celitech-sdk 1.3.38 → 1.3.42
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/README.md +31 -3
- package/dist/index.d.ts +314 -23
- package/dist/index.js +1554 -656
- package/dist/index.mjs +1531 -634
- package/package.json +3 -2
package/README.md
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
# Celitech TypeScript SDK 1.3.
|
1
|
+
# Celitech TypeScript SDK 1.3.42
|
2
2
|
|
3
3
|
Welcome to the Celitech SDK documentation. This guide will help you get started with integrating and using the Celitech SDK in your project.
|
4
4
|
|
@@ -6,8 +6,8 @@ Welcome to the Celitech SDK documentation. This guide will help you get started
|
|
6
6
|
|
7
7
|
## Versions
|
8
8
|
|
9
|
-
- API version: `1.
|
10
|
-
- SDK version: `1.3.
|
9
|
+
- API version: `1.3.42`
|
10
|
+
- SDK version: `1.3.42`
|
11
11
|
|
12
12
|
## About the API
|
13
13
|
|
@@ -133,20 +133,48 @@ The SDK includes several models that represent the data structures used in API r
|
|
133
133
|
| [GetAccessTokenRequest](documentation/models/GetAccessTokenRequest.md) | |
|
134
134
|
| [GetAccessTokenOkResponse](documentation/models/GetAccessTokenOkResponse.md) | |
|
135
135
|
| [ListDestinationsOkResponse](documentation/models/ListDestinationsOkResponse.md) | |
|
136
|
+
| [\_\_](documentation/models/__.md) | |
|
137
|
+
| [\_1](documentation/models/_1.md) | |
|
136
138
|
| [ListPackagesOkResponse](documentation/models/ListPackagesOkResponse.md) | |
|
139
|
+
| [\_2](documentation/models/_2.md) | |
|
140
|
+
| [\_3](documentation/models/_3.md) | |
|
141
|
+
| [CreatePurchaseV2Request](documentation/models/CreatePurchaseV2Request.md) | |
|
142
|
+
| [CreatePurchaseV2OkResponse](documentation/models/CreatePurchaseV2OkResponse.md) | |
|
143
|
+
| [\_4](documentation/models/_4.md) | |
|
144
|
+
| [\_5](documentation/models/_5.md) | |
|
137
145
|
| [ListPurchasesOkResponse](documentation/models/ListPurchasesOkResponse.md) | |
|
146
|
+
| [\_6](documentation/models/_6.md) | |
|
147
|
+
| [\_7](documentation/models/_7.md) | |
|
138
148
|
| [CreatePurchaseRequest](documentation/models/CreatePurchaseRequest.md) | |
|
139
149
|
| [CreatePurchaseOkResponse](documentation/models/CreatePurchaseOkResponse.md) | |
|
150
|
+
| [\_8](documentation/models/_8.md) | |
|
151
|
+
| [\_9](documentation/models/_9.md) | |
|
140
152
|
| [TopUpEsimRequest](documentation/models/TopUpEsimRequest.md) | |
|
141
153
|
| [TopUpEsimOkResponse](documentation/models/TopUpEsimOkResponse.md) | |
|
154
|
+
| [\_10](documentation/models/_10.md) | |
|
155
|
+
| [\_11](documentation/models/_11.md) | |
|
142
156
|
| [EditPurchaseRequest](documentation/models/EditPurchaseRequest.md) | |
|
143
157
|
| [EditPurchaseOkResponse](documentation/models/EditPurchaseOkResponse.md) | |
|
158
|
+
| [\_12](documentation/models/_12.md) | |
|
159
|
+
| [\_13](documentation/models/_13.md) | |
|
144
160
|
| [GetPurchaseConsumptionOkResponse](documentation/models/GetPurchaseConsumptionOkResponse.md) | |
|
161
|
+
| [\_14](documentation/models/_14.md) | |
|
162
|
+
| [\_15](documentation/models/_15.md) | |
|
145
163
|
| [GetEsimOkResponse](documentation/models/GetEsimOkResponse.md) | |
|
164
|
+
| [\_16](documentation/models/_16.md) | |
|
165
|
+
| [\_17](documentation/models/_17.md) | |
|
146
166
|
| [GetEsimDeviceOkResponse](documentation/models/GetEsimDeviceOkResponse.md) | |
|
167
|
+
| [\_18](documentation/models/_18.md) | |
|
168
|
+
| [\_19](documentation/models/_19.md) | |
|
147
169
|
| [GetEsimHistoryOkResponse](documentation/models/GetEsimHistoryOkResponse.md) | |
|
170
|
+
| [\_20](documentation/models/_20.md) | |
|
171
|
+
| [\_21](documentation/models/_21.md) | |
|
148
172
|
| [GetEsimMacOkResponse](documentation/models/GetEsimMacOkResponse.md) | |
|
173
|
+
| [\_22](documentation/models/_22.md) | |
|
174
|
+
| [\_23](documentation/models/_23.md) | |
|
149
175
|
| [TokenOkResponse](documentation/models/TokenOkResponse.md) | |
|
176
|
+
| [\_24](documentation/models/_24.md) | |
|
177
|
+
| [\_25](documentation/models/_25.md) | |
|
150
178
|
|
151
179
|
</details>
|
152
180
|
|
package/dist/index.d.ts
CHANGED
@@ -4,7 +4,7 @@ declare enum Environment {
|
|
4
4
|
DEFAULT = "https://api.celitech.net/v1"
|
5
5
|
}
|
6
6
|
|
7
|
-
type HttpMethod$1 = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD';
|
7
|
+
type HttpMethod$1 = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS';
|
8
8
|
interface HttpRequest {
|
9
9
|
baseUrl: string;
|
10
10
|
method: HttpMethod$1;
|
@@ -64,6 +64,11 @@ interface ResponseDefinition {
|
|
64
64
|
contentType: ContentType;
|
65
65
|
status: number;
|
66
66
|
}
|
67
|
+
interface ErrorDefinition {
|
68
|
+
error: new (...args: any[]) => Error;
|
69
|
+
contentType: ContentType;
|
70
|
+
status: number;
|
71
|
+
}
|
67
72
|
interface CreateRequestParameters<Page = unknown[]> {
|
68
73
|
baseUrl: string;
|
69
74
|
method: HttpMethod;
|
@@ -74,6 +79,7 @@ interface CreateRequestParameters<Page = unknown[]> {
|
|
74
79
|
path: string;
|
75
80
|
config: SdkConfig;
|
76
81
|
responses: ResponseDefinition[];
|
82
|
+
errors: ErrorDefinition[];
|
77
83
|
requestSchema: ZodType;
|
78
84
|
requestContentType: ContentType;
|
79
85
|
validation: ValidationOptions;
|
@@ -96,6 +102,7 @@ interface RequestPagination<Page> {
|
|
96
102
|
pagePath: string[];
|
97
103
|
pageSchema?: ZodType<Page, any, any>;
|
98
104
|
}
|
105
|
+
|
99
106
|
declare class Request<PageSchema = unknown[]> {
|
100
107
|
baseUrl: string;
|
101
108
|
headers: Map<string, RequestParameter>;
|
@@ -106,6 +113,7 @@ declare class Request<PageSchema = unknown[]> {
|
|
106
113
|
path: string;
|
107
114
|
config: SdkConfig;
|
108
115
|
responses: ResponseDefinition[];
|
116
|
+
errors: ErrorDefinition[];
|
109
117
|
requestSchema: ZodType;
|
110
118
|
requestContentType: ContentType;
|
111
119
|
validation: ValidationOptions;
|
@@ -129,7 +137,7 @@ declare class Request<PageSchema = unknown[]> {
|
|
129
137
|
private getAllParams;
|
130
138
|
}
|
131
139
|
|
132
|
-
type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD';
|
140
|
+
type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS';
|
133
141
|
interface SdkConfig {
|
134
142
|
baseUrl?: string;
|
135
143
|
environment?: Environment;
|
@@ -137,6 +145,7 @@ interface SdkConfig {
|
|
137
145
|
clientId: string;
|
138
146
|
clientSecret: string;
|
139
147
|
oAuthBaseUrl?: string;
|
148
|
+
accessToken?: string;
|
140
149
|
retry?: RetryOptions;
|
141
150
|
validation?: ValidationOptions;
|
142
151
|
}
|
@@ -166,6 +175,7 @@ declare enum ContentType {
|
|
166
175
|
interface RequestConfig {
|
167
176
|
retry?: RetryOptions;
|
168
177
|
validation?: ValidationOptions;
|
178
|
+
baseUrl?: string;
|
169
179
|
}
|
170
180
|
interface RetryOptions {
|
171
181
|
attempts: number;
|
@@ -211,6 +221,7 @@ declare class BaseService {
|
|
211
221
|
set clientId(clientId: string);
|
212
222
|
set clientSecret(clientSecret: string);
|
213
223
|
set oAuthBaseUrl(oAuthBaseUrl: string);
|
224
|
+
set accessToken(accessToken: string);
|
214
225
|
}
|
215
226
|
|
216
227
|
/**
|
@@ -266,6 +277,7 @@ type GetAccessTokenOkResponse = z.infer<typeof getAccessTokenOkResponse>;
|
|
266
277
|
declare class OAuthService extends BaseService {
|
267
278
|
/**
|
268
279
|
* This endpoint was added by liblab
|
280
|
+
* @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
|
269
281
|
* @returns {Promise<HttpResponse<GetAccessTokenOkResponse>>} Successful Response
|
270
282
|
*/
|
271
283
|
getAccessToken(body: GetAccessTokenRequest, requestConfig?: RequestConfig): Promise<HttpResponse<GetAccessTokenOkResponse>>;
|
@@ -315,6 +327,7 @@ type ListDestinationsOkResponse = z.infer<typeof listDestinationsOkResponse>;
|
|
315
327
|
declare class DestinationsService extends BaseService {
|
316
328
|
/**
|
317
329
|
* List Destinations
|
330
|
+
* @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
|
318
331
|
* @returns {Promise<HttpResponse<ListDestinationsOkResponse>>} Successful Response
|
319
332
|
*/
|
320
333
|
listDestinations(requestConfig?: RequestConfig): Promise<HttpResponse<ListDestinationsOkResponse>>;
|
@@ -345,6 +358,14 @@ declare const destinations: z.ZodLazy<z.ZodObject<{
|
|
345
358
|
*/
|
346
359
|
type Destinations = z.infer<typeof destinations>;
|
347
360
|
|
361
|
+
declare class __ extends Error {
|
362
|
+
constructor(message?: string, response?: unknown);
|
363
|
+
}
|
364
|
+
|
365
|
+
declare class _1 extends Error {
|
366
|
+
constructor(message?: string, response?: unknown);
|
367
|
+
}
|
368
|
+
|
348
369
|
/**
|
349
370
|
* The shape of the model inside the application code - what the users use
|
350
371
|
*/
|
@@ -415,14 +436,15 @@ interface ListPackagesParams {
|
|
415
436
|
declare class PackagesService extends BaseService {
|
416
437
|
/**
|
417
438
|
* List Packages
|
418
|
-
* @param {string} [destination] - ISO representation of the package's destination.
|
419
|
-
* @param {string} [startDate] - Start date of the package's validity in the format 'yyyy-MM-dd'. This date can be set to the current day or any day within the next 12 months.
|
420
|
-
* @param {string} [endDate] - End date of the package's validity in the format 'yyyy-MM-dd'. End date can be maximum 90 days after Start date.
|
421
|
-
* @param {string} [afterCursor] - To get the next batch of results, use this parameter. It tells the API where to start fetching data after the last item you received. It helps you avoid repeats and efficiently browse through large sets of data.
|
422
|
-
* @param {number} [limit] - Maximum number of packages to be returned in the response. The value must be greater than 0 and less than or equal to 160. If not provided, the default value is 20
|
423
|
-
* @param {number} [startTime] - Epoch value representing the start time of the package's validity. This timestamp can be set to the current time or any time within the next 12 months
|
424
|
-
* @param {number} [endTime] - Epoch value representing the end time of the package's validity. End time can be maximum 90 days after Start time
|
425
|
-
* @param {number} [duration] - Duration in seconds for the package's validity. If this parameter is present, it will override the startTime and endTime parameters. The maximum duration for a package's validity period is 90 days
|
439
|
+
* @param {string} [params.destination] - ISO representation of the package's destination.
|
440
|
+
* @param {string} [params.startDate] - Start date of the package's validity in the format 'yyyy-MM-dd'. This date can be set to the current day or any day within the next 12 months.
|
441
|
+
* @param {string} [params.endDate] - End date of the package's validity in the format 'yyyy-MM-dd'. End date can be maximum 90 days after Start date.
|
442
|
+
* @param {string} [params.afterCursor] - To get the next batch of results, use this parameter. It tells the API where to start fetching data after the last item you received. It helps you avoid repeats and efficiently browse through large sets of data.
|
443
|
+
* @param {number} [params.limit] - Maximum number of packages to be returned in the response. The value must be greater than 0 and less than or equal to 160. If not provided, the default value is 20
|
444
|
+
* @param {number} [params.startTime] - Epoch value representing the start time of the package's validity. This timestamp can be set to the current time or any time within the next 12 months
|
445
|
+
* @param {number} [params.endTime] - Epoch value representing the end time of the package's validity. End time can be maximum 90 days after Start time
|
446
|
+
* @param {number} [params.duration] - Duration in seconds for the package's validity. If this parameter is present, it will override the startTime and endTime parameters. The maximum duration for a package's validity period is 90 days
|
447
|
+
* @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
|
426
448
|
* @returns {Promise<HttpResponse<ListPackagesOkResponse>>} Successful Response
|
427
449
|
*/
|
428
450
|
listPackages(params?: ListPackagesParams, requestConfig?: RequestConfig): Promise<HttpResponse<ListPackagesOkResponse>>;
|
@@ -465,6 +487,120 @@ declare const packages: z.ZodLazy<z.ZodObject<{
|
|
465
487
|
*/
|
466
488
|
type Packages = z.infer<typeof packages>;
|
467
489
|
|
490
|
+
declare class _2 extends Error {
|
491
|
+
constructor(message?: string, response?: unknown);
|
492
|
+
}
|
493
|
+
|
494
|
+
declare class _3 extends Error {
|
495
|
+
constructor(message?: string, response?: unknown);
|
496
|
+
}
|
497
|
+
|
498
|
+
/**
|
499
|
+
* The shape of the model inside the application code - what the users use
|
500
|
+
*/
|
501
|
+
declare const createPurchaseV2Request: z.ZodLazy<z.ZodObject<{
|
502
|
+
destination: z.ZodString;
|
503
|
+
dataLimitInGb: z.ZodNumber;
|
504
|
+
startDate: z.ZodString;
|
505
|
+
endDate: z.ZodString;
|
506
|
+
quantity: z.ZodNumber;
|
507
|
+
email: z.ZodOptional<z.ZodString>;
|
508
|
+
referenceId: z.ZodOptional<z.ZodString>;
|
509
|
+
networkBrand: z.ZodOptional<z.ZodString>;
|
510
|
+
}, "strip", z.ZodTypeAny, {
|
511
|
+
destination: string;
|
512
|
+
startDate: string;
|
513
|
+
endDate: string;
|
514
|
+
dataLimitInGb: number;
|
515
|
+
quantity: number;
|
516
|
+
email?: string | undefined;
|
517
|
+
referenceId?: string | undefined;
|
518
|
+
networkBrand?: string | undefined;
|
519
|
+
}, {
|
520
|
+
destination: string;
|
521
|
+
startDate: string;
|
522
|
+
endDate: string;
|
523
|
+
dataLimitInGb: number;
|
524
|
+
quantity: number;
|
525
|
+
email?: string | undefined;
|
526
|
+
referenceId?: string | undefined;
|
527
|
+
networkBrand?: string | undefined;
|
528
|
+
}>>;
|
529
|
+
/**
|
530
|
+
*
|
531
|
+
* @typedef {CreatePurchaseV2Request} createPurchaseV2Request
|
532
|
+
* @property {string} - ISO representation of the package's destination
|
533
|
+
* @property {number} - Size of the package in GB. The available options are 1, 2, 3, 5, 8, 20GB
|
534
|
+
* @property {string} - Start date of the package's validity in the format 'yyyy-MM-dd'. This date can be set to the current day or any day within the next 12 months.
|
535
|
+
* @property {string} - End date of the package's validity in the format 'yyyy-MM-dd'. End date can be maximum 90 days after Start date.
|
536
|
+
* @property {number} - Number of eSIMs to purchase.
|
537
|
+
* @property {string} - Email address where the purchase confirmation email will be sent (including QR Code & activation steps)
|
538
|
+
* @property {string} - An identifier provided by the partner to link this purchase to their booking or transaction for analytics and debugging purposes.
|
539
|
+
* @property {string} - Customize the network brand of the issued eSIM. This parameter is accessible to platforms with Diamond tier and requires an alphanumeric string of up to 15 characters.
|
540
|
+
*/
|
541
|
+
type CreatePurchaseV2Request = z.infer<typeof createPurchaseV2Request>;
|
542
|
+
|
543
|
+
/**
|
544
|
+
* The shape of the model inside the application code - what the users use
|
545
|
+
*/
|
546
|
+
declare const createPurchaseV2OkResponse: z.ZodLazy<z.ZodObject<{
|
547
|
+
purchase: z.ZodOptional<z.ZodLazy<z.ZodObject<{
|
548
|
+
id: z.ZodOptional<z.ZodString>;
|
549
|
+
packageId: z.ZodOptional<z.ZodString>;
|
550
|
+
createdDate: z.ZodOptional<z.ZodString>;
|
551
|
+
}, "strip", z.ZodTypeAny, {
|
552
|
+
id?: string | undefined;
|
553
|
+
packageId?: string | undefined;
|
554
|
+
createdDate?: string | undefined;
|
555
|
+
}, {
|
556
|
+
id?: string | undefined;
|
557
|
+
packageId?: string | undefined;
|
558
|
+
createdDate?: string | undefined;
|
559
|
+
}>>>;
|
560
|
+
profile: z.ZodOptional<z.ZodLazy<z.ZodObject<{
|
561
|
+
iccid: z.ZodOptional<z.ZodString>;
|
562
|
+
activationCode: z.ZodOptional<z.ZodString>;
|
563
|
+
manualActivationCode: z.ZodOptional<z.ZodString>;
|
564
|
+
}, "strip", z.ZodTypeAny, {
|
565
|
+
iccid?: string | undefined;
|
566
|
+
activationCode?: string | undefined;
|
567
|
+
manualActivationCode?: string | undefined;
|
568
|
+
}, {
|
569
|
+
iccid?: string | undefined;
|
570
|
+
activationCode?: string | undefined;
|
571
|
+
manualActivationCode?: string | undefined;
|
572
|
+
}>>>;
|
573
|
+
}, "strip", z.ZodTypeAny, {
|
574
|
+
purchase?: {
|
575
|
+
id?: string | undefined;
|
576
|
+
packageId?: string | undefined;
|
577
|
+
createdDate?: string | undefined;
|
578
|
+
} | undefined;
|
579
|
+
profile?: {
|
580
|
+
iccid?: string | undefined;
|
581
|
+
activationCode?: string | undefined;
|
582
|
+
manualActivationCode?: string | undefined;
|
583
|
+
} | undefined;
|
584
|
+
}, {
|
585
|
+
purchase?: {
|
586
|
+
id?: string | undefined;
|
587
|
+
packageId?: string | undefined;
|
588
|
+
createdDate?: string | undefined;
|
589
|
+
} | undefined;
|
590
|
+
profile?: {
|
591
|
+
iccid?: string | undefined;
|
592
|
+
activationCode?: string | undefined;
|
593
|
+
manualActivationCode?: string | undefined;
|
594
|
+
} | undefined;
|
595
|
+
}>>;
|
596
|
+
/**
|
597
|
+
*
|
598
|
+
* @typedef {CreatePurchaseV2OkResponse} createPurchaseV2OkResponse
|
599
|
+
* @property {CreatePurchaseV2OkResponsePurchase}
|
600
|
+
* @property {CreatePurchaseV2OkResponseProfile}
|
601
|
+
*/
|
602
|
+
type CreatePurchaseV2OkResponse = z.infer<typeof createPurchaseV2OkResponse>;
|
603
|
+
|
468
604
|
/**
|
469
605
|
* The shape of the model inside the application code - what the users use
|
470
606
|
*/
|
@@ -758,8 +894,8 @@ declare const topUpEsimRequest: z.ZodLazy<z.ZodObject<{
|
|
758
894
|
}, "strip", z.ZodTypeAny, {
|
759
895
|
startDate: string;
|
760
896
|
endDate: string;
|
761
|
-
iccid: string;
|
762
897
|
dataLimitInGb: number;
|
898
|
+
iccid: string;
|
763
899
|
email?: string | undefined;
|
764
900
|
referenceId?: string | undefined;
|
765
901
|
startTime?: number | undefined;
|
@@ -767,8 +903,8 @@ declare const topUpEsimRequest: z.ZodLazy<z.ZodObject<{
|
|
767
903
|
}, {
|
768
904
|
startDate: string;
|
769
905
|
endDate: string;
|
770
|
-
iccid: string;
|
771
906
|
dataLimitInGb: number;
|
907
|
+
iccid: string;
|
772
908
|
email?: string | undefined;
|
773
909
|
referenceId?: string | undefined;
|
774
910
|
startTime?: number | undefined;
|
@@ -947,42 +1083,103 @@ declare const getPurchaseConsumptionOkResponse: z.ZodLazy<z.ZodObject<{
|
|
947
1083
|
type GetPurchaseConsumptionOkResponse = z.infer<typeof getPurchaseConsumptionOkResponse>;
|
948
1084
|
|
949
1085
|
declare class PurchasesService extends BaseService {
|
1086
|
+
/**
|
1087
|
+
* This endpoint is used to purchase a new eSIM by providing the package details.
|
1088
|
+
* @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
|
1089
|
+
* @returns {Promise<HttpResponse<CreatePurchaseV2OkResponse[]>>} Successful Response
|
1090
|
+
*/
|
1091
|
+
createPurchaseV2(body: CreatePurchaseV2Request, requestConfig?: RequestConfig): Promise<HttpResponse<CreatePurchaseV2OkResponse[]>>;
|
950
1092
|
/**
|
951
1093
|
* This endpoint can be used to list all the successful purchases made between a given interval.
|
952
|
-
* @param {string} [iccid] - ID of the eSIM
|
953
|
-
* @param {string} [afterDate] - Start date of the interval for filtering purchases in the format 'yyyy-MM-dd'
|
954
|
-
* @param {string} [beforeDate] - End date of the interval for filtering purchases in the format 'yyyy-MM-dd'
|
955
|
-
* @param {string} [referenceId] - The referenceId that was provided by the partner during the purchase or topup flow.
|
956
|
-
* @param {string} [afterCursor] - To get the next batch of results, use this parameter. It tells the API where to start fetching data after the last item you received. It helps you avoid repeats and efficiently browse through large sets of data.
|
957
|
-
* @param {number} [limit] - Maximum number of purchases to be returned in the response. The value must be greater than 0 and less than or equal to 100. If not provided, the default value is 20
|
958
|
-
* @param {number} [after] - Epoch value representing the start of the time interval for filtering purchases
|
959
|
-
* @param {number} [before] - Epoch value representing the end of the time interval for filtering purchases
|
1094
|
+
* @param {string} [params.iccid] - ID of the eSIM
|
1095
|
+
* @param {string} [params.afterDate] - Start date of the interval for filtering purchases in the format 'yyyy-MM-dd'
|
1096
|
+
* @param {string} [params.beforeDate] - End date of the interval for filtering purchases in the format 'yyyy-MM-dd'
|
1097
|
+
* @param {string} [params.referenceId] - The referenceId that was provided by the partner during the purchase or topup flow.
|
1098
|
+
* @param {string} [params.afterCursor] - To get the next batch of results, use this parameter. It tells the API where to start fetching data after the last item you received. It helps you avoid repeats and efficiently browse through large sets of data.
|
1099
|
+
* @param {number} [params.limit] - Maximum number of purchases to be returned in the response. The value must be greater than 0 and less than or equal to 100. If not provided, the default value is 20
|
1100
|
+
* @param {number} [params.after] - Epoch value representing the start of the time interval for filtering purchases
|
1101
|
+
* @param {number} [params.before] - Epoch value representing the end of the time interval for filtering purchases
|
1102
|
+
* @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
|
960
1103
|
* @returns {Promise<HttpResponse<ListPurchasesOkResponse>>} Successful Response
|
961
1104
|
*/
|
962
1105
|
listPurchases(params?: ListPurchasesParams, requestConfig?: RequestConfig): Promise<HttpResponse<ListPurchasesOkResponse>>;
|
963
1106
|
/**
|
964
1107
|
* This endpoint is used to purchase a new eSIM by providing the package details.
|
1108
|
+
* @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
|
965
1109
|
* @returns {Promise<HttpResponse<CreatePurchaseOkResponse>>} Successful Response
|
966
1110
|
*/
|
967
1111
|
createPurchase(body: CreatePurchaseRequest, requestConfig?: RequestConfig): Promise<HttpResponse<CreatePurchaseOkResponse>>;
|
968
1112
|
/**
|
969
|
-
* This endpoint is used to top-up an eSIM with the previously associated destination by providing an existing ICCID and the package details. The top-up is
|
1113
|
+
* This endpoint is used to top-up an eSIM with the previously associated destination by providing an existing ICCID and the package details. The top-up is only feasible for eSIMs in "ENABLED" or "INSTALLED" state. You can check this state using the Get eSIM Status endpoint.
|
1114
|
+
* @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
|
970
1115
|
* @returns {Promise<HttpResponse<TopUpEsimOkResponse>>} Successful Response
|
971
1116
|
*/
|
972
1117
|
topUpEsim(body: TopUpEsimRequest, requestConfig?: RequestConfig): Promise<HttpResponse<TopUpEsimOkResponse>>;
|
973
1118
|
/**
|
974
1119
|
* This endpoint allows you to modify the dates of an existing package with a future activation start time. Editing can only be performed for packages that have not been activated, and it cannot change the package size. The modification must not change the package duration category to ensure pricing consistency.
|
1120
|
+
* @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
|
975
1121
|
* @returns {Promise<HttpResponse<EditPurchaseOkResponse>>} Successful Response
|
976
1122
|
*/
|
977
1123
|
editPurchase(body: EditPurchaseRequest, requestConfig?: RequestConfig): Promise<HttpResponse<EditPurchaseOkResponse>>;
|
978
1124
|
/**
|
979
1125
|
* This endpoint can be called for consumption notifications (e.g. every 1 hour or when the user clicks a button). It returns the data balance (consumption) of purchased packages.
|
980
1126
|
* @param {string} purchaseId - ID of the purchase
|
1127
|
+
* @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
|
981
1128
|
* @returns {Promise<HttpResponse<GetPurchaseConsumptionOkResponse>>} Successful Response
|
982
1129
|
*/
|
983
1130
|
getPurchaseConsumption(purchaseId: string, requestConfig?: RequestConfig): Promise<HttpResponse<GetPurchaseConsumptionOkResponse>>;
|
984
1131
|
}
|
985
1132
|
|
1133
|
+
/**
|
1134
|
+
* The shape of the model inside the application code - what the users use
|
1135
|
+
*/
|
1136
|
+
declare const createPurchaseV2OkResponsePurchase: z.ZodLazy<z.ZodObject<{
|
1137
|
+
id: z.ZodOptional<z.ZodString>;
|
1138
|
+
packageId: z.ZodOptional<z.ZodString>;
|
1139
|
+
createdDate: z.ZodOptional<z.ZodString>;
|
1140
|
+
}, "strip", z.ZodTypeAny, {
|
1141
|
+
id?: string | undefined;
|
1142
|
+
packageId?: string | undefined;
|
1143
|
+
createdDate?: string | undefined;
|
1144
|
+
}, {
|
1145
|
+
id?: string | undefined;
|
1146
|
+
packageId?: string | undefined;
|
1147
|
+
createdDate?: string | undefined;
|
1148
|
+
}>>;
|
1149
|
+
/**
|
1150
|
+
*
|
1151
|
+
* @typedef {CreatePurchaseV2OkResponsePurchase} createPurchaseV2OkResponsePurchase
|
1152
|
+
* @property {string} - ID of the purchase
|
1153
|
+
* @property {string} - ID of the package
|
1154
|
+
* @property {string} - Creation date of the purchase in the format 'yyyy-MM-ddThh:mm:ssZZ'
|
1155
|
+
*/
|
1156
|
+
type CreatePurchaseV2OkResponsePurchase = z.infer<typeof createPurchaseV2OkResponsePurchase>;
|
1157
|
+
|
1158
|
+
/**
|
1159
|
+
* The shape of the model inside the application code - what the users use
|
1160
|
+
*/
|
1161
|
+
declare const createPurchaseV2OkResponseProfile: z.ZodLazy<z.ZodObject<{
|
1162
|
+
iccid: z.ZodOptional<z.ZodString>;
|
1163
|
+
activationCode: z.ZodOptional<z.ZodString>;
|
1164
|
+
manualActivationCode: z.ZodOptional<z.ZodString>;
|
1165
|
+
}, "strip", z.ZodTypeAny, {
|
1166
|
+
iccid?: string | undefined;
|
1167
|
+
activationCode?: string | undefined;
|
1168
|
+
manualActivationCode?: string | undefined;
|
1169
|
+
}, {
|
1170
|
+
iccid?: string | undefined;
|
1171
|
+
activationCode?: string | undefined;
|
1172
|
+
manualActivationCode?: string | undefined;
|
1173
|
+
}>>;
|
1174
|
+
/**
|
1175
|
+
*
|
1176
|
+
* @typedef {CreatePurchaseV2OkResponseProfile} createPurchaseV2OkResponseProfile
|
1177
|
+
* @property {string} - ID of the eSIM
|
1178
|
+
* @property {string} - QR Code of the eSIM as base64
|
1179
|
+
* @property {string} - Manual Activation Code of the eSIM
|
1180
|
+
*/
|
1181
|
+
type CreatePurchaseV2OkResponseProfile = z.infer<typeof createPurchaseV2OkResponseProfile>;
|
1182
|
+
|
986
1183
|
/**
|
987
1184
|
* The shape of the model inside the application code - what the users use
|
988
1185
|
*/
|
@@ -1075,7 +1272,7 @@ declare const purchases: z.ZodLazy<z.ZodObject<{
|
|
1075
1272
|
* @property {number} - Epoch value representing the date of creation of the purchase
|
1076
1273
|
* @property {Package_}
|
1077
1274
|
* @property {PurchasesEsim}
|
1078
|
-
* @property {string} - The source indicates where the eSIM was purchased, which can be from the API, dashboard, landing-page
|
1275
|
+
* @property {string} - The source indicates where the eSIM was purchased, which can be from the API, dashboard, landing-page, promo-page or iframe. For purchases made before September 8, 2023, the value will be displayed as 'Not available'.
|
1079
1276
|
* @property {string} - The referenceId that was provided by the partner during the purchase or topup flow. This identifier can be used for analytics and debugging purposes.
|
1080
1277
|
*/
|
1081
1278
|
type Purchases = z.infer<typeof purchases>;
|
@@ -1254,6 +1451,54 @@ declare const topUpEsimOkResponseProfile: z.ZodLazy<z.ZodObject<{
|
|
1254
1451
|
*/
|
1255
1452
|
type TopUpEsimOkResponseProfile = z.infer<typeof topUpEsimOkResponseProfile>;
|
1256
1453
|
|
1454
|
+
declare class _4 extends Error {
|
1455
|
+
constructor(message?: string, response?: unknown);
|
1456
|
+
}
|
1457
|
+
|
1458
|
+
declare class _5 extends Error {
|
1459
|
+
constructor(message?: string, response?: unknown);
|
1460
|
+
}
|
1461
|
+
|
1462
|
+
declare class _6 extends Error {
|
1463
|
+
constructor(message?: string, response?: unknown);
|
1464
|
+
}
|
1465
|
+
|
1466
|
+
declare class _7 extends Error {
|
1467
|
+
constructor(message?: string, response?: unknown);
|
1468
|
+
}
|
1469
|
+
|
1470
|
+
declare class _8 extends Error {
|
1471
|
+
constructor(message?: string, response?: unknown);
|
1472
|
+
}
|
1473
|
+
|
1474
|
+
declare class _9 extends Error {
|
1475
|
+
constructor(message?: string, response?: unknown);
|
1476
|
+
}
|
1477
|
+
|
1478
|
+
declare class _10 extends Error {
|
1479
|
+
constructor(message?: string, response?: unknown);
|
1480
|
+
}
|
1481
|
+
|
1482
|
+
declare class _11 extends Error {
|
1483
|
+
constructor(message?: string, response?: unknown);
|
1484
|
+
}
|
1485
|
+
|
1486
|
+
declare class _12 extends Error {
|
1487
|
+
constructor(message?: string, response?: unknown);
|
1488
|
+
}
|
1489
|
+
|
1490
|
+
declare class _13 extends Error {
|
1491
|
+
constructor(message?: string, response?: unknown);
|
1492
|
+
}
|
1493
|
+
|
1494
|
+
declare class _14 extends Error {
|
1495
|
+
constructor(message?: string, response?: unknown);
|
1496
|
+
}
|
1497
|
+
|
1498
|
+
declare class _15 extends Error {
|
1499
|
+
constructor(message?: string, response?: unknown);
|
1500
|
+
}
|
1501
|
+
|
1257
1502
|
/**
|
1258
1503
|
* The shape of the model inside the application code - what the users use
|
1259
1504
|
*/
|
@@ -1443,24 +1688,28 @@ declare class ESimService extends BaseService {
|
|
1443
1688
|
/**
|
1444
1689
|
* Get eSIM Status
|
1445
1690
|
* @param {string} iccid - ID of the eSIM
|
1691
|
+
* @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
|
1446
1692
|
* @returns {Promise<HttpResponse<GetEsimOkResponse>>} Successful Response
|
1447
1693
|
*/
|
1448
1694
|
getEsim(params: GetEsimParams, requestConfig?: RequestConfig): Promise<HttpResponse<GetEsimOkResponse>>;
|
1449
1695
|
/**
|
1450
1696
|
* Get eSIM Device
|
1451
1697
|
* @param {string} iccid - ID of the eSIM
|
1698
|
+
* @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
|
1452
1699
|
* @returns {Promise<HttpResponse<GetEsimDeviceOkResponse>>} Successful Response
|
1453
1700
|
*/
|
1454
1701
|
getEsimDevice(iccid: string, requestConfig?: RequestConfig): Promise<HttpResponse<GetEsimDeviceOkResponse>>;
|
1455
1702
|
/**
|
1456
1703
|
* Get eSIM History
|
1457
1704
|
* @param {string} iccid - ID of the eSIM
|
1705
|
+
* @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
|
1458
1706
|
* @returns {Promise<HttpResponse<GetEsimHistoryOkResponse>>} Successful Response
|
1459
1707
|
*/
|
1460
1708
|
getEsimHistory(iccid: string, requestConfig?: RequestConfig): Promise<HttpResponse<GetEsimHistoryOkResponse>>;
|
1461
1709
|
/**
|
1462
1710
|
* Get eSIM MAC
|
1463
1711
|
* @param {string} iccid - ID of the eSIM
|
1712
|
+
* @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
|
1464
1713
|
* @returns {Promise<HttpResponse<GetEsimMacOkResponse>>} Successful Response
|
1465
1714
|
*/
|
1466
1715
|
getEsimMac(iccid: string, requestConfig?: RequestConfig): Promise<HttpResponse<GetEsimMacOkResponse>>;
|
@@ -1615,6 +1864,38 @@ declare const getEsimMacOkResponseEsim: z.ZodLazy<z.ZodObject<{
|
|
1615
1864
|
*/
|
1616
1865
|
type GetEsimMacOkResponseEsim = z.infer<typeof getEsimMacOkResponseEsim>;
|
1617
1866
|
|
1867
|
+
declare class _16 extends Error {
|
1868
|
+
constructor(message?: string, response?: unknown);
|
1869
|
+
}
|
1870
|
+
|
1871
|
+
declare class _17 extends Error {
|
1872
|
+
constructor(message?: string, response?: unknown);
|
1873
|
+
}
|
1874
|
+
|
1875
|
+
declare class _18 extends Error {
|
1876
|
+
constructor(message?: string, response?: unknown);
|
1877
|
+
}
|
1878
|
+
|
1879
|
+
declare class _19 extends Error {
|
1880
|
+
constructor(message?: string, response?: unknown);
|
1881
|
+
}
|
1882
|
+
|
1883
|
+
declare class _20 extends Error {
|
1884
|
+
constructor(message?: string, response?: unknown);
|
1885
|
+
}
|
1886
|
+
|
1887
|
+
declare class _21 extends Error {
|
1888
|
+
constructor(message?: string, response?: unknown);
|
1889
|
+
}
|
1890
|
+
|
1891
|
+
declare class _22 extends Error {
|
1892
|
+
constructor(message?: string, response?: unknown);
|
1893
|
+
}
|
1894
|
+
|
1895
|
+
declare class _23 extends Error {
|
1896
|
+
constructor(message?: string, response?: unknown);
|
1897
|
+
}
|
1898
|
+
|
1618
1899
|
/**
|
1619
1900
|
* The shape of the model inside the application code - what the users use
|
1620
1901
|
*/
|
@@ -1635,11 +1916,20 @@ type TokenOkResponse = z.infer<typeof tokenOkResponse>;
|
|
1635
1916
|
declare class IFrameService extends BaseService {
|
1636
1917
|
/**
|
1637
1918
|
* Generate a new token to be used in the iFrame
|
1919
|
+
* @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
|
1638
1920
|
* @returns {Promise<HttpResponse<TokenOkResponse>>} Successful Response
|
1639
1921
|
*/
|
1640
1922
|
token(requestConfig?: RequestConfig): Promise<HttpResponse<TokenOkResponse>>;
|
1641
1923
|
}
|
1642
1924
|
|
1925
|
+
declare class _24 extends Error {
|
1926
|
+
constructor(message?: string, response?: unknown);
|
1927
|
+
}
|
1928
|
+
|
1929
|
+
declare class _25 extends Error {
|
1930
|
+
constructor(message?: string, response?: unknown);
|
1931
|
+
}
|
1932
|
+
|
1643
1933
|
declare class Celitech {
|
1644
1934
|
config: SdkConfig;
|
1645
1935
|
readonly oAuth: OAuthService;
|
@@ -1656,6 +1946,7 @@ declare class Celitech {
|
|
1656
1946
|
set clientId(clientId: string);
|
1657
1947
|
set clientSecret(clientSecret: string);
|
1658
1948
|
set oAuthBaseUrl(oAuthBaseUrl: string);
|
1949
|
+
set accessToken(accessToken: string);
|
1659
1950
|
}
|
1660
1951
|
|
1661
|
-
export { Celitech, CreatePurchaseOkResponse, CreatePurchaseOkResponseProfile, CreatePurchaseOkResponsePurchase, CreatePurchaseRequest, Destinations, DestinationsService, Device, ESimService, EditPurchaseOkResponse, EditPurchaseRequest, Environment, GetAccessTokenOkResponse, GetAccessTokenRequest, GetEsimDeviceOkResponse, GetEsimHistoryOkResponse, GetEsimHistoryOkResponseEsim, GetEsimMacOkResponse, GetEsimMacOkResponseEsim, GetEsimOkResponse, GetEsimOkResponseEsim, GetPurchaseConsumptionOkResponse, GrantType, History, HttpError, HttpMetadata, HttpMethod, HttpResponse, IFrameService, ListDestinationsOkResponse, ListPackagesOkResponse, ListPurchasesOkResponse, OAuthService, Package_, Packages, PackagesService, Purchases, PurchasesEsim, PurchasesService, RequestConfig, RetryOptions, SdkConfig, TokenOkResponse, TopUpEsimOkResponse, TopUpEsimOkResponseProfile, TopUpEsimOkResponsePurchase, TopUpEsimRequest, ValidationOptions };
|
1952
|
+
export { Celitech, CreatePurchaseOkResponse, CreatePurchaseOkResponseProfile, CreatePurchaseOkResponsePurchase, CreatePurchaseRequest, CreatePurchaseV2OkResponse, CreatePurchaseV2OkResponseProfile, CreatePurchaseV2OkResponsePurchase, CreatePurchaseV2Request, Destinations, DestinationsService, Device, ESimService, EditPurchaseOkResponse, EditPurchaseRequest, Environment, GetAccessTokenOkResponse, GetAccessTokenRequest, GetEsimDeviceOkResponse, GetEsimHistoryOkResponse, GetEsimHistoryOkResponseEsim, GetEsimMacOkResponse, GetEsimMacOkResponseEsim, GetEsimOkResponse, GetEsimOkResponseEsim, GetPurchaseConsumptionOkResponse, GrantType, History, HttpError, HttpMetadata, HttpMethod, HttpResponse, IFrameService, ListDestinationsOkResponse, ListPackagesOkResponse, ListPurchasesOkResponse, OAuthService, Package_, Packages, PackagesService, Purchases, PurchasesEsim, PurchasesService, RequestConfig, RetryOptions, SdkConfig, TokenOkResponse, TopUpEsimOkResponse, TopUpEsimOkResponseProfile, TopUpEsimOkResponsePurchase, TopUpEsimRequest, ValidationOptions, _1, _10, _11, _12, _13, _14, _15, _16, _17, _18, _19, _2, _20, _21, _22, _23, _24, _25, _3, _4, _5, _6, _7, _8, _9, __ };
|