celitech-sdk 1.3.43 → 1.3.46
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 +7 -10
- package/dist/index.d.ts +143 -169
- package/dist/index.js +72 -75
- package/dist/index.mjs +72 -75
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
# Celitech TypeScript SDK 1.3.
|
|
1
|
+
# Celitech TypeScript SDK 1.3.46
|
|
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
|
|
|
5
|
-
[](https://liblab.com/?utm_source=readme)
|
|
6
6
|
|
|
7
7
|
## Versions
|
|
8
8
|
|
|
9
|
-
- API version: `1.3.
|
|
10
|
-
- SDK version: `1.3.
|
|
9
|
+
- API version: `1.3.46`
|
|
10
|
+
- SDK version: `1.3.46`
|
|
11
11
|
|
|
12
12
|
## About the API
|
|
13
13
|
|
|
@@ -92,10 +92,7 @@ Below is a comprehensive example demonstrating how to authenticate and call a si
|
|
|
92
92
|
import { Celitech } from 'celitech-sdk';
|
|
93
93
|
|
|
94
94
|
(async () => {
|
|
95
|
-
const celitech = new Celitech({
|
|
96
|
-
clientId: 'CLIENT_ID',
|
|
97
|
-
clientSecret: 'CLIENT_SECRET',
|
|
98
|
-
});
|
|
95
|
+
const celitech = new Celitech({});
|
|
99
96
|
|
|
100
97
|
const { data } = await celitech.destinations.listDestinations();
|
|
101
98
|
|
|
@@ -107,7 +104,7 @@ import { Celitech } from 'celitech-sdk';
|
|
|
107
104
|
|
|
108
105
|
The SDK provides various services to interact with the API.
|
|
109
106
|
|
|
110
|
-
<details>
|
|
107
|
+
<details>
|
|
111
108
|
<summary>Below is a list of all available services with links to their detailed documentation:</summary>
|
|
112
109
|
|
|
113
110
|
| Name |
|
|
@@ -125,7 +122,7 @@ The SDK provides various services to interact with the API.
|
|
|
125
122
|
|
|
126
123
|
The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.
|
|
127
124
|
|
|
128
|
-
<details>
|
|
125
|
+
<details>
|
|
129
126
|
<summary>Below is a list of all available models with links to their detailed documentation:</summary>
|
|
130
127
|
|
|
131
128
|
| Name | Description |
|
package/dist/index.d.ts
CHANGED
|
@@ -159,8 +159,8 @@ interface ClientCredentialAuthConfig extends BaseConfig {
|
|
|
159
159
|
accessToken?: never;
|
|
160
160
|
}
|
|
161
161
|
interface TokenAuthConfig extends BaseConfig {
|
|
162
|
-
clientId?: never;
|
|
163
162
|
clientSecret?: never;
|
|
163
|
+
clientId?: never;
|
|
164
164
|
accessToken: string;
|
|
165
165
|
}
|
|
166
166
|
type SdkConfig = ClientCredentialAuthConfig | TokenAuthConfig;
|
|
@@ -447,8 +447,6 @@ interface ListPackagesParams {
|
|
|
447
447
|
destination?: string;
|
|
448
448
|
startDate?: string;
|
|
449
449
|
endDate?: string;
|
|
450
|
-
dataLimitInGb?: number;
|
|
451
|
-
includeUnlimited?: boolean;
|
|
452
450
|
afterCursor?: string;
|
|
453
451
|
limit?: number;
|
|
454
452
|
startTime?: number;
|
|
@@ -458,25 +456,18 @@ interface ListPackagesParams {
|
|
|
458
456
|
|
|
459
457
|
declare class PackagesService extends BaseService {
|
|
460
458
|
/**
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
* @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
|
|
474
|
-
* @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
|
|
475
|
-
* @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
|
|
476
|
-
* @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
|
|
477
|
-
* @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
|
|
478
|
-
* @returns {Promise<HttpResponse<ListPackagesOkResponse>>} Successful Response
|
|
479
|
-
*/
|
|
459
|
+
* List Packages
|
|
460
|
+
* @param {string} [params.destination] - ISO representation of the package's destination.
|
|
461
|
+
* @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.
|
|
462
|
+
* @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.
|
|
463
|
+
* @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.
|
|
464
|
+
* @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
|
|
465
|
+
* @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
|
|
466
|
+
* @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
|
|
467
|
+
* @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
|
|
468
|
+
* @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
|
|
469
|
+
* @returns {Promise<HttpResponse<ListPackagesOkResponse>>} Successful Response
|
|
470
|
+
*/
|
|
480
471
|
listPackages(params?: ListPackagesParams, requestConfig?: RequestConfig): Promise<HttpResponse<ListPackagesOkResponse>>;
|
|
481
472
|
}
|
|
482
473
|
|
|
@@ -510,8 +501,7 @@ declare const packages: z.ZodLazy<z.ZodObject<{
|
|
|
510
501
|
* @typedef {Packages} packages
|
|
511
502
|
* @property {string} - ID of the package
|
|
512
503
|
* @property {string} - ISO representation of the package's destination.
|
|
513
|
-
* @property {number} - Size of the package in
|
|
514
|
-
|
|
504
|
+
* @property {number} - Size of the package in Bytes
|
|
515
505
|
* @property {number} - Min number of days for the package
|
|
516
506
|
* @property {number} - Max number of days for the package
|
|
517
507
|
* @property {number} - Price of the package in cents
|
|
@@ -538,6 +528,8 @@ declare class _3 extends ThrowableError {
|
|
|
538
528
|
declare const createPurchaseV2Request: z.ZodLazy<z.ZodObject<{
|
|
539
529
|
destination: z.ZodString;
|
|
540
530
|
dataLimitInGb: z.ZodNumber;
|
|
531
|
+
startDate: z.ZodString;
|
|
532
|
+
endDate: z.ZodString;
|
|
541
533
|
quantity: z.ZodNumber;
|
|
542
534
|
email: z.ZodOptional<z.ZodString>;
|
|
543
535
|
referenceId: z.ZodOptional<z.ZodString>;
|
|
@@ -545,6 +537,8 @@ declare const createPurchaseV2Request: z.ZodLazy<z.ZodObject<{
|
|
|
545
537
|
emailBrand: z.ZodOptional<z.ZodString>;
|
|
546
538
|
}, "strip", z.ZodTypeAny, {
|
|
547
539
|
destination: string;
|
|
540
|
+
startDate: string;
|
|
541
|
+
endDate: string;
|
|
548
542
|
dataLimitInGb: number;
|
|
549
543
|
quantity: number;
|
|
550
544
|
email?: string | undefined;
|
|
@@ -553,6 +547,8 @@ declare const createPurchaseV2Request: z.ZodLazy<z.ZodObject<{
|
|
|
553
547
|
emailBrand?: string | undefined;
|
|
554
548
|
}, {
|
|
555
549
|
destination: string;
|
|
550
|
+
startDate: string;
|
|
551
|
+
endDate: string;
|
|
556
552
|
dataLimitInGb: number;
|
|
557
553
|
quantity: number;
|
|
558
554
|
email?: string | undefined;
|
|
@@ -564,12 +560,9 @@ declare const createPurchaseV2Request: z.ZodLazy<z.ZodObject<{
|
|
|
564
560
|
*
|
|
565
561
|
* @typedef {CreatePurchaseV2Request} createPurchaseV2Request
|
|
566
562
|
* @property {string} - ISO representation of the package's destination.
|
|
567
|
-
* @property {number} - Size of the package in GB.
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
For ``unlimited packages`` (available to Region-3), please use ``-1`` as an identifier (supports `duration` only).
|
|
572
|
-
|
|
563
|
+
* @property {number} - Size of the package in GB. The available options are 0.5, 1, 2, 3, 5, 8, 20GB
|
|
564
|
+
* @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.
|
|
565
|
+
* @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.
|
|
573
566
|
* @property {number} - Number of eSIMs to purchase.
|
|
574
567
|
* @property {string} - Email address where the purchase confirmation email will be sent (including QR Code & activation steps)
|
|
575
568
|
* @property {string} - An identifier provided by the partner to link this purchase to their booking or transaction for analytics and debugging purposes.
|
|
@@ -645,12 +638,11 @@ type CreatePurchaseV2OkResponse = z.infer<typeof createPurchaseV2OkResponse>;
|
|
|
645
638
|
declare const listPurchasesOkResponse: z.ZodLazy<z.ZodObject<{
|
|
646
639
|
purchases: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodObject<{
|
|
647
640
|
id: z.ZodOptional<z.ZodString>;
|
|
648
|
-
startDate: z.
|
|
649
|
-
endDate: z.
|
|
650
|
-
duration: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
641
|
+
startDate: z.ZodOptional<z.ZodString>;
|
|
642
|
+
endDate: z.ZodOptional<z.ZodString>;
|
|
651
643
|
createdDate: z.ZodOptional<z.ZodString>;
|
|
652
|
-
startTime: z.
|
|
653
|
-
endTime: z.
|
|
644
|
+
startTime: z.ZodOptional<z.ZodNumber>;
|
|
645
|
+
endTime: z.ZodOptional<z.ZodNumber>;
|
|
654
646
|
createdAt: z.ZodOptional<z.ZodNumber>;
|
|
655
647
|
package: z.ZodOptional<z.ZodLazy<z.ZodObject<{
|
|
656
648
|
id: z.ZodOptional<z.ZodString>;
|
|
@@ -683,12 +675,11 @@ declare const listPurchasesOkResponse: z.ZodLazy<z.ZodObject<{
|
|
|
683
675
|
referenceId: z.ZodOptional<z.ZodString>;
|
|
684
676
|
}, "strip", z.ZodTypeAny, {
|
|
685
677
|
id?: string | undefined;
|
|
686
|
-
startDate?: string |
|
|
687
|
-
endDate?: string |
|
|
688
|
-
duration?: number | null | undefined;
|
|
678
|
+
startDate?: string | undefined;
|
|
679
|
+
endDate?: string | undefined;
|
|
689
680
|
createdDate?: string | undefined;
|
|
690
|
-
startTime?: number |
|
|
691
|
-
endTime?: number |
|
|
681
|
+
startTime?: number | undefined;
|
|
682
|
+
endTime?: number | undefined;
|
|
692
683
|
createdAt?: number | undefined;
|
|
693
684
|
package?: {
|
|
694
685
|
id?: string | undefined;
|
|
@@ -705,12 +696,11 @@ declare const listPurchasesOkResponse: z.ZodLazy<z.ZodObject<{
|
|
|
705
696
|
referenceId?: string | undefined;
|
|
706
697
|
}, {
|
|
707
698
|
id?: string | undefined;
|
|
708
|
-
startDate?: string |
|
|
709
|
-
endDate?: string |
|
|
710
|
-
duration?: number | null | undefined;
|
|
699
|
+
startDate?: string | undefined;
|
|
700
|
+
endDate?: string | undefined;
|
|
711
701
|
createdDate?: string | undefined;
|
|
712
|
-
startTime?: number |
|
|
713
|
-
endTime?: number |
|
|
702
|
+
startTime?: number | undefined;
|
|
703
|
+
endTime?: number | undefined;
|
|
714
704
|
createdAt?: number | undefined;
|
|
715
705
|
package?: {
|
|
716
706
|
id?: string | undefined;
|
|
@@ -730,12 +720,11 @@ declare const listPurchasesOkResponse: z.ZodLazy<z.ZodObject<{
|
|
|
730
720
|
}, "strip", z.ZodTypeAny, {
|
|
731
721
|
purchases?: {
|
|
732
722
|
id?: string | undefined;
|
|
733
|
-
startDate?: string |
|
|
734
|
-
endDate?: string |
|
|
735
|
-
duration?: number | null | undefined;
|
|
723
|
+
startDate?: string | undefined;
|
|
724
|
+
endDate?: string | undefined;
|
|
736
725
|
createdDate?: string | undefined;
|
|
737
|
-
startTime?: number |
|
|
738
|
-
endTime?: number |
|
|
726
|
+
startTime?: number | undefined;
|
|
727
|
+
endTime?: number | undefined;
|
|
739
728
|
createdAt?: number | undefined;
|
|
740
729
|
package?: {
|
|
741
730
|
id?: string | undefined;
|
|
@@ -755,12 +744,11 @@ declare const listPurchasesOkResponse: z.ZodLazy<z.ZodObject<{
|
|
|
755
744
|
}, {
|
|
756
745
|
purchases?: {
|
|
757
746
|
id?: string | undefined;
|
|
758
|
-
startDate?: string |
|
|
759
|
-
endDate?: string |
|
|
760
|
-
duration?: number | null | undefined;
|
|
747
|
+
startDate?: string | undefined;
|
|
748
|
+
endDate?: string | undefined;
|
|
761
749
|
createdDate?: string | undefined;
|
|
762
|
-
startTime?: number |
|
|
763
|
-
endTime?: number |
|
|
750
|
+
startTime?: number | undefined;
|
|
751
|
+
endTime?: number | undefined;
|
|
764
752
|
createdAt?: number | undefined;
|
|
765
753
|
package?: {
|
|
766
754
|
id?: string | undefined;
|
|
@@ -857,27 +845,27 @@ declare const createPurchaseOkResponse: z.ZodLazy<z.ZodObject<{
|
|
|
857
845
|
purchase: z.ZodOptional<z.ZodLazy<z.ZodObject<{
|
|
858
846
|
id: z.ZodOptional<z.ZodString>;
|
|
859
847
|
packageId: z.ZodOptional<z.ZodString>;
|
|
860
|
-
startDate: z.
|
|
861
|
-
endDate: z.
|
|
848
|
+
startDate: z.ZodOptional<z.ZodString>;
|
|
849
|
+
endDate: z.ZodOptional<z.ZodString>;
|
|
862
850
|
createdDate: z.ZodOptional<z.ZodString>;
|
|
863
|
-
startTime: z.
|
|
864
|
-
endTime: z.
|
|
851
|
+
startTime: z.ZodOptional<z.ZodNumber>;
|
|
852
|
+
endTime: z.ZodOptional<z.ZodNumber>;
|
|
865
853
|
}, "strip", z.ZodTypeAny, {
|
|
866
854
|
id?: string | undefined;
|
|
867
855
|
packageId?: string | undefined;
|
|
868
|
-
startDate?: string |
|
|
869
|
-
endDate?: string |
|
|
856
|
+
startDate?: string | undefined;
|
|
857
|
+
endDate?: string | undefined;
|
|
870
858
|
createdDate?: string | undefined;
|
|
871
|
-
startTime?: number |
|
|
872
|
-
endTime?: number |
|
|
859
|
+
startTime?: number | undefined;
|
|
860
|
+
endTime?: number | undefined;
|
|
873
861
|
}, {
|
|
874
862
|
id?: string | undefined;
|
|
875
863
|
packageId?: string | undefined;
|
|
876
|
-
startDate?: string |
|
|
877
|
-
endDate?: string |
|
|
864
|
+
startDate?: string | undefined;
|
|
865
|
+
endDate?: string | undefined;
|
|
878
866
|
createdDate?: string | undefined;
|
|
879
|
-
startTime?: number |
|
|
880
|
-
endTime?: number |
|
|
867
|
+
startTime?: number | undefined;
|
|
868
|
+
endTime?: number | undefined;
|
|
881
869
|
}>>>;
|
|
882
870
|
profile: z.ZodOptional<z.ZodLazy<z.ZodObject<{
|
|
883
871
|
iccid: z.ZodOptional<z.ZodString>;
|
|
@@ -896,11 +884,11 @@ declare const createPurchaseOkResponse: z.ZodLazy<z.ZodObject<{
|
|
|
896
884
|
purchase?: {
|
|
897
885
|
id?: string | undefined;
|
|
898
886
|
packageId?: string | undefined;
|
|
899
|
-
startDate?: string |
|
|
900
|
-
endDate?: string |
|
|
887
|
+
startDate?: string | undefined;
|
|
888
|
+
endDate?: string | undefined;
|
|
901
889
|
createdDate?: string | undefined;
|
|
902
|
-
startTime?: number |
|
|
903
|
-
endTime?: number |
|
|
890
|
+
startTime?: number | undefined;
|
|
891
|
+
endTime?: number | undefined;
|
|
904
892
|
} | undefined;
|
|
905
893
|
profile?: {
|
|
906
894
|
iccid?: string | undefined;
|
|
@@ -911,11 +899,11 @@ declare const createPurchaseOkResponse: z.ZodLazy<z.ZodObject<{
|
|
|
911
899
|
purchase?: {
|
|
912
900
|
id?: string | undefined;
|
|
913
901
|
packageId?: string | undefined;
|
|
914
|
-
startDate?: string |
|
|
915
|
-
endDate?: string |
|
|
902
|
+
startDate?: string | undefined;
|
|
903
|
+
endDate?: string | undefined;
|
|
916
904
|
createdDate?: string | undefined;
|
|
917
|
-
startTime?: number |
|
|
918
|
-
endTime?: number |
|
|
905
|
+
startTime?: number | undefined;
|
|
906
|
+
endTime?: number | undefined;
|
|
919
907
|
} | undefined;
|
|
920
908
|
profile?: {
|
|
921
909
|
iccid?: string | undefined;
|
|
@@ -937,12 +925,16 @@ type CreatePurchaseOkResponse = z.infer<typeof createPurchaseOkResponse>;
|
|
|
937
925
|
declare const topUpEsimRequest: z.ZodLazy<z.ZodObject<{
|
|
938
926
|
iccid: z.ZodString;
|
|
939
927
|
dataLimitInGb: z.ZodNumber;
|
|
928
|
+
startDate: z.ZodString;
|
|
929
|
+
endDate: z.ZodString;
|
|
940
930
|
email: z.ZodOptional<z.ZodString>;
|
|
941
931
|
referenceId: z.ZodOptional<z.ZodString>;
|
|
942
932
|
emailBrand: z.ZodOptional<z.ZodString>;
|
|
943
933
|
startTime: z.ZodOptional<z.ZodNumber>;
|
|
944
934
|
endTime: z.ZodOptional<z.ZodNumber>;
|
|
945
935
|
}, "strip", z.ZodTypeAny, {
|
|
936
|
+
startDate: string;
|
|
937
|
+
endDate: string;
|
|
946
938
|
dataLimitInGb: number;
|
|
947
939
|
iccid: string;
|
|
948
940
|
email?: string | undefined;
|
|
@@ -951,6 +943,8 @@ declare const topUpEsimRequest: z.ZodLazy<z.ZodObject<{
|
|
|
951
943
|
startTime?: number | undefined;
|
|
952
944
|
endTime?: number | undefined;
|
|
953
945
|
}, {
|
|
946
|
+
startDate: string;
|
|
947
|
+
endDate: string;
|
|
954
948
|
dataLimitInGb: number;
|
|
955
949
|
iccid: string;
|
|
956
950
|
email?: string | undefined;
|
|
@@ -963,12 +957,9 @@ declare const topUpEsimRequest: z.ZodLazy<z.ZodObject<{
|
|
|
963
957
|
*
|
|
964
958
|
* @typedef {TopUpEsimRequest} topUpEsimRequest
|
|
965
959
|
* @property {string} - ID of the eSIM
|
|
966
|
-
* @property {number} - Size of the package in GB.
|
|
967
|
-
|
|
968
|
-
|
|
969
|
-
|
|
970
|
-
For ``unlimited packages`` (available to Region-3), please use ``-1`` as an identifier (supports `duration` only).
|
|
971
|
-
|
|
960
|
+
* @property {number} - Size of the package in GB. The available options are 0.5, 1, 2, 3, 5, 8, 20GB
|
|
961
|
+
* @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.
|
|
962
|
+
* @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.
|
|
972
963
|
* @property {string} - Email address where the purchase confirmation email will be sent (excluding QR Code & activation steps).
|
|
973
964
|
* @property {string} - An identifier provided by the partner to link this purchase to their booking or transaction for analytics and debugging purposes.
|
|
974
965
|
* @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.
|
|
@@ -984,30 +975,27 @@ declare const topUpEsimOkResponse: z.ZodLazy<z.ZodObject<{
|
|
|
984
975
|
purchase: z.ZodOptional<z.ZodLazy<z.ZodObject<{
|
|
985
976
|
id: z.ZodOptional<z.ZodString>;
|
|
986
977
|
packageId: z.ZodOptional<z.ZodString>;
|
|
987
|
-
startDate: z.
|
|
988
|
-
endDate: z.
|
|
989
|
-
duration: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
978
|
+
startDate: z.ZodOptional<z.ZodString>;
|
|
979
|
+
endDate: z.ZodOptional<z.ZodString>;
|
|
990
980
|
createdDate: z.ZodOptional<z.ZodString>;
|
|
991
|
-
startTime: z.
|
|
992
|
-
endTime: z.
|
|
981
|
+
startTime: z.ZodOptional<z.ZodNumber>;
|
|
982
|
+
endTime: z.ZodOptional<z.ZodNumber>;
|
|
993
983
|
}, "strip", z.ZodTypeAny, {
|
|
994
984
|
id?: string | undefined;
|
|
995
985
|
packageId?: string | undefined;
|
|
996
|
-
startDate?: string |
|
|
997
|
-
endDate?: string |
|
|
998
|
-
duration?: number | null | undefined;
|
|
986
|
+
startDate?: string | undefined;
|
|
987
|
+
endDate?: string | undefined;
|
|
999
988
|
createdDate?: string | undefined;
|
|
1000
|
-
startTime?: number |
|
|
1001
|
-
endTime?: number |
|
|
989
|
+
startTime?: number | undefined;
|
|
990
|
+
endTime?: number | undefined;
|
|
1002
991
|
}, {
|
|
1003
992
|
id?: string | undefined;
|
|
1004
993
|
packageId?: string | undefined;
|
|
1005
|
-
startDate?: string |
|
|
1006
|
-
endDate?: string |
|
|
1007
|
-
duration?: number | null | undefined;
|
|
994
|
+
startDate?: string | undefined;
|
|
995
|
+
endDate?: string | undefined;
|
|
1008
996
|
createdDate?: string | undefined;
|
|
1009
|
-
startTime?: number |
|
|
1010
|
-
endTime?: number |
|
|
997
|
+
startTime?: number | undefined;
|
|
998
|
+
endTime?: number | undefined;
|
|
1011
999
|
}>>>;
|
|
1012
1000
|
profile: z.ZodOptional<z.ZodLazy<z.ZodObject<{
|
|
1013
1001
|
iccid: z.ZodOptional<z.ZodString>;
|
|
@@ -1020,12 +1008,11 @@ declare const topUpEsimOkResponse: z.ZodLazy<z.ZodObject<{
|
|
|
1020
1008
|
purchase?: {
|
|
1021
1009
|
id?: string | undefined;
|
|
1022
1010
|
packageId?: string | undefined;
|
|
1023
|
-
startDate?: string |
|
|
1024
|
-
endDate?: string |
|
|
1025
|
-
duration?: number | null | undefined;
|
|
1011
|
+
startDate?: string | undefined;
|
|
1012
|
+
endDate?: string | undefined;
|
|
1026
1013
|
createdDate?: string | undefined;
|
|
1027
|
-
startTime?: number |
|
|
1028
|
-
endTime?: number |
|
|
1014
|
+
startTime?: number | undefined;
|
|
1015
|
+
endTime?: number | undefined;
|
|
1029
1016
|
} | undefined;
|
|
1030
1017
|
profile?: {
|
|
1031
1018
|
iccid?: string | undefined;
|
|
@@ -1034,12 +1021,11 @@ declare const topUpEsimOkResponse: z.ZodLazy<z.ZodObject<{
|
|
|
1034
1021
|
purchase?: {
|
|
1035
1022
|
id?: string | undefined;
|
|
1036
1023
|
packageId?: string | undefined;
|
|
1037
|
-
startDate?: string |
|
|
1038
|
-
endDate?: string |
|
|
1039
|
-
duration?: number | null | undefined;
|
|
1024
|
+
startDate?: string | undefined;
|
|
1025
|
+
endDate?: string | undefined;
|
|
1040
1026
|
createdDate?: string | undefined;
|
|
1041
|
-
startTime?: number |
|
|
1042
|
-
endTime?: number |
|
|
1027
|
+
startTime?: number | undefined;
|
|
1028
|
+
endTime?: number | undefined;
|
|
1043
1029
|
} | undefined;
|
|
1044
1030
|
profile?: {
|
|
1045
1031
|
iccid?: string | undefined;
|
|
@@ -1091,22 +1077,22 @@ type EditPurchaseRequest = z.infer<typeof editPurchaseRequest>;
|
|
|
1091
1077
|
*/
|
|
1092
1078
|
declare const editPurchaseOkResponse: z.ZodLazy<z.ZodObject<{
|
|
1093
1079
|
purchaseId: z.ZodOptional<z.ZodString>;
|
|
1094
|
-
newStartDate: z.
|
|
1095
|
-
newEndDate: z.
|
|
1096
|
-
newStartTime: z.
|
|
1097
|
-
newEndTime: z.
|
|
1080
|
+
newStartDate: z.ZodOptional<z.ZodString>;
|
|
1081
|
+
newEndDate: z.ZodOptional<z.ZodString>;
|
|
1082
|
+
newStartTime: z.ZodOptional<z.ZodNumber>;
|
|
1083
|
+
newEndTime: z.ZodOptional<z.ZodNumber>;
|
|
1098
1084
|
}, "strip", z.ZodTypeAny, {
|
|
1099
1085
|
purchaseId?: string | undefined;
|
|
1100
|
-
newStartDate?: string |
|
|
1101
|
-
newEndDate?: string |
|
|
1102
|
-
newStartTime?: number |
|
|
1103
|
-
newEndTime?: number |
|
|
1086
|
+
newStartDate?: string | undefined;
|
|
1087
|
+
newEndDate?: string | undefined;
|
|
1088
|
+
newStartTime?: number | undefined;
|
|
1089
|
+
newEndTime?: number | undefined;
|
|
1104
1090
|
}, {
|
|
1105
1091
|
purchaseId?: string | undefined;
|
|
1106
|
-
newStartDate?: string |
|
|
1107
|
-
newEndDate?: string |
|
|
1108
|
-
newStartTime?: number |
|
|
1109
|
-
newEndTime?: number |
|
|
1092
|
+
newStartDate?: string | undefined;
|
|
1093
|
+
newEndDate?: string | undefined;
|
|
1094
|
+
newStartTime?: number | undefined;
|
|
1095
|
+
newEndTime?: number | undefined;
|
|
1110
1096
|
}>>;
|
|
1111
1097
|
/**
|
|
1112
1098
|
*
|
|
@@ -1135,10 +1121,7 @@ declare const getPurchaseConsumptionOkResponse: z.ZodLazy<z.ZodObject<{
|
|
|
1135
1121
|
/**
|
|
1136
1122
|
*
|
|
1137
1123
|
* @typedef {GetPurchaseConsumptionOkResponse} getPurchaseConsumptionOkResponse
|
|
1138
|
-
* @property {number} - Remaining balance of the package in
|
|
1139
|
-
For ``limited packages``, this field indicates the remaining data in bytes.
|
|
1140
|
-
For ``unlimited packages``, it will return ``-1`` as an identifier.
|
|
1141
|
-
|
|
1124
|
+
* @property {number} - Remaining balance of the package in bytes
|
|
1142
1125
|
* @property {string} - Status of the connectivity, possible values are 'ACTIVE' or 'NOT_ACTIVE'
|
|
1143
1126
|
*/
|
|
1144
1127
|
type GetPurchaseConsumptionOkResponse = z.infer<typeof getPurchaseConsumptionOkResponse>;
|
|
@@ -1177,7 +1160,7 @@ declare class PurchasesService extends BaseService {
|
|
|
1177
1160
|
*/
|
|
1178
1161
|
topUpEsim(body: TopUpEsimRequest, requestConfig?: RequestConfig): Promise<HttpResponse<TopUpEsimOkResponse>>;
|
|
1179
1162
|
/**
|
|
1180
|
-
* 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.
|
|
1163
|
+
* 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.
|
|
1181
1164
|
* @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
|
|
1182
1165
|
* @returns {Promise<HttpResponse<EditPurchaseOkResponse>>} Successful Response
|
|
1183
1166
|
*/
|
|
@@ -1246,12 +1229,11 @@ type CreatePurchaseV2OkResponseProfile = z.infer<typeof createPurchaseV2OkRespon
|
|
|
1246
1229
|
*/
|
|
1247
1230
|
declare const purchases: z.ZodLazy<z.ZodObject<{
|
|
1248
1231
|
id: z.ZodOptional<z.ZodString>;
|
|
1249
|
-
startDate: z.
|
|
1250
|
-
endDate: z.
|
|
1251
|
-
duration: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
1232
|
+
startDate: z.ZodOptional<z.ZodString>;
|
|
1233
|
+
endDate: z.ZodOptional<z.ZodString>;
|
|
1252
1234
|
createdDate: z.ZodOptional<z.ZodString>;
|
|
1253
|
-
startTime: z.
|
|
1254
|
-
endTime: z.
|
|
1235
|
+
startTime: z.ZodOptional<z.ZodNumber>;
|
|
1236
|
+
endTime: z.ZodOptional<z.ZodNumber>;
|
|
1255
1237
|
createdAt: z.ZodOptional<z.ZodNumber>;
|
|
1256
1238
|
package: z.ZodOptional<z.ZodLazy<z.ZodObject<{
|
|
1257
1239
|
id: z.ZodOptional<z.ZodString>;
|
|
@@ -1284,12 +1266,11 @@ declare const purchases: z.ZodLazy<z.ZodObject<{
|
|
|
1284
1266
|
referenceId: z.ZodOptional<z.ZodString>;
|
|
1285
1267
|
}, "strip", z.ZodTypeAny, {
|
|
1286
1268
|
id?: string | undefined;
|
|
1287
|
-
startDate?: string |
|
|
1288
|
-
endDate?: string |
|
|
1289
|
-
duration?: number | null | undefined;
|
|
1269
|
+
startDate?: string | undefined;
|
|
1270
|
+
endDate?: string | undefined;
|
|
1290
1271
|
createdDate?: string | undefined;
|
|
1291
|
-
startTime?: number |
|
|
1292
|
-
endTime?: number |
|
|
1272
|
+
startTime?: number | undefined;
|
|
1273
|
+
endTime?: number | undefined;
|
|
1293
1274
|
createdAt?: number | undefined;
|
|
1294
1275
|
package?: {
|
|
1295
1276
|
id?: string | undefined;
|
|
@@ -1306,12 +1287,11 @@ declare const purchases: z.ZodLazy<z.ZodObject<{
|
|
|
1306
1287
|
referenceId?: string | undefined;
|
|
1307
1288
|
}, {
|
|
1308
1289
|
id?: string | undefined;
|
|
1309
|
-
startDate?: string |
|
|
1310
|
-
endDate?: string |
|
|
1311
|
-
duration?: number | null | undefined;
|
|
1290
|
+
startDate?: string | undefined;
|
|
1291
|
+
endDate?: string | undefined;
|
|
1312
1292
|
createdDate?: string | undefined;
|
|
1313
|
-
startTime?: number |
|
|
1314
|
-
endTime?: number |
|
|
1293
|
+
startTime?: number | undefined;
|
|
1294
|
+
endTime?: number | undefined;
|
|
1315
1295
|
createdAt?: number | undefined;
|
|
1316
1296
|
package?: {
|
|
1317
1297
|
id?: string | undefined;
|
|
@@ -1333,7 +1313,6 @@ declare const purchases: z.ZodLazy<z.ZodObject<{
|
|
|
1333
1313
|
* @property {string} - ID of the purchase
|
|
1334
1314
|
* @property {string} - Start date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'
|
|
1335
1315
|
* @property {string} - End date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'
|
|
1336
|
-
* @property {number} - It designates the number of days the eSIM is valid for within 90-day validity from issuance date.
|
|
1337
1316
|
* @property {string} - Creation date of the purchase in the format 'yyyy-MM-ddThh:mm:ssZZ'
|
|
1338
1317
|
* @property {number} - Epoch value representing the start time of the package's validity
|
|
1339
1318
|
* @property {number} - Epoch value representing the end time of the package's validity
|
|
@@ -1372,8 +1351,7 @@ declare const package_: z.ZodLazy<z.ZodObject<{
|
|
|
1372
1351
|
*
|
|
1373
1352
|
* @typedef {Package_} package_
|
|
1374
1353
|
* @property {string} - ID of the package
|
|
1375
|
-
* @property {number} - Size of the package in
|
|
1376
|
-
|
|
1354
|
+
* @property {number} - Size of the package in Bytes
|
|
1377
1355
|
* @property {string} - ISO representation of the package's destination.
|
|
1378
1356
|
* @property {string} - Name of the package's destination
|
|
1379
1357
|
* @property {number} - Price of the package in cents
|
|
@@ -1403,27 +1381,27 @@ type PurchasesEsim = z.infer<typeof purchasesEsim>;
|
|
|
1403
1381
|
declare const createPurchaseOkResponsePurchase: z.ZodLazy<z.ZodObject<{
|
|
1404
1382
|
id: z.ZodOptional<z.ZodString>;
|
|
1405
1383
|
packageId: z.ZodOptional<z.ZodString>;
|
|
1406
|
-
startDate: z.
|
|
1407
|
-
endDate: z.
|
|
1384
|
+
startDate: z.ZodOptional<z.ZodString>;
|
|
1385
|
+
endDate: z.ZodOptional<z.ZodString>;
|
|
1408
1386
|
createdDate: z.ZodOptional<z.ZodString>;
|
|
1409
|
-
startTime: z.
|
|
1410
|
-
endTime: z.
|
|
1387
|
+
startTime: z.ZodOptional<z.ZodNumber>;
|
|
1388
|
+
endTime: z.ZodOptional<z.ZodNumber>;
|
|
1411
1389
|
}, "strip", z.ZodTypeAny, {
|
|
1412
1390
|
id?: string | undefined;
|
|
1413
1391
|
packageId?: string | undefined;
|
|
1414
|
-
startDate?: string |
|
|
1415
|
-
endDate?: string |
|
|
1392
|
+
startDate?: string | undefined;
|
|
1393
|
+
endDate?: string | undefined;
|
|
1416
1394
|
createdDate?: string | undefined;
|
|
1417
|
-
startTime?: number |
|
|
1418
|
-
endTime?: number |
|
|
1395
|
+
startTime?: number | undefined;
|
|
1396
|
+
endTime?: number | undefined;
|
|
1419
1397
|
}, {
|
|
1420
1398
|
id?: string | undefined;
|
|
1421
1399
|
packageId?: string | undefined;
|
|
1422
|
-
startDate?: string |
|
|
1423
|
-
endDate?: string |
|
|
1400
|
+
startDate?: string | undefined;
|
|
1401
|
+
endDate?: string | undefined;
|
|
1424
1402
|
createdDate?: string | undefined;
|
|
1425
|
-
startTime?: number |
|
|
1426
|
-
endTime?: number |
|
|
1403
|
+
startTime?: number | undefined;
|
|
1404
|
+
endTime?: number | undefined;
|
|
1427
1405
|
}>>;
|
|
1428
1406
|
/**
|
|
1429
1407
|
*
|
|
@@ -1469,30 +1447,27 @@ type CreatePurchaseOkResponseProfile = z.infer<typeof createPurchaseOkResponsePr
|
|
|
1469
1447
|
declare const topUpEsimOkResponsePurchase: z.ZodLazy<z.ZodObject<{
|
|
1470
1448
|
id: z.ZodOptional<z.ZodString>;
|
|
1471
1449
|
packageId: z.ZodOptional<z.ZodString>;
|
|
1472
|
-
startDate: z.
|
|
1473
|
-
endDate: z.
|
|
1474
|
-
duration: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
1450
|
+
startDate: z.ZodOptional<z.ZodString>;
|
|
1451
|
+
endDate: z.ZodOptional<z.ZodString>;
|
|
1475
1452
|
createdDate: z.ZodOptional<z.ZodString>;
|
|
1476
|
-
startTime: z.
|
|
1477
|
-
endTime: z.
|
|
1453
|
+
startTime: z.ZodOptional<z.ZodNumber>;
|
|
1454
|
+
endTime: z.ZodOptional<z.ZodNumber>;
|
|
1478
1455
|
}, "strip", z.ZodTypeAny, {
|
|
1479
1456
|
id?: string | undefined;
|
|
1480
1457
|
packageId?: string | undefined;
|
|
1481
|
-
startDate?: string |
|
|
1482
|
-
endDate?: string |
|
|
1483
|
-
duration?: number | null | undefined;
|
|
1458
|
+
startDate?: string | undefined;
|
|
1459
|
+
endDate?: string | undefined;
|
|
1484
1460
|
createdDate?: string | undefined;
|
|
1485
|
-
startTime?: number |
|
|
1486
|
-
endTime?: number |
|
|
1461
|
+
startTime?: number | undefined;
|
|
1462
|
+
endTime?: number | undefined;
|
|
1487
1463
|
}, {
|
|
1488
1464
|
id?: string | undefined;
|
|
1489
1465
|
packageId?: string | undefined;
|
|
1490
|
-
startDate?: string |
|
|
1491
|
-
endDate?: string |
|
|
1492
|
-
duration?: number | null | undefined;
|
|
1466
|
+
startDate?: string | undefined;
|
|
1467
|
+
endDate?: string | undefined;
|
|
1493
1468
|
createdDate?: string | undefined;
|
|
1494
|
-
startTime?: number |
|
|
1495
|
-
endTime?: number |
|
|
1469
|
+
startTime?: number | undefined;
|
|
1470
|
+
endTime?: number | undefined;
|
|
1496
1471
|
}>>;
|
|
1497
1472
|
/**
|
|
1498
1473
|
*
|
|
@@ -1501,7 +1476,6 @@ declare const topUpEsimOkResponsePurchase: z.ZodLazy<z.ZodObject<{
|
|
|
1501
1476
|
* @property {string} - ID of the package
|
|
1502
1477
|
* @property {string} - Start date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'
|
|
1503
1478
|
* @property {string} - End date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'
|
|
1504
|
-
* @property {number} - It designates the number of days the eSIM is valid for within 90-day validity from issuance date.
|
|
1505
1479
|
* @property {string} - Creation date of the purchase in the format 'yyyy-MM-ddThh:mm:ssZZ'
|
|
1506
1480
|
* @property {number} - Epoch value representing the start time of the package's validity
|
|
1507
1481
|
* @property {number} - Epoch value representing the end time of the package's validity
|