celitech-sdk 1.1.66 → 1.1.71

package/documentation/models/GetEsimHistoryOkResponse.md

@@ -0,0 +1,26 @@
+# GetEsimHistoryOkResponse
+
+**Properties**
+
+| Name | Type                         | Required | Description |
+| :--- | :--------------------------- | :------- | :---------- |
+| esim | GetEsimHistoryOkResponseEsim | ❌       |             |
+
+# GetEsimHistoryOkResponseEsim
+
+**Properties**
+
+| Name    | Type      | Required | Description    |
+| :------ | :-------- | :------- | :------------- |
+| iccid   | string    | ❌       | ID of the eSIM |
+| history | History[] | ❌       |                |
+
+# History
+
+**Properties**
+
+| Name       | Type   | Required | Description                                                                                                                         |
+| :--------- | :----- | :------- | :---------------------------------------------------------------------------------------------------------------------------------- |
+| status     | string | ❌       | The status of the eSIM at a given time, possible values are 'RELEASED', 'DOWNLOADED', 'INSTALLED', 'ENABLED', 'DELETED', or 'ERROR' |
+| statusDate | string | ❌       | The date when the eSIM status changed in the format 'yyyy-MM-ddThh:mm:ssZZ'                                                         |
+| date       | number | ❌       | Epoch value representing the date when the eSIM status changed                                                                      |

package/documentation/models/GetEsimMacOkResponse.md

@@ -0,0 +1,17 @@
+# GetEsimMacOkResponse
+
+**Properties**
+
+| Name | Type                     | Required | Description |
+| :--- | :----------------------- | :------- | :---------- |
+| esim | GetEsimMacOkResponseEsim | ❌       |             |
+
+# GetEsimMacOkResponseEsim
+
+**Properties**
+
+| Name                 | Type   | Required | Description                |
+| :------------------- | :----- | :------- | :------------------------- |
+| iccid                | string | ❌       | ID of the eSIM             |
+| smdpAddress          | string | ❌       | SM-DP+ Address             |
+| manualActivationCode | string | ❌       | The manual activation code |

package/documentation/models/GetEsimOkResponse.md

@@ -0,0 +1,18 @@
+# GetEsimOkResponse
+
+**Properties**
+
+| Name | Type                  | Required | Description |
+| :--- | :-------------------- | :------- | :---------- |
+| esim | GetEsimOkResponseEsim | ❌       |             |
+
+# GetEsimOkResponseEsim
+
+**Properties**
+
+| Name                 | Type   | Required | Description                                                                                                     |
+| :------------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------- |
+| iccid                | string | ❌       | ID of the eSIM                                                                                                  |
+| smdpAddress          | string | ❌       | SM-DP+ Address                                                                                                  |
+| manualActivationCode | string | ❌       | The manual activation code                                                                                      |
+| status               | string | ❌       | Status of the eSIM, possible values are 'RELEASED', 'DOWNLOADED', 'INSTALLED', 'ENABLED', 'DELETED', or 'ERROR' |

package/documentation/models/GetPurchaseConsumptionOkResponse.md

@@ -0,0 +1,8 @@
+# GetPurchaseConsumptionOkResponse
+
+**Properties**
+
+| Name                      | Type   | Required | Description                                                              |
+| :------------------------ | :----- | :------- | :----------------------------------------------------------------------- |
+| dataUsageRemainingInBytes | number | ❌       | Remaining balance of the package in bytes                                |
+| status                    | string | ❌       | Status of the connectivity, possible values are 'ACTIVE' or 'NOT_ACTIVE' |

package/documentation/models/ListDestinationsOkResponse.md

@@ -0,0 +1,17 @@
+# ListDestinationsOkResponse
+
+**Properties**
+
+| Name         | Type           | Required | Description |
+| :----------- | :------------- | :------- | :---------- |
+| destinations | Destinations[] | ❌       |             |
+
+# Destinations
+
+**Properties**
+
+| Name               | Type     | Required | Description                                                                                                                                                                                                                                                                                                               |
+| :----------------- | :------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| name               | string   | ❌       | Name of the destination                                                                                                                                                                                                                                                                                                   |
+| destination        | string   | ❌       | ISO representation of the destination                                                                                                                                                                                                                                                                                     |
+| supportedCountries | 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. |

package/documentation/models/ListPackagesOkResponse.md

@@ -0,0 +1,21 @@
+# ListPackagesOkResponse
+
+**Properties**
+
+| Name        | Type       | Required | Description                                                                                                                                                                                                                                                                                    |
+| :---------- | :--------- | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| packages    | Packages[] | ❌       |                                                                                                                                                                                                                                                                                                |
+| afterCursor | 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 |
+
+# Packages
+
+**Properties**
+
+| Name             | Type   | Required | Description                                     |
+| :--------------- | :----- | :------- | :---------------------------------------------- |
+| id               | string | ❌       | ID of the package                               |
+| destination      | string | ❌       | ISO representation of the package's destination |
+| dataLimitInBytes | number | ❌       | Size of the package in Bytes                    |
+| minDays          | number | ❌       | Min number of days for the package              |
+| maxDays          | number | ❌       | Max number of days for the package              |
+| priceInCents     | number | ❌       | Price of the package in cents                   |

package/documentation/models/ListPurchasesOkResponse.md

@@ -0,0 +1,46 @@
+# ListPurchasesOkResponse
+
+**Properties**
+
+| Name        | Type        | Required | Description                                                                                                                                                                                                                                                                                     |
+| :---------- | :---------- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| purchases   | Purchases[] | ❌       |                                                                                                                                                                                                                                                                                                 |
+| afterCursor | 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. |
+
+# Purchases
+
+**Properties**
+
+| Name        | Type          | Required | Description                                                                                                                                                                                                       |
+| :---------- | :------------ | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| id          | string        | ❌       | ID of the purchase                                                                                                                                                                                                |
+| startDate   | string        | ❌       | Start date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'                                                                                                                                        |
+| endDate     | string        | ❌       | End date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'                                                                                                                                          |
+| createdDate | string        | ❌       | Creation date of the purchase in the format 'yyyy-MM-ddThh:mm:ssZZ'                                                                                                                                               |
+| startTime   | number        | ❌       | Epoch value representing the start time of the package's validity                                                                                                                                                 |
+| endTime     | number        | ❌       | Epoch value representing the end time of the package's validity                                                                                                                                                   |
+| createdAt   | number        | ❌       | Epoch value representing the date of creation of the purchase                                                                                                                                                     |
+| package     | Package\_     | ❌       |                                                                                                                                                                                                                   |
+| esim        | PurchasesEsim | ❌       |                                                                                                                                                                                                                   |
+| source      | string        | ❌       | The source indicates where the eSIM was purchased, which can be from the API, dashboard, landing-page or promo-page. For purchases made before September 8, 2023, the value will be displayed as 'Not available'. |
+| referenceId | 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.                                                             |
+
+# Package\_
+
+**Properties**
+
+| Name             | Type   | Required | Description                                     |
+| :--------------- | :----- | :------- | :---------------------------------------------- |
+| id               | string | ❌       | ID of the package                               |
+| dataLimitInBytes | number | ❌       | Size of the package in Bytes                    |
+| destination      | string | ❌       | ISO representation of the package's destination |
+| destinationName  | string | ❌       | Name of the package's destination               |
+| priceInCents     | number | ❌       | Price of the package in cents                   |
+
+# PurchasesEsim
+
+**Properties**
+
+| Name  | Type   | Required | Description    |
+| :---- | :----- | :------- | :------------- |
+| iccid | string | ❌       | ID of the eSIM |

package/documentation/models/TopUpEsimOkResponse.md

@@ -0,0 +1,30 @@
+# TopUpEsimOkResponse
+
+**Properties**
+
+| Name     | Type                        | Required | Description |
+| :------- | :-------------------------- | :------- | :---------- |
+| purchase | TopUpEsimOkResponsePurchase | ❌       |             |
+| profile  | TopUpEsimOkResponseProfile  | ❌       |             |
+
+# TopUpEsimOkResponsePurchase
+
+**Properties**
+
+| Name        | Type   | Required | Description                                                                |
+| :---------- | :----- | :------- | :------------------------------------------------------------------------- |
+| id          | string | ❌       | ID of the purchase                                                         |
+| packageId   | string | ❌       | ID of the package                                                          |
+| startDate   | string | ❌       | Start date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ' |
+| endDate     | string | ❌       | End date of the package's validity in the format 'yyyy-MM-ddThh:mm:ssZZ'   |
+| createdDate | string | ❌       | Creation date of the purchase in the format 'yyyy-MM-ddThh:mm:ssZZ'        |
+| startTime   | number | ❌       | Epoch value representing the start time of the package's validity          |
+| endTime     | number | ❌       | Epoch value representing the end time of the package's validity            |
+
+# TopUpEsimOkResponseProfile
+
+**Properties**
+
+| Name  | Type   | Required | Description    |
+| :---- | :----- | :------- | :------------- |
+| iccid | string | ❌       | ID of the eSIM |

package/documentation/models/TopUpEsimRequest.md

@@ -0,0 +1,14 @@
+# TopUpEsimRequest
+
+**Properties**
+
+| Name          | Type   | Required | Description                                                                                                                                             |
+| :------------ | :----- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| iccid         | string | ✅       | ID of the eSIM                                                                                                                                          |
+| dataLimitInGb | number | ✅       | Size of the package in GB. The available options are 1, 2, 3, 5, 8, 20GB                                                                                |
+| startDate     | 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.          |
+| endDate       | string | ✅       | End date of the package's validity in the format 'yyyy-MM-dd'. End date can be maximum 90 days after Start date.                                        |
+| email         | string | ❌       | Email address where the purchase confirmation email will be sent (excluding QR Code & activation steps)                                                 |
+| referenceId   | string | ❌       | An identifier provided by the partner to link this purchase to their booking or transaction for analytics and debugging purposes.                       |
+| startTime     | 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. |
+| endTime       | number | ❌       | Epoch value representing the end time of the package's validity. End time can be maximum 90 days after Start time.                                      |

package/documentation/services/DestinationsService.md

@@ -0,0 +1,35 @@
+# DestinationsService
+
+A list of all methods in the `DestinationsService` service. Click on the method name to view detailed information about that method.
+
+| Methods                               | Description       |
+| :------------------------------------ | :---------------- |
+| [listDestinations](#listdestinations) | List Destinations |
+
+## listDestinations
+
+List Destinations
+
+- HTTP Method: `GET`
+- Endpoint: `/destinations`
+
+**Return Type**
+
+`ListDestinationsOkResponse`
+
+**Example Usage Code Snippet**
+
+```typescript
+import { Celitech } from 'celitech-sdk';
+
+(async () => {
+  const celitech = new Celitech({
+    clientId: 'client-id',
+    clientSecret: 'client-secret',
+  });
+
+  const { data } = await celitech.destinations.listDestinations();
+
+  console.log(data);
+})();
+```

package/documentation/services/ESimService.md

@@ -0,0 +1,148 @@
+# ESimService
+
+A list of all methods in the `ESimService` service. Click on the method name to view detailed information about that method.
+
+| Methods                           | Description      |
+| :-------------------------------- | :--------------- |
+| [getESIM](#getesim)               | Get eSIM Status  |
+| [getESIMDevice](#getesimdevice)   | Get eSIM Device  |
+| [getESIMHistory](#getesimhistory) | Get eSIM History |
+| [getESIMMac](#getesimmac)         | Get eSIM MAC     |
+
+## getESIM
+
+Get eSIM Status
+
+- HTTP Method: `GET`
+- Endpoint: `/esim`
+
+**Parameters**
+
+| Name  | Type   | Required | Description    |
+| :---- | :----- | :------- | :------------- |
+| iccid | string | ✅       | ID of the eSIM |
+
+**Return Type**
+
+`GetEsimOkResponse`
+
+**Example Usage Code Snippet**
+
+```typescript
+import { Celitech } from 'celitech-sdk';
+
+(async () => {
+  const celitech = new Celitech({
+    clientId: 'client-id',
+    clientSecret: 'client-secret',
+  });
+
+  const { data } = await celitech.eSim.getEsim({
+    iccid: '1111222233334444555',
+  });
+
+  console.log(data);
+})();
+```
+
+## getESIMDevice
+
+Get eSIM Device
+
+- HTTP Method: `GET`
+- Endpoint: `/esim/{iccid}/device`
+
+**Parameters**
+
+| Name  | Type   | Required | Description    |
+| :---- | :----- | :------- | :------------- |
+| iccid | string | ✅       | ID of the eSIM |
+
+**Return Type**
+
+`GetEsimDeviceOkResponse`
+
+**Example Usage Code Snippet**
+
+```typescript
+import { Celitech } from 'celitech-sdk';
+
+(async () => {
+  const celitech = new Celitech({
+    clientId: 'client-id',
+    clientSecret: 'client-secret',
+  });
+
+  const { data } = await celitech.eSim.getEsimDevice('1111222233334444555');
+
+  console.log(data);
+})();
+```
+
+## getESIMHistory
+
+Get eSIM History
+
+- HTTP Method: `GET`
+- Endpoint: `/esim/{iccid}/history`
+
+**Parameters**
+
+| Name  | Type   | Required | Description    |
+| :---- | :----- | :------- | :------------- |
+| iccid | string | ✅       | ID of the eSIM |
+
+**Return Type**
+
+`GetEsimHistoryOkResponse`
+
+**Example Usage Code Snippet**
+
+```typescript
+import { Celitech } from 'celitech-sdk';
+
+(async () => {
+  const celitech = new Celitech({
+    clientId: 'client-id',
+    clientSecret: 'client-secret',
+  });
+
+  const { data } = await celitech.eSim.getEsimHistory('1111222233334444555');
+
+  console.log(data);
+})();
+```
+
+## getESIMMac
+
+Get eSIM MAC
+
+- HTTP Method: `GET`
+- Endpoint: `/esim/{iccid}/mac`
+
+**Parameters**
+
+| Name  | Type   | Required | Description    |
+| :---- | :----- | :------- | :------------- |
+| iccid | string | ✅       | ID of the eSIM |
+
+**Return Type**
+
+`GetEsimMacOkResponse`
+
+**Example Usage Code Snippet**
+
+```typescript
+import { Celitech } from 'celitech-sdk';
+
+(async () => {
+  const celitech = new Celitech({
+    clientId: 'client-id',
+    clientSecret: 'client-secret',
+  });
+
+  const { data } = await celitech.eSim.getEsimMac('1111222233334444555');
+
+  console.log(data);
+})();
+```

package/documentation/services/PackagesService.md

@@ -0,0 +1,48 @@
+# PackagesService
+
+A list of all methods in the `PackagesService` service. Click on the method name to view detailed information about that method.
+
+| Methods                       | Description   |
+| :---------------------------- | :------------ |
+| [listPackages](#listpackages) | List Packages |
+
+## listPackages
+
+List Packages
+
+- HTTP Method: `GET`
+- Endpoint: `/packages`
+
+**Parameters**
+
+| Name        | Type   | Required | Description                                                                                                                                                                                                         |
+| :---------- | :----- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| destination | string | ❌       | ISO representation of the package's destination.                                                                                                                                                                    |
+| startDate   | 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.                                                                      |
+| endDate     | string | ❌       | End date of the package's validity in the format 'yyyy-MM-dd'. End date can be maximum 90 days after Start date.                                                                                                    |
+| afterCursor | string | ❌       | 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. |
+| limit       | number | ❌       | 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                                                 |
+| startTime   | 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                                                              |
+| endTime     | number | ❌       | Epoch value representing the end time of the package's validity. End time can be maximum 90 days after Start time                                                                                                   |
+| duration    | number | ❌       | Duration in seconds for the package's validity. If this parameter is present, it will override the startTime and endTime parameters. The maximum duration for a package's validity period is 90 days                |
+
+**Return Type**
+
+`ListPackagesOkResponse`
+
+**Example Usage Code Snippet**
+
+```typescript
+import { Celitech } from 'celitech-sdk';
+
+(async () => {
+  const celitech = new Celitech({
+    clientId: 'client-id',
+    clientSecret: 'client-secret',
+  });
+
+  const { data } = await celitech.packages.listPackages({});
+
+  console.log(data);
+})();
+```