pathao-merchant-sdk 1.1.0 → 2.0.0

package/dist/index.d.mts

@@ -3,8 +3,9 @@
  *
  * Official API Details:
  * - Authentication: OAuth2 with client_id, client_secret, username, password
- * - Live URL: https://api-hermes.pathao.com
  * - All endpoints use /aladdin/api/v1/ prefix
+ * - Base URL can be set via PATHAO_BASE_URL environment variable or constructor config
+ * - Timeout can be set via PATHAO_TIMEOUT environment variable or constructor config
  */
 interface PathaoAuthResponse {
     token_type: string;
@@ -34,11 +35,12 @@ interface PathaoStoreRequest {
     name: string;
     contact_name: string;
     contact_number: string;
+    secondary_contact?: string;
+    otp_number?: string;
     address: string;
     city_id: number;
     zone_id: number;
     area_id: number;
-    store_type: number;
 }
 interface PathaoOrderResponse {
     type: string;
@@ -46,44 +48,46 @@ interface PathaoOrderResponse {
     message: string;
     data: {
         consignment_id: string;
-        invoice_id: string;
         merchant_order_id: string;
-        store_id: number;
-        recipient_name: string;
-        recipient_phone: string;
-        recipient_address: string;
-        recipient_city: string;
-        recipient_zone: string;
-        recipient_area: string;
-        delivery_type: string;
-        item_type: string;
-        item_quantity: number;
-        item_weight: number;
-        item_description: string;
-        amount_to_collect: number;
-        special_instruction: string;
-        status: string;
-        created_at: string;
-        updated_at: string;
+        order_status: string;
+        delivery_fee: number;
     };
 }
-interface PathaoStoreResponse {
+interface PathaoStoreCreateResponse {
     type: string;
     code: number;
     message: string;
     data: {
-        store_id: number;
-        name: string;
-        contact_name: string;
-        contact_number: string;
-        address: string;
-        city_id: number;
-        zone_id: number;
-        area_id: number;
-        store_type: number;
-        status: string;
-        created_at: string;
-        updated_at: string;
+        store_name: string;
+    };
+}
+interface PathaoStore {
+    store_id: number;
+    store_name: string;
+    store_address: string;
+    is_active: number;
+    city_id: number;
+    zone_id: number;
+    hub_id: number;
+    is_default_store: boolean;
+    is_default_return_store: boolean;
+}
+interface PathaoStoreListResponse {
+    type: string;
+    code: number;
+    message: string;
+    data: {
+        data: PathaoStore[];
+        total: number;
+        current_page: number;
+        per_page: number;
+        total_in_page: number;
+        last_page: number;
+        path: string;
+        to: number;
+        from: number;
+        last_page_url: string;
+        first_page_url: string;
     };
 }
 interface PathaoPriceRequest {
@@ -93,42 +97,32 @@ interface PathaoPriceRequest {
     delivery_type: number;
     recipient_city: number;
     recipient_zone: number;
-    recipient_area: number;
 }
 interface PathaoPriceResponse {
     type: string;
     code: number;
     message: string;
     data: {
-        store_id: number;
-        item_type: string;
-        item_weight: number;
-        delivery_type: string;
-        recipient_city: string;
-        recipient_zone: string;
-        recipient_area: string;
-        delivery_charge: number;
-        cod_charge: number;
-        total_charge: number;
-        currency: string;
+        price: number;
+        discount: number;
+        promo_discount: number;
+        plan_id: number;
+        cod_enabled: number;
+        cod_percentage: number;
+        additional_charge: number;
+        final_price: number;
     };
 }
 interface PathaoCityResponse {
     type: string;
     code: number;
     message: string;
-    data: Array<{
-        city_id: number;
-        city_name: string;
-        zone_list: Array<{
-            zone_id: number;
-            zone_name: string;
-            area_list: Array<{
-                area_id: number;
-                area_name: string;
-            }>;
+    data: {
+        data: Array<{
+            city_id: number;
+            city_name: string;
         }>;
-    }>;
+    };
 }
 interface PathaoOrderStatusResponse {
     type: string;
@@ -136,47 +130,43 @@ interface PathaoOrderStatusResponse {
     message: string;
     data: {
         consignment_id: string;
-        invoice_id: string;
         merchant_order_id: string;
-        store_id: number;
-        recipient_name: string;
-        recipient_phone: string;
-        recipient_address: string;
-        recipient_city: string;
-        recipient_zone: string;
-        recipient_area: string;
-        delivery_type: string;
-        item_type: string;
-        item_quantity: number;
-        item_weight: number;
-        item_description: string;
-        amount_to_collect: number;
-        special_instruction: string;
-        status: string;
-        status_updated_at: string;
-        created_at: string;
+        order_status: string;
+        order_status_slug: string;
         updated_at: string;
+        invoice_id: string | null;
+    };
+}
+interface PathaoZoneResponse {
+    type: string;
+    code: number;
+    message: string;
+    data: {
+        data: Array<{
+            zone_id: number;
+            zone_name: string;
+        }>;
     };
 }
 interface PathaoAreaResponse {
     type: string;
     code: number;
     message: string;
-    data: Array<{
-        area_id: number;
-        area_name: string;
-        zone_id: number;
-        zone_name: string;
-        city_id: number;
-        city_name: string;
-    }>;
+    data: {
+        data: Array<{
+            area_id: number;
+            area_name: string;
+            home_delivery_available: boolean;
+            pickup_available: boolean;
+        }>;
+    };
 }
 interface PathaoConfig {
     clientId: string;
     clientSecret: string;
     username: string;
     password: string;
-    baseURL?: string;
+    baseURL: string;
     timeout?: number;
 }
 interface PathaoError {
@@ -194,10 +184,6 @@ declare enum ItemType {
     DOCUMENT = 1,
     PARCEL = 2
 }
-declare enum StoreType {
-    PICKUP_POINT = 1,
-    SERVICE_POINT = 2
-}
 
 /**
  * Pathao Merchant API Service (Unofficial SDK)
@@ -206,8 +192,9 @@ declare enum StoreType {
  *
  * API Details (based on public documentation):
  * - Authentication: OAuth2 with client_id, client_secret, username, password
- * - Live URL: https://api-hermes.pathao.com
  * - All endpoints use /aladdin/api/v1/ prefix
+ * - Base URL can be set via PATHAO_BASE_URL environment variable or constructor config
+ * - Timeout can be set via PATHAO_TIMEOUT environment variable or constructor config
  *
  * Features implemented:
  * - Token-based authentication with refresh token support
@@ -224,23 +211,42 @@ declare class PathaoApiService {
     private refreshToken;
     private tokenExpiry;
     private config;
+    private isAuthenticating;
+    private authPromise;
+    private requestQueue;
+    private circuitBreaker;
     constructor(config: PathaoConfig);
     private ensureAuthenticated;
+    private performAuthentication;
+    private processRequestQueue;
     private authenticate;
     private refreshAccessToken;
     private getErrorMessage;
+    private handleCircuitBreaker;
     createOrder(orderData: PathaoOrderRequest): Promise<PathaoOrderResponse>;
-    createStore(storeData: PathaoStoreRequest): Promise<PathaoStoreResponse>;
-    getStores(): Promise<PathaoStoreResponse[]>;
+    createStore(storeData: PathaoStoreRequest): Promise<PathaoStoreCreateResponse>;
+    getStores(): Promise<PathaoStoreListResponse>;
     calculatePrice(priceData: PathaoPriceRequest): Promise<PathaoPriceResponse>;
     getCities(): Promise<PathaoCityResponse>;
-    getAreas(): Promise<PathaoAreaResponse>;
+    getZones(cityId: number): Promise<PathaoZoneResponse>;
+    getAreas(zoneId: number): Promise<PathaoAreaResponse>;
     getOrderStatus(consignmentId: string): Promise<PathaoOrderStatusResponse>;
+    createBulkOrder(orders: PathaoOrderRequest[]): Promise<{
+        message: string;
+        type: string;
+        code: number;
+        data: boolean;
+    }>;
     static validatePhoneNumber(phone: string): boolean;
     static formatPhoneNumber(phone: string): string;
     static validateAddress(address: string): boolean;
     static validateWeight(weight: number): boolean;
     static validateRecipientName(name: string): boolean;
+    static validateStoreName(name: string): boolean;
+    static validateContactName(name: string): boolean;
+    static validateContactNumber(phone: string): boolean;
+    static validateStoreAddress(address: string): boolean;
+    clearAuth(): void;
 }
 
-export { DeliveryType, ItemType, PathaoApiService, type PathaoAreaResponse, type PathaoAuthResponse, type PathaoCityResponse, type PathaoConfig, type PathaoError, type PathaoOrderRequest, type PathaoOrderResponse, type PathaoOrderStatusResponse, type PathaoPriceRequest, type PathaoPriceResponse, type PathaoStoreRequest, type PathaoStoreResponse, StoreType };
+export { DeliveryType, ItemType, PathaoApiService, type PathaoAreaResponse, type PathaoAuthResponse, type PathaoCityResponse, type PathaoConfig, type PathaoError, type PathaoOrderRequest, type PathaoOrderResponse, type PathaoOrderStatusResponse, type PathaoPriceRequest, type PathaoPriceResponse, type PathaoStore, type PathaoStoreCreateResponse, type PathaoStoreListResponse, type PathaoStoreRequest, type PathaoZoneResponse };

package/dist/index.d.ts

@@ -3,8 +3,9 @@
  *
  * Official API Details:
  * - Authentication: OAuth2 with client_id, client_secret, username, password
- * - Live URL: https://api-hermes.pathao.com
  * - All endpoints use /aladdin/api/v1/ prefix
+ * - Base URL can be set via PATHAO_BASE_URL environment variable or constructor config
+ * - Timeout can be set via PATHAO_TIMEOUT environment variable or constructor config
  */
 interface PathaoAuthResponse {
     token_type: string;
@@ -34,11 +35,12 @@ interface PathaoStoreRequest {
     name: string;
     contact_name: string;
     contact_number: string;
+    secondary_contact?: string;
+    otp_number?: string;
     address: string;
     city_id: number;
     zone_id: number;
     area_id: number;
-    store_type: number;
 }
 interface PathaoOrderResponse {
     type: string;
@@ -46,44 +48,46 @@ interface PathaoOrderResponse {
     message: string;
     data: {
         consignment_id: string;
-        invoice_id: string;
         merchant_order_id: string;
-        store_id: number;
-        recipient_name: string;
-        recipient_phone: string;
-        recipient_address: string;
-        recipient_city: string;
-        recipient_zone: string;
-        recipient_area: string;
-        delivery_type: string;
-        item_type: string;
-        item_quantity: number;
-        item_weight: number;
-        item_description: string;
-        amount_to_collect: number;
-        special_instruction: string;
-        status: string;
-        created_at: string;
-        updated_at: string;
+        order_status: string;
+        delivery_fee: number;
     };
 }
-interface PathaoStoreResponse {
+interface PathaoStoreCreateResponse {
     type: string;
     code: number;
     message: string;
     data: {
-        store_id: number;
-        name: string;
-        contact_name: string;
-        contact_number: string;
-        address: string;
-        city_id: number;
-        zone_id: number;
-        area_id: number;
-        store_type: number;
-        status: string;
-        created_at: string;
-        updated_at: string;
+        store_name: string;
+    };
+}
+interface PathaoStore {
+    store_id: number;
+    store_name: string;
+    store_address: string;
+    is_active: number;
+    city_id: number;
+    zone_id: number;
+    hub_id: number;
+    is_default_store: boolean;
+    is_default_return_store: boolean;
+}
+interface PathaoStoreListResponse {
+    type: string;
+    code: number;
+    message: string;
+    data: {
+        data: PathaoStore[];
+        total: number;
+        current_page: number;
+        per_page: number;
+        total_in_page: number;
+        last_page: number;
+        path: string;
+        to: number;
+        from: number;
+        last_page_url: string;
+        first_page_url: string;
     };
 }
 interface PathaoPriceRequest {
@@ -93,42 +97,32 @@ interface PathaoPriceRequest {
     delivery_type: number;
     recipient_city: number;
     recipient_zone: number;
-    recipient_area: number;
 }
 interface PathaoPriceResponse {
     type: string;
     code: number;
     message: string;
     data: {
-        store_id: number;
-        item_type: string;
-        item_weight: number;
-        delivery_type: string;
-        recipient_city: string;
-        recipient_zone: string;
-        recipient_area: string;
-        delivery_charge: number;
-        cod_charge: number;
-        total_charge: number;
-        currency: string;
+        price: number;
+        discount: number;
+        promo_discount: number;
+        plan_id: number;
+        cod_enabled: number;
+        cod_percentage: number;
+        additional_charge: number;
+        final_price: number;
     };
 }
 interface PathaoCityResponse {
     type: string;
     code: number;
     message: string;
-    data: Array<{
-        city_id: number;
-        city_name: string;
-        zone_list: Array<{
-            zone_id: number;
-            zone_name: string;
-            area_list: Array<{
-                area_id: number;
-                area_name: string;
-            }>;
+    data: {
+        data: Array<{
+            city_id: number;
+            city_name: string;
         }>;
-    }>;
+    };
 }
 interface PathaoOrderStatusResponse {
     type: string;
@@ -136,47 +130,43 @@ interface PathaoOrderStatusResponse {
     message: string;
     data: {
         consignment_id: string;
-        invoice_id: string;
         merchant_order_id: string;
-        store_id: number;
-        recipient_name: string;
-        recipient_phone: string;
-        recipient_address: string;
-        recipient_city: string;
-        recipient_zone: string;
-        recipient_area: string;
-        delivery_type: string;
-        item_type: string;
-        item_quantity: number;
-        item_weight: number;
-        item_description: string;
-        amount_to_collect: number;
-        special_instruction: string;
-        status: string;
-        status_updated_at: string;
-        created_at: string;
+        order_status: string;
+        order_status_slug: string;
         updated_at: string;
+        invoice_id: string | null;
+    };
+}
+interface PathaoZoneResponse {
+    type: string;
+    code: number;
+    message: string;
+    data: {
+        data: Array<{
+            zone_id: number;
+            zone_name: string;
+        }>;
     };
 }
 interface PathaoAreaResponse {
     type: string;
     code: number;
     message: string;
-    data: Array<{
-        area_id: number;
-        area_name: string;
-        zone_id: number;
-        zone_name: string;
-        city_id: number;
-        city_name: string;
-    }>;
+    data: {
+        data: Array<{
+            area_id: number;
+            area_name: string;
+            home_delivery_available: boolean;
+            pickup_available: boolean;
+        }>;
+    };
 }
 interface PathaoConfig {
     clientId: string;
     clientSecret: string;
     username: string;
     password: string;
-    baseURL?: string;
+    baseURL: string;
     timeout?: number;
 }
 interface PathaoError {
@@ -194,10 +184,6 @@ declare enum ItemType {
     DOCUMENT = 1,
     PARCEL = 2
 }
-declare enum StoreType {
-    PICKUP_POINT = 1,
-    SERVICE_POINT = 2
-}
 
 /**
  * Pathao Merchant API Service (Unofficial SDK)
@@ -206,8 +192,9 @@ declare enum StoreType {
  *
  * API Details (based on public documentation):
  * - Authentication: OAuth2 with client_id, client_secret, username, password
- * - Live URL: https://api-hermes.pathao.com
  * - All endpoints use /aladdin/api/v1/ prefix
+ * - Base URL can be set via PATHAO_BASE_URL environment variable or constructor config
+ * - Timeout can be set via PATHAO_TIMEOUT environment variable or constructor config
  *
  * Features implemented:
  * - Token-based authentication with refresh token support
@@ -224,23 +211,42 @@ declare class PathaoApiService {
     private refreshToken;
     private tokenExpiry;
     private config;
+    private isAuthenticating;
+    private authPromise;
+    private requestQueue;
+    private circuitBreaker;
     constructor(config: PathaoConfig);
     private ensureAuthenticated;
+    private performAuthentication;
+    private processRequestQueue;
     private authenticate;
     private refreshAccessToken;
     private getErrorMessage;
+    private handleCircuitBreaker;
     createOrder(orderData: PathaoOrderRequest): Promise<PathaoOrderResponse>;
-    createStore(storeData: PathaoStoreRequest): Promise<PathaoStoreResponse>;
-    getStores(): Promise<PathaoStoreResponse[]>;
+    createStore(storeData: PathaoStoreRequest): Promise<PathaoStoreCreateResponse>;
+    getStores(): Promise<PathaoStoreListResponse>;
     calculatePrice(priceData: PathaoPriceRequest): Promise<PathaoPriceResponse>;
     getCities(): Promise<PathaoCityResponse>;
-    getAreas(): Promise<PathaoAreaResponse>;
+    getZones(cityId: number): Promise<PathaoZoneResponse>;
+    getAreas(zoneId: number): Promise<PathaoAreaResponse>;
     getOrderStatus(consignmentId: string): Promise<PathaoOrderStatusResponse>;
+    createBulkOrder(orders: PathaoOrderRequest[]): Promise<{
+        message: string;
+        type: string;
+        code: number;
+        data: boolean;
+    }>;
     static validatePhoneNumber(phone: string): boolean;
     static formatPhoneNumber(phone: string): string;
     static validateAddress(address: string): boolean;
     static validateWeight(weight: number): boolean;
     static validateRecipientName(name: string): boolean;
+    static validateStoreName(name: string): boolean;
+    static validateContactName(name: string): boolean;
+    static validateContactNumber(phone: string): boolean;
+    static validateStoreAddress(address: string): boolean;
+    clearAuth(): void;
 }
 
-export { DeliveryType, ItemType, PathaoApiService, type PathaoAreaResponse, type PathaoAuthResponse, type PathaoCityResponse, type PathaoConfig, type PathaoError, type PathaoOrderRequest, type PathaoOrderResponse, type PathaoOrderStatusResponse, type PathaoPriceRequest, type PathaoPriceResponse, type PathaoStoreRequest, type PathaoStoreResponse, StoreType };
+export { DeliveryType, ItemType, PathaoApiService, type PathaoAreaResponse, type PathaoAuthResponse, type PathaoCityResponse, type PathaoConfig, type PathaoError, type PathaoOrderRequest, type PathaoOrderResponse, type PathaoOrderStatusResponse, type PathaoPriceRequest, type PathaoPriceResponse, type PathaoStore, type PathaoStoreCreateResponse, type PathaoStoreListResponse, type PathaoStoreRequest, type PathaoZoneResponse };