celitech-sdk 1.3.59 → 1.3.61
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 +3 -3
- package/dist/index.d.ts +90 -49
- package/dist/index.js +163 -71
- package/dist/index.mjs +163 -71
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Celitech TypeScript SDK 1.3.
|
|
1
|
+
# Celitech TypeScript SDK 1.3.61
|
|
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.3.
|
|
10
|
-
- SDK version: `1.3.
|
|
9
|
+
- API version: `1.3.61`
|
|
10
|
+
- SDK version: `1.3.61`
|
|
11
11
|
|
|
12
12
|
## About the API
|
|
13
13
|
|
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' | '
|
|
7
|
+
type HttpMethod$1 = 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE';
|
|
8
8
|
interface HttpRequest {
|
|
9
9
|
baseUrl: string;
|
|
10
10
|
method: HttpMethod$1;
|
|
@@ -91,7 +91,7 @@ interface CreateRequestParameters<Page = unknown[]> {
|
|
|
91
91
|
requestContentType: ContentType;
|
|
92
92
|
validation: ValidationOptions;
|
|
93
93
|
retry: RetryOptions;
|
|
94
|
-
pagination?: RequestPagination<Page>;
|
|
94
|
+
pagination?: RequestPagination<Page> | RequestCursorPagination<Page>;
|
|
95
95
|
filename?: string;
|
|
96
96
|
filenames?: string[];
|
|
97
97
|
scopes?: Set<string>;
|
|
@@ -105,12 +105,19 @@ interface RequestParameter {
|
|
|
105
105
|
style: SerializationStyle;
|
|
106
106
|
isLimit: boolean;
|
|
107
107
|
isOffset: boolean;
|
|
108
|
+
isCursor: boolean;
|
|
108
109
|
}
|
|
109
110
|
interface RequestPagination<Page> {
|
|
110
|
-
pageSize
|
|
111
|
+
pageSize?: number;
|
|
111
112
|
pagePath: string[];
|
|
112
113
|
pageSchema?: ZodType<Page, any, any>;
|
|
113
114
|
}
|
|
115
|
+
interface RequestCursorPagination<Page> {
|
|
116
|
+
pagePath: string[];
|
|
117
|
+
pageSchema?: ZodType<Page, any, any>;
|
|
118
|
+
cursorPath: string[];
|
|
119
|
+
cursorSchema?: ZodType<string | null | undefined>;
|
|
120
|
+
}
|
|
114
121
|
|
|
115
122
|
declare class Request<PageSchema = unknown[]> {
|
|
116
123
|
baseUrl: string;
|
|
@@ -127,7 +134,7 @@ declare class Request<PageSchema = unknown[]> {
|
|
|
127
134
|
requestContentType: ContentType;
|
|
128
135
|
validation: ValidationOptions;
|
|
129
136
|
retry: RetryOptions;
|
|
130
|
-
pagination?: RequestPagination<PageSchema>;
|
|
137
|
+
pagination?: RequestPagination<PageSchema> | RequestCursorPagination<PageSchema>;
|
|
131
138
|
filename?: string;
|
|
132
139
|
filenames?: string[];
|
|
133
140
|
scopes?: Set<string>;
|
|
@@ -142,13 +149,14 @@ declare class Request<PageSchema = unknown[]> {
|
|
|
142
149
|
constructFullUrl(): string;
|
|
143
150
|
copy(overrides?: Partial<CreateRequestParameters>): Request<unknown[]>;
|
|
144
151
|
getHeaders(): HeadersInit | undefined;
|
|
145
|
-
nextPage(): void;
|
|
152
|
+
nextPage(cursor?: string): void;
|
|
146
153
|
private constructPath;
|
|
147
154
|
private getOffsetParam;
|
|
155
|
+
private getCursorParam;
|
|
148
156
|
private getAllParams;
|
|
149
157
|
}
|
|
150
158
|
|
|
151
|
-
type HttpMethod = 'GET' | '
|
|
159
|
+
type HttpMethod = 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE';
|
|
152
160
|
interface BaseConfig {
|
|
153
161
|
retry?: RetryOptions;
|
|
154
162
|
validation?: ValidationOptions;
|
|
@@ -178,6 +186,11 @@ interface HttpResponse<T = unknown> {
|
|
|
178
186
|
metadata: HttpMetadata;
|
|
179
187
|
raw: ArrayBuffer;
|
|
180
188
|
}
|
|
189
|
+
interface PaginatedHttpResponse<T = unknown> extends HttpResponse<T> {
|
|
190
|
+
}
|
|
191
|
+
interface CursorPaginatedHttpResponse<T = unknown> extends HttpResponse<T> {
|
|
192
|
+
nextCursor?: string | null;
|
|
193
|
+
}
|
|
181
194
|
declare enum ContentType {
|
|
182
195
|
Json = "json",
|
|
183
196
|
Xml = "xml",
|
|
@@ -223,10 +236,12 @@ declare class HttpClient {
|
|
|
223
236
|
constructor(config: SdkConfig, hook?: CustomHook);
|
|
224
237
|
call<T>(request: Request): Promise<HttpResponse<T>>;
|
|
225
238
|
stream<T>(request: Request): AsyncGenerator<HttpResponse<T>>;
|
|
226
|
-
callPaginated<FullResponse, Page>(request: Request<Page>): Promise<
|
|
239
|
+
callPaginated<FullResponse, Page>(request: Request<Page>): Promise<PaginatedHttpResponse<Page>>;
|
|
240
|
+
callCursorPaginated<FullResponse, Page>(request: Request<Page>): Promise<CursorPaginatedHttpResponse<Page>>;
|
|
227
241
|
setBaseUrl(url: string): void;
|
|
228
242
|
setConfig(config: SdkConfig): void;
|
|
229
243
|
private getPage;
|
|
244
|
+
private getNextCursor;
|
|
230
245
|
}
|
|
231
246
|
|
|
232
247
|
declare class BaseService {
|
|
@@ -288,8 +303,8 @@ type ListDestinationsOkResponse = z.infer<typeof listDestinationsOkResponse>;
|
|
|
288
303
|
declare class DestinationsService extends BaseService {
|
|
289
304
|
/**
|
|
290
305
|
* List Destinations
|
|
291
|
-
* @param {RequestConfig} requestConfig -
|
|
292
|
-
* @returns {Promise<HttpResponse<ListDestinationsOkResponse>>} Successful Response
|
|
306
|
+
* @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
|
|
307
|
+
* @returns {Promise<HttpResponse<ListDestinationsOkResponse>>} - Successful Response
|
|
293
308
|
*/
|
|
294
309
|
listDestinations(requestConfig?: RequestConfig): Promise<HttpResponse<ListDestinationsOkResponse>>;
|
|
295
310
|
}
|
|
@@ -392,7 +407,6 @@ interface ListPackagesParams {
|
|
|
392
407
|
limit?: number;
|
|
393
408
|
startTime?: number;
|
|
394
409
|
endTime?: number;
|
|
395
|
-
duration?: number;
|
|
396
410
|
}
|
|
397
411
|
|
|
398
412
|
declare class PackagesService extends BaseService {
|
|
@@ -405,9 +419,8 @@ declare class PackagesService extends BaseService {
|
|
|
405
419
|
* @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
|
|
406
420
|
* @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
|
|
407
421
|
* @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
|
|
408
|
-
* @param {
|
|
409
|
-
* @
|
|
410
|
-
* @returns {Promise<HttpResponse<ListPackagesOkResponse>>} Successful Response
|
|
422
|
+
* @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
|
|
423
|
+
* @returns {Promise<HttpResponse<ListPackagesOkResponse>>} - Successful Response
|
|
411
424
|
*/
|
|
412
425
|
listPackages(params?: ListPackagesParams, requestConfig?: RequestConfig): Promise<HttpResponse<ListPackagesOkResponse>>;
|
|
413
426
|
}
|
|
@@ -459,8 +472,9 @@ type Packages = z.infer<typeof packages>;
|
|
|
459
472
|
declare const createPurchaseV2Request: z.ZodLazy<z.ZodObject<{
|
|
460
473
|
destination: z.ZodString;
|
|
461
474
|
dataLimitInGb: z.ZodNumber;
|
|
462
|
-
startDate: z.ZodString
|
|
463
|
-
endDate: z.ZodString
|
|
475
|
+
startDate: z.ZodOptional<z.ZodString>;
|
|
476
|
+
endDate: z.ZodOptional<z.ZodString>;
|
|
477
|
+
duration: z.ZodOptional<z.ZodNumber>;
|
|
464
478
|
quantity: z.ZodNumber;
|
|
465
479
|
email: z.ZodOptional<z.ZodString>;
|
|
466
480
|
referenceId: z.ZodOptional<z.ZodString>;
|
|
@@ -468,20 +482,22 @@ declare const createPurchaseV2Request: z.ZodLazy<z.ZodObject<{
|
|
|
468
482
|
emailBrand: z.ZodOptional<z.ZodString>;
|
|
469
483
|
}, "strip", z.ZodTypeAny, {
|
|
470
484
|
destination: string;
|
|
471
|
-
startDate: string;
|
|
472
|
-
endDate: string;
|
|
473
485
|
dataLimitInGb: number;
|
|
474
486
|
quantity: number;
|
|
487
|
+
startDate?: string | undefined;
|
|
488
|
+
endDate?: string | undefined;
|
|
489
|
+
duration?: number | undefined;
|
|
475
490
|
email?: string | undefined;
|
|
476
491
|
referenceId?: string | undefined;
|
|
477
492
|
networkBrand?: string | undefined;
|
|
478
493
|
emailBrand?: string | undefined;
|
|
479
494
|
}, {
|
|
480
495
|
destination: string;
|
|
481
|
-
startDate: string;
|
|
482
|
-
endDate: string;
|
|
483
496
|
dataLimitInGb: number;
|
|
484
497
|
quantity: number;
|
|
498
|
+
startDate?: string | undefined;
|
|
499
|
+
endDate?: string | undefined;
|
|
500
|
+
duration?: number | undefined;
|
|
485
501
|
email?: string | undefined;
|
|
486
502
|
referenceId?: string | undefined;
|
|
487
503
|
networkBrand?: string | undefined;
|
|
@@ -494,6 +510,7 @@ declare const createPurchaseV2Request: z.ZodLazy<z.ZodObject<{
|
|
|
494
510
|
* @property {number} - Size of the package in GB. The available options are 0.5, 1, 2, 3, 5, 8, 20GB
|
|
495
511
|
* @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.
|
|
496
512
|
* @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.
|
|
513
|
+
* @property {number} - Duration of the package in days. Available values are 1, 2, 7, 14, 30, or 90. Either provide startDate/endDate or duration.
|
|
497
514
|
* @property {number} - Number of eSIMs to purchase.
|
|
498
515
|
* @property {string} - Email address where the purchase confirmation email will be sent (including QR Code & activation steps)
|
|
499
516
|
* @property {string} - An identifier provided by the partner to link this purchase to their booking or transaction for analytics and debugging purposes.
|
|
@@ -571,6 +588,7 @@ declare const listPurchasesOkResponse: z.ZodLazy<z.ZodObject<{
|
|
|
571
588
|
id: z.ZodString;
|
|
572
589
|
startDate: z.ZodNullable<z.ZodString>;
|
|
573
590
|
endDate: z.ZodNullable<z.ZodString>;
|
|
591
|
+
duration: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
574
592
|
createdDate: z.ZodString;
|
|
575
593
|
startTime: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
576
594
|
endTime: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
@@ -625,6 +643,7 @@ declare const listPurchasesOkResponse: z.ZodLazy<z.ZodObject<{
|
|
|
625
643
|
};
|
|
626
644
|
source: string;
|
|
627
645
|
purchaseType: string;
|
|
646
|
+
duration?: number | null | undefined;
|
|
628
647
|
startTime?: number | null | undefined;
|
|
629
648
|
endTime?: number | null | undefined;
|
|
630
649
|
createdAt?: number | undefined;
|
|
@@ -647,6 +666,7 @@ declare const listPurchasesOkResponse: z.ZodLazy<z.ZodObject<{
|
|
|
647
666
|
};
|
|
648
667
|
source: string;
|
|
649
668
|
purchaseType: string;
|
|
669
|
+
duration?: number | null | undefined;
|
|
650
670
|
startTime?: number | null | undefined;
|
|
651
671
|
endTime?: number | null | undefined;
|
|
652
672
|
createdAt?: number | undefined;
|
|
@@ -673,6 +693,7 @@ declare const listPurchasesOkResponse: z.ZodLazy<z.ZodObject<{
|
|
|
673
693
|
};
|
|
674
694
|
source: string;
|
|
675
695
|
purchaseType: string;
|
|
696
|
+
duration?: number | null | undefined;
|
|
676
697
|
startTime?: number | null | undefined;
|
|
677
698
|
endTime?: number | null | undefined;
|
|
678
699
|
createdAt?: number | undefined;
|
|
@@ -698,6 +719,7 @@ declare const listPurchasesOkResponse: z.ZodLazy<z.ZodObject<{
|
|
|
698
719
|
};
|
|
699
720
|
source: string;
|
|
700
721
|
purchaseType: string;
|
|
722
|
+
duration?: number | null | undefined;
|
|
701
723
|
startTime?: number | null | undefined;
|
|
702
724
|
endTime?: number | null | undefined;
|
|
703
725
|
createdAt?: number | undefined;
|
|
@@ -713,6 +735,7 @@ declare const listPurchasesOkResponse: z.ZodLazy<z.ZodObject<{
|
|
|
713
735
|
type ListPurchasesOkResponse = z.infer<typeof listPurchasesOkResponse>;
|
|
714
736
|
|
|
715
737
|
interface ListPurchasesParams {
|
|
738
|
+
purchaseId?: string;
|
|
716
739
|
iccid?: string;
|
|
717
740
|
afterDate?: string;
|
|
718
741
|
beforeDate?: string;
|
|
@@ -864,28 +887,31 @@ type CreatePurchaseOkResponse = z.infer<typeof createPurchaseOkResponse>;
|
|
|
864
887
|
declare const topUpEsimRequest: z.ZodLazy<z.ZodObject<{
|
|
865
888
|
iccid: z.ZodString;
|
|
866
889
|
dataLimitInGb: z.ZodNumber;
|
|
867
|
-
startDate: z.ZodString
|
|
868
|
-
endDate: z.ZodString
|
|
890
|
+
startDate: z.ZodOptional<z.ZodString>;
|
|
891
|
+
endDate: z.ZodOptional<z.ZodString>;
|
|
892
|
+
duration: z.ZodOptional<z.ZodNumber>;
|
|
869
893
|
email: z.ZodOptional<z.ZodString>;
|
|
870
894
|
referenceId: z.ZodOptional<z.ZodString>;
|
|
871
895
|
emailBrand: z.ZodOptional<z.ZodString>;
|
|
872
896
|
startTime: z.ZodOptional<z.ZodNumber>;
|
|
873
897
|
endTime: z.ZodOptional<z.ZodNumber>;
|
|
874
898
|
}, "strip", z.ZodTypeAny, {
|
|
875
|
-
startDate: string;
|
|
876
|
-
endDate: string;
|
|
877
899
|
dataLimitInGb: number;
|
|
878
900
|
iccid: string;
|
|
901
|
+
startDate?: string | undefined;
|
|
902
|
+
endDate?: string | undefined;
|
|
903
|
+
duration?: number | undefined;
|
|
879
904
|
email?: string | undefined;
|
|
880
905
|
referenceId?: string | undefined;
|
|
881
906
|
emailBrand?: string | undefined;
|
|
882
907
|
startTime?: number | undefined;
|
|
883
908
|
endTime?: number | undefined;
|
|
884
909
|
}, {
|
|
885
|
-
startDate: string;
|
|
886
|
-
endDate: string;
|
|
887
910
|
dataLimitInGb: number;
|
|
888
911
|
iccid: string;
|
|
912
|
+
startDate?: string | undefined;
|
|
913
|
+
endDate?: string | undefined;
|
|
914
|
+
duration?: number | undefined;
|
|
889
915
|
email?: string | undefined;
|
|
890
916
|
referenceId?: string | undefined;
|
|
891
917
|
emailBrand?: string | undefined;
|
|
@@ -899,6 +925,7 @@ declare const topUpEsimRequest: z.ZodLazy<z.ZodObject<{
|
|
|
899
925
|
* @property {number} - Size of the package in GB. The available options are 0.5, 1, 2, 3, 5, 8, 20GB
|
|
900
926
|
* @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.
|
|
901
927
|
* @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.
|
|
928
|
+
* @property {number} - Duration of the package in days. Available values are 1, 2, 7, 14, 30, or 90. Either provide startDate/endDate or duration.
|
|
902
929
|
* @property {string} - Email address where the purchase confirmation email will be sent (excluding QR Code & activation steps).
|
|
903
930
|
* @property {string} - An identifier provided by the partner to link this purchase to their booking or transaction for analytics and debugging purposes.
|
|
904
931
|
* @property {string} - Customize the email subject brand. The `emailBrand` parameter cannot exceed 25 characters in length and must contain only letters, numbers, and spaces. This feature is available to platforms with Diamond tier only.
|
|
@@ -1068,12 +1095,13 @@ type GetPurchaseConsumptionOkResponse = z.infer<typeof getPurchaseConsumptionOkR
|
|
|
1068
1095
|
declare class PurchasesService extends BaseService {
|
|
1069
1096
|
/**
|
|
1070
1097
|
* This endpoint is used to purchase a new eSIM by providing the package details.
|
|
1071
|
-
* @param {RequestConfig} requestConfig -
|
|
1072
|
-
* @returns {Promise<HttpResponse<CreatePurchaseV2OkResponse[]>>} Successful Response
|
|
1098
|
+
* @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
|
|
1099
|
+
* @returns {Promise<HttpResponse<CreatePurchaseV2OkResponse[]>>} - Successful Response
|
|
1073
1100
|
*/
|
|
1074
1101
|
createPurchaseV2(body: CreatePurchaseV2Request, requestConfig?: RequestConfig): Promise<HttpResponse<CreatePurchaseV2OkResponse[]>>;
|
|
1075
1102
|
/**
|
|
1076
1103
|
* This endpoint can be used to list all the successful purchases made between a given interval.
|
|
1104
|
+
* @param {string} [params.purchaseId] - ID of the purchase
|
|
1077
1105
|
* @param {string} [params.iccid] - ID of the eSIM
|
|
1078
1106
|
* @param {string} [params.afterDate] - Start date of the interval for filtering purchases in the format 'yyyy-MM-dd'
|
|
1079
1107
|
* @param {string} [params.beforeDate] - End date of the interval for filtering purchases in the format 'yyyy-MM-dd'
|
|
@@ -1083,20 +1111,20 @@ declare class PurchasesService extends BaseService {
|
|
|
1083
1111
|
* @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
|
|
1084
1112
|
* @param {number} [params.after] - Epoch value representing the start of the time interval for filtering purchases
|
|
1085
1113
|
* @param {number} [params.before] - Epoch value representing the end of the time interval for filtering purchases
|
|
1086
|
-
* @param {RequestConfig} requestConfig -
|
|
1087
|
-
* @returns {Promise<HttpResponse<ListPurchasesOkResponse>>} Successful Response
|
|
1114
|
+
* @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
|
|
1115
|
+
* @returns {Promise<HttpResponse<ListPurchasesOkResponse>>} - Successful Response
|
|
1088
1116
|
*/
|
|
1089
1117
|
listPurchases(params?: ListPurchasesParams, requestConfig?: RequestConfig): Promise<HttpResponse<ListPurchasesOkResponse>>;
|
|
1090
1118
|
/**
|
|
1091
1119
|
* This endpoint is used to purchase a new eSIM by providing the package details.
|
|
1092
|
-
* @param {RequestConfig} requestConfig -
|
|
1093
|
-
* @returns {Promise<HttpResponse<CreatePurchaseOkResponse>>} Successful Response
|
|
1120
|
+
* @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
|
|
1121
|
+
* @returns {Promise<HttpResponse<CreatePurchaseOkResponse>>} - Successful Response
|
|
1094
1122
|
*/
|
|
1095
1123
|
createPurchase(body: CreatePurchaseRequest, requestConfig?: RequestConfig): Promise<HttpResponse<CreatePurchaseOkResponse>>;
|
|
1096
1124
|
/**
|
|
1097
|
-
* This endpoint is used to top-up an existing eSIM with the previously associated destination by providing its ICCID and package details. To determine if an eSIM can be topped up, use the Get eSIM
|
|
1098
|
-
* @param {RequestConfig} requestConfig -
|
|
1099
|
-
* @returns {Promise<HttpResponse<TopUpEsimOkResponse>>} Successful Response
|
|
1125
|
+
* This endpoint is used to top-up an existing eSIM with the previously associated destination by providing its ICCID and package details. To determine if an eSIM can be topped up, use the Get eSIM endpoint, which returns the `isTopUpAllowed` flag.
|
|
1126
|
+
* @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
|
|
1127
|
+
* @returns {Promise<HttpResponse<TopUpEsimOkResponse>>} - Successful Response
|
|
1100
1128
|
*/
|
|
1101
1129
|
topUpEsim(body: TopUpEsimRequest, requestConfig?: RequestConfig): Promise<HttpResponse<TopUpEsimOkResponse>>;
|
|
1102
1130
|
/**
|
|
@@ -1108,15 +1136,15 @@ declare class PurchasesService extends BaseService {
|
|
|
1108
1136
|
|
|
1109
1137
|
The end date can be extended or shortened as long as it adheres to the same pricing category and does not exceed the allowed duration limits.
|
|
1110
1138
|
|
|
1111
|
-
* @param {RequestConfig} requestConfig -
|
|
1112
|
-
* @returns {Promise<HttpResponse<EditPurchaseOkResponse>>} Successful Response
|
|
1139
|
+
* @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
|
|
1140
|
+
* @returns {Promise<HttpResponse<EditPurchaseOkResponse>>} - Successful Response
|
|
1113
1141
|
*/
|
|
1114
1142
|
editPurchase(body: EditPurchaseRequest, requestConfig?: RequestConfig): Promise<HttpResponse<EditPurchaseOkResponse>>;
|
|
1115
1143
|
/**
|
|
1116
1144
|
* 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.
|
|
1117
1145
|
* @param {string} purchaseId - ID of the purchase
|
|
1118
|
-
* @param {RequestConfig} requestConfig -
|
|
1119
|
-
* @returns {Promise<HttpResponse<GetPurchaseConsumptionOkResponse>>} Successful Response
|
|
1146
|
+
* @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
|
|
1147
|
+
* @returns {Promise<HttpResponse<GetPurchaseConsumptionOkResponse>>} - Successful Response
|
|
1120
1148
|
*/
|
|
1121
1149
|
getPurchaseConsumption(purchaseId: string, requestConfig?: RequestConfig): Promise<HttpResponse<GetPurchaseConsumptionOkResponse>>;
|
|
1122
1150
|
}
|
|
@@ -1178,6 +1206,7 @@ declare const purchases: z.ZodLazy<z.ZodObject<{
|
|
|
1178
1206
|
id: z.ZodString;
|
|
1179
1207
|
startDate: z.ZodNullable<z.ZodString>;
|
|
1180
1208
|
endDate: z.ZodNullable<z.ZodString>;
|
|
1209
|
+
duration: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
1181
1210
|
createdDate: z.ZodString;
|
|
1182
1211
|
startTime: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
1183
1212
|
endTime: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
@@ -1232,6 +1261,7 @@ declare const purchases: z.ZodLazy<z.ZodObject<{
|
|
|
1232
1261
|
};
|
|
1233
1262
|
source: string;
|
|
1234
1263
|
purchaseType: string;
|
|
1264
|
+
duration?: number | null | undefined;
|
|
1235
1265
|
startTime?: number | null | undefined;
|
|
1236
1266
|
endTime?: number | null | undefined;
|
|
1237
1267
|
createdAt?: number | undefined;
|
|
@@ -1254,6 +1284,7 @@ declare const purchases: z.ZodLazy<z.ZodObject<{
|
|
|
1254
1284
|
};
|
|
1255
1285
|
source: string;
|
|
1256
1286
|
purchaseType: string;
|
|
1287
|
+
duration?: number | null | undefined;
|
|
1257
1288
|
startTime?: number | null | undefined;
|
|
1258
1289
|
endTime?: number | null | undefined;
|
|
1259
1290
|
createdAt?: number | undefined;
|
|
@@ -1265,6 +1296,7 @@ declare const purchases: z.ZodLazy<z.ZodObject<{
|
|
|
1265
1296
|
* @property {string} - ID of the purchase
|
|
1266
1297
|
* @property {string} - Start date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'
|
|
1267
1298
|
* @property {string} - End date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'
|
|
1299
|
+
* @property {number} - Duration of the package in days. Possible values are 1, 2, 7, 14, 30, or 90.
|
|
1268
1300
|
* @property {string} - Creation date of the purchase in the format 'yyyy-MM-ddThh:mm:ssZZ'
|
|
1269
1301
|
* @property {number} - Epoch value representing the start time of the package's validity
|
|
1270
1302
|
* @property {number} - Epoch value representing the end time of the package's validity
|
|
@@ -1465,6 +1497,7 @@ declare const getEsimOkResponse: z.ZodLazy<z.ZodObject<{
|
|
|
1465
1497
|
activationCode: z.ZodString;
|
|
1466
1498
|
manualActivationCode: z.ZodString;
|
|
1467
1499
|
status: z.ZodString;
|
|
1500
|
+
connectivityStatus: z.ZodString;
|
|
1468
1501
|
isTopUpAllowed: z.ZodBoolean;
|
|
1469
1502
|
}, "strip", z.ZodTypeAny, {
|
|
1470
1503
|
status: string;
|
|
@@ -1472,6 +1505,7 @@ declare const getEsimOkResponse: z.ZodLazy<z.ZodObject<{
|
|
|
1472
1505
|
activationCode: string;
|
|
1473
1506
|
manualActivationCode: string;
|
|
1474
1507
|
smdpAddress: string;
|
|
1508
|
+
connectivityStatus: string;
|
|
1475
1509
|
isTopUpAllowed: boolean;
|
|
1476
1510
|
}, {
|
|
1477
1511
|
status: string;
|
|
@@ -1479,6 +1513,7 @@ declare const getEsimOkResponse: z.ZodLazy<z.ZodObject<{
|
|
|
1479
1513
|
activationCode: string;
|
|
1480
1514
|
manualActivationCode: string;
|
|
1481
1515
|
smdpAddress: string;
|
|
1516
|
+
connectivityStatus: string;
|
|
1482
1517
|
isTopUpAllowed: boolean;
|
|
1483
1518
|
}>>;
|
|
1484
1519
|
}, "strip", z.ZodTypeAny, {
|
|
@@ -1488,6 +1523,7 @@ declare const getEsimOkResponse: z.ZodLazy<z.ZodObject<{
|
|
|
1488
1523
|
activationCode: string;
|
|
1489
1524
|
manualActivationCode: string;
|
|
1490
1525
|
smdpAddress: string;
|
|
1526
|
+
connectivityStatus: string;
|
|
1491
1527
|
isTopUpAllowed: boolean;
|
|
1492
1528
|
};
|
|
1493
1529
|
}, {
|
|
@@ -1497,6 +1533,7 @@ declare const getEsimOkResponse: z.ZodLazy<z.ZodObject<{
|
|
|
1497
1533
|
activationCode: string;
|
|
1498
1534
|
manualActivationCode: string;
|
|
1499
1535
|
smdpAddress: string;
|
|
1536
|
+
connectivityStatus: string;
|
|
1500
1537
|
isTopUpAllowed: boolean;
|
|
1501
1538
|
};
|
|
1502
1539
|
}>>;
|
|
@@ -1616,23 +1653,23 @@ type GetEsimHistoryOkResponse = z.infer<typeof getEsimHistoryOkResponse>;
|
|
|
1616
1653
|
declare class ESimService extends BaseService {
|
|
1617
1654
|
/**
|
|
1618
1655
|
* Get eSIM
|
|
1619
|
-
* @param {string} iccid - ID of the eSIM
|
|
1620
|
-
* @param {RequestConfig} requestConfig -
|
|
1621
|
-
* @returns {Promise<HttpResponse<GetEsimOkResponse>>} Successful Response
|
|
1656
|
+
* @param {string} params.iccid - ID of the eSIM
|
|
1657
|
+
* @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
|
|
1658
|
+
* @returns {Promise<HttpResponse<GetEsimOkResponse>>} - Successful Response
|
|
1622
1659
|
*/
|
|
1623
1660
|
getEsim(params: GetEsimParams, requestConfig?: RequestConfig): Promise<HttpResponse<GetEsimOkResponse>>;
|
|
1624
1661
|
/**
|
|
1625
1662
|
* Get eSIM Device
|
|
1626
1663
|
* @param {string} iccid - ID of the eSIM
|
|
1627
|
-
* @param {RequestConfig} requestConfig -
|
|
1628
|
-
* @returns {Promise<HttpResponse<GetEsimDeviceOkResponse>>} Successful Response
|
|
1664
|
+
* @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
|
|
1665
|
+
* @returns {Promise<HttpResponse<GetEsimDeviceOkResponse>>} - Successful Response
|
|
1629
1666
|
*/
|
|
1630
1667
|
getEsimDevice(iccid: string, requestConfig?: RequestConfig): Promise<HttpResponse<GetEsimDeviceOkResponse>>;
|
|
1631
1668
|
/**
|
|
1632
1669
|
* Get eSIM History
|
|
1633
1670
|
* @param {string} iccid - ID of the eSIM
|
|
1634
|
-
* @param {RequestConfig} requestConfig -
|
|
1635
|
-
* @returns {Promise<HttpResponse<GetEsimHistoryOkResponse>>} Successful Response
|
|
1671
|
+
* @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
|
|
1672
|
+
* @returns {Promise<HttpResponse<GetEsimHistoryOkResponse>>} - Successful Response
|
|
1636
1673
|
*/
|
|
1637
1674
|
getEsimHistory(iccid: string, requestConfig?: RequestConfig): Promise<HttpResponse<GetEsimHistoryOkResponse>>;
|
|
1638
1675
|
}
|
|
@@ -1646,6 +1683,7 @@ declare const getEsimOkResponseEsim: z.ZodLazy<z.ZodObject<{
|
|
|
1646
1683
|
activationCode: z.ZodString;
|
|
1647
1684
|
manualActivationCode: z.ZodString;
|
|
1648
1685
|
status: z.ZodString;
|
|
1686
|
+
connectivityStatus: z.ZodString;
|
|
1649
1687
|
isTopUpAllowed: z.ZodBoolean;
|
|
1650
1688
|
}, "strip", z.ZodTypeAny, {
|
|
1651
1689
|
status: string;
|
|
@@ -1653,6 +1691,7 @@ declare const getEsimOkResponseEsim: z.ZodLazy<z.ZodObject<{
|
|
|
1653
1691
|
activationCode: string;
|
|
1654
1692
|
manualActivationCode: string;
|
|
1655
1693
|
smdpAddress: string;
|
|
1694
|
+
connectivityStatus: string;
|
|
1656
1695
|
isTopUpAllowed: boolean;
|
|
1657
1696
|
}, {
|
|
1658
1697
|
status: string;
|
|
@@ -1660,6 +1699,7 @@ declare const getEsimOkResponseEsim: z.ZodLazy<z.ZodObject<{
|
|
|
1660
1699
|
activationCode: string;
|
|
1661
1700
|
manualActivationCode: string;
|
|
1662
1701
|
smdpAddress: string;
|
|
1702
|
+
connectivityStatus: string;
|
|
1663
1703
|
isTopUpAllowed: boolean;
|
|
1664
1704
|
}>>;
|
|
1665
1705
|
/**
|
|
@@ -1670,6 +1710,7 @@ declare const getEsimOkResponseEsim: z.ZodLazy<z.ZodObject<{
|
|
|
1670
1710
|
* @property {string} - QR Code of the eSIM as base64
|
|
1671
1711
|
* @property {string} - The manual activation code
|
|
1672
1712
|
* @property {string} - Status of the eSIM, possible values are 'RELEASED', 'DOWNLOADED', 'INSTALLED', 'ENABLED', 'DELETED', or 'ERROR'
|
|
1713
|
+
* @property {string} - Status of the eSIM connectivity, possible values are 'ACTIVE' or 'NOT_ACTIVE'
|
|
1673
1714
|
* @property {boolean} - Indicates whether the eSIM is currently eligible for a top-up. This flag should be checked before attempting a top-up request.
|
|
1674
1715
|
*/
|
|
1675
1716
|
type GetEsimOkResponseEsim = z.infer<typeof getEsimOkResponseEsim>;
|
|
@@ -1789,8 +1830,8 @@ type TokenOkResponse = z.infer<typeof tokenOkResponse>;
|
|
|
1789
1830
|
declare class IFrameService extends BaseService {
|
|
1790
1831
|
/**
|
|
1791
1832
|
* Generate a new token to be used in the iFrame
|
|
1792
|
-
* @param {RequestConfig} requestConfig -
|
|
1793
|
-
* @returns {Promise<HttpResponse<TokenOkResponse>>} Successful Response
|
|
1833
|
+
* @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
|
|
1834
|
+
* @returns {Promise<HttpResponse<TokenOkResponse>>} - Successful Response
|
|
1794
1835
|
*/
|
|
1795
1836
|
token(requestConfig?: RequestConfig): Promise<HttpResponse<TokenOkResponse>>;
|
|
1796
1837
|
}
|
|
@@ -1848,8 +1889,8 @@ type GetAccessTokenOkResponse = z.infer<typeof getAccessTokenOkResponse>;
|
|
|
1848
1889
|
declare class OAuthService extends BaseService {
|
|
1849
1890
|
/**
|
|
1850
1891
|
* This endpoint was added by liblab
|
|
1851
|
-
* @param {RequestConfig} requestConfig -
|
|
1852
|
-
* @returns {Promise<HttpResponse<GetAccessTokenOkResponse>>} Successful Response
|
|
1892
|
+
* @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
|
|
1893
|
+
* @returns {Promise<HttpResponse<GetAccessTokenOkResponse>>} - Successful Response
|
|
1853
1894
|
*/
|
|
1854
1895
|
getAccessToken(body: GetAccessTokenRequest, requestConfig?: RequestConfig): Promise<HttpResponse<GetAccessTokenOkResponse>>;
|
|
1855
1896
|
}
|