@onesim.global/sdk 0.0.0-stage → 0.1.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 +40 -0
- package/LICENSE +21 -0
- package/README.md +365 -2
- package/dist/cjs/client.d.ts +130 -0
- package/dist/cjs/client.js +314 -0
- package/dist/cjs/errors.d.ts +126 -0
- package/dist/cjs/errors.js +199 -0
- package/dist/cjs/generated/openapi.d.ts +2090 -0
- package/dist/cjs/generated/openapi.js +5 -0
- package/dist/cjs/http.d.ts +40 -0
- package/dist/cjs/http.js +211 -0
- package/dist/cjs/index.d.ts +8 -0
- package/dist/cjs/index.js +27 -0
- package/dist/cjs/package.json +3 -0
- package/dist/cjs/types.d.ts +56 -0
- package/dist/cjs/types.js +4 -0
- package/dist/cjs/webhooks.d.ts +26 -0
- package/dist/cjs/webhooks.js +98 -0
- package/dist/esm/client.d.ts +130 -0
- package/dist/esm/client.js +306 -0
- package/dist/esm/errors.d.ts +126 -0
- package/dist/esm/errors.js +182 -0
- package/dist/esm/generated/openapi.d.ts +2090 -0
- package/dist/esm/generated/openapi.js +4 -0
- package/dist/esm/http.d.ts +40 -0
- package/dist/esm/http.js +205 -0
- package/dist/esm/index.d.ts +8 -0
- package/dist/esm/index.js +5 -0
- package/dist/esm/types.d.ts +56 -0
- package/dist/esm/types.js +3 -0
- package/dist/esm/webhooks.d.ts +26 -0
- package/dist/esm/webhooks.js +95 -0
- package/package.json +64 -4
|
@@ -0,0 +1,2090 @@
|
|
|
1
|
+
export interface paths {
|
|
2
|
+
"/v1/packages": {
|
|
3
|
+
parameters: {
|
|
4
|
+
query?: never;
|
|
5
|
+
header?: never;
|
|
6
|
+
path?: never;
|
|
7
|
+
cookie?: never;
|
|
8
|
+
};
|
|
9
|
+
/** List your catalogue */
|
|
10
|
+
get: operations["listPackages"];
|
|
11
|
+
put?: never;
|
|
12
|
+
post?: never;
|
|
13
|
+
delete?: never;
|
|
14
|
+
options?: never;
|
|
15
|
+
head?: never;
|
|
16
|
+
patch?: never;
|
|
17
|
+
trace?: never;
|
|
18
|
+
};
|
|
19
|
+
"/v1/packages/{id}": {
|
|
20
|
+
parameters: {
|
|
21
|
+
query?: never;
|
|
22
|
+
header?: never;
|
|
23
|
+
path?: never;
|
|
24
|
+
cookie?: never;
|
|
25
|
+
};
|
|
26
|
+
/** Get one package */
|
|
27
|
+
get: operations["getPackage"];
|
|
28
|
+
put?: never;
|
|
29
|
+
post?: never;
|
|
30
|
+
delete?: never;
|
|
31
|
+
options?: never;
|
|
32
|
+
head?: never;
|
|
33
|
+
patch?: never;
|
|
34
|
+
trace?: never;
|
|
35
|
+
};
|
|
36
|
+
"/v1/orders": {
|
|
37
|
+
parameters: {
|
|
38
|
+
query?: never;
|
|
39
|
+
header?: never;
|
|
40
|
+
path?: never;
|
|
41
|
+
cookie?: never;
|
|
42
|
+
};
|
|
43
|
+
/** List your orders, newest first */
|
|
44
|
+
get: operations["listOrders"];
|
|
45
|
+
put?: never;
|
|
46
|
+
/** Buy a blank eSIM, a package or a bundle */
|
|
47
|
+
post: operations["createOrder"];
|
|
48
|
+
delete?: never;
|
|
49
|
+
options?: never;
|
|
50
|
+
head?: never;
|
|
51
|
+
patch?: never;
|
|
52
|
+
trace?: never;
|
|
53
|
+
};
|
|
54
|
+
"/v1/orders/{id}": {
|
|
55
|
+
parameters: {
|
|
56
|
+
query?: never;
|
|
57
|
+
header?: never;
|
|
58
|
+
path?: never;
|
|
59
|
+
cookie?: never;
|
|
60
|
+
};
|
|
61
|
+
/**
|
|
62
|
+
* Get one order
|
|
63
|
+
* @description Reading a pending order also moves it forward.
|
|
64
|
+
*/
|
|
65
|
+
get: operations["getOrder"];
|
|
66
|
+
put?: never;
|
|
67
|
+
post?: never;
|
|
68
|
+
delete?: never;
|
|
69
|
+
options?: never;
|
|
70
|
+
head?: never;
|
|
71
|
+
patch?: never;
|
|
72
|
+
trace?: never;
|
|
73
|
+
};
|
|
74
|
+
"/v1/esims": {
|
|
75
|
+
parameters: {
|
|
76
|
+
query?: never;
|
|
77
|
+
header?: never;
|
|
78
|
+
path?: never;
|
|
79
|
+
cookie?: never;
|
|
80
|
+
};
|
|
81
|
+
/** List your eSIMs, newest first */
|
|
82
|
+
get: operations["listEsims"];
|
|
83
|
+
put?: never;
|
|
84
|
+
post?: never;
|
|
85
|
+
delete?: never;
|
|
86
|
+
options?: never;
|
|
87
|
+
head?: never;
|
|
88
|
+
patch?: never;
|
|
89
|
+
trace?: never;
|
|
90
|
+
};
|
|
91
|
+
"/v1/esims/{id}": {
|
|
92
|
+
parameters: {
|
|
93
|
+
query?: never;
|
|
94
|
+
header?: never;
|
|
95
|
+
path?: never;
|
|
96
|
+
cookie?: never;
|
|
97
|
+
};
|
|
98
|
+
/** Get one eSIM with its packages and usage */
|
|
99
|
+
get: operations["getEsim"];
|
|
100
|
+
put?: never;
|
|
101
|
+
post?: never;
|
|
102
|
+
delete?: never;
|
|
103
|
+
options?: never;
|
|
104
|
+
head?: never;
|
|
105
|
+
patch?: never;
|
|
106
|
+
trace?: never;
|
|
107
|
+
};
|
|
108
|
+
"/v1/balance": {
|
|
109
|
+
parameters: {
|
|
110
|
+
query?: never;
|
|
111
|
+
header?: never;
|
|
112
|
+
path?: never;
|
|
113
|
+
cookie?: never;
|
|
114
|
+
};
|
|
115
|
+
/** Get your balance */
|
|
116
|
+
get: operations["getBalance"];
|
|
117
|
+
put?: never;
|
|
118
|
+
post?: never;
|
|
119
|
+
delete?: never;
|
|
120
|
+
options?: never;
|
|
121
|
+
head?: never;
|
|
122
|
+
patch?: never;
|
|
123
|
+
trace?: never;
|
|
124
|
+
};
|
|
125
|
+
"/v1/openapi.json": {
|
|
126
|
+
parameters: {
|
|
127
|
+
query?: never;
|
|
128
|
+
header?: never;
|
|
129
|
+
path?: never;
|
|
130
|
+
cookie?: never;
|
|
131
|
+
};
|
|
132
|
+
/**
|
|
133
|
+
* This document
|
|
134
|
+
* @description For generating a client or checking what changed. Any of your keys reads it.
|
|
135
|
+
*/
|
|
136
|
+
get: operations["getOpenApi"];
|
|
137
|
+
put?: never;
|
|
138
|
+
post?: never;
|
|
139
|
+
delete?: never;
|
|
140
|
+
options?: never;
|
|
141
|
+
head?: never;
|
|
142
|
+
patch?: never;
|
|
143
|
+
trace?: never;
|
|
144
|
+
};
|
|
145
|
+
}
|
|
146
|
+
export interface webhooks {
|
|
147
|
+
"order.completed": {
|
|
148
|
+
parameters: {
|
|
149
|
+
query?: never;
|
|
150
|
+
header?: never;
|
|
151
|
+
path?: never;
|
|
152
|
+
cookie?: never;
|
|
153
|
+
};
|
|
154
|
+
get?: never;
|
|
155
|
+
put?: never;
|
|
156
|
+
/**
|
|
157
|
+
* order.completed
|
|
158
|
+
* @description An order completed: its eSIM has its activation code and its package is on it.
|
|
159
|
+
*/
|
|
160
|
+
post: {
|
|
161
|
+
parameters: {
|
|
162
|
+
query?: never;
|
|
163
|
+
header?: never;
|
|
164
|
+
path?: never;
|
|
165
|
+
cookie?: never;
|
|
166
|
+
};
|
|
167
|
+
requestBody: {
|
|
168
|
+
content: {
|
|
169
|
+
"application/json": components["schemas"]["OrderEvent"];
|
|
170
|
+
};
|
|
171
|
+
};
|
|
172
|
+
responses: {
|
|
173
|
+
/** @description Received. */
|
|
174
|
+
"2XX": {
|
|
175
|
+
headers: {
|
|
176
|
+
[name: string]: unknown;
|
|
177
|
+
};
|
|
178
|
+
content?: never;
|
|
179
|
+
};
|
|
180
|
+
};
|
|
181
|
+
};
|
|
182
|
+
delete?: never;
|
|
183
|
+
options?: never;
|
|
184
|
+
head?: never;
|
|
185
|
+
patch?: never;
|
|
186
|
+
trace?: never;
|
|
187
|
+
};
|
|
188
|
+
"order.failed": {
|
|
189
|
+
parameters: {
|
|
190
|
+
query?: never;
|
|
191
|
+
header?: never;
|
|
192
|
+
path?: never;
|
|
193
|
+
cookie?: never;
|
|
194
|
+
};
|
|
195
|
+
get?: never;
|
|
196
|
+
put?: never;
|
|
197
|
+
/**
|
|
198
|
+
* order.failed
|
|
199
|
+
* @description An order failed and was refunded.
|
|
200
|
+
*/
|
|
201
|
+
post: {
|
|
202
|
+
parameters: {
|
|
203
|
+
query?: never;
|
|
204
|
+
header?: never;
|
|
205
|
+
path?: never;
|
|
206
|
+
cookie?: never;
|
|
207
|
+
};
|
|
208
|
+
requestBody: {
|
|
209
|
+
content: {
|
|
210
|
+
"application/json": components["schemas"]["OrderEvent"];
|
|
211
|
+
};
|
|
212
|
+
};
|
|
213
|
+
responses: {
|
|
214
|
+
/** @description Received. */
|
|
215
|
+
"2XX": {
|
|
216
|
+
headers: {
|
|
217
|
+
[name: string]: unknown;
|
|
218
|
+
};
|
|
219
|
+
content?: never;
|
|
220
|
+
};
|
|
221
|
+
};
|
|
222
|
+
};
|
|
223
|
+
delete?: never;
|
|
224
|
+
options?: never;
|
|
225
|
+
head?: never;
|
|
226
|
+
patch?: never;
|
|
227
|
+
trace?: never;
|
|
228
|
+
};
|
|
229
|
+
"package.activated": {
|
|
230
|
+
parameters: {
|
|
231
|
+
query?: never;
|
|
232
|
+
header?: never;
|
|
233
|
+
path?: never;
|
|
234
|
+
cookie?: never;
|
|
235
|
+
};
|
|
236
|
+
get?: never;
|
|
237
|
+
put?: never;
|
|
238
|
+
/**
|
|
239
|
+
* package.activated
|
|
240
|
+
* @description A package activated on first connection; its validity runs from now.
|
|
241
|
+
*/
|
|
242
|
+
post: {
|
|
243
|
+
parameters: {
|
|
244
|
+
query?: never;
|
|
245
|
+
header?: never;
|
|
246
|
+
path?: never;
|
|
247
|
+
cookie?: never;
|
|
248
|
+
};
|
|
249
|
+
requestBody: {
|
|
250
|
+
content: {
|
|
251
|
+
"application/json": components["schemas"]["PackageEvent"];
|
|
252
|
+
};
|
|
253
|
+
};
|
|
254
|
+
responses: {
|
|
255
|
+
/** @description Received. */
|
|
256
|
+
"2XX": {
|
|
257
|
+
headers: {
|
|
258
|
+
[name: string]: unknown;
|
|
259
|
+
};
|
|
260
|
+
content?: never;
|
|
261
|
+
};
|
|
262
|
+
};
|
|
263
|
+
};
|
|
264
|
+
delete?: never;
|
|
265
|
+
options?: never;
|
|
266
|
+
head?: never;
|
|
267
|
+
patch?: never;
|
|
268
|
+
trace?: never;
|
|
269
|
+
};
|
|
270
|
+
"package.usage": {
|
|
271
|
+
parameters: {
|
|
272
|
+
query?: never;
|
|
273
|
+
header?: never;
|
|
274
|
+
path?: never;
|
|
275
|
+
cookie?: never;
|
|
276
|
+
};
|
|
277
|
+
get?: never;
|
|
278
|
+
put?: never;
|
|
279
|
+
/**
|
|
280
|
+
* package.usage
|
|
281
|
+
* @description A package passed a usage threshold (`percent_used`).
|
|
282
|
+
*/
|
|
283
|
+
post: {
|
|
284
|
+
parameters: {
|
|
285
|
+
query?: never;
|
|
286
|
+
header?: never;
|
|
287
|
+
path?: never;
|
|
288
|
+
cookie?: never;
|
|
289
|
+
};
|
|
290
|
+
requestBody: {
|
|
291
|
+
content: {
|
|
292
|
+
"application/json": components["schemas"]["PackageEvent"];
|
|
293
|
+
};
|
|
294
|
+
};
|
|
295
|
+
responses: {
|
|
296
|
+
/** @description Received. */
|
|
297
|
+
"2XX": {
|
|
298
|
+
headers: {
|
|
299
|
+
[name: string]: unknown;
|
|
300
|
+
};
|
|
301
|
+
content?: never;
|
|
302
|
+
};
|
|
303
|
+
};
|
|
304
|
+
};
|
|
305
|
+
delete?: never;
|
|
306
|
+
options?: never;
|
|
307
|
+
head?: never;
|
|
308
|
+
patch?: never;
|
|
309
|
+
trace?: never;
|
|
310
|
+
};
|
|
311
|
+
"package.expired": {
|
|
312
|
+
parameters: {
|
|
313
|
+
query?: never;
|
|
314
|
+
header?: never;
|
|
315
|
+
path?: never;
|
|
316
|
+
cookie?: never;
|
|
317
|
+
};
|
|
318
|
+
get?: never;
|
|
319
|
+
put?: never;
|
|
320
|
+
/**
|
|
321
|
+
* package.expired
|
|
322
|
+
* @description A package ended: its data ran out or its validity did.
|
|
323
|
+
*/
|
|
324
|
+
post: {
|
|
325
|
+
parameters: {
|
|
326
|
+
query?: never;
|
|
327
|
+
header?: never;
|
|
328
|
+
path?: never;
|
|
329
|
+
cookie?: never;
|
|
330
|
+
};
|
|
331
|
+
requestBody: {
|
|
332
|
+
content: {
|
|
333
|
+
"application/json": components["schemas"]["PackageEvent"];
|
|
334
|
+
};
|
|
335
|
+
};
|
|
336
|
+
responses: {
|
|
337
|
+
/** @description Received. */
|
|
338
|
+
"2XX": {
|
|
339
|
+
headers: {
|
|
340
|
+
[name: string]: unknown;
|
|
341
|
+
};
|
|
342
|
+
content?: never;
|
|
343
|
+
};
|
|
344
|
+
};
|
|
345
|
+
};
|
|
346
|
+
delete?: never;
|
|
347
|
+
options?: never;
|
|
348
|
+
head?: never;
|
|
349
|
+
patch?: never;
|
|
350
|
+
trace?: never;
|
|
351
|
+
};
|
|
352
|
+
"balance.low": {
|
|
353
|
+
parameters: {
|
|
354
|
+
query?: never;
|
|
355
|
+
header?: never;
|
|
356
|
+
path?: never;
|
|
357
|
+
cookie?: never;
|
|
358
|
+
};
|
|
359
|
+
get?: never;
|
|
360
|
+
put?: never;
|
|
361
|
+
/**
|
|
362
|
+
* balance.low
|
|
363
|
+
* @description An order took the amount available to spend below your threshold.
|
|
364
|
+
*/
|
|
365
|
+
post: {
|
|
366
|
+
parameters: {
|
|
367
|
+
query?: never;
|
|
368
|
+
header?: never;
|
|
369
|
+
path?: never;
|
|
370
|
+
cookie?: never;
|
|
371
|
+
};
|
|
372
|
+
requestBody: {
|
|
373
|
+
content: {
|
|
374
|
+
"application/json": components["schemas"]["BalanceEvent"];
|
|
375
|
+
};
|
|
376
|
+
};
|
|
377
|
+
responses: {
|
|
378
|
+
/** @description Received. */
|
|
379
|
+
"2XX": {
|
|
380
|
+
headers: {
|
|
381
|
+
[name: string]: unknown;
|
|
382
|
+
};
|
|
383
|
+
content?: never;
|
|
384
|
+
};
|
|
385
|
+
};
|
|
386
|
+
};
|
|
387
|
+
delete?: never;
|
|
388
|
+
options?: never;
|
|
389
|
+
head?: never;
|
|
390
|
+
patch?: never;
|
|
391
|
+
trace?: never;
|
|
392
|
+
};
|
|
393
|
+
ping: {
|
|
394
|
+
parameters: {
|
|
395
|
+
query?: never;
|
|
396
|
+
header?: never;
|
|
397
|
+
path?: never;
|
|
398
|
+
cookie?: never;
|
|
399
|
+
};
|
|
400
|
+
get?: never;
|
|
401
|
+
put?: never;
|
|
402
|
+
/**
|
|
403
|
+
* ping
|
|
404
|
+
* @description A test event sent from the partner platform.
|
|
405
|
+
*/
|
|
406
|
+
post: {
|
|
407
|
+
parameters: {
|
|
408
|
+
query?: never;
|
|
409
|
+
header?: never;
|
|
410
|
+
path?: never;
|
|
411
|
+
cookie?: never;
|
|
412
|
+
};
|
|
413
|
+
requestBody: {
|
|
414
|
+
content: {
|
|
415
|
+
"application/json": components["schemas"]["PingEvent"];
|
|
416
|
+
};
|
|
417
|
+
};
|
|
418
|
+
responses: {
|
|
419
|
+
/** @description Received. */
|
|
420
|
+
"2XX": {
|
|
421
|
+
headers: {
|
|
422
|
+
[name: string]: unknown;
|
|
423
|
+
};
|
|
424
|
+
content?: never;
|
|
425
|
+
};
|
|
426
|
+
};
|
|
427
|
+
};
|
|
428
|
+
delete?: never;
|
|
429
|
+
options?: never;
|
|
430
|
+
head?: never;
|
|
431
|
+
patch?: never;
|
|
432
|
+
trace?: never;
|
|
433
|
+
};
|
|
434
|
+
}
|
|
435
|
+
export interface components {
|
|
436
|
+
schemas: {
|
|
437
|
+
Error: {
|
|
438
|
+
error: {
|
|
439
|
+
/** @enum {string} */
|
|
440
|
+
code: "invalid_request" | "idempotency_key_required" | "unauthorized" | "insufficient_balance" | "not_offered" | "not_found" | "method_not_allowed" | "idempotency_conflict" | "esim_busy" | "price_changed" | "esim_limit_reached" | "esim_unusable" | "rate_limited" | "internal_error" | "provisioning_failed" | "esims_unavailable";
|
|
441
|
+
message: string;
|
|
442
|
+
request_id: string;
|
|
443
|
+
/** @description price_changed: the current amount. */
|
|
444
|
+
amount?: number;
|
|
445
|
+
/**
|
|
446
|
+
* @description esim_limit_reached: which limit.
|
|
447
|
+
* @enum {string}
|
|
448
|
+
*/
|
|
449
|
+
limit?: "blank" | "daily";
|
|
450
|
+
order?: components["schemas"]["Order"];
|
|
451
|
+
};
|
|
452
|
+
};
|
|
453
|
+
Country: {
|
|
454
|
+
/** @description ISO 3166-1 alpha-2; Kosovo is XK. */
|
|
455
|
+
code: string;
|
|
456
|
+
/** @description Mobile networks the package uses there. */
|
|
457
|
+
networks: string[];
|
|
458
|
+
};
|
|
459
|
+
/**
|
|
460
|
+
* @example {
|
|
461
|
+
* "id": "5f0c1a52-8f3e-4c1e-9b7a-2d6e4f8a1c03",
|
|
462
|
+
* "name": "One Kosovo 5GB",
|
|
463
|
+
* "countries": [
|
|
464
|
+
* {
|
|
465
|
+
* "code": "AL",
|
|
466
|
+
* "networks": [
|
|
467
|
+
* "Vodafone"
|
|
468
|
+
* ]
|
|
469
|
+
* },
|
|
470
|
+
* {
|
|
471
|
+
* "code": "RS",
|
|
472
|
+
* "networks": [
|
|
473
|
+
* "A1",
|
|
474
|
+
* "Yettel"
|
|
475
|
+
* ]
|
|
476
|
+
* },
|
|
477
|
+
* {
|
|
478
|
+
* "code": "XK",
|
|
479
|
+
* "networks": [
|
|
480
|
+
* "IPKO"
|
|
481
|
+
* ]
|
|
482
|
+
* }
|
|
483
|
+
* ],
|
|
484
|
+
* "data": 5242880000,
|
|
485
|
+
* "validity_days": 30,
|
|
486
|
+
* "currency": "EUR",
|
|
487
|
+
* "price": 700,
|
|
488
|
+
* "bundle": {
|
|
489
|
+
* "esim_price": 0,
|
|
490
|
+
* "package_price": 700,
|
|
491
|
+
* "amount": 700
|
|
492
|
+
* }
|
|
493
|
+
* }
|
|
494
|
+
*/
|
|
495
|
+
Package: {
|
|
496
|
+
/** Format: uuid */
|
|
497
|
+
id: string;
|
|
498
|
+
name: string;
|
|
499
|
+
countries: components["schemas"]["Country"][];
|
|
500
|
+
/** @description Data allowance in bytes. */
|
|
501
|
+
data: number;
|
|
502
|
+
/** @description Days of validity from activation. */
|
|
503
|
+
validity_days: number;
|
|
504
|
+
/**
|
|
505
|
+
* @description Your account's currency: all your prices, orders and your balance are in it.
|
|
506
|
+
* @enum {string}
|
|
507
|
+
*/
|
|
508
|
+
currency: "EUR" | "USD";
|
|
509
|
+
/** @description On an eSIM you own (`type: package`); null if not offered. */
|
|
510
|
+
price: number | null;
|
|
511
|
+
/** @description With a new eSIM (`type: bundle`); null if not offered. */
|
|
512
|
+
bundle: components["schemas"]["Bundle"] | null;
|
|
513
|
+
};
|
|
514
|
+
Bundle: {
|
|
515
|
+
/** @description Minor units (cents) of `currency`. */
|
|
516
|
+
esim_price: number;
|
|
517
|
+
/** @description Minor units (cents) of `currency`. */
|
|
518
|
+
package_price: number;
|
|
519
|
+
/** @description Minor units (cents) of `currency`. */
|
|
520
|
+
amount: number;
|
|
521
|
+
};
|
|
522
|
+
/**
|
|
523
|
+
* @example {
|
|
524
|
+
* "esim_price": 150,
|
|
525
|
+
* "currency": "EUR",
|
|
526
|
+
* "data": [
|
|
527
|
+
* {
|
|
528
|
+
* "id": "5f0c1a52-8f3e-4c1e-9b7a-2d6e4f8a1c03",
|
|
529
|
+
* "name": "One Kosovo 5GB",
|
|
530
|
+
* "countries": [
|
|
531
|
+
* {
|
|
532
|
+
* "code": "AL",
|
|
533
|
+
* "networks": [
|
|
534
|
+
* "Vodafone"
|
|
535
|
+
* ]
|
|
536
|
+
* },
|
|
537
|
+
* {
|
|
538
|
+
* "code": "RS",
|
|
539
|
+
* "networks": [
|
|
540
|
+
* "A1",
|
|
541
|
+
* "Yettel"
|
|
542
|
+
* ]
|
|
543
|
+
* },
|
|
544
|
+
* {
|
|
545
|
+
* "code": "XK",
|
|
546
|
+
* "networks": [
|
|
547
|
+
* "IPKO"
|
|
548
|
+
* ]
|
|
549
|
+
* }
|
|
550
|
+
* ],
|
|
551
|
+
* "data": 5242880000,
|
|
552
|
+
* "validity_days": 30,
|
|
553
|
+
* "currency": "EUR",
|
|
554
|
+
* "price": 700,
|
|
555
|
+
* "bundle": {
|
|
556
|
+
* "esim_price": 0,
|
|
557
|
+
* "package_price": 700,
|
|
558
|
+
* "amount": 700
|
|
559
|
+
* }
|
|
560
|
+
* }
|
|
561
|
+
* ]
|
|
562
|
+
* }
|
|
563
|
+
*/
|
|
564
|
+
Catalogue: {
|
|
565
|
+
/** @description A blank eSIM (`type: esim`); null if not offered. */
|
|
566
|
+
esim_price: number | null;
|
|
567
|
+
/**
|
|
568
|
+
* @description Your account's currency: all your prices, orders and your balance are in it.
|
|
569
|
+
* @enum {string}
|
|
570
|
+
*/
|
|
571
|
+
currency: "EUR" | "USD";
|
|
572
|
+
data: components["schemas"]["Package"][];
|
|
573
|
+
};
|
|
574
|
+
/**
|
|
575
|
+
* @example {
|
|
576
|
+
* "type": "bundle",
|
|
577
|
+
* "package_id": "5f0c1a52-8f3e-4c1e-9b7a-2d6e4f8a1c03",
|
|
578
|
+
* "reference": "BOOKING-1042",
|
|
579
|
+
* "expected_amount": 700
|
|
580
|
+
* }
|
|
581
|
+
*/
|
|
582
|
+
OrderRequest: {
|
|
583
|
+
/** @enum {string} */
|
|
584
|
+
type: "esim" | "package" | "bundle";
|
|
585
|
+
/**
|
|
586
|
+
* Format: uuid
|
|
587
|
+
* @description For `package`: the eSIM that gets the package.
|
|
588
|
+
*/
|
|
589
|
+
esim_id?: string;
|
|
590
|
+
/**
|
|
591
|
+
* Format: uuid
|
|
592
|
+
* @description For `package` and `bundle`: from your catalogue.
|
|
593
|
+
*/
|
|
594
|
+
package_id?: string;
|
|
595
|
+
/** @description Your own reference, returned on the order. */
|
|
596
|
+
reference?: string;
|
|
597
|
+
/** @description Refuse with price_changed unless the amount is exactly this. */
|
|
598
|
+
expected_amount?: number;
|
|
599
|
+
};
|
|
600
|
+
Installation: {
|
|
601
|
+
/** @description LPA string for the QR code; null until issued. */
|
|
602
|
+
activation_code: string | null;
|
|
603
|
+
smdp_address: string | null;
|
|
604
|
+
matching_id: string | null;
|
|
605
|
+
/** Format: uri */
|
|
606
|
+
ios_install_url: string | null;
|
|
607
|
+
/** Format: uri */
|
|
608
|
+
android_install_url: string | null;
|
|
609
|
+
};
|
|
610
|
+
OrderEsim: {
|
|
611
|
+
/** Format: uuid */
|
|
612
|
+
id: string;
|
|
613
|
+
iccid: string;
|
|
614
|
+
} & components["schemas"]["Installation"];
|
|
615
|
+
OrderPackage: {
|
|
616
|
+
/**
|
|
617
|
+
* Format: uuid
|
|
618
|
+
* @description The package on the eSIM; null while pending.
|
|
619
|
+
*/
|
|
620
|
+
id: string | null;
|
|
621
|
+
/**
|
|
622
|
+
* Format: uuid
|
|
623
|
+
* @description The catalogue package.
|
|
624
|
+
*/
|
|
625
|
+
package_id: string | null;
|
|
626
|
+
name: string;
|
|
627
|
+
/** @description `not_active`, `active` or `terminated`; null while pending. */
|
|
628
|
+
status: string | null;
|
|
629
|
+
/** @description Bytes. */
|
|
630
|
+
data_total: number;
|
|
631
|
+
/** Format: date-time */
|
|
632
|
+
expires_at: string | null;
|
|
633
|
+
};
|
|
634
|
+
/**
|
|
635
|
+
* @example {
|
|
636
|
+
* "id": "9e4b2f71-3c8a-4d6e-b1f0-7a5c2e8d4b96",
|
|
637
|
+
* "type": "bundle",
|
|
638
|
+
* "status": "completed",
|
|
639
|
+
* "amount": 700,
|
|
640
|
+
* "currency": "EUR",
|
|
641
|
+
* "esim_price": 0,
|
|
642
|
+
* "package_price": 700,
|
|
643
|
+
* "reference": "BOOKING-1042",
|
|
644
|
+
* "created_at": "2026-10-01T09:30:12.000Z",
|
|
645
|
+
* "esim": {
|
|
646
|
+
* "id": "c2a7e9d4-6b1f-4f3a-8e5d-0a9b7c6d5e41",
|
|
647
|
+
* "iccid": "8910390000012345678",
|
|
648
|
+
* "activation_code": "LPA:1$rsp.example.com$4F2A-9C1D-7E3B-8A60",
|
|
649
|
+
* "smdp_address": "rsp.example.com",
|
|
650
|
+
* "matching_id": "4F2A-9C1D-7E3B-8A60",
|
|
651
|
+
* "ios_install_url": "https://esimsetup.apple.com/esim_qrcode_provisioning?carddata=LPA%3A1%24rsp.example.com%244F2A-9C1D-7E3B-8A60",
|
|
652
|
+
* "android_install_url": "https://esimsetup.android.com/esim_qrcode_provisioning?carddata=LPA:1$rsp.example.com$4F2A-9C1D-7E3B-8A60"
|
|
653
|
+
* },
|
|
654
|
+
* "package": {
|
|
655
|
+
* "id": "1d8f6a3b-7e2c-4b9a-a5d4-3f1e0c7b9a28",
|
|
656
|
+
* "package_id": "5f0c1a52-8f3e-4c1e-9b7a-2d6e4f8a1c03",
|
|
657
|
+
* "name": "One Kosovo 5GB",
|
|
658
|
+
* "status": "not_active",
|
|
659
|
+
* "data_total": 5242880000,
|
|
660
|
+
* "expires_at": null
|
|
661
|
+
* }
|
|
662
|
+
* }
|
|
663
|
+
*/
|
|
664
|
+
Order: {
|
|
665
|
+
/** Format: uuid */
|
|
666
|
+
id: string;
|
|
667
|
+
/** @enum {string} */
|
|
668
|
+
type: "esim" | "package" | "bundle";
|
|
669
|
+
/**
|
|
670
|
+
* @description `refunded`: onesim support refunded the order after it completed.
|
|
671
|
+
* @enum {string}
|
|
672
|
+
*/
|
|
673
|
+
status: "pending" | "completed" | "failed" | "refunded";
|
|
674
|
+
/** @description Minor units (cents) of `currency`. */
|
|
675
|
+
amount: number;
|
|
676
|
+
/**
|
|
677
|
+
* @description Your account's currency: all your prices, orders and your balance are in it.
|
|
678
|
+
* @enum {string}
|
|
679
|
+
*/
|
|
680
|
+
currency: "EUR" | "USD";
|
|
681
|
+
/** @description The part of amount for a new eSIM; null when none was issued. */
|
|
682
|
+
esim_price: number | null;
|
|
683
|
+
/** @description The part of amount for the package; null for a blank eSIM. */
|
|
684
|
+
package_price: number | null;
|
|
685
|
+
reference: string | null;
|
|
686
|
+
/** Format: date-time */
|
|
687
|
+
created_at: string;
|
|
688
|
+
esim: components["schemas"]["OrderEsim"];
|
|
689
|
+
package: components["schemas"]["OrderPackage"] | null;
|
|
690
|
+
};
|
|
691
|
+
/**
|
|
692
|
+
* @example {
|
|
693
|
+
* "data": [
|
|
694
|
+
* {
|
|
695
|
+
* "id": "9e4b2f71-3c8a-4d6e-b1f0-7a5c2e8d4b96",
|
|
696
|
+
* "type": "bundle",
|
|
697
|
+
* "status": "completed",
|
|
698
|
+
* "amount": 700,
|
|
699
|
+
* "currency": "EUR",
|
|
700
|
+
* "esim_price": 0,
|
|
701
|
+
* "package_price": 700,
|
|
702
|
+
* "reference": "BOOKING-1042",
|
|
703
|
+
* "created_at": "2026-10-01T09:30:12.000Z",
|
|
704
|
+
* "esim": {
|
|
705
|
+
* "id": "c2a7e9d4-6b1f-4f3a-8e5d-0a9b7c6d5e41",
|
|
706
|
+
* "iccid": "8910390000012345678",
|
|
707
|
+
* "activation_code": "LPA:1$rsp.example.com$4F2A-9C1D-7E3B-8A60",
|
|
708
|
+
* "smdp_address": "rsp.example.com",
|
|
709
|
+
* "matching_id": "4F2A-9C1D-7E3B-8A60",
|
|
710
|
+
* "ios_install_url": "https://esimsetup.apple.com/esim_qrcode_provisioning?carddata=LPA%3A1%24rsp.example.com%244F2A-9C1D-7E3B-8A60",
|
|
711
|
+
* "android_install_url": "https://esimsetup.android.com/esim_qrcode_provisioning?carddata=LPA:1$rsp.example.com$4F2A-9C1D-7E3B-8A60"
|
|
712
|
+
* },
|
|
713
|
+
* "package": {
|
|
714
|
+
* "id": "1d8f6a3b-7e2c-4b9a-a5d4-3f1e0c7b9a28",
|
|
715
|
+
* "package_id": "5f0c1a52-8f3e-4c1e-9b7a-2d6e4f8a1c03",
|
|
716
|
+
* "name": "One Kosovo 5GB",
|
|
717
|
+
* "status": "not_active",
|
|
718
|
+
* "data_total": 5242880000,
|
|
719
|
+
* "expires_at": null
|
|
720
|
+
* }
|
|
721
|
+
* }
|
|
722
|
+
* ],
|
|
723
|
+
* "next_cursor": null
|
|
724
|
+
* }
|
|
725
|
+
*/
|
|
726
|
+
OrderList: {
|
|
727
|
+
data: components["schemas"]["Order"][];
|
|
728
|
+
next_cursor: string | null;
|
|
729
|
+
};
|
|
730
|
+
/**
|
|
731
|
+
* @example {
|
|
732
|
+
* "id": "c2a7e9d4-6b1f-4f3a-8e5d-0a9b7c6d5e41",
|
|
733
|
+
* "iccid": "8910390000012345678",
|
|
734
|
+
* "status": "in_service",
|
|
735
|
+
* "profile_state": "enabled",
|
|
736
|
+
* "created_at": "2026-10-01T09:30:12.000Z"
|
|
737
|
+
* }
|
|
738
|
+
*/
|
|
739
|
+
EsimSummary: {
|
|
740
|
+
/** Format: uuid */
|
|
741
|
+
id: string;
|
|
742
|
+
iccid: string;
|
|
743
|
+
/** @description Network status, e.g. `pre_service`, `in_service`. */
|
|
744
|
+
status: string | null;
|
|
745
|
+
/** @description eSIM profile, e.g. `released`, `enabled`, `disabled`. */
|
|
746
|
+
profile_state: string | null;
|
|
747
|
+
/** Format: date-time */
|
|
748
|
+
created_at: string;
|
|
749
|
+
};
|
|
750
|
+
/**
|
|
751
|
+
* @example {
|
|
752
|
+
* "data": [
|
|
753
|
+
* {
|
|
754
|
+
* "id": "c2a7e9d4-6b1f-4f3a-8e5d-0a9b7c6d5e41",
|
|
755
|
+
* "iccid": "8910390000012345678",
|
|
756
|
+
* "status": "in_service",
|
|
757
|
+
* "profile_state": "enabled",
|
|
758
|
+
* "created_at": "2026-10-01T09:30:12.000Z"
|
|
759
|
+
* }
|
|
760
|
+
* ],
|
|
761
|
+
* "next_cursor": null
|
|
762
|
+
* }
|
|
763
|
+
*/
|
|
764
|
+
EsimList: {
|
|
765
|
+
data: components["schemas"]["EsimSummary"][];
|
|
766
|
+
next_cursor: string | null;
|
|
767
|
+
};
|
|
768
|
+
EsimPackage: {
|
|
769
|
+
/** Format: uuid */
|
|
770
|
+
id: string;
|
|
771
|
+
/** Format: uuid */
|
|
772
|
+
package_id: string | null;
|
|
773
|
+
name: string | null;
|
|
774
|
+
/** @description `not_active`, `active` or `terminated`. */
|
|
775
|
+
status: string | null;
|
|
776
|
+
/** @description Bytes. */
|
|
777
|
+
data_total: number;
|
|
778
|
+
/** @description Bytes; null when not known yet. */
|
|
779
|
+
data_remaining: number | null;
|
|
780
|
+
/** Format: date-time */
|
|
781
|
+
activated_at: string | null;
|
|
782
|
+
/** Format: date-time */
|
|
783
|
+
expires_at: string | null;
|
|
784
|
+
/** Format: date-time */
|
|
785
|
+
created_at: string | null;
|
|
786
|
+
};
|
|
787
|
+
/**
|
|
788
|
+
* @example {
|
|
789
|
+
* "id": "c2a7e9d4-6b1f-4f3a-8e5d-0a9b7c6d5e41",
|
|
790
|
+
* "iccid": "8910390000012345678",
|
|
791
|
+
* "status": "in_service",
|
|
792
|
+
* "profile_state": "enabled",
|
|
793
|
+
* "created_at": "2026-10-01T09:30:12.000Z",
|
|
794
|
+
* "activation_code": "LPA:1$rsp.example.com$4F2A-9C1D-7E3B-8A60",
|
|
795
|
+
* "smdp_address": "rsp.example.com",
|
|
796
|
+
* "matching_id": "4F2A-9C1D-7E3B-8A60",
|
|
797
|
+
* "ios_install_url": "https://esimsetup.apple.com/esim_qrcode_provisioning?carddata=LPA%3A1%24rsp.example.com%244F2A-9C1D-7E3B-8A60",
|
|
798
|
+
* "android_install_url": "https://esimsetup.android.com/esim_qrcode_provisioning?carddata=LPA:1$rsp.example.com$4F2A-9C1D-7E3B-8A60",
|
|
799
|
+
* "refreshed_at": "2026-10-05T18:02:11.000Z",
|
|
800
|
+
* "packages": [
|
|
801
|
+
* {
|
|
802
|
+
* "id": "1d8f6a3b-7e2c-4b9a-a5d4-3f1e0c7b9a28",
|
|
803
|
+
* "package_id": "5f0c1a52-8f3e-4c1e-9b7a-2d6e4f8a1c03",
|
|
804
|
+
* "name": "One Kosovo 5GB",
|
|
805
|
+
* "status": "active",
|
|
806
|
+
* "data_total": 5242880000,
|
|
807
|
+
* "data_remaining": 3984588800,
|
|
808
|
+
* "activated_at": "2026-10-03T07:12:40.000Z",
|
|
809
|
+
* "expires_at": "2026-11-02T07:12:40.000Z",
|
|
810
|
+
* "created_at": "2026-10-01T09:30:14.000Z"
|
|
811
|
+
* }
|
|
812
|
+
* ]
|
|
813
|
+
* }
|
|
814
|
+
*/
|
|
815
|
+
Esim: components["schemas"]["EsimSummary"] & components["schemas"]["Installation"] & {
|
|
816
|
+
/**
|
|
817
|
+
* Format: date-time
|
|
818
|
+
* @description When the network was read; null when it did not answer.
|
|
819
|
+
*/
|
|
820
|
+
refreshed_at: string | null;
|
|
821
|
+
packages: components["schemas"]["EsimPackage"][];
|
|
822
|
+
};
|
|
823
|
+
/**
|
|
824
|
+
* @example {
|
|
825
|
+
* "balance": 23500,
|
|
826
|
+
* "overdraft_limit": 10000,
|
|
827
|
+
* "available": 33500,
|
|
828
|
+
* "currency": "EUR"
|
|
829
|
+
* }
|
|
830
|
+
*/
|
|
831
|
+
Balance: {
|
|
832
|
+
/** @description Cents; negative when you owe us. */
|
|
833
|
+
balance: number;
|
|
834
|
+
/** @description Minor units (cents) of `currency`. */
|
|
835
|
+
overdraft_limit: number;
|
|
836
|
+
/** @description balance + overdraft_limit: what you can spend now. */
|
|
837
|
+
available: number;
|
|
838
|
+
/**
|
|
839
|
+
* @description Your account's currency: all your prices, orders and your balance are in it.
|
|
840
|
+
* @enum {string}
|
|
841
|
+
*/
|
|
842
|
+
currency: "EUR" | "USD";
|
|
843
|
+
};
|
|
844
|
+
Event: {
|
|
845
|
+
/**
|
|
846
|
+
* Format: uuid
|
|
847
|
+
* @description Unique per event: ignore an id you have seen.
|
|
848
|
+
*/
|
|
849
|
+
id: string;
|
|
850
|
+
type: string;
|
|
851
|
+
/** Format: date-time */
|
|
852
|
+
created_at: string;
|
|
853
|
+
data: Record<string, unknown>;
|
|
854
|
+
};
|
|
855
|
+
/**
|
|
856
|
+
* @example {
|
|
857
|
+
* "id": "3b7e1c9a-5d2f-4a8e-9c6b-1f0e7d4a2b85",
|
|
858
|
+
* "type": "order.completed",
|
|
859
|
+
* "created_at": "2026-10-01T09:30:13.000Z",
|
|
860
|
+
* "data": {
|
|
861
|
+
* "id": "9e4b2f71-3c8a-4d6e-b1f0-7a5c2e8d4b96",
|
|
862
|
+
* "type": "bundle",
|
|
863
|
+
* "status": "completed",
|
|
864
|
+
* "amount": 700,
|
|
865
|
+
* "esim_price": 0,
|
|
866
|
+
* "package_price": 700,
|
|
867
|
+
* "currency": "EUR",
|
|
868
|
+
* "reference": "BOOKING-1042",
|
|
869
|
+
* "esim_id": "c2a7e9d4-6b1f-4f3a-8e5d-0a9b7c6d5e41",
|
|
870
|
+
* "iccid": "8910390000012345678",
|
|
871
|
+
* "package_id": "5f0c1a52-8f3e-4c1e-9b7a-2d6e4f8a1c03",
|
|
872
|
+
* "created_at": "2026-10-01T09:30:12.000Z"
|
|
873
|
+
* }
|
|
874
|
+
* }
|
|
875
|
+
*/
|
|
876
|
+
OrderEvent: components["schemas"]["Event"] & {
|
|
877
|
+
/** @enum {unknown} */
|
|
878
|
+
type?: "order.completed" | "order.failed";
|
|
879
|
+
data?: {
|
|
880
|
+
/** Format: uuid */
|
|
881
|
+
id: string;
|
|
882
|
+
/** @enum {string} */
|
|
883
|
+
type: "esim" | "package" | "bundle";
|
|
884
|
+
status: string;
|
|
885
|
+
/** @description Minor units (cents) of `currency`. */
|
|
886
|
+
amount: number;
|
|
887
|
+
esim_price?: number | null;
|
|
888
|
+
package_price?: number | null;
|
|
889
|
+
/**
|
|
890
|
+
* @description Your account's currency: all your prices, orders and your balance are in it.
|
|
891
|
+
* @enum {string}
|
|
892
|
+
*/
|
|
893
|
+
currency: "EUR" | "USD";
|
|
894
|
+
reference?: string | null;
|
|
895
|
+
/** Format: uuid */
|
|
896
|
+
esim_id: string;
|
|
897
|
+
iccid: string;
|
|
898
|
+
/** Format: uuid */
|
|
899
|
+
package_id?: string | null;
|
|
900
|
+
/** Format: date-time */
|
|
901
|
+
created_at: string;
|
|
902
|
+
};
|
|
903
|
+
};
|
|
904
|
+
/**
|
|
905
|
+
* @example {
|
|
906
|
+
* "id": "7a2d9e4b-1c6f-4b3a-8d5e-0f9c2b7a6e13",
|
|
907
|
+
* "type": "package.usage",
|
|
908
|
+
* "created_at": "2026-10-04T16:45:02.000Z",
|
|
909
|
+
* "data": {
|
|
910
|
+
* "esim_id": "c2a7e9d4-6b1f-4f3a-8e5d-0a9b7c6d5e41",
|
|
911
|
+
* "iccid": "8910390000012345678",
|
|
912
|
+
* "package": {
|
|
913
|
+
* "id": "1d8f6a3b-7e2c-4b9a-a5d4-3f1e0c7b9a28",
|
|
914
|
+
* "package_id": "5f0c1a52-8f3e-4c1e-9b7a-2d6e4f8a1c03",
|
|
915
|
+
* "name": "One Kosovo 5GB"
|
|
916
|
+
* },
|
|
917
|
+
* "percent_used": 80
|
|
918
|
+
* }
|
|
919
|
+
* }
|
|
920
|
+
*/
|
|
921
|
+
PackageEvent: components["schemas"]["Event"] & {
|
|
922
|
+
/** @enum {unknown} */
|
|
923
|
+
type?: "package.activated" | "package.usage" | "package.expired";
|
|
924
|
+
data?: {
|
|
925
|
+
/** Format: uuid */
|
|
926
|
+
esim_id: string;
|
|
927
|
+
iccid: string;
|
|
928
|
+
package: {
|
|
929
|
+
/** Format: uuid */
|
|
930
|
+
id: string | null;
|
|
931
|
+
/** Format: uuid */
|
|
932
|
+
package_id: string | null;
|
|
933
|
+
name: string | null;
|
|
934
|
+
};
|
|
935
|
+
/** @description package.usage: rounded down to the nearest 10. */
|
|
936
|
+
percent_used?: number;
|
|
937
|
+
/**
|
|
938
|
+
* Format: date-time
|
|
939
|
+
* @description package.activated: when its validity ends.
|
|
940
|
+
*/
|
|
941
|
+
expires_at?: string | null;
|
|
942
|
+
/** @description package.expired: true when the data ran out first. */
|
|
943
|
+
data_used_up?: boolean;
|
|
944
|
+
};
|
|
945
|
+
};
|
|
946
|
+
/**
|
|
947
|
+
* @example {
|
|
948
|
+
* "id": "e5c8b1f4-9a3d-4e7b-a2c6-8d1f0b9e3a57",
|
|
949
|
+
* "type": "balance.low",
|
|
950
|
+
* "created_at": "2026-10-01T09:30:12.000Z",
|
|
951
|
+
* "data": {
|
|
952
|
+
* "balance": -2500,
|
|
953
|
+
* "overdraft_limit": 10000,
|
|
954
|
+
* "available": 7500,
|
|
955
|
+
* "threshold": 10000,
|
|
956
|
+
* "currency": "EUR",
|
|
957
|
+
* "order_id": "9e4b2f71-3c8a-4d6e-b1f0-7a5c2e8d4b96"
|
|
958
|
+
* }
|
|
959
|
+
* }
|
|
960
|
+
*/
|
|
961
|
+
BalanceEvent: components["schemas"]["Event"] & {
|
|
962
|
+
/** @enum {unknown} */
|
|
963
|
+
type?: "balance.low";
|
|
964
|
+
data?: {
|
|
965
|
+
balance: number;
|
|
966
|
+
/** @description Minor units (cents) of `currency`. */
|
|
967
|
+
overdraft_limit: number;
|
|
968
|
+
available: number;
|
|
969
|
+
/** @description Minor units (cents) of `currency`. */
|
|
970
|
+
threshold: number;
|
|
971
|
+
/**
|
|
972
|
+
* @description Your account's currency: all your prices, orders and your balance are in it.
|
|
973
|
+
* @enum {string}
|
|
974
|
+
*/
|
|
975
|
+
currency: "EUR" | "USD";
|
|
976
|
+
/** Format: uuid */
|
|
977
|
+
order_id?: string;
|
|
978
|
+
};
|
|
979
|
+
};
|
|
980
|
+
PingEvent: components["schemas"]["Event"] & {
|
|
981
|
+
/** @enum {unknown} */
|
|
982
|
+
type?: "ping";
|
|
983
|
+
};
|
|
984
|
+
};
|
|
985
|
+
responses: never;
|
|
986
|
+
parameters: {
|
|
987
|
+
/** @description Page size, 1 to 100. */
|
|
988
|
+
Limit: number;
|
|
989
|
+
/** @description The `next_cursor` of the previous page. */
|
|
990
|
+
Cursor: string;
|
|
991
|
+
};
|
|
992
|
+
requestBodies: never;
|
|
993
|
+
headers: never;
|
|
994
|
+
pathItems: never;
|
|
995
|
+
}
|
|
996
|
+
export type $defs = Record<string, never>;
|
|
997
|
+
export interface operations {
|
|
998
|
+
listPackages: {
|
|
999
|
+
parameters: {
|
|
1000
|
+
query?: never;
|
|
1001
|
+
header?: never;
|
|
1002
|
+
path?: never;
|
|
1003
|
+
cookie?: never;
|
|
1004
|
+
};
|
|
1005
|
+
requestBody?: never;
|
|
1006
|
+
responses: {
|
|
1007
|
+
/** @description Your packages and eSIM price. */
|
|
1008
|
+
200: {
|
|
1009
|
+
headers: {
|
|
1010
|
+
[name: string]: unknown;
|
|
1011
|
+
};
|
|
1012
|
+
content: {
|
|
1013
|
+
"application/json": components["schemas"]["Catalogue"];
|
|
1014
|
+
};
|
|
1015
|
+
};
|
|
1016
|
+
/** @description Malformed request. */
|
|
1017
|
+
400: {
|
|
1018
|
+
headers: {
|
|
1019
|
+
[name: string]: unknown;
|
|
1020
|
+
};
|
|
1021
|
+
content: {
|
|
1022
|
+
/**
|
|
1023
|
+
* @example {
|
|
1024
|
+
* "error": {
|
|
1025
|
+
* "code": "invalid_request",
|
|
1026
|
+
* "message": "limit must be a whole number from 1 to 100.",
|
|
1027
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1028
|
+
* }
|
|
1029
|
+
* }
|
|
1030
|
+
*/
|
|
1031
|
+
"application/json": components["schemas"]["Error"];
|
|
1032
|
+
};
|
|
1033
|
+
};
|
|
1034
|
+
/** @description Missing, unknown or revoked key. */
|
|
1035
|
+
401: {
|
|
1036
|
+
headers: {
|
|
1037
|
+
[name: string]: unknown;
|
|
1038
|
+
};
|
|
1039
|
+
content: {
|
|
1040
|
+
/**
|
|
1041
|
+
* @example {
|
|
1042
|
+
* "error": {
|
|
1043
|
+
* "code": "unauthorized",
|
|
1044
|
+
* "message": "Send a valid API key as `Authorization: Bearer osk_…`.",
|
|
1045
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1046
|
+
* }
|
|
1047
|
+
* }
|
|
1048
|
+
*/
|
|
1049
|
+
"application/json": components["schemas"]["Error"];
|
|
1050
|
+
};
|
|
1051
|
+
};
|
|
1052
|
+
/** @description Rate limited. */
|
|
1053
|
+
429: {
|
|
1054
|
+
headers: {
|
|
1055
|
+
[name: string]: unknown;
|
|
1056
|
+
};
|
|
1057
|
+
content: {
|
|
1058
|
+
/**
|
|
1059
|
+
* @example {
|
|
1060
|
+
* "error": {
|
|
1061
|
+
* "code": "rate_limited",
|
|
1062
|
+
* "message": "Too many requests. Wait and retry.",
|
|
1063
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1064
|
+
* }
|
|
1065
|
+
* }
|
|
1066
|
+
*/
|
|
1067
|
+
"application/json": components["schemas"]["Error"];
|
|
1068
|
+
};
|
|
1069
|
+
};
|
|
1070
|
+
/** @description Our fault; retry. */
|
|
1071
|
+
500: {
|
|
1072
|
+
headers: {
|
|
1073
|
+
[name: string]: unknown;
|
|
1074
|
+
};
|
|
1075
|
+
content: {
|
|
1076
|
+
/**
|
|
1077
|
+
* @example {
|
|
1078
|
+
* "error": {
|
|
1079
|
+
* "code": "internal_error",
|
|
1080
|
+
* "message": "Something failed on our side. Retrying with the same Idempotency-Key is safe.",
|
|
1081
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1082
|
+
* }
|
|
1083
|
+
* }
|
|
1084
|
+
*/
|
|
1085
|
+
"application/json": components["schemas"]["Error"];
|
|
1086
|
+
};
|
|
1087
|
+
};
|
|
1088
|
+
};
|
|
1089
|
+
};
|
|
1090
|
+
getPackage: {
|
|
1091
|
+
parameters: {
|
|
1092
|
+
query?: never;
|
|
1093
|
+
header?: never;
|
|
1094
|
+
path: {
|
|
1095
|
+
/** @description The package id from your catalogue. */
|
|
1096
|
+
id: string;
|
|
1097
|
+
};
|
|
1098
|
+
cookie?: never;
|
|
1099
|
+
};
|
|
1100
|
+
requestBody?: never;
|
|
1101
|
+
responses: {
|
|
1102
|
+
/** @description The package. */
|
|
1103
|
+
200: {
|
|
1104
|
+
headers: {
|
|
1105
|
+
[name: string]: unknown;
|
|
1106
|
+
};
|
|
1107
|
+
content: {
|
|
1108
|
+
"application/json": components["schemas"]["Package"];
|
|
1109
|
+
};
|
|
1110
|
+
};
|
|
1111
|
+
/** @description Malformed request. */
|
|
1112
|
+
400: {
|
|
1113
|
+
headers: {
|
|
1114
|
+
[name: string]: unknown;
|
|
1115
|
+
};
|
|
1116
|
+
content: {
|
|
1117
|
+
/**
|
|
1118
|
+
* @example {
|
|
1119
|
+
* "error": {
|
|
1120
|
+
* "code": "invalid_request",
|
|
1121
|
+
* "message": "limit must be a whole number from 1 to 100.",
|
|
1122
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1123
|
+
* }
|
|
1124
|
+
* }
|
|
1125
|
+
*/
|
|
1126
|
+
"application/json": components["schemas"]["Error"];
|
|
1127
|
+
};
|
|
1128
|
+
};
|
|
1129
|
+
/** @description Missing, unknown or revoked key. */
|
|
1130
|
+
401: {
|
|
1131
|
+
headers: {
|
|
1132
|
+
[name: string]: unknown;
|
|
1133
|
+
};
|
|
1134
|
+
content: {
|
|
1135
|
+
/**
|
|
1136
|
+
* @example {
|
|
1137
|
+
* "error": {
|
|
1138
|
+
* "code": "unauthorized",
|
|
1139
|
+
* "message": "Send a valid API key as `Authorization: Bearer osk_…`.",
|
|
1140
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1141
|
+
* }
|
|
1142
|
+
* }
|
|
1143
|
+
*/
|
|
1144
|
+
"application/json": components["schemas"]["Error"];
|
|
1145
|
+
};
|
|
1146
|
+
};
|
|
1147
|
+
/** @description Not in your catalogue. */
|
|
1148
|
+
404: {
|
|
1149
|
+
headers: {
|
|
1150
|
+
[name: string]: unknown;
|
|
1151
|
+
};
|
|
1152
|
+
content: {
|
|
1153
|
+
/**
|
|
1154
|
+
* @example {
|
|
1155
|
+
* "error": {
|
|
1156
|
+
* "code": "not_found",
|
|
1157
|
+
* "message": "No such package in your catalogue.",
|
|
1158
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1159
|
+
* }
|
|
1160
|
+
* }
|
|
1161
|
+
*/
|
|
1162
|
+
"application/json": components["schemas"]["Error"];
|
|
1163
|
+
};
|
|
1164
|
+
};
|
|
1165
|
+
/** @description Rate limited. */
|
|
1166
|
+
429: {
|
|
1167
|
+
headers: {
|
|
1168
|
+
[name: string]: unknown;
|
|
1169
|
+
};
|
|
1170
|
+
content: {
|
|
1171
|
+
/**
|
|
1172
|
+
* @example {
|
|
1173
|
+
* "error": {
|
|
1174
|
+
* "code": "rate_limited",
|
|
1175
|
+
* "message": "Too many requests. Wait and retry.",
|
|
1176
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1177
|
+
* }
|
|
1178
|
+
* }
|
|
1179
|
+
*/
|
|
1180
|
+
"application/json": components["schemas"]["Error"];
|
|
1181
|
+
};
|
|
1182
|
+
};
|
|
1183
|
+
/** @description Our fault; retry. */
|
|
1184
|
+
500: {
|
|
1185
|
+
headers: {
|
|
1186
|
+
[name: string]: unknown;
|
|
1187
|
+
};
|
|
1188
|
+
content: {
|
|
1189
|
+
/**
|
|
1190
|
+
* @example {
|
|
1191
|
+
* "error": {
|
|
1192
|
+
* "code": "internal_error",
|
|
1193
|
+
* "message": "Something failed on our side. Retrying with the same Idempotency-Key is safe.",
|
|
1194
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1195
|
+
* }
|
|
1196
|
+
* }
|
|
1197
|
+
*/
|
|
1198
|
+
"application/json": components["schemas"]["Error"];
|
|
1199
|
+
};
|
|
1200
|
+
};
|
|
1201
|
+
};
|
|
1202
|
+
};
|
|
1203
|
+
listOrders: {
|
|
1204
|
+
parameters: {
|
|
1205
|
+
query?: {
|
|
1206
|
+
/** @description Page size, 1 to 100. */
|
|
1207
|
+
limit?: components["parameters"]["Limit"];
|
|
1208
|
+
/** @description The `next_cursor` of the previous page. */
|
|
1209
|
+
cursor?: components["parameters"]["Cursor"];
|
|
1210
|
+
/** @description Only orders on this eSIM. */
|
|
1211
|
+
esim_id?: string;
|
|
1212
|
+
/** @description Only orders with this reference. */
|
|
1213
|
+
reference?: string;
|
|
1214
|
+
/** @description Only orders created after this time. */
|
|
1215
|
+
created_after?: string;
|
|
1216
|
+
};
|
|
1217
|
+
header?: never;
|
|
1218
|
+
path?: never;
|
|
1219
|
+
cookie?: never;
|
|
1220
|
+
};
|
|
1221
|
+
requestBody?: never;
|
|
1222
|
+
responses: {
|
|
1223
|
+
/** @description A page of orders. */
|
|
1224
|
+
200: {
|
|
1225
|
+
headers: {
|
|
1226
|
+
[name: string]: unknown;
|
|
1227
|
+
};
|
|
1228
|
+
content: {
|
|
1229
|
+
"application/json": components["schemas"]["OrderList"];
|
|
1230
|
+
};
|
|
1231
|
+
};
|
|
1232
|
+
/** @description Malformed request. */
|
|
1233
|
+
400: {
|
|
1234
|
+
headers: {
|
|
1235
|
+
[name: string]: unknown;
|
|
1236
|
+
};
|
|
1237
|
+
content: {
|
|
1238
|
+
/**
|
|
1239
|
+
* @example {
|
|
1240
|
+
* "error": {
|
|
1241
|
+
* "code": "invalid_request",
|
|
1242
|
+
* "message": "limit must be a whole number from 1 to 100.",
|
|
1243
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1244
|
+
* }
|
|
1245
|
+
* }
|
|
1246
|
+
*/
|
|
1247
|
+
"application/json": components["schemas"]["Error"];
|
|
1248
|
+
};
|
|
1249
|
+
};
|
|
1250
|
+
/** @description Missing, unknown or revoked key. */
|
|
1251
|
+
401: {
|
|
1252
|
+
headers: {
|
|
1253
|
+
[name: string]: unknown;
|
|
1254
|
+
};
|
|
1255
|
+
content: {
|
|
1256
|
+
/**
|
|
1257
|
+
* @example {
|
|
1258
|
+
* "error": {
|
|
1259
|
+
* "code": "unauthorized",
|
|
1260
|
+
* "message": "Send a valid API key as `Authorization: Bearer osk_…`.",
|
|
1261
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1262
|
+
* }
|
|
1263
|
+
* }
|
|
1264
|
+
*/
|
|
1265
|
+
"application/json": components["schemas"]["Error"];
|
|
1266
|
+
};
|
|
1267
|
+
};
|
|
1268
|
+
/** @description Rate limited. */
|
|
1269
|
+
429: {
|
|
1270
|
+
headers: {
|
|
1271
|
+
[name: string]: unknown;
|
|
1272
|
+
};
|
|
1273
|
+
content: {
|
|
1274
|
+
/**
|
|
1275
|
+
* @example {
|
|
1276
|
+
* "error": {
|
|
1277
|
+
* "code": "rate_limited",
|
|
1278
|
+
* "message": "Too many requests. Wait and retry.",
|
|
1279
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1280
|
+
* }
|
|
1281
|
+
* }
|
|
1282
|
+
*/
|
|
1283
|
+
"application/json": components["schemas"]["Error"];
|
|
1284
|
+
};
|
|
1285
|
+
};
|
|
1286
|
+
/** @description Our fault; retry. */
|
|
1287
|
+
500: {
|
|
1288
|
+
headers: {
|
|
1289
|
+
[name: string]: unknown;
|
|
1290
|
+
};
|
|
1291
|
+
content: {
|
|
1292
|
+
/**
|
|
1293
|
+
* @example {
|
|
1294
|
+
* "error": {
|
|
1295
|
+
* "code": "internal_error",
|
|
1296
|
+
* "message": "Something failed on our side. Retrying with the same Idempotency-Key is safe.",
|
|
1297
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1298
|
+
* }
|
|
1299
|
+
* }
|
|
1300
|
+
*/
|
|
1301
|
+
"application/json": components["schemas"]["Error"];
|
|
1302
|
+
};
|
|
1303
|
+
};
|
|
1304
|
+
};
|
|
1305
|
+
};
|
|
1306
|
+
createOrder: {
|
|
1307
|
+
parameters: {
|
|
1308
|
+
query?: never;
|
|
1309
|
+
header: {
|
|
1310
|
+
/** @description A UUID, new for each purchase and the same on its retries. */
|
|
1311
|
+
"Idempotency-Key": string;
|
|
1312
|
+
};
|
|
1313
|
+
path?: never;
|
|
1314
|
+
cookie?: never;
|
|
1315
|
+
};
|
|
1316
|
+
requestBody: {
|
|
1317
|
+
content: {
|
|
1318
|
+
"application/json": components["schemas"]["OrderRequest"];
|
|
1319
|
+
};
|
|
1320
|
+
};
|
|
1321
|
+
responses: {
|
|
1322
|
+
/** @description Completed. A retry answers with the order as it is now, so its status may be refunded. */
|
|
1323
|
+
201: {
|
|
1324
|
+
headers: {
|
|
1325
|
+
[name: string]: unknown;
|
|
1326
|
+
};
|
|
1327
|
+
content: {
|
|
1328
|
+
"application/json": components["schemas"]["Order"];
|
|
1329
|
+
};
|
|
1330
|
+
};
|
|
1331
|
+
/** @description Pending: poll the order until it is completed or failed. */
|
|
1332
|
+
202: {
|
|
1333
|
+
headers: {
|
|
1334
|
+
[name: string]: unknown;
|
|
1335
|
+
};
|
|
1336
|
+
content: {
|
|
1337
|
+
/**
|
|
1338
|
+
* @example {
|
|
1339
|
+
* "id": "9e4b2f71-3c8a-4d6e-b1f0-7a5c2e8d4b96",
|
|
1340
|
+
* "type": "bundle",
|
|
1341
|
+
* "status": "pending",
|
|
1342
|
+
* "amount": 700,
|
|
1343
|
+
* "currency": "EUR",
|
|
1344
|
+
* "esim_price": 0,
|
|
1345
|
+
* "package_price": 700,
|
|
1346
|
+
* "reference": "BOOKING-1042",
|
|
1347
|
+
* "created_at": "2026-10-01T09:30:12.000Z",
|
|
1348
|
+
* "esim": {
|
|
1349
|
+
* "id": "c2a7e9d4-6b1f-4f3a-8e5d-0a9b7c6d5e41",
|
|
1350
|
+
* "iccid": "8910390000012345678",
|
|
1351
|
+
* "activation_code": null,
|
|
1352
|
+
* "smdp_address": null,
|
|
1353
|
+
* "matching_id": null,
|
|
1354
|
+
* "ios_install_url": null,
|
|
1355
|
+
* "android_install_url": null
|
|
1356
|
+
* },
|
|
1357
|
+
* "package": {
|
|
1358
|
+
* "id": null,
|
|
1359
|
+
* "package_id": "5f0c1a52-8f3e-4c1e-9b7a-2d6e4f8a1c03",
|
|
1360
|
+
* "name": "One Kosovo 5GB",
|
|
1361
|
+
* "status": null,
|
|
1362
|
+
* "data_total": 5242880000,
|
|
1363
|
+
* "expires_at": null
|
|
1364
|
+
* }
|
|
1365
|
+
* }
|
|
1366
|
+
*/
|
|
1367
|
+
"application/json": components["schemas"]["Order"];
|
|
1368
|
+
};
|
|
1369
|
+
};
|
|
1370
|
+
/** @description Malformed request. */
|
|
1371
|
+
400: {
|
|
1372
|
+
headers: {
|
|
1373
|
+
[name: string]: unknown;
|
|
1374
|
+
};
|
|
1375
|
+
content: {
|
|
1376
|
+
/**
|
|
1377
|
+
* @example {
|
|
1378
|
+
* "error": {
|
|
1379
|
+
* "code": "invalid_request",
|
|
1380
|
+
* "message": "package_id is required.",
|
|
1381
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1382
|
+
* }
|
|
1383
|
+
* }
|
|
1384
|
+
*/
|
|
1385
|
+
"application/json": components["schemas"]["Error"];
|
|
1386
|
+
};
|
|
1387
|
+
};
|
|
1388
|
+
/** @description Missing, unknown or revoked key. */
|
|
1389
|
+
401: {
|
|
1390
|
+
headers: {
|
|
1391
|
+
[name: string]: unknown;
|
|
1392
|
+
};
|
|
1393
|
+
content: {
|
|
1394
|
+
/**
|
|
1395
|
+
* @example {
|
|
1396
|
+
* "error": {
|
|
1397
|
+
* "code": "unauthorized",
|
|
1398
|
+
* "message": "Send a valid API key as `Authorization: Bearer osk_…`.",
|
|
1399
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1400
|
+
* }
|
|
1401
|
+
* }
|
|
1402
|
+
*/
|
|
1403
|
+
"application/json": components["schemas"]["Error"];
|
|
1404
|
+
};
|
|
1405
|
+
};
|
|
1406
|
+
/** @description Balance plus overdraft is below the amount. */
|
|
1407
|
+
402: {
|
|
1408
|
+
headers: {
|
|
1409
|
+
[name: string]: unknown;
|
|
1410
|
+
};
|
|
1411
|
+
content: {
|
|
1412
|
+
/**
|
|
1413
|
+
* @example {
|
|
1414
|
+
* "error": {
|
|
1415
|
+
* "code": "insufficient_balance",
|
|
1416
|
+
* "message": "Your balance and overdraft do not cover this order.",
|
|
1417
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1418
|
+
* }
|
|
1419
|
+
* }
|
|
1420
|
+
*/
|
|
1421
|
+
"application/json": components["schemas"]["Error"];
|
|
1422
|
+
};
|
|
1423
|
+
};
|
|
1424
|
+
/** @description Not offered to you. */
|
|
1425
|
+
403: {
|
|
1426
|
+
headers: {
|
|
1427
|
+
[name: string]: unknown;
|
|
1428
|
+
};
|
|
1429
|
+
content: {
|
|
1430
|
+
/**
|
|
1431
|
+
* @example {
|
|
1432
|
+
* "error": {
|
|
1433
|
+
* "code": "not_offered",
|
|
1434
|
+
* "message": "This package is not offered with a new eSIM.",
|
|
1435
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1436
|
+
* }
|
|
1437
|
+
* }
|
|
1438
|
+
*/
|
|
1439
|
+
"application/json": components["schemas"]["Error"];
|
|
1440
|
+
};
|
|
1441
|
+
};
|
|
1442
|
+
/** @description No such package or eSIM. */
|
|
1443
|
+
404: {
|
|
1444
|
+
headers: {
|
|
1445
|
+
[name: string]: unknown;
|
|
1446
|
+
};
|
|
1447
|
+
content: {
|
|
1448
|
+
/**
|
|
1449
|
+
* @example {
|
|
1450
|
+
* "error": {
|
|
1451
|
+
* "code": "not_found",
|
|
1452
|
+
* "message": "No such package in your catalogue.",
|
|
1453
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1454
|
+
* }
|
|
1455
|
+
* }
|
|
1456
|
+
*/
|
|
1457
|
+
"application/json": components["schemas"]["Error"];
|
|
1458
|
+
};
|
|
1459
|
+
};
|
|
1460
|
+
/** @description Conflict: idempotency_conflict, esim_busy, price_changed, esim_limit_reached or esim_unusable. */
|
|
1461
|
+
409: {
|
|
1462
|
+
headers: {
|
|
1463
|
+
[name: string]: unknown;
|
|
1464
|
+
};
|
|
1465
|
+
content: {
|
|
1466
|
+
/**
|
|
1467
|
+
* @example {
|
|
1468
|
+
* "error": {
|
|
1469
|
+
* "code": "price_changed",
|
|
1470
|
+
* "message": "The amount of this order is now 700.",
|
|
1471
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52",
|
|
1472
|
+
* "amount": 700
|
|
1473
|
+
* }
|
|
1474
|
+
* }
|
|
1475
|
+
*/
|
|
1476
|
+
"application/json": components["schemas"]["Error"];
|
|
1477
|
+
};
|
|
1478
|
+
};
|
|
1479
|
+
/** @description Rate limited. */
|
|
1480
|
+
429: {
|
|
1481
|
+
headers: {
|
|
1482
|
+
[name: string]: unknown;
|
|
1483
|
+
};
|
|
1484
|
+
content: {
|
|
1485
|
+
/**
|
|
1486
|
+
* @example {
|
|
1487
|
+
* "error": {
|
|
1488
|
+
* "code": "rate_limited",
|
|
1489
|
+
* "message": "Too many requests. Wait and retry.",
|
|
1490
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1491
|
+
* }
|
|
1492
|
+
* }
|
|
1493
|
+
*/
|
|
1494
|
+
"application/json": components["schemas"]["Error"];
|
|
1495
|
+
};
|
|
1496
|
+
};
|
|
1497
|
+
/** @description Our fault; retry. */
|
|
1498
|
+
500: {
|
|
1499
|
+
headers: {
|
|
1500
|
+
[name: string]: unknown;
|
|
1501
|
+
};
|
|
1502
|
+
content: {
|
|
1503
|
+
/**
|
|
1504
|
+
* @example {
|
|
1505
|
+
* "error": {
|
|
1506
|
+
* "code": "internal_error",
|
|
1507
|
+
* "message": "Something failed on our side. Retrying with the same Idempotency-Key is safe.",
|
|
1508
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1509
|
+
* }
|
|
1510
|
+
* }
|
|
1511
|
+
*/
|
|
1512
|
+
"application/json": components["schemas"]["Error"];
|
|
1513
|
+
};
|
|
1514
|
+
};
|
|
1515
|
+
/** @description The network refused; the order failed and was refunded. */
|
|
1516
|
+
502: {
|
|
1517
|
+
headers: {
|
|
1518
|
+
[name: string]: unknown;
|
|
1519
|
+
};
|
|
1520
|
+
content: {
|
|
1521
|
+
/**
|
|
1522
|
+
* @example {
|
|
1523
|
+
* "error": {
|
|
1524
|
+
* "code": "provisioning_failed",
|
|
1525
|
+
* "message": "The network did not provision this order. It failed and the amount is back on your balance.",
|
|
1526
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52",
|
|
1527
|
+
* "order": {
|
|
1528
|
+
* "id": "9e4b2f71-3c8a-4d6e-b1f0-7a5c2e8d4b96",
|
|
1529
|
+
* "type": "bundle",
|
|
1530
|
+
* "status": "failed",
|
|
1531
|
+
* "amount": 700,
|
|
1532
|
+
* "currency": "EUR",
|
|
1533
|
+
* "esim_price": 0,
|
|
1534
|
+
* "package_price": 700,
|
|
1535
|
+
* "reference": "BOOKING-1042",
|
|
1536
|
+
* "created_at": "2026-10-01T09:30:12.000Z",
|
|
1537
|
+
* "esim": {
|
|
1538
|
+
* "id": "c2a7e9d4-6b1f-4f3a-8e5d-0a9b7c6d5e41",
|
|
1539
|
+
* "iccid": "8910390000012345678",
|
|
1540
|
+
* "activation_code": null,
|
|
1541
|
+
* "smdp_address": null,
|
|
1542
|
+
* "matching_id": null,
|
|
1543
|
+
* "ios_install_url": null,
|
|
1544
|
+
* "android_install_url": null
|
|
1545
|
+
* },
|
|
1546
|
+
* "package": {
|
|
1547
|
+
* "id": null,
|
|
1548
|
+
* "package_id": "5f0c1a52-8f3e-4c1e-9b7a-2d6e4f8a1c03",
|
|
1549
|
+
* "name": "One Kosovo 5GB",
|
|
1550
|
+
* "status": null,
|
|
1551
|
+
* "data_total": 5242880000,
|
|
1552
|
+
* "expires_at": null
|
|
1553
|
+
* }
|
|
1554
|
+
* }
|
|
1555
|
+
* }
|
|
1556
|
+
* }
|
|
1557
|
+
*/
|
|
1558
|
+
"application/json": components["schemas"]["Error"];
|
|
1559
|
+
};
|
|
1560
|
+
};
|
|
1561
|
+
/** @description No eSIM can be issued right now. */
|
|
1562
|
+
503: {
|
|
1563
|
+
headers: {
|
|
1564
|
+
[name: string]: unknown;
|
|
1565
|
+
};
|
|
1566
|
+
content: {
|
|
1567
|
+
/**
|
|
1568
|
+
* @example {
|
|
1569
|
+
* "error": {
|
|
1570
|
+
* "code": "esims_unavailable",
|
|
1571
|
+
* "message": "No eSIM can be issued right now. Try again later.",
|
|
1572
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1573
|
+
* }
|
|
1574
|
+
* }
|
|
1575
|
+
*/
|
|
1576
|
+
"application/json": components["schemas"]["Error"];
|
|
1577
|
+
};
|
|
1578
|
+
};
|
|
1579
|
+
};
|
|
1580
|
+
};
|
|
1581
|
+
getOrder: {
|
|
1582
|
+
parameters: {
|
|
1583
|
+
query?: never;
|
|
1584
|
+
header?: never;
|
|
1585
|
+
path: {
|
|
1586
|
+
/** @description The order id. */
|
|
1587
|
+
id: string;
|
|
1588
|
+
};
|
|
1589
|
+
cookie?: never;
|
|
1590
|
+
};
|
|
1591
|
+
requestBody?: never;
|
|
1592
|
+
responses: {
|
|
1593
|
+
/** @description The order. */
|
|
1594
|
+
200: {
|
|
1595
|
+
headers: {
|
|
1596
|
+
[name: string]: unknown;
|
|
1597
|
+
};
|
|
1598
|
+
content: {
|
|
1599
|
+
"application/json": components["schemas"]["Order"];
|
|
1600
|
+
};
|
|
1601
|
+
};
|
|
1602
|
+
/** @description Malformed request. */
|
|
1603
|
+
400: {
|
|
1604
|
+
headers: {
|
|
1605
|
+
[name: string]: unknown;
|
|
1606
|
+
};
|
|
1607
|
+
content: {
|
|
1608
|
+
/**
|
|
1609
|
+
* @example {
|
|
1610
|
+
* "error": {
|
|
1611
|
+
* "code": "invalid_request",
|
|
1612
|
+
* "message": "limit must be a whole number from 1 to 100.",
|
|
1613
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1614
|
+
* }
|
|
1615
|
+
* }
|
|
1616
|
+
*/
|
|
1617
|
+
"application/json": components["schemas"]["Error"];
|
|
1618
|
+
};
|
|
1619
|
+
};
|
|
1620
|
+
/** @description Missing, unknown or revoked key. */
|
|
1621
|
+
401: {
|
|
1622
|
+
headers: {
|
|
1623
|
+
[name: string]: unknown;
|
|
1624
|
+
};
|
|
1625
|
+
content: {
|
|
1626
|
+
/**
|
|
1627
|
+
* @example {
|
|
1628
|
+
* "error": {
|
|
1629
|
+
* "code": "unauthorized",
|
|
1630
|
+
* "message": "Send a valid API key as `Authorization: Bearer osk_…`.",
|
|
1631
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1632
|
+
* }
|
|
1633
|
+
* }
|
|
1634
|
+
*/
|
|
1635
|
+
"application/json": components["schemas"]["Error"];
|
|
1636
|
+
};
|
|
1637
|
+
};
|
|
1638
|
+
/** @description No such order. */
|
|
1639
|
+
404: {
|
|
1640
|
+
headers: {
|
|
1641
|
+
[name: string]: unknown;
|
|
1642
|
+
};
|
|
1643
|
+
content: {
|
|
1644
|
+
/**
|
|
1645
|
+
* @example {
|
|
1646
|
+
* "error": {
|
|
1647
|
+
* "code": "not_found",
|
|
1648
|
+
* "message": "No such order.",
|
|
1649
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1650
|
+
* }
|
|
1651
|
+
* }
|
|
1652
|
+
*/
|
|
1653
|
+
"application/json": components["schemas"]["Error"];
|
|
1654
|
+
};
|
|
1655
|
+
};
|
|
1656
|
+
/** @description Rate limited. */
|
|
1657
|
+
429: {
|
|
1658
|
+
headers: {
|
|
1659
|
+
[name: string]: unknown;
|
|
1660
|
+
};
|
|
1661
|
+
content: {
|
|
1662
|
+
/**
|
|
1663
|
+
* @example {
|
|
1664
|
+
* "error": {
|
|
1665
|
+
* "code": "rate_limited",
|
|
1666
|
+
* "message": "Too many requests. Wait and retry.",
|
|
1667
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1668
|
+
* }
|
|
1669
|
+
* }
|
|
1670
|
+
*/
|
|
1671
|
+
"application/json": components["schemas"]["Error"];
|
|
1672
|
+
};
|
|
1673
|
+
};
|
|
1674
|
+
/** @description Our fault; retry. */
|
|
1675
|
+
500: {
|
|
1676
|
+
headers: {
|
|
1677
|
+
[name: string]: unknown;
|
|
1678
|
+
};
|
|
1679
|
+
content: {
|
|
1680
|
+
/**
|
|
1681
|
+
* @example {
|
|
1682
|
+
* "error": {
|
|
1683
|
+
* "code": "internal_error",
|
|
1684
|
+
* "message": "Something failed on our side. Retrying with the same Idempotency-Key is safe.",
|
|
1685
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1686
|
+
* }
|
|
1687
|
+
* }
|
|
1688
|
+
*/
|
|
1689
|
+
"application/json": components["schemas"]["Error"];
|
|
1690
|
+
};
|
|
1691
|
+
};
|
|
1692
|
+
};
|
|
1693
|
+
};
|
|
1694
|
+
listEsims: {
|
|
1695
|
+
parameters: {
|
|
1696
|
+
query?: {
|
|
1697
|
+
/** @description Page size, 1 to 100. */
|
|
1698
|
+
limit?: components["parameters"]["Limit"];
|
|
1699
|
+
/** @description The `next_cursor` of the previous page. */
|
|
1700
|
+
cursor?: components["parameters"]["Cursor"];
|
|
1701
|
+
/** @description Only the eSIM with this ICCID. */
|
|
1702
|
+
iccid?: string;
|
|
1703
|
+
};
|
|
1704
|
+
header?: never;
|
|
1705
|
+
path?: never;
|
|
1706
|
+
cookie?: never;
|
|
1707
|
+
};
|
|
1708
|
+
requestBody?: never;
|
|
1709
|
+
responses: {
|
|
1710
|
+
/** @description A page of eSIMs. */
|
|
1711
|
+
200: {
|
|
1712
|
+
headers: {
|
|
1713
|
+
[name: string]: unknown;
|
|
1714
|
+
};
|
|
1715
|
+
content: {
|
|
1716
|
+
"application/json": components["schemas"]["EsimList"];
|
|
1717
|
+
};
|
|
1718
|
+
};
|
|
1719
|
+
/** @description Malformed request. */
|
|
1720
|
+
400: {
|
|
1721
|
+
headers: {
|
|
1722
|
+
[name: string]: unknown;
|
|
1723
|
+
};
|
|
1724
|
+
content: {
|
|
1725
|
+
/**
|
|
1726
|
+
* @example {
|
|
1727
|
+
* "error": {
|
|
1728
|
+
* "code": "invalid_request",
|
|
1729
|
+
* "message": "limit must be a whole number from 1 to 100.",
|
|
1730
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1731
|
+
* }
|
|
1732
|
+
* }
|
|
1733
|
+
*/
|
|
1734
|
+
"application/json": components["schemas"]["Error"];
|
|
1735
|
+
};
|
|
1736
|
+
};
|
|
1737
|
+
/** @description Missing, unknown or revoked key. */
|
|
1738
|
+
401: {
|
|
1739
|
+
headers: {
|
|
1740
|
+
[name: string]: unknown;
|
|
1741
|
+
};
|
|
1742
|
+
content: {
|
|
1743
|
+
/**
|
|
1744
|
+
* @example {
|
|
1745
|
+
* "error": {
|
|
1746
|
+
* "code": "unauthorized",
|
|
1747
|
+
* "message": "Send a valid API key as `Authorization: Bearer osk_…`.",
|
|
1748
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1749
|
+
* }
|
|
1750
|
+
* }
|
|
1751
|
+
*/
|
|
1752
|
+
"application/json": components["schemas"]["Error"];
|
|
1753
|
+
};
|
|
1754
|
+
};
|
|
1755
|
+
/** @description Rate limited. */
|
|
1756
|
+
429: {
|
|
1757
|
+
headers: {
|
|
1758
|
+
[name: string]: unknown;
|
|
1759
|
+
};
|
|
1760
|
+
content: {
|
|
1761
|
+
/**
|
|
1762
|
+
* @example {
|
|
1763
|
+
* "error": {
|
|
1764
|
+
* "code": "rate_limited",
|
|
1765
|
+
* "message": "Too many requests. Wait and retry.",
|
|
1766
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1767
|
+
* }
|
|
1768
|
+
* }
|
|
1769
|
+
*/
|
|
1770
|
+
"application/json": components["schemas"]["Error"];
|
|
1771
|
+
};
|
|
1772
|
+
};
|
|
1773
|
+
/** @description Our fault; retry. */
|
|
1774
|
+
500: {
|
|
1775
|
+
headers: {
|
|
1776
|
+
[name: string]: unknown;
|
|
1777
|
+
};
|
|
1778
|
+
content: {
|
|
1779
|
+
/**
|
|
1780
|
+
* @example {
|
|
1781
|
+
* "error": {
|
|
1782
|
+
* "code": "internal_error",
|
|
1783
|
+
* "message": "Something failed on our side. Retrying with the same Idempotency-Key is safe.",
|
|
1784
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1785
|
+
* }
|
|
1786
|
+
* }
|
|
1787
|
+
*/
|
|
1788
|
+
"application/json": components["schemas"]["Error"];
|
|
1789
|
+
};
|
|
1790
|
+
};
|
|
1791
|
+
};
|
|
1792
|
+
};
|
|
1793
|
+
getEsim: {
|
|
1794
|
+
parameters: {
|
|
1795
|
+
query?: never;
|
|
1796
|
+
header?: never;
|
|
1797
|
+
path: {
|
|
1798
|
+
/** @description The eSIM id. */
|
|
1799
|
+
id: string;
|
|
1800
|
+
};
|
|
1801
|
+
cookie?: never;
|
|
1802
|
+
};
|
|
1803
|
+
requestBody?: never;
|
|
1804
|
+
responses: {
|
|
1805
|
+
/** @description The eSIM, read live from the network. */
|
|
1806
|
+
200: {
|
|
1807
|
+
headers: {
|
|
1808
|
+
[name: string]: unknown;
|
|
1809
|
+
};
|
|
1810
|
+
content: {
|
|
1811
|
+
"application/json": components["schemas"]["Esim"];
|
|
1812
|
+
};
|
|
1813
|
+
};
|
|
1814
|
+
/** @description Malformed request. */
|
|
1815
|
+
400: {
|
|
1816
|
+
headers: {
|
|
1817
|
+
[name: string]: unknown;
|
|
1818
|
+
};
|
|
1819
|
+
content: {
|
|
1820
|
+
/**
|
|
1821
|
+
* @example {
|
|
1822
|
+
* "error": {
|
|
1823
|
+
* "code": "invalid_request",
|
|
1824
|
+
* "message": "limit must be a whole number from 1 to 100.",
|
|
1825
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1826
|
+
* }
|
|
1827
|
+
* }
|
|
1828
|
+
*/
|
|
1829
|
+
"application/json": components["schemas"]["Error"];
|
|
1830
|
+
};
|
|
1831
|
+
};
|
|
1832
|
+
/** @description Missing, unknown or revoked key. */
|
|
1833
|
+
401: {
|
|
1834
|
+
headers: {
|
|
1835
|
+
[name: string]: unknown;
|
|
1836
|
+
};
|
|
1837
|
+
content: {
|
|
1838
|
+
/**
|
|
1839
|
+
* @example {
|
|
1840
|
+
* "error": {
|
|
1841
|
+
* "code": "unauthorized",
|
|
1842
|
+
* "message": "Send a valid API key as `Authorization: Bearer osk_…`.",
|
|
1843
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1844
|
+
* }
|
|
1845
|
+
* }
|
|
1846
|
+
*/
|
|
1847
|
+
"application/json": components["schemas"]["Error"];
|
|
1848
|
+
};
|
|
1849
|
+
};
|
|
1850
|
+
/** @description No such eSIM. */
|
|
1851
|
+
404: {
|
|
1852
|
+
headers: {
|
|
1853
|
+
[name: string]: unknown;
|
|
1854
|
+
};
|
|
1855
|
+
content: {
|
|
1856
|
+
/**
|
|
1857
|
+
* @example {
|
|
1858
|
+
* "error": {
|
|
1859
|
+
* "code": "not_found",
|
|
1860
|
+
* "message": "No such eSIM.",
|
|
1861
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1862
|
+
* }
|
|
1863
|
+
* }
|
|
1864
|
+
*/
|
|
1865
|
+
"application/json": components["schemas"]["Error"];
|
|
1866
|
+
};
|
|
1867
|
+
};
|
|
1868
|
+
/** @description Rate limited. */
|
|
1869
|
+
429: {
|
|
1870
|
+
headers: {
|
|
1871
|
+
[name: string]: unknown;
|
|
1872
|
+
};
|
|
1873
|
+
content: {
|
|
1874
|
+
/**
|
|
1875
|
+
* @example {
|
|
1876
|
+
* "error": {
|
|
1877
|
+
* "code": "rate_limited",
|
|
1878
|
+
* "message": "Too many requests. Wait and retry.",
|
|
1879
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1880
|
+
* }
|
|
1881
|
+
* }
|
|
1882
|
+
*/
|
|
1883
|
+
"application/json": components["schemas"]["Error"];
|
|
1884
|
+
};
|
|
1885
|
+
};
|
|
1886
|
+
/** @description Our fault; retry. */
|
|
1887
|
+
500: {
|
|
1888
|
+
headers: {
|
|
1889
|
+
[name: string]: unknown;
|
|
1890
|
+
};
|
|
1891
|
+
content: {
|
|
1892
|
+
/**
|
|
1893
|
+
* @example {
|
|
1894
|
+
* "error": {
|
|
1895
|
+
* "code": "internal_error",
|
|
1896
|
+
* "message": "Something failed on our side. Retrying with the same Idempotency-Key is safe.",
|
|
1897
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1898
|
+
* }
|
|
1899
|
+
* }
|
|
1900
|
+
*/
|
|
1901
|
+
"application/json": components["schemas"]["Error"];
|
|
1902
|
+
};
|
|
1903
|
+
};
|
|
1904
|
+
};
|
|
1905
|
+
};
|
|
1906
|
+
getBalance: {
|
|
1907
|
+
parameters: {
|
|
1908
|
+
query?: never;
|
|
1909
|
+
header?: never;
|
|
1910
|
+
path?: never;
|
|
1911
|
+
cookie?: never;
|
|
1912
|
+
};
|
|
1913
|
+
requestBody?: never;
|
|
1914
|
+
responses: {
|
|
1915
|
+
/** @description Your balance. */
|
|
1916
|
+
200: {
|
|
1917
|
+
headers: {
|
|
1918
|
+
[name: string]: unknown;
|
|
1919
|
+
};
|
|
1920
|
+
content: {
|
|
1921
|
+
"application/json": components["schemas"]["Balance"];
|
|
1922
|
+
};
|
|
1923
|
+
};
|
|
1924
|
+
/** @description Malformed request. */
|
|
1925
|
+
400: {
|
|
1926
|
+
headers: {
|
|
1927
|
+
[name: string]: unknown;
|
|
1928
|
+
};
|
|
1929
|
+
content: {
|
|
1930
|
+
/**
|
|
1931
|
+
* @example {
|
|
1932
|
+
* "error": {
|
|
1933
|
+
* "code": "invalid_request",
|
|
1934
|
+
* "message": "limit must be a whole number from 1 to 100.",
|
|
1935
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1936
|
+
* }
|
|
1937
|
+
* }
|
|
1938
|
+
*/
|
|
1939
|
+
"application/json": components["schemas"]["Error"];
|
|
1940
|
+
};
|
|
1941
|
+
};
|
|
1942
|
+
/** @description Missing, unknown or revoked key. */
|
|
1943
|
+
401: {
|
|
1944
|
+
headers: {
|
|
1945
|
+
[name: string]: unknown;
|
|
1946
|
+
};
|
|
1947
|
+
content: {
|
|
1948
|
+
/**
|
|
1949
|
+
* @example {
|
|
1950
|
+
* "error": {
|
|
1951
|
+
* "code": "unauthorized",
|
|
1952
|
+
* "message": "Send a valid API key as `Authorization: Bearer osk_…`.",
|
|
1953
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1954
|
+
* }
|
|
1955
|
+
* }
|
|
1956
|
+
*/
|
|
1957
|
+
"application/json": components["schemas"]["Error"];
|
|
1958
|
+
};
|
|
1959
|
+
};
|
|
1960
|
+
/** @description Rate limited. */
|
|
1961
|
+
429: {
|
|
1962
|
+
headers: {
|
|
1963
|
+
[name: string]: unknown;
|
|
1964
|
+
};
|
|
1965
|
+
content: {
|
|
1966
|
+
/**
|
|
1967
|
+
* @example {
|
|
1968
|
+
* "error": {
|
|
1969
|
+
* "code": "rate_limited",
|
|
1970
|
+
* "message": "Too many requests. Wait and retry.",
|
|
1971
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1972
|
+
* }
|
|
1973
|
+
* }
|
|
1974
|
+
*/
|
|
1975
|
+
"application/json": components["schemas"]["Error"];
|
|
1976
|
+
};
|
|
1977
|
+
};
|
|
1978
|
+
/** @description Our fault; retry. */
|
|
1979
|
+
500: {
|
|
1980
|
+
headers: {
|
|
1981
|
+
[name: string]: unknown;
|
|
1982
|
+
};
|
|
1983
|
+
content: {
|
|
1984
|
+
/**
|
|
1985
|
+
* @example {
|
|
1986
|
+
* "error": {
|
|
1987
|
+
* "code": "internal_error",
|
|
1988
|
+
* "message": "Something failed on our side. Retrying with the same Idempotency-Key is safe.",
|
|
1989
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
1990
|
+
* }
|
|
1991
|
+
* }
|
|
1992
|
+
*/
|
|
1993
|
+
"application/json": components["schemas"]["Error"];
|
|
1994
|
+
};
|
|
1995
|
+
};
|
|
1996
|
+
};
|
|
1997
|
+
};
|
|
1998
|
+
getOpenApi: {
|
|
1999
|
+
parameters: {
|
|
2000
|
+
query?: never;
|
|
2001
|
+
header?: never;
|
|
2002
|
+
path?: never;
|
|
2003
|
+
cookie?: never;
|
|
2004
|
+
};
|
|
2005
|
+
requestBody?: never;
|
|
2006
|
+
responses: {
|
|
2007
|
+
/** @description The OpenAPI document. */
|
|
2008
|
+
200: {
|
|
2009
|
+
headers: {
|
|
2010
|
+
[name: string]: unknown;
|
|
2011
|
+
};
|
|
2012
|
+
content: {
|
|
2013
|
+
"application/json": Record<string, unknown>;
|
|
2014
|
+
};
|
|
2015
|
+
};
|
|
2016
|
+
/** @description Malformed request. */
|
|
2017
|
+
400: {
|
|
2018
|
+
headers: {
|
|
2019
|
+
[name: string]: unknown;
|
|
2020
|
+
};
|
|
2021
|
+
content: {
|
|
2022
|
+
/**
|
|
2023
|
+
* @example {
|
|
2024
|
+
* "error": {
|
|
2025
|
+
* "code": "invalid_request",
|
|
2026
|
+
* "message": "limit must be a whole number from 1 to 100.",
|
|
2027
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
2028
|
+
* }
|
|
2029
|
+
* }
|
|
2030
|
+
*/
|
|
2031
|
+
"application/json": components["schemas"]["Error"];
|
|
2032
|
+
};
|
|
2033
|
+
};
|
|
2034
|
+
/** @description Missing, unknown or revoked key. */
|
|
2035
|
+
401: {
|
|
2036
|
+
headers: {
|
|
2037
|
+
[name: string]: unknown;
|
|
2038
|
+
};
|
|
2039
|
+
content: {
|
|
2040
|
+
/**
|
|
2041
|
+
* @example {
|
|
2042
|
+
* "error": {
|
|
2043
|
+
* "code": "unauthorized",
|
|
2044
|
+
* "message": "Send a valid API key as `Authorization: Bearer osk_…`.",
|
|
2045
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
2046
|
+
* }
|
|
2047
|
+
* }
|
|
2048
|
+
*/
|
|
2049
|
+
"application/json": components["schemas"]["Error"];
|
|
2050
|
+
};
|
|
2051
|
+
};
|
|
2052
|
+
/** @description Rate limited. */
|
|
2053
|
+
429: {
|
|
2054
|
+
headers: {
|
|
2055
|
+
[name: string]: unknown;
|
|
2056
|
+
};
|
|
2057
|
+
content: {
|
|
2058
|
+
/**
|
|
2059
|
+
* @example {
|
|
2060
|
+
* "error": {
|
|
2061
|
+
* "code": "rate_limited",
|
|
2062
|
+
* "message": "Too many requests. Wait and retry.",
|
|
2063
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
2064
|
+
* }
|
|
2065
|
+
* }
|
|
2066
|
+
*/
|
|
2067
|
+
"application/json": components["schemas"]["Error"];
|
|
2068
|
+
};
|
|
2069
|
+
};
|
|
2070
|
+
/** @description Our fault; retry. */
|
|
2071
|
+
500: {
|
|
2072
|
+
headers: {
|
|
2073
|
+
[name: string]: unknown;
|
|
2074
|
+
};
|
|
2075
|
+
content: {
|
|
2076
|
+
/**
|
|
2077
|
+
* @example {
|
|
2078
|
+
* "error": {
|
|
2079
|
+
* "code": "internal_error",
|
|
2080
|
+
* "message": "Something failed on our side. Retrying with the same Idempotency-Key is safe.",
|
|
2081
|
+
* "request_id": "0c5e8a3f-2b7d-4e91-a6c4-9f1d3b8e7a52"
|
|
2082
|
+
* }
|
|
2083
|
+
* }
|
|
2084
|
+
*/
|
|
2085
|
+
"application/json": components["schemas"]["Error"];
|
|
2086
|
+
};
|
|
2087
|
+
};
|
|
2088
|
+
};
|
|
2089
|
+
};
|
|
2090
|
+
}
|