celitech-sdk 2.0.4 → 2.0.7

package/dist/index.d.ts

@@ -182,6 +182,20 @@ declare class ThrowableError extends Error {
      * @param response - Optional response data associated with the error
      */
     constructor(message: string, response?: unknown);
+    /**
+     * Creates an error instance from a response body.
+     * Parsing (which can throw) is kept out of the constructor so that constructing
+     * an error while handling an error response never throws. The base implementation
+     * simply constructs the instance; subclasses may override to populate typed fields.
+     *
+     * Contract: every subclass constructor must accept `(message, response?)`. The base
+     * uses `new this(message, response)`, so a subclass with a different constructor
+     * signature must override `from()`.
+     * @param message - The error message
+     * @param response - Optional response data associated with the error
+     * @returns A new error instance
+     */
+    static from(message: string, response?: unknown): ThrowableError;
     /**
      * Throws this error instance.
      * Convenience method for explicitly throwing the error.
@@ -207,8 +221,10 @@ interface ResponseDefinition {
  * Used to throw typed errors based on content type and status code.
  */
 interface ErrorDefinition {
-    /** Constructor for the error class to instantiate */
-    error: new (...args: any[]) => ThrowableError;
+    /** The error class to instantiate, exposing a static `from` factory */
+    error: (new (...args: any[]) => ThrowableError) & {
+        from(message: string, response?: unknown): ThrowableError;
+    };
     /** The content type of this error response */
     contentType: ContentType;
     /** The HTTP status code this error applies to */
@@ -469,8 +485,11 @@ interface CursorPaginatedHttpResponse<T = unknown> extends HttpResponse<T> {
 declare enum ContentType {
     /** JSON format (application/json) */
     Json = "json",
-    /** XML format (application/xml, text/xml) */
-    Xml = "xml",
+    /**
+     * @deprecated XML is handled as text. Use {@link ContentType.Text} instead.
+     * Kept as an alias for backward compatibility; will be removed in a future major version.
+     */
+    Xml = "text",
     /** PDF document (application/pdf) */
     Pdf = "pdf",
     /** Image file (image/*) */
@@ -496,6 +515,7 @@ interface RetryOptions {
     maxDelayMs?: number;
     backoffFactor?: number;
     jitterMs?: number;
+    maxRetryAfterDelayMs?: number;
     statusCodesToRetry?: number[];
     httpMethodsToRetry?: HttpMethod[];
 }
@@ -726,9 +746,8 @@ declare const listDestinationsOkResponse: z.ZodLazy<z.ZodObject<{
     }[];
 }>>;
 /**
- *
- * @typedef  {ListDestinationsOkResponse} listDestinationsOkResponse
- * @property {Destinations[]}
+ * @typedef {ListDestinationsOkResponse} listDestinationsOkResponse
+ * @property {Destinations[]} destinations
  */
 type ListDestinationsOkResponse = z.infer<typeof listDestinationsOkResponse>;
 
@@ -775,12 +794,11 @@ declare const destinations: z.ZodLazy<z.ZodObject<{
     supportedCountries: string[];
 }>>;
 /**
- *
- * @typedef  {Destinations} destinations
- * @property {string} - Name of the destination
- * @property {string} - ISO3 representation of the destination
- * @property {string} - ISO2 representation of the destination
- * @property {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.
+ * @typedef {Destinations} destinations
+ * @property {string} name - Name of the destination
+ * @property {string} destination - ISO3 representation of the destination
+ * @property {string} destinationIso2 - ISO2 representation of the destination
+ * @property {string[]} supportedCountries - 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.
  */
 type Destinations = z.infer<typeof destinations>;
 
@@ -845,21 +863,22 @@ declare const listPackagesOkResponse: z.ZodLazy<z.ZodObject<{
     afterCursor: string | null;
 }>>;
 /**
- *
- * @typedef  {ListPackagesOkResponse} listPackagesOkResponse
- * @property {Packages[]}
- * @property {string} - The cursor value representing the end of the current page of results. Use this cursor value as the "afterCursor" parameter in your next request to retrieve the subsequent page of results. It ensures that you continue fetching data from where you left off, facilitating smooth pagination
+ * @typedef {ListPackagesOkResponse} listPackagesOkResponse
+ * @property {Packages[]} packages
+ * @property {string} afterCursor - The cursor value representing the end of the current page of results. Use this cursor value as the "afterCursor" parameter in your next request to retrieve the subsequent page of results. It ensures that you continue fetching data from where you left off, facilitating smooth pagination
  */
 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 +897,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
      */
@@ -924,16 +945,15 @@ declare const packages: z.ZodLazy<z.ZodObject<{
     priceInCents: number;
 }>>;
 /**
- *
- * @typedef  {Packages} packages
- * @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} - Min number of days for the package
- * @property {number} - Max number of days for the package
- * @property {number} - Price of the package in cents
+ * @typedef {Packages} packages
+ * @property {string} id - ID of the package
+ * @property {string} destination - ISO3 representation of the package's destination.
+ * @property {string} destinationIso2 - ISO2 representation of the package's destination.
+ * @property {number} dataLimitInBytes - Size of the package in Bytes. A value of `-1` indicates an unlimited package.
+ * @property {number} dataLimitInGb - Size of the package in GB. A value of `-1` indicates an unlimited (date-based) package.
+ * @property {number} minDays - Min number of days for the package
+ * @property {number} maxDays - Max number of days for the package
+ * @property {number} priceInCents - Price of the package in cents
  */
 type Packages = z.infer<typeof packages>;
 
@@ -980,19 +1000,18 @@ declare const createPurchaseV2Request: z.ZodLazy<z.ZodObject<{
     language?: string | undefined;
 }>>;
 /**
- *
- * @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 {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} - 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.
- * @property {string} - Customize the network brand of the issued eSIM. The `networkBrand` parameter cannot exceed 15 characters in length and must contain only letters, numbers, dots (.), ampersands (&), and spaces. This feature is available to platforms with Diamond tier only.
- * @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.
- * @property {CreatePurchaseV2RequestLanguage} - Language of the confirmation email sent to the customer.
+ * @typedef {CreatePurchaseV2Request} createPurchaseV2Request
+ * @property {string} destination - ISO representation of the package's destination. Supports both ISO2 (e.g., 'FR') and ISO3 (e.g., 'FRA') country codes.
+ * @property {number} dataLimitInGb - 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} 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.
+ * @property {string} endDate - 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 - 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} quantity - Number of eSIMs to purchase.
+ * @property {string} email - Email address where the purchase confirmation email will be sent (including QR Code & activation steps)
+ * @property {string} referenceId - An identifier provided by the partner to link this purchase to their booking or transaction for analytics and debugging purposes.
+ * @property {string} networkBrand - Customize the network brand of the issued eSIM. The `networkBrand` parameter cannot exceed 15 characters in length and must contain only letters, numbers, dots (.), ampersands (&), and spaces. This feature is available to platforms with Diamond tier only.
+ * @property {string} emailBrand - 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.
+ * @property {CreatePurchaseV2RequestLanguage} language - Language of the confirmation email sent to the customer.
  */
 type CreatePurchaseV2Request = z.infer<typeof createPurchaseV2Request>;
 
@@ -1062,10 +1081,9 @@ declare const createPurchaseV2OkResponse: z.ZodLazy<z.ZodObject<{
     };
 }>>;
 /**
- *
- * @typedef  {CreatePurchaseV2OkResponse} createPurchaseV2OkResponse
- * @property {CreatePurchaseV2OkResponsePurchase}
- * @property {CreatePurchaseV2OkResponseProfile}
+ * @typedef {CreatePurchaseV2OkResponse} createPurchaseV2OkResponse
+ * @property {CreatePurchaseV2OkResponsePurchase} purchase
+ * @property {CreatePurchaseV2OkResponseProfile} profile
  */
 type CreatePurchaseV2OkResponse = z.infer<typeof createPurchaseV2OkResponse>;
 
@@ -1225,10 +1243,9 @@ declare const listPurchasesOkResponse: z.ZodLazy<z.ZodObject<{
     }[];
 }>>;
 /**
- *
- * @typedef  {ListPurchasesOkResponse} listPurchasesOkResponse
- * @property {Purchases[]}
- * @property {string} - The cursor value representing the end of the current page of results. Use this cursor value as the "afterCursor" parameter in your next request to retrieve the subsequent page of results. It ensures that you continue fetching data from where you left off, facilitating smooth pagination.
+ * @typedef {ListPurchasesOkResponse} listPurchasesOkResponse
+ * @property {Purchases[]} purchases
+ * @property {string} afterCursor - The cursor value representing the end of the current page of results. Use this cursor value as the "afterCursor" parameter in your next request to retrieve the subsequent page of results. It ensures that you continue fetching data from where you left off, facilitating smooth pagination.
  */
 type ListPurchasesOkResponse = z.infer<typeof listPurchasesOkResponse>;
 
@@ -1288,19 +1305,18 @@ declare const createPurchaseRequest: z.ZodLazy<z.ZodObject<{
     endTime?: number | undefined;
 }>>;
 /**
- *
- * @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 {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)
- * @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 network brand of the issued eSIM. The `networkBrand` parameter cannot exceed 15 characters in length and must contain only letters, numbers, dots (.), ampersands (&), and spaces. This feature is available to platforms with Diamond tier only.
- * @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.
- * @property {CreatePurchaseRequestLanguage} - Language of the confirmation email sent to the customer.
- * @property {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.
- * @property {number} - Epoch value representing the end time of the package's validity. End time can be maximum 90 days after Start time.
+ * @typedef {CreatePurchaseRequest} createPurchaseRequest
+ * @property {string} destination - ISO representation of the package's destination. Supports both ISO2 (e.g., 'FR') and ISO3 (e.g., 'FRA') country codes.
+ * @property {number} dataLimitInGb - 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} 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.
+ * @property {string} endDate - 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 - Email address where the purchase confirmation email will be sent (including QR Code & activation steps)
+ * @property {string} referenceId - An identifier provided by the partner to link this purchase to their booking or transaction for analytics and debugging purposes.
+ * @property {string} networkBrand - Customize the network brand of the issued eSIM. The `networkBrand` parameter cannot exceed 15 characters in length and must contain only letters, numbers, dots (.), ampersands (&), and spaces. This feature is available to platforms with Diamond tier only.
+ * @property {string} emailBrand - 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.
+ * @property {CreatePurchaseRequestLanguage} language - Language of the confirmation email sent to the customer.
+ * @property {number} 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.
+ * @property {number} endTime - Epoch value representing the end time of the package's validity. End time can be maximum 90 days after Start time.
  */
 type CreatePurchaseRequest = z.infer<typeof createPurchaseRequest>;
 
@@ -1380,10 +1396,9 @@ declare const createPurchaseOkResponse: z.ZodLazy<z.ZodObject<{
     };
 }>>;
 /**
- *
- * @typedef  {CreatePurchaseOkResponse} createPurchaseOkResponse
- * @property {CreatePurchaseOkResponsePurchase}
- * @property {CreatePurchaseOkResponseProfile}
+ * @typedef {CreatePurchaseOkResponse} createPurchaseOkResponse
+ * @property {CreatePurchaseOkResponsePurchase} purchase
+ * @property {CreatePurchaseOkResponseProfile} profile
  */
 type CreatePurchaseOkResponse = z.infer<typeof createPurchaseOkResponse>;
 
@@ -1427,18 +1442,17 @@ declare const topUpEsimRequest: z.ZodLazy<z.ZodObject<{
     endTime?: number | undefined;
 }>>;
 /**
- *
- * @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 {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 {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.
- * @property {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.
- * @property {number} - Epoch value representing the end time of the package's validity. End time can be maximum 90 days after Start time.
+ * @typedef {TopUpEsimRequest} topUpEsimRequest
+ * @property {string} iccid - ID of the eSIM
+ * @property {number} dataLimitInGb - 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} 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.
+ * @property {string} endDate - 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 - 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 - Email address where the purchase confirmation email will be sent (excluding QR Code & activation steps).
+ * @property {string} referenceId - An identifier provided by the partner to link this purchase to their booking or transaction for analytics and debugging purposes.
+ * @property {string} emailBrand - 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.
+ * @property {number} 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.
+ * @property {number} endTime - Epoch value representing the end time of the package's validity. End time can be maximum 90 days after Start time.
  */
 type TopUpEsimRequest = z.infer<typeof topUpEsimRequest>;
 
@@ -1508,10 +1522,9 @@ declare const topUpEsimOkResponse: z.ZodLazy<z.ZodObject<{
     };
 }>>;
 /**
- *
- * @typedef  {TopUpEsimOkResponse} topUpEsimOkResponse
- * @property {TopUpEsimOkResponsePurchase}
- * @property {TopUpEsimOkResponseProfile}
+ * @typedef {TopUpEsimOkResponse} topUpEsimOkResponse
+ * @property {TopUpEsimOkResponsePurchase} purchase
+ * @property {TopUpEsimOkResponseProfile} profile
  */
 type TopUpEsimOkResponse = z.infer<typeof topUpEsimOkResponse>;
 
@@ -1540,13 +1553,12 @@ declare const editPurchaseRequest: z.ZodLazy<z.ZodObject<{
     endTime?: number | undefined;
 }>>;
 /**
- *
- * @typedef  {EditPurchaseRequest} editPurchaseRequest
- * @property {string} - ID of the purchase
- * @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} - 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.
- * @property {number} - Epoch value representing the end time of the package's validity. End time can be maximum 90 days after Start time.
+ * @typedef {EditPurchaseRequest} editPurchaseRequest
+ * @property {string} purchaseId - ID of the purchase
+ * @property {string} 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.
+ * @property {string} endDate - 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} 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.
+ * @property {number} endTime - Epoch value representing the end time of the package's validity. End time can be maximum 90 days after Start time.
  */
 type EditPurchaseRequest = z.infer<typeof editPurchaseRequest>;
 
@@ -1575,13 +1587,12 @@ declare const editPurchaseOkResponse: z.ZodLazy<z.ZodObject<{
     newEndTime?: number | null | undefined;
 }>>;
 /**
- *
- * @typedef  {EditPurchaseOkResponse} editPurchaseOkResponse
- * @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} - Epoch value representing the new start time of the package's validity
- * @property {number} - Epoch value representing the new end time of the package's validity
+ * @typedef {EditPurchaseOkResponse} editPurchaseOkResponse
+ * @property {string} purchaseId - ID of the purchase
+ * @property {string} newStartDate - Start date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'
+ * @property {string} newEndDate - End date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'
+ * @property {number} newStartTime - Epoch value representing the new start time of the package's validity
+ * @property {number} newEndTime - Epoch value representing the new end time of the package's validity
  */
 type EditPurchaseOkResponse = z.infer<typeof editPurchaseOkResponse>;
 
@@ -1604,11 +1615,10 @@ declare const getPurchaseConsumptionOkResponse: z.ZodLazy<z.ZodObject<{
     dataUsageRemainingInGb: number;
 }>>;
 /**
- *
- * @typedef  {GetPurchaseConsumptionOkResponse} getPurchaseConsumptionOkResponse
- * @property {number} - Remaining balance of the package in bytes
- * @property {number} - Remaining balance of the package in GB
- * @property {string} - Status of the connectivity, possible values are 'ACTIVE' or 'NOT_ACTIVE'
+ * @typedef {GetPurchaseConsumptionOkResponse} getPurchaseConsumptionOkResponse
+ * @property {number} dataUsageRemainingInBytes - Remaining balance of the package in bytes. Returns `-1` for unlimited packages.
+ * @property {number} dataUsageRemainingInGb - Remaining balance of the package in GB. Returns `-1` for unlimited packages.
+ * @property {string} status - Status of the connectivity, possible values are 'ACTIVE' or 'NOT_ACTIVE'
  */
 type GetPurchaseConsumptionOkResponse = z.infer<typeof getPurchaseConsumptionOkResponse>;
 
@@ -1735,11 +1745,10 @@ declare const createPurchaseV2OkResponsePurchase: z.ZodLazy<z.ZodObject<{
     createdDate: string;
 }>>;
 /**
- *
- * @typedef  {CreatePurchaseV2OkResponsePurchase} createPurchaseV2OkResponsePurchase
- * @property {string} - ID of the purchase
- * @property {string} - ID of the package
- * @property {string} - Creation date of the purchase in the format 'yyyy-MM-ddThh:mm:ssZZ'
+ * @typedef {CreatePurchaseV2OkResponsePurchase} createPurchaseV2OkResponsePurchase
+ * @property {string} id - ID of the purchase
+ * @property {string} packageId - ID of the package
+ * @property {string} createdDate - Creation date of the purchase in the format 'yyyy-MM-ddThh:mm:ssZZ'
  */
 type CreatePurchaseV2OkResponsePurchase = z.infer<typeof createPurchaseV2OkResponsePurchase>;
 
@@ -1768,13 +1777,12 @@ declare const createPurchaseV2OkResponseProfile: z.ZodLazy<z.ZodObject<{
     androidActivationLink: string;
 }>>;
 /**
- *
- * @typedef  {CreatePurchaseV2OkResponseProfile} createPurchaseV2OkResponseProfile
- * @property {string} - ID of the eSIM
- * @property {string} - QR Code of the eSIM as base64
- * @property {string} - Manual Activation Code of the eSIM
- * @property {string} - iOS Activation Link of the eSIM
- * @property {string} - Android Activation Link of the eSIM
+ * @typedef {CreatePurchaseV2OkResponseProfile} createPurchaseV2OkResponseProfile
+ * @property {string} iccid - ID of the eSIM
+ * @property {string} activationCode - QR Code of the eSIM as base64
+ * @property {string} manualActivationCode - Manual Activation Code of the eSIM
+ * @property {string} iosActivationLink - iOS Activation Link of the eSIM
+ * @property {string} androidActivationLink - Android Activation Link of the eSIM
  */
 type CreatePurchaseV2OkResponseProfile = z.infer<typeof createPurchaseV2OkResponseProfile>;
 
@@ -1885,21 +1893,20 @@ declare const purchases: z.ZodLazy<z.ZodObject<{
     referenceId?: string | null | undefined;
 }>>;
 /**
- *
- * @typedef  {Purchases} purchases
- * @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 {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
- * @property {number} - Epoch value representing the date of creation of the purchase
- * @property {Package_}
- * @property {PurchasesEsim}
- * @property {string} - The `source` indicates whether the purchase was made from the API, dashboard, landing-page, promo-page or iframe. For purchases made before September 8, 2023, the value will be displayed as 'Not available'.
- * @property {string} - The `purchaseType` indicates whether this is the initial purchase that creates the eSIM (First Purchase) or a subsequent top-up on an existing eSIM (Top-up Purchase).
- * @property {string} - The `referenceId` that was provided by the partner during the purchase or top-up flow. This identifier can be used for analytics and debugging purposes.
+ * @typedef {Purchases} purchases
+ * @property {string} id - ID of the purchase
+ * @property {string} startDate - Start date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'
+ * @property {string} endDate - End date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'
+ * @property {number} duration - Duration of the package in days. Possible values are 1, 2, 7, 14, 30, or 90. `null` for unlimited (date-based) packages.
+ * @property {string} createdDate - Creation date of the purchase in the format 'yyyy-MM-ddThh:mm:ssZZ'
+ * @property {number} startTime - Epoch value representing the start time of the package's validity
+ * @property {number} endTime - Epoch value representing the end time of the package's validity
+ * @property {number} createdAt - Epoch value representing the date of creation of the purchase
+ * @property {Package_} package
+ * @property {PurchasesEsim} esim
+ * @property {string} source - The `source` indicates whether the purchase was made from the API, dashboard, landing-page, promo-page or iframe. For purchases made before September 8, 2023, the value will be displayed as 'Not available'.
+ * @property {string} purchaseType - The `purchaseType` indicates whether this is the initial purchase that creates the eSIM (First Purchase) or a subsequent top-up on an existing eSIM (Top-up Purchase).
+ * @property {string} referenceId - The `referenceId` that was provided by the partner during the purchase or top-up flow. This identifier can be used for analytics and debugging purposes.
  */
 type Purchases = z.infer<typeof purchases>;
 
@@ -1934,15 +1941,14 @@ declare const package_: z.ZodLazy<z.ZodObject<{
     destinationName: string;
 }>>;
 /**
- *
- * @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 {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
- * @property {number} - Price of the package in cents
+ * @typedef {Package_} package_
+ * @property {string} id - ID of the package
+ * @property {number} dataLimitInBytes - Size of the package in Bytes. A value of `-1` indicates an unlimited package.
+ * @property {number} dataLimitInGb - Size of the package in GB. A value of `-1` indicates an unlimited (date-based) package.
+ * @property {string} destination - ISO3 representation of the package's destination.
+ * @property {string} destinationIso2 - ISO2 representation of the package's destination.
+ * @property {string} destinationName - Name of the package's destination
+ * @property {number} priceInCents - Price of the package in cents
  */
 type Package_ = z.infer<typeof package_>;
 
@@ -1959,9 +1965,8 @@ declare const purchasesEsim: z.ZodLazy<z.ZodObject<{
     iccid: string;
 }>>;
 /**
- *
- * @typedef  {PurchasesEsim} purchasesEsim
- * @property {string} - ID of the eSIM
+ * @typedef {PurchasesEsim} purchasesEsim
+ * @property {string} iccid - ID of the eSIM
  */
 type PurchasesEsim = z.infer<typeof purchasesEsim>;
 
@@ -1996,15 +2001,14 @@ declare const createPurchaseOkResponsePurchase: z.ZodLazy<z.ZodObject<{
     endTime?: number | null | undefined;
 }>>;
 /**
- *
- * @typedef  {CreatePurchaseOkResponsePurchase} createPurchaseOkResponsePurchase
- * @property {string} - ID of the purchase
- * @property {string} - ID of the package
- * @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 {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
+ * @typedef {CreatePurchaseOkResponsePurchase} createPurchaseOkResponsePurchase
+ * @property {string} id - ID of the purchase
+ * @property {string} packageId - ID of the package
+ * @property {string} startDate - Start date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'
+ * @property {string} endDate - End date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'
+ * @property {string} createdDate - Creation date of the purchase in the format 'yyyy-MM-ddThh:mm:ssZZ'
+ * @property {number} startTime - Epoch value representing the start time of the package's validity
+ * @property {number} endTime - Epoch value representing the end time of the package's validity
  */
 type CreatePurchaseOkResponsePurchase = z.infer<typeof createPurchaseOkResponsePurchase>;
 
@@ -2027,11 +2031,10 @@ declare const createPurchaseOkResponseProfile: z.ZodLazy<z.ZodObject<{
     manualActivationCode: string;
 }>>;
 /**
- *
- * @typedef  {CreatePurchaseOkResponseProfile} createPurchaseOkResponseProfile
- * @property {string} - ID of the eSIM
- * @property {string} - QR Code of the eSIM as base64
- * @property {string} - Manual Activation Code of the eSIM
+ * @typedef {CreatePurchaseOkResponseProfile} createPurchaseOkResponseProfile
+ * @property {string} iccid - ID of the eSIM
+ * @property {string} activationCode - QR Code of the eSIM as base64
+ * @property {string} manualActivationCode - Manual Activation Code of the eSIM
  */
 type CreatePurchaseOkResponseProfile = z.infer<typeof createPurchaseOkResponseProfile>;
 
@@ -2074,15 +2077,14 @@ declare const topUpEsimOkResponsePurchase: z.ZodLazy<z.ZodObject<{
     endTime?: number | null | undefined;
 }>>;
 /**
- *
- * @typedef  {TopUpEsimOkResponsePurchase} topUpEsimOkResponsePurchase
- * @property {string} - ID of the purchase
- * @property {string} - ID of the package
- * @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 {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
+ * @typedef {TopUpEsimOkResponsePurchase} topUpEsimOkResponsePurchase
+ * @property {string} id - ID of the purchase
+ * @property {string} packageId - ID of the package
+ * @property {string} startDate - Start date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'
+ * @property {string} endDate - End date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'
+ * @property {string} createdDate - Creation date of the purchase in the format 'yyyy-MM-ddThh:mm:ssZZ'
+ * @property {number} startTime - Epoch value representing the start time of the package's validity
+ * @property {number} endTime - Epoch value representing the end time of the package's validity
  */
 type TopUpEsimOkResponsePurchase = z.infer<typeof topUpEsimOkResponsePurchase>;
 
@@ -2099,9 +2101,8 @@ declare const topUpEsimOkResponseProfile: z.ZodLazy<z.ZodObject<{
     iccid: string;
 }>>;
 /**
- *
- * @typedef  {TopUpEsimOkResponseProfile} topUpEsimOkResponseProfile
- * @property {string} - ID of the eSIM
+ * @typedef {TopUpEsimOkResponseProfile} topUpEsimOkResponseProfile
+ * @property {string} iccid - ID of the eSIM
  */
 type TopUpEsimOkResponseProfile = z.infer<typeof topUpEsimOkResponseProfile>;
 
@@ -2158,9 +2159,8 @@ declare const getEsimOkResponse: z.ZodLazy<z.ZodObject<{
     };
 }>>;
 /**
- *
- * @typedef  {GetEsimOkResponse} getEsimOkResponse
- * @property {GetEsimOkResponseEsim}
+ * @typedef {GetEsimOkResponse} getEsimOkResponse
+ * @property {GetEsimOkResponseEsim} esim
  */
 type GetEsimOkResponse = z.infer<typeof getEsimOkResponse>;
 
@@ -2206,9 +2206,8 @@ declare const getEsimDeviceOkResponse: z.ZodLazy<z.ZodObject<{
     };
 }>>;
 /**
- *
- * @typedef  {GetEsimDeviceOkResponse} getEsimDeviceOkResponse
- * @property {Device}
+ * @typedef {GetEsimDeviceOkResponse} getEsimDeviceOkResponse
+ * @property {Device} device
  */
 type GetEsimDeviceOkResponse = z.infer<typeof getEsimDeviceOkResponse>;
 
@@ -2268,9 +2267,8 @@ declare const getEsimHistoryOkResponse: z.ZodLazy<z.ZodObject<{
     };
 }>>;
 /**
- *
- * @typedef  {GetEsimHistoryOkResponse} getEsimHistoryOkResponse
- * @property {GetEsimHistoryOkResponseEsim}
+ * @typedef {GetEsimHistoryOkResponse} getEsimHistoryOkResponse
+ * @property {GetEsimHistoryOkResponseEsim} esim
  */
 type GetEsimHistoryOkResponse = z.infer<typeof getEsimHistoryOkResponse>;
 
@@ -2355,15 +2353,14 @@ declare const getEsimOkResponseEsim: z.ZodLazy<z.ZodObject<{
     isTopUpAllowed: boolean;
 }>>;
 /**
- *
- * @typedef  {GetEsimOkResponseEsim} getEsimOkResponseEsim
- * @property {string} - ID of the eSIM
- * @property {string} - SM-DP+ Address
- * @property {string} - QR Code of the eSIM as base64
- * @property {string} - The manual activation code
- * @property {string} - Status of the eSIM, possible values are 'RELEASED', 'DOWNLOADED', 'INSTALLED', 'ENABLED', 'DELETED', or 'ERROR'
- * @property {string} - Status of the eSIM connectivity, possible values are 'ACTIVE' or 'NOT_ACTIVE'
- * @property {boolean} - Indicates whether the eSIM is currently eligible for a top-up. This flag should be checked before attempting a top-up request.
+ * @typedef {GetEsimOkResponseEsim} getEsimOkResponseEsim
+ * @property {string} iccid - ID of the eSIM
+ * @property {string} smdpAddress - SM-DP+ Address
+ * @property {string} activationCode - QR Code of the eSIM as base64
+ * @property {string} manualActivationCode - The manual activation code
+ * @property {string} status - Status of the eSIM, possible values are 'RELEASED', 'DOWNLOADED', 'INSTALLED', 'ENABLED', 'DELETED', or 'ERROR'
+ * @property {string} connectivityStatus - Status of the eSIM connectivity, possible values are 'ACTIVE' or 'NOT_ACTIVE'
+ * @property {boolean} isTopUpAllowed - Indicates whether the eSIM is currently eligible for a top-up. This flag should be checked before attempting a top-up request.
  */
 type GetEsimOkResponseEsim = z.infer<typeof getEsimOkResponseEsim>;
 
@@ -2389,12 +2386,11 @@ declare const device: z.ZodLazy<z.ZodObject<{
     eid: string;
 }>>;
 /**
- *
- * @typedef  {Device} device
- * @property {string} - Name of the OEM
- * @property {string} - Name of the Device
- * @property {string} - Model of the Device
- * @property {string} - Serial Number of the eSIM
+ * @typedef {Device} device
+ * @property {string} oem - Name of the OEM
+ * @property {string} hardwareName - Name of the Device
+ * @property {string} hardwareModel - Model of the Device
+ * @property {string} eid - Serial Number of the eSIM
  */
 type Device = z.infer<typeof device>;
 
@@ -2434,10 +2430,9 @@ declare const getEsimHistoryOkResponseEsim: z.ZodLazy<z.ZodObject<{
     }[];
 }>>;
 /**
- *
- * @typedef  {GetEsimHistoryOkResponseEsim} getEsimHistoryOkResponseEsim
- * @property {string} - ID of the eSIM
- * @property {History[]}
+ * @typedef {GetEsimHistoryOkResponseEsim} getEsimHistoryOkResponseEsim
+ * @property {string} iccid - ID of the eSIM
+ * @property {History[]} history
  */
 type GetEsimHistoryOkResponseEsim = z.infer<typeof getEsimHistoryOkResponseEsim>;
 
@@ -2460,11 +2455,10 @@ declare const history: z.ZodLazy<z.ZodObject<{
     date?: number | undefined;
 }>>;
 /**
- *
- * @typedef  {History} history
- * @property {string} - The status of the eSIM at a given time, possible values are 'RELEASED', 'DOWNLOADED', 'INSTALLED', 'ENABLED', 'DELETED', or 'ERROR'
- * @property {string} - The date when the eSIM status changed in the format 'yyyy-MM-ddThh:mm:ssZZ'
- * @property {number} - Epoch value representing the date when the eSIM status changed
+ * @typedef {History} history
+ * @property {string} status - The status of the eSIM at a given time, possible values are 'RELEASED', 'DOWNLOADED', 'INSTALLED', 'ENABLED', 'DELETED', or 'ERROR'
+ * @property {string} statusDate - The date when the eSIM status changed in the format 'yyyy-MM-ddThh:mm:ssZZ'
+ * @property {number} date - Epoch value representing the date when the eSIM status changed
  */
 type History = z.infer<typeof history>;
 
@@ -2481,9 +2475,8 @@ declare const tokenOkResponse: z.ZodLazy<z.ZodObject<{
     token: string;
 }>>;
 /**
- *
- * @typedef  {TokenOkResponse} tokenOkResponse
- * @property {string} - The generated token
+ * @typedef {TokenOkResponse} tokenOkResponse
+ * @property {string} token - The generated token
  */
 type TokenOkResponse = z.infer<typeof tokenOkResponse>;
 
@@ -2530,12 +2523,11 @@ declare const oAuthTokenRequest: z.ZodLazy<z.ZodObject<{
     scope: string;
 }>>;
 /**
- *
- * @typedef  {OAuthTokenRequest} oAuthTokenRequest
- * @property {GrantType}
- * @property {string}
- * @property {string}
- * @property {string}
+ * @typedef {OAuthTokenRequest} oAuthTokenRequest
+ * @property {GrantType} grantType
+ * @property {string} clientId
+ * @property {string} clientSecret
+ * @property {string} scope
  */
 type OAuthTokenRequest = z.infer<typeof oAuthTokenRequest>;
 
@@ -2555,10 +2547,9 @@ declare const oAuthTokenResponse: z.ZodLazy<z.ZodObject<{
     expiresIn?: number | null | undefined;
 }>>;
 /**
- *
- * @typedef  {OAuthTokenResponse} oAuthTokenResponse
- * @property {string}
- * @property {number}
+ * @typedef {OAuthTokenResponse} oAuthTokenResponse
+ * @property {string} accessToken
+ * @property {number} expiresIn
  */
 type OAuthTokenResponse = z.infer<typeof oAuthTokenResponse>;
 
@@ -2591,6 +2582,7 @@ declare class BadRequest extends ThrowableError {
     message: string;
     protected response?: unknown;
     constructor(message: string, response?: unknown);
+    static from(message: string, response?: unknown): BadRequest;
     throw(): void;
 }
 
@@ -2598,6 +2590,7 @@ declare class Unauthorized extends ThrowableError {
     message: string;
     protected response?: unknown;
     constructor(message: string, response?: unknown);
+    static from(message: string, response?: unknown): Unauthorized;
     throw(): void;
 }