@augustusbank/typescript-sdk 0.19.0 → 0.21.0

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' | 'BTC' | 'ETH' | 'SOL' | 'POL';
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
   /**
    * ID of the merchant account that received the deposit.
@@ -59,7 +59,7 @@ export interface DepositRetrieveResponse {
   destination_account_id: string;
 
   /**
-   * Payment rail or blockchain used for the deposit.
+   * Payment rail or blockchain used for the deposit, or null when unknown.
    */
   rail:
     | 'sepa_instant'
@@ -94,10 +94,10 @@ export interface DepositRetrieveResponse {
    * Counterparty bank account or crypto wallet that sent the funds.
    */
   source:
-    | DepositRetrieveResponse.UnionMember0
-    | DepositRetrieveResponse.UnionMember1
-    | DepositRetrieveResponse.UnionMember2
-    | DepositRetrieveResponse.UnionMember3;
+    | DepositRetrieveResponse.Iban
+    | DepositRetrieveResponse.UkSortCode
+    | DepositRetrieveResponse.Aba
+    | DepositRetrieveResponse.Wallet;
 
   /**
    * Current status of the deposit.
@@ -121,7 +121,7 @@ export interface DepositRetrieveResponse {
 }
 
 export namespace DepositRetrieveResponse {
-  export interface UnionMember0 {
+  export interface Iban {
     /**
      * Name of the account holder.
      */
@@ -143,7 +143,7 @@ export namespace DepositRetrieveResponse {
     type: 'iban';
   }
 
-  export interface UnionMember1 {
+  export interface UkSortCode {
     /**
      * Name of the account holder.
      */
@@ -165,7 +165,7 @@ export namespace DepositRetrieveResponse {
     type: 'sort_code';
   }
 
-  export interface UnionMember2 {
+  export interface Aba {
     /**
      * Name of the account holder.
      */
@@ -187,7 +187,7 @@ export namespace DepositRetrieveResponse {
     type: 'aba';
   }
 
-  export interface UnionMember3 {
+  export interface Wallet {
     /**
      * Wallet address on the specified blockchain.
      */
@@ -237,7 +237,7 @@ export interface DepositListResponse {
   /**
    * Supported fiat or crypto currency code for the deposit amount.
    */
-  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
   /**
    * ID of the merchant account that received the deposit.
@@ -245,7 +245,7 @@ export interface DepositListResponse {
   destination_account_id: string;
 
   /**
-   * Payment rail or blockchain used for the deposit.
+   * Payment rail or blockchain used for the deposit, or null when unknown.
    */
   rail:
     | 'sepa_instant'
@@ -280,10 +280,10 @@ export interface DepositListResponse {
    * Counterparty bank account or crypto wallet that sent the funds.
    */
   source:
-    | DepositListResponse.UnionMember0
-    | DepositListResponse.UnionMember1
-    | DepositListResponse.UnionMember2
-    | DepositListResponse.UnionMember3;
+    | DepositListResponse.Iban
+    | DepositListResponse.UkSortCode
+    | DepositListResponse.Aba
+    | DepositListResponse.Wallet;
 
   /**
    * Current status of the deposit.
@@ -307,7 +307,7 @@ export interface DepositListResponse {
 }
 
 export namespace DepositListResponse {
-  export interface UnionMember0 {
+  export interface Iban {
     /**
      * Name of the account holder.
      */
@@ -329,7 +329,7 @@ export namespace DepositListResponse {
     type: 'iban';
   }
 
-  export interface UnionMember1 {
+  export interface UkSortCode {
     /**
      * Name of the account holder.
      */
@@ -351,7 +351,7 @@ export namespace DepositListResponse {
     type: 'sort_code';
   }
 
-  export interface UnionMember2 {
+  export interface Aba {
     /**
      * Name of the account holder.
      */
@@ -373,7 +373,7 @@ export namespace DepositListResponse {
     type: 'aba';
   }
 
-  export interface UnionMember3 {
+  export interface Wallet {
     /**
      * Wallet address on the specified blockchain.
      */

package/src/resources/payouts.ts

@@ -53,16 +53,16 @@ export interface PayoutCreateResponse {
   /**
    * Currency code (ISO 4217 currency code or crypto currency code).
    */
-  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
   /**
    * Bank account or crypto wallet the payout was sent to.
    */
   destination:
-    | PayoutCreateResponse.UnionMember0
-    | PayoutCreateResponse.UnionMember1
-    | PayoutCreateResponse.UnionMember2
-    | PayoutCreateResponse.UnionMember3;
+    | PayoutCreateResponse.IbanFinancialAddress
+    | PayoutCreateResponse.SortCodeFinancialAddress
+    | PayoutCreateResponse.AbaFinancialAddress
+    | PayoutCreateResponse.CryptoWalletFinancialAddress;
 
   /**
    * Failure details when status is failed, otherwise null.
@@ -101,7 +101,7 @@ export interface PayoutCreateResponse {
 }
 
 export namespace PayoutCreateResponse {
-  export interface UnionMember0 {
+  export interface IbanFinancialAddress {
     /**
      * Name of the account holder.
      */
@@ -123,7 +123,7 @@ export namespace PayoutCreateResponse {
     type: 'iban';
   }
 
-  export interface UnionMember1 {
+  export interface SortCodeFinancialAddress {
     /**
      * Name of the account holder.
      */
@@ -145,7 +145,7 @@ export namespace PayoutCreateResponse {
     type: 'sort_code';
   }
 
-  export interface UnionMember2 {
+  export interface AbaFinancialAddress {
     /**
      * Name of the account holder.
      */
@@ -167,7 +167,7 @@ export namespace PayoutCreateResponse {
     type: 'aba';
   }
 
-  export interface UnionMember3 {
+  export interface CryptoWalletFinancialAddress {
     /**
      * Wallet address on the specified blockchain.
      */
@@ -246,16 +246,16 @@ export interface PayoutRetrieveResponse {
   /**
    * Currency code (ISO 4217 currency code or crypto currency code).
    */
-  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
   /**
    * Bank account or crypto wallet the payout was sent to.
    */
   destination:
-    | PayoutRetrieveResponse.UnionMember0
-    | PayoutRetrieveResponse.UnionMember1
-    | PayoutRetrieveResponse.UnionMember2
-    | PayoutRetrieveResponse.UnionMember3;
+    | PayoutRetrieveResponse.IbanFinancialAddress
+    | PayoutRetrieveResponse.SortCodeFinancialAddress
+    | PayoutRetrieveResponse.AbaFinancialAddress
+    | PayoutRetrieveResponse.CryptoWalletFinancialAddress;
 
   /**
    * Failure details when status is failed, otherwise null.
@@ -294,7 +294,7 @@ export interface PayoutRetrieveResponse {
 }
 
 export namespace PayoutRetrieveResponse {
-  export interface UnionMember0 {
+  export interface IbanFinancialAddress {
     /**
      * Name of the account holder.
      */
@@ -316,7 +316,7 @@ export namespace PayoutRetrieveResponse {
     type: 'iban';
   }
 
-  export interface UnionMember1 {
+  export interface SortCodeFinancialAddress {
     /**
      * Name of the account holder.
      */
@@ -338,7 +338,7 @@ export namespace PayoutRetrieveResponse {
     type: 'sort_code';
   }
 
-  export interface UnionMember2 {
+  export interface AbaFinancialAddress {
     /**
      * Name of the account holder.
      */
@@ -360,7 +360,7 @@ export namespace PayoutRetrieveResponse {
     type: 'aba';
   }
 
-  export interface UnionMember3 {
+  export interface CryptoWalletFinancialAddress {
     /**
      * Wallet address on the specified blockchain.
      */
@@ -439,16 +439,16 @@ export interface PayoutListResponse {
   /**
    * Currency code (ISO 4217 currency code or crypto currency code).
    */
-  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
   /**
    * Bank account or crypto wallet the payout was sent to.
    */
   destination:
-    | PayoutListResponse.UnionMember0
-    | PayoutListResponse.UnionMember1
-    | PayoutListResponse.UnionMember2
-    | PayoutListResponse.UnionMember3;
+    | PayoutListResponse.IbanFinancialAddress
+    | PayoutListResponse.SortCodeFinancialAddress
+    | PayoutListResponse.AbaFinancialAddress
+    | PayoutListResponse.CryptoWalletFinancialAddress;
 
   /**
    * Failure details when status is failed, otherwise null.
@@ -487,7 +487,7 @@ export interface PayoutListResponse {
 }
 
 export namespace PayoutListResponse {
-  export interface UnionMember0 {
+  export interface IbanFinancialAddress {
     /**
      * Name of the account holder.
      */
@@ -509,7 +509,7 @@ export namespace PayoutListResponse {
     type: 'iban';
   }
 
-  export interface UnionMember1 {
+  export interface SortCodeFinancialAddress {
     /**
      * Name of the account holder.
      */
@@ -531,7 +531,7 @@ export namespace PayoutListResponse {
     type: 'sort_code';
   }
 
-  export interface UnionMember2 {
+  export interface AbaFinancialAddress {
     /**
      * Name of the account holder.
      */
@@ -553,7 +553,7 @@ export namespace PayoutListResponse {
     type: 'aba';
   }
 
-  export interface UnionMember3 {
+  export interface CryptoWalletFinancialAddress {
     /**
      * Wallet address on the specified blockchain.
      */
@@ -622,16 +622,16 @@ export interface PayoutCreateParams {
   /**
    * Currency for the payout.
    */
-  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
   /**
    * Bank account or crypto wallet to send funds to.
    */
   destination:
-    | PayoutCreateParams.UnionMember0
-    | PayoutCreateParams.UnionMember1
-    | PayoutCreateParams.UnionMember2
-    | PayoutCreateParams.UnionMember3;
+    | PayoutCreateParams.Iban
+    | PayoutCreateParams.SortCodeFinancialAddress
+    | PayoutCreateParams.AbaFinancialAddress
+    | PayoutCreateParams.CryptoWalletFinancialAddress;
 
   /**
    * Payment reference.
@@ -655,7 +655,7 @@ export interface PayoutCreateParams {
 }
 
 export namespace PayoutCreateParams {
-  export interface UnionMember0 {
+  export interface Iban {
     /**
      * Name of the account holder.
      */
@@ -677,7 +677,7 @@ export namespace PayoutCreateParams {
     bic?: string;
   }
 
-  export interface UnionMember1 {
+  export interface SortCodeFinancialAddress {
     /**
      * Name of the account holder.
      */
@@ -699,7 +699,7 @@ export namespace PayoutCreateParams {
     type: 'sort_code';
   }
 
-  export interface UnionMember2 {
+  export interface AbaFinancialAddress {
     /**
      * Name of the account holder.
      */
@@ -721,7 +721,7 @@ export namespace PayoutCreateParams {
     type: 'aba';
   }
 
-  export interface UnionMember3 {
+  export interface CryptoWalletFinancialAddress {
     /**
      * Wallet address on the specified blockchain.
      */
@@ -754,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' | 'BTC' | 'ETH' | 'SOL' | 'POL'>;
+  currencies?: Array<'EUR' | 'GBP' | 'USD' | 'USDC'>;
 
   /**
    * Filter by payout status.

package/src/resources/returns.ts

@@ -53,7 +53,7 @@ export interface ReturnCreateResponse {
   /**
    * Currency code (ISO 4217 currency code or crypto currency code).
    */
-  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
   /**
    * ID of the parent deposit.
@@ -136,7 +136,7 @@ export interface ReturnRetrieveResponse {
   /**
    * Currency code (ISO 4217 currency code or crypto currency code).
    */
-  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
   /**
    * ID of the parent deposit.
@@ -219,7 +219,7 @@ export interface ReturnListResponse {
   /**
    * Currency code (ISO 4217 currency code or crypto currency code).
    */
-  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
   /**
    * ID of the parent deposit.

package/src/resources/transactions.ts

@@ -55,10 +55,10 @@ export interface TransactionRetrieveResponse {
    * Bank account or wallet of the other party, or null when not known.
    */
   counterparty:
-    | TransactionRetrieveResponse.UnionMember0
-    | TransactionRetrieveResponse.UnionMember1
-    | TransactionRetrieveResponse.UnionMember2
-    | TransactionRetrieveResponse.UnionMember3
+    | TransactionRetrieveResponse.IbanFinancialAddress
+    | TransactionRetrieveResponse.SortCodeFinancialAddress
+    | TransactionRetrieveResponse.AbaFinancialAddress
+    | TransactionRetrieveResponse.CryptoWalletFinancialAddress
     | null;
 
   /**
@@ -69,7 +69,7 @@ export interface TransactionRetrieveResponse {
   /**
    * ISO 4217 fiat or crypto currency code of the amount.
    */
-  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
   /**
    * The product that caused this transaction, or null when no product is linked.
@@ -93,7 +93,7 @@ export interface TransactionRetrieveResponse {
 }
 
 export namespace TransactionRetrieveResponse {
-  export interface UnionMember0 {
+  export interface IbanFinancialAddress {
     /**
      * Name of the account holder.
      */
@@ -115,7 +115,7 @@ export namespace TransactionRetrieveResponse {
     type: 'iban';
   }
 
-  export interface UnionMember1 {
+  export interface SortCodeFinancialAddress {
     /**
      * Name of the account holder.
      */
@@ -137,7 +137,7 @@ export namespace TransactionRetrieveResponse {
     type: 'sort_code';
   }
 
-  export interface UnionMember2 {
+  export interface AbaFinancialAddress {
     /**
      * Name of the account holder.
      */
@@ -159,7 +159,7 @@ export namespace TransactionRetrieveResponse {
     type: 'aba';
   }
 
-  export interface UnionMember3 {
+  export interface CryptoWalletFinancialAddress {
     /**
      * Wallet address on the specified blockchain.
      */
@@ -225,10 +225,10 @@ export interface TransactionListResponse {
    * Bank account or wallet of the other party, or null when not known.
    */
   counterparty:
-    | TransactionListResponse.UnionMember0
-    | TransactionListResponse.UnionMember1
-    | TransactionListResponse.UnionMember2
-    | TransactionListResponse.UnionMember3
+    | TransactionListResponse.IbanFinancialAddress
+    | TransactionListResponse.SortCodeFinancialAddress
+    | TransactionListResponse.AbaFinancialAddress
+    | TransactionListResponse.CryptoWalletFinancialAddress
     | null;
 
   /**
@@ -239,7 +239,7 @@ export interface TransactionListResponse {
   /**
    * ISO 4217 fiat or crypto currency code of the amount.
    */
-  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
   /**
    * The product that caused this transaction, or null when no product is linked.
@@ -263,7 +263,7 @@ export interface TransactionListResponse {
 }
 
 export namespace TransactionListResponse {
-  export interface UnionMember0 {
+  export interface IbanFinancialAddress {
     /**
      * Name of the account holder.
      */
@@ -285,7 +285,7 @@ export namespace TransactionListResponse {
     type: 'iban';
   }
 
-  export interface UnionMember1 {
+  export interface SortCodeFinancialAddress {
     /**
      * Name of the account holder.
      */
@@ -307,7 +307,7 @@ export namespace TransactionListResponse {
     type: 'sort_code';
   }
 
-  export interface UnionMember2 {
+  export interface AbaFinancialAddress {
     /**
      * Name of the account holder.
      */
@@ -329,7 +329,7 @@ export namespace TransactionListResponse {
     type: 'aba';
   }
 
-  export interface UnionMember3 {
+  export interface CryptoWalletFinancialAddress {
     /**
      * Wallet address on the specified blockchain.
      */