celitech-sdk 1.2.5 → 1.3.3

package/README.md

@@ -1,11 +1,11 @@
-# Celitech TypeScript SDK 1.2.5
+# Celitech TypeScript SDK 1.3.3
 
 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.2.5`
+- SDK version: `1.3.3`
 
 ## About the API
 
@@ -16,6 +16,8 @@ Welcome to the CELITECH API documentation! Useful links: [Homepage](https://www.
 - [Setup & Configuration](#setup--configuration)
   - [Supported Language Versions](#supported-language-versions)
   - [Installation](#installation)
+- [Authentication](#authentication)
+  - [OAuth Authentication](#oauth-authentication)
   - [Environment Variables](#environment-variables)
 - [Setting a Custom Timeout](#setting-a-custom-timeout)
 - [Sample Usage](#sample-usage)
@@ -37,6 +39,24 @@ 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.
+
+```ts
+
+```
+
+If you need to set or update the OAuth parameters after the SDK initialization, you can use:
+
+```ts
+
+```
+
 ## Environment Variables
 
 These are the environment variables for the SDK:
@@ -66,10 +86,7 @@ Below is a comprehensive example demonstrating how to authenticate and call a si
 import { Celitech } from 'celitech-sdk';
 
 (async () => {
-  const celitech = new Celitech({
-    clientId: 'client-id',
-    clientSecret: 'client-secret',
-  });
+  const celitech = new Celitech({});
 
   const { data } = await celitech.destinations.listDestinations();
 
@@ -86,6 +103,7 @@ The SDK provides various services to interact with the API.
 
 | Name                                                                 |
 | :------------------------------------------------------------------- |
+| [OAuthService](documentation/services/OAuthService.md)               |
 | [DestinationsService](documentation/services/DestinationsService.md) |
 | [PackagesService](documentation/services/PackagesService.md)         |
 | [PurchasesService](documentation/services/PurchasesService.md)       |
@@ -102,6 +120,8 @@ The SDK includes several models that represent the data structures used in API r
 
 | Name                                                                                         | Description |
 | :------------------------------------------------------------------------------------------- | :---------- |
+| [GetAccessTokenRequest](documentation/models/GetAccessTokenRequest.md)                       |             |
+| [GetAccessTokenOkResponse](documentation/models/GetAccessTokenOkResponse.md)                 |             |
 | [ListDestinationsOkResponse](documentation/models/ListDestinationsOkResponse.md)             |             |
 | [ListPackagesOkResponse](documentation/models/ListPackagesOkResponse.md)                     |             |
 | [ListPurchasesOkResponse](documentation/models/ListPurchasesOkResponse.md)                   |             |

package/dist/index.d.ts

@@ -46,6 +46,19 @@ declare enum SerializationStyle {
     NONE = "none"
 }
 
+declare class OAuthToken {
+    accessToken: string;
+    scopes: Set<string>;
+    expiresAt: number | null;
+    constructor(accessToken: string, scopes: Set<string>, expiresAt: number | null);
+    hasAllScopes(scopes: Set<string>): boolean;
+}
+declare class OAuthTokenManager {
+    private static instance;
+    private token?;
+    getToken(scopes: Set<string>, config: SdkConfig): Promise<OAuthToken>;
+}
+
 interface CreateRequestParameters<FullResponse, Page = unknown[]> {
     baseUrl: string;
     method: HttpMethod;
@@ -62,6 +75,8 @@ interface CreateRequestParameters<FullResponse, Page = unknown[]> {
     validation: ValidationOptions;
     retry: RetryOptions;
     pagination?: RequestPagination<Page>;
+    scopes: Set<string>;
+    tokenManager: OAuthTokenManager;
 }
 interface RequestParameter {
     key: string | undefined;
@@ -93,6 +108,8 @@ declare class Request<T = unknown, PageSchema = unknown[]> {
     validation: ValidationOptions;
     retry: RetryOptions;
     pagination?: RequestPagination<PageSchema>;
+    scopes: Set<string>;
+    tokenManager: OAuthTokenManager;
     private readonly pathPattern;
     constructor(params: CreateRequestParameters<T, PageSchema>);
     addHeaderParam(key: string, param: RequestParameter): void;
@@ -114,8 +131,8 @@ interface SdkConfig {
     baseUrl?: string;
     environment?: Environment;
     timeoutMs?: number;
-    clientId?: string;
-    clientSecret?: string;
+    clientId: string;
+    clientSecret: string;
     retry?: RetryOptions;
     validation?: ValidationOptions;
 }
@@ -152,11 +169,17 @@ interface ValidationOptions {
     responseValidation?: boolean;
 }
 
+declare class HttpError extends Error {
+    readonly error: string;
+    readonly metadata: HttpMetadata;
+    readonly raw?: ArrayBuffer;
+    constructor(metadata: HttpMetadata, raw?: ArrayBuffer, error?: string);
+}
+
 declare class CustomHook implements Hook {
-    getToken(clientId: string, clientSecret: string): Promise<any>;
     beforeRequest(request: HttpRequest, params: Map<string, string>): Promise<HttpRequest>;
     afterResponse(request: HttpRequest, response: HttpResponse$1<any>, params: Map<string, string>): Promise<HttpResponse$1<any>>;
-    onError(request: HttpRequest, response: HttpResponse$1<any>, params: Map<string, string>): Promise<HttpError$1>;
+    onError(request: HttpRequest, response: HttpResponse$1<any>, params: Map<string, string>): Promise<HttpError>;
 }
 
 declare class HttpClient {
@@ -172,8 +195,9 @@ declare class HttpClient {
 
 declare class BaseService {
     config: SdkConfig;
+    protected tokenManager: OAuthTokenManager;
     client: HttpClient;
-    constructor(config: SdkConfig);
+    constructor(config: SdkConfig, tokenManager: OAuthTokenManager);
     set baseUrl(baseUrl: string);
     set environment(environment: Environment);
     set timeoutMs(timeoutMs: number);
@@ -181,6 +205,68 @@ declare class BaseService {
     set clientSecret(clientSecret: string);
 }
 
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+declare const getAccessTokenRequest: z.ZodLazy<z.ZodObject<{
+    grantType: z.ZodOptional<z.ZodString>;
+    clientId: z.ZodOptional<z.ZodString>;
+    clientSecret: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    grantType?: string | undefined;
+    clientId?: string | undefined;
+    clientSecret?: string | undefined;
+}, {
+    grantType?: string | undefined;
+    clientId?: string | undefined;
+    clientSecret?: string | undefined;
+}>>;
+/**
+ *
+ * @typedef  {GetAccessTokenRequest} getAccessTokenRequest
+ * @property {GrantType}
+ * @property {string}
+ * @property {string}
+ */
+type GetAccessTokenRequest = z.infer<typeof getAccessTokenRequest>;
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+declare const getAccessTokenOkResponse: z.ZodLazy<z.ZodObject<{
+    accessToken: z.ZodOptional<z.ZodString>;
+    tokenType: z.ZodOptional<z.ZodString>;
+    expiresIn: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    accessToken?: string | undefined;
+    tokenType?: string | undefined;
+    expiresIn?: number | undefined;
+}, {
+    accessToken?: string | undefined;
+    tokenType?: string | undefined;
+    expiresIn?: number | undefined;
+}>>;
+/**
+ *
+ * @typedef  {GetAccessTokenOkResponse} getAccessTokenOkResponse
+ * @property {string}
+ * @property {string}
+ * @property {number}
+ */
+type GetAccessTokenOkResponse = z.infer<typeof getAccessTokenOkResponse>;
+
+declare class OAuthService extends BaseService {
+    /**
+     * This endpoint was added by liblab
+     * @returns {Promise<HttpResponse<GetAccessTokenOkResponse>>} Successful Response
+     */
+    getAccessToken(body: GetAccessTokenRequest, requestConfig?: RequestConfig): Promise<HttpResponse<GetAccessTokenOkResponse>>;
+}
+
+declare enum GrantType {
+    CLIENT_CREDENTIALS = "client_credentials"
+}
+
 /**
  * The shape of the model inside the application code - what the users use
  */
@@ -1521,19 +1607,14 @@ declare const getEsimMacOkResponseEsim: z.ZodLazy<z.ZodObject<{
  */
 type GetEsimMacOkResponseEsim = z.infer<typeof getEsimMacOkResponseEsim>;
 
-declare class HttpError extends Error {
-    readonly error: string;
-    readonly metadata: HttpMetadata;
-    readonly raw?: ArrayBuffer;
-    constructor(metadata: HttpMetadata, raw?: ArrayBuffer, error?: string);
-}
-
 declare class Celitech {
     config: SdkConfig;
+    readonly oAuth: OAuthService;
     readonly destinations: DestinationsService;
     readonly packages: PackagesService;
     readonly purchases: PurchasesService;
     readonly eSim: ESimService;
+    protected tokenManager: OAuthTokenManager;
     constructor(config: SdkConfig);
     set baseUrl(baseUrl: string);
     set environment(environment: Environment);
@@ -1542,4 +1623,4 @@ declare class Celitech {
     set clientSecret(clientSecret: string);
 }
 
-export { Celitech, CreatePurchaseOkResponse, CreatePurchaseOkResponseProfile, CreatePurchaseOkResponsePurchase, CreatePurchaseRequest, Destinations, DestinationsService, Device, ESimService, EditPurchaseOkResponse, EditPurchaseRequest, Environment, GetEsimDeviceOkResponse, GetEsimHistoryOkResponse, GetEsimHistoryOkResponseEsim, GetEsimMacOkResponse, GetEsimMacOkResponseEsim, GetEsimOkResponse, GetEsimOkResponseEsim, GetPurchaseConsumptionOkResponse, History, HttpError, HttpMetadata, HttpMethod, HttpResponse, ListDestinationsOkResponse, ListPackagesOkResponse, ListPurchasesOkResponse, Package_, Packages, PackagesService, Purchases, PurchasesEsim, PurchasesService, RequestConfig, RetryOptions, SdkConfig, TopUpEsimOkResponse, TopUpEsimOkResponseProfile, TopUpEsimOkResponsePurchase, TopUpEsimRequest, ValidationOptions };
+export { Celitech, CreatePurchaseOkResponse, CreatePurchaseOkResponseProfile, CreatePurchaseOkResponsePurchase, CreatePurchaseRequest, Destinations, DestinationsService, Device, ESimService, EditPurchaseOkResponse, EditPurchaseRequest, Environment, GetAccessTokenOkResponse, GetAccessTokenRequest, GetEsimDeviceOkResponse, GetEsimHistoryOkResponse, GetEsimHistoryOkResponseEsim, GetEsimMacOkResponse, GetEsimMacOkResponseEsim, GetEsimOkResponse, GetEsimOkResponseEsim, GetPurchaseConsumptionOkResponse, GrantType, History, HttpError, HttpMetadata, HttpMethod, HttpResponse, ListDestinationsOkResponse, ListPackagesOkResponse, ListPurchasesOkResponse, OAuthService, Package_, Packages, PackagesService, Purchases, PurchasesEsim, PurchasesService, RequestConfig, RetryOptions, SdkConfig, TopUpEsimOkResponse, TopUpEsimOkResponseProfile, TopUpEsimOkResponsePurchase, TopUpEsimRequest, ValidationOptions };