@tourist-esim/touristesim-nodejs-sdk 1.0.4 → 1.2.0

package/README.md

@@ -60,7 +60,7 @@ const plans = await sdk.plans().get({
 });
 
 // Get single plan
-const plan = await sdk.plans().find(123);
+const plan = await sdk.plans().find('vietnam_100mb_7days_7e87c5');
 
 // Get plans by country
 const usPlans = await sdk.plans().byCountry('US');
@@ -69,7 +69,7 @@ const usPlans = await sdk.plans().byCountry('US');
 const globalPlans = await sdk.plans().global();
 
 // Validate plan
-const validation = await sdk.plans().validate(123, 5);
+const validation = await sdk.plans().validate('vietnam_100mb_7days_7e87c5', 5);
 ```
 
 ### Countries
@@ -93,19 +93,17 @@ const featured = await sdk.countries().featured();
 ```typescript
 // Create order
 const order = await sdk.orders().create({
-  plan_id: 123,
-  quantity: 2,
-  customer_email: 'customer@example.com'
+  plans: [{ plan_slug: 'vietnam_100mb_7days_7e87c5', quantity: 1 }],
+  customer: { email: 'customer@example.com', name: 'Jane Doe' },
 });
 
 // Get orders
 const orders = await sdk.orders().all();
 
-// Get single order
-const order = await sdk.orders().find(456);
+// Get single order by order number
+const order = await sdk.orders().find('PO-260519MKAUVE');
 
-// Cancel order
-await sdk.orders().cancel(456);
+// To request a cancellation or refund, contact Tourist eSIM support
 ```
 
 ### eSIMs
@@ -141,7 +139,7 @@ import {
 } from '@tourist-esim/touristesim-nodejs-sdk';
 
 try {
-  const plan = await sdk.plans().find(999);
+  const plan = await sdk.plans().find('nonexistent_plan_slug');
 } catch (error) {
   if (error instanceof AuthenticationException) {
     console.error('Auth failed:', error.message);

package/dist/Models/Model.d.ts

@@ -19,6 +19,7 @@ export declare class Model {
  */
 export declare class Plan extends Model {
     protected casts: Record<string, string>;
+    getPlanSlug(): string;
     getType(): string;
     isLocal(): boolean;
     isRegional(): boolean;
@@ -59,8 +60,7 @@ export declare class Order extends Model {
     isPending(): boolean;
     isFailed(): boolean;
     isCancelled(): boolean;
-    getTotalPrice(): number;
-    getQuantity(): number;
+    getItemsCount(): number;
 }
 /**
  * eSIM Model
@@ -75,4 +75,16 @@ export declare class Esim extends Model {
     getIccid(): string;
     getBalanceData(): number;
     getValidityEnd(): string | null;
+    getCoverage(): Record<string, unknown> | null;
+    getCoverageType(): string | null;
+    getCoverageLabel(): string | null;
+    getCoverageCountries(): Record<string, unknown>[];
+    getCoverageRegion(): Record<string, unknown> | null;
+    getNetworkOperators(): Record<string, unknown> | null;
+    getNetworkOperatorsCount(): number;
+    getNetworkOperatorNames(): string[];
+    getShareLink(): Record<string, unknown> | null;
+    getShareLinkSlug(): string | null;
+    getShareLinkUrl(): string | null;
+    getShareLinkPin(): string | null;
 }

package/dist/Models/Model.js

@@ -64,7 +64,6 @@ export class Plan extends Model {
     constructor() {
         super(...arguments);
         this.casts = {
-            id: 'integer',
             price: 'float',
             data: 'integer',
             validity_days: 'integer',
@@ -72,6 +71,9 @@ export class Plan extends Model {
             countries_count: 'integer',
         };
     }
+    getPlanSlug() {
+        return this.get('plan_slug', '');
+    }
     getType() {
         return this.get('type', 'local');
     }
@@ -152,10 +154,9 @@ export class Order extends Model {
     constructor() {
         super(...arguments);
         this.casts = {
-            id: 'integer',
-            plan_id: 'integer',
-            quantity: 'integer',
-            total_price: 'float',
+            items_count: 'integer',
+            amount: 'float',
+            is_sandbox: 'boolean',
         };
     }
     getStatus() {
@@ -173,11 +174,8 @@ export class Order extends Model {
     isCancelled() {
         return this.getStatus() === 'cancelled';
     }
-    getTotalPrice() {
-        return this.get('total_price', 0);
-    }
-    getQuantity() {
-        return this.get('quantity', 0);
+    getItemsCount() {
+        return this.get('items_count', 0);
     }
 }
 /**
@@ -214,4 +212,49 @@ export class Esim extends Model {
     getValidityEnd() {
         return this.get('validity_end', null);
     }
+    getCoverage() {
+        return this.get('coverage', null);
+    }
+    getCoverageType() {
+        const coverage = this.getCoverage();
+        return coverage?.type;
+    }
+    getCoverageLabel() {
+        const coverage = this.getCoverage();
+        return coverage?.label;
+    }
+    getCoverageCountries() {
+        const coverage = this.getCoverage();
+        return coverage?.countries || [];
+    }
+    getCoverageRegion() {
+        const coverage = this.getCoverage();
+        return coverage?.region || null;
+    }
+    getNetworkOperators() {
+        return this.get('network_operators', null);
+    }
+    getNetworkOperatorsCount() {
+        const operators = this.getNetworkOperators();
+        return operators?.count || 0;
+    }
+    getNetworkOperatorNames() {
+        const operators = this.getNetworkOperators();
+        return operators?.operators || [];
+    }
+    getShareLink() {
+        return this.get('share_link', null);
+    }
+    getShareLinkSlug() {
+        const shareLink = this.getShareLink();
+        return shareLink?.slug || null;
+    }
+    getShareLinkUrl() {
+        const shareLink = this.getShareLink();
+        return shareLink?.url || null;
+    }
+    getShareLinkPin() {
+        const shareLink = this.getShareLink();
+        return shareLink?.pin || null;
+    }
 }

package/dist/Resources/Plans.d.ts

@@ -7,7 +7,7 @@ import { Collection, PaginatedCollection } from '../Support/Collection.js';
 export declare class Plans extends Resource {
     get(filters?: Record<string, any>): Promise<PaginatedCollection>;
     find(id: number | string): Promise<Plan>;
-    validate(planId: number, quantity: number): Promise<Record<string, any>>;
+    validate(planSlug: string, quantity: number): Promise<Record<string, any>>;
     byCountry(code: string, perPage?: number): Promise<Collection<Plan>>;
     byRegion(slug: string, perPage?: number): Promise<Collection<Plan>>;
     global(perPage?: number): Promise<Collection<Plan>>;

package/dist/Resources/Plans.js

@@ -13,9 +13,9 @@ export class Plans extends Resource {
         const response = await this.client.get(`/plans/${id}`);
         return new Plan(response.data);
     }
-    async validate(planId, quantity) {
+    async validate(planSlug, quantity) {
         const response = await this.client.post('/plans/validate', {
-            plan_id: planId,
+            plan_slug: planSlug,
             quantity,
         });
         return response.data || {};

package/dist/Resources/index.d.ts

@@ -12,9 +12,8 @@ import { Order } from '../Models/Model.js';
 import { Collection, PaginatedCollection } from '../Support/Collection.js';
 export declare class Orders extends Resource {
     all(filters?: Record<string, any>): Promise<PaginatedCollection<Order>>;
-    find(id: number | string): Promise<Order>;
+    find(orderNumber: string): Promise<Order>;
     create(data: Record<string, any>): Promise<Order>;
-    cancel(id: number | string): Promise<boolean>;
 }
 /**
  * Esims Resource

package/dist/Resources/index.js

@@ -18,18 +18,14 @@ export class Orders extends Resource {
         const response = await this.client.get('/orders', filters);
         return new PaginatedCollection(Collection.make(response.data?.orders || [], Order).all(), response.data?.pagination || {});
     }
-    async find(id) {
-        const response = await this.client.get(`/orders/${id}`);
+    async find(orderNumber) {
+        const response = await this.client.get(`/orders/${orderNumber}`);
         return new Order(response.data);
     }
     async create(data) {
         const response = await this.client.post('/orders', data);
         return new Order(response.data);
     }
-    async cancel(id) {
-        await this.client.post(`/orders/${id}/cancel`, {});
-        return true;
-    }
 }
 /**
  * Esims Resource

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tourist-esim/touristesim-nodejs-sdk",
-  "version": "1.0.4",
+  "version": "1.2.0",
   "description": "Official Node.js SDK for Tourist eSIM Partner API - Easy integration for resellers and partners",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -50,4 +50,4 @@
     "ts-jest": "^29.1.1",
     "typescript": "^5.2.0"
   }
-}
+}

package/src/Models/Model.ts

@@ -72,7 +72,6 @@ export class Model {
  */
 export class Plan extends Model {
   protected casts: Record<string, string> = {
-    id: 'integer',
     price: 'float',
     data: 'integer',
     validity_days: 'integer',
@@ -80,6 +79,10 @@ export class Plan extends Model {
     countries_count: 'integer',
   };
 
+  getPlanSlug(): string {
+    return this.get('plan_slug', '');
+  }
+
   getType(): string {
     return this.get('type', 'local');
   }
@@ -176,10 +179,9 @@ export class Country extends Model {
  */
 export class Order extends Model {
   protected casts: Record<string, string> = {
-    id: 'integer',
-    plan_id: 'integer',
-    quantity: 'integer',
-    total_price: 'float',
+    items_count: 'integer',
+    amount: 'float',
+    is_sandbox: 'boolean',
   };
 
   getStatus(): string {
@@ -202,12 +204,8 @@ export class Order extends Model {
     return this.getStatus() === 'cancelled';
   }
 
-  getTotalPrice(): number {
-    return this.get('total_price', 0);
-  }
-
-  getQuantity(): number {
-    return this.get('quantity', 0);
+  getItemsCount(): number {
+    return this.get('items_count', 0);
   }
 }
 
@@ -250,4 +248,61 @@ export class Esim extends Model {
   getValidityEnd(): string | null {
     return this.get('validity_end', null);
   }
+
+  getCoverage(): Record<string, unknown> | null {
+    return this.get('coverage', null);
+  }
+
+  getCoverageType(): string | null {
+    const coverage = this.getCoverage();
+    return coverage?.type as string | null;
+  }
+
+  getCoverageLabel(): string | null {
+    const coverage = this.getCoverage();
+    return coverage?.label as string | null;
+  }
+
+  getCoverageCountries(): Record<string, unknown>[] {
+    const coverage = this.getCoverage();
+    return (coverage?.countries as Record<string, unknown>[]) || [];
+  }
+
+  getCoverageRegion(): Record<string, unknown> | null {
+    const coverage = this.getCoverage();
+    return (coverage?.region as Record<string, unknown>) || null;
+  }
+
+  getNetworkOperators(): Record<string, unknown> | null {
+    return this.get('network_operators', null);
+  }
+
+  getNetworkOperatorsCount(): number {
+    const operators = this.getNetworkOperators();
+    return (operators?.count as number) || 0;
+  }
+
+  getNetworkOperatorNames(): string[] {
+    const operators = this.getNetworkOperators();
+    return (operators?.operators as string[]) || [];
+  }
+
+  getShareLink(): Record<string, unknown> | null {
+    return this.get('share_link', null);
+  }
+
+  getShareLinkSlug(): string | null {
+    const shareLink = this.getShareLink();
+    return (shareLink?.slug as string) || null;
+  }
+
+  getShareLinkUrl(): string | null {
+    const shareLink = this.getShareLink();
+    return (shareLink?.url as string) || null;
+  }
+
+  getShareLinkPin(): string | null {
+    const shareLink = this.getShareLink();
+    return (shareLink?.pin as string) || null;
+  }
 }

package/src/Resources/Plans.ts

@@ -19,9 +19,9 @@ export class Plans extends Resource {
     return new Plan(response.data);
   }
 
-  async validate(planId: number, quantity: number): Promise<Record<string, any>> {
+  async validate(planSlug: string, quantity: number): Promise<Record<string, any>> {
     const response = await this.client.post('/plans/validate', {
-      plan_id: planId,
+      plan_slug: planSlug,
       quantity,
     });
     return response.data || {};

package/src/Resources/index.ts

@@ -25,8 +25,8 @@ export class Orders extends Resource {
     );
   }
 
-  async find(id: number | string): Promise<Order> {
-    const response = await this.client.get(`/orders/${id}`);
+  async find(orderNumber: string): Promise<Order> {
+    const response = await this.client.get(`/orders/${orderNumber}`);
     return new Order(response.data);
   }
 
@@ -34,11 +34,6 @@ export class Orders extends Resource {
     const response = await this.client.post('/orders', data);
     return new Order(response.data);
   }
-
-  async cancel(id: number | string): Promise<boolean> {
-    await this.client.post(`/orders/${id}/cancel`, {});
-    return true;
-  }
 }
 
 /**