0

List port-out related reports

by
Published Apr 8, 2025

List the reports generated about port-out operations.

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 port-out related reports
7
 * List the reports generated about port-out operations.
8
 */
9
export async function main(
10
	auth: Telnyx,
11
	page_number_: string | undefined,
12
	page_size_: string | undefined,
13
	filter_report_type_: 'export_portouts_csv' | undefined,
14
	filter_status_: 'pending' | 'completed' | undefined
15
) {
16
	const url = new URL(`https://api.telnyx.com/v2/portouts/reports`)
17
	for (const [k, v] of [
18
		['page[number]', page_number_],
19
		['page[size]', page_size_],
20
		['filter[report_type]', filter_report_type_],
21
		['filter[status]', filter_status_]
22
	]) {
23
		if (v !== undefined && v !== '' && k !== undefined) {
24
			url.searchParams.append(k, v)
25
		}
26
	}
27
	const response = await fetch(url, {
28
		method: 'GET',
29
		headers: {
30
			Authorization: 'Bearer ' + auth.apiKey
31
		},
32
		body: undefined
33
	})
34
	if (!response.ok) {
35
		const text = await response.text()
36
		throw new Error(`${response.status} ${text}`)
37
	}
38
	return await response.json()
39
}
40