@wyocrm/sdk 5.5.39 → 5.5.41

package/build/index.d.ts

@@ -23,21 +23,123 @@ declare module '@wyocrm/sdk/services' {
       static getHttpClient(skipInit?: boolean): AxiosInstance;
       static getMerchantGuid(): string;
   }
+  /**
+   * Interface for Terminal Services.
+   */
   export interface ITerminalServices {
+      /**
+       * Uploads a customer photo.
+       * @param customerId - The customer ID.
+       * @param file - The file to upload.
+       * @param axiosConfig - The Axios request configuration.
+       * @returns A promise that resolves to nothing.
+       */
       uploadCustomerPhoto(customerId: number, fileUpload: IFileUploadRequest, axiosConfig?: AxiosRequestConfig): Promise<void>;
+      /**
+       * Creates a customer.
+       * @param options - The customer options.
+       * @param axiosConfig - The Axios request configuration.
+       * @returns A promise that resolves to the created customer.
+       */
       createCustomer(options: ICustomerOptions, axiosConfig?: AxiosRequestConfig): Promise<ICustomer>;
+      /**
+       * Updates a customer.
+       * @param customerId - The customer ID.
+       * @param options - The customer options.
+       * @param axiosConfig - The Axios request configuration.
+       * @returns A promise that resolves to the updated customer.
+       */
       updateCustomer(customerId: number, options: ICustomerOptions, axiosConfig?: AxiosRequestConfig): Promise<ICustomer>;
+      /**
+       * Deletes a customer.
+       * @param id - The customer ID.
+       * @param axiosConfig - The Axios request configuration.
+       * @returns A promise that resolves to nothing.
+       */
       deleteCustomer(id: number, axiosConfig?: AxiosRequestConfig): Promise<void>;
+      /**
+       * Retrieves a customer by ID.
+       * @param id - The customer ID.
+       * @param axiosConfig - The Axios request configuration.
+       * @returns A promise that resolves to the retrieved customer.
+       */
       getCustomerById(id: number, axiosConfig?: AxiosRequestConfig): Promise<ICustomer>;
+      /**
+       * Retrieves coupons by customer ID.
+       * @param id - The customer ID.
+       * @param axiosConfig - The Axios request configuration.
+       * @returns A promise that resolves to the retrieved coupons.
+       */
       getCouponsByCustomerId(id: number, axiosConfig?: AxiosRequestConfig): Promise<IApiResponse<ICouponItem>>;
+      /**
+       * Marks a coupon as used/redeemed.
+       * @param couponGuid - The coupon GUID.
+       * @param axiosConfig - The Axios request configuration.
+       * @returns A promise that resolves when the coupon is marked as used.
+       */
       markCouponAsUsed(couponGuid: string, axiosConfig?: AxiosRequestConfig): Promise<void>;
+      /**
+       * Marks a coupon as unused/not redeemed.
+       * @param couponGuid - The coupon GUID.
+       * @param axiosConfig - The Axios request configuration.
+       * @returns A promise that resolves when the coupon is marked as unused.
+       */
       markCouponAsUnused(couponGuid: string, axiosConfig?: AxiosRequestConfig): Promise<void>;
+      /**
+       * Searches customers based on a keyword.
+       * @param keyword - The keyword to search.
+       * @param builder - The query builder for customers.
+       * @param axiosConfig - The Axios request configuration.
+       * @returns A promise that resolves to an array of searched customers.
+       */
       searchCustomers(keyword: string, builder: QueryBuilder<ICustomer>, axiosConfig?: AxiosRequestConfig): Promise<ICustomer[]>;
+      /**
+       * Queries customers based on a query builder.
+       * @param builder - The query builder for customers.
+       * @param searchKeywords - The search keywords.
+       * @param axiosConfig - The Axios request configuration.
+       * @returns A promise that resolves to an array of queried customers.
+       */
       queryCustomers(builder: QueryBuilder<ICustomer>, searchKeywords?: string, axiosConfig?: AxiosRequestConfig): Promise<IQueryResponse<ICustomer>>;
+      /**
+       * Queries transactions based on a query builder.
+       * @param query - The query builder for transactions.
+       * @param axiosConfig - The Axios request configuration.
+       * @returns A promise that resolves to an array of queried transactions.
+       */
       queryTransactions(query: QueryBuilder<ITransaction>, axiosConfig?: AxiosRequestConfig): Promise<IQueryResponse<ITransaction>>;
+      /**
+       * Queries orders based on a query builder.
+       * @param query - The query builder for orders.
+       * @param axiosConfig - The Axios request configuration.
+       * @returns A promise that resolves to an array of queried orders.
+       */
       queryOrders(query: QueryBuilder<IOrder>, axiosConfig?: AxiosRequestConfig): Promise<IQueryResponse<IOrder>>;
+      /**
+       * Applicable payment method code: PNOW
+       * @param terminalId - The terminal ID.
+       * @param amount - The amount for the charge.
+       * @param invoiceRefId - The invoice reference ID.
+       * @param description - The description.
+       * @param paymentMethodCode - The payment method code.
+       * @param axiosConfig - The Axios request configuration.
+       * @returns A promise that resolves to the created charge.
+       */
       createCharge(terminalId: string, amount: number, invoiceRefId: string, description: string, paymentMethodCode?: string, axiosConfig?: AxiosRequestConfig): Promise<IObjectResponse<ICharge>>;
+      /**
+       * Applicable payment method code: PNOW
+       * Retrieves a charge by ID.
+       * @param chargeId - The charge ID.
+       * @param axiosConfig - The Axios request configuration.
+       * @returns A promise that resolves to the retrieved charge.
+       */
       getCharge(chargeGuid: string, axiosConfig?: AxiosRequestConfig): Promise<IObjectResponse<ICharge>>;
+      /**
+       * Cancels a charge by charge GUID.
+       * @param chargeGuid - The charge GUID to cancel.
+       * @param axiosConfig - The Axios request configuration.
+       * @returns A promise that resolves to the cancelled charge response.
+       */
       cancelCharge(chargeGuid: string, axiosConfig?: AxiosRequestConfig): Promise<IObjectResponse<ICharge>>;
   }
   export class TerminalServices implements ITerminalServices {
@@ -58,7 +160,18 @@ declare module '@wyocrm/sdk/services' {
       cancelCharge(chargeGuid: string, axiosConfig?: AxiosRequestConfig): Promise<IObjectResponse<ICharge>>;
   }
   export interface IAdminServices {
+      /**
+       * Gets merchants by admin user
+       * @param axiosConfig - The Axios request configuration
+       * @returns A promise that resolves to an array of merchants
+       */
       getMerchants(axiosConfig?: AxiosRequestConfig): Promise<IObjectResponse<IMerchant[]>>;
+      /**
+       * Gets a merchant by guid
+       * @param merchantGuid - The merchant GUID
+       * @param axiosConfig - The Axios request configuration
+       * @returns A promise that resolves to a merchant
+       */
       getMerchantByGuid(merchantGuid: string, axiosConfig?: AxiosRequestConfig): Promise<IObjectResponse<IMerchant>>;
   }
   export class AdminServices implements IAdminServices {
@@ -66,49 +179,269 @@ declare module '@wyocrm/sdk/services' {
       getMerchantByGuid(merchantGuid: string, axiosConfig?: AxiosRequestConfig): Promise<IObjectResponse<IMerchant>>;
   }
   export interface IClientService {
+      /**
+       * Exchanges credentials for access token using password grant
+       * @param request - Password grant request containing username and password
+       * @param headers - Custom headers including language preference
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to token response
+       */
       exchangePasswordGrant(request: IPasswordGrantRequest, headers?: ICustomHeaders, axiosConfig?: AxiosRequestConfig): Promise<ITokenResponse>;
+      /**
+       * Exchanges Google ID token for access token
+       * @param request - Google ID token request
+       * @param headers - Custom headers including language preference
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to token response
+       */
       exchangeGoogleIdToken(request: IGoogleIdTokenRequest, headers?: ICustomHeaders, axiosConfig?: AxiosRequestConfig): Promise<ITokenResponse>;
+      /**
+       * Exchanges Apple ID token for access token
+       * @param request - Apple ID token request
+       * @param headers - Custom headers including language preference
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to token response
+       */
       exchangeAppleIdToken(request: IAppleIdTokenRequest, headers?: ICustomHeaders, axiosConfig?: AxiosRequestConfig): Promise<ITokenResponse>;
+      /**
+       * Exchanges WeChat authorization code for access token
+       * @param request - WeChat code request
+       * @param headers - Custom headers including language preference
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to token response
+       */
       exchangeWeixinCode(request: IWeixinCodeRequest, headers?: ICustomHeaders, axiosConfig?: AxiosRequestConfig): Promise<ITokenResponse>;
+      /**
+       * Gets user information using access token
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to user information
+       */
       getUserInfo(axiosConfig?: AxiosRequestConfig): Promise<IUserInfo>;
+      /**
+       * Sends OTP to customer for a specific merchant
+       * @param merchantGuid - The merchant GUID
+       * @param request - OTP request containing phone number
+       * @param headers - Custom headers including language preference
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to response with headers
+       */
       sendOtp(merchantGuid: string, request: IOtpRequest, headers?: ICustomHeaders, axiosConfig?: AxiosRequestConfig): Promise<AxiosResponse<Response>>;
+      /**
+       * Retrieves terminal merchant account details.
+       * @param merchantGuid - The merchant GUID.
+       * @param axiosConfig - The Axios request configuration.
+       * @returns A promise that resolves to the merchant account details.
+       */
       getUserDetail(merchantGuid: string, axiosConfig?: AxiosRequestConfig): Promise<AxiosResponse<IObjectResponse<IUserDetail>>>;
+      /**
+       * Checks if a social account exists
+       * @param socialAccount - The social account type
+       * @param code - The social account code
+       * @param axiosConfig - The Axios request configuration
+       * @returns A promise that resolves to the social account existence
+       */
       socialAccountExists(socialAccount: 'apple' | 'google' | 'weixin', code: string, axiosConfig?: AxiosRequestConfig): Promise<AxiosResponse<IObjectResponse<boolean>>>;
+      /**
+       * Queries transactions for a specific merchant
+       * @param merchantGuid - The merchant GUID
+       * @param builder - Query builder for filtering and pagination
+       * @param axiosConfig - The Axios request configuration
+       * @returns A promise that resolves to a QueryResponse containing transactions
+       */
       queryTransactions(merchantGuid: string, builder: QueryBuilder<ITransaction & {
           IncludeJointMerchants?: boolean;
       }>, axiosConfig?: AxiosRequestConfig): Promise<IQueryResponse<ITransaction>>;
+      /**
+       * Gets current user account information
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to user account data
+       */
       getAccount(axiosConfig?: AxiosRequestConfig): Promise<ICustomer>;
+      /**
+       * Updates current user account information
+       * @param data - Partial user data to update
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to updated user account data
+       */
       updateAccount(data: Partial<ICustomer>, axiosConfig?: AxiosRequestConfig): Promise<ICustomer>;
+      /**
+       * Uploads user profile photo
+       * @param file - File upload request with base64 encoded image
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to updated user account data
+       */
       uploadProfilePhoto(file: IFileUploadRequest, axiosConfig?: AxiosRequestConfig): Promise<ICustomer>;
+      /**
+       * Changes user password
+       * @param request - Password change request with current and new password
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to response
+       */
       changePassword(request: IChangePasswordRequest, axiosConfig?: AxiosRequestConfig): Promise<Response>;
+      /**
+       * Changes user phone number via OTP verification
+       * @param request - Phone number change request with new number and OTP
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to response
+       */
       changePhoneNumberByOtp(request: IChangePhoneNumberRequest, axiosConfig?: AxiosRequestConfig): Promise<Response>;
+      /**
+       * Unsubscribes from topic notifications
+       * @param request - Unsubscribe request with topic and channel
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to response
+       */
       unsubscribe(request: ISubscribeRequest, axiosConfig?: AxiosRequestConfig): Promise<Response>;
+      /**
+       * Agrees to PDPA terms
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to response
+       */
       agreePdpa(axiosConfig?: AxiosRequestConfig): Promise<Response>;
+      /**
+       * Gets user addresses
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to addresses list
+       */
       getAddresses(axiosConfig?: AxiosRequestConfig): Promise<IObjectResponse<Address[]>>;
+      /**
+       * Creates new address
+       * @param data - Address data
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to created address
+       */
       createAddress(data: Partial<Address>, axiosConfig?: AxiosRequestConfig): Promise<IObjectResponse<Address>>;
+      /**
+       * Updates existing address
+       * @param id - Address ID
+       * @param data - Address data to update
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to updated address
+       */
       updateAddress(id: number, data: Partial<Address>, axiosConfig?: AxiosRequestConfig): Promise<IObjectResponse<Address>>;
+      /**
+       * Deletes address
+       * @param id - Address ID
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to deleted address
+       */
       deleteAddress(id: number, axiosConfig?: AxiosRequestConfig): Promise<IObjectResponse<Address>>;
+      /**
+       * Gets user payment sources
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to payment sources list
+       */
       getPaymentSources(axiosConfig?: AxiosRequestConfig): Promise<IObjectResponse<IPaymentSource[]>>;
+      /**
+       * Creates new payment source
+       * @param data - Payment source data with payment method code and token
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to created payment source
+       */
       createPaymentSource(data: Partial<IPaymentSource> & {
           payment_method_code: string;
           token: string;
       }, axiosConfig?: AxiosRequestConfig): Promise<IObjectResponse<IPaymentSource>>;
+      /**
+       * Updates payment source default status
+       * @param data - Payment source ID and default flag
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to updated payment source
+       */
       updatePaymentSource(data: {
           id: number;
           is_default: boolean;
       }, axiosConfig?: AxiosRequestConfig): Promise<IObjectResponse<IPaymentSource>>;
+      /**
+       * Deletes payment source
+       * @param id - Payment source ID
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to deleted payment source
+       */
       deletePaymentSource(id: number, axiosConfig?: AxiosRequestConfig): Promise<IObjectResponse<IPaymentSource>>;
+      /**
+       * Sends OTP via SMS
+       * @param request - OTP SMS request with phone number
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to response
+       */
       sendOtpSms(request: IOtpSmsRequest, axiosConfig?: AxiosRequestConfig): Promise<Response>;
+      /**
+       * Gets customer Terms and Conditions agreement status
+       * @param phoneNumber - Customer's phone number
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to T&C status
+       */
       getTermsAndConditionStatus(phoneNumber: string, axiosConfig?: AxiosRequestConfig): Promise<IObjectResponse<boolean>>;
+      /**
+       * Collects a coupon by coupon guid
+       * @param couponGuid - The coupon GUID
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to the collected coupon
+       */
       collectCouponByGuid(couponGuid: string, axiosConfig?: AxiosRequestConfig): Promise<IObjectResponse<ICouponItem>>;
+      /**
+       * Gets a coupon by coupon guid
+       * @param couponGuid - The coupon GUID
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to the coupon details
+       */
       getCouponByGuid(couponGuid: string, axiosConfig?: AxiosRequestConfig): Promise<IObjectResponse<ICoupon>>;
+      /**
+       * Gets WhatsApp login request
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to WhatsApp login response
+       */
       getWhatsAppLoginRequest(axiosConfig?: AxiosRequestConfig): Promise<IObjectResponse<IWhatsAppLoginResponse>>;
+      /**
+       * Gets WhatsApp login status
+       * @param sessionUid - The session UID
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to WhatsApp login status response
+       */
       getWhatsAppLoginStatus(sessionUid: string, axiosConfig?: AxiosRequestConfig): Promise<IWhatsAppLoginStatusResponse>;
+      /**
+       * Exchanges WhatsApp session code for access token
+       * @param request - WhatsApp session request containing code
+       * @param headers - Custom headers including language preference
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to token response
+       */
       exchangeWhatsAppSessionCode(request: IWhatsAppSessionRequest, headers?: ICustomHeaders, axiosConfig?: AxiosRequestConfig): Promise<ITokenResponse>;
+      /**
+       * Queries coupon items for a specific merchant
+       * @param merchantGuid - The merchant GUID
+       * @param builder - Query builder for filtering and pagination
+       * @param axiosConfig - The Axios request configuration
+       * @returns A promise that resolves to a QueryResponse containing coupon items
+       */
       queryCouponItems(merchantGuid: string, builder: QueryBuilder<ICouponItem & {
           is_redeemed?: boolean;
           is_expired?: boolean;
       }>, axiosConfig?: AxiosRequestConfig): Promise<IQueryResponse<ICouponItem>>;
+      /**
+       * Gets the coupons that can be sold or redeemed in a merchant's coupon store
+       * @param merchantGuid - The merchant GUID
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to the store coupons
+       */
+      getCouponStore(merchantGuid: string, axiosConfig?: AxiosRequestConfig): Promise<IApiResponse<ICoupon>>;
+      /**
+       * Buys a coupon with the user's points; rejects with HTTP 402 when points are insufficient
+       * @param merchantGuid - The merchant GUID
+       * @param couponGuid - The coupon GUID
+       * @param axiosConfig - Axios request configuration
+       * @returns Promise resolving to all of the user's valid coupon items for the merchant
+       */
+      buyCoupon(merchantGuid: string, couponGuid: string, axiosConfig?: AxiosRequestConfig): Promise<IApiResponse<ICouponItem>>;
+      /**
+       * Queries coupons for a specific merchant
+       * @param merchantGuid - The merchant GUID
+       * @param builder - Query builder for filtering and pagination
+       * @param axiosConfig - Axios request configuration
+       * @returns A promise that resolves to a QueryResponse containing coupons
+       */
+      queryCoupons(merchantGuid: string, builder: QueryBuilder<ICoupon>, axiosConfig?: AxiosRequestConfig): Promise<IQueryResponse<ICoupon>>;
   }
   export class ClientService implements IClientService {
       exchangePasswordGrant(request: IPasswordGrantRequest, headers?: ICustomHeaders, axiosConfig?: AxiosRequestConfig): Promise<ITokenResponse>;
@@ -154,6 +487,9 @@ declare module '@wyocrm/sdk/services' {
           is_redeemed?: boolean;
           is_expired?: boolean;
       }>, axiosConfig?: AxiosRequestConfig): Promise<IQueryResponse<ICouponItem>>;
+      getCouponStore(merchantGuid: string, axiosConfig?: AxiosRequestConfig): Promise<IApiResponse<ICoupon>>;
+      buyCoupon(merchantGuid: string, couponGuid: string, axiosConfig?: AxiosRequestConfig): Promise<IApiResponse<ICouponItem>>;
+      queryCoupons(merchantGuid: string, builder: QueryBuilder<ICoupon>, axiosConfig?: AxiosRequestConfig): Promise<IQueryResponse<ICoupon>>;
   }
 
 }
@@ -168,7 +504,9 @@ declare module '@wyocrm/sdk/types' {
       delivery?: Delivery | undefined;
   }
   export interface Delivery {
+      /** When this transaction is created */
       created_at?: Date;
+      /** Date and time of the latest update on this transaction */
       updated_at?: Date;
       errors?: string[] | undefined;
       id?: number;
@@ -184,7 +522,9 @@ declare module '@wyocrm/sdk/types' {
       to_address1?: Address | undefined;
   }
   export interface Address {
+      /** When this transaction is created */
       created_at?: Date;
+      /** Date and time of the latest update on this transaction */
       updated_at?: Date;
       errors?: string[] | undefined;
       id?: number;
@@ -213,43 +553,81 @@ declare module '@wyocrm/sdk/types' {
       };
   }
   export interface ICustomer {
+      /** Unique membership ID */
       membership_id: string;
+      /** Merchant Identifier */
       license_id: number;
+      /** User's total credit */
       credit: number;
+      /** User's total points */
       point: number;
+      /** Total transaction amount */
       transaction_total: number;
+      /** Number of transactions */
       transaction_time: number;
+      /** User's tier */
       tier: any | null;
+      /** Array of tag GUIDs */
       tag_guids: string[] | null;
+      /** User's Group ID */
       user_group_id: number;
+      /** Name of the User's Group */
       user_group_name: string | null;
+      /** Expiration date of the group */
       group_expires_at: string;
+      /** Error message */
       error: string | null;
+      /** User's ID */
       id: number;
+      /** Reference ID */
       ref_id: string;
+      /** Image URL */
       image_url: string | null;
+      /** Stripe token */
       stripe_token: string | null;
+      /** Stripe customer ID */
       stripe_customer_id: string | null;
+      /** Username */
       username: string;
+      /** Company name */
       company: string | null;
+      /** Identification number */
       ic: string | null;
+      /** Display name */
       display_name: string;
+      /** Full name */
       full_name: string;
+      /** Birth date */
       birth_date: string | null;
+      /** Gender */
       gender: string | null;
+      /** Address */
       address: string | null;
+      /** Postcode */
       postcode: string | null;
+      /** Additional notes */
       note: string | null;
+      /** Preferred language */
       language: string | null;
+      /** Time zone */
       time_zone: string | null;
+      /** Creation date and time */
       created_at: string;
+      /** Last update date and time */
       updated_at: string;
+      /** Comma-separated list of license IDs */
       license_ids: string;
+      /** Security stamp */
       security_stamp: string;
+      /** Phone number */
       phone_number: string;
+      /** Email address */
       email: string | null;
+      /** Whether the email is confirmed */
       email_confirmed: boolean;
+      /** Whether the phone number is confirmed */
       phone_number_confirmed: boolean;
+      /** Date and time of agreeing to PDPA */
       agree_pdpa_at: string | null;
   }
   export class Customer implements ICustomer {
@@ -293,14 +671,23 @@ declare module '@wyocrm/sdk/types' {
       agree_pdpa_at: any;
   }
   export type ICustomerOptions = {
+      /** Reference ID */
       ref_id: string;
+      /** IC */
       ic: string;
+      /** Display name of the user */
       display_name: string;
+      /** URL of the user's image */
       image_url: string;
+      /** Birth date of the user */
       birth_date: string;
+      /** Gender of the user */
       gender: string;
+      /** Language of the user */
       language: string;
+      /** Phone number of the user */
       phone_number: string;
+      /** Email of the user */
       email: string;
   };
   export class CustomerOptions implements ICustomerOptions {
@@ -340,38 +727,67 @@ declare module '@wyocrm/sdk/types' {
       At = "StartsWith"
   }
   export interface ITransactionMerchant {
+      /** Merchant name */
       name?: string;
+      /** Merchant logo URL */
       logo_url?: string;
   }
   export interface ITransactionMeta {
+      /** List of coupon IDs to redeem */
       coupon_ids_to_redeem: string[];
   }
   export interface ITransaction {
+      /** Unique identifier for the order */
       id: number;
+      /** Associated invoice ID, 0 if not applicable */
       invoice_id: number;
+      /** Type of the order, e.g., 'revopos' */
       type: string;
+      /** Primary license ID associated with the order */
       primary_license_id: number;
+      /** License ID associated with the order */
       license_id: number;
+      /** Reference ID for the order */
       ref_id: string;
+      /** User ID who placed the order */
       user_id: number;
+      /** Credit added to the order, default is 0.00 */
       add_credit: number;
+      /** Credit subtracted from the order, default is 0.00 */
       minus_credit: number;
+      /** Points added to the order, default is 0.00 */
       add_point: number;
+      /** Points subtracted from the order, default is 0.00 */
       minus_point: number;
+      /** Current status of the order, e.g., 'paid' */
       status: string;
+      /** Grand total amount of the order */
       grand_total: number;
+      /** Whether the order belongs to this shop */
       is_local: boolean;
+      /** Timestamp when the order was closed */
       closed_at: Date;
+      /** Timestamp when the order was created */
       created_at: Date;
+      /** Timestamp when the order was last updated */
       updated_at: Date;
+      /** List of errors, if any, during order processing */
       errors: string[];
+      /** The complete invoice object */
       invoice?: any;
+      /** The complete invoice configuration object */
       config?: any;
+      /** Merchant information */
       merchant?: ITransactionMerchant;
+      /** The complete coupon redemption object snapshot at the time of redemption */
       coupon?: any;
+      /** The amount of credit which is used within expiry date */
       used_credit: number;
+      /** The amount of credit which is expired */
       expired_credit: number;
+      /** The credit expiry date and time */
       expired_at: string | null;
+      /** The transaction meta data */
       meta: ITransactionMeta;
   }
   export class Transaction implements ITransaction {
@@ -420,31 +836,55 @@ declare module '@wyocrm/sdk/types' {
       PaymentDeclined = "Payment Declined"
   }
   export interface IMeta {
+      /** Date and time when the order was placed */
       placed_at: string;
+      /** Current status of the order */
       current_status: string;
+      /** Date and time when the order preparation started */
       prepare_at: string;
+      /** Status of the order before the current status */
       previous_status: string;
+      /** Date and time when the order is expected to be delivered */
       deliver_at: string;
+      /** Date and time when the order was actually delivered */
       delivered_at: string;
   }
   export interface IOrder {
+      /** Unique identifier for the order */
       id: number;
+      /** Reference identifier for the order */
       order_ref: string;
+      /** Table ID associated with the order (0 if not applicable) */
       table_id: number;
+      /** Invoice ID associated with the order */
       invoice_id: number;
+      /** Call number associated with the order (0 if not applicable) */
       call_num: number;
+      /** User ID of the person who placed the order */
       user_id: number;
+      /** License ID associated with the order */
       license_id: number;
+      /** Charge ID associated with the order */
       charge_id: number;
+      /** Delivery ID associated with the order */
       delivery_id: number;
+      /** Type of the order (e.g., Delivery, Pickup) */
       order_type: string;
+      /** Payment source ID used for the order */
       payment_source_id: number;
+      /** Current status of the order (e.g., Delivered, Pending) */
       status: OrderStatus;
+      /** Name of the customer */
       customer_name: string;
+      /** Phone number of the customer */
       customer_phone_number: string;
+      /** Metadata associated with the order */
       meta: IMeta;
+      /** Date and time when the order was created */
       created_at: string;
+      /** Date and time when the order was last updated */
       updated_at: string;
+      /** List of errors encountered (if any) */
       errors: string[];
   }
   export class Order implements IOrder {
@@ -500,7 +940,9 @@ declare module '@wyocrm/sdk/types' {
       EXCLUSIVE = 3
   }
   export interface IApplying<T> {
+      /** Applying type */
       applying_type: ApplyingType;
+      /** List of applying items */
       applying_items: T[];
   }
   export class Applying<T> implements IApplying<T> {
@@ -509,34 +951,63 @@ declare module '@wyocrm/sdk/types' {
       constructor();
   }
   export interface ICoupon {
+      /** Coupon GUID */
       guid: string;
+      /** Promo code */
       promo_code: string;
+      /** Flag for multi-store applicability */
       is_multi_stores: boolean;
+      /** Name of the coupon */
       name: string;
+      /** Alias of the coupon */
       alias: string;
+      /** Coupon description */
       description: string;
+      /** Coupon description alias */
       description_alias: string;
+      /** Applying plus details */
       applying_plus: IApplying<string>;
+      /** Applying user tags details */
       applying_user_tags: IApplying<string>;
+      /** Applying user groups details */
       applying_user_groups: IApplying<number>;
+      /** Discount calculation type */
       discount_calc_type: number;
+      /** Discount amount */
       discount_amount: number;
+      /** Discount percent */
       discount_percent: number;
+      /** Coupon duration */
       duration: number;
+      /** Usage count */
       usage_count: number;
+      /** Usage limit per invoice */
       usage_limit_per_invoice: number;
+      /** Minimum invoice amount for coupon applicability */
       above_invoice_amount: number;
+      /** Maximum invoice amount for coupon applicability */
       below_invoice_amount: number;
+      /** Flag for free delivery */
       is_delivery_free: boolean;
+      /** Flag for individual use */
       is_individual_use: boolean;
+      /** Price in points */
       price_in_points: number;
+      /** Styles (specify the type if known) */
       styles: any;
+      /** Expiry date of the coupon */
       expired_at: string;
+      /** Flag for auto-generation */
       auto_gen: boolean;
+      /** Flag for selling ability */
       can_sell: boolean;
+      /** Flag for redeeming ability */
       can_redeem: boolean;
+      /** Creation date */
       created_at: string;
+      /** Last updated date */
       updated_at: string;
+      /** List of errors */
       errors: any[];
   }
   export class Coupon implements ICoupon {
@@ -572,17 +1043,29 @@ declare module '@wyocrm/sdk/types' {
       constructor();
   }
   export interface ICouponItem {
+      /** Unique GUID */
       guid: string;
+      /** Coupon details */
       coupon: ICoupon;
+      /** Usage details (specify the type if known) */
       usage: any;
+      /** Promo code */
       promo_code: string;
+      /** Flag for expiry */
       is_expired: boolean;
+      /** Flag for redemption */
       is_redeemed: boolean;
+      /** Flag for generation */
       is_generated: boolean;
+      /** Creation date */
       created_at: string;
+      /** Last updated date */
       updated_at: string;
+      /** Expiry date */
       expired_at: string;
+      /** Version */
       version: string;
+      /** List of errors */
       errors: any[];
   }
   export class CouponItem implements ICouponItem {
@@ -601,8 +1084,11 @@ declare module '@wyocrm/sdk/types' {
       constructor();
   }
   export interface IApiResponse<T> {
+      /** Array of data items */
       data: T[];
+      /** Array of errors */
       errors: string[];
+      /** Total count of all items */
       count_all: number;
   }
   export class ApiResponse<T> implements IApiResponse<T> {
@@ -663,19 +1149,33 @@ declare module '@wyocrm/sdk/types' {
       "invoice" = 1
   }
   export interface IMerchant {
+      /** Unique merchant ID */
       id: number;
+      /** Merchant name */
       name: string;
+      /** Merchant description */
       description?: string;
+      /** License ID */
       license_id: number;
+      /** Business address */
       address?: string;
+      /** Contact phone number */
       phone_number?: string;
+      /** Business email */
       email?: string;
+      /** Website URL */
       website?: string;
+      /** Logo image URL */
       logo_url?: string;
+      /** Business hours in JSON format */
       business_hours?: string;
+      /** Active status */
       is_active: boolean;
+      /** Creation timestamp */
       created_at: string;
+      /** Last update timestamp */
       updated_at: string;
+      /** Error messages */
       errors?: string[];
   }
   export class Merchant implements IMerchant {
@@ -768,19 +1268,33 @@ declare module '@wyocrm/sdk/types' {
       'X-Response-Language'?: string;
       [key: string]: string | undefined;
   }
+  /**
+   * OTP request interface for requesting OTP via SMS
+   */
   export interface IOtpRequest {
+      /** Phone number to send OTP to */
       phone_number: string;
   }
   export class OtpRequest implements IOtpRequest {
       phone_number: string;
       constructor();
   }
+  /**
+   * Base model interface for common database fields
+   */
   export interface IModelBase {
+      /** When this transaction is created */
       created_at: string;
+      /** Date and time of the latest update on this transaction */
       updated_at: string;
+      /** Soft delete flag */
       is_delete: boolean;
+      /** List of errors encountered during processing */
       errors: string[];
   }
+  /**
+   * User preferences extensible data structure
+   */
   export interface IPreferences {
       [key: string]: any;
   }
@@ -788,25 +1302,48 @@ declare module '@wyocrm/sdk/types' {
       [key: string]: any;
       constructor();
   }
+  /**
+   * User detail interface for merchant-specific user information
+   */
   export interface IUserDetail extends IModelBase {
+      /** Primary key identifier */
       id: number;
+      /** License ID associated with the user */
       license_id: number;
+      /** User ID */
       user_id: number;
+      /** User alias or display name */
       alias?: string;
+      /** User image URL (ignored in database operations) */
       image_url?: string;
+      /** Unique membership identifier */
       membership_id?: string;
+      /** User's total credit balance */
       credit: number;
+      /** User's total points */
       point: number;
+      /** Total transaction amount */
       transaction_total: number;
+      /** Number of transactions */
       transaction_time: number;
+      /** Array of tag GUIDs associated with the user */
       tag_guids: string[];
+      /** User group ID */
       user_group_id: number;
+      /** Name of the user group */
       user_group_name?: string;
+      /** Expiration date of the group membership */
       group_expires_at: string;
+      /** Merchant ID where the user was created */
       created_by_merchant_id: number;
+      /** User preferences extensible data */
       preferences: IPreferences;
+      /** Valid coupon count */
       valid_coupon_count: number;
   }
+  /**
+   * User detail class implementation
+   */
   export class UserDetail implements IUserDetail {
       id: number;
       license_id: number;
@@ -888,11 +1425,47 @@ declare module '@wyocrm/sdk/types' {
       exchange_code?: string;
       errors: string[];
   }
+  export type CouponValidationError = 'REDEEMED' | 'EXPIRED' | 'CANNOT_REDEEM' | 'MIN_AMOUNT_NOT_MET' | 'MAX_AMOUNT_EXCEEDED' | 'ITEMS_NOT_MATCHED' | 'INDIVIDUAL_USE_CONFLICT' | 'USAGE_LIMIT_EXCEEDED';
+  export interface ICouponValidationContext {
+      grand_total_amount: number;
+      item_uids: string[];
+      selected_coupons: ICouponItem[];
+  }
+  export interface ICouponValidationResult {
+      valid: boolean;
+      error?: CouponValidationError;
+  }
   export {};
 
 }
 declare module '@wyocrm/sdk/utils' {
+  import { ICouponItem, CouponValidationError, ICouponValidationContext, ICouponValidationResult } from '@wyocrm/sdk/types';
+  /**
+   * Creates a preconfigured Axios instance that unwraps `response.data`.
+   * @param baseURL - API base URL.
+   * @param key - API key sent as `x-api-key`.
+   * @param uid - Device UID sent as `x-device-uid`.
+   * @param timeout - Request timeout in ms.
+   * @returns The Axios instance.
+   */
   export function createInstance(baseURL: string, key: string, uid: string, timeout?: number): import("axios").AxiosInstance;
+  /**
+   * Validates a single coupon item client-side: status, expiry, amount range, item match, individual-use and per-invoice limit.
+   * @param item - The coupon item to validate.
+   * @param context - Invoice grand total, item UIDs and other selected coupons; omit to check status rules only.
+   * @returns `{ valid: true }` or `{ valid: false, error }`.
+   */
+  export function validateCoupon(item: ICouponItem, context?: ICouponValidationContext): ICouponValidationResult;
+  /**
+   * Validates coupon items against each other; each is checked with the rest as `selected_coupons`.
+   * @param items - The coupon items to validate together.
+   * @param context - Invoice grand total and item UIDs; omit to check status rules only.
+   * @returns `valid` plus an `errors` map keyed by item guid.
+   */
+  export function validateCoupons(items: ICouponItem[], context?: Omit<ICouponValidationContext, 'selected_coupons'>): {
+      valid: boolean;
+      errors: Record<string, CouponValidationError>;
+  };
 
 }
 declare module '@wyocrm/sdk' {