celitech-sdk 2.0.4 → 2.0.6

package/README.md

@@ -1,11 +1,11 @@
-# Celitech TypeScript SDK 2.0.4
+# Celitech TypeScript SDK 2.0.6
 
 Welcome to the Celitech SDK documentation. This guide will help you get started with integrating and using the Celitech SDK in your project.
 
 ## Versions
 
-- API version: `2.0.4`
-- SDK version: `2.0.4`
+- API version: `2.0.6`
+- SDK version: `2.0.6`
 
 ## About the API
 

package/dist/index.d.ts

@@ -854,12 +854,14 @@ type ListPackagesOkResponse = z.infer<typeof listPackagesOkResponse>;
 
 interface ListPackagesParams {
     destination?: string;
+    dataLimitInGb?: number;
     startDate?: string;
     endDate?: string;
     afterCursor?: string;
     limit?: number;
     startTime?: number;
     endTime?: number;
+    includeUnlimited?: boolean;
 }
 
 /**
@@ -878,12 +880,14 @@ declare class PackagesService extends BaseService {
     /**
      * List Packages
      * @param {string} [params.destination] - ISO representation of the package's destination. Supports both ISO2 (e.g., 'FR') and ISO3 (e.g., 'FRA') country codes.
+     * @param {number} [params.dataLimitInGb] - Filter packages by data limit in GB. When provided, only packages with this exact data limit are returned. Use `-1` together with `includeUnlimited=true` to return only unlimited packages. A value of `0` is ignored.
      * @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.
      * @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.
      * @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.
      * @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
      * @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
      * @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
+     * @param {boolean} [params.includeUnlimited] - Whether to include unlimited (date-based) packages in the results. Unlimited packages are excluded by default; set this to `true` to include them. An unlimited package has `dataLimitInGB` and `dataLimitInBytes` equal to `-1`, and is offered for 3 to 30 days with `minDays` equal to `maxDays`.
      * @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
      * @returns {Promise<HttpResponse<ListPackagesOkResponse>>} - Successful Response
      */
@@ -929,8 +933,8 @@ declare const packages: z.ZodLazy<z.ZodObject<{
  * @property {string} - ID of the package
  * @property {string} - ISO3 representation of the package's destination.
  * @property {string} - ISO2 representation of the package's destination.
- * @property {number} - Size of the package in Bytes
- * @property {number} - Size of the package in GB
+ * @property {number} - Size of the package in Bytes. A value of `-1` indicates an unlimited package.
+ * @property {number} - Size of the package in GB. A value of `-1` indicates an unlimited (date-based) package.
  * @property {number} - Min number of days for the package
  * @property {number} - Max number of days for the package
  * @property {number} - Price of the package in cents
@@ -983,10 +987,10 @@ declare const createPurchaseV2Request: z.ZodLazy<z.ZodObject<{
  *
  * @typedef  {CreatePurchaseV2Request} createPurchaseV2Request
  * @property {string} - ISO representation of the package's destination. Supports both ISO2 (e.g., 'FR') and ISO3 (e.g., 'FRA') country codes.
- * @property {number} - Size of the package in GB. The available options are 0.5, 1, 2, 3, 5, 8, 20, 50GB
+ * @property {number} - Size of the package in GB. The available options are 0.5, 1, 2, 3, 5, 8, 20, 50GB. Use `-1` to purchase an unlimited (date-based) package — provide `startDate`/`endDate` spanning 3 to 30 days (`duration` is not supported for unlimited packages).
  * @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.
  * @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.
- * @property {number} - Duration of the package in days. Available values are 1, 2, 7, 14, 30, or 90. Either provide startDate/endDate or duration.
+ * @property {number} - Duration of the package in days. Available values are 1, 2, 7, 14, 30, or 90. Either provide startDate/endDate or duration. Not supported for unlimited packages (`dataLimitInGB` = -1), which are date-based — provide startDate/endDate instead.
  * @property {number} - Number of eSIMs to purchase.
  * @property {string} - Email address where the purchase confirmation email will be sent (including QR Code & activation steps)
  * @property {string} - An identifier provided by the partner to link this purchase to their booking or transaction for analytics and debugging purposes.
@@ -1291,7 +1295,7 @@ declare const createPurchaseRequest: z.ZodLazy<z.ZodObject<{
  *
  * @typedef  {CreatePurchaseRequest} createPurchaseRequest
  * @property {string} - ISO representation of the package's destination. Supports both ISO2 (e.g., 'FR') and ISO3 (e.g., 'FRA') country codes.
- * @property {number} - Size of the package in GB. The available options are 0.5, 1, 2, 3, 5, 8, 20, 50GB
+ * @property {number} - Size of the package in GB. The available options are 0.5, 1, 2, 3, 5, 8, 20, 50GB. Use `-1` to purchase an unlimited (date-based) package — provide `startDate`/`endDate` spanning 3 to 30 days.
  * @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.
  * @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.
  * @property {string} - Email address where the purchase confirmation email will be sent (including QR Code & activation steps)
@@ -1430,10 +1434,10 @@ declare const topUpEsimRequest: z.ZodLazy<z.ZodObject<{
  *
  * @typedef  {TopUpEsimRequest} topUpEsimRequest
  * @property {string} - ID of the eSIM
- * @property {number} - Size of the package in GB. The available options are 0.5, 1, 2, 3, 5, 8, 20, 50GB
+ * @property {number} - Size of the package in GB. The available options are 0.5, 1, 2, 3, 5, 8, 20, 50GB. Use `-1` to top up with an unlimited (date-based) package — provide `startDate`/`endDate` spanning 3 to 30 days (`duration` is not supported for unlimited packages).
  * @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.
  * @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.
- * @property {number} - Duration of the package in days. Available values are 1, 2, 7, 14, 30, or 90. Either provide startDate/endDate or duration.
+ * @property {number} - Duration of the package in days. Available values are 1, 2, 7, 14, 30, or 90. Either provide startDate/endDate or duration. Not supported for unlimited packages (`dataLimitInGB` = -1), which are date-based — provide startDate/endDate instead.
  * @property {string} - Email address where the purchase confirmation email will be sent (excluding QR Code & activation steps).
  * @property {string} - An identifier provided by the partner to link this purchase to their booking or transaction for analytics and debugging purposes.
  * @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.
@@ -1606,8 +1610,8 @@ declare const getPurchaseConsumptionOkResponse: z.ZodLazy<z.ZodObject<{
 /**
  *
  * @typedef  {GetPurchaseConsumptionOkResponse} getPurchaseConsumptionOkResponse
- * @property {number} - Remaining balance of the package in bytes
- * @property {number} - Remaining balance of the package in GB
+ * @property {number} - Remaining balance of the package in bytes. Returns `-1` for unlimited packages.
+ * @property {number} - Remaining balance of the package in GB. Returns `-1` for unlimited packages.
  * @property {string} - Status of the connectivity, possible values are 'ACTIVE' or 'NOT_ACTIVE'
  */
 type GetPurchaseConsumptionOkResponse = z.infer<typeof getPurchaseConsumptionOkResponse>;
@@ -1890,7 +1894,7 @@ declare const purchases: z.ZodLazy<z.ZodObject<{
  * @property {string} - ID of the purchase
  * @property {string} - Start date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'
  * @property {string} - End date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'
- * @property {number} - Duration of the package in days. Possible values are 1, 2, 7, 14, 30, or 90.
+ * @property {number} - Duration of the package in days. Possible values are 1, 2, 7, 14, 30, or 90. `null` for unlimited (date-based) packages.
  * @property {string} - Creation date of the purchase in the format 'yyyy-MM-ddThh:mm:ssZZ'
  * @property {number} - Epoch value representing the start time of the package's validity
  * @property {number} - Epoch value representing the end time of the package's validity
@@ -1937,8 +1941,8 @@ declare const package_: z.ZodLazy<z.ZodObject<{
  *
  * @typedef  {Package_} package_
  * @property {string} - ID of the package
- * @property {number} - Size of the package in Bytes
- * @property {number} - Size of the package in GB
+ * @property {number} - Size of the package in Bytes. A value of `-1` indicates an unlimited package.
+ * @property {number} - Size of the package in GB. A value of `-1` indicates an unlimited (date-based) package.
  * @property {string} - ISO3 representation of the package's destination.
  * @property {string} - ISO2 representation of the package's destination.
  * @property {string} - Name of the package's destination

package/dist/index.js

@@ -1938,7 +1938,7 @@ var RequestBuilder = class {
     };
     this.addHeaderParam({
       key: "User-Agent",
-      value: "postman-codegen/1.5.0 celitech-sdk/2.0.4 (typescript)"
+      value: "postman-codegen/1.7.0 celitech-sdk/2.0.6 (typescript)"
     });
   }
   setConfig(config) {
@@ -2633,12 +2633,14 @@ var PackagesService = class extends BaseService {
   /**
    * List Packages
    * @param {string} [params.destination] - ISO representation of the package's destination. Supports both ISO2 (e.g., 'FR') and ISO3 (e.g., 'FRA') country codes.
+   * @param {number} [params.dataLimitInGb] - Filter packages by data limit in GB. When provided, only packages with this exact data limit are returned. Use `-1` together with `includeUnlimited=true` to return only unlimited packages. A value of `0` is ignored.
    * @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.
    * @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.
    * @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.
    * @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
    * @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
    * @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
+   * @param {boolean} [params.includeUnlimited] - Whether to include unlimited (date-based) packages in the results. Unlimited packages are excluded by default; set this to `true` to include them. An unlimited package has `dataLimitInGB` and `dataLimitInBytes` equal to `-1`, and is offered for 3 to 30 days with `minDays` equal to `maxDays`.
    * @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<ListPackagesOkResponse>>} - Successful Response
    */
@@ -2646,12 +2648,14 @@ var PackagesService = class extends BaseService {
     const resolvedConfig = this.getResolvedConfig(this.listPackagesConfig, requestConfig);
     import_zod13.z.object({
       destination: import_zod13.z.string().optional(),
+      dataLimitInGb: import_zod13.z.number().optional(),
       startDate: import_zod13.z.string().optional(),
       endDate: import_zod13.z.string().optional(),
       afterCursor: import_zod13.z.string().optional(),
       limit: import_zod13.z.number().optional(),
       startTime: import_zod13.z.number().optional(),
-      endTime: import_zod13.z.number().optional()
+      endTime: import_zod13.z.number().optional(),
+      includeUnlimited: import_zod13.z.boolean().optional()
     }).parse(params != null ? params : {});
     const request = new RequestBuilder().setConfig(resolvedConfig).setBaseUrl(resolvedConfig).setMethod("GET").setPath("/packages").setRequestSchema(import_zod13.z.any()).setScopes([]).setTokenManager(this.tokenManager).setRequestContentType("json" /* Json */).addResponse({
       schema: listPackagesOkResponseResponse,
@@ -2668,6 +2672,9 @@ var PackagesService = class extends BaseService {
     }).addQueryParam({
       key: "destination",
       value: params == null ? void 0 : params.destination
+    }).addQueryParam({
+      key: "dataLimitInGB",
+      value: params == null ? void 0 : params.dataLimitInGb
     }).addQueryParam({
       key: "startDate",
       value: params == null ? void 0 : params.startDate
@@ -2686,6 +2693,9 @@ var PackagesService = class extends BaseService {
     }).addQueryParam({
       key: "endTime",
       value: params == null ? void 0 : params.endTime
+    }).addQueryParam({
+      key: "includeUnlimited",
+      value: params == null ? void 0 : params.includeUnlimited
     }).build();
     return this.client.callDirect(request);
   }

package/dist/index.mjs

@@ -1892,7 +1892,7 @@ var RequestBuilder = class {
     };
     this.addHeaderParam({
       key: "User-Agent",
-      value: "postman-codegen/1.5.0 celitech-sdk/2.0.4 (typescript)"
+      value: "postman-codegen/1.7.0 celitech-sdk/2.0.6 (typescript)"
     });
   }
   setConfig(config) {
@@ -2587,12 +2587,14 @@ var PackagesService = class extends BaseService {
   /**
    * List Packages
    * @param {string} [params.destination] - ISO representation of the package's destination. Supports both ISO2 (e.g., 'FR') and ISO3 (e.g., 'FRA') country codes.
+   * @param {number} [params.dataLimitInGb] - Filter packages by data limit in GB. When provided, only packages with this exact data limit are returned. Use `-1` together with `includeUnlimited=true` to return only unlimited packages. A value of `0` is ignored.
    * @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.
    * @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.
    * @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.
    * @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
    * @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
    * @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
+   * @param {boolean} [params.includeUnlimited] - Whether to include unlimited (date-based) packages in the results. Unlimited packages are excluded by default; set this to `true` to include them. An unlimited package has `dataLimitInGB` and `dataLimitInBytes` equal to `-1`, and is offered for 3 to 30 days with `minDays` equal to `maxDays`.
    * @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<ListPackagesOkResponse>>} - Successful Response
    */
@@ -2600,12 +2602,14 @@ var PackagesService = class extends BaseService {
     const resolvedConfig = this.getResolvedConfig(this.listPackagesConfig, requestConfig);
     z11.object({
       destination: z11.string().optional(),
+      dataLimitInGb: z11.number().optional(),
       startDate: z11.string().optional(),
       endDate: z11.string().optional(),
       afterCursor: z11.string().optional(),
       limit: z11.number().optional(),
       startTime: z11.number().optional(),
-      endTime: z11.number().optional()
+      endTime: z11.number().optional(),
+      includeUnlimited: z11.boolean().optional()
     }).parse(params != null ? params : {});
     const request = new RequestBuilder().setConfig(resolvedConfig).setBaseUrl(resolvedConfig).setMethod("GET").setPath("/packages").setRequestSchema(z11.any()).setScopes([]).setTokenManager(this.tokenManager).setRequestContentType("json" /* Json */).addResponse({
       schema: listPackagesOkResponseResponse,
@@ -2622,6 +2626,9 @@ var PackagesService = class extends BaseService {
     }).addQueryParam({
       key: "destination",
       value: params == null ? void 0 : params.destination
+    }).addQueryParam({
+      key: "dataLimitInGB",
+      value: params == null ? void 0 : params.dataLimitInGb
     }).addQueryParam({
       key: "startDate",
       value: params == null ? void 0 : params.startDate
@@ -2640,6 +2647,9 @@ var PackagesService = class extends BaseService {
     }).addQueryParam({
       key: "endTime",
       value: params == null ? void 0 : params.endTime
+    }).addQueryParam({
+      key: "includeUnlimited",
+      value: params == null ? void 0 : params.includeUnlimited
     }).build();
     return this.client.callDirect(request);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "celitech-sdk",
-  "version": "2.0.4",
+  "version": "2.0.6",
   "description": "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/)",
   "source": "./src/index.ts",
   "main": "./dist/index.js",
@@ -36,7 +36,7 @@
     "tsup": "^6.7.0"
   },
   "dependencies": {
-    "zod": "3.22.0"
+    "zod": "3.22.3"
   },
   "exports": {
     ".": {