0

List all porting events

by
Published Apr 8, 2025

Returns a list of all porting events.

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 all porting events
7
 * Returns a list of all porting events.
8
 */
9
export async function main(
10
	auth: Telnyx,
11
	page_number_: string | undefined,
12
	page_size_: string | undefined,
13
	filter_type_:
14
		| 'porting_order.deleted'
15
		| 'porting_order.loa_updated'
16
		| 'porting_order.messaging_changed'
17
		| 'porting_order.status_changed'
18
		| 'porting_order.sharing_apiKey_expired'
19
		| 'porting_order.new_comment'
20
		| 'porting_order.split'
21
		| undefined,
22
	filter_porting_order_id_: string | undefined,
23
	filter_created_at__gte_: string | undefined,
24
	filter_created_at__lte_: string | undefined
25
) {
26
	const url = new URL(`https://api.telnyx.com/v2/porting/events`)
27
	for (const [k, v] of [
28
		['page[number]', page_number_],
29
		['page[size]', page_size_],
30
		['filter[type]', filter_type_],
31
		['filter[porting_order_id]', filter_porting_order_id_],
32
		['filter[created_at][gte]', filter_created_at__gte_],
33
		['filter[created_at][lte]', filter_created_at__lte_]
34
	]) {
35
		if (v !== undefined && v !== '' && k !== undefined) {
36
			url.searchParams.append(k, v)
37
		}
38
	}
39
	const response = await fetch(url, {
40
		method: 'GET',
41
		headers: {
42
			Authorization: 'Bearer ' + auth.apiKey
43
		},
44
		body: undefined
45
	})
46
	if (!response.ok) {
47
		const text = await response.text()
48
		throw new Error(`${response.status} ${text}`)
49
	}
50
	return await response.json()
51
}
52