celitech-sdk 1.1.87 → 1.1.88

package/README.md

@@ -1,11 +1,11 @@
-# Celitech TypeScript SDK 1.1.87
+# Celitech TypeScript SDK 1.1.88
 
 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.87`
+- SDK version: `1.1.88`
 
 ## About the API
 

package/dist/index.d.ts

@@ -13,6 +13,7 @@ interface HttpRequest {
     body?: BodyInit;
     abortSignal?: AbortSignal;
     queryParams: Map<string, unknown>;
+    pathParams: Map<string, unknown>;
 }
 interface HttpMetadata$1 {
     status: number;
@@ -24,14 +25,14 @@ interface HttpResponse$1<T> {
     metadata: HttpMetadata$1;
     raw: ArrayBuffer;
 }
-interface HttpError {
+interface HttpError$1 {
     error: string;
     metadata: HttpMetadata$1;
 }
 interface Hook {
     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>;
+    onError(request: HttpRequest, response: HttpResponse$1<any>, params: Map<string, string>): Promise<HttpError$1>;
 }
 
 declare enum SerializationStyle {
@@ -45,7 +46,7 @@ declare enum SerializationStyle {
     NONE = "none"
 }
 
-interface CreateRequestParameters<T> {
+interface CreateRequestParameters<FullResponse, Page = unknown[]> {
     baseUrl: string;
     method: HttpMethod;
     body?: any;
@@ -54,12 +55,13 @@ interface CreateRequestParameters<T> {
     pathParams: Map<string, RequestParameter>;
     path: string;
     config: SdkConfig;
-    responseSchema: ZodType<T, any, any>;
+    responseSchema: ZodType<FullResponse, any, any>;
     requestSchema: ZodType;
     requestContentType: ContentType;
     responseContentType: ContentType;
     validation: ValidationOptions;
     retry: RetryOptions;
+    pagination?: RequestPagination<Page>;
 }
 interface RequestParameter {
     key: string | undefined;
@@ -67,8 +69,15 @@ interface RequestParameter {
     explode: boolean;
     encode: boolean;
     style: SerializationStyle;
+    isLimit: boolean;
+    isOffset: boolean;
+}
+interface RequestPagination<Page> {
+    pageSize: number;
+    pagePath: string[];
+    pageSchema?: ZodType<Page, any, any>;
 }
-declare class Request<T> {
+declare class Request<T = unknown, PageSchema = unknown[]> {
     baseUrl: string;
     headers: Map<string, RequestParameter>;
     queryParams: Map<string, RequestParameter>;
@@ -83,25 +92,28 @@ declare class Request<T> {
     responseContentType: ContentType;
     validation: ValidationOptions;
     retry: RetryOptions;
+    pagination?: RequestPagination<PageSchema>;
     private readonly pathPattern;
-    constructor(params: CreateRequestParameters<T>);
+    constructor(params: CreateRequestParameters<T, PageSchema>);
     addHeaderParam(key: string, param: RequestParameter): void;
     addQueryParam(key: string, param: RequestParameter): void;
     addPathParam(key: string, param: RequestParameter): void;
     addBody(body: any): void;
     updateFromHookRequest(hookRequest: HttpRequest): void;
-    toHookRequest(): HttpRequest;
     constructFullUrl(): string;
-    copy(overrides?: Partial<CreateRequestParameters<T>>): Request<T>;
+    copy(overrides?: Partial<CreateRequestParameters<T>>): Request<T, unknown[]>;
     getHeaders(): HeadersInit | undefined;
+    nextPage(): void;
     private constructPath;
+    private getOffsetParam;
+    private getAllParams;
 }
 
 type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD';
 interface SdkConfig {
     baseUrl?: string;
     environment?: Environment;
-    timeout?: number;
+    timeoutMs?: number;
     clientId?: string;
     clientSecret?: string;
     retry?: RetryOptions;
@@ -144,7 +156,7 @@ 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>;
+    onError(request: HttpRequest, response: HttpResponse$1<any>, params: Map<string, string>): Promise<HttpError$1>;
 }
 
 declare class HttpClient {
@@ -152,8 +164,10 @@ declare class HttpClient {
     private readonly requestHandlerChain;
     constructor(config: SdkConfig, hook?: CustomHook);
     call<T>(request: Request<T>): Promise<HttpResponse<T>>;
+    callPaginated<FullResponse, Page>(request: Request<FullResponse, Page>): Promise<HttpResponse<Page>>;
     setBaseUrl(url: string): void;
     setConfig(config: SdkConfig): void;
+    private getPage;
 }
 
 declare class BaseService {
@@ -162,7 +176,7 @@ declare class BaseService {
     constructor(config: SdkConfig);
     set baseUrl(baseUrl: string);
     set environment(environment: Environment);
-    set timeout(timeout: number);
+    set timeoutMs(timeoutMs: number);
     set clientId(clientId: string);
     set clientSecret(clientSecret: string);
 }
@@ -586,12 +600,15 @@ declare const createPurchaseOkResponse: z.ZodLazy<z.ZodObject<{
     profile: z.ZodOptional<z.ZodLazy<z.ZodObject<{
         iccid: z.ZodOptional<z.ZodString>;
         activationCode: z.ZodOptional<z.ZodString>;
+        manualActivationCode: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         iccid?: string | undefined;
         activationCode?: string | undefined;
+        manualActivationCode?: string | undefined;
     }, {
         iccid?: string | undefined;
         activationCode?: string | undefined;
+        manualActivationCode?: string | undefined;
     }>>>;
 }, "strip", z.ZodTypeAny, {
     purchase?: {
@@ -606,6 +623,7 @@ declare const createPurchaseOkResponse: z.ZodLazy<z.ZodObject<{
     profile?: {
         iccid?: string | undefined;
         activationCode?: string | undefined;
+        manualActivationCode?: string | undefined;
     } | undefined;
 }, {
     purchase?: {
@@ -620,6 +638,7 @@ declare const createPurchaseOkResponse: z.ZodLazy<z.ZodObject<{
     profile?: {
         iccid?: string | undefined;
         activationCode?: string | undefined;
+        manualActivationCode?: string | undefined;
     } | undefined;
 }>>;
 /**
@@ -1064,18 +1083,22 @@ type CreatePurchaseOkResponsePurchase = z.infer<typeof createPurchaseOkResponseP
 declare const createPurchaseOkResponseProfile: z.ZodLazy<z.ZodObject<{
     iccid: z.ZodOptional<z.ZodString>;
     activationCode: z.ZodOptional<z.ZodString>;
+    manualActivationCode: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     iccid?: string | undefined;
     activationCode?: string | undefined;
+    manualActivationCode?: string | undefined;
 }, {
     iccid?: string | undefined;
     activationCode?: string | undefined;
+    manualActivationCode?: string | undefined;
 }>>;
 /**
  *
  * @typedef  {CreatePurchaseOkResponseProfile} createPurchaseOkResponseProfile
  * @property {string} - ID of the eSIM
  * @property {string} - QR Code of the eSIM as base64
+ * @property {string} - Manual Activation Code of the eSIM
  */
 type CreatePurchaseOkResponseProfile = z.infer<typeof createPurchaseOkResponseProfile>;
 
@@ -1498,6 +1521,13 @@ 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 destinations: DestinationsService;
@@ -1507,9 +1537,9 @@ declare class Celitech {
     constructor(config: SdkConfig);
     set baseUrl(baseUrl: string);
     set environment(environment: Environment);
-    set timeout(timeout: number);
+    set timeoutMs(timeoutMs: number);
     set clientId(clientId: string);
     set clientSecret(clientSecret: string);
 }
 
-export { Celitech, CreatePurchaseOkResponse, CreatePurchaseOkResponseProfile, CreatePurchaseOkResponsePurchase, CreatePurchaseRequest, Destinations, DestinationsService, Device, ESimService, EditPurchaseOkResponse, EditPurchaseRequest, GetEsimDeviceOkResponse, GetEsimHistoryOkResponse, GetEsimHistoryOkResponseEsim, GetEsimMacOkResponse, GetEsimMacOkResponseEsim, GetEsimOkResponse, GetEsimOkResponseEsim, GetPurchaseConsumptionOkResponse, History, 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, 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 };