@sazito/client-sdk 1.2.6 → 1.2.8

package/dist/index.d.mts

@@ -478,14 +478,69 @@ interface ShippingAssignment {
  * Order-related types
  */
 
+type OrderPublicId = number | string;
+interface OrderInvoiceItem {
+    productVariantId: OrderPublicId;
+    name: string;
+    image?: {
+        url?: string;
+    };
+    variantAttributes: Array<{
+        name: string;
+        value: string;
+    }>;
+    singleItemPrice: number;
+    noOfItems: number;
+    totalItemsPrice: number;
+    customerProfit?: number;
+    formAttributes?: unknown;
+    bookingAttributes?: unknown;
+    productVariant: {
+        commercialFiles?: Array<{
+            id: OrderPublicId;
+        }>;
+        product: {
+            productType: string;
+        };
+    };
+}
+interface OrderShippingItem {
+    id: OrderPublicId;
+    invoiceItemIds: OrderPublicId[];
+    rate: {
+        id?: OrderPublicId;
+        name: string;
+        price: number;
+        type?: string;
+        icon?: string;
+        color?: string;
+    };
+}
+interface OrderInvoice {
+    invoiceItems: OrderInvoiceItem[];
+    shippingItems: OrderShippingItem[];
+    netTotal: number;
+    finalTotal: number;
+    shippingTotal?: number;
+    discountTotal?: number;
+    creditTotal?: number;
+    vat?: number;
+    vatPercent?: number;
+    itemsTotalRawPrice?: number;
+    itemsDiscount?: number;
+    customerProfit?: number;
+    customerProfitPercentage?: number;
+    discountUsages?: Array<{
+        discountCode?: {
+            code?: string;
+        };
+    }>;
+}
 interface Order {
-    id: number;
-    orderNumber: string;
+    id: OrderPublicId;
+    orderNumber: OrderPublicId;
     orderIdentifier: string;
-    invoice: {
-        shippingItems: JsonObject[];
-        invoiceItems: InvoiceItem[];
-    };
+    invoice: OrderInvoice;
 }
 interface OrdersListResponse {
     orders: Order[];
@@ -535,14 +590,33 @@ interface Payment {
     };
     amount: number;
 }
-interface PaymentAction {
-    action: 'POST' | 'REDIRECT' | 'UPLOAD' | 'pending' | 'showOrder' | 'StockViolated' | 'FAIL';
-    address?: string;
-    payload?: JsonObject;
-    order?: Order;
-    time?: number;
+interface PaymentActionBase {
     message?: string;
 }
+type PaymentAction = PaymentActionBase & ({
+    action: 'POST';
+    address: string;
+    payload: Record<string, string | number>;
+} | {
+    action: 'REDIRECT';
+    address: string;
+} | {
+    action: 'UPLOAD';
+    time?: number;
+} | {
+    action: 'show_otp_modal';
+    time?: number;
+} | {
+    action: 'show_order';
+    order: Order;
+} | {
+    action: 'pending';
+    order: Order;
+} | {
+    action: 'payment_fail_error' | 'show_error' | 'FAIL';
+} | {
+    action: 'StockViolated';
+});
 interface PaymentCredentials {
     id: number;
     identifier: string;
@@ -553,7 +627,9 @@ interface CreatePaymentInput {
     paymentType: number;
 }
 interface PaymentStepInput {
+    /** Payment ID supplied by Sazito's gateway-return path. */
     id?: number;
+    /** Payment identifier supplied by Sazito's gateway-return path. */
     paymentIdentifier?: string;
     payload?: JsonObject;
     tatoken?: string;
@@ -861,7 +937,9 @@ declare class HttpClient {
     /**
      * POST request
      */
-    post<T>(endpoint: string, body?: any, options?: RequestOptions): Promise<SazitoResponse<T>>;
+    post<T>(endpoint: string, body?: any, options?: RequestOptions & {
+        skipRequestTransform?: boolean;
+    }): Promise<SazitoResponse<T>>;
     /**
      * PUT request
      */
@@ -1069,7 +1147,7 @@ declare class OrdersAPI {
     /**
      * Get single order by ID (requires authentication)
      */
-    get(orderId: number, options?: RequestOptions): Promise<SazitoResponse<Order>>;
+    get(orderId: OrderPublicId, options?: RequestOptions): Promise<SazitoResponse<Order>>;
 }
 
 /**
@@ -1202,14 +1280,14 @@ declare class PaymentsAPI {
     /**
      * Initialize payment: start the payment step before redirecting the user to
      * the gateway. Returns the next {@link PaymentAction} (typically REDIRECT or
-     * POST for hosted gateways, or showOrder for zero-amount/instant payments).
+     * POST for hosted gateways, or show_order for zero-amount/instant payments).
      */
     initialize(options?: RequestOptions): Promise<SazitoResponse<PaymentAction>>;
     /**
      * Verify payment after the user returns from the gateway. Forwards the
      * gateway callback parameters (e.g. `tatoken`, `trackingData`, `isFailed`,
      * `code`) to the same payment-step endpoint and returns the settled
-     * {@link PaymentAction} (showOrder on success, FAIL/StockViolated otherwise,
+     * {@link PaymentAction} (show_order on success, FAIL/StockViolated otherwise,
      * or pending if the gateway has not reported back yet).
      */
     verify(input?: PaymentStepInput, options?: RequestOptions): Promise<SazitoResponse<PaymentAction>>;
@@ -1238,6 +1316,7 @@ declare class PaymentsAPI {
     clearPayment(): void;
     private withExactJsonHeader;
     private buildProcessStepFormData;
+    private buildProcessStepBody;
     private appendFormValue;
     /**
      * Post-process a `process_payment_step` response. The exact-JSON endpoint
@@ -1246,6 +1325,9 @@ declare class PaymentsAPI {
      */
     private finalizeStepResponse;
     private normalizeAction;
+    private optionalNumber;
+    private isPostPayload;
+    private isCheckoutOrder;
     private callPinchAfterSuccessfulPayment;
 }
 
@@ -2314,4 +2396,4 @@ declare function transformAddToCartInput(variantId: number, quantity: number, fo
 declare function transformCreateCartInput(input: TransformValue): TransformObject;
 
 export { CredentialsManager, HttpClient, MemoryStorage, SazitoClient, TokenStorage, createBookingAPI as booking, createCartAPI as cart, createCategoriesAPI as categories, createCMSAPI as cms, createBookingAPI, createCMSAPI, createCartAPI, createCategoriesAPI, createDynamicFormsAPI, createEntityRoutesAPI, createFeedbacksAPI, createGeneralAPI, createImagesAPI, createInvoicesAPI, createMenuAPI, createOrdersAPI, createPaymentsAPI, createProductsAPI, createRegionsAPI, createSazitoClient, createSearchAPI, createShippingAPI, createUsersAPI, createVisitsAPI, createWalletAPI, createDynamicFormsAPI as dynamicForms, createEntityRoutesAPI as entityRoutes, createFeedbacksAPI as feedbacks, createGeneralAPI as general, createImagesAPI as images, createInvoicesAPI as invoices, createMenuAPI as menu, createOrdersAPI as orders, createPaymentsAPI as payments, createProductsAPI as products, createRegionsAPI as regions, createSearchAPI as search, createShippingAPI as shipping, toEnglishDigits, transformAddToCartInput, transformApiResponse, transformCartResponse, transformCreateCartInput, transformInvoiceResponse, transformProductListResponse, transformRequestKeys, transformResponseKeys, transformShippingAddressInput, createUsersAPI as users, createVisitsAPI as visits, createWalletAPI as wallet };
-export type { AddToCartInput, ApplicableShippingMethods, BlogPage, BlogPageEntityRoute, CMSPageEntityRoute, CMSPageType, CacheConfig, Cart, CartCredentials, CartProduct, CheckoutProductSnapshot, City$1 as City, CmsPage, CookieOptions, CreateCartInput, CreateInvoiceInput, CreatePaymentInput, EntityRoute, EntityRouteResponse, EntityType, FormAttributeValue, Image, Invoice, InvoiceCredentials, InvoiceItem, InvoiceItemFormAttributes, InvoiceShippingAddress, InvoiceShippingAddressRegion, ItemShippingRate, JsonArray, JsonObject, JsonPrimitive, JsonValue, MenuItem, MenuNode, MenuTree, Order, OrderFilters, OrdersListResponse, PaginatedResponse, Payment, PaymentAction, PaymentCredentials, PaymentGateway, PaymentMethod, PaymentStatus, PaymentStepFormFields, PaymentStepFormValue, PaymentStepInput, Product, ProductAttribute, ProductAttributeValueObject, ProductCategory, ProductCategoryEntityRoute, ProductEntityRoute, ProductFilters, ProductSort, ProductVariant, RefreshInvoiceInput, Region$1 as Region, RequestOptions, RetryConfig, SazitoConfig, SazitoError, SazitoResponse, SchedulerBookingAttributes, SearchFilters, SearchResponse, ShippingAddress, ShippingAddressCity, ShippingAddressCredentials, ShippingAddressInput, ShippingAddressRegion, ShippingAssignment, ShippingItem, ShippingMethod, ShippingRate, StorageAdapter, Tag, UnknownEntityRoute, UploadedFormFileAttribute, User };
+export type { AddToCartInput, ApplicableShippingMethods, BlogPage, BlogPageEntityRoute, CMSPageEntityRoute, CMSPageType, CacheConfig, Cart, CartCredentials, CartProduct, CheckoutProductSnapshot, City$1 as City, CmsPage, CookieOptions, CreateCartInput, CreateInvoiceInput, CreatePaymentInput, EntityRoute, EntityRouteResponse, EntityType, FormAttributeValue, Image, Invoice, InvoiceCredentials, InvoiceItem, InvoiceItemFormAttributes, InvoiceShippingAddress, InvoiceShippingAddressRegion, ItemShippingRate, JsonArray, JsonObject, JsonPrimitive, JsonValue, MenuItem, MenuNode, MenuTree, Order, OrderFilters, OrderInvoice, OrderInvoiceItem, OrderPublicId, OrderShippingItem, OrdersListResponse, PaginatedResponse, Payment, PaymentAction, PaymentCredentials, PaymentGateway, PaymentMethod, PaymentStatus, PaymentStepFormFields, PaymentStepFormValue, PaymentStepInput, Product, ProductAttribute, ProductAttributeValueObject, ProductCategory, ProductCategoryEntityRoute, ProductEntityRoute, ProductFilters, ProductSort, ProductVariant, RefreshInvoiceInput, Region$1 as Region, RequestOptions, RetryConfig, SazitoConfig, SazitoError, SazitoResponse, SchedulerBookingAttributes, SearchFilters, SearchResponse, ShippingAddress, ShippingAddressCity, ShippingAddressCredentials, ShippingAddressInput, ShippingAddressRegion, ShippingAssignment, ShippingItem, ShippingMethod, ShippingRate, StorageAdapter, Tag, UnknownEntityRoute, UploadedFormFileAttribute, User };

package/dist/index.d.ts

@@ -478,14 +478,69 @@ interface ShippingAssignment {
  * Order-related types
  */
 
+type OrderPublicId = number | string;
+interface OrderInvoiceItem {
+    productVariantId: OrderPublicId;
+    name: string;
+    image?: {
+        url?: string;
+    };
+    variantAttributes: Array<{
+        name: string;
+        value: string;
+    }>;
+    singleItemPrice: number;
+    noOfItems: number;
+    totalItemsPrice: number;
+    customerProfit?: number;
+    formAttributes?: unknown;
+    bookingAttributes?: unknown;
+    productVariant: {
+        commercialFiles?: Array<{
+            id: OrderPublicId;
+        }>;
+        product: {
+            productType: string;
+        };
+    };
+}
+interface OrderShippingItem {
+    id: OrderPublicId;
+    invoiceItemIds: OrderPublicId[];
+    rate: {
+        id?: OrderPublicId;
+        name: string;
+        price: number;
+        type?: string;
+        icon?: string;
+        color?: string;
+    };
+}
+interface OrderInvoice {
+    invoiceItems: OrderInvoiceItem[];
+    shippingItems: OrderShippingItem[];
+    netTotal: number;
+    finalTotal: number;
+    shippingTotal?: number;
+    discountTotal?: number;
+    creditTotal?: number;
+    vat?: number;
+    vatPercent?: number;
+    itemsTotalRawPrice?: number;
+    itemsDiscount?: number;
+    customerProfit?: number;
+    customerProfitPercentage?: number;
+    discountUsages?: Array<{
+        discountCode?: {
+            code?: string;
+        };
+    }>;
+}
 interface Order {
-    id: number;
-    orderNumber: string;
+    id: OrderPublicId;
+    orderNumber: OrderPublicId;
     orderIdentifier: string;
-    invoice: {
-        shippingItems: JsonObject[];
-        invoiceItems: InvoiceItem[];
-    };
+    invoice: OrderInvoice;
 }
 interface OrdersListResponse {
     orders: Order[];
@@ -535,14 +590,33 @@ interface Payment {
     };
     amount: number;
 }
-interface PaymentAction {
-    action: 'POST' | 'REDIRECT' | 'UPLOAD' | 'pending' | 'showOrder' | 'StockViolated' | 'FAIL';
-    address?: string;
-    payload?: JsonObject;
-    order?: Order;
-    time?: number;
+interface PaymentActionBase {
     message?: string;
 }
+type PaymentAction = PaymentActionBase & ({
+    action: 'POST';
+    address: string;
+    payload: Record<string, string | number>;
+} | {
+    action: 'REDIRECT';
+    address: string;
+} | {
+    action: 'UPLOAD';
+    time?: number;
+} | {
+    action: 'show_otp_modal';
+    time?: number;
+} | {
+    action: 'show_order';
+    order: Order;
+} | {
+    action: 'pending';
+    order: Order;
+} | {
+    action: 'payment_fail_error' | 'show_error' | 'FAIL';
+} | {
+    action: 'StockViolated';
+});
 interface PaymentCredentials {
     id: number;
     identifier: string;
@@ -553,7 +627,9 @@ interface CreatePaymentInput {
     paymentType: number;
 }
 interface PaymentStepInput {
+    /** Payment ID supplied by Sazito's gateway-return path. */
     id?: number;
+    /** Payment identifier supplied by Sazito's gateway-return path. */
     paymentIdentifier?: string;
     payload?: JsonObject;
     tatoken?: string;
@@ -861,7 +937,9 @@ declare class HttpClient {
     /**
      * POST request
      */
-    post<T>(endpoint: string, body?: any, options?: RequestOptions): Promise<SazitoResponse<T>>;
+    post<T>(endpoint: string, body?: any, options?: RequestOptions & {
+        skipRequestTransform?: boolean;
+    }): Promise<SazitoResponse<T>>;
     /**
      * PUT request
      */
@@ -1069,7 +1147,7 @@ declare class OrdersAPI {
     /**
      * Get single order by ID (requires authentication)
      */
-    get(orderId: number, options?: RequestOptions): Promise<SazitoResponse<Order>>;
+    get(orderId: OrderPublicId, options?: RequestOptions): Promise<SazitoResponse<Order>>;
 }
 
 /**
@@ -1202,14 +1280,14 @@ declare class PaymentsAPI {
     /**
      * Initialize payment: start the payment step before redirecting the user to
      * the gateway. Returns the next {@link PaymentAction} (typically REDIRECT or
-     * POST for hosted gateways, or showOrder for zero-amount/instant payments).
+     * POST for hosted gateways, or show_order for zero-amount/instant payments).
      */
     initialize(options?: RequestOptions): Promise<SazitoResponse<PaymentAction>>;
     /**
      * Verify payment after the user returns from the gateway. Forwards the
      * gateway callback parameters (e.g. `tatoken`, `trackingData`, `isFailed`,
      * `code`) to the same payment-step endpoint and returns the settled
-     * {@link PaymentAction} (showOrder on success, FAIL/StockViolated otherwise,
+     * {@link PaymentAction} (show_order on success, FAIL/StockViolated otherwise,
      * or pending if the gateway has not reported back yet).
      */
     verify(input?: PaymentStepInput, options?: RequestOptions): Promise<SazitoResponse<PaymentAction>>;
@@ -1238,6 +1316,7 @@ declare class PaymentsAPI {
     clearPayment(): void;
     private withExactJsonHeader;
     private buildProcessStepFormData;
+    private buildProcessStepBody;
     private appendFormValue;
     /**
      * Post-process a `process_payment_step` response. The exact-JSON endpoint
@@ -1246,6 +1325,9 @@ declare class PaymentsAPI {
      */
     private finalizeStepResponse;
     private normalizeAction;
+    private optionalNumber;
+    private isPostPayload;
+    private isCheckoutOrder;
     private callPinchAfterSuccessfulPayment;
 }
 
@@ -2314,4 +2396,4 @@ declare function transformAddToCartInput(variantId: number, quantity: number, fo
 declare function transformCreateCartInput(input: TransformValue): TransformObject;
 
 export { CredentialsManager, HttpClient, MemoryStorage, SazitoClient, TokenStorage, createBookingAPI as booking, createCartAPI as cart, createCategoriesAPI as categories, createCMSAPI as cms, createBookingAPI, createCMSAPI, createCartAPI, createCategoriesAPI, createDynamicFormsAPI, createEntityRoutesAPI, createFeedbacksAPI, createGeneralAPI, createImagesAPI, createInvoicesAPI, createMenuAPI, createOrdersAPI, createPaymentsAPI, createProductsAPI, createRegionsAPI, createSazitoClient, createSearchAPI, createShippingAPI, createUsersAPI, createVisitsAPI, createWalletAPI, createDynamicFormsAPI as dynamicForms, createEntityRoutesAPI as entityRoutes, createFeedbacksAPI as feedbacks, createGeneralAPI as general, createImagesAPI as images, createInvoicesAPI as invoices, createMenuAPI as menu, createOrdersAPI as orders, createPaymentsAPI as payments, createProductsAPI as products, createRegionsAPI as regions, createSearchAPI as search, createShippingAPI as shipping, toEnglishDigits, transformAddToCartInput, transformApiResponse, transformCartResponse, transformCreateCartInput, transformInvoiceResponse, transformProductListResponse, transformRequestKeys, transformResponseKeys, transformShippingAddressInput, createUsersAPI as users, createVisitsAPI as visits, createWalletAPI as wallet };
-export type { AddToCartInput, ApplicableShippingMethods, BlogPage, BlogPageEntityRoute, CMSPageEntityRoute, CMSPageType, CacheConfig, Cart, CartCredentials, CartProduct, CheckoutProductSnapshot, City$1 as City, CmsPage, CookieOptions, CreateCartInput, CreateInvoiceInput, CreatePaymentInput, EntityRoute, EntityRouteResponse, EntityType, FormAttributeValue, Image, Invoice, InvoiceCredentials, InvoiceItem, InvoiceItemFormAttributes, InvoiceShippingAddress, InvoiceShippingAddressRegion, ItemShippingRate, JsonArray, JsonObject, JsonPrimitive, JsonValue, MenuItem, MenuNode, MenuTree, Order, OrderFilters, OrdersListResponse, PaginatedResponse, Payment, PaymentAction, PaymentCredentials, PaymentGateway, PaymentMethod, PaymentStatus, PaymentStepFormFields, PaymentStepFormValue, PaymentStepInput, Product, ProductAttribute, ProductAttributeValueObject, ProductCategory, ProductCategoryEntityRoute, ProductEntityRoute, ProductFilters, ProductSort, ProductVariant, RefreshInvoiceInput, Region$1 as Region, RequestOptions, RetryConfig, SazitoConfig, SazitoError, SazitoResponse, SchedulerBookingAttributes, SearchFilters, SearchResponse, ShippingAddress, ShippingAddressCity, ShippingAddressCredentials, ShippingAddressInput, ShippingAddressRegion, ShippingAssignment, ShippingItem, ShippingMethod, ShippingRate, StorageAdapter, Tag, UnknownEntityRoute, UploadedFormFileAttribute, User };
+export type { AddToCartInput, ApplicableShippingMethods, BlogPage, BlogPageEntityRoute, CMSPageEntityRoute, CMSPageType, CacheConfig, Cart, CartCredentials, CartProduct, CheckoutProductSnapshot, City$1 as City, CmsPage, CookieOptions, CreateCartInput, CreateInvoiceInput, CreatePaymentInput, EntityRoute, EntityRouteResponse, EntityType, FormAttributeValue, Image, Invoice, InvoiceCredentials, InvoiceItem, InvoiceItemFormAttributes, InvoiceShippingAddress, InvoiceShippingAddressRegion, ItemShippingRate, JsonArray, JsonObject, JsonPrimitive, JsonValue, MenuItem, MenuNode, MenuTree, Order, OrderFilters, OrderInvoice, OrderInvoiceItem, OrderPublicId, OrderShippingItem, OrdersListResponse, PaginatedResponse, Payment, PaymentAction, PaymentCredentials, PaymentGateway, PaymentMethod, PaymentStatus, PaymentStepFormFields, PaymentStepFormValue, PaymentStepInput, Product, ProductAttribute, ProductAttributeValueObject, ProductCategory, ProductCategoryEntityRoute, ProductEntityRoute, ProductFilters, ProductSort, ProductVariant, RefreshInvoiceInput, Region$1 as Region, RequestOptions, RetryConfig, SazitoConfig, SazitoError, SazitoResponse, SchedulerBookingAttributes, SearchFilters, SearchResponse, ShippingAddress, ShippingAddressCity, ShippingAddressCredentials, ShippingAddressInput, ShippingAddressRegion, ShippingAssignment, ShippingItem, ShippingMethod, ShippingRate, StorageAdapter, Tag, UnknownEntityRoute, UploadedFormFileAttribute, User };