celitech-sdk 1.1.84 → 1.1.86

package/documentation/services/ESimService.md

@@ -1,148 +0,0 @@
-# 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

@@ -1,48 +0,0 @@
-# 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);
-})();
-```

package/documentation/services/PurchasesService.md

@@ -1,219 +0,0 @@
-# PurchasesService
-
-A list of all methods in the `PurchasesService` service. Click on the method name to view detailed information about that method.
-
-| Methods                                           | Description                                                                                                                                                                                                                                                                                                            |
-| :------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [listPurchases](#listpurchases)                   | This endpoint can be used to list all the successful purchases made between a given interval.                                                                                                                                                                                                                          |
-| [createPurchase](#createpurchase)                 | This endpoint is used to purchase a new eSIM by providing the package details.                                                                                                                                                                                                                                         |
-| [topUpESIM](#topupesim)                           | 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 not feasible for eSIMs in "DELETED" or "ERROR" state.                                                                                                         |
-| [editPurchase](#editpurchase)                     | This endpoint allows you to modify the dates of an existing package with a future activation start time. Editing can only be performed for packages that have not been activated, and it cannot change the package size. The modification must not change the package duration category to ensure pricing consistency. |
-| [getPurchaseConsumption](#getpurchaseconsumption) | 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.                                                                                                                                       |
-
-## listPurchases
-
-This endpoint can be used to list all the successful purchases made between a given interval.
-
-- HTTP Method: `GET`
-- Endpoint: `/purchases`
-
-**Parameters**
-
-| Name        | Type   | Required | Description                                                                                                                                                                                                         |
-| :---------- | :----- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| iccid       | string | ❌       | ID of the eSIM                                                                                                                                                                                                      |
-| afterDate   | string | ❌       | Start date of the interval for filtering purchases in the format 'yyyy-MM-dd'                                                                                                                                       |
-| beforeDate  | string | ❌       | End date of the interval for filtering purchases in the format 'yyyy-MM-dd'                                                                                                                                         |
-| referenceId | string | ❌       | The referenceId that was provided by the partner during the purchase or topup flow.                                                                                                                                 |
-| 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 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                                                |
-| after       | number | ❌       | Epoch value representing the start of the time interval for filtering purchases                                                                                                                                     |
-| before      | number | ❌       | Epoch value representing the end of the time interval for filtering purchases                                                                                                                                       |
-
-**Return Type**
-
-`ListPurchasesOkResponse`
-
-**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.purchases.listPurchases({});
-
-  console.log(data);
-})();
-```
-
-## createPurchase
-
-This endpoint is used to purchase a new eSIM by providing the package details.
-
-- HTTP Method: `POST`
-- Endpoint: `/purchases`
-
-**Parameters**
-
-| Name | Type                                                        | Required | Description       |
-| :--- | :---------------------------------------------------------- | :------- | :---------------- |
-| body | [CreatePurchaseRequest](../models/CreatePurchaseRequest.md) | ✅       | The request body. |
-
-**Return Type**
-
-`CreatePurchaseOkResponse`
-
-**Example Usage Code Snippet**
-
-```typescript
-import { Celitech, CreatePurchaseRequest } from 'celitech-sdk';
-
-(async () => {
-  const celitech = new Celitech({
-    clientId: 'client-id',
-    clientSecret: 'client-secret',
-  });
-
-  const input: CreatePurchaseRequest = {
-    destination: 'FRA',
-    dataLimitInGb: 1,
-    startDate: '2023-11-01',
-    endDate: '2023-11-20',
-    email: 'example@domain.com',
-    referenceId: 'abc111222333444',
-    networkBrand: 'CELITECH',
-    startTime: 2.37,
-    endTime: 8.12,
-  };
-
-  const { data } = await celitech.purchases.createPurchase(input);
-
-  console.log(data);
-})();
-```
-
-## topUpESIM
-
-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 not feasible for eSIMs in "DELETED" or "ERROR" state.
-
-- HTTP Method: `POST`
-- Endpoint: `/purchases/topup`
-
-**Parameters**
-
-| Name | Type                                              | Required | Description       |
-| :--- | :------------------------------------------------ | :------- | :---------------- |
-| body | [TopUpEsimRequest](../models/TopUpEsimRequest.md) | ✅       | The request body. |
-
-**Return Type**
-
-`TopUpEsimOkResponse`
-
-**Example Usage Code Snippet**
-
-```typescript
-import { Celitech, TopUpEsimRequest } from 'celitech-sdk';
-
-(async () => {
-  const celitech = new Celitech({
-    clientId: 'client-id',
-    clientSecret: 'client-secret',
-  });
-
-  const input: TopUpEsimRequest = {
-    iccid: '1111222233334444555',
-    dataLimitInGb: 1,
-    startDate: '2023-11-01',
-    endDate: '2023-11-20',
-    email: 'example@domain.com',
-    referenceId: 'abc111222333444',
-    startTime: 8.12,
-    endTime: 4.35,
-  };
-
-  const { data } = await celitech.purchases.topUpEsim(input);
-
-  console.log(data);
-})();
-```
-
-## editPurchase
-
-This endpoint allows you to modify the dates of an existing package with a future activation start time. Editing can only be performed for packages that have not been activated, and it cannot change the package size. The modification must not change the package duration category to ensure pricing consistency.
-
-- HTTP Method: `POST`
-- Endpoint: `/purchases/edit`
-
-**Parameters**
-
-| Name | Type                                                    | Required | Description       |
-| :--- | :------------------------------------------------------ | :------- | :---------------- |
-| body | [EditPurchaseRequest](../models/EditPurchaseRequest.md) | ✅       | The request body. |
-
-**Return Type**
-
-`EditPurchaseOkResponse`
-
-**Example Usage Code Snippet**
-
-```typescript
-import { Celitech, EditPurchaseRequest } from 'celitech-sdk';
-
-(async () => {
-  const celitech = new Celitech({
-    clientId: 'client-id',
-    clientSecret: 'client-secret',
-  });
-
-  const input: EditPurchaseRequest = {
-    purchaseId: 'ae471106-c8b4-42cf-b83a-b061291f2922',
-    startDate: '2023-11-01',
-    endDate: '2023-11-20',
-    startTime: 8.76,
-    endTime: 4.68,
-  };
-
-  const { data } = await celitech.purchases.editPurchase(input);
-
-  console.log(data);
-})();
-```
-
-## getPurchaseConsumption
-
-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.
-
-- HTTP Method: `GET`
-- Endpoint: `/purchases/{purchaseId}/consumption`
-
-**Parameters**
-
-| Name       | Type   | Required | Description        |
-| :--------- | :----- | :------- | :----------------- |
-| purchaseId | string | ✅       | ID of the purchase |
-
-**Return Type**
-
-`GetPurchaseConsumptionOkResponse`
-
-**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.purchases.getPurchaseConsumption('4973fa15-6979-4daa-9cf3-672620df819c');
-
-  console.log(data);
-})();
-```

package/documentation/snippets/destinations-get.md

@@ -1,14 +0,0 @@
-```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/snippets/esim-get.md

@@ -1,16 +0,0 @@
-```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);
-})();
-```

package/documentation/snippets/esim-{iccid}-device-get.md

@@ -1,14 +0,0 @@
-```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);
-})();
-```

package/documentation/snippets/esim-{iccid}-history-get.md

@@ -1,14 +0,0 @@
-```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);
-})();
-```

package/documentation/snippets/esim-{iccid}-mac-get.md

@@ -1,14 +0,0 @@
-```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/snippets/packages-get.md

@@ -1,14 +0,0 @@
-```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);
-})();
-```

package/documentation/snippets/purchases-edit-post.md

@@ -1,22 +0,0 @@
-```typescript
-import { Celitech, EditPurchaseRequest } from 'celitech-sdk';
-
-(async () => {
-  const celitech = new Celitech({
-    clientId: 'client-id',
-    clientSecret: 'client-secret',
-  });
-
-  const input: EditPurchaseRequest = {
-    purchaseId: 'ae471106-c8b4-42cf-b83a-b061291f2922',
-    startDate: '2023-11-01',
-    endDate: '2023-11-20',
-    startTime: 8.76,
-    endTime: 4.68,
-  };
-
-  const { data } = await celitech.purchases.editPurchase(input);
-
-  console.log(data);
-})();
-```

package/documentation/snippets/purchases-get.md

@@ -1,14 +0,0 @@
-```typescript
-import { Celitech } from 'celitech-sdk';
-
-(async () => {
-  const celitech = new Celitech({
-    clientId: 'client-id',
-    clientSecret: 'client-secret',
-  });
-
-  const { data } = await celitech.purchases.listPurchases({});
-
-  console.log(data);
-})();
-```

package/documentation/snippets/purchases-post.md

@@ -1,26 +0,0 @@
-```typescript
-import { Celitech, CreatePurchaseRequest } from 'celitech-sdk';
-
-(async () => {
-  const celitech = new Celitech({
-    clientId: 'client-id',
-    clientSecret: 'client-secret',
-  });
-
-  const input: CreatePurchaseRequest = {
-    destination: 'FRA',
-    dataLimitInGb: 1,
-    startDate: '2023-11-01',
-    endDate: '2023-11-20',
-    email: 'example@domain.com',
-    referenceId: 'abc111222333444',
-    networkBrand: 'CELITECH',
-    startTime: 2.37,
-    endTime: 8.12,
-  };
-
-  const { data } = await celitech.purchases.createPurchase(input);
-
-  console.log(data);
-})();
-```

package/documentation/snippets/purchases-topup-post.md

@@ -1,25 +0,0 @@
-```typescript
-import { Celitech, TopUpEsimRequest } from 'celitech-sdk';
-
-(async () => {
-  const celitech = new Celitech({
-    clientId: 'client-id',
-    clientSecret: 'client-secret',
-  });
-
-  const input: TopUpEsimRequest = {
-    iccid: '1111222233334444555',
-    dataLimitInGb: 1,
-    startDate: '2023-11-01',
-    endDate: '2023-11-20',
-    email: 'example@domain.com',
-    referenceId: 'abc111222333444',
-    startTime: 8.12,
-    endTime: 4.35,
-  };
-
-  const { data } = await celitech.purchases.topUpEsim(input);
-
-  console.log(data);
-})();
-```

package/documentation/snippets/purchases-{purchaseId}-consumption-get.md

@@ -1,14 +0,0 @@
-```typescript
-import { Celitech } from 'celitech-sdk';
-
-(async () => {
-  const celitech = new Celitech({
-    clientId: 'client-id',
-    clientSecret: 'client-secret',
-  });
-
-  const { data } = await celitech.purchases.getPurchaseConsumption('4973fa15-6979-4daa-9cf3-672620df819c');
-
-  console.log(data);
-})();
-```

package/examples/README.md

@@ -1,27 +0,0 @@
-# celitech-sdk
-
-A basic example of how to use the celitech-sdk package.
-
-## Installation
-
-In the event `celitech-sdk` is not published to npm, you can install it locally by running the following command in the examples folder:
-
-```sh
-npm run setup
-```
-
-This will rebuild the parent package and install it locally.
-
-Otherwise you can install it from npm:
-
-```sh
-npm install celitech-sdk
-```
-
-## Usage
-
-To run the example, run the following command in the examples folder:
-
-```sh
-npm run start
-```

package/examples/package.json

@@ -1,18 +0,0 @@
-{
-  "name": "Celitech",
-  "version": "1.1.84",
-  "private": true,
-  "dependencies": {
-    "celitech-sdk": "file:../",
-    "zod": "3.22.0"
-  },
-  "scripts": {
-    "setup": "npm --prefix ../ install && npm --prefix ../ run build && npm install",
-    "start": "tsc && node dist/index.js",
-    "dev": "ts-node src/index.ts"
-  },
-  "devDependencies": {
-    "ts-node": "^10.9.1",
-    "typescript": "5.3.3"
-  }
-}

package/examples/src/index.ts

@@ -1,12 +0,0 @@
-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);
-})();