celitech-sdk 2.0.7 → 2.0.10

package/dist/index.d.ts

@@ -209,7 +209,7 @@ declare class ThrowableError extends Error {
  * Used to match and validate responses based on content type and status code.
  */
 interface ResponseDefinition {
-    /** Zod schema for validating the response body */
+    /** Schema for validating the response body */
     schema: ZodType;
     /** The content type of this response (e.g., 'application/json') */
     contentType: ContentType;
@@ -289,7 +289,7 @@ interface RequestPagination<Page> {
     pageSize?: number;
     /** JSON path to extract page data from response */
     pagePath: string[];
-    /** Zod schema for validating page data */
+    /** Schema for validating page data */
     pageSchema?: ZodType<Page, any, any>;
 }
 /**
@@ -301,12 +301,12 @@ interface RequestPagination<Page> {
 interface RequestCursorPagination<Page> {
     /** JSON path to extract page data from response */
     pagePath: string[];
-    /** Zod schema for validating page data */
+    /** Schema for validating page data */
     pageSchema?: ZodType<Page, any, any>;
     /** JSON path to extract next cursor from response */
     cursorPath: string[];
-    /** Zod schema for validating cursor value */
-    cursorSchema?: ZodType<string | null | undefined>;
+    /** Schema for validating cursor value */
+    cursorSchema?: ZodType<any, any, any>;
 }
 
 /**
@@ -403,8 +403,11 @@ declare class Request<PageSchema = unknown[]> {
      * Handles both cursor-based and limit-offset pagination strategies.
      *
      * @param cursor - The cursor value for cursor-based pagination (optional for limit-offset)
+     * @param offsetIncrement - Fallback increment for offset pagination with no declared `pageSize`
+     * (stepless offset — gap doc row 200), where the caller only learns the increment after fetching
+     * a page (its item count). Ignored whenever `pageSize` is set, which always wins.
      */
-    nextPage(cursor?: string): void;
+    nextPage(cursor?: string, offsetIncrement?: number): void;
     private constructPath;
     private getOffsetParam;
     private getCursorParam;
@@ -521,6 +524,7 @@ interface RetryOptions {
 }
 interface ValidationOptions {
     responseValidation?: boolean;
+    requestValidation?: boolean;
 }
 
 /**
@@ -699,6 +703,7 @@ declare class BaseService {
      * @returns Merged configuration with all overrides applied
      */
     protected getResolvedConfig(methodConfig?: Partial<SdkConfig>, requestConfig?: Partial<SdkConfig>): SdkConfig;
+    protected toBase64(str: string): string;
     set baseUrl(baseUrl: string);
     set environment(environment: Environment);
     set timeoutMs(timeoutMs: number);
@@ -1008,7 +1013,7 @@ declare const createPurchaseV2Request: z.ZodLazy<z.ZodObject<{
  * @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} referenceId - An identifier provided by the partner to link this purchase to their booking or transaction for analytics and debugging purposes. Letters, digits, `-`, `_`, `.`, `@` and `+` are allowed (so an email address works), up to 255 characters.
  * @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.
@@ -1087,6 +1092,31 @@ declare const createPurchaseV2OkResponse: z.ZodLazy<z.ZodObject<{
  */
 type CreatePurchaseV2OkResponse = z.infer<typeof createPurchaseV2OkResponse>;
 
+interface CreatePurchaseV2Params {
+    idempotencyKey?: string;
+}
+interface ListPurchasesParams {
+    purchaseId?: string;
+    iccid?: string;
+    afterDate?: string;
+    beforeDate?: string;
+    email?: string;
+    referenceId?: string;
+    afterCursor?: string;
+    limit?: number;
+    after?: number;
+    before?: number;
+}
+interface CreatePurchaseParams {
+    idempotencyKey?: string;
+}
+interface TopUpEsimParams {
+    idempotencyKey?: string;
+}
+interface EditPurchaseParams {
+    idempotencyKey?: string;
+}
+
 /**
  * Zod schema for the ListPurchasesOkResponse model.
  * Defines the structure and validation rules for this data type.
@@ -1249,19 +1279,6 @@ declare const listPurchasesOkResponse: z.ZodLazy<z.ZodObject<{
  */
 type ListPurchasesOkResponse = z.infer<typeof listPurchasesOkResponse>;
 
-interface ListPurchasesParams {
-    purchaseId?: string;
-    iccid?: string;
-    afterDate?: string;
-    beforeDate?: string;
-    email?: string;
-    referenceId?: string;
-    afterCursor?: string;
-    limit?: number;
-    after?: number;
-    before?: number;
-}
-
 /**
  * Zod schema for the CreatePurchaseRequest model.
  * Defines the structure and validation rules for this data type.
@@ -1311,7 +1328,7 @@ declare const createPurchaseRequest: z.ZodLazy<z.ZodObject<{
  * @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} referenceId - An identifier provided by the partner to link this purchase to their booking or transaction for analytics and debugging purposes. Letters, digits, `-`, `_`, `.`, `@` and `+` are allowed (so an email address works), up to 255 characters.
  * @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.
@@ -1449,7 +1466,7 @@ declare const topUpEsimRequest: z.ZodLazy<z.ZodObject<{
  * @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} referenceId - An identifier provided by the partner to link this purchase to their booking or transaction for analytics and debugging purposes. Letters, digits, `-`, `_`, `.`, `@` and `+` are allowed (so an email address works), up to 255 characters.
  * @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.
@@ -1672,10 +1689,11 @@ declare class PurchasesService extends BaseService {
     setGetPurchaseConsumptionConfig(config: Partial<SdkConfig>): this;
     /**
      * This endpoint is used to purchase a new eSIM by providing the package details.
+     * @param {string} [params.idempotencyKey] - Optional. A unique value (for example a UUID) that makes this request safe to retry. If a request with the same `Idempotency-Key` and the same body succeeds, repeating it returns the original response instead of performing the action again, and the response includes the header `Idempotent-Replayed: true`. Keys are scoped to your credentials and remembered for 3 days. Only successful (2xx) responses are remembered, so a request that failed can be retried with the same key. Reusing a key with a different request returns `422`; sending it while the original request is still being processed returns `409`. If the idempotency store is temporarily unavailable, the request is not processed and returns `503`; retry it. Must be 1 to 255 printable ASCII characters, without spaces.
      * @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
      * @returns {Promise<HttpResponse<CreatePurchaseV2OkResponse[]>>} - Successful Response
      */
-    createPurchaseV2(body: CreatePurchaseV2Request, requestConfig?: Partial<SdkConfig>): Promise<CreatePurchaseV2OkResponse[]>;
+    createPurchaseV2(body: CreatePurchaseV2Request, params?: CreatePurchaseV2Params, requestConfig?: Partial<SdkConfig>): Promise<CreatePurchaseV2OkResponse[]>;
     /**
      * This endpoint can be used to list all the successful purchases made between a given interval.
      * @param {string} [params.purchaseId] - ID of the purchase
@@ -1694,16 +1712,18 @@ declare class PurchasesService extends BaseService {
     listPurchases(params?: ListPurchasesParams, requestConfig?: Partial<SdkConfig>): Promise<ListPurchasesOkResponse>;
     /**
      * This endpoint is used to purchase a new eSIM by providing the package details.
+     * @param {string} [params.idempotencyKey] - Optional. A unique value (for example a UUID) that makes this request safe to retry. If a request with the same `Idempotency-Key` and the same body succeeds, repeating it returns the original response instead of performing the action again, and the response includes the header `Idempotent-Replayed: true`. Keys are scoped to your credentials and remembered for 3 days. Only successful (2xx) responses are remembered, so a request that failed can be retried with the same key. Reusing a key with a different request returns `422`; sending it while the original request is still being processed returns `409`. If the idempotency store is temporarily unavailable, the request is not processed and returns `503`; retry it. Must be 1 to 255 printable ASCII characters, without spaces.
      * @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
      * @returns {Promise<HttpResponse<CreatePurchaseOkResponse>>} - Successful Response
      */
-    createPurchase(body: CreatePurchaseRequest, requestConfig?: Partial<SdkConfig>): Promise<CreatePurchaseOkResponse>;
+    createPurchase(body: CreatePurchaseRequest, params?: CreatePurchaseParams, requestConfig?: Partial<SdkConfig>): Promise<CreatePurchaseOkResponse>;
     /**
      * This endpoint is used to top-up an existing eSIM with the previously associated destination by providing its ICCID and package details. To determine if an eSIM can be topped up, use the Get eSIM endpoint, which returns the `isTopUpAllowed` flag.
+     * @param {string} [params.idempotencyKey] - Optional. A unique value (for example a UUID) that makes this request safe to retry. If a request with the same `Idempotency-Key` and the same body succeeds, repeating it returns the original response instead of performing the action again, and the response includes the header `Idempotent-Replayed: true`. Keys are scoped to your credentials and remembered for 3 days. Only successful (2xx) responses are remembered, so a request that failed can be retried with the same key. Reusing a key with a different request returns `422`; sending it while the original request is still being processed returns `409`. If the idempotency store is temporarily unavailable, the request is not processed and returns `503`; retry it. Must be 1 to 255 printable ASCII characters, without spaces.
      * @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
      * @returns {Promise<HttpResponse<TopUpEsimOkResponse>>} - Successful Response
      */
-    topUpEsim(body: TopUpEsimRequest, requestConfig?: Partial<SdkConfig>): Promise<TopUpEsimOkResponse>;
+    topUpEsim(body: TopUpEsimRequest, params?: TopUpEsimParams, requestConfig?: Partial<SdkConfig>): Promise<TopUpEsimOkResponse>;
     /**
    * This endpoint allows you to modify the validity dates of an existing purchase.
   **Behavior:**
@@ -1713,10 +1733,11 @@ declare class PurchasesService extends BaseService {
   
   The end date can be extended or shortened as long as it adheres to the same pricing category and does not exceed the allowed duration limits.
   
+   * @param {string} [params.idempotencyKey] - Optional. A unique value (for example a UUID) that makes this request safe to retry. If a request with the same `Idempotency-Key` and the same body succeeds, repeating it returns the original response instead of performing the action again, and the response includes the header `Idempotent-Replayed: true`. Keys are scoped to your credentials and remembered for 3 days. Only successful (2xx) responses are remembered, so a request that failed can be retried with the same key. Reusing a key with a different request returns `422`; sending it while the original request is still being processed returns `409`. If the idempotency store is temporarily unavailable, the request is not processed and returns `503`; retry it. Must be 1 to 255 printable ASCII characters, without spaces.
    * @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<EditPurchaseOkResponse>>} - Successful Response
    */
-    editPurchase(body: EditPurchaseRequest, requestConfig?: Partial<SdkConfig>): Promise<EditPurchaseOkResponse>;
+    editPurchase(body: EditPurchaseRequest, params?: EditPurchaseParams, requestConfig?: Partial<SdkConfig>): Promise<EditPurchaseOkResponse>;
     /**
      * 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.
      * @param {string} purchaseId - ID of the purchase
@@ -2167,6 +2188,9 @@ type GetEsimOkResponse = z.infer<typeof getEsimOkResponse>;
 interface GetEsimParams {
     iccid: string;
 }
+interface SuspendEsimParams {
+    idempotencyKey?: string;
+}
 
 /**
  * Zod schema for the GetEsimDeviceOkResponse model.
@@ -2272,6 +2296,24 @@ declare const getEsimHistoryOkResponse: z.ZodLazy<z.ZodObject<{
  */
 type GetEsimHistoryOkResponse = z.infer<typeof getEsimHistoryOkResponse>;
 
+/**
+ * Zod schema for the SuspendEsimOkResponse model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
+ */
+declare const suspendEsimOkResponse: z.ZodLazy<z.ZodObject<{
+    message: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+}, {
+    message: string;
+}>>;
+/**
+ * @typedef {SuspendEsimOkResponse} suspendEsimOkResponse
+ * @property {string} message - Confirmation message
+ */
+type SuspendEsimOkResponse = z.infer<typeof suspendEsimOkResponse>;
+
 /**
  * Service class for ESimService operations.
  * Provides methods to interact with ESimService-related API endpoints.
@@ -2281,6 +2323,7 @@ declare class ESimService extends BaseService {
     protected getEsimConfig?: Partial<SdkConfig>;
     protected getEsimDeviceConfig?: Partial<SdkConfig>;
     protected getEsimHistoryConfig?: Partial<SdkConfig>;
+    protected suspendEsimConfig?: Partial<SdkConfig>;
     /**
      * Sets method-level configuration for getEsim.
      * @param config - Partial configuration to override service-level defaults
@@ -2299,6 +2342,12 @@ declare class ESimService extends BaseService {
      * @returns This service instance for method chaining
      */
     setGetEsimHistoryConfig(config: Partial<SdkConfig>): this;
+    /**
+     * Sets method-level configuration for suspendEsim.
+     * @param config - Partial configuration to override service-level defaults
+     * @returns This service instance for method chaining
+     */
+    setSuspendEsimConfig(config: Partial<SdkConfig>): this;
     /**
      * Get eSIM
      * @param {string} params.iccid - ID of the eSIM
@@ -2320,6 +2369,14 @@ declare class ESimService extends BaseService {
      * @returns {Promise<HttpResponse<GetEsimHistoryOkResponse>>} - Successful Response
      */
     getEsimHistory(iccid: string, requestConfig?: Partial<SdkConfig>): Promise<GetEsimHistoryOkResponse>;
+    /**
+     * Suspends an eSIM to prevent abuse. All of the eSIM's packages are terminated and its connectivity is switched off. The eSIM is not refunded: the charge stays.
+     * @param {string} iccid - ID of the eSIM
+     * @param {string} [params.idempotencyKey] - Optional. A unique value (for example a UUID) that makes this request safe to retry. If a request with the same `Idempotency-Key` and the same body succeeds, repeating it returns the original response instead of performing the action again, and the response includes the header `Idempotent-Replayed: true`. Keys are scoped to your credentials and remembered for 3 days. Only successful (2xx) responses are remembered, so a request that failed can be retried with the same key. Reusing a key with a different request returns `422`; sending it while the original request is still being processed returns `409`. If the idempotency store is temporarily unavailable, the request is not processed and returns `503`; retry it. Must be 1 to 255 printable ASCII characters, without spaces.
+     * @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
+     * @returns {Promise<HttpResponse<SuspendEsimOkResponse>>} - Successful Response
+     */
+    suspendEsim(iccid: string, params?: SuspendEsimParams, requestConfig?: Partial<SdkConfig>): Promise<SuspendEsimOkResponse>;
 }
 
 /**
@@ -2578,19 +2635,11 @@ declare enum GrantType {
     CLIENT_CREDENTIALS = "client_credentials"
 }
 
-declare class BadRequest extends ThrowableError {
-    message: string;
-    protected response?: unknown;
-    constructor(message: string, response?: unknown);
-    static from(message: string, response?: unknown): BadRequest;
-    throw(): void;
-}
-
-declare class Unauthorized extends ThrowableError {
+declare class ErrorResponse extends ThrowableError {
     message: string;
     protected response?: unknown;
     constructor(message: string, response?: unknown);
-    static from(message: string, response?: unknown): Unauthorized;
+    static from(message: string, response?: unknown): ErrorResponse;
     throw(): void;
 }
 
@@ -2612,4 +2661,4 @@ declare class Celitech {
     set accessToken(accessToken: string);
 }
 
-export { BadRequest, Celitech, CreatePurchaseOkResponse, CreatePurchaseOkResponseProfile, CreatePurchaseOkResponsePurchase, CreatePurchaseRequest, CreatePurchaseRequestLanguage, CreatePurchaseV2OkResponse, CreatePurchaseV2OkResponseProfile, CreatePurchaseV2OkResponsePurchase, CreatePurchaseV2Request, CreatePurchaseV2RequestLanguage, Destinations, DestinationsService, Device, ESimService, EditPurchaseOkResponse, EditPurchaseRequest, Environment, GetEsimDeviceOkResponse, GetEsimHistoryOkResponse, GetEsimHistoryOkResponseEsim, GetEsimOkResponse, GetEsimOkResponseEsim, GetPurchaseConsumptionOkResponse, GrantType, History, HttpError, HttpMetadata, HttpMethod, HttpResponse, IFrameService, ListDestinationsOkResponse, ListPackagesOkResponse, ListPurchasesOkResponse, OAuthService, OAuthTokenRequest, OAuthTokenResponse, Package_, Packages, PackagesService, Purchases, PurchasesEsim, PurchasesService, RetryOptions, SdkConfig, TokenOkResponse, TopUpEsimOkResponse, TopUpEsimOkResponseProfile, TopUpEsimOkResponsePurchase, TopUpEsimRequest, Unauthorized, ValidationOptions };
+export { Celitech, CreatePurchaseOkResponse, CreatePurchaseOkResponseProfile, CreatePurchaseOkResponsePurchase, CreatePurchaseRequest, CreatePurchaseRequestLanguage, CreatePurchaseV2OkResponse, CreatePurchaseV2OkResponseProfile, CreatePurchaseV2OkResponsePurchase, CreatePurchaseV2Request, CreatePurchaseV2RequestLanguage, Destinations, DestinationsService, Device, ESimService, EditPurchaseOkResponse, EditPurchaseRequest, Environment, ErrorResponse, GetEsimDeviceOkResponse, GetEsimHistoryOkResponse, GetEsimHistoryOkResponseEsim, GetEsimOkResponse, GetEsimOkResponseEsim, GetPurchaseConsumptionOkResponse, GrantType, History, HttpError, HttpMetadata, HttpMethod, HttpResponse, IFrameService, ListDestinationsOkResponse, ListPackagesOkResponse, ListPurchasesOkResponse, OAuthService, OAuthTokenRequest, OAuthTokenResponse, Package_, Packages, PackagesService, Purchases, PurchasesEsim, PurchasesService, RetryOptions, SdkConfig, SuspendEsimOkResponse, TokenOkResponse, TopUpEsimOkResponse, TopUpEsimOkResponseProfile, TopUpEsimOkResponsePurchase, TopUpEsimRequest, ValidationOptions };