@augustusbank/typescript-sdk 0.19.0 → 0.21.0

package/resources/webhooks.d.ts

@@ -47,11 +47,11 @@ export declare namespace PayoutCreatedWebhookEvent {
         /**
          * 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: Payload.UnionMember0 | Payload.UnionMember1 | Payload.UnionMember2 | Payload.UnionMember3;
+        destination: Payload.IbanFinancialAddress | Payload.SortCodeFinancialAddress | Payload.AbaFinancialAddress | Payload.CryptoWalletFinancialAddress;
         /**
          * Failure details when status is failed, otherwise null.
          */
@@ -84,7 +84,7 @@ export declare namespace PayoutCreatedWebhookEvent {
         updated_at: string;
     }
     namespace Payload {
-        interface UnionMember0 {
+        interface IbanFinancialAddress {
             /**
              * Name of the account holder.
              */
@@ -102,7 +102,7 @@ export declare namespace PayoutCreatedWebhookEvent {
              */
             type: 'iban';
         }
-        interface UnionMember1 {
+        interface SortCodeFinancialAddress {
             /**
              * Name of the account holder.
              */
@@ -120,7 +120,7 @@ export declare namespace PayoutCreatedWebhookEvent {
              */
             type: 'sort_code';
         }
-        interface UnionMember2 {
+        interface AbaFinancialAddress {
             /**
              * Name of the account holder.
              */
@@ -138,7 +138,7 @@ export declare namespace PayoutCreatedWebhookEvent {
              */
             type: 'aba';
         }
-        interface UnionMember3 {
+        interface CryptoWalletFinancialAddress {
             /**
              * Wallet address on the specified blockchain.
              */
@@ -213,11 +213,11 @@ export declare namespace PayoutInitiatedWebhookEvent {
         /**
          * 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: Payload.UnionMember0 | Payload.UnionMember1 | Payload.UnionMember2 | Payload.UnionMember3;
+        destination: Payload.IbanFinancialAddress | Payload.SortCodeFinancialAddress | Payload.AbaFinancialAddress | Payload.CryptoWalletFinancialAddress;
         /**
          * Failure details when status is failed, otherwise null.
          */
@@ -250,7 +250,7 @@ export declare namespace PayoutInitiatedWebhookEvent {
         updated_at: string;
     }
     namespace Payload {
-        interface UnionMember0 {
+        interface IbanFinancialAddress {
             /**
              * Name of the account holder.
              */
@@ -268,7 +268,7 @@ export declare namespace PayoutInitiatedWebhookEvent {
              */
             type: 'iban';
         }
-        interface UnionMember1 {
+        interface SortCodeFinancialAddress {
             /**
              * Name of the account holder.
              */
@@ -286,7 +286,7 @@ export declare namespace PayoutInitiatedWebhookEvent {
              */
             type: 'sort_code';
         }
-        interface UnionMember2 {
+        interface AbaFinancialAddress {
             /**
              * Name of the account holder.
              */
@@ -304,7 +304,7 @@ export declare namespace PayoutInitiatedWebhookEvent {
              */
             type: 'aba';
         }
-        interface UnionMember3 {
+        interface CryptoWalletFinancialAddress {
             /**
              * Wallet address on the specified blockchain.
              */
@@ -379,11 +379,11 @@ export declare namespace PayoutPaidWebhookEvent {
         /**
          * 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: Payload.UnionMember0 | Payload.UnionMember1 | Payload.UnionMember2 | Payload.UnionMember3;
+        destination: Payload.IbanFinancialAddress | Payload.SortCodeFinancialAddress | Payload.AbaFinancialAddress | Payload.CryptoWalletFinancialAddress;
         /**
          * Failure details when status is failed, otherwise null.
          */
@@ -416,7 +416,7 @@ export declare namespace PayoutPaidWebhookEvent {
         updated_at: string;
     }
     namespace Payload {
-        interface UnionMember0 {
+        interface IbanFinancialAddress {
             /**
              * Name of the account holder.
              */
@@ -434,7 +434,7 @@ export declare namespace PayoutPaidWebhookEvent {
              */
             type: 'iban';
         }
-        interface UnionMember1 {
+        interface SortCodeFinancialAddress {
             /**
              * Name of the account holder.
              */
@@ -452,7 +452,7 @@ export declare namespace PayoutPaidWebhookEvent {
              */
             type: 'sort_code';
         }
-        interface UnionMember2 {
+        interface AbaFinancialAddress {
             /**
              * Name of the account holder.
              */
@@ -470,7 +470,7 @@ export declare namespace PayoutPaidWebhookEvent {
              */
             type: 'aba';
         }
-        interface UnionMember3 {
+        interface CryptoWalletFinancialAddress {
             /**
              * Wallet address on the specified blockchain.
              */
@@ -545,11 +545,11 @@ export declare namespace PayoutFailedWebhookEvent {
         /**
          * 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: Payload.UnionMember0 | Payload.UnionMember1 | Payload.UnionMember2 | Payload.UnionMember3;
+        destination: Payload.IbanFinancialAddress | Payload.SortCodeFinancialAddress | Payload.AbaFinancialAddress | Payload.CryptoWalletFinancialAddress;
         /**
          * Failure details when status is failed, otherwise null.
          */
@@ -582,7 +582,7 @@ export declare namespace PayoutFailedWebhookEvent {
         updated_at: string;
     }
     namespace Payload {
-        interface UnionMember0 {
+        interface IbanFinancialAddress {
             /**
              * Name of the account holder.
              */
@@ -600,7 +600,7 @@ export declare namespace PayoutFailedWebhookEvent {
              */
             type: 'iban';
         }
-        interface UnionMember1 {
+        interface SortCodeFinancialAddress {
             /**
              * Name of the account holder.
              */
@@ -618,7 +618,7 @@ export declare namespace PayoutFailedWebhookEvent {
              */
             type: 'sort_code';
         }
-        interface UnionMember2 {
+        interface AbaFinancialAddress {
             /**
              * Name of the account holder.
              */
@@ -636,7 +636,7 @@ export declare namespace PayoutFailedWebhookEvent {
              */
             type: 'aba';
         }
-        interface UnionMember3 {
+        interface CryptoWalletFinancialAddress {
             /**
              * Wallet address on the specified blockchain.
              */
@@ -711,7 +711,7 @@ export declare namespace ReturnInitiatedWebhookEvent {
         /**
          * 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.
          */
@@ -795,7 +795,7 @@ export declare namespace ReturnPaidWebhookEvent {
         /**
          * 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.
          */
@@ -879,7 +879,7 @@ export declare namespace ReturnFailedWebhookEvent {
         /**
          * 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.
          */
@@ -963,7 +963,7 @@ export declare namespace ReturnReturnedWebhookEvent {
         /**
          * 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.
          */
@@ -1051,13 +1051,13 @@ export declare namespace DepositReceivedWebhookEvent {
         /**
          * 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.
          */
         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' | 'faster_payments' | 'sepa' | 'elixir' | 'express_elixir' | 'sek_account_to_account' | 'sumclearing' | 'straksclearing' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'btc' | 'btc_testnet4' | 'eth' | 'eth_sepolia' | 'sol' | 'sol_devnet' | 'matic' | 'matic_amoy' | null;
         /**
@@ -1067,7 +1067,7 @@ export declare namespace DepositReceivedWebhookEvent {
         /**
          * Counterparty bank account or crypto wallet that sent the funds.
          */
-        source: Payload.UnionMember0 | Payload.UnionMember1 | Payload.UnionMember2 | Payload.UnionMember3;
+        source: Payload.Iban | Payload.UkSortCode | Payload.Aba | Payload.Wallet;
         /**
          * Current status of the deposit.
          */
@@ -1086,7 +1086,7 @@ export declare namespace DepositReceivedWebhookEvent {
         updated_at: string;
     }
     namespace Payload {
-        interface UnionMember0 {
+        interface Iban {
             /**
              * Name of the account holder.
              */
@@ -1104,7 +1104,7 @@ export declare namespace DepositReceivedWebhookEvent {
              */
             type: 'iban';
         }
-        interface UnionMember1 {
+        interface UkSortCode {
             /**
              * Name of the account holder.
              */
@@ -1122,7 +1122,7 @@ export declare namespace DepositReceivedWebhookEvent {
              */
             type: 'sort_code';
         }
-        interface UnionMember2 {
+        interface Aba {
             /**
              * Name of the account holder.
              */
@@ -1140,7 +1140,7 @@ export declare namespace DepositReceivedWebhookEvent {
              */
             type: 'aba';
         }
-        interface UnionMember3 {
+        interface Wallet {
             /**
              * Wallet address on the specified blockchain.
              */
@@ -1220,7 +1220,7 @@ export declare namespace ConversionCreatedWebhookEvent {
         /**
          * Source currency code.
          */
-        source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
+        source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
         /**
          * Current status of the conversion.
          */
@@ -1232,7 +1232,7 @@ export declare namespace ConversionCreatedWebhookEvent {
         /**
          * Target currency code.
          */
-        target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
+        target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
         /**
          * Resource type discriminator.
          */
@@ -1318,7 +1318,7 @@ export declare namespace ConversionCompletedWebhookEvent {
         /**
          * Source currency code.
          */
-        source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
+        source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
         /**
          * Current status of the conversion.
          */
@@ -1330,7 +1330,7 @@ export declare namespace ConversionCompletedWebhookEvent {
         /**
          * Target currency code.
          */
-        target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
+        target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
         /**
          * Resource type discriminator.
          */
@@ -1416,7 +1416,7 @@ export declare namespace ConversionFailedWebhookEvent {
         /**
          * Source currency code.
          */
-        source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
+        source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
         /**
          * Current status of the conversion.
          */
@@ -1428,7 +1428,7 @@ export declare namespace ConversionFailedWebhookEvent {
         /**
          * Target currency code.
          */
-        target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
+        target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
         /**
          * Resource type discriminator.
          */