Celitech TypeScript SDK 1.3.8

Welcome to the Celitech SDK documentation. This guide will help you get started with integrating and using the Celitech SDK in your project.

Versions

• API version: 1.1.0
• SDK version: 1.3.8

About the API

Welcome to the CELITECH API documentation! Useful links: Homepage | Support email | Blog

Table of Contents

• Setup & Configuration
  • Supported Language Versions
  • Installation
• Authentication
  • OAuth Authentication
  • Environment Variables
• Setting a Custom Timeout
• Sample Usage
• Services
• Models
• License

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: TypeScript >= 4.8.4

Installation

To get started with the SDK, we recommend installing using npm:

npm install celitech-sdk

Authentication

OAuth Authentication

The Celitech API uses OAuth for authentication.

You need to provide the OAuth parameters when initializing the SDK.

const sdk = new Celitech({ clientSecret: 'CLIENT_SECRET', clientId: 'CLIENT_ID' });

If you need to set or update the OAuth parameters after the SDK initialization, you can use:

const sdk = new Celitech();
sdk.clientId = 'CLIENT_ID';
sdk.clientSecret = 'CLIENT_SECRET';

Environment Variables

These are the environment variables for the SDK:

| Name | Description | | :------------ | :---------------------- | | CLIENT_ID | Client ID parameter | | CLIENT_SECRET | Client Secret parameter |

Environment variables are a way to configure your application outside the code. You can set these environment variables on the command line or use your project's existing tooling for managing environment variables.

If you are using a .env file, a template with the variable names is provided in the .env.example file located in the same directory as this README.

Setting a Custom Timeout

You can set a custom timeout for the SDK's HTTP requests as follows:

const celitech = new Celitech({ timeout: 10000 });

Sample Usage

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

import { Celitech } from 'celitech-sdk';

(async () => {
  const celitech = new Celitech({
    clientSecret: 'CLIENT_SECRET',
    clientId: 'CLIENT_ID',
  });

  const { data } = await celitech.destinations.listDestinations();

  console.log(data);
})();

Services

The SDK provides various services to interact with the API.

| Name | | :------------------------------------------------------------------- | | OAuthService | | DestinationsService | | PackagesService | | PurchasesService | | ESimService |

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

| Name | Description | | :------------------------------------------------------------------------------------------- | :---------- | | GetAccessTokenRequest | | | GetAccessTokenOkResponse | | | ListDestinationsOkResponse | | | ListPackagesOkResponse | | | ListPurchasesOkResponse | | | CreatePurchaseRequest | | | CreatePurchaseOkResponse | | | TopUpEsimRequest | | | TopUpEsimOkResponse | | | EditPurchaseRequest | | | EditPurchaseOkResponse | | | GetPurchaseConsumptionOkResponse | | | GetEsimOkResponse | | | GetEsimDeviceOkResponse | | | GetEsimHistoryOkResponse | | | GetEsimMacOkResponse | |

License

This SDK is licensed under the MIT License.

See the LICENSE file for more details.