celitech-sdk 1.3.54 → 1.3.56

package/README.md

@@ -1,4 +1,4 @@
-# Celitech TypeScript SDK 1.3.54
+# Celitech TypeScript SDK 1.3.56
 
 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.54`
-- SDK version: `1.3.54`
+- API version: `1.3.56`
+- SDK version: `1.3.56`
 
 ## About the API
 

package/dist/index.d.ts

@@ -634,7 +634,7 @@ declare const listPurchasesOkResponse: z.ZodLazy<z.ZodObject<{
         }>>>;
         source: z.ZodOptional<z.ZodString>;
         purchaseType: z.ZodOptional<z.ZodString>;
-        referenceId: z.ZodOptional<z.ZodString>;
+        referenceId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
     }, "strip", z.ZodTypeAny, {
         id?: string | undefined;
         startDate?: string | undefined;
@@ -656,7 +656,7 @@ declare const listPurchasesOkResponse: z.ZodLazy<z.ZodObject<{
         } | undefined;
         source?: string | undefined;
         purchaseType?: string | undefined;
-        referenceId?: string | undefined;
+        referenceId?: string | null | undefined;
     }, {
         id?: string | undefined;
         startDate?: string | undefined;
@@ -678,7 +678,7 @@ declare const listPurchasesOkResponse: z.ZodLazy<z.ZodObject<{
         } | undefined;
         source?: string | undefined;
         purchaseType?: string | undefined;
-        referenceId?: string | undefined;
+        referenceId?: string | null | undefined;
     }>>, "many">>;
     afterCursor: z.ZodNullable<z.ZodOptional<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
@@ -703,7 +703,7 @@ declare const listPurchasesOkResponse: z.ZodLazy<z.ZodObject<{
         } | undefined;
         source?: string | undefined;
         purchaseType?: string | undefined;
-        referenceId?: string | undefined;
+        referenceId?: string | null | undefined;
     }[] | undefined;
     afterCursor?: string | null | undefined;
 }, {
@@ -728,7 +728,7 @@ declare const listPurchasesOkResponse: z.ZodLazy<z.ZodObject<{
         } | undefined;
         source?: string | undefined;
         purchaseType?: string | undefined;
-        referenceId?: string | undefined;
+        referenceId?: string | null | undefined;
     }[] | undefined;
     afterCursor?: string | null | undefined;
 }>>;
@@ -744,6 +744,7 @@ interface ListPurchasesParams {
     iccid?: string;
     afterDate?: string;
     beforeDate?: string;
+    email?: string;
     referenceId?: string;
     afterCursor?: string;
     limit?: number;
@@ -1104,6 +1105,7 @@ declare class PurchasesService extends BaseService {
      * @param {string} [params.iccid] - ID of the eSIM
      * @param {string} [params.afterDate] - Start date of the interval for filtering purchases in the format 'yyyy-MM-dd'
      * @param {string} [params.beforeDate] - End date of the interval for filtering purchases in the format 'yyyy-MM-dd'
+     * @param {string} [params.email] - Email associated to the purchase.
      * @param {string} [params.referenceId] - The referenceId that was provided by the partner during the purchase or topup flow.
      * @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 purchases to be returned in the response. The value must be greater than 0 and less than or equal to 100. If not provided, the default value is 20
@@ -1120,7 +1122,7 @@ declare class PurchasesService extends BaseService {
      */
     createPurchase(body: CreatePurchaseRequest, requestConfig?: RequestConfig): Promise<HttpResponse<CreatePurchaseOkResponse>>;
     /**
-     * This endpoint is used to top-up an eSIM with the previously associated destination by providing an existing ICCID and the package details. The top-up is only feasible for eSIMs in "ENABLED" or "INSTALLED" state. You can check this state using the Get eSIM Status endpoint.
+     * 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 Status endpoint, which returns the `isTopUpAllowed` flag.
      * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
      * @returns {Promise<HttpResponse<TopUpEsimOkResponse>>} Successful Response
      */
@@ -1232,7 +1234,7 @@ declare const purchases: z.ZodLazy<z.ZodObject<{
     }>>>;
     source: z.ZodOptional<z.ZodString>;
     purchaseType: z.ZodOptional<z.ZodString>;
-    referenceId: z.ZodOptional<z.ZodString>;
+    referenceId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
     id?: string | undefined;
     startDate?: string | undefined;
@@ -1254,7 +1256,7 @@ declare const purchases: z.ZodLazy<z.ZodObject<{
     } | undefined;
     source?: string | undefined;
     purchaseType?: string | undefined;
-    referenceId?: string | undefined;
+    referenceId?: string | null | undefined;
 }, {
     id?: string | undefined;
     startDate?: string | undefined;
@@ -1276,7 +1278,7 @@ declare const purchases: z.ZodLazy<z.ZodObject<{
     } | undefined;
     source?: string | undefined;
     purchaseType?: string | undefined;
-    referenceId?: string | undefined;
+    referenceId?: string | null | undefined;
 }>>;
 /**
  *
@@ -1567,16 +1569,19 @@ declare const getEsimOkResponse: z.ZodLazy<z.ZodObject<{
         smdpAddress: z.ZodOptional<z.ZodString>;
         manualActivationCode: z.ZodOptional<z.ZodString>;
         status: z.ZodOptional<z.ZodString>;
+        isTopUpAllowed: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
         iccid?: string | undefined;
         smdpAddress?: string | undefined;
         manualActivationCode?: string | undefined;
         status?: string | undefined;
+        isTopUpAllowed?: boolean | undefined;
     }, {
         iccid?: string | undefined;
         smdpAddress?: string | undefined;
         manualActivationCode?: string | undefined;
         status?: string | undefined;
+        isTopUpAllowed?: boolean | undefined;
     }>>>;
 }, "strip", z.ZodTypeAny, {
     esim?: {
@@ -1584,6 +1589,7 @@ declare const getEsimOkResponse: z.ZodLazy<z.ZodObject<{
         smdpAddress?: string | undefined;
         manualActivationCode?: string | undefined;
         status?: string | undefined;
+        isTopUpAllowed?: boolean | undefined;
     } | undefined;
 }, {
     esim?: {
@@ -1591,6 +1597,7 @@ declare const getEsimOkResponse: z.ZodLazy<z.ZodObject<{
         smdpAddress?: string | undefined;
         manualActivationCode?: string | undefined;
         status?: string | undefined;
+        isTopUpAllowed?: boolean | undefined;
     } | undefined;
 }>>;
 /**
@@ -1782,16 +1789,19 @@ declare const getEsimOkResponseEsim: z.ZodLazy<z.ZodObject<{
     smdpAddress: z.ZodOptional<z.ZodString>;
     manualActivationCode: z.ZodOptional<z.ZodString>;
     status: z.ZodOptional<z.ZodString>;
+    isTopUpAllowed: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     iccid?: string | undefined;
     smdpAddress?: string | undefined;
     manualActivationCode?: string | undefined;
     status?: string | undefined;
+    isTopUpAllowed?: boolean | undefined;
 }, {
     iccid?: string | undefined;
     smdpAddress?: string | undefined;
     manualActivationCode?: string | undefined;
     status?: string | undefined;
+    isTopUpAllowed?: boolean | undefined;
 }>>;
 /**
  *
@@ -1800,6 +1810,7 @@ declare const getEsimOkResponseEsim: z.ZodLazy<z.ZodObject<{
  * @property {string} - SM-DP+ Address
  * @property {string} - The manual activation code
  * @property {string} - Status of the eSIM, possible values are 'RELEASED', 'DOWNLOADED', 'INSTALLED', 'ENABLED', 'DELETED', or 'ERROR'
+ * @property {boolean} - 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>;
 

package/dist/index.js

@@ -2134,7 +2134,7 @@ var purchases = import_zod24.z.lazy(() => {
     esim: purchasesEsim.optional(),
     source: import_zod24.z.string().optional(),
     purchaseType: import_zod24.z.string().optional(),
-    referenceId: import_zod24.z.string().optional()
+    referenceId: import_zod24.z.string().optional().nullable()
   });
 });
 var purchasesResponse = import_zod24.z.lazy(() => {
@@ -2150,7 +2150,7 @@ var purchasesResponse = import_zod24.z.lazy(() => {
     esim: purchasesEsimResponse.optional(),
     source: import_zod24.z.string().optional(),
     purchaseType: import_zod24.z.string().optional(),
-    referenceId: import_zod24.z.string().optional()
+    referenceId: import_zod24.z.string().optional().nullable()
   }).transform((data) => ({
     id: data["id"],
     startDate: data["startDate"],
@@ -2179,7 +2179,7 @@ var purchasesRequest = import_zod24.z.lazy(() => {
     esim: purchasesEsimRequest.optional(),
     source: import_zod24.z.string().optional(),
     purchaseType: import_zod24.z.string().optional(),
-    referenceId: import_zod24.z.string().optional()
+    referenceId: import_zod24.z.string().optional().nullable()
   }).transform((data) => ({
     id: data["id"],
     startDate: data["startDate"],
@@ -2926,6 +2926,7 @@ var PurchasesService = class extends BaseService {
    * @param {string} [params.iccid] - ID of the eSIM
    * @param {string} [params.afterDate] - Start date of the interval for filtering purchases in the format 'yyyy-MM-dd'
    * @param {string} [params.beforeDate] - End date of the interval for filtering purchases in the format 'yyyy-MM-dd'
+   * @param {string} [params.email] - Email associated to the purchase.
    * @param {string} [params.referenceId] - The referenceId that was provided by the partner during the purchase or topup flow.
    * @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 purchases to be returned in the response. The value must be greater than 0 and less than or equal to 100. If not provided, the default value is 20
@@ -2956,6 +2957,9 @@ var PurchasesService = class extends BaseService {
     }).addQueryParam({
       key: "beforeDate",
       value: params == null ? void 0 : params.beforeDate
+    }).addQueryParam({
+      key: "email",
+      value: params == null ? void 0 : params.email
     }).addQueryParam({
       key: "referenceId",
       value: params == null ? void 0 : params.referenceId
@@ -2996,7 +3000,7 @@ var PurchasesService = class extends BaseService {
     return this.client.call(request);
   }
   /**
-   * This endpoint is used to top-up an eSIM with the previously associated destination by providing an existing ICCID and the package details. The top-up is only feasible for eSIMs in "ENABLED" or "INSTALLED" state. You can check this state using the Get eSIM Status endpoint.
+   * 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 Status endpoint, which returns the `isTopUpAllowed` flag.
    * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<TopUpEsimOkResponse>>} Successful Response
    */
@@ -3077,7 +3081,8 @@ var getEsimOkResponseEsim = import_zod48.z.lazy(() => {
     iccid: import_zod48.z.string().min(18).max(22).optional(),
     smdpAddress: import_zod48.z.string().optional(),
     manualActivationCode: import_zod48.z.string().optional(),
-    status: import_zod48.z.string().optional()
+    status: import_zod48.z.string().optional(),
+    isTopUpAllowed: import_zod48.z.boolean().optional()
   });
 });
 var getEsimOkResponseEsimResponse = import_zod48.z.lazy(() => {
@@ -3085,12 +3090,14 @@ var getEsimOkResponseEsimResponse = import_zod48.z.lazy(() => {
     iccid: import_zod48.z.string().min(18).max(22).optional(),
     smdpAddress: import_zod48.z.string().optional(),
     manualActivationCode: import_zod48.z.string().optional(),
-    status: import_zod48.z.string().optional()
+    status: import_zod48.z.string().optional(),
+    isTopUpAllowed: import_zod48.z.boolean().optional()
   }).transform((data) => ({
     iccid: data["iccid"],
     smdpAddress: data["smdpAddress"],
     manualActivationCode: data["manualActivationCode"],
-    status: data["status"]
+    status: data["status"],
+    isTopUpAllowed: data["isTopUpAllowed"]
   }));
 });
 var getEsimOkResponseEsimRequest = import_zod48.z.lazy(() => {
@@ -3098,12 +3105,14 @@ var getEsimOkResponseEsimRequest = import_zod48.z.lazy(() => {
     iccid: import_zod48.z.string().min(18).max(22).optional(),
     smdpAddress: import_zod48.z.string().optional(),
     manualActivationCode: import_zod48.z.string().optional(),
-    status: import_zod48.z.string().optional()
+    status: import_zod48.z.string().optional(),
+    isTopUpAllowed: import_zod48.z.boolean().optional()
   }).transform((data) => ({
     iccid: data["iccid"],
     smdpAddress: data["smdpAddress"],
     manualActivationCode: data["manualActivationCode"],
-    status: data["status"]
+    status: data["status"],
+    isTopUpAllowed: data["isTopUpAllowed"]
   }));
 });
 

package/dist/index.mjs

@@ -2090,7 +2090,7 @@ var purchases = z22.lazy(() => {
     esim: purchasesEsim.optional(),
     source: z22.string().optional(),
     purchaseType: z22.string().optional(),
-    referenceId: z22.string().optional()
+    referenceId: z22.string().optional().nullable()
   });
 });
 var purchasesResponse = z22.lazy(() => {
@@ -2106,7 +2106,7 @@ var purchasesResponse = z22.lazy(() => {
     esim: purchasesEsimResponse.optional(),
     source: z22.string().optional(),
     purchaseType: z22.string().optional(),
-    referenceId: z22.string().optional()
+    referenceId: z22.string().optional().nullable()
   }).transform((data) => ({
     id: data["id"],
     startDate: data["startDate"],
@@ -2135,7 +2135,7 @@ var purchasesRequest = z22.lazy(() => {
     esim: purchasesEsimRequest.optional(),
     source: z22.string().optional(),
     purchaseType: z22.string().optional(),
-    referenceId: z22.string().optional()
+    referenceId: z22.string().optional().nullable()
   }).transform((data) => ({
     id: data["id"],
     startDate: data["startDate"],
@@ -2882,6 +2882,7 @@ var PurchasesService = class extends BaseService {
    * @param {string} [params.iccid] - ID of the eSIM
    * @param {string} [params.afterDate] - Start date of the interval for filtering purchases in the format 'yyyy-MM-dd'
    * @param {string} [params.beforeDate] - End date of the interval for filtering purchases in the format 'yyyy-MM-dd'
+   * @param {string} [params.email] - Email associated to the purchase.
    * @param {string} [params.referenceId] - The referenceId that was provided by the partner during the purchase or topup flow.
    * @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 purchases to be returned in the response. The value must be greater than 0 and less than or equal to 100. If not provided, the default value is 20
@@ -2912,6 +2913,9 @@ var PurchasesService = class extends BaseService {
     }).addQueryParam({
       key: "beforeDate",
       value: params == null ? void 0 : params.beforeDate
+    }).addQueryParam({
+      key: "email",
+      value: params == null ? void 0 : params.email
     }).addQueryParam({
       key: "referenceId",
       value: params == null ? void 0 : params.referenceId
@@ -2952,7 +2956,7 @@ var PurchasesService = class extends BaseService {
     return this.client.call(request);
   }
   /**
-   * This endpoint is used to top-up an eSIM with the previously associated destination by providing an existing ICCID and the package details. The top-up is only feasible for eSIMs in "ENABLED" or "INSTALLED" state. You can check this state using the Get eSIM Status endpoint.
+   * 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 Status endpoint, which returns the `isTopUpAllowed` flag.
    * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
    * @returns {Promise<HttpResponse<TopUpEsimOkResponse>>} Successful Response
    */
@@ -3033,7 +3037,8 @@ var getEsimOkResponseEsim = z46.lazy(() => {
     iccid: z46.string().min(18).max(22).optional(),
     smdpAddress: z46.string().optional(),
     manualActivationCode: z46.string().optional(),
-    status: z46.string().optional()
+    status: z46.string().optional(),
+    isTopUpAllowed: z46.boolean().optional()
   });
 });
 var getEsimOkResponseEsimResponse = z46.lazy(() => {
@@ -3041,12 +3046,14 @@ var getEsimOkResponseEsimResponse = z46.lazy(() => {
     iccid: z46.string().min(18).max(22).optional(),
     smdpAddress: z46.string().optional(),
     manualActivationCode: z46.string().optional(),
-    status: z46.string().optional()
+    status: z46.string().optional(),
+    isTopUpAllowed: z46.boolean().optional()
   }).transform((data) => ({
     iccid: data["iccid"],
     smdpAddress: data["smdpAddress"],
     manualActivationCode: data["manualActivationCode"],
-    status: data["status"]
+    status: data["status"],
+    isTopUpAllowed: data["isTopUpAllowed"]
   }));
 });
 var getEsimOkResponseEsimRequest = z46.lazy(() => {
@@ -3054,12 +3061,14 @@ var getEsimOkResponseEsimRequest = z46.lazy(() => {
     iccid: z46.string().min(18).max(22).optional(),
     smdpAddress: z46.string().optional(),
     manualActivationCode: z46.string().optional(),
-    status: z46.string().optional()
+    status: z46.string().optional(),
+    isTopUpAllowed: z46.boolean().optional()
   }).transform((data) => ({
     iccid: data["iccid"],
     smdpAddress: data["smdpAddress"],
     manualActivationCode: data["manualActivationCode"],
-    status: data["status"]
+    status: data["status"],
+    isTopUpAllowed: data["isTopUpAllowed"]
   }));
 });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "celitech-sdk",
-  "version": "1.3.54",
+  "version": "1.3.56",
   "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",