celitech-sdk 1.3.60 → 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 -51
- package/dist/index.js +163 -75
- package/dist/index.mjs +163 -75
- 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;
|
|
@@ -722,7 +745,6 @@ interface ListPurchasesParams {
|
|
|
722
745
|
limit?: number;
|
|
723
746
|
after?: number;
|
|
724
747
|
before?: number;
|
|
725
|
-
purchaseId?: string;
|
|
726
748
|
}
|
|
727
749
|
|
|
728
750
|
/**
|
|
@@ -865,28 +887,31 @@ type CreatePurchaseOkResponse = z.infer<typeof createPurchaseOkResponse>;
|
|
|
865
887
|
declare const topUpEsimRequest: z.ZodLazy<z.ZodObject<{
|
|
866
888
|
iccid: z.ZodString;
|
|
867
889
|
dataLimitInGb: z.ZodNumber;
|
|
868
|
-
startDate: z.ZodString
|
|
869
|
-
endDate: z.ZodString
|
|
890
|
+
startDate: z.ZodOptional<z.ZodString>;
|
|
891
|
+
endDate: z.ZodOptional<z.ZodString>;
|
|
892
|
+
duration: z.ZodOptional<z.ZodNumber>;
|
|
870
893
|
email: z.ZodOptional<z.ZodString>;
|
|
871
894
|
referenceId: z.ZodOptional<z.ZodString>;
|
|
872
895
|
emailBrand: z.ZodOptional<z.ZodString>;
|
|
873
896
|
startTime: z.ZodOptional<z.ZodNumber>;
|
|
874
897
|
endTime: z.ZodOptional<z.ZodNumber>;
|
|
875
898
|
}, "strip", z.ZodTypeAny, {
|
|
876
|
-
startDate: string;
|
|
877
|
-
endDate: string;
|
|
878
899
|
dataLimitInGb: number;
|
|
879
900
|
iccid: string;
|
|
901
|
+
startDate?: string | undefined;
|
|
902
|
+
endDate?: string | undefined;
|
|
903
|
+
duration?: number | undefined;
|
|
880
904
|
email?: string | undefined;
|
|
881
905
|
referenceId?: string | undefined;
|
|
882
906
|
emailBrand?: string | undefined;
|
|
883
907
|
startTime?: number | undefined;
|
|
884
908
|
endTime?: number | undefined;
|
|
885
909
|
}, {
|
|
886
|
-
startDate: string;
|
|
887
|
-
endDate: string;
|
|
888
910
|
dataLimitInGb: number;
|
|
889
911
|
iccid: string;
|
|
912
|
+
startDate?: string | undefined;
|
|
913
|
+
endDate?: string | undefined;
|
|
914
|
+
duration?: number | undefined;
|
|
890
915
|
email?: string | undefined;
|
|
891
916
|
referenceId?: string | undefined;
|
|
892
917
|
emailBrand?: string | undefined;
|
|
@@ -900,6 +925,7 @@ declare const topUpEsimRequest: z.ZodLazy<z.ZodObject<{
|
|
|
900
925
|
* @property {number} - Size of the package in GB. The available options are 0.5, 1, 2, 3, 5, 8, 20GB
|
|
901
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.
|
|
902
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.
|
|
903
929
|
* @property {string} - Email address where the purchase confirmation email will be sent (excluding QR Code & activation steps).
|
|
904
930
|
* @property {string} - An identifier provided by the partner to link this purchase to their booking or transaction for analytics and debugging purposes.
|
|
905
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.
|
|
@@ -1069,12 +1095,13 @@ type GetPurchaseConsumptionOkResponse = z.infer<typeof getPurchaseConsumptionOkR
|
|
|
1069
1095
|
declare class PurchasesService extends BaseService {
|
|
1070
1096
|
/**
|
|
1071
1097
|
* This endpoint is used to purchase a new eSIM by providing the package details.
|
|
1072
|
-
* @param {RequestConfig} requestConfig -
|
|
1073
|
-
* @returns {Promise<HttpResponse<CreatePurchaseV2OkResponse[]>>} Successful Response
|
|
1098
|
+
* @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
|
|
1099
|
+
* @returns {Promise<HttpResponse<CreatePurchaseV2OkResponse[]>>} - Successful Response
|
|
1074
1100
|
*/
|
|
1075
1101
|
createPurchaseV2(body: CreatePurchaseV2Request, requestConfig?: RequestConfig): Promise<HttpResponse<CreatePurchaseV2OkResponse[]>>;
|
|
1076
1102
|
/**
|
|
1077
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
|
|
1078
1105
|
* @param {string} [params.iccid] - ID of the eSIM
|
|
1079
1106
|
* @param {string} [params.afterDate] - Start date of the interval for filtering purchases in the format 'yyyy-MM-dd'
|
|
1080
1107
|
* @param {string} [params.beforeDate] - End date of the interval for filtering purchases in the format 'yyyy-MM-dd'
|
|
@@ -1084,21 +1111,20 @@ declare class PurchasesService extends BaseService {
|
|
|
1084
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
|
|
1085
1112
|
* @param {number} [params.after] - Epoch value representing the start of the time interval for filtering purchases
|
|
1086
1113
|
* @param {number} [params.before] - Epoch value representing the end of the time interval for filtering purchases
|
|
1087
|
-
* @param {
|
|
1088
|
-
* @
|
|
1089
|
-
* @returns {Promise<HttpResponse<ListPurchasesOkResponse>>} Successful Response
|
|
1114
|
+
* @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
|
|
1115
|
+
* @returns {Promise<HttpResponse<ListPurchasesOkResponse>>} - Successful Response
|
|
1090
1116
|
*/
|
|
1091
1117
|
listPurchases(params?: ListPurchasesParams, requestConfig?: RequestConfig): Promise<HttpResponse<ListPurchasesOkResponse>>;
|
|
1092
1118
|
/**
|
|
1093
1119
|
* This endpoint is used to purchase a new eSIM by providing the package details.
|
|
1094
|
-
* @param {RequestConfig} requestConfig -
|
|
1095
|
-
* @returns {Promise<HttpResponse<CreatePurchaseOkResponse>>} Successful Response
|
|
1120
|
+
* @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
|
|
1121
|
+
* @returns {Promise<HttpResponse<CreatePurchaseOkResponse>>} - Successful Response
|
|
1096
1122
|
*/
|
|
1097
1123
|
createPurchase(body: CreatePurchaseRequest, requestConfig?: RequestConfig): Promise<HttpResponse<CreatePurchaseOkResponse>>;
|
|
1098
1124
|
/**
|
|
1099
|
-
* 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
|
|
1100
|
-
* @param {RequestConfig} requestConfig -
|
|
1101
|
-
* @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
|
|
1102
1128
|
*/
|
|
1103
1129
|
topUpEsim(body: TopUpEsimRequest, requestConfig?: RequestConfig): Promise<HttpResponse<TopUpEsimOkResponse>>;
|
|
1104
1130
|
/**
|
|
@@ -1110,15 +1136,15 @@ declare class PurchasesService extends BaseService {
|
|
|
1110
1136
|
|
|
1111
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.
|
|
1112
1138
|
|
|
1113
|
-
* @param {RequestConfig} requestConfig -
|
|
1114
|
-
* @returns {Promise<HttpResponse<EditPurchaseOkResponse>>} Successful Response
|
|
1139
|
+
* @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
|
|
1140
|
+
* @returns {Promise<HttpResponse<EditPurchaseOkResponse>>} - Successful Response
|
|
1115
1141
|
*/
|
|
1116
1142
|
editPurchase(body: EditPurchaseRequest, requestConfig?: RequestConfig): Promise<HttpResponse<EditPurchaseOkResponse>>;
|
|
1117
1143
|
/**
|
|
1118
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.
|
|
1119
1145
|
* @param {string} purchaseId - ID of the purchase
|
|
1120
|
-
* @param {RequestConfig} requestConfig -
|
|
1121
|
-
* @returns {Promise<HttpResponse<GetPurchaseConsumptionOkResponse>>} Successful Response
|
|
1146
|
+
* @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
|
|
1147
|
+
* @returns {Promise<HttpResponse<GetPurchaseConsumptionOkResponse>>} - Successful Response
|
|
1122
1148
|
*/
|
|
1123
1149
|
getPurchaseConsumption(purchaseId: string, requestConfig?: RequestConfig): Promise<HttpResponse<GetPurchaseConsumptionOkResponse>>;
|
|
1124
1150
|
}
|
|
@@ -1180,6 +1206,7 @@ declare const purchases: z.ZodLazy<z.ZodObject<{
|
|
|
1180
1206
|
id: z.ZodString;
|
|
1181
1207
|
startDate: z.ZodNullable<z.ZodString>;
|
|
1182
1208
|
endDate: z.ZodNullable<z.ZodString>;
|
|
1209
|
+
duration: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
1183
1210
|
createdDate: z.ZodString;
|
|
1184
1211
|
startTime: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
1185
1212
|
endTime: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
@@ -1234,6 +1261,7 @@ declare const purchases: z.ZodLazy<z.ZodObject<{
|
|
|
1234
1261
|
};
|
|
1235
1262
|
source: string;
|
|
1236
1263
|
purchaseType: string;
|
|
1264
|
+
duration?: number | null | undefined;
|
|
1237
1265
|
startTime?: number | null | undefined;
|
|
1238
1266
|
endTime?: number | null | undefined;
|
|
1239
1267
|
createdAt?: number | undefined;
|
|
@@ -1256,6 +1284,7 @@ declare const purchases: z.ZodLazy<z.ZodObject<{
|
|
|
1256
1284
|
};
|
|
1257
1285
|
source: string;
|
|
1258
1286
|
purchaseType: string;
|
|
1287
|
+
duration?: number | null | undefined;
|
|
1259
1288
|
startTime?: number | null | undefined;
|
|
1260
1289
|
endTime?: number | null | undefined;
|
|
1261
1290
|
createdAt?: number | undefined;
|
|
@@ -1267,6 +1296,7 @@ declare const purchases: z.ZodLazy<z.ZodObject<{
|
|
|
1267
1296
|
* @property {string} - ID of the purchase
|
|
1268
1297
|
* @property {string} - Start date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'
|
|
1269
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.
|
|
1270
1300
|
* @property {string} - Creation date of the purchase in the format 'yyyy-MM-ddThh:mm:ssZZ'
|
|
1271
1301
|
* @property {number} - Epoch value representing the start time of the package's validity
|
|
1272
1302
|
* @property {number} - Epoch value representing the end time of the package's validity
|
|
@@ -1467,6 +1497,7 @@ declare const getEsimOkResponse: z.ZodLazy<z.ZodObject<{
|
|
|
1467
1497
|
activationCode: z.ZodString;
|
|
1468
1498
|
manualActivationCode: z.ZodString;
|
|
1469
1499
|
status: z.ZodString;
|
|
1500
|
+
connectivityStatus: z.ZodString;
|
|
1470
1501
|
isTopUpAllowed: z.ZodBoolean;
|
|
1471
1502
|
}, "strip", z.ZodTypeAny, {
|
|
1472
1503
|
status: string;
|
|
@@ -1474,6 +1505,7 @@ declare const getEsimOkResponse: z.ZodLazy<z.ZodObject<{
|
|
|
1474
1505
|
activationCode: string;
|
|
1475
1506
|
manualActivationCode: string;
|
|
1476
1507
|
smdpAddress: string;
|
|
1508
|
+
connectivityStatus: string;
|
|
1477
1509
|
isTopUpAllowed: boolean;
|
|
1478
1510
|
}, {
|
|
1479
1511
|
status: string;
|
|
@@ -1481,6 +1513,7 @@ declare const getEsimOkResponse: z.ZodLazy<z.ZodObject<{
|
|
|
1481
1513
|
activationCode: string;
|
|
1482
1514
|
manualActivationCode: string;
|
|
1483
1515
|
smdpAddress: string;
|
|
1516
|
+
connectivityStatus: string;
|
|
1484
1517
|
isTopUpAllowed: boolean;
|
|
1485
1518
|
}>>;
|
|
1486
1519
|
}, "strip", z.ZodTypeAny, {
|
|
@@ -1490,6 +1523,7 @@ declare const getEsimOkResponse: z.ZodLazy<z.ZodObject<{
|
|
|
1490
1523
|
activationCode: string;
|
|
1491
1524
|
manualActivationCode: string;
|
|
1492
1525
|
smdpAddress: string;
|
|
1526
|
+
connectivityStatus: string;
|
|
1493
1527
|
isTopUpAllowed: boolean;
|
|
1494
1528
|
};
|
|
1495
1529
|
}, {
|
|
@@ -1499,6 +1533,7 @@ declare const getEsimOkResponse: z.ZodLazy<z.ZodObject<{
|
|
|
1499
1533
|
activationCode: string;
|
|
1500
1534
|
manualActivationCode: string;
|
|
1501
1535
|
smdpAddress: string;
|
|
1536
|
+
connectivityStatus: string;
|
|
1502
1537
|
isTopUpAllowed: boolean;
|
|
1503
1538
|
};
|
|
1504
1539
|
}>>;
|
|
@@ -1618,23 +1653,23 @@ type GetEsimHistoryOkResponse = z.infer<typeof getEsimHistoryOkResponse>;
|
|
|
1618
1653
|
declare class ESimService extends BaseService {
|
|
1619
1654
|
/**
|
|
1620
1655
|
* Get eSIM
|
|
1621
|
-
* @param {string} iccid - ID of the eSIM
|
|
1622
|
-
* @param {RequestConfig} requestConfig -
|
|
1623
|
-
* @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
|
|
1624
1659
|
*/
|
|
1625
1660
|
getEsim(params: GetEsimParams, requestConfig?: RequestConfig): Promise<HttpResponse<GetEsimOkResponse>>;
|
|
1626
1661
|
/**
|
|
1627
1662
|
* Get eSIM Device
|
|
1628
1663
|
* @param {string} iccid - ID of the eSIM
|
|
1629
|
-
* @param {RequestConfig} requestConfig -
|
|
1630
|
-
* @returns {Promise<HttpResponse<GetEsimDeviceOkResponse>>} Successful Response
|
|
1664
|
+
* @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
|
|
1665
|
+
* @returns {Promise<HttpResponse<GetEsimDeviceOkResponse>>} - Successful Response
|
|
1631
1666
|
*/
|
|
1632
1667
|
getEsimDevice(iccid: string, requestConfig?: RequestConfig): Promise<HttpResponse<GetEsimDeviceOkResponse>>;
|
|
1633
1668
|
/**
|
|
1634
1669
|
* Get eSIM History
|
|
1635
1670
|
* @param {string} iccid - ID of the eSIM
|
|
1636
|
-
* @param {RequestConfig} requestConfig -
|
|
1637
|
-
* @returns {Promise<HttpResponse<GetEsimHistoryOkResponse>>} Successful Response
|
|
1671
|
+
* @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
|
|
1672
|
+
* @returns {Promise<HttpResponse<GetEsimHistoryOkResponse>>} - Successful Response
|
|
1638
1673
|
*/
|
|
1639
1674
|
getEsimHistory(iccid: string, requestConfig?: RequestConfig): Promise<HttpResponse<GetEsimHistoryOkResponse>>;
|
|
1640
1675
|
}
|
|
@@ -1648,6 +1683,7 @@ declare const getEsimOkResponseEsim: z.ZodLazy<z.ZodObject<{
|
|
|
1648
1683
|
activationCode: z.ZodString;
|
|
1649
1684
|
manualActivationCode: z.ZodString;
|
|
1650
1685
|
status: z.ZodString;
|
|
1686
|
+
connectivityStatus: z.ZodString;
|
|
1651
1687
|
isTopUpAllowed: z.ZodBoolean;
|
|
1652
1688
|
}, "strip", z.ZodTypeAny, {
|
|
1653
1689
|
status: string;
|
|
@@ -1655,6 +1691,7 @@ declare const getEsimOkResponseEsim: z.ZodLazy<z.ZodObject<{
|
|
|
1655
1691
|
activationCode: string;
|
|
1656
1692
|
manualActivationCode: string;
|
|
1657
1693
|
smdpAddress: string;
|
|
1694
|
+
connectivityStatus: string;
|
|
1658
1695
|
isTopUpAllowed: boolean;
|
|
1659
1696
|
}, {
|
|
1660
1697
|
status: string;
|
|
@@ -1662,6 +1699,7 @@ declare const getEsimOkResponseEsim: z.ZodLazy<z.ZodObject<{
|
|
|
1662
1699
|
activationCode: string;
|
|
1663
1700
|
manualActivationCode: string;
|
|
1664
1701
|
smdpAddress: string;
|
|
1702
|
+
connectivityStatus: string;
|
|
1665
1703
|
isTopUpAllowed: boolean;
|
|
1666
1704
|
}>>;
|
|
1667
1705
|
/**
|
|
@@ -1672,6 +1710,7 @@ declare const getEsimOkResponseEsim: z.ZodLazy<z.ZodObject<{
|
|
|
1672
1710
|
* @property {string} - QR Code of the eSIM as base64
|
|
1673
1711
|
* @property {string} - The manual activation code
|
|
1674
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'
|
|
1675
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.
|
|
1676
1715
|
*/
|
|
1677
1716
|
type GetEsimOkResponseEsim = z.infer<typeof getEsimOkResponseEsim>;
|
|
@@ -1791,8 +1830,8 @@ type TokenOkResponse = z.infer<typeof tokenOkResponse>;
|
|
|
1791
1830
|
declare class IFrameService extends BaseService {
|
|
1792
1831
|
/**
|
|
1793
1832
|
* Generate a new token to be used in the iFrame
|
|
1794
|
-
* @param {RequestConfig} requestConfig -
|
|
1795
|
-
* @returns {Promise<HttpResponse<TokenOkResponse>>} Successful Response
|
|
1833
|
+
* @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
|
|
1834
|
+
* @returns {Promise<HttpResponse<TokenOkResponse>>} - Successful Response
|
|
1796
1835
|
*/
|
|
1797
1836
|
token(requestConfig?: RequestConfig): Promise<HttpResponse<TokenOkResponse>>;
|
|
1798
1837
|
}
|
|
@@ -1850,8 +1889,8 @@ type GetAccessTokenOkResponse = z.infer<typeof getAccessTokenOkResponse>;
|
|
|
1850
1889
|
declare class OAuthService extends BaseService {
|
|
1851
1890
|
/**
|
|
1852
1891
|
* This endpoint was added by liblab
|
|
1853
|
-
* @param {RequestConfig} requestConfig -
|
|
1854
|
-
* @returns {Promise<HttpResponse<GetAccessTokenOkResponse>>} Successful Response
|
|
1892
|
+
* @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
|
|
1893
|
+
* @returns {Promise<HttpResponse<GetAccessTokenOkResponse>>} - Successful Response
|
|
1855
1894
|
*/
|
|
1856
1895
|
getAccessToken(body: GetAccessTokenRequest, requestConfig?: RequestConfig): Promise<HttpResponse<GetAccessTokenOkResponse>>;
|
|
1857
1896
|
}
|