dutchman-bridge 1.0.0 → 1.2.0

package/README.md

@@ -11,20 +11,14 @@ and response is typed, and it is regenerated whenever the API changes.
 
 ## Install
 
-The package is distributed from a private GitHub repository you have been given read
-access to. Pin a tag in your `package.json`:
-
-```json
-{
-  "dependencies": {
-    "dutchman-bridge": "github:Dutchman-io/dutchman-bridge-sdk#v1.0.0"
-  }
-}
+```bash
+npm install dutchman-bridge
 ```
 
-or `npm install github:Dutchman-io/dutchman-bridge-sdk#v1.0.0`. npm needs credentials
-that can read the repository — an SSH key or a `GITHUB_TOKEN`/git credential helper on
-the machine running the install (including CI).
+Published on the public npm registry. To pin the exact generated source instead, a
+git dependency on a release tag also works:
+`"dutchman-bridge": "github:Dutchman-io/dutchman-bridge-sdk#v1.0.0"` (needs read
+access to the repository).
 
 ## Configure
 
@@ -144,6 +138,32 @@ do {
 } while (cursor);
 ```
 
+## Retrying safely
+
+Every call that moves money takes an optional `reference` — your own request id.
+Send the same value again and you get the original record back; nothing moves
+twice.
+
+```ts
+await bridge.wallet.withdraw({
+  path: { customerId },
+  body: { amount: 50000, reference: 'req_01HZY4K8N2' },
+});
+```
+
+It is accepted by `wallet.withdraw`, `send.submit`, `wallet.initiateFundingCharge`
+and `globalSend.initiate`. Letters, digits, dot, underscore and hyphen; 120
+characters max. It is scoped per endpoint, so the same value on a withdrawal and
+on a send are two different records — choose one per intended operation (a
+request id, not a customer id).
+
+**A timeout is not a failure.** If a call times out or answers 5xx, retry it with
+the same `reference` rather than assuming nothing happened — that is the only way
+to find out which. Without one, a retry is a second withdrawal.
+
+Buy and sell are covered by their quote instead: a `quoteId` executes exactly
+once, including when two requests arrive together.
+
 ## Errors
 
 On a non-2xx status `error` is the parsed JSON body and `data` is `undefined`. The API

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 export { client, type CreateClientConfig } from './client.gen';
 export { Bank, Countries, Customers, DutchmanBridge, Features, GlobalSend, Kyc, type Options, Profile, Ramp, Receiving, Send, Wallet, Webhook } from './sdk.gen';
-export type { AddAccountDto, BankAddAccountData, BankAddAccountResponse, BankAddAccountResponses, BankBanksData, BankBanksResponse, BankBanksResponses, BankDeleteAccountData, BankDeleteAccountResponse, BankDeleteAccountResponses, BankGetAccountsData, BankGetAccountsResponse, BankGetAccountsResponses, BankSetDefaultAccountData, BankSetDefaultAccountResponse, BankSetDefaultAccountResponses, BankVerifyAccountData, BankVerifyAccountResponse, BankVerifyAccountResponses, BlockchainNetwork, CheckSelfieDto, ClientOptions, CountriesListData, CountriesListResponse, CountriesListResponses, CustomerSellDto, CustomersFullData, CustomersFullResponse, CustomersFullResponses, CustomersGetData, CustomersGetResponse, CustomersGetResponses, CustomersRegisterData, CustomersRegisterResponse, CustomersRegisterResponses, FeaturesListData, FeaturesListResponse, FeaturesListResponses, FeatureStatus, FundingChargeStatus, GetQuoteDto, GlobalSendBeneficiaryDto, GlobalSendCorridorsData, GlobalSendCorridorsResponse, GlobalSendCorridorsResponses, GlobalSendInitiateData, GlobalSendInitiateResponse, GlobalSendInitiateResponses, GlobalSendQuoteData, GlobalSendQuoteDto, GlobalSendQuoteResponse, GlobalSendQuoteResponses, GlobalSendVerificationStatusData, GlobalSendVerificationStatusResponse, GlobalSendVerificationStatusResponses, InitiateFundingChargeDto, InitiateGlobalSendDto, KycDocumentData, KycDocumentResponse, KycDocumentResponses, KycReverificationData, KycReverificationResponse, KycReverificationResponses, KycSelfieCheckRouteData, KycSelfieCheckRouteResponse, KycSelfieCheckRouteResponses, KycStatus, KycStatusData, KycStatusResponse, KycStatusResponses, KycTier1Data, KycTier1Response, KycTier1Responses, KycTier2Data, KycTier2Response, KycTier2Responses, KycTier3Data, KycTier3Response, KycTier3Responses, LedgerEntryType, PartnerAccountVerificationDto, PartnerBalanceDto, PartnerBankAccountDto, PartnerBankDto, PartnerBuyResultDto, PartnerCorridorDto, PartnerCountryDto, PartnerCustomerDto, PartnerCustomerKycSnapshotDto, PartnerCustomerSnapshotDto, PartnerCustomerWalletSnapshotDto, PartnerDepositAddressDto, PartnerFeatureDto, PartnerFundingChargeDto, PartnerGlobalSendQuoteDto, PartnerGlobalSendResultDto, PartnerKycRecordDto, PartnerKycSubmissionDto, PartnerLedgerEntryDto, PartnerNetworkDto, PartnerRampQuoteDto, PartnerRateDto, PartnerReceivingAccountDto, PartnerReceivingActivityDto, PartnerReverificationRequestDto, PartnerSelfieCheckDto, PartnerSellResultDto, PartnerSendNetworkDto, PartnerSendQuoteDto, PartnerSendResultDto, PartnerSettlementModeDto, PartnerUploadedDocumentDto, PartnerVerificationRecordDto, PartnerVirtualAccountDto, PartnerWebhookConfigDto, PartnerWebhookDeliveryDetailDto, PartnerWebhookDeliveryDto, PartnerWebhookSecretDto, PartnerWebhookTestDto, PartnerWithdrawalBankAccountDto, PartnerWithdrawalDto, ProfileChangePasswordData, ProfileChangePasswordResponse, ProfileChangePasswordResponses, ProfileDeleteAccountData, ProfileDeleteAccountResponse, ProfileDeleteAccountResponses, ProfileGetSettlementModeData, ProfileGetSettlementModeResponse, ProfileGetSettlementModeResponses, ProfileProfileData, ProfileProfileResponse, ProfileProfileResponses, ProfileSetSettlementModeData, ProfileSetSettlementModeResponse, ProfileSetSettlementModeResponses, ProfileUpdateProfileData, ProfileUpdateProfileResponse, ProfileUpdateProfileResponses, ProfileWithdrawalsData, ProfileWithdrawalsResponse, ProfileWithdrawalsResponses, QuoteSendDto, RampBuyData, RampBuyQuoteData, RampBuyQuoteResponse, RampBuyQuoteResponses, RampBuyResponse, RampBuyResponses, RampRateData, RampRateResponse, RampRateResponses, RampSellData, RampSellNetworksData, RampSellNetworksResponse, RampSellNetworksResponses, RampSellQuoteData, RampSellQuoteResponse, RampSellQuoteResponses, RampSellResponse, RampSellResponses, ReceivingActivityData, ReceivingActivityResponse, ReceivingActivityResponses, ReceivingCurrenciesData, ReceivingCurrenciesResponse, ReceivingCurrenciesResponses, ReceivingListData, ReceivingListResponse, ReceivingListResponses, ReceivingOpenData, ReceivingOpenResponse, ReceivingOpenResponses, ReceivingRefreshData, ReceivingRefreshResponse, ReceivingRefreshResponses, RegisterCustomerDto, ResetPassword, ReverificationItem, ReverificationStatus, SendDto, SendNetworksData, SendNetworksResponse, SendNetworksResponses, SendQuoteData, SendQuoteResponse, SendQuoteResponses, SendSubmitData, SendSubmitResponse, SendSubmitResponses, SettlementMode, SettlementModeDto, SetWebhookUrlDto, SubmitTier3Dto, Tier1KycDto, Tier2KycDto, UpdateCustomerProfileDto, VerifyAccountNumberInput, WalletAddressesData, WalletAddressesResponse, WalletAddressesResponses, WalletBalanceData, WalletBalanceResponse, WalletBalanceResponses, WalletFundingChargesData, WalletFundingChargesResponse, WalletFundingChargesResponses, WalletInitiateFundingChargeData, WalletInitiateFundingChargeResponse, WalletInitiateFundingChargeResponses, WalletStreamBalanceData, WalletStreamBalanceResponses, WalletTransactionsData, WalletTransactionsResponse, WalletTransactionsResponses, WalletVirtualAccountForData, WalletVirtualAccountForResponse, WalletVirtualAccountForResponses, WalletWithdrawData, WalletWithdrawResponse, WalletWithdrawResponses, WebhookConfigData, WebhookConfigResponse, WebhookConfigResponses, WebhookDeliveriesData, WebhookDeliveriesResponse, WebhookDeliveriesResponses, WebhookDeliveryData, WebhookDeliveryResponse, WebhookDeliveryResponses, WebhookDeliveryStatus, WebhookReplayData, WebhookReplayResponse, WebhookReplayResponses, WebhookRotateSecretData, WebhookRotateSecretResponse, WebhookRotateSecretResponses, WebhookSetUrlData, WebhookSetUrlResponse, WebhookSetUrlResponses, WithdrawalStatus, WithdrawDto } from './types.gen';
+export type { AddAccountDto, BankAddAccountData, BankAddAccountResponse, BankAddAccountResponses, BankBanksData, BankBanksResponse, BankBanksResponses, BankDeleteAccountData, BankDeleteAccountResponse, BankDeleteAccountResponses, BankGetAccountsData, BankGetAccountsResponse, BankGetAccountsResponses, BankSetDefaultAccountData, BankSetDefaultAccountResponse, BankSetDefaultAccountResponses, BankVerifyAccountData, BankVerifyAccountResponse, BankVerifyAccountResponses, BlockchainNetwork, CheckSelfieDto, ClientOptions, CountriesListData, CountriesListResponse, CountriesListResponses, CustomerSellDto, CustomersFullData, CustomersFullResponse, CustomersFullResponses, CustomersGetData, CustomersGetResponse, CustomersGetResponses, CustomersRegisterData, CustomersRegisterResponse, CustomersRegisterResponses, FeaturesListData, FeaturesListResponse, FeaturesListResponses, FeatureStatus, FundingChargeStatus, GetQuoteDto, GlobalSendBeneficiaryDto, GlobalSendCorridorsData, GlobalSendCorridorsResponse, GlobalSendCorridorsResponses, GlobalSendInitiateData, GlobalSendInitiateResponse, GlobalSendInitiateResponses, GlobalSendQuoteData, GlobalSendQuoteDto, GlobalSendQuoteResponse, GlobalSendQuoteResponses, GlobalSendVerificationStatusData, GlobalSendVerificationStatusResponse, GlobalSendVerificationStatusResponses, InitiateFundingChargeDto, InitiateGlobalSendDto, KycDocumentData, KycDocumentResponse, KycDocumentResponses, KycReverificationData, KycReverificationResponse, KycReverificationResponses, KycSelfieCheckRouteData, KycSelfieCheckRouteResponse, KycSelfieCheckRouteResponses, KycStatus, KycStatusData, KycStatusResponse, KycStatusResponses, KycSummaryData, KycSummaryResponse, KycSummaryResponses, KycTier1Data, KycTier1Response, KycTier1Responses, KycTier2Data, KycTier2Response, KycTier2Responses, KycTier3Data, KycTier3Response, KycTier3Responses, LedgerEntryType, PartnerAccountVerificationDto, PartnerBalanceDto, PartnerBankAccountDto, PartnerBankDto, PartnerBuyResultDto, PartnerCorridorDto, PartnerCountryDto, PartnerCustomerDto, PartnerCustomerKycSnapshotDto, PartnerCustomerSnapshotDto, PartnerCustomerWalletSnapshotDto, PartnerDepositAddressDto, PartnerFeatureDto, PartnerFundingChargeDto, PartnerGlobalSendQuoteDto, PartnerGlobalSendResultDto, PartnerKycRecordDto, PartnerKycSubmissionDto, PartnerLedgerEntryDto, PartnerNetworkDto, PartnerRampQuoteDto, PartnerRateDto, PartnerReceivingAccountDto, PartnerReceivingActivityDto, PartnerReverificationRequestDto, PartnerSelfieCheckDto, PartnerSellResultDto, PartnerSendNetworkDto, PartnerSendQuoteDto, PartnerSendResultDto, PartnerTierStateDto, PartnerTierStatus, PartnerUploadedDocumentDto, PartnerVerificationInput, PartnerVerificationRecordDto, PartnerVerificationSummaryDto, PartnerVerificationTiersDto, PartnerVirtualAccountDto, PartnerWebhookConfigDto, PartnerWebhookDeliveryDetailDto, PartnerWebhookDeliveryDto, PartnerWebhookSecretDto, PartnerWebhookTestDto, PartnerWithdrawalBankAccountDto, PartnerWithdrawalDto, PartnerWithdrawalQuoteDto, ProfileChangePasswordData, ProfileChangePasswordResponse, ProfileChangePasswordResponses, ProfileDeleteAccountData, ProfileDeleteAccountResponse, ProfileDeleteAccountResponses, ProfileProfileData, ProfileProfileResponse, ProfileProfileResponses, ProfileUpdateProfileData, ProfileUpdateProfileResponse, ProfileUpdateProfileResponses, ProfileWithdrawalsData, ProfileWithdrawalsResponse, ProfileWithdrawalsResponses, QuoteSendDto, RampBuyData, RampBuyQuoteData, RampBuyQuoteResponse, RampBuyQuoteResponses, RampBuyResponse, RampBuyResponses, RampRateData, RampRateResponse, RampRateResponses, RampSellData, RampSellNetworksData, RampSellNetworksResponse, RampSellNetworksResponses, RampSellQuoteData, RampSellQuoteResponse, RampSellQuoteResponses, RampSellResponse, RampSellResponses, ReceivingActivityData, ReceivingActivityResponse, ReceivingActivityResponses, ReceivingCurrenciesData, ReceivingCurrenciesResponse, ReceivingCurrenciesResponses, ReceivingListData, ReceivingListResponse, ReceivingListResponses, ReceivingOpenData, ReceivingOpenResponse, ReceivingOpenResponses, ReceivingRefreshData, ReceivingRefreshResponse, ReceivingRefreshResponses, RegisterCustomerDto, ResetPassword, ReverificationItem, ReverificationStatus, SendDto, SendNetworksData, SendNetworksResponse, SendNetworksResponses, SendQuoteData, SendQuoteResponse, SendQuoteResponses, SendSubmitData, SendSubmitResponse, SendSubmitResponses, SetWebhookUrlDto, SubmitTier3Dto, Tier1KycDto, Tier2KycDto, UpdateCustomerProfileDto, VerifyAccountNumberInput, WalletAddressesData, WalletAddressesResponse, WalletAddressesResponses, WalletBalanceData, WalletBalanceResponse, WalletBalanceResponses, WalletFundingChargesData, WalletFundingChargesResponse, WalletFundingChargesResponses, WalletInitiateFundingChargeData, WalletInitiateFundingChargeResponse, WalletInitiateFundingChargeResponses, WalletStreamBalanceData, WalletStreamBalanceResponses, WalletTransactionsData, WalletTransactionsResponse, WalletTransactionsResponses, WalletVirtualAccountForData, WalletVirtualAccountForResponse, WalletVirtualAccountForResponses, WalletWithdrawalQuoteData, WalletWithdrawalQuoteResponse, WalletWithdrawalQuoteResponses, WalletWithdrawData, WalletWithdrawResponse, WalletWithdrawResponses, WebhookConfigData, WebhookConfigResponse, WebhookConfigResponses, WebhookDeliveriesData, WebhookDeliveriesResponse, WebhookDeliveriesResponses, WebhookDeliveryData, WebhookDeliveryResponse, WebhookDeliveryResponses, WebhookDeliveryStatus, WebhookReplayData, WebhookReplayResponse, WebhookReplayResponses, WebhookRotateSecretData, WebhookRotateSecretResponse, WebhookRotateSecretResponses, WebhookSetUrlData, WebhookSetUrlResponse, WebhookSetUrlResponses, WithdrawalStatus, WithdrawDto } from './types.gen';

package/dist/sdk.gen.d.ts

@@ -1,5 +1,5 @@
 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';
+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, KycSummaryData, KycSummaryResponses, KycTier1Data, KycTier1Responses, KycTier2Data, KycTier2Responses, KycTier3Data, KycTier3Responses, ProfileChangePasswordData, ProfileChangePasswordResponses, ProfileDeleteAccountData, ProfileDeleteAccountResponses, ProfileProfileData, ProfileProfileResponses, 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, WalletWithdrawalQuoteData, WalletWithdrawalQuoteResponses, 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
@@ -64,20 +64,18 @@ export declare class Profile extends HeyApiClient {
      * 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 {
+    /**
+     * Where the customer stands, and what to submit next
+     *
+     * The recommended single read: the highest approved tier, each tier's status, the inputs to submit next (with any open re-verification items first), the open re-verification request, and the KYC records. Replaces calling GET .../kyc and GET .../kyc/reverification separately.
+     */
+    summary<ThrowOnError extends boolean = false>(options: Options<KycSummaryData, ThrowOnError>): RequestResult<KycSummaryResponses, unknown, ThrowOnError>;
     /**
      * A customer's KYC records, newest first
      */
@@ -136,8 +134,16 @@ export declare class Wallet extends HeyApiClient {
      * 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>;
+    /**
+     * Price a withdrawal before submitting it
+     *
+     * The withdrawal fee (a percentage of the amount plus a fixed charge for the currency) is charged on top of the amount: the bank receives `amount`, the balance is debited `totalDebited`. Nothing is reserved.
+     */
+    withdrawalQuote<ThrowOnError extends boolean = false>(options: Options<WalletWithdrawalQuoteData, ThrowOnError>): RequestResult<WalletWithdrawalQuoteResponses, unknown, ThrowOnError>;
     /**
      * Pay a held balance out to the customer's default bank account
+     *
+     * The bank receives `amount`; the withdrawal fee is debited on top of it. Price it first with GET .../withdraw/quote.
      */
     withdraw<ThrowOnError extends boolean = false>(options: Options<WalletWithdrawData, ThrowOnError>): RequestResult<WalletWithdrawResponses, unknown, ThrowOnError>;
     /**
@@ -183,7 +189,7 @@ export declare class GlobalSend extends HeyApiClient {
 }
 export declare class Ramp extends HeyApiClient {
     /**
-     * Price a buy (fiat -> USDT) against the customer's fiat balance
+     * Price a buy (fiat -> stablecoin) against the customer's fiat balance
      */
     buyQuote<ThrowOnError extends boolean = false>(options: Options<RampBuyQuoteData, ThrowOnError>): RequestResult<RampBuyQuoteResponses, unknown, ThrowOnError>;
     /**
@@ -191,21 +197,21 @@ export declare class Ramp extends HeyApiClient {
      */
     buy<ThrowOnError extends boolean = false>(options: Options<RampBuyData, ThrowOnError>): RequestResult<RampBuyResponses, unknown, ThrowOnError>;
     /**
-     * Networks the customer can sell USDT on
+     * Networks the customer can deposit stablecoins 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
+     * Live all-in stablecoin rates in the customer's local fiat, for previewing a conversion
      *
-     * Does not lock a rate -- checkout still goes through the quote routes.
+     * Rates include our spread and every fee, so amount * rate is what the customer pays or receives. Pass ?asset to price a specific stablecoin (default RAMP_DEFAULT_ASSET) and ?amount to fold the fixed exchange fee into sellRate for that amount. 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
+     * Price a sell (stablecoin -> fiat) against the customer's balance
      */
     sellQuote<ThrowOnError extends boolean = false>(options: Options<RampSellQuoteData, ThrowOnError>): RequestResult<RampSellQuoteResponses, unknown, ThrowOnError>;
     /**
-     * Execute a sell from the customer's USDT balance
+     * Execute a sell from the customer's stablecoin balance
      */
     sell<ThrowOnError extends boolean = false>(options: Options<RampSellData, ThrowOnError>): RequestResult<RampSellResponses, unknown, ThrowOnError>;
 }

package/dist/sdk.gen.js

@@ -120,42 +120,30 @@ class Profile extends HeyApiClient {
         });
     }
     /**
-     * Read the customer's settlement preference (AUTO to default bank vs MANUAL hold)
+     * The customer's withdrawal / global payout history, newest first
      */
-    getSettlementMode(options) {
+    withdrawals(options) {
         return (options.client ?? this.client).get({
             security: [{ name: 'x-api-key', type: 'apiKey' }],
-            url: '/api/v1/partner/v1/customers/{customerId}/settlement-mode',
+            url: '/api/v1/partner/v1/customers/{customerId}/withdrawals',
             ...options
         });
     }
+}
+exports.Profile = Profile;
+class Kyc extends HeyApiClient {
     /**
-     * Update how the customer's sale proceeds settle
-     */
-    setSettlementMode(options) {
-        return (options.client ?? this.client).patch({
-            security: [{ name: 'x-api-key', type: 'apiKey' }],
-            url: '/api/v1/partner/v1/customers/{customerId}/settlement-mode',
-            ...options,
-            headers: {
-                'Content-Type': 'application/json',
-                ...options.headers
-            }
-        });
-    }
-    /**
-     * The customer's withdrawal / global payout history, newest first
+     * Where the customer stands, and what to submit next
+     *
+     * The recommended single read: the highest approved tier, each tier's status, the inputs to submit next (with any open re-verification items first), the open re-verification request, and the KYC records. Replaces calling GET .../kyc and GET .../kyc/reverification separately.
      */
-    withdrawals(options) {
+    summary(options) {
         return (options.client ?? this.client).get({
             security: [{ name: 'x-api-key', type: 'apiKey' }],
-            url: '/api/v1/partner/v1/customers/{customerId}/withdrawals',
+            url: '/api/v1/partner/v1/customers/{customerId}/verification',
             ...options
         });
     }
-}
-exports.Profile = Profile;
-class Kyc extends HeyApiClient {
     /**
      * A customer's KYC records, newest first
      */
@@ -308,8 +296,22 @@ class Wallet extends HeyApiClient {
             ...options
         });
     }
+    /**
+     * Price a withdrawal before submitting it
+     *
+     * The withdrawal fee (a percentage of the amount plus a fixed charge for the currency) is charged on top of the amount: the bank receives `amount`, the balance is debited `totalDebited`. Nothing is reserved.
+     */
+    withdrawalQuote(options) {
+        return (options.client ?? this.client).get({
+            security: [{ name: 'x-api-key', type: 'apiKey' }],
+            url: '/api/v1/partner/v1/customers/{customerId}/withdraw/quote',
+            ...options
+        });
+    }
     /**
      * Pay a held balance out to the customer's default bank account
+     *
+     * The bank receives `amount`; the withdrawal fee is debited on top of it. Price it first with GET .../withdraw/quote.
      */
     withdraw(options) {
         return (options.client ?? this.client).post({
@@ -442,7 +444,7 @@ class GlobalSend extends HeyApiClient {
 exports.GlobalSend = GlobalSend;
 class Ramp extends HeyApiClient {
     /**
-     * Price a buy (fiat -> USDT) against the customer's fiat balance
+     * Price a buy (fiat -> stablecoin) against the customer's fiat balance
      */
     buyQuote(options) {
         return (options.client ?? this.client).post({
@@ -470,7 +472,7 @@ class Ramp extends HeyApiClient {
         });
     }
     /**
-     * Networks the customer can sell USDT on
+     * Networks the customer can deposit stablecoins on
      */
     sellNetworks(options) {
         return (options.client ?? this.client).get({
@@ -480,9 +482,9 @@ class Ramp extends HeyApiClient {
         });
     }
     /**
-     * Live USDT rates in the customer's local fiat, for previewing a conversion
+     * Live all-in stablecoin rates in the customer's local fiat, for previewing a conversion
      *
-     * Does not lock a rate -- checkout still goes through the quote routes.
+     * Rates include our spread and every fee, so amount * rate is what the customer pays or receives. Pass ?asset to price a specific stablecoin (default RAMP_DEFAULT_ASSET) and ?amount to fold the fixed exchange fee into sellRate for that amount. Does not lock a rate -- checkout still goes through the quote routes.
      */
     rate(options) {
         return (options.client ?? this.client).get({
@@ -492,7 +494,7 @@ class Ramp extends HeyApiClient {
         });
     }
     /**
-     * Price a sell (USDT -> fiat) against the customer's USDT balance
+     * Price a sell (stablecoin -> fiat) against the customer's balance
      */
     sellQuote(options) {
         return (options.client ?? this.client).post({
@@ -506,7 +508,7 @@ class Ramp extends HeyApiClient {
         });
     }
     /**
-     * Execute a sell from the customer's USDT balance
+     * Execute a sell from the customer's stablecoin balance
      */
     sell(options) {
         return (options.client ?? this.client).post({