@mobilerun/sdk 5.4.0 → 5.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/client.d.mts +2 -5
- package/client.d.mts.map +1 -1
- package/client.d.ts +2 -5
- package/client.d.ts.map +1 -1
- package/client.js +0 -3
- package/client.js.map +1 -1
- package/client.mjs +0 -3
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/apps.d.mts +10 -2
- package/resources/apps.d.mts.map +1 -1
- package/resources/apps.d.ts +10 -2
- package/resources/apps.d.ts.map +1 -1
- package/resources/apps.js +3 -1
- package/resources/apps.js.map +1 -1
- package/resources/apps.mjs +3 -1
- package/resources/apps.mjs.map +1 -1
- package/resources/assistant/conversations.d.mts +26 -4
- package/resources/assistant/conversations.d.mts.map +1 -1
- package/resources/assistant/conversations.d.ts +26 -4
- package/resources/assistant/conversations.d.ts.map +1 -1
- package/resources/assistant/conversations.js +12 -4
- package/resources/assistant/conversations.js.map +1 -1
- package/resources/assistant/conversations.mjs +12 -4
- package/resources/assistant/conversations.mjs.map +1 -1
- package/resources/connect/proxies.d.mts +36 -20
- package/resources/connect/proxies.d.mts.map +1 -1
- package/resources/connect/proxies.d.ts +36 -20
- package/resources/connect/proxies.d.ts.map +1 -1
- package/resources/connect/proxies.js +10 -2
- package/resources/connect/proxies.js.map +1 -1
- package/resources/connect/proxies.mjs +10 -2
- package/resources/connect/proxies.mjs.map +1 -1
- package/resources/devices/apps.d.mts +37 -17
- package/resources/devices/apps.d.mts.map +1 -1
- package/resources/devices/apps.d.ts +37 -17
- package/resources/devices/apps.d.ts.map +1 -1
- package/resources/devices/apps.js +15 -14
- package/resources/devices/apps.js.map +1 -1
- package/resources/devices/apps.mjs +15 -14
- package/resources/devices/apps.mjs.map +1 -1
- package/resources/devices/devices.d.mts +29 -4
- package/resources/devices/devices.d.mts.map +1 -1
- package/resources/devices/devices.d.ts +29 -4
- package/resources/devices/devices.d.ts.map +1 -1
- package/resources/devices/devices.js +7 -4
- package/resources/devices/devices.js.map +1 -1
- package/resources/devices/devices.mjs +7 -4
- package/resources/devices/devices.mjs.map +1 -1
- package/resources/devices/index.d.mts +1 -0
- package/resources/devices/index.d.mts.map +1 -1
- package/resources/devices/index.d.ts +1 -0
- package/resources/devices/index.d.ts.map +1 -1
- package/resources/devices/index.js +3 -1
- package/resources/devices/index.js.map +1 -1
- package/resources/devices/index.mjs +1 -0
- package/resources/devices/index.mjs.map +1 -1
- package/resources/devices/keyboard.d.mts +9 -3
- package/resources/devices/keyboard.d.mts.map +1 -1
- package/resources/devices/keyboard.d.ts +9 -3
- package/resources/devices/keyboard.d.ts.map +1 -1
- package/resources/devices/keyboard.js +3 -3
- package/resources/devices/keyboard.mjs +3 -3
- package/resources/devices/recordings.d.mts +11 -0
- package/resources/devices/recordings.d.mts.map +1 -1
- package/resources/devices/recordings.d.ts +11 -0
- package/resources/devices/recordings.d.ts.map +1 -1
- package/resources/devices/traffic-sessions.d.mts +173 -0
- package/resources/devices/traffic-sessions.d.mts.map +1 -0
- package/resources/devices/traffic-sessions.d.ts +173 -0
- package/resources/devices/traffic-sessions.d.ts.map +1 -0
- package/resources/devices/traffic-sessions.js +43 -0
- package/resources/devices/traffic-sessions.js.map +1 -0
- package/resources/devices/traffic-sessions.mjs +39 -0
- package/resources/devices/traffic-sessions.mjs.map +1 -0
- package/resources/files.d.mts +72 -0
- package/resources/files.d.mts.map +1 -1
- package/resources/files.d.ts +72 -0
- package/resources/files.d.ts.map +1 -1
- package/resources/index.d.mts +1 -2
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +1 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +1 -3
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +0 -1
- package/resources/index.mjs.map +1 -1
- package/resources/mailboxes/mailboxes.d.mts +45 -37
- package/resources/mailboxes/mailboxes.d.mts.map +1 -1
- package/resources/mailboxes/mailboxes.d.ts +45 -37
- package/resources/mailboxes/mailboxes.d.ts.map +1 -1
- package/resources/mailboxes/mailboxes.js +13 -20
- package/resources/mailboxes/mailboxes.js.map +1 -1
- package/resources/mailboxes/mailboxes.mjs +13 -20
- package/resources/mailboxes/mailboxes.mjs.map +1 -1
- package/resources/mailboxes/messages.d.mts +2 -2
- package/resources/mailboxes/messages.d.ts +2 -2
- package/resources/mailboxes/messages.js +2 -2
- package/resources/mailboxes/messages.mjs +2 -2
- package/resources/messages/conversations.d.mts +4 -15
- package/resources/messages/conversations.d.mts.map +1 -1
- package/resources/messages/conversations.d.ts +4 -15
- package/resources/messages/conversations.d.ts.map +1 -1
- package/resources/messages/conversations.js +4 -15
- package/resources/messages/conversations.js.map +1 -1
- package/resources/messages/conversations.mjs +4 -15
- package/resources/messages/conversations.mjs.map +1 -1
- package/resources/messages/messages.d.mts +2 -4
- package/resources/messages/messages.d.mts.map +1 -1
- package/resources/messages/messages.d.ts +2 -4
- package/resources/messages/messages.d.ts.map +1 -1
- package/resources/messages/messages.js +2 -4
- package/resources/messages/messages.js.map +1 -1
- package/resources/messages/messages.mjs +2 -4
- package/resources/messages/messages.mjs.map +1 -1
- package/resources/numbers/index.d.mts +1 -1
- package/resources/numbers/index.d.mts.map +1 -1
- package/resources/numbers/index.d.ts +1 -1
- package/resources/numbers/index.d.ts.map +1 -1
- package/resources/numbers/index.js.map +1 -1
- package/resources/numbers/index.mjs.map +1 -1
- package/resources/numbers/numbers.d.mts +48 -35
- package/resources/numbers/numbers.d.mts.map +1 -1
- package/resources/numbers/numbers.d.ts +48 -35
- package/resources/numbers/numbers.d.ts.map +1 -1
- package/resources/numbers/numbers.js +23 -29
- package/resources/numbers/numbers.js.map +1 -1
- package/resources/numbers/numbers.mjs +23 -29
- package/resources/numbers/numbers.mjs.map +1 -1
- package/resources/tasks/tasks.d.mts +80 -32
- package/resources/tasks/tasks.d.mts.map +1 -1
- package/resources/tasks/tasks.d.ts +80 -32
- package/resources/tasks/tasks.d.ts.map +1 -1
- package/resources/tasks/tasks.js.map +1 -1
- package/resources/tasks/tasks.mjs.map +1 -1
- package/resources/webhooks/webhooks.d.mts +1 -0
- package/resources/webhooks/webhooks.d.mts.map +1 -1
- package/resources/webhooks/webhooks.d.ts +1 -0
- package/resources/webhooks/webhooks.d.ts.map +1 -1
- package/resources/webhooks/webhooks.js.map +1 -1
- package/resources/webhooks/webhooks.mjs.map +1 -1
- package/resources/workflows/events.d.mts +18 -0
- package/resources/workflows/events.d.mts.map +1 -1
- package/resources/workflows/events.d.ts +18 -0
- package/resources/workflows/events.d.ts.map +1 -1
- package/resources/workflows/executions.d.mts +84 -5
- package/resources/workflows/executions.d.mts.map +1 -1
- package/resources/workflows/executions.d.ts +84 -5
- package/resources/workflows/executions.d.ts.map +1 -1
- package/resources/workflows/executions.js +3 -2
- package/resources/workflows/executions.js.map +1 -1
- package/resources/workflows/executions.mjs +3 -2
- package/resources/workflows/executions.mjs.map +1 -1
- package/resources/workflows/flows/actions.d.mts +19 -0
- package/resources/workflows/flows/actions.d.mts.map +1 -1
- package/resources/workflows/flows/actions.d.ts +19 -0
- package/resources/workflows/flows/actions.d.ts.map +1 -1
- package/resources/workflows/flows/flows.d.mts +142 -2
- package/resources/workflows/flows/flows.d.mts.map +1 -1
- package/resources/workflows/flows/flows.d.ts +142 -2
- package/resources/workflows/flows/flows.d.ts.map +1 -1
- package/resources/workflows/flows/flows.js +11 -1
- package/resources/workflows/flows/flows.js.map +1 -1
- package/resources/workflows/flows/flows.mjs +11 -1
- package/resources/workflows/flows/flows.mjs.map +1 -1
- package/resources/workflows/flows/index.d.mts +1 -1
- package/resources/workflows/flows/index.d.mts.map +1 -1
- package/resources/workflows/flows/index.d.ts +1 -1
- package/resources/workflows/flows/index.d.ts.map +1 -1
- package/resources/workflows/flows/index.js.map +1 -1
- package/resources/workflows/flows/index.mjs.map +1 -1
- package/resources/workflows/index.d.mts +1 -1
- package/resources/workflows/index.d.mts.map +1 -1
- package/resources/workflows/index.d.ts +1 -1
- package/resources/workflows/index.d.ts.map +1 -1
- package/resources/workflows/index.js.map +1 -1
- package/resources/workflows/index.mjs.map +1 -1
- package/resources/workflows/triggers.d.mts +17 -3
- package/resources/workflows/triggers.d.mts.map +1 -1
- package/resources/workflows/triggers.d.ts +17 -3
- package/resources/workflows/triggers.d.ts.map +1 -1
- package/resources/workflows/workflows.d.mts +2 -2
- package/resources/workflows/workflows.d.mts.map +1 -1
- package/resources/workflows/workflows.d.ts +2 -2
- package/resources/workflows/workflows.d.ts.map +1 -1
- package/resources/workflows/workflows.js.map +1 -1
- package/resources/workflows/workflows.mjs.map +1 -1
- package/src/client.ts +4 -41
- package/src/resources/apps.ts +11 -2
- package/src/resources/assistant/conversations.ts +38 -4
- package/src/resources/connect/proxies.ts +49 -21
- package/src/resources/devices/apps.ts +41 -17
- package/src/resources/devices/devices.ts +58 -4
- package/src/resources/devices/index.ts +11 -0
- package/src/resources/devices/keyboard.ts +10 -3
- package/src/resources/devices/recordings.ts +12 -0
- package/src/resources/devices/traffic-sessions.ts +299 -0
- package/src/resources/files.ts +114 -0
- package/src/resources/index.ts +2 -19
- package/src/resources/mailboxes/mailboxes.ts +56 -37
- package/src/resources/mailboxes/messages.ts +2 -2
- package/src/resources/messages/conversations.ts +4 -15
- package/src/resources/messages/messages.ts +2 -4
- package/src/resources/numbers/index.ts +2 -0
- package/src/resources/numbers/numbers.ts +58 -34
- package/src/resources/tasks/tasks.ts +120 -40
- package/src/resources/webhooks/webhooks.ts +2 -0
- package/src/resources/workflows/events.ts +24 -0
- package/src/resources/workflows/executions.ts +121 -5
- package/src/resources/workflows/flows/actions.ts +26 -0
- package/src/resources/workflows/flows/flows.ts +182 -1
- package/src/resources/workflows/flows/index.ts +1 -0
- package/src/resources/workflows/index.ts +1 -0
- package/src/resources/workflows/triggers.ts +19 -3
- package/src/resources/workflows/workflows.ts +2 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
- package/resources/esims/esims.d.mts +0 -566
- package/resources/esims/esims.d.mts.map +0 -1
- package/resources/esims/esims.d.ts +0 -566
- package/resources/esims/esims.d.ts.map +0 -1
- package/resources/esims/esims.js +0 -205
- package/resources/esims/esims.js.map +0 -1
- package/resources/esims/esims.mjs +0 -200
- package/resources/esims/esims.mjs.map +0 -1
- package/resources/esims/index.d.mts +0 -3
- package/resources/esims/index.d.mts.map +0 -1
- package/resources/esims/index.d.ts +0 -3
- package/resources/esims/index.d.ts.map +0 -1
- package/resources/esims/index.js +0 -9
- package/resources/esims/index.js.map +0 -1
- package/resources/esims/index.mjs +0 -4
- package/resources/esims/index.mjs.map +0 -1
- package/resources/esims/messages.d.mts +0 -106
- package/resources/esims/messages.d.mts.map +0 -1
- package/resources/esims/messages.d.ts +0 -106
- package/resources/esims/messages.d.ts.map +0 -1
- package/resources/esims/messages.js +0 -37
- package/resources/esims/messages.js.map +0 -1
- package/resources/esims/messages.mjs +0 -33
- package/resources/esims/messages.mjs.map +0 -1
- package/resources/esims.d.mts +0 -2
- package/resources/esims.d.mts.map +0 -1
- package/resources/esims.d.ts +0 -2
- package/resources/esims.d.ts.map +0 -1
- package/resources/esims.js +0 -6
- package/resources/esims.js.map +0 -1
- package/resources/esims.mjs +0 -3
- package/resources/esims.mjs.map +0 -1
- package/src/resources/esims/esims.ts +0 -1019
- package/src/resources/esims/index.ts +0 -28
- package/src/resources/esims/messages.ts +0 -187
- package/src/resources/esims.ts +0 -3
|
@@ -1,1019 +0,0 @@
|
|
|
1
|
-
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
-
|
|
3
|
-
import { APIResource } from '../../core/resource';
|
|
4
|
-
import * as Shared from '../shared';
|
|
5
|
-
import * as MessagesAPI from './messages';
|
|
6
|
-
import {
|
|
7
|
-
MessageListParams,
|
|
8
|
-
MessageListResponse,
|
|
9
|
-
MessageSendParams,
|
|
10
|
-
MessageSendResponse,
|
|
11
|
-
Messages,
|
|
12
|
-
} from './messages';
|
|
13
|
-
import { APIPromise } from '../../core/api-promise';
|
|
14
|
-
import { buildHeaders } from '../../internal/headers';
|
|
15
|
-
import { RequestOptions } from '../../internal/request-options';
|
|
16
|
-
import { path } from '../../internal/utils/path';
|
|
17
|
-
|
|
18
|
-
export class Esims extends APIResource {
|
|
19
|
-
messages: MessagesAPI.Messages = new MessagesAPI.Messages(this._client);
|
|
20
|
-
|
|
21
|
-
/**
|
|
22
|
-
* Purchases a physical eSIM from available inventory for the authenticated owner.
|
|
23
|
-
* Returns 409 when no stock is available, or 402 with a billing checkout URL when
|
|
24
|
-
* billing capacity is exhausted.
|
|
25
|
-
*
|
|
26
|
-
* @example
|
|
27
|
-
* ```ts
|
|
28
|
-
* const esim = await client.esims.create();
|
|
29
|
-
* ```
|
|
30
|
-
*/
|
|
31
|
-
create(
|
|
32
|
-
body: EsimCreateParams | null | undefined = {},
|
|
33
|
-
options?: RequestOptions,
|
|
34
|
-
): APIPromise<EsimCreateResponse> {
|
|
35
|
-
return this._client.post('/numbers/esims', { body, ...options });
|
|
36
|
-
}
|
|
37
|
-
|
|
38
|
-
/**
|
|
39
|
-
* Retrieves a single physical eSIM.
|
|
40
|
-
*
|
|
41
|
-
* @example
|
|
42
|
-
* ```ts
|
|
43
|
-
* const esim = await client.esims.retrieve(
|
|
44
|
-
* '550e8400-e29b-41d4-a716-446655440000',
|
|
45
|
-
* );
|
|
46
|
-
* ```
|
|
47
|
-
*/
|
|
48
|
-
retrieve(id: string, options?: RequestOptions): APIPromise<EsimRetrieveResponse> {
|
|
49
|
-
return this._client.get(path`/numbers/esims/${id}`, options);
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
/**
|
|
53
|
-
* Updates the eSIM's self-reported msisdn and/or display name. Both fields are
|
|
54
|
-
* optional, but the request body itself is required. Omitting a field leaves it
|
|
55
|
-
* unchanged; setting it to null or an empty string clears it. `name` is capped at
|
|
56
|
-
* 15 characters. Available regardless of the eSIM's current status.
|
|
57
|
-
*
|
|
58
|
-
* @example
|
|
59
|
-
* ```ts
|
|
60
|
-
* const esim = await client.esims.update(
|
|
61
|
-
* '550e8400-e29b-41d4-a716-446655440000',
|
|
62
|
-
* );
|
|
63
|
-
* ```
|
|
64
|
-
*/
|
|
65
|
-
update(
|
|
66
|
-
id: string,
|
|
67
|
-
body: EsimUpdateParams | null | undefined = {},
|
|
68
|
-
options?: RequestOptions,
|
|
69
|
-
): APIPromise<EsimUpdateResponse> {
|
|
70
|
-
return this._client.patch(path`/numbers/esims/${id}`, { body, ...options });
|
|
71
|
-
}
|
|
72
|
-
|
|
73
|
-
/**
|
|
74
|
-
* Lists physical eSIMs owned by the authenticated owner.
|
|
75
|
-
*
|
|
76
|
-
* @example
|
|
77
|
-
* ```ts
|
|
78
|
-
* const esims = await client.esims.list();
|
|
79
|
-
* ```
|
|
80
|
-
*/
|
|
81
|
-
list(
|
|
82
|
-
query: EsimListParams | null | undefined = {},
|
|
83
|
-
options?: RequestOptions,
|
|
84
|
-
): APIPromise<EsimListResponse> {
|
|
85
|
-
return this._client.get('/numbers/esims', { query, ...options });
|
|
86
|
-
}
|
|
87
|
-
|
|
88
|
-
/**
|
|
89
|
-
* Removes a physical eSIM. Idempotent — returns 204 for a fresh removal or a
|
|
90
|
-
* replay of an already-removed eSIM. An eSIM currently installed on a device is
|
|
91
|
-
* uninstalled first, then removed. An eSIM in an intermediate install state
|
|
92
|
-
* returns 409 `operator_resolution_required` and requires manual resolution.
|
|
93
|
-
* Returns 404 if the eSIM doesn't exist or isn't owned by the caller.
|
|
94
|
-
*
|
|
95
|
-
* @example
|
|
96
|
-
* ```ts
|
|
97
|
-
* await client.esims.delete(
|
|
98
|
-
* '550e8400-e29b-41d4-a716-446655440000',
|
|
99
|
-
* );
|
|
100
|
-
* ```
|
|
101
|
-
*/
|
|
102
|
-
delete(id: string, options?: RequestOptions): APIPromise<void> {
|
|
103
|
-
return this._client.delete(path`/numbers/esims/${id}`, {
|
|
104
|
-
...options,
|
|
105
|
-
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
106
|
-
});
|
|
107
|
-
}
|
|
108
|
-
|
|
109
|
-
/**
|
|
110
|
-
* Reports whether a free device is currently available, for pre-checking the
|
|
111
|
-
* import flow before upload. This is a hint only, not a reservation —
|
|
112
|
-
* `POST /esims/import` re-checks availability at submit time.
|
|
113
|
-
*
|
|
114
|
-
* @example
|
|
115
|
-
* ```ts
|
|
116
|
-
* const response = await client.esims.capacity();
|
|
117
|
-
* ```
|
|
118
|
-
*/
|
|
119
|
-
capacity(options?: RequestOptions): APIPromise<EsimCapacityResponse> {
|
|
120
|
-
return this._client.get('/numbers/esims/capacity', options);
|
|
121
|
-
}
|
|
122
|
-
|
|
123
|
-
/**
|
|
124
|
-
* Checks for proof of payment for this eSIM's current rent and confirms it if
|
|
125
|
-
* found. If no proof is available yet, returns 200 with the eSIM unchanged rather
|
|
126
|
-
* than an error. Always returns the current eSIM state.
|
|
127
|
-
*
|
|
128
|
-
* @example
|
|
129
|
-
* ```ts
|
|
130
|
-
* const response = await client.esims.confirmPayment(
|
|
131
|
-
* '550e8400-e29b-41d4-a716-446655440000',
|
|
132
|
-
* );
|
|
133
|
-
* ```
|
|
134
|
-
*/
|
|
135
|
-
confirmPayment(id: string, options?: RequestOptions): APIPromise<EsimConfirmPaymentResponse> {
|
|
136
|
-
return this._client.post(path`/numbers/esims/${id}/confirm-payment`, options);
|
|
137
|
-
}
|
|
138
|
-
|
|
139
|
-
/**
|
|
140
|
-
* Registers a bring-your-own (BYO) eSIM activation code as owned inventory.
|
|
141
|
-
* Provide either `{ smdpAddress, matchingId?, confirmationCode? }` or
|
|
142
|
-
* `{ lpaCode }` — supplying both, or neither, returns 400. An optional `name` sets
|
|
143
|
-
* a display label on the created eSIM (up to 15 characters).
|
|
144
|
-
*
|
|
145
|
-
* Subject to per-owner and daily import limits, and disabled entirely unless BYO
|
|
146
|
-
* imports are enabled for this deployment (409 `byo_disabled`). Idempotent via
|
|
147
|
-
* `idempotencyKey`: replaying the same key with an identical request returns the
|
|
148
|
-
* original response; the same key with a different request returns 409
|
|
149
|
-
* `idempotency_conflict`.
|
|
150
|
-
*
|
|
151
|
-
* When rent-first billing is off (default), the import is free — 201 with the
|
|
152
|
-
* eSIM. Setting `autoInstall: true` additionally dispatches an install immediately
|
|
153
|
-
* after import (`deviceId` may only be set together with `autoInstall`): this
|
|
154
|
-
* returns 202 with `{esim, operationId, statusUrl}` when the install claim
|
|
155
|
-
* succeeds (poll `GET /esims/{id}/install-status`), or 201 with the eSIM plus
|
|
156
|
-
* `installDispatch: {ok: false, reason}` when the install could not be dispatched
|
|
157
|
-
* — the import itself still succeeds either way.
|
|
158
|
-
*
|
|
159
|
-
* When rent-first billing is on, import additionally requires available device
|
|
160
|
-
* capacity (409 `device_pool_empty`) and is subject to a per-owner
|
|
161
|
-
* awaiting-payment cap (409 `byo_awaiting_payment_cap`). On success the eSIM is
|
|
162
|
-
* created `awaiting_payment` and a checkout is started: 201 with
|
|
163
|
-
* `{esim, rentStatus, checkoutUrl}` when the checkout URL is ready immediately, or
|
|
164
|
-
* 202 with `checkoutUrl: null` otherwise — poll `GET /esims/{id}` until it's
|
|
165
|
-
* populated. Once payment is confirmed, install is triggered automatically.
|
|
166
|
-
*
|
|
167
|
-
* @example
|
|
168
|
-
* ```ts
|
|
169
|
-
* const response = await client.esims.import();
|
|
170
|
-
* ```
|
|
171
|
-
*/
|
|
172
|
-
import(
|
|
173
|
-
body: EsimImportParams | null | undefined = {},
|
|
174
|
-
options?: RequestOptions,
|
|
175
|
-
): APIPromise<EsimImportResponse> {
|
|
176
|
-
return this._client.post('/numbers/esims/import', { body, ...options });
|
|
177
|
-
}
|
|
178
|
-
|
|
179
|
-
/**
|
|
180
|
-
* Installs the eSIM's activation code onto a device. `deviceId` is optional — omit
|
|
181
|
-
* it to use an available device from the pool. This call is asynchronous: it
|
|
182
|
-
* returns 202 with `{esim, operationId, statusUrl}` immediately, and the result is
|
|
183
|
-
* available by polling `GET /esims/{id}/install-status`. Retrying with the same
|
|
184
|
-
* request is safe if a response is lost.
|
|
185
|
-
*
|
|
186
|
-
* Returns 409 when the eSIM is not in the `owned` state, or when no device is
|
|
187
|
-
* currently available (see `reason`). When rent-first billing is enabled, a BYO
|
|
188
|
-
* eSIM whose rent isn't active returns 402 with `{esim, rentStatus, checkoutUrl}`
|
|
189
|
-
* instead.
|
|
190
|
-
*
|
|
191
|
-
* @example
|
|
192
|
-
* ```ts
|
|
193
|
-
* const response = await client.esims.install(
|
|
194
|
-
* '550e8400-e29b-41d4-a716-446655440000',
|
|
195
|
-
* );
|
|
196
|
-
* ```
|
|
197
|
-
*/
|
|
198
|
-
install(
|
|
199
|
-
id: string,
|
|
200
|
-
body: EsimInstallParams | null | undefined = {},
|
|
201
|
-
options?: RequestOptions,
|
|
202
|
-
): APIPromise<EsimInstallResponse> {
|
|
203
|
-
return this._client.post(path`/numbers/esims/${id}/install`, { body, ...options });
|
|
204
|
-
}
|
|
205
|
-
|
|
206
|
-
/**
|
|
207
|
-
* Returns the eSIM's current install status, checking for a terminal outcome if an
|
|
208
|
-
* install is still in progress.
|
|
209
|
-
*
|
|
210
|
-
* @example
|
|
211
|
-
* ```ts
|
|
212
|
-
* const response = await client.esims.installStatus(
|
|
213
|
-
* '550e8400-e29b-41d4-a716-446655440000',
|
|
214
|
-
* );
|
|
215
|
-
* ```
|
|
216
|
-
*/
|
|
217
|
-
installStatus(id: string, options?: RequestOptions): APIPromise<EsimInstallStatusResponse> {
|
|
218
|
-
return this._client.get(path`/numbers/esims/${id}/install-status`, options);
|
|
219
|
-
}
|
|
220
|
-
|
|
221
|
-
/**
|
|
222
|
-
* Returns a lightweight list (id, msisdn, carrierName, status, masked iccid) for
|
|
223
|
-
* use in a message filter dropdown. Unlike `GET /esims`, this includes all
|
|
224
|
-
* statuses, including retired eSIMs.
|
|
225
|
-
*
|
|
226
|
-
* @example
|
|
227
|
-
* ```ts
|
|
228
|
-
* const response = await client.esims.selector();
|
|
229
|
-
* ```
|
|
230
|
-
*/
|
|
231
|
-
selector(
|
|
232
|
-
query: EsimSelectorParams | null | undefined = {},
|
|
233
|
-
options?: RequestOptions,
|
|
234
|
-
): APIPromise<EsimSelectorResponse> {
|
|
235
|
-
return this._client.get('/numbers/esims/selector', { query, ...options });
|
|
236
|
-
}
|
|
237
|
-
}
|
|
238
|
-
|
|
239
|
-
export interface EsimCreateResponse {
|
|
240
|
-
data: EsimCreateResponse.Data;
|
|
241
|
-
}
|
|
242
|
-
|
|
243
|
-
export namespace EsimCreateResponse {
|
|
244
|
-
export interface Data {
|
|
245
|
-
id: string;
|
|
246
|
-
|
|
247
|
-
carrierName: string | null;
|
|
248
|
-
|
|
249
|
-
countryCode: string | null;
|
|
250
|
-
|
|
251
|
-
createdAt: string | null;
|
|
252
|
-
|
|
253
|
-
createdBy: string | null;
|
|
254
|
-
|
|
255
|
-
deviceId: string | null;
|
|
256
|
-
|
|
257
|
-
deviceUuid: string | null;
|
|
258
|
-
|
|
259
|
-
iccid: string | null;
|
|
260
|
-
|
|
261
|
-
msisdn: string | null;
|
|
262
|
-
|
|
263
|
-
name: string | null;
|
|
264
|
-
|
|
265
|
-
networkStatus: 'degraded' | null;
|
|
266
|
-
|
|
267
|
-
source: 'stocked' | 'byo';
|
|
268
|
-
|
|
269
|
-
status: 'in_stock' | 'owned' | 'installing' | 'installed' | 'install_failed' | 'retired';
|
|
270
|
-
|
|
271
|
-
subscriptionId: number | null;
|
|
272
|
-
|
|
273
|
-
updatedAt: string | null;
|
|
274
|
-
|
|
275
|
-
cancellationScheduled?: boolean;
|
|
276
|
-
|
|
277
|
-
checkoutUrl?: string | null;
|
|
278
|
-
|
|
279
|
-
currentPeriodEnd?: string | null;
|
|
280
|
-
|
|
281
|
-
exempt?: boolean;
|
|
282
|
-
|
|
283
|
-
rentStatus?:
|
|
284
|
-
| 'not_applicable'
|
|
285
|
-
| 'exempt'
|
|
286
|
-
| 'inactive'
|
|
287
|
-
| 'awaiting_payment'
|
|
288
|
-
| 'active'
|
|
289
|
-
| 'cancel_pending'
|
|
290
|
-
| 'refund_pending'
|
|
291
|
-
| 'retiring'
|
|
292
|
-
| 'billing_error';
|
|
293
|
-
}
|
|
294
|
-
}
|
|
295
|
-
|
|
296
|
-
export interface EsimRetrieveResponse {
|
|
297
|
-
data: EsimRetrieveResponse.Data;
|
|
298
|
-
}
|
|
299
|
-
|
|
300
|
-
export namespace EsimRetrieveResponse {
|
|
301
|
-
export interface Data {
|
|
302
|
-
id: string;
|
|
303
|
-
|
|
304
|
-
carrierName: string | null;
|
|
305
|
-
|
|
306
|
-
countryCode: string | null;
|
|
307
|
-
|
|
308
|
-
createdAt: string | null;
|
|
309
|
-
|
|
310
|
-
createdBy: string | null;
|
|
311
|
-
|
|
312
|
-
deviceId: string | null;
|
|
313
|
-
|
|
314
|
-
deviceUuid: string | null;
|
|
315
|
-
|
|
316
|
-
iccid: string | null;
|
|
317
|
-
|
|
318
|
-
msisdn: string | null;
|
|
319
|
-
|
|
320
|
-
name: string | null;
|
|
321
|
-
|
|
322
|
-
networkStatus: 'degraded' | null;
|
|
323
|
-
|
|
324
|
-
source: 'stocked' | 'byo';
|
|
325
|
-
|
|
326
|
-
status: 'in_stock' | 'owned' | 'installing' | 'installed' | 'install_failed' | 'retired';
|
|
327
|
-
|
|
328
|
-
subscriptionId: number | null;
|
|
329
|
-
|
|
330
|
-
updatedAt: string | null;
|
|
331
|
-
|
|
332
|
-
cancellationScheduled?: boolean;
|
|
333
|
-
|
|
334
|
-
checkoutUrl?: string | null;
|
|
335
|
-
|
|
336
|
-
currentPeriodEnd?: string | null;
|
|
337
|
-
|
|
338
|
-
exempt?: boolean;
|
|
339
|
-
|
|
340
|
-
rentStatus?:
|
|
341
|
-
| 'not_applicable'
|
|
342
|
-
| 'exempt'
|
|
343
|
-
| 'inactive'
|
|
344
|
-
| 'awaiting_payment'
|
|
345
|
-
| 'active'
|
|
346
|
-
| 'cancel_pending'
|
|
347
|
-
| 'refund_pending'
|
|
348
|
-
| 'retiring'
|
|
349
|
-
| 'billing_error';
|
|
350
|
-
}
|
|
351
|
-
}
|
|
352
|
-
|
|
353
|
-
export interface EsimUpdateResponse {
|
|
354
|
-
data: EsimUpdateResponse.Data;
|
|
355
|
-
}
|
|
356
|
-
|
|
357
|
-
export namespace EsimUpdateResponse {
|
|
358
|
-
export interface Data {
|
|
359
|
-
id: string;
|
|
360
|
-
|
|
361
|
-
carrierName: string | null;
|
|
362
|
-
|
|
363
|
-
countryCode: string | null;
|
|
364
|
-
|
|
365
|
-
createdAt: string | null;
|
|
366
|
-
|
|
367
|
-
createdBy: string | null;
|
|
368
|
-
|
|
369
|
-
deviceId: string | null;
|
|
370
|
-
|
|
371
|
-
deviceUuid: string | null;
|
|
372
|
-
|
|
373
|
-
iccid: string | null;
|
|
374
|
-
|
|
375
|
-
msisdn: string | null;
|
|
376
|
-
|
|
377
|
-
name: string | null;
|
|
378
|
-
|
|
379
|
-
networkStatus: 'degraded' | null;
|
|
380
|
-
|
|
381
|
-
source: 'stocked' | 'byo';
|
|
382
|
-
|
|
383
|
-
status: 'in_stock' | 'owned' | 'installing' | 'installed' | 'install_failed' | 'retired';
|
|
384
|
-
|
|
385
|
-
subscriptionId: number | null;
|
|
386
|
-
|
|
387
|
-
updatedAt: string | null;
|
|
388
|
-
|
|
389
|
-
cancellationScheduled?: boolean;
|
|
390
|
-
|
|
391
|
-
checkoutUrl?: string | null;
|
|
392
|
-
|
|
393
|
-
currentPeriodEnd?: string | null;
|
|
394
|
-
|
|
395
|
-
exempt?: boolean;
|
|
396
|
-
|
|
397
|
-
rentStatus?:
|
|
398
|
-
| 'not_applicable'
|
|
399
|
-
| 'exempt'
|
|
400
|
-
| 'inactive'
|
|
401
|
-
| 'awaiting_payment'
|
|
402
|
-
| 'active'
|
|
403
|
-
| 'cancel_pending'
|
|
404
|
-
| 'refund_pending'
|
|
405
|
-
| 'retiring'
|
|
406
|
-
| 'billing_error';
|
|
407
|
-
}
|
|
408
|
-
}
|
|
409
|
-
|
|
410
|
-
export interface EsimListResponse {
|
|
411
|
-
items: Array<EsimListResponse.Item>;
|
|
412
|
-
|
|
413
|
-
pagination: Shared.Pagination;
|
|
414
|
-
}
|
|
415
|
-
|
|
416
|
-
export namespace EsimListResponse {
|
|
417
|
-
export interface Item {
|
|
418
|
-
id: string;
|
|
419
|
-
|
|
420
|
-
carrierName: string | null;
|
|
421
|
-
|
|
422
|
-
countryCode: string | null;
|
|
423
|
-
|
|
424
|
-
createdAt: string | null;
|
|
425
|
-
|
|
426
|
-
createdBy: string | null;
|
|
427
|
-
|
|
428
|
-
deviceId: string | null;
|
|
429
|
-
|
|
430
|
-
deviceUuid: string | null;
|
|
431
|
-
|
|
432
|
-
iccid: string | null;
|
|
433
|
-
|
|
434
|
-
msisdn: string | null;
|
|
435
|
-
|
|
436
|
-
name: string | null;
|
|
437
|
-
|
|
438
|
-
networkStatus: 'degraded' | null;
|
|
439
|
-
|
|
440
|
-
source: 'stocked' | 'byo';
|
|
441
|
-
|
|
442
|
-
status: 'in_stock' | 'owned' | 'installing' | 'installed' | 'install_failed' | 'retired';
|
|
443
|
-
|
|
444
|
-
subscriptionId: number | null;
|
|
445
|
-
|
|
446
|
-
updatedAt: string | null;
|
|
447
|
-
|
|
448
|
-
cancellationScheduled?: boolean;
|
|
449
|
-
|
|
450
|
-
checkoutUrl?: string | null;
|
|
451
|
-
|
|
452
|
-
currentPeriodEnd?: string | null;
|
|
453
|
-
|
|
454
|
-
exempt?: boolean;
|
|
455
|
-
|
|
456
|
-
rentStatus?:
|
|
457
|
-
| 'not_applicable'
|
|
458
|
-
| 'exempt'
|
|
459
|
-
| 'inactive'
|
|
460
|
-
| 'awaiting_payment'
|
|
461
|
-
| 'active'
|
|
462
|
-
| 'cancel_pending'
|
|
463
|
-
| 'refund_pending'
|
|
464
|
-
| 'retiring'
|
|
465
|
-
| 'billing_error';
|
|
466
|
-
}
|
|
467
|
-
}
|
|
468
|
-
|
|
469
|
-
export interface EsimCapacityResponse {
|
|
470
|
-
data: EsimCapacityResponse.Data;
|
|
471
|
-
}
|
|
472
|
-
|
|
473
|
-
export namespace EsimCapacityResponse {
|
|
474
|
-
export interface Data {
|
|
475
|
-
available: boolean;
|
|
476
|
-
|
|
477
|
-
freeDevices: number;
|
|
478
|
-
}
|
|
479
|
-
}
|
|
480
|
-
|
|
481
|
-
export interface EsimConfirmPaymentResponse {
|
|
482
|
-
data: EsimConfirmPaymentResponse.Data;
|
|
483
|
-
}
|
|
484
|
-
|
|
485
|
-
export namespace EsimConfirmPaymentResponse {
|
|
486
|
-
export interface Data {
|
|
487
|
-
id: string;
|
|
488
|
-
|
|
489
|
-
carrierName: string | null;
|
|
490
|
-
|
|
491
|
-
countryCode: string | null;
|
|
492
|
-
|
|
493
|
-
createdAt: string | null;
|
|
494
|
-
|
|
495
|
-
createdBy: string | null;
|
|
496
|
-
|
|
497
|
-
deviceId: string | null;
|
|
498
|
-
|
|
499
|
-
deviceUuid: string | null;
|
|
500
|
-
|
|
501
|
-
iccid: string | null;
|
|
502
|
-
|
|
503
|
-
msisdn: string | null;
|
|
504
|
-
|
|
505
|
-
name: string | null;
|
|
506
|
-
|
|
507
|
-
networkStatus: 'degraded' | null;
|
|
508
|
-
|
|
509
|
-
source: 'stocked' | 'byo';
|
|
510
|
-
|
|
511
|
-
status: 'in_stock' | 'owned' | 'installing' | 'installed' | 'install_failed' | 'retired';
|
|
512
|
-
|
|
513
|
-
subscriptionId: number | null;
|
|
514
|
-
|
|
515
|
-
updatedAt: string | null;
|
|
516
|
-
|
|
517
|
-
cancellationScheduled?: boolean;
|
|
518
|
-
|
|
519
|
-
checkoutUrl?: string | null;
|
|
520
|
-
|
|
521
|
-
currentPeriodEnd?: string | null;
|
|
522
|
-
|
|
523
|
-
exempt?: boolean;
|
|
524
|
-
|
|
525
|
-
rentStatus?:
|
|
526
|
-
| 'not_applicable'
|
|
527
|
-
| 'exempt'
|
|
528
|
-
| 'inactive'
|
|
529
|
-
| 'awaiting_payment'
|
|
530
|
-
| 'active'
|
|
531
|
-
| 'cancel_pending'
|
|
532
|
-
| 'refund_pending'
|
|
533
|
-
| 'retiring'
|
|
534
|
-
| 'billing_error';
|
|
535
|
-
}
|
|
536
|
-
}
|
|
537
|
-
|
|
538
|
-
export interface EsimImportResponse {
|
|
539
|
-
data:
|
|
540
|
-
| EsimImportResponse.PublicEsim
|
|
541
|
-
| EsimImportResponse.EsimAwaitingPaymentResponse
|
|
542
|
-
| EsimImportResponse.EsimImportInstallDispatchFailedResponse;
|
|
543
|
-
}
|
|
544
|
-
|
|
545
|
-
export namespace EsimImportResponse {
|
|
546
|
-
export interface PublicEsim {
|
|
547
|
-
id: string;
|
|
548
|
-
|
|
549
|
-
carrierName: string | null;
|
|
550
|
-
|
|
551
|
-
countryCode: string | null;
|
|
552
|
-
|
|
553
|
-
createdAt: string | null;
|
|
554
|
-
|
|
555
|
-
createdBy: string | null;
|
|
556
|
-
|
|
557
|
-
deviceId: string | null;
|
|
558
|
-
|
|
559
|
-
deviceUuid: string | null;
|
|
560
|
-
|
|
561
|
-
iccid: string | null;
|
|
562
|
-
|
|
563
|
-
msisdn: string | null;
|
|
564
|
-
|
|
565
|
-
name: string | null;
|
|
566
|
-
|
|
567
|
-
networkStatus: 'degraded' | null;
|
|
568
|
-
|
|
569
|
-
source: 'stocked' | 'byo';
|
|
570
|
-
|
|
571
|
-
status: 'in_stock' | 'owned' | 'installing' | 'installed' | 'install_failed' | 'retired';
|
|
572
|
-
|
|
573
|
-
subscriptionId: number | null;
|
|
574
|
-
|
|
575
|
-
updatedAt: string | null;
|
|
576
|
-
|
|
577
|
-
cancellationScheduled?: boolean;
|
|
578
|
-
|
|
579
|
-
checkoutUrl?: string | null;
|
|
580
|
-
|
|
581
|
-
currentPeriodEnd?: string | null;
|
|
582
|
-
|
|
583
|
-
exempt?: boolean;
|
|
584
|
-
|
|
585
|
-
rentStatus?:
|
|
586
|
-
| 'not_applicable'
|
|
587
|
-
| 'exempt'
|
|
588
|
-
| 'inactive'
|
|
589
|
-
| 'awaiting_payment'
|
|
590
|
-
| 'active'
|
|
591
|
-
| 'cancel_pending'
|
|
592
|
-
| 'refund_pending'
|
|
593
|
-
| 'retiring'
|
|
594
|
-
| 'billing_error';
|
|
595
|
-
}
|
|
596
|
-
|
|
597
|
-
export interface EsimAwaitingPaymentResponse {
|
|
598
|
-
checkoutUrl: string | null;
|
|
599
|
-
|
|
600
|
-
esim: EsimAwaitingPaymentResponse.Esim;
|
|
601
|
-
|
|
602
|
-
rentStatus: 'awaiting_payment';
|
|
603
|
-
}
|
|
604
|
-
|
|
605
|
-
export namespace EsimAwaitingPaymentResponse {
|
|
606
|
-
export interface Esim {
|
|
607
|
-
id: string;
|
|
608
|
-
|
|
609
|
-
carrierName: string | null;
|
|
610
|
-
|
|
611
|
-
countryCode: string | null;
|
|
612
|
-
|
|
613
|
-
createdAt: string | null;
|
|
614
|
-
|
|
615
|
-
createdBy: string | null;
|
|
616
|
-
|
|
617
|
-
deviceId: string | null;
|
|
618
|
-
|
|
619
|
-
deviceUuid: string | null;
|
|
620
|
-
|
|
621
|
-
iccid: string | null;
|
|
622
|
-
|
|
623
|
-
msisdn: string | null;
|
|
624
|
-
|
|
625
|
-
name: string | null;
|
|
626
|
-
|
|
627
|
-
networkStatus: 'degraded' | null;
|
|
628
|
-
|
|
629
|
-
source: 'stocked' | 'byo';
|
|
630
|
-
|
|
631
|
-
status: 'in_stock' | 'owned' | 'installing' | 'installed' | 'install_failed' | 'retired';
|
|
632
|
-
|
|
633
|
-
subscriptionId: number | null;
|
|
634
|
-
|
|
635
|
-
updatedAt: string | null;
|
|
636
|
-
|
|
637
|
-
cancellationScheduled?: boolean;
|
|
638
|
-
|
|
639
|
-
checkoutUrl?: string | null;
|
|
640
|
-
|
|
641
|
-
currentPeriodEnd?: string | null;
|
|
642
|
-
|
|
643
|
-
exempt?: boolean;
|
|
644
|
-
|
|
645
|
-
rentStatus?:
|
|
646
|
-
| 'not_applicable'
|
|
647
|
-
| 'exempt'
|
|
648
|
-
| 'inactive'
|
|
649
|
-
| 'awaiting_payment'
|
|
650
|
-
| 'active'
|
|
651
|
-
| 'cancel_pending'
|
|
652
|
-
| 'refund_pending'
|
|
653
|
-
| 'retiring'
|
|
654
|
-
| 'billing_error';
|
|
655
|
-
}
|
|
656
|
-
}
|
|
657
|
-
|
|
658
|
-
export interface EsimImportInstallDispatchFailedResponse {
|
|
659
|
-
id: string;
|
|
660
|
-
|
|
661
|
-
carrierName: string | null;
|
|
662
|
-
|
|
663
|
-
countryCode: string | null;
|
|
664
|
-
|
|
665
|
-
createdAt: string | null;
|
|
666
|
-
|
|
667
|
-
createdBy: string | null;
|
|
668
|
-
|
|
669
|
-
deviceId: string | null;
|
|
670
|
-
|
|
671
|
-
deviceUuid: string | null;
|
|
672
|
-
|
|
673
|
-
iccid: string | null;
|
|
674
|
-
|
|
675
|
-
installDispatch: EsimImportInstallDispatchFailedResponse.InstallDispatch;
|
|
676
|
-
|
|
677
|
-
msisdn: string | null;
|
|
678
|
-
|
|
679
|
-
name: string | null;
|
|
680
|
-
|
|
681
|
-
networkStatus: 'degraded' | null;
|
|
682
|
-
|
|
683
|
-
source: 'stocked' | 'byo';
|
|
684
|
-
|
|
685
|
-
status: 'in_stock' | 'owned' | 'installing' | 'installed' | 'install_failed' | 'retired';
|
|
686
|
-
|
|
687
|
-
subscriptionId: number | null;
|
|
688
|
-
|
|
689
|
-
updatedAt: string | null;
|
|
690
|
-
|
|
691
|
-
cancellationScheduled?: boolean;
|
|
692
|
-
|
|
693
|
-
checkoutUrl?: string | null;
|
|
694
|
-
|
|
695
|
-
currentPeriodEnd?: string | null;
|
|
696
|
-
|
|
697
|
-
exempt?: boolean;
|
|
698
|
-
|
|
699
|
-
rentStatus?:
|
|
700
|
-
| 'not_applicable'
|
|
701
|
-
| 'exempt'
|
|
702
|
-
| 'inactive'
|
|
703
|
-
| 'awaiting_payment'
|
|
704
|
-
| 'active'
|
|
705
|
-
| 'cancel_pending'
|
|
706
|
-
| 'refund_pending'
|
|
707
|
-
| 'retiring'
|
|
708
|
-
| 'billing_error';
|
|
709
|
-
}
|
|
710
|
-
|
|
711
|
-
export namespace EsimImportInstallDispatchFailedResponse {
|
|
712
|
-
export interface InstallDispatch {
|
|
713
|
-
ok: false;
|
|
714
|
-
|
|
715
|
-
reason: string;
|
|
716
|
-
}
|
|
717
|
-
}
|
|
718
|
-
}
|
|
719
|
-
|
|
720
|
-
export interface EsimInstallResponse {
|
|
721
|
-
data: EsimInstallResponse.Data;
|
|
722
|
-
}
|
|
723
|
-
|
|
724
|
-
export namespace EsimInstallResponse {
|
|
725
|
-
export interface Data {
|
|
726
|
-
id: string;
|
|
727
|
-
|
|
728
|
-
carrierName: string | null;
|
|
729
|
-
|
|
730
|
-
countryCode: string | null;
|
|
731
|
-
|
|
732
|
-
createdAt: string | null;
|
|
733
|
-
|
|
734
|
-
createdBy: string | null;
|
|
735
|
-
|
|
736
|
-
deviceId: string | null;
|
|
737
|
-
|
|
738
|
-
deviceUuid: string | null;
|
|
739
|
-
|
|
740
|
-
iccid: string | null;
|
|
741
|
-
|
|
742
|
-
msisdn: string | null;
|
|
743
|
-
|
|
744
|
-
name: string | null;
|
|
745
|
-
|
|
746
|
-
networkStatus: 'degraded' | null;
|
|
747
|
-
|
|
748
|
-
source: 'stocked' | 'byo';
|
|
749
|
-
|
|
750
|
-
status: 'in_stock' | 'owned' | 'installing' | 'installed' | 'install_failed' | 'retired';
|
|
751
|
-
|
|
752
|
-
subscriptionId: number | null;
|
|
753
|
-
|
|
754
|
-
updatedAt: string | null;
|
|
755
|
-
|
|
756
|
-
cancellationScheduled?: boolean;
|
|
757
|
-
|
|
758
|
-
checkoutUrl?: string | null;
|
|
759
|
-
|
|
760
|
-
currentPeriodEnd?: string | null;
|
|
761
|
-
|
|
762
|
-
exempt?: boolean;
|
|
763
|
-
|
|
764
|
-
rentStatus?:
|
|
765
|
-
| 'not_applicable'
|
|
766
|
-
| 'exempt'
|
|
767
|
-
| 'inactive'
|
|
768
|
-
| 'awaiting_payment'
|
|
769
|
-
| 'active'
|
|
770
|
-
| 'cancel_pending'
|
|
771
|
-
| 'refund_pending'
|
|
772
|
-
| 'retiring'
|
|
773
|
-
| 'billing_error';
|
|
774
|
-
}
|
|
775
|
-
}
|
|
776
|
-
|
|
777
|
-
export interface EsimInstallStatusResponse {
|
|
778
|
-
data: EsimInstallStatusResponse.Data;
|
|
779
|
-
}
|
|
780
|
-
|
|
781
|
-
export namespace EsimInstallStatusResponse {
|
|
782
|
-
export interface Data {
|
|
783
|
-
esim: Data.Esim;
|
|
784
|
-
|
|
785
|
-
operationId: string | null;
|
|
786
|
-
|
|
787
|
-
status:
|
|
788
|
-
| 'installing'
|
|
789
|
-
| 'pending_download'
|
|
790
|
-
| 'downloading'
|
|
791
|
-
| 'downloaded'
|
|
792
|
-
| 'enabling'
|
|
793
|
-
| 'configuring_apn'
|
|
794
|
-
| 'active'
|
|
795
|
-
| 'download_failed'
|
|
796
|
-
| 'enable_failed'
|
|
797
|
-
| 'download_outcome_unknown'
|
|
798
|
-
| 'install_failed'
|
|
799
|
-
| 'physical_removal_unconfirmed'
|
|
800
|
-
| 'deleted'
|
|
801
|
-
| null;
|
|
802
|
-
}
|
|
803
|
-
|
|
804
|
-
export namespace Data {
|
|
805
|
-
export interface Esim {
|
|
806
|
-
id: string;
|
|
807
|
-
|
|
808
|
-
carrierName: string | null;
|
|
809
|
-
|
|
810
|
-
countryCode: string | null;
|
|
811
|
-
|
|
812
|
-
createdAt: string | null;
|
|
813
|
-
|
|
814
|
-
createdBy: string | null;
|
|
815
|
-
|
|
816
|
-
deviceId: string | null;
|
|
817
|
-
|
|
818
|
-
deviceUuid: string | null;
|
|
819
|
-
|
|
820
|
-
iccid: string | null;
|
|
821
|
-
|
|
822
|
-
msisdn: string | null;
|
|
823
|
-
|
|
824
|
-
name: string | null;
|
|
825
|
-
|
|
826
|
-
networkStatus: 'degraded' | null;
|
|
827
|
-
|
|
828
|
-
source: 'stocked' | 'byo';
|
|
829
|
-
|
|
830
|
-
status: 'in_stock' | 'owned' | 'installing' | 'installed' | 'install_failed' | 'retired';
|
|
831
|
-
|
|
832
|
-
subscriptionId: number | null;
|
|
833
|
-
|
|
834
|
-
updatedAt: string | null;
|
|
835
|
-
|
|
836
|
-
cancellationScheduled?: boolean;
|
|
837
|
-
|
|
838
|
-
checkoutUrl?: string | null;
|
|
839
|
-
|
|
840
|
-
currentPeriodEnd?: string | null;
|
|
841
|
-
|
|
842
|
-
exempt?: boolean;
|
|
843
|
-
|
|
844
|
-
rentStatus?:
|
|
845
|
-
| 'not_applicable'
|
|
846
|
-
| 'exempt'
|
|
847
|
-
| 'inactive'
|
|
848
|
-
| 'awaiting_payment'
|
|
849
|
-
| 'active'
|
|
850
|
-
| 'cancel_pending'
|
|
851
|
-
| 'refund_pending'
|
|
852
|
-
| 'retiring'
|
|
853
|
-
| 'billing_error';
|
|
854
|
-
}
|
|
855
|
-
}
|
|
856
|
-
}
|
|
857
|
-
|
|
858
|
-
export interface EsimSelectorResponse {
|
|
859
|
-
items: Array<EsimSelectorResponse.Item>;
|
|
860
|
-
|
|
861
|
-
pagination: Shared.Pagination;
|
|
862
|
-
}
|
|
863
|
-
|
|
864
|
-
export namespace EsimSelectorResponse {
|
|
865
|
-
export interface Item {
|
|
866
|
-
id: string;
|
|
867
|
-
|
|
868
|
-
carrierName: string | null;
|
|
869
|
-
|
|
870
|
-
iccid: string | null;
|
|
871
|
-
|
|
872
|
-
msisdn: string | null;
|
|
873
|
-
|
|
874
|
-
name: string | null;
|
|
875
|
-
|
|
876
|
-
source: 'stocked' | 'byo';
|
|
877
|
-
|
|
878
|
-
status: 'in_stock' | 'owned' | 'installing' | 'installed' | 'install_failed' | 'retired';
|
|
879
|
-
}
|
|
880
|
-
}
|
|
881
|
-
|
|
882
|
-
export interface EsimCreateParams {
|
|
883
|
-
/**
|
|
884
|
-
* Client-supplied key; replaying the same key returns the original purchase
|
|
885
|
-
* instead of buying again
|
|
886
|
-
*/
|
|
887
|
-
idempotencyKey?: string;
|
|
888
|
-
|
|
889
|
-
/**
|
|
890
|
-
* Optional user-defined display label — NFC-normalized, up to 15 GRAPHEMES. Omit
|
|
891
|
-
* or null for no label.
|
|
892
|
-
*/
|
|
893
|
-
name?: string | null;
|
|
894
|
-
}
|
|
895
|
-
|
|
896
|
-
export interface EsimUpdateParams {
|
|
897
|
-
/**
|
|
898
|
-
* Self-reported E.164 MSISDN for this eSIM's line. Omit to leave unchanged;
|
|
899
|
-
* null/empty clears it. An unverified label — never used for routing.
|
|
900
|
-
*/
|
|
901
|
-
msisdn?: string | null;
|
|
902
|
-
|
|
903
|
-
/**
|
|
904
|
-
* User-defined display label — NFC-normalized, up to 15 GRAPHEMES (not UTF-16 code
|
|
905
|
-
* units; an emoji/flag may span several). Omit to leave unchanged;
|
|
906
|
-
* null/empty/whitespace-only clears it.
|
|
907
|
-
*/
|
|
908
|
-
name?: string | null;
|
|
909
|
-
}
|
|
910
|
-
|
|
911
|
-
export interface EsimListParams {
|
|
912
|
-
/**
|
|
913
|
-
* Only include eSIMs created by the calling actor.
|
|
914
|
-
*/
|
|
915
|
-
mine?: 'true' | 'false';
|
|
916
|
-
|
|
917
|
-
page?: number;
|
|
918
|
-
|
|
919
|
-
pageSize?: number;
|
|
920
|
-
|
|
921
|
-
status?: 'all' | 'in_stock' | 'owned' | 'installing' | 'installed' | 'install_failed' | 'retired';
|
|
922
|
-
}
|
|
923
|
-
|
|
924
|
-
export interface EsimImportParams {
|
|
925
|
-
/**
|
|
926
|
-
* Rent OFF only: dispatch install-on-device immediately after a successful import.
|
|
927
|
-
* No-op when ESIM_BYO_RENT_ENABLED=true.
|
|
928
|
-
*/
|
|
929
|
-
autoInstall?: boolean;
|
|
930
|
-
|
|
931
|
-
carrierName?: string;
|
|
932
|
-
|
|
933
|
-
confirmationCode?: string;
|
|
934
|
-
|
|
935
|
-
countryCode?: string;
|
|
936
|
-
|
|
937
|
-
/**
|
|
938
|
-
* physedge device id to auto-install onto; requires autoInstall:true and rent OFF.
|
|
939
|
-
* Omit for a random pool device.
|
|
940
|
-
*/
|
|
941
|
-
deviceId?: string;
|
|
942
|
-
|
|
943
|
-
/**
|
|
944
|
-
* Client-supplied key; replaying the same key+request returns the original import
|
|
945
|
-
* instead of importing again
|
|
946
|
-
*/
|
|
947
|
-
idempotencyKey?: string;
|
|
948
|
-
|
|
949
|
-
/**
|
|
950
|
-
* Full LPA activation code
|
|
951
|
-
*/
|
|
952
|
-
lpaCode?: string;
|
|
953
|
-
|
|
954
|
-
matchingId?: string;
|
|
955
|
-
|
|
956
|
-
/**
|
|
957
|
-
* Self-reported E.164 MSISDN for this eSIM's line — an unverified label, never
|
|
958
|
-
* used for routing
|
|
959
|
-
*/
|
|
960
|
-
msisdn?: string;
|
|
961
|
-
|
|
962
|
-
/**
|
|
963
|
-
* User-defined display label — NFC-normalized, up to 15 GRAPHEMES (not UTF-16 code
|
|
964
|
-
* units; an emoji/flag may span several). Omit/null/empty/whitespace-only leaves
|
|
965
|
-
* it unset.
|
|
966
|
-
*/
|
|
967
|
-
name?: string | null;
|
|
968
|
-
|
|
969
|
-
notes?: string;
|
|
970
|
-
|
|
971
|
-
/**
|
|
972
|
-
* SM-DP+ activation host — bare hostname ONLY, no port/scheme/path.
|
|
973
|
-
*/
|
|
974
|
-
smdpAddress?: string;
|
|
975
|
-
}
|
|
976
|
-
|
|
977
|
-
export interface EsimInstallParams {
|
|
978
|
-
/**
|
|
979
|
-
* physedge device id to install the eSIM onto; omit for a random pool device
|
|
980
|
-
*/
|
|
981
|
-
deviceId?: string;
|
|
982
|
-
}
|
|
983
|
-
|
|
984
|
-
export interface EsimSelectorParams {
|
|
985
|
-
page?: number;
|
|
986
|
-
|
|
987
|
-
pageSize?: number;
|
|
988
|
-
}
|
|
989
|
-
|
|
990
|
-
Esims.Messages = Messages;
|
|
991
|
-
|
|
992
|
-
export declare namespace Esims {
|
|
993
|
-
export {
|
|
994
|
-
type EsimCreateResponse as EsimCreateResponse,
|
|
995
|
-
type EsimRetrieveResponse as EsimRetrieveResponse,
|
|
996
|
-
type EsimUpdateResponse as EsimUpdateResponse,
|
|
997
|
-
type EsimListResponse as EsimListResponse,
|
|
998
|
-
type EsimCapacityResponse as EsimCapacityResponse,
|
|
999
|
-
type EsimConfirmPaymentResponse as EsimConfirmPaymentResponse,
|
|
1000
|
-
type EsimImportResponse as EsimImportResponse,
|
|
1001
|
-
type EsimInstallResponse as EsimInstallResponse,
|
|
1002
|
-
type EsimInstallStatusResponse as EsimInstallStatusResponse,
|
|
1003
|
-
type EsimSelectorResponse as EsimSelectorResponse,
|
|
1004
|
-
type EsimCreateParams as EsimCreateParams,
|
|
1005
|
-
type EsimUpdateParams as EsimUpdateParams,
|
|
1006
|
-
type EsimListParams as EsimListParams,
|
|
1007
|
-
type EsimImportParams as EsimImportParams,
|
|
1008
|
-
type EsimInstallParams as EsimInstallParams,
|
|
1009
|
-
type EsimSelectorParams as EsimSelectorParams,
|
|
1010
|
-
};
|
|
1011
|
-
|
|
1012
|
-
export {
|
|
1013
|
-
Messages as Messages,
|
|
1014
|
-
type MessageListResponse as MessageListResponse,
|
|
1015
|
-
type MessageSendResponse as MessageSendResponse,
|
|
1016
|
-
type MessageListParams as MessageListParams,
|
|
1017
|
-
type MessageSendParams as MessageSendParams,
|
|
1018
|
-
};
|
|
1019
|
-
}
|