@thera-hr/api-sdk 0.0.1-prerelease2786-dev-anthony → 0.0.1-prerelease2787-dev-2

package/api/resources/api/resources/thera/resources/bridge/resources/bridgeApi/client/Client.d.ts

@@ -0,0 +1,303 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as core from "../../../../../../../../../../core";
+import * as TheraApi from "../../../../../../../../../index";
+export declare namespace BridgeApi {
+    interface Options {
+        environment: core.Supplier<string>;
+        token?: core.Supplier<core.BearerToken | undefined>;
+    }
+    interface RequestOptions {
+        timeoutInSeconds?: number;
+        maxRetries?: number;
+        abortSignal?: AbortSignal;
+    }
+}
+export declare class BridgeApi {
+    protected readonly _options: BridgeApi.Options;
+    constructor(_options: BridgeApi.Options);
+    /**
+     * Customers need to accept Bridge's terms of service before KYC processing.
+     *
+     * @param {BridgeApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.api.thera.bridge.bridgeApi.requestTosLink()
+     */
+    requestTosLink(requestOptions?: BridgeApi.RequestOptions): Promise<TheraApi.api.thera.bridge.TosLinkResponse>;
+    /**
+     * Create a new customer and start the KYC process.
+     *
+     * @param {TheraApi.api.thera.bridge.CreateCustomer} request
+     * @param {BridgeApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.api.thera.bridge.bridgeApi.createCustomer({
+     *         type: "string",
+     *         firstName: "string",
+     *         lastName: "string",
+     *         email: "string",
+     *         phone: "string",
+     *         address: {
+     *             streetLine1: "string",
+     *             streetLine2: "string",
+     *             city: "string",
+     *             state: "string",
+     *             postalCode: "string",
+     *             country: "string"
+     *         },
+     *         signedAgreementId: "string",
+     *         birthDate: "string",
+     *         taxIdentificationNumber: "string",
+     *         documents: [{
+     *                 purposes: [{
+     *                         "key": "value"
+     *                     }],
+     *                 file: "string",
+     *                 description: {
+     *                     "key": "value"
+     *                 }
+     *             }],
+     *         identifyingInformation: [{
+     *                 type: "string",
+     *                 imageFront: "string",
+     *                 issuingCountry: "string",
+     *                 number: {
+     *                     "key": "value"
+     *                 },
+     *                 imageBack: {
+     *                     "key": "value"
+     *                 }
+     *             }],
+     *         residentialAddress: {
+     *             streetLine1: "string",
+     *             streetLine2: "string",
+     *             city: "string",
+     *             state: "string",
+     *             postalCode: "string",
+     *             country: "string"
+     *         },
+     *         documentIdentificationNumber: "string"
+     *     })
+     */
+    createCustomer(request: TheraApi.api.thera.bridge.CreateCustomer, requestOptions?: BridgeApi.RequestOptions): Promise<TheraApi.db.User>;
+    /**
+     * Links an external crypto wallet to a customer.
+     *
+     * @param {string} customerId
+     * @param {TheraApi.api.thera.bridge.ExternalAccount} request
+     * @param {BridgeApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.api.thera.bridge.bridgeApi.createExternalAccount("string", {
+     *         walletAddress: "string",
+     *         currency: "string",
+     *         paymentRail: "string"
+     *     })
+     */
+    createExternalAccount(customerId: string, request: TheraApi.api.thera.bridge.ExternalAccount, requestOptions?: BridgeApi.RequestOptions): Promise<TheraApi.api.thera.bridge.LinkExternalAccountResponse>;
+    /**
+     * Retrieve customer details, including linked accounts and KYC status.
+     *
+     * @param {string} customerId
+     * @param {BridgeApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.api.thera.bridge.bridgeApi.getCustomerDetails("string")
+     */
+    getCustomerDetails(customerId: string, requestOptions?: BridgeApi.RequestOptions): Promise<TheraApi.api.thera.bridge.CustomerDetails>;
+    /**
+     * Retrieve a list of all registered customers.
+     *
+     * @param {BridgeApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.api.thera.bridge.bridgeApi.getAllCustomers()
+     */
+    getAllCustomers(requestOptions?: BridgeApi.RequestOptions): Promise<TheraApi.api.thera.bridge.CustomerDetails[]>;
+    /**
+     * Initiates a payout transaction to an external crypto wallet.
+     *
+     * @param {TheraApi.api.thera.bridge.CryptoPayout} request
+     * @param {BridgeApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.api.thera.bridge.bridgeApi.processCryptoPayout({
+     *         customerId: "string",
+     *         amount: "string",
+     *         currency: "string",
+     *         recipientWallet: "string",
+     *         network: "string"
+     *     })
+     */
+    processCryptoPayout(request: TheraApi.api.thera.bridge.CryptoPayout, requestOptions?: BridgeApi.RequestOptions): Promise<TheraApi.api.thera.bridge.PayoutResponse>;
+    /**
+     * Retrieve the status of a previously processed crypto payout.
+     *
+     * @param {string} transactionId
+     * @param {BridgeApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.api.thera.bridge.bridgeApi.getPayoutStatus("string")
+     */
+    getPayoutStatus(transactionId: string, requestOptions?: BridgeApi.RequestOptions): Promise<TheraApi.api.thera.bridge.PayoutStatus>;
+    /**
+     * Creates a new bridge wallet for a customer.
+     *
+     * @param {TheraApi.api.thera.bridge.CreateWalletRequest} request
+     * @param {BridgeApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.api.thera.bridge.bridgeApi.createWallet({
+     *         userId: "string",
+     *         chain: "string"
+     *     })
+     */
+    createWallet(request: TheraApi.api.thera.bridge.CreateWalletRequest, requestOptions?: BridgeApi.RequestOptions): Promise<TheraApi.api.thera.bridge.WalletDetails>;
+    /**
+     * Retrieves details of a specific wallet.
+     *
+     * @param {string} walletId
+     * @param {BridgeApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.api.thera.bridge.bridgeApi.getWalletDetails("string")
+     */
+    getWalletDetails(walletId: string, requestOptions?: BridgeApi.RequestOptions): Promise<TheraApi.api.thera.bridge.WalletDetails>;
+    /**
+     * Retrieves all wallets associated with a customer.
+     *
+     * @param {string} customerId
+     * @param {BridgeApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.api.thera.bridge.bridgeApi.listWallets("string")
+     */
+    listWallets(customerId: string, requestOptions?: BridgeApi.RequestOptions): Promise<TheraApi.api.thera.bridge.WalletDetails[]>;
+    /**
+     * Transfers funds between custodial wallets.
+     *
+     * @param {TheraApi.api.thera.bridge.TransferFundsRequest} request
+     * @param {BridgeApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.api.thera.bridge.bridgeApi.transferFunds({
+     *         fromWalletId: "string",
+     *         toWalletId: "string",
+     *         amount: "string",
+     *         currency: "string",
+     *         flow: TheraApi.api.thera.bridge.TransferFundsFlow.PayoutWallet
+     *     })
+     */
+    transferFunds(request: TheraApi.api.thera.bridge.TransferFundsRequest, requestOptions?: BridgeApi.RequestOptions): Promise<TheraApi.api.thera.bridge.TransferFundsResponse>;
+    /**
+     * Retrieve details of a linked external crypto account.
+     *
+     * @param {string} accountId
+     * @param {BridgeApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.api.thera.bridge.bridgeApi.getExternalAccount("string")
+     */
+    getExternalAccount(accountId: string, requestOptions?: BridgeApi.RequestOptions): Promise<TheraApi.api.thera.bridge.ExternalAccount>;
+    /**
+     * Retrieve a list of all external accounts linked to customers.
+     *
+     * @param {string} customerId
+     * @param {BridgeApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.api.thera.bridge.bridgeApi.listExternalAccounts("string")
+     */
+    listExternalAccounts(customerId: string, requestOptions?: BridgeApi.RequestOptions): Promise<TheraApi.api.thera.bridge.ExternalAccount[]>;
+    /**
+     * Update details of a linked external account.
+     *
+     * @param {string} accountId
+     * @param {TheraApi.api.thera.bridge.UpdateExternalAccountRequest} request
+     * @param {BridgeApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.api.thera.bridge.bridgeApi.updateExternalAccount("string", {
+     *         nickname: "string",
+     *         accountStatus: "string"
+     *     })
+     */
+    updateExternalAccount(accountId: string, request: TheraApi.api.thera.bridge.UpdateExternalAccountRequest, requestOptions?: BridgeApi.RequestOptions): Promise<TheraApi.api.thera.bridge.UpdateExternalAccountResponse>;
+    /**
+     * Unlinks an external crypto account from a customer.
+     *
+     * @param {string} accountId
+     * @param {BridgeApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.api.thera.bridge.bridgeApi.unlinkExternalAccount("string")
+     */
+    unlinkExternalAccount(accountId: string, requestOptions?: BridgeApi.RequestOptions): Promise<void>;
+    /**
+     * Reactivates a previously unlinked external account.
+     *
+     * @param {string} accountId
+     * @param {BridgeApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.api.thera.bridge.bridgeApi.reactivateExternalAccount("string")
+     */
+    reactivateExternalAccount(accountId: string, requestOptions?: BridgeApi.RequestOptions): Promise<void>;
+    /**
+     * Initiates a transfer transaction between accounts.
+     *
+     * @param {TheraApi.api.thera.bridge.Transfer} request
+     * @param {BridgeApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.api.thera.bridge.bridgeApi.createTransfer({
+     *         clientReferenceId: "string",
+     *         amount: "string",
+     *         onBehalfOf: "string",
+     *         developerFee: "string",
+     *         source: {
+     *             currency: "string",
+     *             paymentRail: "string",
+     *             externalAccountId: "string",
+     *             bridgeWalletId: "string",
+     *             fromAddress: "string"
+     *         },
+     *         destination: {
+     *             currency: "string",
+     *             paymentRail: "string",
+     *             externalAccountId: "string",
+     *             bridgeWalletId: "string",
+     *             toAddress: "string",
+     *             wireMessage: "string",
+     *             sepaReference: "string",
+     *             swiftReference: "string",
+     *             swiftCharges: "string",
+     *             achReference: "string"
+     *         }
+     *     })
+     */
+    createTransfer(request: TheraApi.api.thera.bridge.Transfer, requestOptions?: BridgeApi.RequestOptions): Promise<TheraApi.api.thera.bridge.TransferFundsResponse>;
+    /**
+     * Retrieve details of a specific transfer.
+     *
+     * @param {string} transactionId
+     * @param {BridgeApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.api.thera.bridge.bridgeApi.getTransferDetails("string")
+     */
+    getTransferDetails(transactionId: string, requestOptions?: BridgeApi.RequestOptions): Promise<TheraApi.api.thera.bridge.TransferDetails>;
+    /**
+     * Retrieves all transfers.
+     *
+     * @param {string} customerId
+     * @param {BridgeApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.api.thera.bridge.bridgeApi.listTransfers("string")
+     */
+    listTransfers(customerId: string, requestOptions?: BridgeApi.RequestOptions): Promise<TheraApi.api.thera.bridge.TransferDetails[]>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}