0

Retrieve regulatory requirements

by
Published Apr 8, 2025
Script telnyx Verified

The script

Submitted by hugo697 Bun
Verified 428 days ago
1
//native
2
type Telnyx = {
3
	apiKey: string
4
}
5
/**
6
 * Retrieve regulatory requirements
7
 *
8
 */
9
export async function main(
10
	auth: Telnyx,
11
	filter_phone_number_: string | undefined,
12
	filter_requirement_group_id_: string | undefined,
13
	filter_country_code_: string | undefined,
14
	filter_phone_number_type_:
15
		| 'local'
16
		| 'toll_free'
17
		| 'mobile'
18
		| 'national'
19
		| 'shared_cost'
20
		| undefined,
21
	filter_action_: 'ordering' | 'porting' | 'action' | undefined
22
) {
23
	const url = new URL(`https://api.telnyx.com/v2/regulatory_requirements`)
24
	for (const [k, v] of [
25
		['filter[phone_number]', filter_phone_number_],
26
		['filter[requirement_group_id]', filter_requirement_group_id_],
27
		['filter[country_code]', filter_country_code_],
28
		['filter[phone_number_type]', filter_phone_number_type_],
29
		['filter[action]', filter_action_]
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