celitech-sdk 1.1.85 → 1.1.87

package/README.md

@@ -1,11 +1,11 @@
-# Celitech TypeScript SDK 1.1.85
+# Celitech TypeScript SDK 1.1.87
 
 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.1.85`
+- SDK version: `1.1.87`
 
 ## About the API
 
@@ -17,7 +17,8 @@ Welcome to the CELITECH API documentation! Useful links: [Homepage](https://www.
   - [Supported Language Versions](#supported-language-versions)
   - [Installation](#installation)
   - [Environment Variables](#environment-variables)
-- [Setting a custom Timeout](#setting-a-custom-timeout)
+- [Setting a Custom Timeout](#setting-a-custom-timeout)
+- [Sample Usage](#sample-usage)
 - [Services](#services)
 - [Models](#models)
 - [License](#license)
@@ -49,7 +50,7 @@ Environment variables are a way to configure your application outside the code.
 
 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
+## Setting a Custom Timeout
 
 You can set a custom timeout for the SDK's HTTP requests as follows:
 
@@ -57,6 +58,25 @@ 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:
+
+```ts
+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);
+})();
+```
+
 ## Services
 
 The SDK provides various services to interact with the API.
@@ -96,20 +116,6 @@ The SDK includes several models that represent the data structures used in API r
 | [GetEsimDeviceOkResponse](documentation/models/GetEsimDeviceOkResponse.md)                   |             |
 | [GetEsimHistoryOkResponse](documentation/models/GetEsimHistoryOkResponse.md)                 |             |
 | [GetEsimMacOkResponse](documentation/models/GetEsimMacOkResponse.md)                         |             |
-| [Destinations](documentation/models/Destinations.md)                                         |             |
-| [Packages](documentation/models/Packages.md)                                                 |             |
-| [Purchases](documentation/models/Purchases.md)                                               |             |
-| [Package\_](documentation/models/Package_.md)                                                |             |
-| [PurchasesEsim](documentation/models/PurchasesEsim.md)                                       |             |
-| [CreatePurchaseOkResponsePurchase](documentation/models/CreatePurchaseOkResponsePurchase.md) |             |
-| [CreatePurchaseOkResponseProfile](documentation/models/CreatePurchaseOkResponseProfile.md)   |             |
-| [TopUpEsimOkResponsePurchase](documentation/models/TopUpEsimOkResponsePurchase.md)           |             |
-| [TopUpEsimOkResponseProfile](documentation/models/TopUpEsimOkResponseProfile.md)             |             |
-| [GetEsimOkResponseEsim](documentation/models/GetEsimOkResponseEsim.md)                       |             |
-| [Device](documentation/models/Device.md)                                                     |             |
-| [GetEsimHistoryOkResponseEsim](documentation/models/GetEsimHistoryOkResponseEsim.md)         |             |
-| [History](documentation/models/History.md)                                                   |             |
-| [GetEsimMacOkResponseEsim](documentation/models/GetEsimMacOkResponseEsim.md)                 |             |
 
 </details>