celitech-sdk 1.1.48 → 1.1.49

Sign up to get free protection for your applications and to get access to all the features.
Files changed (23) hide show
  1. package/README.md +37 -37
  2. package/dist/commonjs/http/HTTPLibrary.js +1 -1
  3. package/dist/commonjs/services/eSim/ESim.d.ts +4 -4
  4. package/dist/commonjs/services/eSim/ESim.js +4 -4
  5. package/dist/commonjs/services/packages/Packages.d.ts +8 -8
  6. package/dist/commonjs/services/packages/Packages.js +8 -8
  7. package/dist/commonjs/services/purchases/Purchases.d.ts +4 -4
  8. package/dist/commonjs/services/purchases/Purchases.js +4 -4
  9. package/dist/esm/http/HTTPLibrary.js +1 -1
  10. package/dist/esm/services/eSim/ESim.d.ts +4 -4
  11. package/dist/esm/services/eSim/ESim.js +4 -4
  12. package/dist/esm/services/packages/Packages.d.ts +8 -8
  13. package/dist/esm/services/packages/Packages.js +8 -8
  14. package/dist/esm/services/purchases/Purchases.d.ts +4 -4
  15. package/dist/esm/services/purchases/Purchases.js +4 -4
  16. package/dist/umd/http/HTTPLibrary.js +1 -1
  17. package/dist/umd/services/eSim/ESim.d.ts +4 -4
  18. package/dist/umd/services/eSim/ESim.js +4 -4
  19. package/dist/umd/services/packages/Packages.d.ts +8 -8
  20. package/dist/umd/services/packages/Packages.js +8 -8
  21. package/dist/umd/services/purchases/Purchases.d.ts +4 -4
  22. package/dist/umd/services/purchases/Purchases.js +4 -4
  23. package/package.json +1 -1
package/README.md CHANGED
@@ -1,9 +1,9 @@
1
- # Celitech Typescript SDK 1.1.48
1
+ # Celitech Typescript SDK 1.1.49
2
2
 
3
3
  The Typescript SDK for Celitech.
4
4
 
5
- - API version: 1.1.48
6
- - SDK version: 1.1.48
5
+ - API version: 1.1.49
6
+ - SDK version: 1.1.49
7
7
 
8
8
  ## Table of Contents
9
9
 
@@ -151,16 +151,16 @@ List Packages
151
151
 
152
152
  Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}
153
153
 
154
- | Name | Type | Description |
155
- | :---------- | :----- | :---------- |
156
- | destination | string | |
157
- | startDate | string | |
158
- | endDate | string | |
159
- | afterCursor | string | |
160
- | limit | number | |
161
- | startTime | number | |
162
- | endTime | number | |
163
- | duration | number | |
154
+ | Name | Type | Description |
155
+ | :---------- | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
156
+ | destination | string | ISO representation of the package's destination. Optional, unless startDate and endDate are used, then it becomes mandatory. |
157
+ | startDate | 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. |
158
+ | endDate | string | End date of the package's validity in the format 'yyyy-MM-dd'. End date can be maximum 60 days after Start date. |
159
+ | afterCursor | string | 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. |
160
+ | limit | number | 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 |
161
+ | startTime | number | 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 |
162
+ | endTime | number | Epoch value representing the end time of the package's validity. End time can be maximum 60 days after Start time |
163
+ | duration | number | 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 60 days |
164
164
 
165
165
  **Return Type**
166
166
 
@@ -220,15 +220,15 @@ List Purchases
220
220
 
221
221
  Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}
222
222
 
223
- | Name | Type | Description |
224
- | :---------- | :----- | :------------------------------------------------------------------------------ |
225
- | iccid | string | |
226
- | afterDate | string | Start date of the interval for filtering purchases in the format 'yyyy-MM-dd' |
227
- | beforeDate | string | End date of the interval for filtering purchases in the format 'yyyy-MM-dd' |
228
- | afterCursor | string | |
229
- | limit | number | |
230
- | after | number | Epoch value representing the start of the time interval for filtering purchases |
231
- | before | number | Epoch value representing the end of the time interval for filtering purchases |
223
+ | Name | Type | Description |
224
+ | :---------- | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
225
+ | iccid | string | ID of the eSIM |
226
+ | afterDate | string | Start date of the interval for filtering purchases in the format 'yyyy-MM-dd' |
227
+ | beforeDate | string | End date of the interval for filtering purchases in the format 'yyyy-MM-dd' |
228
+ | afterCursor | string | 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. |
229
+ | limit | number | 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 |
230
+ | after | number | Epoch value representing the start of the time interval for filtering purchases |
231
+ | before | number | Epoch value representing the end of the time interval for filtering purchases |
232
232
 
233
233
  **Return Type**
234
234
 
@@ -315,9 +315,9 @@ Get Purchase Consumption
315
315
 
316
316
  **Required Parameters**
317
317
 
318
- | Name | Type | Description |
319
- | :--------- | :----- | :---------- |
320
- | purchaseId | string | |
318
+ | Name | Type | Description |
319
+ | :--------- | :----- | :----------------- |
320
+ | purchaseId | string | ID of the purchase |
321
321
 
322
322
  **Return Type**
323
323
 
@@ -346,9 +346,9 @@ Get eSIM Status
346
346
 
347
347
  **Required Parameters**
348
348
 
349
- | Name | Type | Description |
350
- | :---- | :----- | :---------- |
351
- | iccid | string | |
349
+ | Name | Type | Description |
350
+ | :---- | :----- | :------------- |
351
+ | iccid | string | ID of the eSIM |
352
352
 
353
353
  **Return Type**
354
354
 
@@ -377,9 +377,9 @@ Get eSIM Device
377
377
 
378
378
  **Required Parameters**
379
379
 
380
- | Name | Type | Description |
381
- | :---- | :----- | :---------- |
382
- | iccid | string | |
380
+ | Name | Type | Description |
381
+ | :---- | :----- | :------------- |
382
+ | iccid | string | ID of the eSIM |
383
383
 
384
384
  **Return Type**
385
385
 
@@ -408,9 +408,9 @@ Get eSIM History
408
408
 
409
409
  **Required Parameters**
410
410
 
411
- | Name | Type | Description |
412
- | :---- | :----- | :---------- |
413
- | iccid | string | |
411
+ | Name | Type | Description |
412
+ | :---- | :----- | :------------- |
413
+ | iccid | string | ID of the eSIM |
414
414
 
415
415
  **Return Type**
416
416
 
@@ -439,9 +439,9 @@ Get eSIM MAC
439
439
 
440
440
  **Required Parameters**
441
441
 
442
- | Name | Type | Description |
443
- | :---- | :----- | :---------- |
444
- | iccid | string | |
442
+ | Name | Type | Description |
443
+ | :---- | :----- | :------------- |
444
+ | iccid | string | ID of the eSIM |
445
445
 
446
446
  **Return Type**
447
447
 
package/dist/commonjs/http/HTTPLibrary.js CHANGED
@@ -94,7 +94,7 @@ class HTTPLibrary {
94
94
  return response;
95
95
  }
96
96
  getUserAgentHeader() {
97
- const userAgentBase = 'Celitech/1.1.48';
97
+ const userAgentBase = 'Celitech/1.1.49';
98
98
  let userAgent = '';
99
99
  if (typeof window !== 'undefined') {
100
100
  return {};
package/dist/commonjs/services/eSim/ESim.d.ts CHANGED
@@ -8,7 +8,7 @@ export declare class ESimService extends BaseService {
8
8
  * @summary Get eSIM Status
9
9
  * @description Get status from eSIM
10
10
 
11
- * @param iccid Needed input variable
11
+ * @param iccid ID of the eSIM
12
12
  * @returns {Promise<GetEsimResponse>} - The promise with the result
13
13
  */
14
14
  getEsim(iccid: string): Promise<GetEsimResponse>;
@@ -16,7 +16,7 @@ export declare class ESimService extends BaseService {
16
16
  * @summary Get eSIM Device
17
17
  * @description Get device info from an installed eSIM
18
18
 
19
- * @param iccid Needed input variable
19
+ * @param iccid ID of the eSIM
20
20
  * @returns {Promise<GetEsimDeviceResponse>} - The promise with the result
21
21
  */
22
22
  getEsimDevice(iccid: string): Promise<GetEsimDeviceResponse>;
@@ -24,7 +24,7 @@ export declare class ESimService extends BaseService {
24
24
  * @summary Get eSIM History
25
25
  * @description Get history from an eSIM
26
26
 
27
- * @param iccid Needed input variable
27
+ * @param iccid ID of the eSIM
28
28
  * @returns {Promise<GetEsimHistoryResponse>} - The promise with the result
29
29
  */
30
30
  getEsimHistory(iccid: string): Promise<GetEsimHistoryResponse>;
@@ -32,7 +32,7 @@ export declare class ESimService extends BaseService {
32
32
  * @summary Get eSIM MAC
33
33
  * @description Get MAC from eSIM
34
34
 
35
- * @param iccid Needed input variable
35
+ * @param iccid ID of the eSIM
36
36
  * @returns {Promise<GetEsimMacResponse>} - The promise with the result
37
37
  */
38
38
  getEsimMac(iccid: string): Promise<GetEsimMacResponse>;
package/dist/commonjs/services/eSim/ESim.js CHANGED
@@ -13,7 +13,7 @@ class ESimService extends BaseService_1.default {
13
13
  * @summary Get eSIM Status
14
14
  * @description Get status from eSIM
15
15
 
16
- * @param iccid Needed input variable
16
+ * @param iccid ID of the eSIM
17
17
  * @returns {Promise<GetEsimResponse>} - The promise with the result
18
18
  */
19
19
  async getEsim(iccid) {
@@ -40,7 +40,7 @@ class ESimService extends BaseService_1.default {
40
40
  * @summary Get eSIM Device
41
41
  * @description Get device info from an installed eSIM
42
42
 
43
- * @param iccid Needed input variable
43
+ * @param iccid ID of the eSIM
44
44
  * @returns {Promise<GetEsimDeviceResponse>} - The promise with the result
45
45
  */
46
46
  async getEsimDevice(iccid) {
@@ -64,7 +64,7 @@ class ESimService extends BaseService_1.default {
64
64
  * @summary Get eSIM History
65
65
  * @description Get history from an eSIM
66
66
 
67
- * @param iccid Needed input variable
67
+ * @param iccid ID of the eSIM
68
68
  * @returns {Promise<GetEsimHistoryResponse>} - The promise with the result
69
69
  */
70
70
  async getEsimHistory(iccid) {
@@ -88,7 +88,7 @@ class ESimService extends BaseService_1.default {
88
88
  * @summary Get eSIM MAC
89
89
  * @description Get MAC from eSIM
90
90
 
91
- * @param iccid Needed input variable
91
+ * @param iccid ID of the eSIM
92
92
  * @returns {Promise<GetEsimMacResponse>} - The promise with the result
93
93
  */
94
94
  async getEsimMac(iccid) {
package/dist/commonjs/services/packages/Packages.d.ts CHANGED
@@ -6,14 +6,14 @@ export declare class PackagesService extends BaseService {
6
6
  * @description List of available packages
7
7
 
8
8
  * @param optionalParams - Optional parameters
9
- * @param optionalParams.destination - Needed input variable
10
- * @param optionalParams.startDate - Needed input variable
11
- * @param optionalParams.endDate - Needed input variable
12
- * @param optionalParams.afterCursor - Needed input variable
13
- * @param optionalParams.limit - Needed input variable
14
- * @param optionalParams.startTime - Needed input variable
15
- * @param optionalParams.endTime - Needed input variable
16
- * @param optionalParams.duration - Needed input variable
9
+ * @param optionalParams.destination - ISO representation of the package's destination. Optional, unless startDate and endDate are used, then it becomes mandatory.
10
+ * @param optionalParams.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.
11
+ * @param optionalParams.endDate - End date of the package's validity in the format 'yyyy-MM-dd'. End date can be maximum 60 days after Start date.
12
+ * @param optionalParams.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.
13
+ * @param optionalParams.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
14
+ * @param optionalParams.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
15
+ * @param optionalParams.endTime - Epoch value representing the end time of the package's validity. End time can be maximum 60 days after Start time
16
+ * @param optionalParams.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 60 days
17
17
  * @returns {Promise<ListPackagesResponse>} - The promise with the result
18
18
  */
19
19
  listPackages(optionalParams?: {
package/dist/commonjs/services/packages/Packages.js CHANGED
@@ -14,14 +14,14 @@ class PackagesService extends BaseService_1.default {
14
14
  * @description List of available packages
15
15
 
16
16
  * @param optionalParams - Optional parameters
17
- * @param optionalParams.destination - Needed input variable
18
- * @param optionalParams.startDate - Needed input variable
19
- * @param optionalParams.endDate - Needed input variable
20
- * @param optionalParams.afterCursor - Needed input variable
21
- * @param optionalParams.limit - Needed input variable
22
- * @param optionalParams.startTime - Needed input variable
23
- * @param optionalParams.endTime - Needed input variable
24
- * @param optionalParams.duration - Needed input variable
17
+ * @param optionalParams.destination - ISO representation of the package's destination. Optional, unless startDate and endDate are used, then it becomes mandatory.
18
+ * @param optionalParams.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.
19
+ * @param optionalParams.endDate - End date of the package's validity in the format 'yyyy-MM-dd'. End date can be maximum 60 days after Start date.
20
+ * @param optionalParams.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.
21
+ * @param optionalParams.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
22
+ * @param optionalParams.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
23
+ * @param optionalParams.endTime - Epoch value representing the end time of the package's validity. End time can be maximum 60 days after Start time
24
+ * @param optionalParams.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 60 days
25
25
  * @returns {Promise<ListPackagesResponse>} - The promise with the result
26
26
  */
27
27
  async listPackages(optionalParams = {}) {
package/dist/commonjs/services/purchases/Purchases.d.ts CHANGED
@@ -13,11 +13,11 @@ export declare class PurchasesService extends BaseService {
13
13
  * @description This endpoint can be used to list all the successful purchases made between a given interval.
14
14
 
15
15
  * @param optionalParams - Optional parameters
16
- * @param optionalParams.iccid - Needed input variable
16
+ * @param optionalParams.iccid - ID of the eSIM
17
17
  * @param optionalParams.afterDate - Start date of the interval for filtering purchases in the format 'yyyy-MM-dd'
18
18
  * @param optionalParams.beforeDate - End date of the interval for filtering purchases in the format 'yyyy-MM-dd'
19
- * @param optionalParams.afterCursor - Needed input variable
20
- * @param optionalParams.limit - Needed input variable
19
+ * @param optionalParams.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.
20
+ * @param optionalParams.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
21
21
  * @param optionalParams.after - Epoch value representing the start of the time interval for filtering purchases
22
22
  * @param optionalParams.before - Epoch value representing the end of the time interval for filtering purchases
23
23
  * @returns {Promise<ListPurchasesResponse>} - The promise with the result
@@ -56,7 +56,7 @@ export declare class PurchasesService extends BaseService {
56
56
  * @summary Get Purchase Consumption
57
57
  * @description 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.
58
58
 
59
- * @param purchaseId Needed input variable
59
+ * @param purchaseId ID of the purchase
60
60
  * @returns {Promise<GetPurchaseConsumptionResponse>} - The promise with the result
61
61
  */
62
62
  getPurchaseConsumption(purchaseId: string): Promise<GetPurchaseConsumptionResponse>;
package/dist/commonjs/services/purchases/Purchases.js CHANGED
@@ -14,11 +14,11 @@ class PurchasesService extends BaseService_1.default {
14
14
  * @description This endpoint can be used to list all the successful purchases made between a given interval.
15
15
 
16
16
  * @param optionalParams - Optional parameters
17
- * @param optionalParams.iccid - Needed input variable
17
+ * @param optionalParams.iccid - ID of the eSIM
18
18
  * @param optionalParams.afterDate - Start date of the interval for filtering purchases in the format 'yyyy-MM-dd'
19
19
  * @param optionalParams.beforeDate - End date of the interval for filtering purchases in the format 'yyyy-MM-dd'
20
- * @param optionalParams.afterCursor - Needed input variable
21
- * @param optionalParams.limit - Needed input variable
20
+ * @param optionalParams.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.
21
+ * @param optionalParams.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
22
22
  * @param optionalParams.after - Epoch value representing the start of the time interval for filtering purchases
23
23
  * @param optionalParams.before - Epoch value representing the end of the time interval for filtering purchases
24
24
  * @returns {Promise<ListPurchasesResponse>} - The promise with the result
@@ -121,7 +121,7 @@ class PurchasesService extends BaseService_1.default {
121
121
  * @summary Get Purchase Consumption
122
122
  * @description 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.
123
123
 
124
- * @param purchaseId Needed input variable
124
+ * @param purchaseId ID of the purchase
125
125
  * @returns {Promise<GetPurchaseConsumptionResponse>} - The promise with the result
126
126
  */
127
127
  async getPurchaseConsumption(purchaseId) {
package/dist/esm/http/HTTPLibrary.js CHANGED
@@ -89,7 +89,7 @@ export default class HTTPLibrary {
89
89
  return response;
90
90
  }
91
91
  getUserAgentHeader() {
92
- const userAgentBase = 'Celitech/1.1.48';
92
+ const userAgentBase = 'Celitech/1.1.49';
93
93
  let userAgent = '';
94
94
  if (typeof window !== 'undefined') {
95
95
  return {};
package/dist/esm/services/eSim/ESim.d.ts CHANGED
@@ -8,7 +8,7 @@ export declare class ESimService extends BaseService {
8
8
  * @summary Get eSIM Status
9
9
  * @description Get status from eSIM
10
10
 
11
- * @param iccid Needed input variable
11
+ * @param iccid ID of the eSIM
12
12
  * @returns {Promise<GetEsimResponse>} - The promise with the result
13
13
  */
14
14
  getEsim(iccid: string): Promise<GetEsimResponse>;
@@ -16,7 +16,7 @@ export declare class ESimService extends BaseService {
16
16
  * @summary Get eSIM Device
17
17
  * @description Get device info from an installed eSIM
18
18
 
19
- * @param iccid Needed input variable
19
+ * @param iccid ID of the eSIM
20
20
  * @returns {Promise<GetEsimDeviceResponse>} - The promise with the result
21
21
  */
22
22
  getEsimDevice(iccid: string): Promise<GetEsimDeviceResponse>;
@@ -24,7 +24,7 @@ export declare class ESimService extends BaseService {
24
24
  * @summary Get eSIM History
25
25
  * @description Get history from an eSIM
26
26
 
27
- * @param iccid Needed input variable
27
+ * @param iccid ID of the eSIM
28
28
  * @returns {Promise<GetEsimHistoryResponse>} - The promise with the result
29
29
  */
30
30
  getEsimHistory(iccid: string): Promise<GetEsimHistoryResponse>;
@@ -32,7 +32,7 @@ export declare class ESimService extends BaseService {
32
32
  * @summary Get eSIM MAC
33
33
  * @description Get MAC from eSIM
34
34
 
35
- * @param iccid Needed input variable
35
+ * @param iccid ID of the eSIM
36
36
  * @returns {Promise<GetEsimMacResponse>} - The promise with the result
37
37
  */
38
38
  getEsimMac(iccid: string): Promise<GetEsimMacResponse>;
package/dist/esm/services/eSim/ESim.js CHANGED
@@ -7,7 +7,7 @@ export class ESimService extends BaseService {
7
7
  * @summary Get eSIM Status
8
8
  * @description Get status from eSIM
9
9
 
10
- * @param iccid Needed input variable
10
+ * @param iccid ID of the eSIM
11
11
  * @returns {Promise<GetEsimResponse>} - The promise with the result
12
12
  */
13
13
  async getEsim(iccid) {
@@ -34,7 +34,7 @@ export class ESimService extends BaseService {
34
34
  * @summary Get eSIM Device
35
35
  * @description Get device info from an installed eSIM
36
36
 
37
- * @param iccid Needed input variable
37
+ * @param iccid ID of the eSIM
38
38
  * @returns {Promise<GetEsimDeviceResponse>} - The promise with the result
39
39
  */
40
40
  async getEsimDevice(iccid) {
@@ -58,7 +58,7 @@ export class ESimService extends BaseService {
58
58
  * @summary Get eSIM History
59
59
  * @description Get history from an eSIM
60
60
 
61
- * @param iccid Needed input variable
61
+ * @param iccid ID of the eSIM
62
62
  * @returns {Promise<GetEsimHistoryResponse>} - The promise with the result
63
63
  */
64
64
  async getEsimHistory(iccid) {
@@ -82,7 +82,7 @@ export class ESimService extends BaseService {
82
82
  * @summary Get eSIM MAC
83
83
  * @description Get MAC from eSIM
84
84
 
85
- * @param iccid Needed input variable
85
+ * @param iccid ID of the eSIM
86
86
  * @returns {Promise<GetEsimMacResponse>} - The promise with the result
87
87
  */
88
88
  async getEsimMac(iccid) {
package/dist/esm/services/packages/Packages.d.ts CHANGED
@@ -6,14 +6,14 @@ export declare class PackagesService extends BaseService {
6
6
  * @description List of available packages
7
7
 
8
8
  * @param optionalParams - Optional parameters
9
- * @param optionalParams.destination - Needed input variable
10
- * @param optionalParams.startDate - Needed input variable
11
- * @param optionalParams.endDate - Needed input variable
12
- * @param optionalParams.afterCursor - Needed input variable
13
- * @param optionalParams.limit - Needed input variable
14
- * @param optionalParams.startTime - Needed input variable
15
- * @param optionalParams.endTime - Needed input variable
16
- * @param optionalParams.duration - Needed input variable
9
+ * @param optionalParams.destination - ISO representation of the package's destination. Optional, unless startDate and endDate are used, then it becomes mandatory.
10
+ * @param optionalParams.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.
11
+ * @param optionalParams.endDate - End date of the package's validity in the format 'yyyy-MM-dd'. End date can be maximum 60 days after Start date.
12
+ * @param optionalParams.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.
13
+ * @param optionalParams.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
14
+ * @param optionalParams.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
15
+ * @param optionalParams.endTime - Epoch value representing the end time of the package's validity. End time can be maximum 60 days after Start time
16
+ * @param optionalParams.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 60 days
17
17
  * @returns {Promise<ListPackagesResponse>} - The promise with the result
18
18
  */
19
19
  listPackages(optionalParams?: {
package/dist/esm/services/packages/Packages.js CHANGED
@@ -8,14 +8,14 @@ export class PackagesService extends BaseService {
8
8
  * @description List of available packages
9
9
 
10
10
  * @param optionalParams - Optional parameters
11
- * @param optionalParams.destination - Needed input variable
12
- * @param optionalParams.startDate - Needed input variable
13
- * @param optionalParams.endDate - Needed input variable
14
- * @param optionalParams.afterCursor - Needed input variable
15
- * @param optionalParams.limit - Needed input variable
16
- * @param optionalParams.startTime - Needed input variable
17
- * @param optionalParams.endTime - Needed input variable
18
- * @param optionalParams.duration - Needed input variable
11
+ * @param optionalParams.destination - ISO representation of the package's destination. Optional, unless startDate and endDate are used, then it becomes mandatory.
12
+ * @param optionalParams.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.
13
+ * @param optionalParams.endDate - End date of the package's validity in the format 'yyyy-MM-dd'. End date can be maximum 60 days after Start date.
14
+ * @param optionalParams.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.
15
+ * @param optionalParams.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
16
+ * @param optionalParams.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
17
+ * @param optionalParams.endTime - Epoch value representing the end time of the package's validity. End time can be maximum 60 days after Start time
18
+ * @param optionalParams.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 60 days
19
19
  * @returns {Promise<ListPackagesResponse>} - The promise with the result
20
20
  */
21
21
  async listPackages(optionalParams = {}) {
package/dist/esm/services/purchases/Purchases.d.ts CHANGED
@@ -13,11 +13,11 @@ export declare class PurchasesService extends BaseService {
13
13
  * @description This endpoint can be used to list all the successful purchases made between a given interval.
14
14
 
15
15
  * @param optionalParams - Optional parameters
16
- * @param optionalParams.iccid - Needed input variable
16
+ * @param optionalParams.iccid - ID of the eSIM
17
17
  * @param optionalParams.afterDate - Start date of the interval for filtering purchases in the format 'yyyy-MM-dd'
18
18
  * @param optionalParams.beforeDate - End date of the interval for filtering purchases in the format 'yyyy-MM-dd'
19
- * @param optionalParams.afterCursor - Needed input variable
20
- * @param optionalParams.limit - Needed input variable
19
+ * @param optionalParams.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.
20
+ * @param optionalParams.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
21
21
  * @param optionalParams.after - Epoch value representing the start of the time interval for filtering purchases
22
22
  * @param optionalParams.before - Epoch value representing the end of the time interval for filtering purchases
23
23
  * @returns {Promise<ListPurchasesResponse>} - The promise with the result
@@ -56,7 +56,7 @@ export declare class PurchasesService extends BaseService {
56
56
  * @summary Get Purchase Consumption
57
57
  * @description 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.
58
58
 
59
- * @param purchaseId Needed input variable
59
+ * @param purchaseId ID of the purchase
60
60
  * @returns {Promise<GetPurchaseConsumptionResponse>} - The promise with the result
61
61
  */
62
62
  getPurchaseConsumption(purchaseId: string): Promise<GetPurchaseConsumptionResponse>;
package/dist/esm/services/purchases/Purchases.js CHANGED
@@ -8,11 +8,11 @@ export class PurchasesService extends BaseService {
8
8
  * @description This endpoint can be used to list all the successful purchases made between a given interval.
9
9
 
10
10
  * @param optionalParams - Optional parameters
11
- * @param optionalParams.iccid - Needed input variable
11
+ * @param optionalParams.iccid - ID of the eSIM
12
12
  * @param optionalParams.afterDate - Start date of the interval for filtering purchases in the format 'yyyy-MM-dd'
13
13
  * @param optionalParams.beforeDate - End date of the interval for filtering purchases in the format 'yyyy-MM-dd'
14
- * @param optionalParams.afterCursor - Needed input variable
15
- * @param optionalParams.limit - Needed input variable
14
+ * @param optionalParams.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.
15
+ * @param optionalParams.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
16
16
  * @param optionalParams.after - Epoch value representing the start of the time interval for filtering purchases
17
17
  * @param optionalParams.before - Epoch value representing the end of the time interval for filtering purchases
18
18
  * @returns {Promise<ListPurchasesResponse>} - The promise with the result
@@ -115,7 +115,7 @@ export class PurchasesService extends BaseService {
115
115
  * @summary Get Purchase Consumption
116
116
  * @description 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.
117
117
 
118
- * @param purchaseId Needed input variable
118
+ * @param purchaseId ID of the purchase
119
119
  * @returns {Promise<GetPurchaseConsumptionResponse>} - The promise with the result
120
120
  */
121
121
  async getPurchaseConsumption(purchaseId) {
package/dist/umd/http/HTTPLibrary.js CHANGED
@@ -103,7 +103,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
103
103
  return response;
104
104
  }
105
105
  getUserAgentHeader() {
106
- const userAgentBase = 'Celitech/1.1.48';
106
+ const userAgentBase = 'Celitech/1.1.49';
107
107
  let userAgent = '';
108
108
  if (typeof window !== 'undefined') {
109
109
  return {};
package/dist/umd/services/eSim/ESim.d.ts CHANGED
@@ -8,7 +8,7 @@ export declare class ESimService extends BaseService {
8
8
  * @summary Get eSIM Status
9
9
  * @description Get status from eSIM
10
10
 
11
- * @param iccid Needed input variable
11
+ * @param iccid ID of the eSIM
12
12
  * @returns {Promise<GetEsimResponse>} - The promise with the result
13
13
  */
14
14
  getEsim(iccid: string): Promise<GetEsimResponse>;
@@ -16,7 +16,7 @@ export declare class ESimService extends BaseService {
16
16
  * @summary Get eSIM Device
17
17
  * @description Get device info from an installed eSIM
18
18
 
19
- * @param iccid Needed input variable
19
+ * @param iccid ID of the eSIM
20
20
  * @returns {Promise<GetEsimDeviceResponse>} - The promise with the result
21
21
  */
22
22
  getEsimDevice(iccid: string): Promise<GetEsimDeviceResponse>;
@@ -24,7 +24,7 @@ export declare class ESimService extends BaseService {
24
24
  * @summary Get eSIM History
25
25
  * @description Get history from an eSIM
26
26
 
27
- * @param iccid Needed input variable
27
+ * @param iccid ID of the eSIM
28
28
  * @returns {Promise<GetEsimHistoryResponse>} - The promise with the result
29
29
  */
30
30
  getEsimHistory(iccid: string): Promise<GetEsimHistoryResponse>;
@@ -32,7 +32,7 @@ export declare class ESimService extends BaseService {
32
32
  * @summary Get eSIM MAC
33
33
  * @description Get MAC from eSIM
34
34
 
35
- * @param iccid Needed input variable
35
+ * @param iccid ID of the eSIM
36
36
  * @returns {Promise<GetEsimMacResponse>} - The promise with the result
37
37
  */
38
38
  getEsimMac(iccid: string): Promise<GetEsimMacResponse>;
package/dist/umd/services/eSim/ESim.js CHANGED
@@ -22,7 +22,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
22
22
  * @summary Get eSIM Status
23
23
  * @description Get status from eSIM
24
24
 
25
- * @param iccid Needed input variable
25
+ * @param iccid ID of the eSIM
26
26
  * @returns {Promise<GetEsimResponse>} - The promise with the result
27
27
  */
28
28
  async getEsim(iccid) {
@@ -49,7 +49,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
49
49
  * @summary Get eSIM Device
50
50
  * @description Get device info from an installed eSIM
51
51
 
52
- * @param iccid Needed input variable
52
+ * @param iccid ID of the eSIM
53
53
  * @returns {Promise<GetEsimDeviceResponse>} - The promise with the result
54
54
  */
55
55
  async getEsimDevice(iccid) {
@@ -73,7 +73,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
73
73
  * @summary Get eSIM History
74
74
  * @description Get history from an eSIM
75
75
 
76
- * @param iccid Needed input variable
76
+ * @param iccid ID of the eSIM
77
77
  * @returns {Promise<GetEsimHistoryResponse>} - The promise with the result
78
78
  */
79
79
  async getEsimHistory(iccid) {
@@ -97,7 +97,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
97
97
  * @summary Get eSIM MAC
98
98
  * @description Get MAC from eSIM
99
99
 
100
- * @param iccid Needed input variable
100
+ * @param iccid ID of the eSIM
101
101
  * @returns {Promise<GetEsimMacResponse>} - The promise with the result
102
102
  */
103
103
  async getEsimMac(iccid) {
package/dist/umd/services/packages/Packages.d.ts CHANGED
@@ -6,14 +6,14 @@ export declare class PackagesService extends BaseService {
6
6
  * @description List of available packages
7
7
 
8
8
  * @param optionalParams - Optional parameters
9
- * @param optionalParams.destination - Needed input variable
10
- * @param optionalParams.startDate - Needed input variable
11
- * @param optionalParams.endDate - Needed input variable
12
- * @param optionalParams.afterCursor - Needed input variable
13
- * @param optionalParams.limit - Needed input variable
14
- * @param optionalParams.startTime - Needed input variable
15
- * @param optionalParams.endTime - Needed input variable
16
- * @param optionalParams.duration - Needed input variable
9
+ * @param optionalParams.destination - ISO representation of the package's destination. Optional, unless startDate and endDate are used, then it becomes mandatory.
10
+ * @param optionalParams.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.
11
+ * @param optionalParams.endDate - End date of the package's validity in the format 'yyyy-MM-dd'. End date can be maximum 60 days after Start date.
12
+ * @param optionalParams.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.
13
+ * @param optionalParams.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
14
+ * @param optionalParams.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
15
+ * @param optionalParams.endTime - Epoch value representing the end time of the package's validity. End time can be maximum 60 days after Start time
16
+ * @param optionalParams.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 60 days
17
17
  * @returns {Promise<ListPackagesResponse>} - The promise with the result
18
18
  */
19
19
  listPackages(optionalParams?: {
package/dist/umd/services/packages/Packages.js CHANGED
@@ -23,14 +23,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
23
23
  * @description List of available packages
24
24
 
25
25
  * @param optionalParams - Optional parameters
26
- * @param optionalParams.destination - Needed input variable
27
- * @param optionalParams.startDate - Needed input variable
28
- * @param optionalParams.endDate - Needed input variable
29
- * @param optionalParams.afterCursor - Needed input variable
30
- * @param optionalParams.limit - Needed input variable
31
- * @param optionalParams.startTime - Needed input variable
32
- * @param optionalParams.endTime - Needed input variable
33
- * @param optionalParams.duration - Needed input variable
26
+ * @param optionalParams.destination - ISO representation of the package's destination. Optional, unless startDate and endDate are used, then it becomes mandatory.
27
+ * @param optionalParams.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.
28
+ * @param optionalParams.endDate - End date of the package's validity in the format 'yyyy-MM-dd'. End date can be maximum 60 days after Start date.
29
+ * @param optionalParams.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.
30
+ * @param optionalParams.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
31
+ * @param optionalParams.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
32
+ * @param optionalParams.endTime - Epoch value representing the end time of the package's validity. End time can be maximum 60 days after Start time
33
+ * @param optionalParams.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 60 days
34
34
  * @returns {Promise<ListPackagesResponse>} - The promise with the result
35
35
  */
36
36
  async listPackages(optionalParams = {}) {
package/dist/umd/services/purchases/Purchases.d.ts CHANGED
@@ -13,11 +13,11 @@ export declare class PurchasesService extends BaseService {
13
13
  * @description This endpoint can be used to list all the successful purchases made between a given interval.
14
14
 
15
15
  * @param optionalParams - Optional parameters
16
- * @param optionalParams.iccid - Needed input variable
16
+ * @param optionalParams.iccid - ID of the eSIM
17
17
  * @param optionalParams.afterDate - Start date of the interval for filtering purchases in the format 'yyyy-MM-dd'
18
18
  * @param optionalParams.beforeDate - End date of the interval for filtering purchases in the format 'yyyy-MM-dd'
19
- * @param optionalParams.afterCursor - Needed input variable
20
- * @param optionalParams.limit - Needed input variable
19
+ * @param optionalParams.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.
20
+ * @param optionalParams.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
21
21
  * @param optionalParams.after - Epoch value representing the start of the time interval for filtering purchases
22
22
  * @param optionalParams.before - Epoch value representing the end of the time interval for filtering purchases
23
23
  * @returns {Promise<ListPurchasesResponse>} - The promise with the result
@@ -56,7 +56,7 @@ export declare class PurchasesService extends BaseService {
56
56
  * @summary Get Purchase Consumption
57
57
  * @description 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.
58
58
 
59
- * @param purchaseId Needed input variable
59
+ * @param purchaseId ID of the purchase
60
60
  * @returns {Promise<GetPurchaseConsumptionResponse>} - The promise with the result
61
61
  */
62
62
  getPurchaseConsumption(purchaseId: string): Promise<GetPurchaseConsumptionResponse>;
package/dist/umd/services/purchases/Purchases.js CHANGED
@@ -23,11 +23,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
23
23
  * @description This endpoint can be used to list all the successful purchases made between a given interval.
24
24
 
25
25
  * @param optionalParams - Optional parameters
26
- * @param optionalParams.iccid - Needed input variable
26
+ * @param optionalParams.iccid - ID of the eSIM
27
27
  * @param optionalParams.afterDate - Start date of the interval for filtering purchases in the format 'yyyy-MM-dd'
28
28
  * @param optionalParams.beforeDate - End date of the interval for filtering purchases in the format 'yyyy-MM-dd'
29
- * @param optionalParams.afterCursor - Needed input variable
30
- * @param optionalParams.limit - Needed input variable
29
+ * @param optionalParams.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.
30
+ * @param optionalParams.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
31
31
  * @param optionalParams.after - Epoch value representing the start of the time interval for filtering purchases
32
32
  * @param optionalParams.before - Epoch value representing the end of the time interval for filtering purchases
33
33
  * @returns {Promise<ListPurchasesResponse>} - The promise with the result
@@ -130,7 +130,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
130
130
  * @summary Get Purchase Consumption
131
131
  * @description 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.
132
132
 
133
- * @param purchaseId Needed input variable
133
+ * @param purchaseId ID of the purchase
134
134
  * @returns {Promise<GetPurchaseConsumptionResponse>} - The promise with the result
135
135
  */
136
136
  async getPurchaseConsumption(purchaseId) {
package/package.json CHANGED
@@ -48,7 +48,7 @@
48
48
  },
49
49
  "name": "celitech-sdk",
50
50
  "description": "Celitech - Welcome to the CELITECH API documentation! Useful links: [Homepage](https://www.celitech.com) | [Support email](mailto:support@celitech.com) | [Blog](https://www.celitech.com/blog/) ",
51
- "version": "1.1.48",
51
+ "version": "1.1.49",
52
52
  "author": "Celitech",
53
53
  "dependencies": {
54
54
  "axios": "^1.0.0"