celitech-sdk 1.3.42 → 1.3.44

package/README.md

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

package/dist/index.d.ts

@@ -59,13 +59,20 @@ declare class OAuthTokenManager {
     getToken(scopes: Set<string>, config: SdkConfig): Promise<OAuthToken>;
 }
 
+declare class ThrowableError extends Error {
+    message: string;
+    protected response?: unknown;
+    constructor(message: string, response?: unknown);
+    throw(): void;
+}
+
 interface ResponseDefinition {
     schema: ZodType;
     contentType: ContentType;
     status: number;
 }
 interface ErrorDefinition {
-    error: new (...args: any[]) => Error;
+    error: new (...args: any[]) => ThrowableError;
     contentType: ContentType;
     status: number;
 }
@@ -138,17 +145,25 @@ declare class Request<PageSchema = unknown[]> {
 }
 
 type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS';
-interface SdkConfig {
+interface BaseConfig {
+    retry?: RetryOptions;
+    validation?: ValidationOptions;
     baseUrl?: string;
     environment?: Environment;
     timeoutMs?: number;
+    oAuthBaseUrl?: string;
+}
+interface ClientCredentialAuthConfig extends BaseConfig {
     clientId: string;
     clientSecret: string;
-    oAuthBaseUrl?: string;
-    accessToken?: string;
-    retry?: RetryOptions;
-    validation?: ValidationOptions;
+    accessToken?: never;
+}
+interface TokenAuthConfig extends BaseConfig {
+    clientId?: never;
+    clientSecret?: never;
+    accessToken: string;
 }
+type SdkConfig = ClientCredentialAuthConfig | TokenAuthConfig;
 interface HttpMetadata {
     status: number;
     statusText: string;
@@ -358,12 +373,18 @@ declare const destinations: z.ZodLazy<z.ZodObject<{
  */
 type Destinations = z.infer<typeof destinations>;
 
-declare class __ extends Error {
-    constructor(message?: string, response?: unknown);
+declare class __ extends ThrowableError {
+    message: string;
+    protected response?: unknown;
+    constructor(message: string, response?: unknown);
+    throw(): void;
 }
 
-declare class _1 extends Error {
-    constructor(message?: string, response?: unknown);
+declare class _1 extends ThrowableError {
+    message: string;
+    protected response?: unknown;
+    constructor(message: string, response?: unknown);
+    throw(): void;
 }
 
 /**
@@ -479,7 +500,7 @@ declare const packages: z.ZodLazy<z.ZodObject<{
  *
  * @typedef  {Packages} packages
  * @property {string} - ID of the package
- * @property {string} - ISO representation of the package's destination
+ * @property {string} - ISO representation of the package's destination.
  * @property {number} - Size of the package in Bytes
  * @property {number} - Min number of days for the package
  * @property {number} - Max number of days for the package
@@ -487,12 +508,18 @@ declare const packages: z.ZodLazy<z.ZodObject<{
  */
 type Packages = z.infer<typeof packages>;
 
-declare class _2 extends Error {
-    constructor(message?: string, response?: unknown);
+declare class _2 extends ThrowableError {
+    message: string;
+    protected response?: unknown;
+    constructor(message: string, response?: unknown);
+    throw(): void;
 }
 
-declare class _3 extends Error {
-    constructor(message?: string, response?: unknown);
+declare class _3 extends ThrowableError {
+    message: string;
+    protected response?: unknown;
+    constructor(message: string, response?: unknown);
+    throw(): void;
 }
 
 /**
@@ -507,6 +534,7 @@ declare const createPurchaseV2Request: z.ZodLazy<z.ZodObject<{
     email: z.ZodOptional<z.ZodString>;
     referenceId: z.ZodOptional<z.ZodString>;
     networkBrand: z.ZodOptional<z.ZodString>;
+    emailBrand: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     destination: string;
     startDate: string;
@@ -516,6 +544,7 @@ declare const createPurchaseV2Request: z.ZodLazy<z.ZodObject<{
     email?: string | undefined;
     referenceId?: string | undefined;
     networkBrand?: string | undefined;
+    emailBrand?: string | undefined;
 }, {
     destination: string;
     startDate: string;
@@ -525,18 +554,20 @@ declare const createPurchaseV2Request: z.ZodLazy<z.ZodObject<{
     email?: string | undefined;
     referenceId?: string | undefined;
     networkBrand?: string | undefined;
+    emailBrand?: string | undefined;
 }>>;
 /**
  *
  * @typedef  {CreatePurchaseV2Request} createPurchaseV2Request
- * @property {string} - ISO representation of the package's destination
- * @property {number} - Size of the package in GB. The available options are 1, 2, 3, 5, 8, 20GB
+ * @property {string} - ISO representation of the package's destination.
+ * @property {number} - Size of the package in GB. The available options are 0.5, 1, 2, 3, 5, 8, 20GB
  * @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} - 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. This parameter is accessible to platforms with Diamond tier and requires an alphanumeric string of up to 15 characters.
+ * @property {string} - Customize the network brand of the issued eSIM. The `networkBrand` parameter cannot exceed 15 characters in length and must contain only letters and numbers. 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.
  */
 type CreatePurchaseV2Request = z.infer<typeof createPurchaseV2Request>;
 
@@ -640,6 +671,7 @@ declare const listPurchasesOkResponse: z.ZodLazy<z.ZodObject<{
             iccid?: string | undefined;
         }>>>;
         source: z.ZodOptional<z.ZodString>;
+        purchaseType: z.ZodOptional<z.ZodString>;
         referenceId: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         id?: string | undefined;
@@ -660,6 +692,7 @@ declare const listPurchasesOkResponse: z.ZodLazy<z.ZodObject<{
             iccid?: string | undefined;
         } | undefined;
         source?: string | undefined;
+        purchaseType?: string | undefined;
         referenceId?: string | undefined;
     }, {
         id?: string | undefined;
@@ -680,6 +713,7 @@ declare const listPurchasesOkResponse: z.ZodLazy<z.ZodObject<{
             iccid?: string | undefined;
         } | undefined;
         source?: string | undefined;
+        purchaseType?: string | undefined;
         referenceId?: string | undefined;
     }>>, "many">>;
     afterCursor: z.ZodNullable<z.ZodOptional<z.ZodString>>;
@@ -703,6 +737,7 @@ declare const listPurchasesOkResponse: z.ZodLazy<z.ZodObject<{
             iccid?: string | undefined;
         } | undefined;
         source?: string | undefined;
+        purchaseType?: string | undefined;
         referenceId?: string | undefined;
     }[] | undefined;
     afterCursor?: string | null | undefined;
@@ -726,6 +761,7 @@ declare const listPurchasesOkResponse: z.ZodLazy<z.ZodObject<{
             iccid?: string | undefined;
         } | undefined;
         source?: string | undefined;
+        purchaseType?: string | undefined;
         referenceId?: string | undefined;
     }[] | undefined;
     afterCursor?: string | null | undefined;
@@ -760,6 +796,7 @@ declare const createPurchaseRequest: z.ZodLazy<z.ZodObject<{
     email: z.ZodOptional<z.ZodString>;
     referenceId: z.ZodOptional<z.ZodString>;
     networkBrand: z.ZodOptional<z.ZodString>;
+    emailBrand: z.ZodOptional<z.ZodString>;
     startTime: z.ZodOptional<z.ZodNumber>;
     endTime: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
@@ -770,6 +807,7 @@ declare const createPurchaseRequest: z.ZodLazy<z.ZodObject<{
     email?: string | undefined;
     referenceId?: string | undefined;
     networkBrand?: string | undefined;
+    emailBrand?: string | undefined;
     startTime?: number | undefined;
     endTime?: number | undefined;
 }, {
@@ -780,19 +818,21 @@ declare const createPurchaseRequest: z.ZodLazy<z.ZodObject<{
     email?: string | undefined;
     referenceId?: string | undefined;
     networkBrand?: string | undefined;
+    emailBrand?: string | undefined;
     startTime?: number | undefined;
     endTime?: number | undefined;
 }>>;
 /**
  *
  * @typedef  {CreatePurchaseRequest} createPurchaseRequest
- * @property {string} - ISO representation of the package's destination
- * @property {number} - Size of the package in GB. The available options are 1, 2, 3, 5, 8, 20GB
+ * @property {string} - ISO representation of the package's destination.
+ * @property {number} - Size of the package in GB. The available options are 0.5, 1, 2, 3, 5, 8, 20GB
  * @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. This parameter is accessible to platforms with Diamond tier and requires an alphanumeric string of up to 15 characters
+ * @property {string} - Customize the network brand of the issued eSIM. The `networkBrand` parameter cannot exceed 15 characters in length and must contain only letters and numbers. 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 {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.
  */
@@ -889,6 +929,7 @@ declare const topUpEsimRequest: z.ZodLazy<z.ZodObject<{
     endDate: z.ZodString;
     email: z.ZodOptional<z.ZodString>;
     referenceId: z.ZodOptional<z.ZodString>;
+    emailBrand: z.ZodOptional<z.ZodString>;
     startTime: z.ZodOptional<z.ZodNumber>;
     endTime: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
@@ -898,6 +939,7 @@ declare const topUpEsimRequest: z.ZodLazy<z.ZodObject<{
     iccid: string;
     email?: string | undefined;
     referenceId?: string | undefined;
+    emailBrand?: string | undefined;
     startTime?: number | undefined;
     endTime?: number | undefined;
 }, {
@@ -907,6 +949,7 @@ declare const topUpEsimRequest: z.ZodLazy<z.ZodObject<{
     iccid: string;
     email?: string | undefined;
     referenceId?: string | undefined;
+    emailBrand?: string | undefined;
     startTime?: number | undefined;
     endTime?: number | undefined;
 }>>;
@@ -914,11 +957,12 @@ 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 1, 2, 3, 5, 8, 20GB
+ * @property {number} - Size of the package in GB. The available options are 0.5, 1, 2, 3, 5, 8, 20GB
  * @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 (excluding QR Code & activation steps)
+ * @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.
  */
@@ -1218,6 +1262,7 @@ declare const purchases: z.ZodLazy<z.ZodObject<{
         iccid?: string | undefined;
     }>>>;
     source: z.ZodOptional<z.ZodString>;
+    purchaseType: z.ZodOptional<z.ZodString>;
     referenceId: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     id?: string | undefined;
@@ -1238,6 +1283,7 @@ declare const purchases: z.ZodLazy<z.ZodObject<{
         iccid?: string | undefined;
     } | undefined;
     source?: string | undefined;
+    purchaseType?: string | undefined;
     referenceId?: string | undefined;
 }, {
     id?: string | undefined;
@@ -1258,6 +1304,7 @@ declare const purchases: z.ZodLazy<z.ZodObject<{
         iccid?: string | undefined;
     } | undefined;
     source?: string | undefined;
+    purchaseType?: string | undefined;
     referenceId?: string | undefined;
 }>>;
 /**
@@ -1272,8 +1319,9 @@ declare const purchases: z.ZodLazy<z.ZodObject<{
  * @property {number} - Epoch value representing the date of creation of the purchase
  * @property {Package_}
  * @property {PurchasesEsim}
- * @property {string} - The source indicates where the eSIM was purchased, which can be 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 referenceId that was provided by the partner during the purchase or topup flow. This identifier can be used for analytics and debugging purposes.
+ * @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.
  */
 type Purchases = z.infer<typeof purchases>;
 
@@ -1304,7 +1352,7 @@ 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 {string} - ISO representation of the package's destination
+ * @property {string} - ISO representation of the package's destination.
  * @property {string} - Name of the package's destination
  * @property {number} - Price of the package in cents
  */
@@ -1451,52 +1499,88 @@ declare const topUpEsimOkResponseProfile: z.ZodLazy<z.ZodObject<{
  */
 type TopUpEsimOkResponseProfile = z.infer<typeof topUpEsimOkResponseProfile>;
 
-declare class _4 extends Error {
-    constructor(message?: string, response?: unknown);
+declare class _4 extends ThrowableError {
+    message: string;
+    protected response?: unknown;
+    constructor(message: string, response?: unknown);
+    throw(): void;
 }
 
-declare class _5 extends Error {
-    constructor(message?: string, response?: unknown);
+declare class _5 extends ThrowableError {
+    message: string;
+    protected response?: unknown;
+    constructor(message: string, response?: unknown);
+    throw(): void;
 }
 
-declare class _6 extends Error {
-    constructor(message?: string, response?: unknown);
+declare class _6 extends ThrowableError {
+    message: string;
+    protected response?: unknown;
+    constructor(message: string, response?: unknown);
+    throw(): void;
 }
 
-declare class _7 extends Error {
-    constructor(message?: string, response?: unknown);
+declare class _7 extends ThrowableError {
+    message: string;
+    protected response?: unknown;
+    constructor(message: string, response?: unknown);
+    throw(): void;
 }
 
-declare class _8 extends Error {
-    constructor(message?: string, response?: unknown);
+declare class _8 extends ThrowableError {
+    message: string;
+    protected response?: unknown;
+    constructor(message: string, response?: unknown);
+    throw(): void;
 }
 
-declare class _9 extends Error {
-    constructor(message?: string, response?: unknown);
+declare class _9 extends ThrowableError {
+    message: string;
+    protected response?: unknown;
+    constructor(message: string, response?: unknown);
+    throw(): void;
 }
 
-declare class _10 extends Error {
-    constructor(message?: string, response?: unknown);
+declare class _10 extends ThrowableError {
+    message: string;
+    protected response?: unknown;
+    constructor(message: string, response?: unknown);
+    throw(): void;
 }
 
-declare class _11 extends Error {
-    constructor(message?: string, response?: unknown);
+declare class _11 extends ThrowableError {
+    message: string;
+    protected response?: unknown;
+    constructor(message: string, response?: unknown);
+    throw(): void;
 }
 
-declare class _12 extends Error {
-    constructor(message?: string, response?: unknown);
+declare class _12 extends ThrowableError {
+    message: string;
+    protected response?: unknown;
+    constructor(message: string, response?: unknown);
+    throw(): void;
 }
 
-declare class _13 extends Error {
-    constructor(message?: string, response?: unknown);
+declare class _13 extends ThrowableError {
+    message: string;
+    protected response?: unknown;
+    constructor(message: string, response?: unknown);
+    throw(): void;
 }
 
-declare class _14 extends Error {
-    constructor(message?: string, response?: unknown);
+declare class _14 extends ThrowableError {
+    message: string;
+    protected response?: unknown;
+    constructor(message: string, response?: unknown);
+    throw(): void;
 }
 
-declare class _15 extends Error {
-    constructor(message?: string, response?: unknown);
+declare class _15 extends ThrowableError {
+    message: string;
+    protected response?: unknown;
+    constructor(message: string, response?: unknown);
+    throw(): void;
 }
 
 /**
@@ -1864,36 +1948,60 @@ declare const getEsimMacOkResponseEsim: z.ZodLazy<z.ZodObject<{
  */
 type GetEsimMacOkResponseEsim = z.infer<typeof getEsimMacOkResponseEsim>;
 
-declare class _16 extends Error {
-    constructor(message?: string, response?: unknown);
+declare class _16 extends ThrowableError {
+    message: string;
+    protected response?: unknown;
+    constructor(message: string, response?: unknown);
+    throw(): void;
 }
 
-declare class _17 extends Error {
-    constructor(message?: string, response?: unknown);
+declare class _17 extends ThrowableError {
+    message: string;
+    protected response?: unknown;
+    constructor(message: string, response?: unknown);
+    throw(): void;
 }
 
-declare class _18 extends Error {
-    constructor(message?: string, response?: unknown);
+declare class _18 extends ThrowableError {
+    message: string;
+    protected response?: unknown;
+    constructor(message: string, response?: unknown);
+    throw(): void;
 }
 
-declare class _19 extends Error {
-    constructor(message?: string, response?: unknown);
+declare class _19 extends ThrowableError {
+    message: string;
+    protected response?: unknown;
+    constructor(message: string, response?: unknown);
+    throw(): void;
 }
 
-declare class _20 extends Error {
-    constructor(message?: string, response?: unknown);
+declare class _20 extends ThrowableError {
+    message: string;
+    protected response?: unknown;
+    constructor(message: string, response?: unknown);
+    throw(): void;
 }
 
-declare class _21 extends Error {
-    constructor(message?: string, response?: unknown);
+declare class _21 extends ThrowableError {
+    message: string;
+    protected response?: unknown;
+    constructor(message: string, response?: unknown);
+    throw(): void;
 }
 
-declare class _22 extends Error {
-    constructor(message?: string, response?: unknown);
+declare class _22 extends ThrowableError {
+    message: string;
+    protected response?: unknown;
+    constructor(message: string, response?: unknown);
+    throw(): void;
 }
 
-declare class _23 extends Error {
-    constructor(message?: string, response?: unknown);
+declare class _23 extends ThrowableError {
+    message: string;
+    protected response?: unknown;
+    constructor(message: string, response?: unknown);
+    throw(): void;
 }
 
 /**
@@ -1922,12 +2030,18 @@ declare class IFrameService extends BaseService {
     token(requestConfig?: RequestConfig): Promise<HttpResponse<TokenOkResponse>>;
 }
 
-declare class _24 extends Error {
-    constructor(message?: string, response?: unknown);
+declare class _24 extends ThrowableError {
+    message: string;
+    protected response?: unknown;
+    constructor(message: string, response?: unknown);
+    throw(): void;
 }
 
-declare class _25 extends Error {
-    constructor(message?: string, response?: unknown);
+declare class _25 extends ThrowableError {
+    message: string;
+    protected response?: unknown;
+    constructor(message: string, response?: unknown);
+    throw(): void;
 }
 
 declare class Celitech {