celitech-sdk - npm Package Compare versions

Comparing version 1.1.60 to 1.1.64

dist/commonjs/http/HTTPLibrary.js

@@ -97,3 +97,3 @@ "use strict";
     getUserAgentHeader() {
-        const userAgentBase = 'Celitech/1.1.60';
+        const userAgentBase = 'Celitech/1.1.64';
         let userAgent = '';
@@ -100,0 +100,0 @@ if (typeof window !== 'undefined') {

dist/commonjs/services/destinations/Destinations.d.ts

@@ -6,3 +6,3 @@ import BaseService from '../../BaseService';
      * @summary List Destinations
-     * @description Name of the destinations
+     * @description List Destinations
   
@@ -9,0 +9,0 @@ * @returns {Promise<ListDestinationsResponse>} - The promise with the result

dist/commonjs/services/destinations/Destinations.js

@@ -13,3 +13,3 @@ "use strict";
      * @summary List Destinations
-     * @description Name of the destinations
+     * @description List Destinations
   
@@ -16,0 +16,0 @@ * @returns {Promise<ListDestinationsResponse>} - The promise with the result

dist/commonjs/services/destinations/models/ListDestinationsResponse.d.ts

@@ -11,2 +11,5 @@ export interface ListDestinationsResponse {
         destination?: string;
+        /**
+         * This array indicates the geographical area covered by a specific destination. If the destination represents a single country, the array will include that country. However, if the destination represents a broader regional scope, the array will be populated with the names of the countries belonging to that region.
+         */
         supportedCountries?: string[];
@@ -13,0 +16,0 @@ }[];

dist/commonjs/services/eSim/ESim.d.ts

@@ -9,3 +9,3 @@ import BaseService from '../../BaseService';
      * @summary Get eSIM Status
-     * @description Get status from eSIM
+     * @description Get eSIM Status
   
@@ -18,3 +18,3 @@ * @param iccid ID of the eSIM
      * @summary Get eSIM Device
-     * @description Get device info from an installed eSIM
+     * @description Get eSIM Device
   
@@ -27,3 +27,3 @@ * @param iccid ID of the eSIM
      * @summary Get eSIM History
-     * @description Get history from an eSIM
+     * @description Get eSIM History
   
@@ -36,3 +36,3 @@ * @param iccid ID of the eSIM
      * @summary Get eSIM MAC
-     * @description Get MAC from eSIM
+     * @description Get eSIM MAC
   
@@ -39,0 +39,0 @@ * @param iccid ID of the eSIM

dist/commonjs/services/eSim/ESim.js

@@ -14,3 +14,3 @@ "use strict";
      * @summary Get eSIM Status
-     * @description Get status from eSIM
+     * @description Get eSIM Status
   
@@ -42,3 +42,3 @@ * @param iccid ID of the eSIM
      * @summary Get eSIM Device
-     * @description Get device info from an installed eSIM
+     * @description Get eSIM Device
   
@@ -67,3 +67,3 @@ * @param iccid ID of the eSIM
      * @summary Get eSIM History
-     * @description Get history from an eSIM
+     * @description Get eSIM History
   
@@ -92,3 +92,3 @@ * @param iccid ID of the eSIM
      * @summary Get eSIM MAC
-     * @description Get MAC from eSIM
+     * @description Get eSIM MAC
   
@@ -95,0 +95,0 @@ * @param iccid ID of the eSIM

dist/commonjs/services/packages/Packages.d.ts

@@ -6,3 +6,3 @@ import BaseService from '../../BaseService';
      * @summary List Packages
-     * @description List of available packages
+     * @description List Packages
   
@@ -9,0 +9,0 @@ * @param optionalParams - Optional parameters

dist/commonjs/services/packages/Packages.js

@@ -14,3 +14,3 @@ "use strict";
      * @summary List Packages
-     * @description List of available packages
+     * @description List Packages
   
@@ -17,0 +17,0 @@ * @param optionalParams - Optional parameters

dist/commonjs/services/purchases/models/CreatePurchaseRequest.d.ts

@@ -23,2 +23,6 @@ export interface CreatePurchaseRequest {
     /**
+     * An identifier provided by the partner to link this purchase to their booking or transaction for analytics and debugging purposes.
+     */
+    referenceId?: string;
+    /**
      * Customize the network brand of the issued eSIM. This parameter is accessible to platforms with Diamond tier and requires an alphanumeric string of up to 15 characters
@@ -25,0 +29,0 @@ */

dist/commonjs/services/purchases/models/ListPurchasesResponse.d.ts

@@ -36,5 +36,9 @@ export interface ListPurchasesResponse {
         /**
-         * The source indicates where the eSIM was purchased, which can be from the API, dashboard, or landing-page. For purchases made before September 8, 2023, the value will be displayed as 'Not available'.
+         * The source indicates where the eSIM was purchased, which can be from the API, dashboard, landing-page or promo-page. For purchases made before September 8, 2023, the value will be displayed as 'Not available'.
          */
         source?: string;
+        /**
+         * The referenceId that was provided by the partner during the purchase or topup flow. This identifier can be used for analytics and debugging purposes.
+         */
+        referenceId?: string;
         package_?: Package_;
@@ -41,0 +45,0 @@ }[];

dist/commonjs/services/purchases/models/TopUpEsimRequest.d.ts

@@ -23,2 +23,6 @@ export interface TopUpEsimRequest {
     /**
+     * An identifier provided by the partner to link this purchase to their booking or transaction for analytics and debugging purposes.
+     */
+    referenceId?: string;
+    /**
      * @deprecated
@@ -25,0 +29,0 @@ * 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.

dist/commonjs/services/purchases/Purchases.d.ts

@@ -19,2 +19,3 @@ import BaseService from '../../BaseService';
      * @param optionalParams.beforeDate - End date of the interval for filtering purchases in the format 'yyyy-MM-dd'
+     * @param optionalParams.referenceId - The referenceId that was provided by the partner during the purchase or topup flow.
      * @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,2 +31,3 @@ * @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
         beforeDate?: string;
+        referenceId?: string;
         afterCursor?: string;
@@ -32,0 +34,0 @@ limit?: number;

dist/commonjs/services/purchases/Purchases.js

@@ -20,2 +20,3 @@ "use strict";
      * @param optionalParams.beforeDate - End date of the interval for filtering purchases in the format 'yyyy-MM-dd'
+     * @param optionalParams.referenceId - The referenceId that was provided by the partner during the purchase or topup flow.
      * @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.
@@ -28,3 +29,3 @@ * @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
     async listPurchases(optionalParams = {}) {
-        const { iccid, afterDate, beforeDate, afterCursor, limit, after, before } = optionalParams;
+        const { iccid, afterDate, beforeDate, referenceId, afterCursor, limit, after, before } = optionalParams;
         const queryParams = [];
@@ -41,2 +42,5 @@ const headers = {};
         }
+        if (referenceId) {
+            queryParams.push((0, QuerySerializer_1.serializeQuery)('form', true, 'referenceId', referenceId));
+        }
         if (afterCursor) {
@@ -43,0 +47,0 @@ queryParams.push((0, QuerySerializer_1.serializeQuery)('form', true, 'afterCursor', afterCursor));

dist/esm/http/HTTPLibrary.js

@@ -92,3 +92,3 @@ import axios from 'axios';
     getUserAgentHeader() {
-        const userAgentBase = 'Celitech/1.1.60';
+        const userAgentBase = 'Celitech/1.1.64';
         let userAgent = '';
@@ -95,0 +95,0 @@ if (typeof window !== 'undefined') {

dist/esm/services/destinations/Destinations.d.ts

@@ -6,3 +6,3 @@ import BaseService from '../../BaseService';
      * @summary List Destinations
-     * @description Name of the destinations
+     * @description List Destinations
   
@@ -9,0 +9,0 @@ * @returns {Promise<ListDestinationsResponse>} - The promise with the result

dist/esm/services/destinations/Destinations.js

@@ -7,3 +7,3 @@ import BaseService from '../../BaseService';
      * @summary List Destinations
-     * @description Name of the destinations
+     * @description List Destinations
   
@@ -10,0 +10,0 @@ * @returns {Promise<ListDestinationsResponse>} - The promise with the result

dist/esm/services/destinations/models/ListDestinationsResponse.d.ts

@@ -11,2 +11,5 @@ export interface ListDestinationsResponse {
         destination?: string;
+        /**
+         * This array indicates the geographical area covered by a specific destination. If the destination represents a single country, the array will include that country. However, if the destination represents a broader regional scope, the array will be populated with the names of the countries belonging to that region.
+         */
         supportedCountries?: string[];
@@ -13,0 +16,0 @@ }[];

dist/esm/services/eSim/ESim.d.ts

@@ -9,3 +9,3 @@ import BaseService from '../../BaseService';
      * @summary Get eSIM Status
-     * @description Get status from eSIM
+     * @description Get eSIM Status
   
@@ -18,3 +18,3 @@ * @param iccid ID of the eSIM
      * @summary Get eSIM Device
-     * @description Get device info from an installed eSIM
+     * @description Get eSIM Device
   
@@ -27,3 +27,3 @@ * @param iccid ID of the eSIM
      * @summary Get eSIM History
-     * @description Get history from an eSIM
+     * @description Get eSIM History
   
@@ -36,3 +36,3 @@ * @param iccid ID of the eSIM
      * @summary Get eSIM MAC
-     * @description Get MAC from eSIM
+     * @description Get eSIM MAC
   
@@ -39,0 +39,0 @@ * @param iccid ID of the eSIM

dist/esm/services/eSim/ESim.js

@@ -8,3 +8,3 @@ import BaseService from '../../BaseService';
      * @summary Get eSIM Status
-     * @description Get status from eSIM
+     * @description Get eSIM Status
   
@@ -36,3 +36,3 @@ * @param iccid ID of the eSIM
      * @summary Get eSIM Device
-     * @description Get device info from an installed eSIM
+     * @description Get eSIM Device
   
@@ -61,3 +61,3 @@ * @param iccid ID of the eSIM
      * @summary Get eSIM History
-     * @description Get history from an eSIM
+     * @description Get eSIM History
   
@@ -86,3 +86,3 @@ * @param iccid ID of the eSIM
      * @summary Get eSIM MAC
-     * @description Get MAC from eSIM
+     * @description Get eSIM MAC
   
@@ -89,0 +89,0 @@ * @param iccid ID of the eSIM

dist/esm/services/packages/Packages.d.ts

@@ -6,3 +6,3 @@ import BaseService from '../../BaseService';
      * @summary List Packages
-     * @description List of available packages
+     * @description List Packages
   
@@ -9,0 +9,0 @@ * @param optionalParams - Optional parameters

dist/esm/services/packages/Packages.js

@@ -8,3 +8,3 @@ import BaseService from '../../BaseService';
      * @summary List Packages
-     * @description List of available packages
+     * @description List Packages
   
@@ -11,0 +11,0 @@ * @param optionalParams - Optional parameters

dist/esm/services/purchases/models/CreatePurchaseRequest.d.ts

@@ -23,2 +23,6 @@ export interface CreatePurchaseRequest {
     /**
+     * An identifier provided by the partner to link this purchase to their booking or transaction for analytics and debugging purposes.
+     */
+    referenceId?: string;
+    /**
      * Customize the network brand of the issued eSIM. This parameter is accessible to platforms with Diamond tier and requires an alphanumeric string of up to 15 characters
@@ -25,0 +29,0 @@ */

dist/esm/services/purchases/models/ListPurchasesResponse.d.ts

@@ -36,5 +36,9 @@ export interface ListPurchasesResponse {
         /**
-         * The source indicates where the eSIM was purchased, which can be from the API, dashboard, or landing-page. For purchases made before September 8, 2023, the value will be displayed as 'Not available'.
+         * The source indicates where the eSIM was purchased, which can be from the API, dashboard, landing-page or promo-page. For purchases made before September 8, 2023, the value will be displayed as 'Not available'.
          */
         source?: string;
+        /**
+         * The referenceId that was provided by the partner during the purchase or topup flow. This identifier can be used for analytics and debugging purposes.
+         */
+        referenceId?: string;
         package_?: Package_;
@@ -41,0 +45,0 @@ }[];

dist/esm/services/purchases/models/TopUpEsimRequest.d.ts

@@ -23,2 +23,6 @@ export interface TopUpEsimRequest {
     /**
+     * An identifier provided by the partner to link this purchase to their booking or transaction for analytics and debugging purposes.
+     */
+    referenceId?: string;
+    /**
      * @deprecated
@@ -25,0 +29,0 @@ * 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.

dist/esm/services/purchases/Purchases.d.ts

@@ -19,2 +19,3 @@ import BaseService from '../../BaseService';
      * @param optionalParams.beforeDate - End date of the interval for filtering purchases in the format 'yyyy-MM-dd'
+     * @param optionalParams.referenceId - The referenceId that was provided by the partner during the purchase or topup flow.
      * @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,2 +31,3 @@ * @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
         beforeDate?: string;
+        referenceId?: string;
         afterCursor?: string;
@@ -32,0 +34,0 @@ limit?: number;

dist/esm/services/purchases/Purchases.js

@@ -14,2 +14,3 @@ import BaseService from '../../BaseService';
      * @param optionalParams.beforeDate - End date of the interval for filtering purchases in the format 'yyyy-MM-dd'
+     * @param optionalParams.referenceId - The referenceId that was provided by the partner during the purchase or topup flow.
      * @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.
@@ -22,3 +23,3 @@ * @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
     async listPurchases(optionalParams = {}) {
-        const { iccid, afterDate, beforeDate, afterCursor, limit, after, before } = optionalParams;
+        const { iccid, afterDate, beforeDate, referenceId, afterCursor, limit, after, before } = optionalParams;
         const queryParams = [];
@@ -35,2 +36,5 @@ const headers = {};
         }
+        if (referenceId) {
+            queryParams.push(serializeQuery('form', true, 'referenceId', referenceId));
+        }
         if (afterCursor) {
@@ -37,0 +41,0 @@ queryParams.push(serializeQuery('form', true, 'afterCursor', afterCursor));

dist/umd/http/HTTPLibrary.js

@@ -106,3 +106,3 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
         getUserAgentHeader() {
-            const userAgentBase = 'Celitech/1.1.60';
+            const userAgentBase = 'Celitech/1.1.64';
             let userAgent = '';
@@ -109,0 +109,0 @@ if (typeof window !== 'undefined') {

dist/umd/services/destinations/Destinations.d.ts

@@ -6,3 +6,3 @@ import BaseService from '../../BaseService';
      * @summary List Destinations
-     * @description Name of the destinations
+     * @description List Destinations
   
@@ -9,0 +9,0 @@ * @returns {Promise<ListDestinationsResponse>} - The promise with the result

dist/umd/services/destinations/Destinations.js

@@ -22,3 +22,3 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
          * @summary List Destinations
-         * @description Name of the destinations
+         * @description List Destinations
       
@@ -25,0 +25,0 @@ * @returns {Promise<ListDestinationsResponse>} - The promise with the result

dist/umd/services/destinations/models/ListDestinationsResponse.d.ts

@@ -11,2 +11,5 @@ export interface ListDestinationsResponse {
         destination?: string;
+        /**
+         * This array indicates the geographical area covered by a specific destination. If the destination represents a single country, the array will include that country. However, if the destination represents a broader regional scope, the array will be populated with the names of the countries belonging to that region.
+         */
         supportedCountries?: string[];
@@ -13,0 +16,0 @@ }[];

dist/umd/services/eSim/ESim.d.ts

@@ -9,3 +9,3 @@ import BaseService from '../../BaseService';
      * @summary Get eSIM Status
-     * @description Get status from eSIM
+     * @description Get eSIM Status
   
@@ -18,3 +18,3 @@ * @param iccid ID of the eSIM
      * @summary Get eSIM Device
-     * @description Get device info from an installed eSIM
+     * @description Get eSIM Device
   
@@ -27,3 +27,3 @@ * @param iccid ID of the eSIM
      * @summary Get eSIM History
-     * @description Get history from an eSIM
+     * @description Get eSIM History
   
@@ -36,3 +36,3 @@ * @param iccid ID of the eSIM
      * @summary Get eSIM MAC
-     * @description Get MAC from eSIM
+     * @description Get eSIM MAC
   
@@ -39,0 +39,0 @@ * @param iccid ID of the eSIM

dist/umd/services/eSim/ESim.js

@@ -23,3 +23,3 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
          * @summary Get eSIM Status
-         * @description Get status from eSIM
+         * @description Get eSIM Status
       
@@ -51,3 +51,3 @@ * @param iccid ID of the eSIM
          * @summary Get eSIM Device
-         * @description Get device info from an installed eSIM
+         * @description Get eSIM Device
       
@@ -76,3 +76,3 @@ * @param iccid ID of the eSIM
          * @summary Get eSIM History
-         * @description Get history from an eSIM
+         * @description Get eSIM History
       
@@ -101,3 +101,3 @@ * @param iccid ID of the eSIM
          * @summary Get eSIM MAC
-         * @description Get MAC from eSIM
+         * @description Get eSIM MAC
       
@@ -104,0 +104,0 @@ * @param iccid ID of the eSIM

dist/umd/services/packages/Packages.d.ts

@@ -6,3 +6,3 @@ import BaseService from '../../BaseService';
      * @summary List Packages
-     * @description List of available packages
+     * @description List Packages
   
@@ -9,0 +9,0 @@ * @param optionalParams - Optional parameters

dist/umd/services/packages/Packages.js

@@ -23,3 +23,3 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
          * @summary List Packages
-         * @description List of available packages
+         * @description List Packages
       
@@ -26,0 +26,0 @@ * @param optionalParams - Optional parameters

dist/umd/services/purchases/models/CreatePurchaseRequest.d.ts

@@ -23,2 +23,6 @@ export interface CreatePurchaseRequest {
     /**
+     * An identifier provided by the partner to link this purchase to their booking or transaction for analytics and debugging purposes.
+     */
+    referenceId?: string;
+    /**
      * Customize the network brand of the issued eSIM. This parameter is accessible to platforms with Diamond tier and requires an alphanumeric string of up to 15 characters
@@ -25,0 +29,0 @@ */

dist/umd/services/purchases/models/ListPurchasesResponse.d.ts

@@ -36,5 +36,9 @@ export interface ListPurchasesResponse {
         /**
-         * The source indicates where the eSIM was purchased, which can be from the API, dashboard, or landing-page. For purchases made before September 8, 2023, the value will be displayed as 'Not available'.
+         * The source indicates where the eSIM was purchased, which can be from the API, dashboard, landing-page or promo-page. For purchases made before September 8, 2023, the value will be displayed as 'Not available'.
          */
         source?: string;
+        /**
+         * The referenceId that was provided by the partner during the purchase or topup flow. This identifier can be used for analytics and debugging purposes.
+         */
+        referenceId?: string;
         package_?: Package_;
@@ -41,0 +45,0 @@ }[];

dist/umd/services/purchases/models/TopUpEsimRequest.d.ts

@@ -23,2 +23,6 @@ export interface TopUpEsimRequest {
     /**
+     * An identifier provided by the partner to link this purchase to their booking or transaction for analytics and debugging purposes.
+     */
+    referenceId?: string;
+    /**
      * @deprecated
@@ -25,0 +29,0 @@ * 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.

dist/umd/services/purchases/Purchases.d.ts

@@ -19,2 +19,3 @@ import BaseService from '../../BaseService';
      * @param optionalParams.beforeDate - End date of the interval for filtering purchases in the format 'yyyy-MM-dd'
+     * @param optionalParams.referenceId - The referenceId that was provided by the partner during the purchase or topup flow.
      * @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,2 +31,3 @@ * @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
         beforeDate?: string;
+        referenceId?: string;
         afterCursor?: string;
@@ -32,0 +34,0 @@ limit?: number;

dist/umd/services/purchases/Purchases.js

@@ -29,2 +29,3 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
          * @param optionalParams.beforeDate - End date of the interval for filtering purchases in the format 'yyyy-MM-dd'
+         * @param optionalParams.referenceId - The referenceId that was provided by the partner during the purchase or topup flow.
          * @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.
@@ -37,3 +38,3 @@ * @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
         async listPurchases(optionalParams = {}) {
-            const { iccid, afterDate, beforeDate, afterCursor, limit, after, before } = optionalParams;
+            const { iccid, afterDate, beforeDate, referenceId, afterCursor, limit, after, before } = optionalParams;
             const queryParams = [];
@@ -50,2 +51,5 @@ const headers = {};
             }
+            if (referenceId) {
+                queryParams.push((0, QuerySerializer_1.serializeQuery)('form', true, 'referenceId', referenceId));
+            }
             if (afterCursor) {
@@ -52,0 +56,0 @@ queryParams.push((0, QuerySerializer_1.serializeQuery)('form', true, 'afterCursor', afterCursor));

package.json

@@ -51,3 +51,3 @@ {
   "description": "Celitech - Welcome to the CELITECH API documentation!  Useful links: [Homepage](https://www.celitech.com) | [Support email](mailto:[e-mail]) | [Blog](https://www.celitech.com/blog/) ",
-  "version": "1.1.60",
+  "version": "1.1.64",
   "author": "Celitech",
@@ -54,0 +54,0 @@ "dependencies": {

README.md

@@ -1,7 +0,7 @@
-# Celitech Typescript SDK 1.1.60
+# Celitech Typescript SDK 1.1.64
 
 The Typescript SDK for Celitech.
 
-- API version: 1.1.60
-- SDK version: 1.1.60
+- API version: 1.1.64
+- SDK version: 1.1.64
 
@@ -234,2 +234,3 @@ ## Table of Contents
 | beforeDate  | string | End date of the interval for filtering purchases in the format 'yyyy-MM-dd'                                                                                                                                         |
+| referenceId | string | The referenceId that was provided by the partner during the purchase or topup flow.                                                                                                                                 |
 | 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. |
@@ -236,0 +237,0 @@ | 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                                                |

No alert changes

Improved metrics

Total package byte prevSize

589752

increased by0.84%

Lines of code

7936

increased by0.84%

Number of lines in readme file

485

increased by0.21%

No dependency changes