@augustusbank/typescript-sdk 0.12.1 → 0.14.0

package/src/resources/conversions.ts

@@ -81,7 +81,7 @@ export interface ConversionCreateResponse {
   /**
    * Source currency code.
    */
-  source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+  source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
   /**
    * Current status of the conversion.
@@ -96,7 +96,7 @@ export interface ConversionCreateResponse {
   /**
    * Target currency code.
    */
-  target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+  target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
   /**
    * Resource type discriminator.
@@ -165,7 +165,7 @@ export interface ConversionRetrieveResponse {
   /**
    * Source currency code.
    */
-  source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+  source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
   /**
    * Current status of the conversion.
@@ -180,7 +180,7 @@ export interface ConversionRetrieveResponse {
   /**
    * Target currency code.
    */
-  target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+  target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
   /**
    * Resource type discriminator.
@@ -249,7 +249,7 @@ export interface ConversionListResponse {
   /**
    * Source currency code.
    */
-  source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+  source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
   /**
    * Current status of the conversion.
@@ -264,7 +264,7 @@ export interface ConversionListResponse {
   /**
    * Target currency code.
    */
-  target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+  target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
   /**
    * Resource type discriminator.
@@ -315,7 +315,7 @@ export interface ConversionListParams extends CursorPageParams {
   /**
    * Filter by source currency code.
    */
-  source_currency?: 'EUR' | 'GBP' | 'USD' | 'USDC';
+  source_currency?: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
   /**
    * Filter by conversion status.
@@ -325,7 +325,7 @@ export interface ConversionListParams extends CursorPageParams {
   /**
    * Filter by target currency code.
    */
-  target_currency?: 'EUR' | 'GBP' | 'USD' | 'USDC';
+  target_currency?: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 }
 
 export declare namespace Conversions {

package/src/resources/deposits.ts

@@ -51,7 +51,7 @@ export interface DepositRetrieveResponse {
   /**
    * Supported fiat or crypto currency code for the deposit amount.
    */
-  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
   /**
    * ID of the merchant account that received the deposit.
@@ -73,6 +73,10 @@ export interface DepositRetrieveResponse {
     | 'swift'
     | 'internal'
     | 'target'
+    | 'ach'
+    | 'fedwire'
+    | 'btc'
+    | 'btc_testnet4'
     | 'eth'
     | 'eth_sepolia'
     | 'sol'
@@ -92,7 +96,8 @@ export interface DepositRetrieveResponse {
   source:
     | DepositRetrieveResponse.UnionMember0
     | DepositRetrieveResponse.UnionMember1
-    | DepositRetrieveResponse.UnionMember2;
+    | DepositRetrieveResponse.UnionMember2
+    | DepositRetrieveResponse.UnionMember3;
 
   /**
    * Current status of the deposit.
@@ -161,6 +166,28 @@ export namespace DepositRetrieveResponse {
   }
 
   export interface UnionMember2 {
+    /**
+     * Name of the account holder.
+     */
+    account_holder_name: string;
+
+    /**
+     * Bank account number.
+     */
+    account_number: string;
+
+    /**
+     * ABA routing number (9 digits).
+     */
+    routing_number: string;
+
+    /**
+     * Discriminator for ABA wire source.
+     */
+    type: 'aba';
+  }
+
+  export interface UnionMember3 {
     /**
      * Wallet address on the specified blockchain.
      */
@@ -169,7 +196,15 @@ export namespace DepositRetrieveResponse {
     /**
      * Blockchain network for the crypto wallet.
      */
-    blockchain: 'ethereum' | 'solana' | 'polygon';
+    blockchain:
+      | 'bitcoin'
+      | 'ethereum'
+      | 'solana'
+      | 'polygon'
+      | 'bitcoin_testnet4'
+      | 'ethereum_sepolia'
+      | 'solana_devnet'
+      | 'polygon_amoy';
 
     /**
      * Discriminator for crypto wallet source.
@@ -202,7 +237,7 @@ export interface DepositListResponse {
   /**
    * Supported fiat or crypto currency code for the deposit amount.
    */
-  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
   /**
    * ID of the merchant account that received the deposit.
@@ -224,6 +259,10 @@ export interface DepositListResponse {
     | 'swift'
     | 'internal'
     | 'target'
+    | 'ach'
+    | 'fedwire'
+    | 'btc'
+    | 'btc_testnet4'
     | 'eth'
     | 'eth_sepolia'
     | 'sol'
@@ -243,7 +282,8 @@ export interface DepositListResponse {
   source:
     | DepositListResponse.UnionMember0
     | DepositListResponse.UnionMember1
-    | DepositListResponse.UnionMember2;
+    | DepositListResponse.UnionMember2
+    | DepositListResponse.UnionMember3;
 
   /**
    * Current status of the deposit.
@@ -312,6 +352,28 @@ export namespace DepositListResponse {
   }
 
   export interface UnionMember2 {
+    /**
+     * Name of the account holder.
+     */
+    account_holder_name: string;
+
+    /**
+     * Bank account number.
+     */
+    account_number: string;
+
+    /**
+     * ABA routing number (9 digits).
+     */
+    routing_number: string;
+
+    /**
+     * Discriminator for ABA wire source.
+     */
+    type: 'aba';
+  }
+
+  export interface UnionMember3 {
     /**
      * Wallet address on the specified blockchain.
      */
@@ -320,7 +382,15 @@ export namespace DepositListResponse {
     /**
      * Blockchain network for the crypto wallet.
      */
-    blockchain: 'ethereum' | 'solana' | 'polygon';
+    blockchain:
+      | 'bitcoin'
+      | 'ethereum'
+      | 'solana'
+      | 'polygon'
+      | 'bitcoin_testnet4'
+      | 'ethereum_sepolia'
+      | 'solana_devnet'
+      | 'polygon_amoy';
 
     /**
      * Discriminator for crypto wallet source.

package/src/resources/index.ts

@@ -57,7 +57,15 @@ export {
   type PayoutListResponsesCursorPage,
 } from './payouts';
 export { Quotes, type QuoteRetrieveResponse } from './quotes/quotes';
-export { Returns, type ReturnRetrieveResponse } from './returns';
+export {
+  Returns,
+  type ReturnCreateResponse,
+  type ReturnRetrieveResponse,
+  type ReturnListResponse,
+  type ReturnCreateParams,
+  type ReturnListParams,
+  type ReturnListResponsesCursorPage,
+} from './returns';
 export { Scopes, type ScopeListResponse } from './scopes';
 export {
   WebhookDeliveries,

package/src/resources/payouts.ts

@@ -53,7 +53,7 @@ export interface PayoutCreateResponse {
   /**
    * Currency code (ISO 4217 currency code or crypto currency code).
    */
-  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
   /**
    * Bank account or crypto wallet the payout was sent to.
@@ -176,7 +176,15 @@ export namespace PayoutCreateResponse {
     /**
      * Blockchain network for the crypto wallet.
      */
-    blockchain: 'ethereum' | 'solana' | 'polygon';
+    blockchain:
+      | 'bitcoin'
+      | 'ethereum'
+      | 'solana'
+      | 'polygon'
+      | 'bitcoin_testnet4'
+      | 'ethereum_sepolia'
+      | 'solana_devnet'
+      | 'polygon_amoy';
 
     /**
      * Discriminator for crypto wallet financial address.
@@ -238,7 +246,7 @@ export interface PayoutRetrieveResponse {
   /**
    * Currency code (ISO 4217 currency code or crypto currency code).
    */
-  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
   /**
    * Bank account or crypto wallet the payout was sent to.
@@ -361,7 +369,15 @@ export namespace PayoutRetrieveResponse {
     /**
      * Blockchain network for the crypto wallet.
      */
-    blockchain: 'ethereum' | 'solana' | 'polygon';
+    blockchain:
+      | 'bitcoin'
+      | 'ethereum'
+      | 'solana'
+      | 'polygon'
+      | 'bitcoin_testnet4'
+      | 'ethereum_sepolia'
+      | 'solana_devnet'
+      | 'polygon_amoy';
 
     /**
      * Discriminator for crypto wallet financial address.
@@ -423,7 +439,7 @@ export interface PayoutListResponse {
   /**
    * Currency code (ISO 4217 currency code or crypto currency code).
    */
-  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
   /**
    * Bank account or crypto wallet the payout was sent to.
@@ -546,7 +562,15 @@ export namespace PayoutListResponse {
     /**
      * Blockchain network for the crypto wallet.
      */
-    blockchain: 'ethereum' | 'solana' | 'polygon';
+    blockchain:
+      | 'bitcoin'
+      | 'ethereum'
+      | 'solana'
+      | 'polygon'
+      | 'bitcoin_testnet4'
+      | 'ethereum_sepolia'
+      | 'solana_devnet'
+      | 'polygon_amoy';
 
     /**
      * Discriminator for crypto wallet financial address.
@@ -598,7 +622,7 @@ export interface PayoutCreateParams {
   /**
    * Currency for the payout.
    */
-  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
   /**
    * Bank account or crypto wallet to send funds to.
@@ -606,7 +630,8 @@ export interface PayoutCreateParams {
   destination:
     | PayoutCreateParams.UnionMember0
     | PayoutCreateParams.UnionMember1
-    | PayoutCreateParams.UnionMember2;
+    | PayoutCreateParams.UnionMember2
+    | PayoutCreateParams.UnionMember3;
 
   /**
    * Payment reference.
@@ -675,6 +700,28 @@ export namespace PayoutCreateParams {
   }
 
   export interface UnionMember2 {
+    /**
+     * Name of the account holder.
+     */
+    account_holder_name: string;
+
+    /**
+     * Bank account number.
+     */
+    account_number: string;
+
+    /**
+     * ABA routing number (9 digits).
+     */
+    routing_number: string;
+
+    /**
+     * Discriminator for ABA wire financial address.
+     */
+    type: 'aba';
+  }
+
+  export interface UnionMember3 {
     /**
      * Wallet address on the specified blockchain.
      */
@@ -683,7 +730,15 @@ export namespace PayoutCreateParams {
     /**
      * Blockchain network for the crypto wallet.
      */
-    blockchain: 'ethereum' | 'solana' | 'polygon';
+    blockchain:
+      | 'bitcoin'
+      | 'ethereum'
+      | 'solana'
+      | 'polygon'
+      | 'bitcoin_testnet4'
+      | 'ethereum_sepolia'
+      | 'solana_devnet'
+      | 'polygon_amoy';
 
     /**
      * Discriminator for crypto wallet financial address.
@@ -699,7 +754,7 @@ export interface PayoutListParams extends CursorPageParams {
    * Filter to these currency codes. Use a separate `currencies` query parameter for
    * each value (e.g. `?currencies=EUR&currencies=USD`).
    */
-  currencies?: Array<'EUR' | 'GBP' | 'USD' | 'USDC'>;
+  currencies?: Array<'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC'>;
 
   /**
    * Filter by payout status.

package/src/resources/quotes/indicative.ts

@@ -40,7 +40,7 @@ export interface IndicativeRetrieveResponse {
   /**
    * Source currency code.
    */
-  source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+  source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
   /**
    * Target amount as a string decimal.
@@ -50,7 +50,7 @@ export interface IndicativeRetrieveResponse {
   /**
    * Target currency code.
    */
-  target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+  target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
   /**
    * Venue the quote was fetched from.
@@ -71,7 +71,7 @@ export namespace IndicativeRetrieveResponse {
     /**
      * Fee currency code.
      */
-    currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+    currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
   }
 }
 
@@ -79,12 +79,12 @@ export interface IndicativeRetrieveParams {
   /**
    * Source currency code.
    */
-  source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+  source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
   /**
    * Target currency code.
    */
-  target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+  target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
   /**
    * Source amount as a string decimal. Defaults to 1 unit if omitted.

package/src/resources/quotes/quotes.ts

@@ -52,7 +52,7 @@ export interface QuoteRetrieveResponse {
   /**
    * Source currency code.
    */
-  source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+  source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
   /**
    * Current status of the quote.
@@ -77,7 +77,7 @@ export interface QuoteRetrieveResponse {
   /**
    * Target currency code.
    */
-  target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+  target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC';
 
   /**
    * Resource type discriminator.