dutchman-bridge 1.0.0

package/dist/sdk.gen.d.ts

@@ -0,0 +1,339 @@
+import { type Client, type ClientMeta, type Options as Options2, type RequestResult, type TDataShape } from './client';
+import type { BankAddAccountData, BankAddAccountResponses, BankBanksData, BankBanksResponses, BankDeleteAccountData, BankDeleteAccountResponses, BankGetAccountsData, BankGetAccountsResponses, BankSetDefaultAccountData, BankSetDefaultAccountResponses, BankVerifyAccountData, BankVerifyAccountResponses, CountriesListData, CountriesListResponses, CustomersFullData, CustomersFullResponses, CustomersGetData, CustomersGetResponses, CustomersRegisterData, CustomersRegisterResponses, FeaturesListData, FeaturesListResponses, GlobalSendCorridorsData, GlobalSendCorridorsResponses, GlobalSendInitiateData, GlobalSendInitiateResponses, GlobalSendQuoteData, GlobalSendQuoteResponses, GlobalSendVerificationStatusData, GlobalSendVerificationStatusResponses, KycDocumentData, KycDocumentResponses, KycReverificationData, KycReverificationResponses, KycSelfieCheckRouteData, KycSelfieCheckRouteResponses, KycStatusData, KycStatusResponses, KycTier1Data, KycTier1Responses, KycTier2Data, KycTier2Responses, KycTier3Data, KycTier3Responses, ProfileChangePasswordData, ProfileChangePasswordResponses, ProfileDeleteAccountData, ProfileDeleteAccountResponses, ProfileGetSettlementModeData, ProfileGetSettlementModeResponses, ProfileProfileData, ProfileProfileResponses, ProfileSetSettlementModeData, ProfileSetSettlementModeResponses, ProfileUpdateProfileData, ProfileUpdateProfileResponses, ProfileWithdrawalsData, ProfileWithdrawalsResponses, RampBuyData, RampBuyQuoteData, RampBuyQuoteResponses, RampBuyResponses, RampRateData, RampRateResponses, RampSellData, RampSellNetworksData, RampSellNetworksResponses, RampSellQuoteData, RampSellQuoteResponses, RampSellResponses, ReceivingActivityData, ReceivingActivityResponses, ReceivingCurrenciesData, ReceivingCurrenciesResponses, ReceivingListData, ReceivingListResponses, ReceivingOpenData, ReceivingOpenResponses, ReceivingRefreshData, ReceivingRefreshResponses, SendNetworksData, SendNetworksResponses, SendQuoteData, SendQuoteResponses, SendSubmitData, SendSubmitResponses, WalletAddressesData, WalletAddressesResponses, WalletBalanceData, WalletBalanceResponses, WalletFundingChargesData, WalletFundingChargesResponses, WalletInitiateFundingChargeData, WalletInitiateFundingChargeResponses, WalletStreamBalanceData, WalletStreamBalanceResponses, WalletTransactionsData, WalletTransactionsResponses, WalletVirtualAccountForData, WalletVirtualAccountForResponses, WalletWithdrawData, WalletWithdrawResponses, WebhookConfigData, WebhookConfigResponses, WebhookDeliveriesData, WebhookDeliveriesResponses, WebhookDeliveryData, WebhookDeliveryResponses, WebhookReplayData, WebhookReplayResponses, WebhookRotateSecretData, WebhookRotateSecretResponses, WebhookSetUrlData, WebhookSetUrlResponses } from './types.gen';
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
+};
+declare class HeyApiClient {
+    protected client: Client;
+    constructor(args?: {
+        client?: Client;
+    });
+}
+declare class HeyApiRegistry<T> {
+    private readonly defaultKey;
+    private readonly instances;
+    get(key?: string): T;
+    set(value: T, key?: string): void;
+}
+export declare class Customers extends HeyApiClient {
+    /**
+     * Register a customer under your account
+     *
+     * The customer never authenticates with Dutchman Bridge directly -- that's entirely yours to manage. This just attributes a new customer id to your account so every other Partner API call can reference it.
+     */
+    register<ThrowOnError extends boolean = false>(options: Options<CustomersRegisterData, ThrowOnError>): RequestResult<CustomersRegisterResponses, unknown, ThrowOnError>;
+    /**
+     * Read one of your customer's profile
+     */
+    get<ThrowOnError extends boolean = false>(options: Options<CustomersGetData, ThrowOnError>): RequestResult<CustomersGetResponses, unknown, ThrowOnError>;
+    /**
+     * A customer's full snapshot -- profile, KYC, and wallet -- in one call
+     *
+     * Replaces separately calling profile/kyc/wallet routes when you just need a customer's current state, e.g. right after registration or to reconcile after a webhook. Not a substitute for the wallet routes' live balance -- fetch this fresh rather than caching it indefinitely, since a crypto deposit or fiat funding event has no webhook of its own yet.
+     */
+    full<ThrowOnError extends boolean = false>(options: Options<CustomersFullData, ThrowOnError>): RequestResult<CustomersFullResponses, unknown, ThrowOnError>;
+}
+export declare class Profile extends HeyApiClient {
+    /**
+     * Delete the customer's account
+     *
+     * Refused (409) while the customer still holds a balance or has a transfer in flight. Deleting twice is not an error.
+     */
+    deleteAccount<ThrowOnError extends boolean = false>(options: Options<ProfileDeleteAccountData, ThrowOnError>): RequestResult<ProfileDeleteAccountResponses, unknown, ThrowOnError>;
+    /**
+     * The customer's profile
+     */
+    profile<ThrowOnError extends boolean = false>(options: Options<ProfileProfileData, ThrowOnError>): RequestResult<ProfileProfileResponses, unknown, ThrowOnError>;
+    /**
+     * Update the customer's profile
+     *
+     * Identity fields can be filled in while empty; once KYC is approved they lock, and only an admin re-verification request reopens them.
+     */
+    updateProfile<ThrowOnError extends boolean = false>(options: Options<ProfileUpdateProfileData, ThrowOnError>): RequestResult<ProfileUpdateProfileResponses, unknown, ThrowOnError>;
+    /**
+     * Change the customer's password
+     */
+    changePassword<ThrowOnError extends boolean = false>(options: Options<ProfileChangePasswordData, ThrowOnError>): RequestResult<ProfileChangePasswordResponses, unknown, ThrowOnError>;
+    /**
+     * Read the customer's settlement preference (AUTO to default bank vs MANUAL hold)
+     */
+    getSettlementMode<ThrowOnError extends boolean = false>(options: Options<ProfileGetSettlementModeData, ThrowOnError>): RequestResult<ProfileGetSettlementModeResponses, unknown, ThrowOnError>;
+    /**
+     * Update how the customer's sale proceeds settle
+     */
+    setSettlementMode<ThrowOnError extends boolean = false>(options: Options<ProfileSetSettlementModeData, ThrowOnError>): RequestResult<ProfileSetSettlementModeResponses, unknown, ThrowOnError>;
+    /**
+     * The customer's withdrawal / global payout history, newest first
+     */
+    withdrawals<ThrowOnError extends boolean = false>(options: Options<ProfileWithdrawalsData, ThrowOnError>): RequestResult<ProfileWithdrawalsResponses, unknown, ThrowOnError>;
+}
+export declare class Kyc extends HeyApiClient {
+    /**
+     * A customer's KYC records, newest first
+     */
+    status<ThrowOnError extends boolean = false>(options: Options<KycStatusData, ThrowOnError>): RequestResult<KycStatusResponses, unknown, ThrowOnError>;
+    /**
+     * Any open re-verification request an admin has raised for the customer
+     *
+     * The items to re-provide plus the message, or null when there is nothing to re-verify.
+     */
+    reverification<ThrowOnError extends boolean = false>(options: Options<KycReverificationData, ThrowOnError>): RequestResult<KycReverificationResponses, unknown, ThrowOnError>;
+    /**
+     * Submit Tier 1 (BVN + NIN)
+     */
+    tier1<ThrowOnError extends boolean = false>(options: Options<KycTier1Data, ThrowOnError>): RequestResult<KycTier1Responses, unknown, ThrowOnError>;
+    /**
+     * Submit Tier 2 (ID document, from a prior /kyc/documents upload)
+     */
+    tier2<ThrowOnError extends boolean = false>(options: Options<KycTier2Data, ThrowOnError>): RequestResult<KycTier2Responses, unknown, ThrowOnError>;
+    /**
+     * Submit Tier 3 (date of birth + address, for cross-border corridors)
+     */
+    tier3<ThrowOnError extends boolean = false>(options: Options<KycTier3Data, ThrowOnError>): RequestResult<KycTier3Responses, unknown, ThrowOnError>;
+    /**
+     * Check a customer's selfie before submitting it
+     *
+     * Returns what to change -- too dark, blurry, sunglasses, more than one face -- so it can be retaken now rather than rejected by a reviewer days later. Advisory only: a submission is never blocked on this.
+     */
+    selfieCheckRoute<ThrowOnError extends boolean = false>(options: Options<KycSelfieCheckRouteData, ThrowOnError>): RequestResult<KycSelfieCheckRouteResponses, unknown, ThrowOnError>;
+    /**
+     * Upload a customer's ID document or selfie ahead of Tier 2
+     */
+    document<ThrowOnError extends boolean = false>(options: Options<KycDocumentData, ThrowOnError>): RequestResult<KycDocumentResponses, unknown, ThrowOnError>;
+}
+export declare class Wallet extends HeyApiClient {
+    /**
+     * USDT + local fiat balance
+     */
+    balance<ThrowOnError extends boolean = false>(options: Options<WalletBalanceData, ThrowOnError>): RequestResult<WalletBalanceResponses, unknown, ThrowOnError>;
+    /**
+     * Live updates: re-emits the customer's balance on every credit/debit
+     *
+     * Mirrors Dutchman Bridge's own consumer /user/balance/stream, scoped to the customer instead of the caller's own JWT. Long-lived --keep the connection open rather than reconnecting per update.
+     */
+    streamBalance<ThrowOnError extends boolean = false>(options: Options<WalletStreamBalanceData, ThrowOnError>): RequestResult<WalletStreamBalanceResponses, unknown, ThrowOnError>;
+    /**
+     * Recent balance movements, cursor-paginated
+     */
+    transactions<ThrowOnError extends boolean = false>(options: Options<WalletTransactionsData, ThrowOnError>): RequestResult<WalletTransactionsResponses, unknown, ThrowOnError>;
+    /**
+     * The customer's per-network USDT deposit addresses
+     */
+    addresses<ThrowOnError extends boolean = false>(options: Options<WalletAddressesData, ThrowOnError>): RequestResult<WalletAddressesResponses, unknown, ThrowOnError>;
+    /**
+     * Local-currency virtual account for fiat funding
+     *
+     * Issued on first read in the customer's own fiat (NGN needs an approved BVN first); the same account is returned on every read after.
+     */
+    virtualAccountFor<ThrowOnError extends boolean = false>(options: Options<WalletVirtualAccountForData, ThrowOnError>): RequestResult<WalletVirtualAccountForResponses, unknown, ThrowOnError>;
+    /**
+     * Pay a held balance out to the customer's default bank account
+     */
+    withdraw<ThrowOnError extends boolean = false>(options: Options<WalletWithdrawData, ThrowOnError>): RequestResult<WalletWithdrawResponses, unknown, ThrowOnError>;
+    /**
+     * Start a fund-by-charge: a one-off bank account (bank_transfer) or a redirect URL to authorise (eft, ZAR)
+     */
+    initiateFundingCharge<ThrowOnError extends boolean = false>(options: Options<WalletInitiateFundingChargeData, ThrowOnError>): RequestResult<WalletInitiateFundingChargeResponses, unknown, ThrowOnError>;
+    /**
+     * The customer's funding charges, newest first
+     */
+    fundingCharges<ThrowOnError extends boolean = false>(options: Options<WalletFundingChargesData, ThrowOnError>): RequestResult<WalletFundingChargesResponses, unknown, ThrowOnError>;
+}
+export declare class Send extends HeyApiClient {
+    /**
+     * Networks the customer can send USDT/USDC on, with fee and minimum
+     */
+    networks<ThrowOnError extends boolean = false>(options: Options<SendNetworksData, ThrowOnError>): RequestResult<SendNetworksResponses, unknown, ThrowOnError>;
+    /**
+     * Quote a send before submitting it
+     */
+    quote<ThrowOnError extends boolean = false>(options: Options<SendQuoteData, ThrowOnError>): RequestResult<SendQuoteResponses, unknown, ThrowOnError>;
+    /**
+     * Send USDT on-chain to the given address
+     */
+    submit<ThrowOnError extends boolean = false>(options: Options<SendSubmitData, ThrowOnError>): RequestResult<SendSubmitResponses, unknown, ThrowOnError>;
+}
+export declare class GlobalSend extends HeyApiClient {
+    /**
+     * Re-check the customer's level 3 verification status with the partner
+     */
+    verificationStatus<ThrowOnError extends boolean = false>(options: Options<GlobalSendVerificationStatusData, ThrowOnError>): RequestResult<GlobalSendVerificationStatusResponses, unknown, ThrowOnError>;
+    /**
+     * Countries the customer can send to, with their currency and rails
+     */
+    corridors<ThrowOnError extends boolean = false>(options: Options<GlobalSendCorridorsData, ThrowOnError>): RequestResult<GlobalSendCorridorsResponses, unknown, ThrowOnError>;
+    /**
+     * Price a cross-border send for the customer
+     */
+    quote<ThrowOnError extends boolean = false>(options: Options<GlobalSendQuoteData, ThrowOnError>): RequestResult<GlobalSendQuoteResponses, unknown, ThrowOnError>;
+    /**
+     * Initiate a cross-border send for the customer
+     */
+    initiate<ThrowOnError extends boolean = false>(options: Options<GlobalSendInitiateData, ThrowOnError>): RequestResult<GlobalSendInitiateResponses, unknown, ThrowOnError>;
+}
+export declare class Ramp extends HeyApiClient {
+    /**
+     * Price a buy (fiat -> USDT) against the customer's fiat balance
+     */
+    buyQuote<ThrowOnError extends boolean = false>(options: Options<RampBuyQuoteData, ThrowOnError>): RequestResult<RampBuyQuoteResponses, unknown, ThrowOnError>;
+    /**
+     * Execute a buy from the customer's fiat balance
+     */
+    buy<ThrowOnError extends boolean = false>(options: Options<RampBuyData, ThrowOnError>): RequestResult<RampBuyResponses, unknown, ThrowOnError>;
+    /**
+     * Networks the customer can sell USDT on
+     */
+    sellNetworks<ThrowOnError extends boolean = false>(options: Options<RampSellNetworksData, ThrowOnError>): RequestResult<RampSellNetworksResponses, unknown, ThrowOnError>;
+    /**
+     * Live USDT rates in the customer's local fiat, for previewing a conversion
+     *
+     * Does not lock a rate -- checkout still goes through the quote routes.
+     */
+    rate<ThrowOnError extends boolean = false>(options: Options<RampRateData, ThrowOnError>): RequestResult<RampRateResponses, unknown, ThrowOnError>;
+    /**
+     * Price a sell (USDT -> fiat) against the customer's USDT balance
+     */
+    sellQuote<ThrowOnError extends boolean = false>(options: Options<RampSellQuoteData, ThrowOnError>): RequestResult<RampSellQuoteResponses, unknown, ThrowOnError>;
+    /**
+     * Execute a sell from the customer's USDT balance
+     */
+    sell<ThrowOnError extends boolean = false>(options: Options<RampSellData, ThrowOnError>): RequestResult<RampSellResponses, unknown, ThrowOnError>;
+}
+export declare class Bank extends HeyApiClient {
+    /**
+     * Banks for the given (or the customer's own) country/currency
+     */
+    banks<ThrowOnError extends boolean = false>(options: Options<BankBanksData, ThrowOnError>): RequestResult<BankBanksResponses, unknown, ThrowOnError>;
+    /**
+     * Resolve an account number to its account name
+     */
+    verifyAccount<ThrowOnError extends boolean = false>(options: Options<BankVerifyAccountData, ThrowOnError>): RequestResult<BankVerifyAccountResponses, unknown, ThrowOnError>;
+    /**
+     * List the customer's linked payout accounts, default first
+     */
+    getAccounts<ThrowOnError extends boolean = false>(options: Options<BankGetAccountsData, ThrowOnError>): RequestResult<BankGetAccountsResponses, unknown, ThrowOnError>;
+    /**
+     * Link a payout bank account to the customer
+     */
+    addAccount<ThrowOnError extends boolean = false>(options: Options<BankAddAccountData, ThrowOnError>): RequestResult<BankAddAccountResponses, unknown, ThrowOnError>;
+    /**
+     * Make a linked account the customer's default payout destination
+     */
+    setDefaultAccount<ThrowOnError extends boolean = false>(options: Options<BankSetDefaultAccountData, ThrowOnError>): RequestResult<BankSetDefaultAccountResponses, unknown, ThrowOnError>;
+    /**
+     * Remove a customer's linked payout account
+     */
+    deleteAccount<ThrowOnError extends boolean = false>(options: Options<BankDeleteAccountData, ThrowOnError>): RequestResult<BankDeleteAccountResponses, unknown, ThrowOnError>;
+}
+export declare class Receiving extends HeyApiClient {
+    /**
+     * Foreign currencies the customer can be paid in
+     */
+    currencies<ThrowOnError extends boolean = false>(options: Options<ReceivingCurrenciesData, ThrowOnError>): RequestResult<ReceivingCurrenciesResponses, unknown, ThrowOnError>;
+    /**
+     * Every foreign-currency account the customer holds
+     */
+    list<ThrowOnError extends boolean = false>(options: Options<ReceivingListData, ThrowOnError>): RequestResult<ReceivingListResponses, unknown, ThrowOnError>;
+    /**
+     * Payments seen on the customer's receiving accounts, including ones still in flight
+     */
+    activity<ThrowOnError extends boolean = false>(options: Options<ReceivingActivityData, ThrowOnError>): RequestResult<ReceivingActivityResponses, unknown, ThrowOnError>;
+    /**
+     * Open (or return) the customer's account for one currency
+     *
+     * Idempotent per currency -- calling twice returns the same account rather than opening a second one.
+     */
+    open<ThrowOnError extends boolean = false>(options: Options<ReceivingOpenData, ThrowOnError>): RequestResult<ReceivingOpenResponses, unknown, ThrowOnError>;
+    /**
+     * Re-read one of the customer's accounts from the partner
+     *
+     * An account is often issued pending and activated shortly after, and nothing pushes a notification for that transition.
+     */
+    refresh<ThrowOnError extends boolean = false>(options: Options<ReceivingRefreshData, ThrowOnError>): RequestResult<ReceivingRefreshResponses, unknown, ThrowOnError>;
+}
+export declare class Countries extends HeyApiClient {
+    /**
+     * Countries currently enabled for onboarding
+     */
+    list<ThrowOnError extends boolean = false>(options?: Options<CountriesListData, ThrowOnError>): RequestResult<CountriesListResponses, unknown, ThrowOnError>;
+}
+export declare class Features extends HeyApiClient {
+    /**
+     * Every switchable capability and its current state
+     */
+    list<ThrowOnError extends boolean = false>(options?: Options<FeaturesListData, ThrowOnError>): RequestResult<FeaturesListResponses, unknown, ThrowOnError>;
+}
+export declare class Webhook extends HeyApiClient {
+    /**
+     * Your current webhook URL and whether a secret is set
+     */
+    config<ThrowOnError extends boolean = false>(options?: Options<WebhookConfigData, ThrowOnError>): RequestResult<WebhookConfigResponses, unknown, ThrowOnError>;
+    /**
+     * Set your webhook URL and receive a new signing secret
+     *
+     * Validates the URL, mints a fresh secret (the old one stops working), stores it encrypted, and immediately POSTs a signed `webhook.test` event to the URL. The secret is returned here and nowhere else.
+     */
+    setUrl<ThrowOnError extends boolean = false>(options: Options<WebhookSetUrlData, ThrowOnError>): RequestResult<WebhookSetUrlResponses, unknown, ThrowOnError>;
+    /**
+     * Rotate the signing secret
+     *
+     * The previous secret stops working immediately; queued deliveries are signed with the new one. A `webhook.test` ping is sent, as on PUT.
+     */
+    rotateSecret<ThrowOnError extends boolean = false>(options?: Options<WebhookRotateSecretData, ThrowOnError>): RequestResult<WebhookRotateSecretResponses, unknown, ThrowOnError>;
+    /**
+     * Your delivery log, newest first
+     */
+    deliveries<ThrowOnError extends boolean = false>(options?: Options<WebhookDeliveriesData, ThrowOnError>): RequestResult<WebhookDeliveriesResponses, unknown, ThrowOnError>;
+    /**
+     * One delivery, including the payload that was sent
+     */
+    delivery<ThrowOnError extends boolean = false>(options: Options<WebhookDeliveryData, ThrowOnError>): RequestResult<WebhookDeliveryResponses, unknown, ThrowOnError>;
+    /**
+     * Send a delivery again
+     *
+     * Queues it for immediate re-delivery with the SAME event id, so your handler can recognise it as a duplicate if the original did land.
+     */
+    replay<ThrowOnError extends boolean = false>(options: Options<WebhookReplayData, ThrowOnError>): RequestResult<WebhookReplayResponses, unknown, ThrowOnError>;
+}
+export declare class DutchmanBridge extends HeyApiClient {
+    static readonly __registry: HeyApiRegistry<DutchmanBridge>;
+    constructor(args?: {
+        client?: Client;
+        key?: string;
+    });
+    private _customers?;
+    get customers(): Customers;
+    private _profile?;
+    get profile(): Profile;
+    private _kyc?;
+    get kyc(): Kyc;
+    private _wallet?;
+    get wallet(): Wallet;
+    private _send?;
+    get send(): Send;
+    private _globalSend?;
+    get globalSend(): GlobalSend;
+    private _ramp?;
+    get ramp(): Ramp;
+    private _bank?;
+    get bank(): Bank;
+    private _receiving?;
+    get receiving(): Receiving;
+    private _countries?;
+    get countries(): Countries;
+    private _features?;
+    get features(): Features;
+    private _webhook?;
+    get webhook(): Webhook;
+}
+export {};