@coin-voyage/shared 2.1.0 → 2.2.0-beta.1

package/dist/api/client.d.ts

@@ -1,5 +1,5 @@
 import { type CurrencyWithBalance, type PayOrder, PayOrderMode } from "../common/index";
-import type { PaymentDetails, PaymentDetailsParams, PayOrderParams, PayOrderQuoteParams } from "../types/api";
+import type { ClaimFeesRequest, ClaimFeesResponse, CreateWebhookRequest, GetFeeBalancesResponse, PaymentDetails, PaymentDetailsParams, PayOrderParams, PayOrderQuoteParams, QuoteWithBalance, SwapDataRequest, SwapDataResponse, SwapQuoteRequest, UpdateWebhookRequest, WebhookResponse } from "../types/api";
 import { type APIEnvironment } from "./config";
 import { type APIResponse } from "./fetcher";
 export declare class ApiClient {
@@ -7,7 +7,7 @@ export declare class ApiClient {
     private readonly environment?;
     private readonly sessionId?;
     private readonly version?;
-    constructor({ apiKey, sessionId, environment, version }: {
+    constructor({ apiKey, sessionId, environment, version, }: {
         apiKey: string;
         sessionId?: string;
         environment?: APIEnvironment;
@@ -15,176 +15,176 @@ export declare class ApiClient {
     });
     private request;
     /**
-    * Fetches a PayOrder by its ID.
-    *
-    * Retrieves a PayOrder object from the API using the provided payOrderId.
-    * This function requires an API key for authentication.
-    *
-    * @param {string} payOrderId - The unique identifier of the PayOrder.
-    * @returns {Promise<APIResponse<PayOrder>>} - The PayOrder object wrapped in an API response if the request is successful.
-    *
-    * @example
-    * const { data: payOrder, error } = await getPayOrder('123456');
-    */
+     * Fetches a PayOrder by its ID.
+     *
+     * Retrieves a PayOrder object from the API using the provided payOrderId.
+     * This function requires an API key for authentication.
+     *
+     * @param {string} payOrderId - The unique identifier of the PayOrder.
+     * @returns {Promise<APIResponse<PayOrder>>} - The PayOrder object wrapped in an API response if the request is successful.
+     *
+     * @example
+     * const { data: payOrder, error } = await getPayOrder('123456');
+     */
     getPayOrder(payOrderId: string): Promise<APIResponse<PayOrder>>;
     /**
-    * Creates a `DEPOSIT` PayOrder.
-    *
-    * Creates a PayOrder of type `DEPOSIT` with the provided parameters.
-    *
-    * @param {PayOrderParams} params - Parameters required to create a deposit PayOrder.
-    * @returns {Promise<APIResponse<PayOrder>>} - The PayOrder object wrapped in an API response if the request is successful.
-    *
-    * @example
-    * const depositOrderParams = {
-    *   intent: {
-    *      asset: { chain_id: 1, address: null },
-    *      amount: { token_amount: 100 },
-    *      receiving_address: '0x1234...abcd'
-    *   },
-    *   metadata: { description: 'Deposit for account' }
-    * };
-    * const { data, error } = await createDepositPayOrder(depositOrderParams);
-    * if (data) {
-    *   console.log('Deposit PayOrder created:', data);
-    * }
-    */
+     * Creates a `DEPOSIT` PayOrder.
+     *
+     * Creates a PayOrder of type `DEPOSIT` with the provided parameters.
+     *
+     * @param {PayOrderParams} params - Parameters required to create a deposit PayOrder.
+     * @returns {Promise<APIResponse<PayOrder>>} - The PayOrder object wrapped in an API response if the request is successful.
+     *
+     * @example
+     * const depositOrderParams = {
+     *   intent: {
+     *      asset: { chain_id: 1, address: null },
+     *      amount: { token_amount: 100 },
+     *      receiving_address: '0x1234...abcd'
+     *   },
+     *   metadata: { description: 'Deposit for account' }
+     * };
+     * const { data, error } = await createDepositPayOrder(depositOrderParams);
+     * if (data) {
+     *   console.log('Deposit PayOrder created:', data);
+     * }
+     */
     createDepositPayOrder(params: PayOrderParams): Promise<APIResponse<PayOrder>>;
     /**
-    * Creates a `SALE` PayOrder.
-    *
-    * Creates a PayOrder with mode `SALE` with the provided params.
-    *
-    * Requires a valid HMAC-SHA256 signature generated by `generateAuthorizationSignature`.
-    *
-    * @param {SalePayOrderParams} params - Params required to create a sale PayOrder.
-    * @param {string} apiSecret - API secret used to generate the authorization signature.
-    * @returns {Promise<APIResponse<PayOrder>>} - A PayOrder object wrapped in an API response if the request was successful.
-    *
-    * @example
-    * const apiSecret = 'yourApiSecret';
-    * const response = await createSalePayOrder({
-    *   intent: {
-    *     asset: { chain_id: 1, address: null },
-    *     amount: {
-    *      fiat: {
-    *        amount: 200,
-    *        unit: "USD"
-    *     },
-    *   },
-    *   metadata: {
-    *     items: [
-    *       {
-    *         name: "t-shirt",
-    *         description: "a nice t-shirt",
-    *         image: "https://example.com/tshirt.jpg",
-    *         quantity: 1,
-    *         unit_price: 200,
-    *         currency: "USD"
-    *       }
-    *     ]
-    *   }
-    * }, apiSecret);
-    * if (response.data) {
-    *   console.log('Sale PayOrder created:', response.data);
-    * }
-    */
+     * Creates a `SALE` PayOrder.
+     *
+     * Creates a PayOrder with mode `SALE` with the provided params.
+     *
+     * Requires a valid HMAC-SHA256 signature generated by `generateAuthorizationSignature`.
+     *
+     * @param {SalePayOrderParams} params - Params required to create a sale PayOrder.
+     * @param {string} apiSecret - API secret used to generate the authorization signature.
+     * @returns {Promise<APIResponse<PayOrder>>} - A PayOrder object wrapped in an API response if the request was successful.
+     *
+     * @example
+     * const apiSecret = 'yourApiSecret';
+     * const response = await createSalePayOrder({
+     *   intent: {
+     *     asset: { chain_id: 1, address: null },
+     *     amount: {
+     *      fiat: {
+     *        amount: 200,
+     *        unit: "USD"
+     *     },
+     *   },
+     *   metadata: {
+     *     items: [
+     *       {
+     *         name: "t-shirt",
+     *         description: "a nice t-shirt",
+     *         image: "https://example.com/tshirt.jpg",
+     *         quantity: 1,
+     *         unit_price: 200,
+     *         currency: "USD"
+     *       }
+     *     ]
+     *   }
+     * }, apiSecret);
+     * if (response.data) {
+     *   console.log('Sale PayOrder created:', response.data);
+     * }
+     */
     createSalePayOrder(params: PayOrderParams, apiSecret: string): Promise<APIResponse<PayOrder>>;
     /**
-    * Creates a `REFUND` PayOrder.
-    *
-    * Creates a PayOrder with mode `REFUND` with the provided params.
-    *
-    * Requires a valid HMAC-SHA256 signature generated by `generateAuthorizationSignature`.
-    *
-    * @param {string} payOrderId - The unique identifier of the PayOrder to be refunded.
-    * @param {PayOrderParams} params - Params required to create a refund PayOrder.
-    * @param {string} apiSecret - API secret used to generate the authorization signature.
-    * @returns {Promise<APIResponse<PayOrder>>} - A PayOrder object wrapped in an API response if the request was successful.
-    *
-    * @example
-    * const apiSecret = 'yourApiSecret';
-    * const response = await createRefundPayOrder(refundOrderId, {
-    *   intent: {
-    *     asset: { chain_id: 1, address: null },
-    *     receiving_address: '0x5678...efgh',
-    *     amount: {
-    *       fiat: {
-    *         value: 100,
-    *         unit: "USD"
-    *       }
-    *     }
-    *   },
-    *   metadata: {
-    *     items: [
-    *       {
-    *         name: "refund",
-    *         description: "Refund for t-shirt purchase",
-    *         unit_price: 100,
-    *         currency: "USD"
-    *       }
-    *     ]
-    *   }
-    * }, apiSecret);
-    * if (response.data) {
-    *   console.log('Refund PayOrder created:', response.data);
-    * }
-    */
+     * Creates a `REFUND` PayOrder.
+     *
+     * Creates a PayOrder with mode `REFUND` with the provided params.
+     *
+     * Requires a valid HMAC-SHA256 signature generated by `generateAuthorizationSignature`.
+     *
+     * @param {string} payOrderId - The unique identifier of the PayOrder to be refunded.
+     * @param {PayOrderParams} params - Params required to create a refund PayOrder.
+     * @param {string} apiSecret - API secret used to generate the authorization signature.
+     * @returns {Promise<APIResponse<PayOrder>>} - A PayOrder object wrapped in an API response if the request was successful.
+     *
+     * @example
+     * const apiSecret = 'yourApiSecret';
+     * const response = await createRefundPayOrder(refundOrderId, {
+     *   intent: {
+     *     asset: { chain_id: 1, address: null },
+     *     receiving_address: '0x5678...efgh',
+     *     amount: {
+     *       fiat: {
+     *         value: 100,
+     *         unit: "USD"
+     *       }
+     *     }
+     *   },
+     *   metadata: {
+     *     items: [
+     *       {
+     *         name: "refund",
+     *         description: "Refund for t-shirt purchase",
+     *         unit_price: 100,
+     *         currency: "USD"
+     *       }
+     *     ]
+     *   }
+     * }, apiSecret);
+     * if (response.data) {
+     *   console.log('Refund PayOrder created:', response.data);
+     * }
+     */
     createRefundPayOrder(payOrderId: string, params: PayOrderParams, apiSecret: string): Promise<APIResponse<PayOrder>>;
     createPayOrder(params: PayOrderParams, mode: PayOrderMode, signature?: string): Promise<APIResponse<PayOrder>>;
     /**
-   * Generates a PayOrder Quote.
-   *
-   * Creates a PayOrder Quote for an existing PayOrder by providing wallet information and chain details.
-   * This function requires an API key for authentication.
-   *
-   * @param {string} orderId - The unique identifier of the PayOrder for which the quote is requested.
-   * @param {PayOrderQuoteParams} quoteParams - Contains `wallet_address`, `chain_type`, `chain_id`.
-   * @returns {Promise<APIResponse<CurrencyWithBalance[]>>} - An array of PayTokens wrapped in an API response if the request was successful.
-   *
-   * @example
-   * const orderId = 'existingOrderId';
-   * const quoteParams = {
-   *   wallet_address: '0x1234...abcd',
-   *   chain_type: ChainType.EVM,
-   *   chain_id: 1 // Ethereum Mainnet
-   * };
-   *
-   * const response = await payOrderQuote(orderId, quoteParams);
-   * if (response.data) {
-   *   console.log('Available tokens:', response.data);
-   * }
-   */
+     * Generates a PayOrder Quote.
+     *
+     * Creates a PayOrder Quote for an existing PayOrder by providing wallet information and chain details.
+     * This function requires an API key for authentication.
+     *
+     * @param {string} orderId - The unique identifier of the PayOrder for which the quote is requested.
+     * @param {PayOrderQuoteParams} quoteParams - Contains `wallet_address`, `chain_type`, `chain_id`.
+     * @returns {Promise<APIResponse<CurrencyWithBalance[]>>} - An array of PayTokens wrapped in an API response if the request was successful.
+     *
+     * @example
+     * const orderId = 'existingOrderId';
+     * const quoteParams = {
+     *   wallet_address: '0x1234...abcd',
+     *   chain_type: ChainType.EVM,
+     *   chain_id: 1 // Ethereum Mainnet
+     * };
+     *
+     * const response = await payOrderQuote(orderId, quoteParams);
+     * if (response.data) {
+     *   console.log('Available tokens:', response.data);
+     * }
+     */
     payOrderQuote(orderId: string, quoteParams: PayOrderQuoteParams): Promise<APIResponse<CurrencyWithBalance[]>>;
     /**
-  * Retrieves payment details for a specific PayOrder.
-  *
-  * This function fetches payment details associated with a specific PayOrder ID.
-  * It allows specifying the token and blockchain network (via `token_address` and `chain_id`)
-  * to retrieve source currency information, as well as a refund address for the transaction.
-  *
-  * The request is authenticated using the provided API key in the headers.
-  *
-  * @param {PaymentDetailsParams} params - Parameters to retrieve the payment details.
-  * @param {string} params.payorder_id - The unique identifier of the PayOrder for which payment details are fetched.
-  * @param {string} [params.token_address] - (Optional) The token address of the source currency.
-  * @param {ChainId} params.chain_id - The blockchain network ID where the token resides.
-  * @param {string} params.refund_address - The address where funds will be refunded in case of a failed transaction.
-  *
-  * @returns {Promise<APIResponse<PaymentDetails>>} - The payment details object wrapped in an API response if the request is successful.
-  *
-  * @example
-  * const response = await payOrderPaymentDetails({
-  *   payorder_id: '12345',
-  *   token_address: '0x1234567890abcdef1234567890abcdef12345678',
-  *   chain_id: 1,
-  *   refund_address: '0xabcdefabcdefabcdefabcdefabcdefabcdefabcd',
-  * });
-  *
-  * if (response.data) {
-  *   console.log('Payment details:', response.data);
-  * }
-  */
+     * Retrieves payment details for a specific PayOrder.
+     *
+     * This function fetches payment details associated with a specific PayOrder ID.
+     * It allows specifying the token and blockchain network (via `token_address` and `chain_id`)
+     * to retrieve source currency information, as well as a refund address for the transaction.
+     *
+     * The request is authenticated using the provided API key in the headers.
+     *
+     * @param {PaymentDetailsParams} params - Parameters to retrieve the payment details.
+     * @param {string} params.payorder_id - The unique identifier of the PayOrder for which payment details are fetched.
+     * @param {string} [params.token_address] - (Optional) The token address of the source currency.
+     * @param {ChainId} params.chain_id - The blockchain network ID where the token resides.
+     * @param {string} params.refund_address - The address where funds will be refunded in case of a failed transaction.
+     *
+     * @returns {Promise<APIResponse<PaymentDetails>>} - The payment details object wrapped in an API response if the request is successful.
+     *
+     * @example
+     * const response = await payOrderPaymentDetails({
+     *   payorder_id: '12345',
+     *   token_address: '0x1234567890abcdef1234567890abcdef12345678',
+     *   chain_id: 1,
+     *   refund_address: '0xabcdefabcdefabcdefabcdefabcdefabcdefabcd',
+     * });
+     *
+     * if (response.data) {
+     *   console.log('Payment details:', response.data);
+     * }
+     */
     payOrderPaymentDetails(params: PaymentDetailsParams): Promise<APIResponse<PaymentDetails>>;
     /**
      * Generates an authorization signature for API requests using HMAC-SHA256.
@@ -211,4 +211,65 @@ export declare class ApiClient {
      * // APIKey=yourApiKey,signature=a1b2c3d4...,timestamp=1737106896
      */
     generateAuthorizationSignature(apiSecret: string, method: string, path: string): string;
+    /**
+     * Retrieves the claimable fee balances for the authenticated organization.
+     *
+     * @param {string} apiSecret - API secret used to generate the authorization signature.
+     * @returns {Promise<APIResponse<GetFeeBalancesResponse>>} - Fee balances wrapped in an API response.
+     */
+    getFeeBalances(apiSecret: string): Promise<APIResponse<GetFeeBalancesResponse>>;
+    /**
+     * Claims accrued fees for the authenticated organization.
+     *
+     * @param {ClaimFeesRequest} params - Parameters for claiming fees.
+     * @param {string} apiSecret - API secret used to generate the authorization signature.
+     * @returns {Promise<APIResponse<ClaimFeesResponse>>} - Claim result wrapped in an API response.
+     */
+    claimFees(params: ClaimFeesRequest, apiSecret: string): Promise<APIResponse<ClaimFeesResponse>>;
+    /**
+     * Retrieves all webhooks for the authenticated organization.
+     *
+     * @param {string} apiSecret - API secret used to generate the authorization signature.
+     * @returns {Promise<APIResponse<WebhookResponse[]>>} - List of webhooks wrapped in an API response.
+     */
+    listWebhooks(apiSecret: string): Promise<APIResponse<WebhookResponse[]>>;
+    /**
+     * Creates a new webhook for the authenticated organization.
+     *
+     * @param {CreateWebhookRequest} params - Parameters for creating the webhook.
+     * @param {string} apiSecret - API secret used to generate the authorization signature.
+     * @returns {Promise<APIResponse<WebhookResponse>>} - Created webhook wrapped in an API response.
+     */
+    createWebhook(params: CreateWebhookRequest, apiSecret: string): Promise<APIResponse<WebhookResponse>>;
+    /**
+     * Updates an existing webhook for the authenticated organization.
+     *
+     * @param {string} webhookId - The unique identifier of the webhook to update.
+     * @param {UpdateWebhookRequest} params - Parameters for updating the webhook.
+     * @param {string} apiSecret - API secret used to generate the authorization signature.
+     * @returns {Promise<APIResponse<WebhookResponse>>} - Updated webhook wrapped in an API response.
+     */
+    updateWebhook(webhookId: string, params: UpdateWebhookRequest, apiSecret: string): Promise<APIResponse<WebhookResponse>>;
+    /**
+     * Deletes an existing webhook for the authenticated organization.
+     *
+     * @param {string} webhookId - The unique identifier of the webhook to delete.
+     * @param {string} apiSecret - API secret used to generate the authorization signature.
+     * @returns {Promise<APIResponse<void>>} - Empty response on success.
+     */
+    deleteWebhook(webhookId: string, apiSecret: string): Promise<APIResponse<void>>;
+    /**
+     * Gets a quote for swapping between two currencies.
+     *
+     * @param {SwapQuoteRequest} params - Parameters for the swap quote.
+     * @returns {Promise<APIResponse<QuoteWithBalance>>} - Swap quote wrapped in an API response.
+     */
+    swapQuote(params: SwapQuoteRequest): Promise<APIResponse<QuoteWithBalance>>;
+    /**
+     * Gets transaction data for executing a swap.
+     *
+     * @param {SwapDataRequest} params - Parameters for the swap data.
+     * @returns {Promise<APIResponse<SwapDataResponse>>} - Swap data wrapped in an API response.
+     */
+    swapData(params: SwapDataRequest): Promise<APIResponse<SwapDataResponse>>;
 }