0

List sub number orders

by
Published Apr 8, 2025

Get a paginated list of sub number orders.

Script telnyx Verified

The script

Submitted by hugo697 Bun
Verified 428 days ago
1
//native
2
type Telnyx = {
3
	apiKey: string
4
}
5
/**
6
 * List sub number orders
7
 * Get a paginated list of sub number orders.
8
 */
9
export async function main(
10
	auth: Telnyx,
11
	filter_status_: string | undefined,
12
	filter_order_request_id_: string | undefined,
13
	filter_country_code_: string | undefined,
14
	filter_phone_number_type_: string | undefined,
15
	filter_phone_numbers_count_: string | undefined
16
) {
17
	const url = new URL(`https://api.telnyx.com/v2/sub_number_orders`)
18
	for (const [k, v] of [
19
		['filter[status]', filter_status_],
20
		['filter[order_request_id]', filter_order_request_id_],
21
		['filter[country_code]', filter_country_code_],
22
		['filter[phone_number_type]', filter_phone_number_type_],
23
		['filter[phone_numbers_count]', filter_phone_numbers_count_]
24
	]) {
25
		if (v !== undefined && v !== '' && k !== undefined) {
26
			url.searchParams.append(k, v)
27
		}
28
	}
29
	const response = await fetch(url, {
30
		method: 'GET',
31
		headers: {
32
			Authorization: 'Bearer ' + auth.apiKey
33
		},
34
		body: undefined
35
	})
36
	if (!response.ok) {
37
		const text = await response.text()
38
		throw new Error(`${response.status} ${text}`)
39
	}
40
	return await response.json()
41
}
42