dutchman-bridge 1.1.0 → 1.2.0

package/dist/sdk.gen.d.ts

@@ -189,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>;
     /**
@@ -197,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 deposit USDT on
+     * Networks the customer can deposit stablecoins on
      */
     sellNetworks<ThrowOnError extends boolean = false>(options: Options<RampSellNetworksData, ThrowOnError>): RequestResult<RampSellNetworksResponses, unknown, ThrowOnError>;
     /**
-     * Live all-in 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
      *
-     * Rates include our spread and every fee, so amount * rate is what the customer pays or receives. Pass ?amount (USDT) to fold the fixed exchange fee into sellRate for that amount. 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

@@ -444,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({
@@ -472,7 +472,7 @@ class Ramp extends HeyApiClient {
         });
     }
     /**
-     * Networks the customer can deposit USDT on
+     * Networks the customer can deposit stablecoins on
      */
     sellNetworks(options) {
         return (options.client ?? this.client).get({
@@ -482,9 +482,9 @@ class Ramp extends HeyApiClient {
         });
     }
     /**
-     * Live all-in 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
      *
-     * Rates include our spread and every fee, so amount * rate is what the customer pays or receives. Pass ?amount (USDT) to fold the fixed exchange fee into sellRate for that amount. 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({
@@ -494,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({
@@ -508,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({

package/dist/types.gen.d.ts

@@ -636,7 +636,13 @@ export type PartnerRampQuoteDto = {
 };
 export type GetQuoteDto = {
     amount: number;
+    /**
+     * On a sell, the stablecoin being sold; on a buy, the fiat being spent. Any stablecoin the service credits can be ramped wherever the exchange quotes the pair.
+     */
     sourceCurrency: string;
+    /**
+     * On a sell, the fiat received; on a buy, the stablecoin bought. Must be the customer's own local fiat on the fiat side.
+     */
     destinationCurrency: string;
     type: 'sell' | 'buy';
     /**
@@ -652,8 +658,18 @@ export type GetQuoteDto = {
 };
 export type PartnerBuyResultDto = {
     reference: string;
+    asset: 'USDT' | 'USDC' | 'CNGN';
     fiatCurrency: string;
     fiatSpent: number;
+    /**
+     * Units of `asset` now on the balance.
+     */
+    assetCredited: number;
+    /**
+     * Same number as `assetCredited`, kept for clients written when USDT was the only rampable asset. Read `assetCredited` with `asset`.
+     *
+     * @deprecated
+     */
     usdtCredited: number;
 };
 export type CustomerSellDto = {
@@ -674,32 +690,52 @@ export type PartnerNetworkDto = {
     evm: boolean;
 };
 export type PartnerRateDto = {
+    /**
+     * The stablecoin these rates price — echoes the ?asset asked for.
+     */
+    asset: 'USDT' | 'USDC' | 'CNGN';
     fiatCurrency: string;
     /**
-     * Fiat paid per USDT when buying. All-in: spread applied, and buys carry no fees.
+     * Fiat paid per unit of `asset` when buying. All-in: spread applied, and buys carry no fees.
      */
     buyRate: number;
     /**
-     * Fiat received per USDT when selling. All-in: spread applied, plus the fixed exchange fee when ?amount was given, so amount * sellRate is exactly what the customer receives. The withdrawal fee is separate; see GET .../withdraw/quote.
+     * Fiat received per unit of `asset` when selling. All-in: spread applied, plus the fixed exchange fee when ?amount was given, so amount * sellRate is exactly what the customer receives. The withdrawal fee is separate; see GET .../withdraw/quote.
      */
     sellRate: number;
     /**
-     * USDT amount sellRate was priced for; null when ?amount was omitted, in which case the fixed exchange fee is not in sellRate.
+     * Amount of `asset` sellRate was priced for; null when ?amount was omitted, in which case the fixed exchange fee is not in sellRate.
      */
     amount: number | null;
     /**
-     * Fixed sell-side exchange fee, USDT. In sellRate only when ?amount was given.
+     * Fixed sell-side exchange fee, in units of `asset`. In sellRate only when ?amount was given.
+     */
+    exchangeFeeAsset: number;
+    /**
+     * Same number as `exchangeFeeAsset`. See PartnerBuyResultDto.
+     *
+     * @deprecated
      */
     exchangeFeeUsdt: number;
 };
 export type PartnerSellResultDto = {
     reference: string;
-    usdtSold: number;
+    asset: 'USDT' | 'USDC' | 'CNGN';
+    /**
+     * Units of `asset` sold.
+     */
+    assetSold: number;
     fiatCurrency: string;
     /**
      * Now on the customer's fiat balance; withdraw it with POST .../withdraw.
      */
     fiatCredited: number;
+    /**
+     * Same number as `assetSold`. See PartnerBuyResultDto.
+     *
+     * @deprecated
+     */
+    usdtSold: number;
 };
 export type PartnerBankDto = {
     code: string;
@@ -1533,9 +1569,13 @@ export type RampRateData = {
          */
         network?: 'ethereum' | 'polygon' | 'arbitrum' | 'base' | 'arc' | 'bsc' | 'optimism' | 'tron';
         /**
-         * USDT amount to price the sell rate for. When given, the fixed exchange fee is spread over it, so amount * sellRate is exactly what the customer receives. Omit for a per-unit rate that carries the spread only.
+         * Amount of `asset` to price the sell rate for. When given, the fixed exchange fee is spread over it, so amount * sellRate is exactly what the customer receives. Omit for a per-unit rate that carries the spread only.
          */
         amount?: number;
+        /**
+         * Stablecoin to price against the customer's local fiat. Defaults to RAMP_DEFAULT_ASSET when omitted, so older clients keep working. The response echoes the asset it priced.
+         */
+        asset?: 'USDT' | 'USDC' | 'CNGN';
     };
     url: '/api/v1/partner/v1/customers/{customerId}/rate';
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dutchman-bridge",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "TypeScript SDK for the Dutchman Bridge Partner API, generated from its OpenAPI specification.",
   "license": "UNLICENSED",
   "publishConfig": {

package/src/sdk.gen.ts

@@ -491,7 +491,7 @@ export class GlobalSend extends HeyApiClient {
 
 export 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
      */
     public buyQuote<ThrowOnError extends boolean = false>(options: Options<RampBuyQuoteData, ThrowOnError>): RequestResult<RampBuyQuoteResponses, unknown, ThrowOnError> {
         return (options.client ?? this.client).post<RampBuyQuoteResponses, unknown, ThrowOnError>({
@@ -521,7 +521,7 @@ export class Ramp extends HeyApiClient {
     }
     
     /**
-     * Networks the customer can deposit USDT on
+     * Networks the customer can deposit stablecoins on
      */
     public sellNetworks<ThrowOnError extends boolean = false>(options: Options<RampSellNetworksData, ThrowOnError>): RequestResult<RampSellNetworksResponses, unknown, ThrowOnError> {
         return (options.client ?? this.client).get<RampSellNetworksResponses, unknown, ThrowOnError>({
@@ -532,9 +532,9 @@ export class Ramp extends HeyApiClient {
     }
     
     /**
-     * Live all-in 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
      *
-     * Rates include our spread and every fee, so amount * rate is what the customer pays or receives. Pass ?amount (USDT) to fold the fixed exchange fee into sellRate for that amount. 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.
      */
     public rate<ThrowOnError extends boolean = false>(options: Options<RampRateData, ThrowOnError>): RequestResult<RampRateResponses, unknown, ThrowOnError> {
         return (options.client ?? this.client).get<RampRateResponses, unknown, ThrowOnError>({
@@ -545,7 +545,7 @@ export 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
      */
     public sellQuote<ThrowOnError extends boolean = false>(options: Options<RampSellQuoteData, ThrowOnError>): RequestResult<RampSellQuoteResponses, unknown, ThrowOnError> {
         return (options.client ?? this.client).post<RampSellQuoteResponses, unknown, ThrowOnError>({
@@ -560,7 +560,7 @@ export class Ramp extends HeyApiClient {
     }
     
     /**
-     * Execute a sell from the customer's USDT balance
+     * Execute a sell from the customer's stablecoin balance
      */
     public sell<ThrowOnError extends boolean = false>(options: Options<RampSellData, ThrowOnError>): RequestResult<RampSellResponses, unknown, ThrowOnError> {
         return (options.client ?? this.client).post<RampSellResponses, unknown, ThrowOnError>({

package/src/types.gen.ts

@@ -688,7 +688,13 @@ export type PartnerRampQuoteDto = {
 
 export type GetQuoteDto = {
     amount: number;
+    /**
+     * On a sell, the stablecoin being sold; on a buy, the fiat being spent. Any stablecoin the service credits can be ramped wherever the exchange quotes the pair.
+     */
     sourceCurrency: string;
+    /**
+     * On a sell, the fiat received; on a buy, the stablecoin bought. Must be the customer's own local fiat on the fiat side.
+     */
     destinationCurrency: string;
     type: 'sell' | 'buy';
     /**
@@ -705,8 +711,18 @@ export type GetQuoteDto = {
 
 export type PartnerBuyResultDto = {
     reference: string;
+    asset: 'USDT' | 'USDC' | 'CNGN';
     fiatCurrency: string;
     fiatSpent: number;
+    /**
+     * Units of `asset` now on the balance.
+     */
+    assetCredited: number;
+    /**
+     * Same number as `assetCredited`, kept for clients written when USDT was the only rampable asset. Read `assetCredited` with `asset`.
+     *
+     * @deprecated
+     */
     usdtCredited: number;
 };
 
@@ -730,33 +746,53 @@ export type PartnerNetworkDto = {
 };
 
 export type PartnerRateDto = {
+    /**
+     * The stablecoin these rates price — echoes the ?asset asked for.
+     */
+    asset: 'USDT' | 'USDC' | 'CNGN';
     fiatCurrency: string;
     /**
-     * Fiat paid per USDT when buying. All-in: spread applied, and buys carry no fees.
+     * Fiat paid per unit of `asset` when buying. All-in: spread applied, and buys carry no fees.
      */
     buyRate: number;
     /**
-     * Fiat received per USDT when selling. All-in: spread applied, plus the fixed exchange fee when ?amount was given, so amount * sellRate is exactly what the customer receives. The withdrawal fee is separate; see GET .../withdraw/quote.
+     * Fiat received per unit of `asset` when selling. All-in: spread applied, plus the fixed exchange fee when ?amount was given, so amount * sellRate is exactly what the customer receives. The withdrawal fee is separate; see GET .../withdraw/quote.
      */
     sellRate: number;
     /**
-     * USDT amount sellRate was priced for; null when ?amount was omitted, in which case the fixed exchange fee is not in sellRate.
+     * Amount of `asset` sellRate was priced for; null when ?amount was omitted, in which case the fixed exchange fee is not in sellRate.
      */
     amount: number | null;
     /**
-     * Fixed sell-side exchange fee, USDT. In sellRate only when ?amount was given.
+     * Fixed sell-side exchange fee, in units of `asset`. In sellRate only when ?amount was given.
+     */
+    exchangeFeeAsset: number;
+    /**
+     * Same number as `exchangeFeeAsset`. See PartnerBuyResultDto.
+     *
+     * @deprecated
      */
     exchangeFeeUsdt: number;
 };
 
 export type PartnerSellResultDto = {
     reference: string;
-    usdtSold: number;
+    asset: 'USDT' | 'USDC' | 'CNGN';
+    /**
+     * Units of `asset` sold.
+     */
+    assetSold: number;
     fiatCurrency: string;
     /**
      * Now on the customer's fiat balance; withdraw it with POST .../withdraw.
      */
     fiatCredited: number;
+    /**
+     * Same number as `assetSold`. See PartnerBuyResultDto.
+     *
+     * @deprecated
+     */
+    usdtSold: number;
 };
 
 export type PartnerBankDto = {
@@ -1702,9 +1738,13 @@ export type RampRateData = {
          */
         network?: 'ethereum' | 'polygon' | 'arbitrum' | 'base' | 'arc' | 'bsc' | 'optimism' | 'tron';
         /**
-         * USDT amount to price the sell rate for. When given, the fixed exchange fee is spread over it, so amount * sellRate is exactly what the customer receives. Omit for a per-unit rate that carries the spread only.
+         * Amount of `asset` to price the sell rate for. When given, the fixed exchange fee is spread over it, so amount * sellRate is exactly what the customer receives. Omit for a per-unit rate that carries the spread only.
          */
         amount?: number;
+        /**
+         * Stablecoin to price against the customer's local fiat. Defaults to RAMP_DEFAULT_ASSET when omitted, so older clients keep working. The response echoes the asset it priced.
+         */
+        asset?: 'USDT' | 'USDC' | 'CNGN';
     };
     url: '/api/v1/partner/v1/customers/{customerId}/rate';
 };