Ctrl K

List all addresses

Published Apr 8, 2025

Returns a list of your addresses.

Script telnyx Verified

Use in Windmill

The script

Submitted by hugo697 Bun

Verified 428 days ago

All edits

Permalink

//native
type Telnyx = {
	apiKey: string
}
/**
 * List all addresses
 * Returns a list of your addresses.
 */
export async function main(
	auth: Telnyx,
	page_number_: string | undefined,
	page_size_: string | undefined,
	filter_customer_reference__eq_: string | undefined,
	filter_customer_reference__contains_: string | undefined,
	filter_used_as_emergency_: string | undefined,
	filter_street_address__contains_: string | undefined,
	filter_address_book__eq_: string | undefined,
	sort: 'created_at' | 'first_name' | 'last_name' | 'business_name' | 'street_address' | undefined
) {
	const url = new URL(`https://api.telnyx.com/v2/addresses`)
	for (const [k, v] of [
		['page[number]', page_number_],
		['page[size]', page_size_],
		['filter[customer_reference][eq]', filter_customer_reference__eq_],
		['filter[customer_reference][contains]', filter_customer_reference__contains_],
		['filter[used_as_emergency]', filter_used_as_emergency_],
		['filter[street_address][contains]', filter_street_address__contains_],
		['filter[address_book][eq]', filter_address_book__eq_],
		['sort', sort]
	]) {
		if (v !== undefined && v !== '' && k !== undefined) {
			url.searchParams.append(k, v)
		}
	}
	const response = await fetch(url, {
		method: 'GET',
		headers: {
			Authorization: 'Bearer ' + auth.apiKey
		},
		body: undefined
	})
	if (!response.ok) {
		const text = await response.text()
		throw new Error(`${response.status} ${text}`)
	}
	return await response.json()
}


`1`	`//native`
`2`	`type Telnyx = {`
`3`	`apiKey: string`
`4`	`}`
`5`	`/**`
`6`	`* List all addresses`
`7`	`* Returns a list of your addresses.`
`8`	`*/`
`9`	`export async function main(`
`10`	`auth: Telnyx,`
`11`	`page_number_: string \| undefined,`
`12`	`page_size_: string \| undefined,`
`13`	`filter_customer_reference__eq_: string \| undefined,`
`14`	`filter_customer_reference__contains_: string \| undefined,`
`15`	`filter_used_as_emergency_: string \| undefined,`
`16`	`filter_street_address__contains_: string \| undefined,`
`17`	`filter_address_book__eq_: string \| undefined,`
`18`	`sort: 'created_at' \| 'first_name' \| 'last_name' \| 'business_name' \| 'street_address' \| undefined`
`19`	`) {`
`20`	const url = new URL(`https://api.telnyx.com/v2/addresses`)
`21`	`for (const [k, v] of [`
`22`	`['page[number]', page_number_],`
`23`	`['page[size]', page_size_],`
`24`	`['filter[customer_reference][eq]', filter_customer_reference__eq_],`
`25`	`['filter[customer_reference][contains]', filter_customer_reference__contains_],`
`26`	`['filter[used_as_emergency]', filter_used_as_emergency_],`
`27`	`['filter[street_address][contains]', filter_street_address__contains_],`
`28`	`['filter[address_book][eq]', filter_address_book__eq_],`
`29`	`['sort', sort]`
`30`	`]) {`
`31`	`if (v !== undefined && v !== '' && k !== undefined) {`
`32`	`url.searchParams.append(k, v)`
`33`	`}`
`34`	`}`
`35`	`const response = await fetch(url, {`
`36`	`method: 'GET',`
`37`	`headers: {`
`38`	`Authorization: 'Bearer ' + auth.apiKey`
`39`	`},`
`40`	`body: undefined`
`41`	`})`
`42`	`if (!response.ok) {`
`43`	`const text = await response.text()`
`44`	throw new Error(`${response.status} ${text}`)
`45`	`}`
`46`	`return await response.json()`
`47`	`}`
`48`