@congminh1254/shopee-sdk 0.10.0 → 1.0.0

package/lib/schemas/payment.d.ts

@@ -296,3 +296,400 @@ export interface GetEscrowDetailResponse extends BaseResponse {
         buyer_payment_info: BuyerPaymentInfo;
     };
 }
+/**
+ * Parameters for getting escrow list
+ */
+export type GetEscrowListParams = {
+    /** Query start time (timestamp) */
+    release_time_from: number;
+    /** Query end time (timestamp) */
+    release_time_to: number;
+    /** Number of pages returned, max: 100, default: 40 */
+    page_size?: number;
+    /** The page number, min: 1, default: 1 */
+    page_no?: number;
+};
+/**
+ * Escrow item in list response
+ */
+export interface EscrowListItem {
+    /** Shopee's unique identifier for an order */
+    order_sn: string;
+    /** The settlement amount */
+    payout_amount: number;
+    /** The release time (timestamp) */
+    escrow_release_time: number;
+}
+/**
+ * Response for get escrow list API
+ */
+export interface GetEscrowListResponse extends BaseResponse {
+    response: {
+        /** The list of escrow order sn */
+        escrow_list: EscrowListItem[];
+        /** Indicates whether there are more pages */
+        more: boolean;
+    };
+}
+/**
+ * Parameters for getting escrow detail batch
+ */
+export type GetEscrowDetailBatchParams = {
+    /** List of order SNs, limit [1,50]. Recommended 1-20 orders per request */
+    order_sn_list: string[];
+};
+/**
+ * Escrow detail batch item
+ */
+export interface EscrowDetailBatchItem {
+    /** Shopee's unique identifier for an order */
+    order_sn: string;
+    /** Username of buyer */
+    buyer_user_name: string;
+    /** List of return order numbers */
+    return_order_sn_list: string[];
+    /** Order income details */
+    order_income: OrderIncome;
+    /** Buyer payment information */
+    buyer_payment_info: BuyerPaymentInfo;
+}
+/**
+ * Response for get escrow detail batch API
+ */
+export interface GetEscrowDetailBatchResponse extends BaseResponse {
+    response: {
+        /** List of escrow details */
+        order_income_list: EscrowDetailBatchItem[];
+    };
+}
+/**
+ * Parameters for getting wallet transaction list
+ */
+export type GetWalletTransactionListParams = {
+    /** The start time of the query, timestamp */
+    create_time_from: number;
+    /** The end time of the query, timestamp */
+    create_time_to: number;
+    /** Offset for pagination, start from 0 */
+    page_no?: number;
+    /** The number of records returned per page, min 1, max 100, default 40 */
+    page_size?: number;
+    /** Transaction types filter */
+    transaction_type?: number;
+};
+/**
+ * Wallet transaction item
+ */
+export interface WalletTransaction {
+    /** Transaction ID */
+    transaction_id: number;
+    /** Transaction type */
+    transaction_type: string;
+    /** Transaction status */
+    status: string;
+    /** Amount */
+    amount: number;
+    /** Current balance after this transaction */
+    current_balance: number;
+    /** Transaction time (timestamp) */
+    create_time: number;
+    /** Order SN if related to order */
+    order_sn?: string;
+    /** Withdrawal ID if related to withdrawal */
+    withdrawal_id?: number;
+    /** Reason for transaction */
+    reason: string;
+}
+/**
+ * Response for get wallet transaction list API
+ */
+export interface GetWalletTransactionListResponse extends BaseResponse {
+    response: {
+        /** List of wallet transactions */
+        transaction_list: WalletTransaction[];
+        /** Indicates whether there are more pages */
+        more: boolean;
+    };
+}
+/**
+ * Payment method item
+ */
+export interface PaymentMethod {
+    /** Payment method ID */
+    payment_method_id: number;
+    /** Payment method name */
+    payment_method_name: string;
+    /** Whether this payment method is enabled */
+    is_enabled: boolean;
+}
+/**
+ * Response for get payment method list API
+ */
+export interface GetPaymentMethodListResponse extends BaseResponse {
+    response: {
+        /** List of payment methods */
+        payment_method_list: PaymentMethod[];
+    };
+}
+/**
+ * Response for get shop installment status API
+ */
+export interface GetShopInstallmentStatusResponse extends BaseResponse {
+    response: {
+        /** Tenure list for shop */
+        tenure_list: number[];
+        /** Shop installment status */
+        status: string;
+    };
+}
+/**
+ * Parameters for setting shop installment status
+ */
+export type SetShopInstallmentStatusParams = {
+    /** Whether to enable installment for shop */
+    installment_enabled: boolean;
+    /** List of tenure months to enable */
+    tenure_list?: number[];
+};
+/**
+ * Response for set shop installment status API
+ */
+export interface SetShopInstallmentStatusResponse extends BaseResponse {
+    response: Record<string, never>;
+}
+/**
+ * Parameters for getting item installment status
+ */
+export type GetItemInstallmentStatusParams = {
+    /** Item ID */
+    item_id: number;
+};
+/**
+ * Response for get item installment status API
+ */
+export interface GetItemInstallmentStatusResponse extends BaseResponse {
+    response: {
+        /** Item ID */
+        item_id: number;
+        /** Tenure list enabled for this item */
+        tenure_list: number[];
+    };
+}
+/**
+ * Parameters for setting item installment status
+ */
+export type SetItemInstallmentStatusParams = {
+    /** Item ID */
+    item_id: number;
+    /** List of tenure months to enable */
+    tenure_list: number[];
+};
+/**
+ * Response for set item installment status API
+ */
+export interface SetItemInstallmentStatusResponse extends BaseResponse {
+    response: Record<string, never>;
+}
+/**
+ * Parameters for generating income report
+ */
+export type GenerateIncomeReportParams = {
+    /** Start time for the report (timestamp) */
+    start_time: number;
+    /** End time for the report (timestamp) */
+    end_time: number;
+    /** Currency for the report */
+    currency?: string;
+};
+/**
+ * Response for generate income report API
+ */
+export interface GenerateIncomeReportResponse extends BaseResponse {
+    response: {
+        /** Unique identifier for the income report */
+        income_report_id: string;
+    };
+}
+/**
+ * Parameters for getting income report
+ */
+export type GetIncomeReportParams = {
+    /** Income report ID */
+    income_report_id: string;
+};
+/**
+ * Response for get income report API
+ */
+export interface GetIncomeReportResponse extends BaseResponse {
+    response: {
+        /** Income report ID */
+        income_report_id: string;
+        /** Report status: PROCESSING, COMPLETED, FAILED */
+        status: string;
+        /** Download URL if report is ready */
+        url?: string;
+        /** Report generation time (timestamp) */
+        create_time: number;
+    };
+}
+/**
+ * Parameters for generating income statement
+ */
+export type GenerateIncomeStatementParams = {
+    /** Start time for the statement (timestamp) */
+    start_time: number;
+    /** End time for the statement (timestamp) */
+    end_time: number;
+};
+/**
+ * Response for generate income statement API
+ */
+export interface GenerateIncomeStatementResponse extends BaseResponse {
+    response: {
+        /** Unique identifier for the income statement */
+        income_statement_id: string;
+    };
+}
+/**
+ * Parameters for getting income statement
+ */
+export type GetIncomeStatementParams = {
+    /** Income statement ID */
+    income_statement_id: string;
+};
+/**
+ * Response for get income statement API
+ */
+export interface GetIncomeStatementResponse extends BaseResponse {
+    response: {
+        /** Income statement ID */
+        income_statement_id: string;
+        /** Statement status: PROCESSING, COMPLETED, FAILED */
+        status: string;
+        /** Download URL if statement is ready */
+        url?: string;
+        /** Statement generation time (timestamp) */
+        create_time: number;
+    };
+}
+/**
+ * Parameters for getting billing transaction info
+ */
+export type GetBillingTransactionInfoParams = {
+    /** Transaction time from (timestamp) */
+    transaction_time_from: number;
+    /** Transaction time to (timestamp) */
+    transaction_time_to: number;
+    /** Page number, default 1 */
+    page_no?: number;
+    /** Page size, max 100, default 40 */
+    page_size?: number;
+};
+/**
+ * Billing transaction item
+ */
+export interface BillingTransaction {
+    /** Transaction ID */
+    transaction_id: string;
+    /** Transaction type */
+    transaction_type: string;
+    /** Transaction amount */
+    amount: number;
+    /** Transaction time (timestamp) */
+    transaction_time: number;
+    /** Order SN if applicable */
+    order_sn?: string;
+    /** Currency */
+    currency: string;
+}
+/**
+ * Response for get billing transaction info API
+ */
+export interface GetBillingTransactionInfoResponse extends BaseResponse {
+    response: {
+        /** List of billing transactions */
+        transaction_list: BillingTransaction[];
+        /** Indicates whether there are more pages */
+        more: boolean;
+    };
+}
+/**
+ * Parameters for getting payout detail (deprecated, use getPayoutInfo instead)
+ */
+export type GetPayoutDetailParams = {
+    /** Payout time from (timestamp) */
+    payout_time_from: number;
+    /** Payout time to (timestamp) */
+    payout_time_to: number;
+    /** Page number, default 1 */
+    page_no?: number;
+    /** Page size, max 100, default 40 */
+    page_size?: number;
+};
+/**
+ * Payout detail item
+ */
+export interface PayoutDetail {
+    /** Payout ID */
+    payout_id: string;
+    /** Payout amount */
+    payout_amount: number;
+    /** Payout time (timestamp) */
+    payout_time: number;
+    /** Currency */
+    currency: string;
+    /** Exchange rate */
+    exchange_rate?: number;
+}
+/**
+ * Response for get payout detail API (deprecated)
+ */
+export interface GetPayoutDetailResponse extends BaseResponse {
+    response: {
+        /** List of payout details */
+        payout_list: PayoutDetail[];
+        /** Indicates whether there are more pages */
+        more: boolean;
+    };
+}
+/**
+ * Parameters for getting payout info
+ */
+export type GetPayoutInfoParams = {
+    /** Payout time from (timestamp) */
+    payout_time_from: number;
+    /** Payout time to (timestamp) */
+    payout_time_to: number;
+    /** Page number, default 1 */
+    page_no?: number;
+    /** Page size, max 100, default 40 */
+    page_size?: number;
+};
+/**
+ * Payout info item
+ */
+export interface PayoutInfo {
+    /** Payout ID */
+    payout_id: string;
+    /** Payout amount */
+    payout_amount: number;
+    /** Payout time (timestamp) */
+    payout_time: number;
+    /** Currency */
+    currency: string;
+    /** Exchange rate */
+    exchange_rate?: number;
+    /** Payout fee */
+    payout_fee?: number;
+}
+/**
+ * Response for get payout info API
+ */
+export interface GetPayoutInfoResponse extends BaseResponse {
+    response: {
+        /** List of payout info */
+        payout_list: PayoutInfo[];
+        /** Indicates whether there are more pages */
+        more: boolean;
+    };
+}