@augustusbank/typescript-sdk 0.27.0 → 0.28.0

package/src/resources/webhooks.ts

@@ -9932,6 +9932,11 @@ export namespace CounterpartyCreatedWebhookEvent {
      */
     date_of_birth: string | null;
 
+    /**
+     * Email address of the counterparty, or null if not recorded.
+     */
+    email: string | null;
+
     /**
      * Whether the counterparty is a business or an individual.
      */
@@ -9941,9 +9946,9 @@ export namespace CounterpartyCreatedWebhookEvent {
      * Financial address of the counterparty.
      */
     financial_address:
+      | Payload.AbaFinancialAddress
       | Payload.IbanFinancialAddress
       | Payload.SortCodeFinancialAddress
-      | Payload.AbaFinancialAddress
       | Payload.BicFinancialAddress
       | Payload.CryptoWalletFinancialAddress;
 
@@ -9953,6 +9958,11 @@ export namespace CounterpartyCreatedWebhookEvent {
      */
     is_self_owned: boolean;
 
+    /**
+     * National tax or identity number of the counterparty, or null if not recorded.
+     */
+    legal_id: string | null;
+
     /**
      * Set of up to 50 key-value string pairs you can attach to store structured
      * information, such as correlating this resource with an object in your own
@@ -9965,6 +9975,11 @@ export namespace CounterpartyCreatedWebhookEvent {
      */
     name: string | null;
 
+    /**
+     * Phone number of the counterparty, or null if not recorded.
+     */
+    phone: string | null;
+
     /**
      * Physical address of the counterparty, or null if not recorded.
      */
@@ -9977,70 +9992,80 @@ export namespace CounterpartyCreatedWebhookEvent {
   }
 
   export namespace Payload {
-    export interface IbanFinancialAddress {
+    export interface AbaFinancialAddress {
       /**
        * Name of the account holder.
        */
       account_holder_name: string;
 
       /**
-       * Bank Identifier Code, or null if not provided.
+       * Bank account number.
        */
-      bic: string | null;
+      account_number: string;
 
       /**
-       * International Bank Account Number.
+       * Whether the account is a checking or a savings account, or null if not provided.
        */
-      iban: string;
+      account_type: 'checking' | 'savings' | null;
 
       /**
-       * Discriminator for IBAN financial address.
+       * ABA routing number (9 digits).
        */
-      type: 'iban';
+      routing_number: string;
+
+      /**
+       * Discriminator for ABA wire financial address.
+       */
+      type: 'aba';
     }
 
-    export interface SortCodeFinancialAddress {
+    export interface IbanFinancialAddress {
       /**
        * Name of the account holder.
        */
       account_holder_name: string;
 
       /**
-       * UK account number (8 digits).
+       * Whether the account is a checking or a savings account, or null if not provided.
        */
-      account_number: string;
+      account_type: 'checking' | 'savings' | null;
 
       /**
-       * UK sort code (6 digits).
+       * Bank Identifier Code, or null if not provided.
        */
-      sort_code: string;
+      bic: string | null;
 
       /**
-       * Discriminator for UK sort code financial address.
+       * International Bank Account Number.
        */
-      type: 'sort_code';
+      iban: string;
+
+      /**
+       * Discriminator for IBAN financial address.
+       */
+      type: 'iban';
     }
 
-    export interface AbaFinancialAddress {
+    export interface SortCodeFinancialAddress {
       /**
        * Name of the account holder.
        */
       account_holder_name: string;
 
       /**
-       * Bank account number.
+       * UK account number (8 digits).
        */
       account_number: string;
 
       /**
-       * ABA routing number (9 digits).
+       * UK sort code (6 digits).
        */
-      routing_number: string;
+      sort_code: string;
 
       /**
-       * Discriminator for ABA wire financial address.
+       * Discriminator for UK sort code financial address.
        */
-      type: 'aba';
+      type: 'sort_code';
     }
 
     export interface BicFinancialAddress {
@@ -10054,6 +10079,11 @@ export namespace CounterpartyCreatedWebhookEvent {
        */
       account_number: string;
 
+      /**
+       * Whether the account is a checking or a savings account, or null if not provided.
+       */
+      account_type: 'checking' | 'savings' | null;
+
       /**
        * ISO 9362 Bank Identifier Code (8 or 11 characters).
        */
@@ -10430,6 +10460,11 @@ export namespace CounterpartyVerifiedWebhookEvent {
      */
     date_of_birth: string | null;
 
+    /**
+     * Email address of the counterparty, or null if not recorded.
+     */
+    email: string | null;
+
     /**
      * Whether the counterparty is a business or an individual.
      */
@@ -10439,9 +10474,9 @@ export namespace CounterpartyVerifiedWebhookEvent {
      * Financial address of the counterparty.
      */
     financial_address:
+      | Payload.AbaFinancialAddress
       | Payload.IbanFinancialAddress
       | Payload.SortCodeFinancialAddress
-      | Payload.AbaFinancialAddress
       | Payload.BicFinancialAddress
       | Payload.CryptoWalletFinancialAddress;
 
@@ -10451,6 +10486,11 @@ export namespace CounterpartyVerifiedWebhookEvent {
      */
     is_self_owned: boolean;
 
+    /**
+     * National tax or identity number of the counterparty, or null if not recorded.
+     */
+    legal_id: string | null;
+
     /**
      * Set of up to 50 key-value string pairs you can attach to store structured
      * information, such as correlating this resource with an object in your own
@@ -10463,6 +10503,11 @@ export namespace CounterpartyVerifiedWebhookEvent {
      */
     name: string | null;
 
+    /**
+     * Phone number of the counterparty, or null if not recorded.
+     */
+    phone: string | null;
+
     /**
      * Physical address of the counterparty, or null if not recorded.
      */
@@ -10475,70 +10520,80 @@ export namespace CounterpartyVerifiedWebhookEvent {
   }
 
   export namespace Payload {
-    export interface IbanFinancialAddress {
+    export interface AbaFinancialAddress {
       /**
        * Name of the account holder.
        */
       account_holder_name: string;
 
       /**
-       * Bank Identifier Code, or null if not provided.
+       * Bank account number.
        */
-      bic: string | null;
+      account_number: string;
 
       /**
-       * International Bank Account Number.
+       * Whether the account is a checking or a savings account, or null if not provided.
        */
-      iban: string;
+      account_type: 'checking' | 'savings' | null;
 
       /**
-       * Discriminator for IBAN financial address.
+       * ABA routing number (9 digits).
        */
-      type: 'iban';
+      routing_number: string;
+
+      /**
+       * Discriminator for ABA wire financial address.
+       */
+      type: 'aba';
     }
 
-    export interface SortCodeFinancialAddress {
+    export interface IbanFinancialAddress {
       /**
        * Name of the account holder.
        */
       account_holder_name: string;
 
       /**
-       * UK account number (8 digits).
+       * Whether the account is a checking or a savings account, or null if not provided.
        */
-      account_number: string;
+      account_type: 'checking' | 'savings' | null;
 
       /**
-       * UK sort code (6 digits).
+       * Bank Identifier Code, or null if not provided.
        */
-      sort_code: string;
+      bic: string | null;
 
       /**
-       * Discriminator for UK sort code financial address.
+       * International Bank Account Number.
        */
-      type: 'sort_code';
+      iban: string;
+
+      /**
+       * Discriminator for IBAN financial address.
+       */
+      type: 'iban';
     }
 
-    export interface AbaFinancialAddress {
+    export interface SortCodeFinancialAddress {
       /**
        * Name of the account holder.
        */
       account_holder_name: string;
 
       /**
-       * Bank account number.
+       * UK account number (8 digits).
        */
       account_number: string;
 
       /**
-       * ABA routing number (9 digits).
+       * UK sort code (6 digits).
        */
-      routing_number: string;
+      sort_code: string;
 
       /**
-       * Discriminator for ABA wire financial address.
+       * Discriminator for UK sort code financial address.
        */
-      type: 'aba';
+      type: 'sort_code';
     }
 
     export interface BicFinancialAddress {
@@ -10552,6 +10607,11 @@ export namespace CounterpartyVerifiedWebhookEvent {
        */
       account_number: string;
 
+      /**
+       * Whether the account is a checking or a savings account, or null if not provided.
+       */
+      account_type: 'checking' | 'savings' | null;
+
       /**
        * ISO 9362 Bank Identifier Code (8 or 11 characters).
        */
@@ -10928,6 +10988,11 @@ export namespace CounterpartyRejectedWebhookEvent {
      */
     date_of_birth: string | null;
 
+    /**
+     * Email address of the counterparty, or null if not recorded.
+     */
+    email: string | null;
+
     /**
      * Whether the counterparty is a business or an individual.
      */
@@ -10937,9 +11002,9 @@ export namespace CounterpartyRejectedWebhookEvent {
      * Financial address of the counterparty.
      */
     financial_address:
+      | Payload.AbaFinancialAddress
       | Payload.IbanFinancialAddress
       | Payload.SortCodeFinancialAddress
-      | Payload.AbaFinancialAddress
       | Payload.BicFinancialAddress
       | Payload.CryptoWalletFinancialAddress;
 
@@ -10949,6 +11014,11 @@ export namespace CounterpartyRejectedWebhookEvent {
      */
     is_self_owned: boolean;
 
+    /**
+     * National tax or identity number of the counterparty, or null if not recorded.
+     */
+    legal_id: string | null;
+
     /**
      * Set of up to 50 key-value string pairs you can attach to store structured
      * information, such as correlating this resource with an object in your own
@@ -10961,6 +11031,11 @@ export namespace CounterpartyRejectedWebhookEvent {
      */
     name: string | null;
 
+    /**
+     * Phone number of the counterparty, or null if not recorded.
+     */
+    phone: string | null;
+
     /**
      * Physical address of the counterparty, or null if not recorded.
      */
@@ -10973,70 +11048,80 @@ export namespace CounterpartyRejectedWebhookEvent {
   }
 
   export namespace Payload {
-    export interface IbanFinancialAddress {
+    export interface AbaFinancialAddress {
       /**
        * Name of the account holder.
        */
       account_holder_name: string;
 
       /**
-       * Bank Identifier Code, or null if not provided.
+       * Bank account number.
        */
-      bic: string | null;
+      account_number: string;
 
       /**
-       * International Bank Account Number.
+       * Whether the account is a checking or a savings account, or null if not provided.
        */
-      iban: string;
+      account_type: 'checking' | 'savings' | null;
 
       /**
-       * Discriminator for IBAN financial address.
+       * ABA routing number (9 digits).
        */
-      type: 'iban';
+      routing_number: string;
+
+      /**
+       * Discriminator for ABA wire financial address.
+       */
+      type: 'aba';
     }
 
-    export interface SortCodeFinancialAddress {
+    export interface IbanFinancialAddress {
       /**
        * Name of the account holder.
        */
       account_holder_name: string;
 
       /**
-       * UK account number (8 digits).
+       * Whether the account is a checking or a savings account, or null if not provided.
        */
-      account_number: string;
+      account_type: 'checking' | 'savings' | null;
 
       /**
-       * UK sort code (6 digits).
+       * Bank Identifier Code, or null if not provided.
        */
-      sort_code: string;
+      bic: string | null;
 
       /**
-       * Discriminator for UK sort code financial address.
+       * International Bank Account Number.
        */
-      type: 'sort_code';
+      iban: string;
+
+      /**
+       * Discriminator for IBAN financial address.
+       */
+      type: 'iban';
     }
 
-    export interface AbaFinancialAddress {
+    export interface SortCodeFinancialAddress {
       /**
        * Name of the account holder.
        */
       account_holder_name: string;
 
       /**
-       * Bank account number.
+       * UK account number (8 digits).
        */
       account_number: string;
 
       /**
-       * ABA routing number (9 digits).
+       * UK sort code (6 digits).
        */
-      routing_number: string;
+      sort_code: string;
 
       /**
-       * Discriminator for ABA wire financial address.
+       * Discriminator for UK sort code financial address.
        */
-      type: 'aba';
+      type: 'sort_code';
     }
 
     export interface BicFinancialAddress {
@@ -11050,6 +11135,11 @@ export namespace CounterpartyRejectedWebhookEvent {
        */
       account_number: string;
 
+      /**
+       * Whether the account is a checking or a savings account, or null if not provided.
+       */
+      account_type: 'checking' | 'savings' | null;
+
       /**
        * ISO 9362 Bank Identifier Code (8 or 11 characters).
        */
@@ -11426,6 +11516,11 @@ export namespace CounterpartyBlockedWebhookEvent {
      */
     date_of_birth: string | null;
 
+    /**
+     * Email address of the counterparty, or null if not recorded.
+     */
+    email: string | null;
+
     /**
      * Whether the counterparty is a business or an individual.
      */
@@ -11435,9 +11530,9 @@ export namespace CounterpartyBlockedWebhookEvent {
      * Financial address of the counterparty.
      */
     financial_address:
+      | Payload.AbaFinancialAddress
       | Payload.IbanFinancialAddress
       | Payload.SortCodeFinancialAddress
-      | Payload.AbaFinancialAddress
       | Payload.BicFinancialAddress
       | Payload.CryptoWalletFinancialAddress;
 
@@ -11447,6 +11542,11 @@ export namespace CounterpartyBlockedWebhookEvent {
      */
     is_self_owned: boolean;
 
+    /**
+     * National tax or identity number of the counterparty, or null if not recorded.
+     */
+    legal_id: string | null;
+
     /**
      * Set of up to 50 key-value string pairs you can attach to store structured
      * information, such as correlating this resource with an object in your own
@@ -11459,6 +11559,11 @@ export namespace CounterpartyBlockedWebhookEvent {
      */
     name: string | null;
 
+    /**
+     * Phone number of the counterparty, or null if not recorded.
+     */
+    phone: string | null;
+
     /**
      * Physical address of the counterparty, or null if not recorded.
      */
@@ -11471,70 +11576,80 @@ export namespace CounterpartyBlockedWebhookEvent {
   }
 
   export namespace Payload {
-    export interface IbanFinancialAddress {
+    export interface AbaFinancialAddress {
       /**
        * Name of the account holder.
        */
       account_holder_name: string;
 
       /**
-       * Bank Identifier Code, or null if not provided.
+       * Bank account number.
        */
-      bic: string | null;
+      account_number: string;
 
       /**
-       * International Bank Account Number.
+       * Whether the account is a checking or a savings account, or null if not provided.
        */
-      iban: string;
+      account_type: 'checking' | 'savings' | null;
 
       /**
-       * Discriminator for IBAN financial address.
+       * ABA routing number (9 digits).
        */
-      type: 'iban';
+      routing_number: string;
+
+      /**
+       * Discriminator for ABA wire financial address.
+       */
+      type: 'aba';
     }
 
-    export interface SortCodeFinancialAddress {
+    export interface IbanFinancialAddress {
       /**
        * Name of the account holder.
        */
       account_holder_name: string;
 
       /**
-       * UK account number (8 digits).
+       * Whether the account is a checking or a savings account, or null if not provided.
        */
-      account_number: string;
+      account_type: 'checking' | 'savings' | null;
 
       /**
-       * UK sort code (6 digits).
+       * Bank Identifier Code, or null if not provided.
        */
-      sort_code: string;
+      bic: string | null;
 
       /**
-       * Discriminator for UK sort code financial address.
+       * International Bank Account Number.
        */
-      type: 'sort_code';
+      iban: string;
+
+      /**
+       * Discriminator for IBAN financial address.
+       */
+      type: 'iban';
     }
 
-    export interface AbaFinancialAddress {
+    export interface SortCodeFinancialAddress {
       /**
        * Name of the account holder.
        */
       account_holder_name: string;
 
       /**
-       * Bank account number.
+       * UK account number (8 digits).
        */
       account_number: string;
 
       /**
-       * ABA routing number (9 digits).
+       * UK sort code (6 digits).
        */
-      routing_number: string;
+      sort_code: string;
 
       /**
-       * Discriminator for ABA wire financial address.
+       * Discriminator for UK sort code financial address.
        */
-      type: 'aba';
+      type: 'sort_code';
     }
 
     export interface BicFinancialAddress {
@@ -11548,6 +11663,11 @@ export namespace CounterpartyBlockedWebhookEvent {
        */
       account_number: string;
 
+      /**
+       * Whether the account is a checking or a savings account, or null if not provided.
+       */
+      account_type: 'checking' | 'savings' | null;
+
       /**
        * ISO 9362 Bank Identifier Code (8 or 11 characters).
        */
@@ -11924,6 +12044,11 @@ export namespace CounterpartyUnblockedWebhookEvent {
      */
     date_of_birth: string | null;
 
+    /**
+     * Email address of the counterparty, or null if not recorded.
+     */
+    email: string | null;
+
     /**
      * Whether the counterparty is a business or an individual.
      */
@@ -11933,9 +12058,9 @@ export namespace CounterpartyUnblockedWebhookEvent {
      * Financial address of the counterparty.
      */
     financial_address:
+      | Payload.AbaFinancialAddress
       | Payload.IbanFinancialAddress
       | Payload.SortCodeFinancialAddress
-      | Payload.AbaFinancialAddress
       | Payload.BicFinancialAddress
       | Payload.CryptoWalletFinancialAddress;
 
@@ -11945,6 +12070,11 @@ export namespace CounterpartyUnblockedWebhookEvent {
      */
     is_self_owned: boolean;
 
+    /**
+     * National tax or identity number of the counterparty, or null if not recorded.
+     */
+    legal_id: string | null;
+
     /**
      * Set of up to 50 key-value string pairs you can attach to store structured
      * information, such as correlating this resource with an object in your own
@@ -11957,6 +12087,11 @@ export namespace CounterpartyUnblockedWebhookEvent {
      */
     name: string | null;
 
+    /**
+     * Phone number of the counterparty, or null if not recorded.
+     */
+    phone: string | null;
+
     /**
      * Physical address of the counterparty, or null if not recorded.
      */
@@ -11969,70 +12104,80 @@ export namespace CounterpartyUnblockedWebhookEvent {
   }
 
   export namespace Payload {
-    export interface IbanFinancialAddress {
+    export interface AbaFinancialAddress {
       /**
        * Name of the account holder.
        */
       account_holder_name: string;
 
       /**
-       * Bank Identifier Code, or null if not provided.
+       * Bank account number.
        */
-      bic: string | null;
+      account_number: string;
 
       /**
-       * International Bank Account Number.
+       * Whether the account is a checking or a savings account, or null if not provided.
        */
-      iban: string;
+      account_type: 'checking' | 'savings' | null;
 
       /**
-       * Discriminator for IBAN financial address.
+       * ABA routing number (9 digits).
        */
-      type: 'iban';
+      routing_number: string;
+
+      /**
+       * Discriminator for ABA wire financial address.
+       */
+      type: 'aba';
     }
 
-    export interface SortCodeFinancialAddress {
+    export interface IbanFinancialAddress {
       /**
        * Name of the account holder.
        */
       account_holder_name: string;
 
       /**
-       * UK account number (8 digits).
+       * Whether the account is a checking or a savings account, or null if not provided.
        */
-      account_number: string;
+      account_type: 'checking' | 'savings' | null;
 
       /**
-       * UK sort code (6 digits).
+       * Bank Identifier Code, or null if not provided.
        */
-      sort_code: string;
+      bic: string | null;
 
       /**
-       * Discriminator for UK sort code financial address.
+       * International Bank Account Number.
        */
-      type: 'sort_code';
+      iban: string;
+
+      /**
+       * Discriminator for IBAN financial address.
+       */
+      type: 'iban';
     }
 
-    export interface AbaFinancialAddress {
+    export interface SortCodeFinancialAddress {
       /**
        * Name of the account holder.
        */
       account_holder_name: string;
 
       /**
-       * Bank account number.
+       * UK account number (8 digits).
        */
       account_number: string;
 
       /**
-       * ABA routing number (9 digits).
+       * UK sort code (6 digits).
        */
-      routing_number: string;
+      sort_code: string;
 
       /**
-       * Discriminator for ABA wire financial address.
+       * Discriminator for UK sort code financial address.
        */
-      type: 'aba';
+      type: 'sort_code';
     }
 
     export interface BicFinancialAddress {
@@ -12046,6 +12191,11 @@ export namespace CounterpartyUnblockedWebhookEvent {
        */
       account_number: string;
 
+      /**
+       * Whether the account is a checking or a savings account, or null if not provided.
+       */
+      account_type: 'checking' | 'savings' | null;
+
       /**
        * ISO 9362 Bank Identifier Code (8 or 11 characters).
        */
@@ -12422,6 +12572,11 @@ export namespace CounterpartyUpdatedWebhookEvent {
      */
     date_of_birth: string | null;
 
+    /**
+     * Email address of the counterparty, or null if not recorded.
+     */
+    email: string | null;
+
     /**
      * Whether the counterparty is a business or an individual.
      */
@@ -12431,9 +12586,9 @@ export namespace CounterpartyUpdatedWebhookEvent {
      * Financial address of the counterparty.
      */
     financial_address:
+      | Payload.AbaFinancialAddress
       | Payload.IbanFinancialAddress
       | Payload.SortCodeFinancialAddress
-      | Payload.AbaFinancialAddress
       | Payload.BicFinancialAddress
       | Payload.CryptoWalletFinancialAddress;
 
@@ -12443,6 +12598,11 @@ export namespace CounterpartyUpdatedWebhookEvent {
      */
     is_self_owned: boolean;
 
+    /**
+     * National tax or identity number of the counterparty, or null if not recorded.
+     */
+    legal_id: string | null;
+
     /**
      * Set of up to 50 key-value string pairs you can attach to store structured
      * information, such as correlating this resource with an object in your own
@@ -12455,6 +12615,11 @@ export namespace CounterpartyUpdatedWebhookEvent {
      */
     name: string | null;
 
+    /**
+     * Phone number of the counterparty, or null if not recorded.
+     */
+    phone: string | null;
+
     /**
      * Physical address of the counterparty, or null if not recorded.
      */
@@ -12467,70 +12632,80 @@ export namespace CounterpartyUpdatedWebhookEvent {
   }
 
   export namespace Payload {
-    export interface IbanFinancialAddress {
+    export interface AbaFinancialAddress {
       /**
        * Name of the account holder.
        */
       account_holder_name: string;
 
       /**
-       * Bank Identifier Code, or null if not provided.
+       * Bank account number.
        */
-      bic: string | null;
+      account_number: string;
 
       /**
-       * International Bank Account Number.
+       * Whether the account is a checking or a savings account, or null if not provided.
        */
-      iban: string;
+      account_type: 'checking' | 'savings' | null;
 
       /**
-       * Discriminator for IBAN financial address.
+       * ABA routing number (9 digits).
        */
-      type: 'iban';
+      routing_number: string;
+
+      /**
+       * Discriminator for ABA wire financial address.
+       */
+      type: 'aba';
     }
 
-    export interface SortCodeFinancialAddress {
+    export interface IbanFinancialAddress {
       /**
        * Name of the account holder.
        */
       account_holder_name: string;
 
       /**
-       * UK account number (8 digits).
+       * Whether the account is a checking or a savings account, or null if not provided.
        */
-      account_number: string;
+      account_type: 'checking' | 'savings' | null;
 
       /**
-       * UK sort code (6 digits).
+       * Bank Identifier Code, or null if not provided.
        */
-      sort_code: string;
+      bic: string | null;
 
       /**
-       * Discriminator for UK sort code financial address.
+       * International Bank Account Number.
        */
-      type: 'sort_code';
+      iban: string;
+
+      /**
+       * Discriminator for IBAN financial address.
+       */
+      type: 'iban';
     }
 
-    export interface AbaFinancialAddress {
+    export interface SortCodeFinancialAddress {
       /**
        * Name of the account holder.
        */
       account_holder_name: string;
 
       /**
-       * Bank account number.
+       * UK account number (8 digits).
        */
       account_number: string;
 
       /**
-       * ABA routing number (9 digits).
+       * UK sort code (6 digits).
        */
-      routing_number: string;
+      sort_code: string;
 
       /**
-       * Discriminator for ABA wire financial address.
+       * Discriminator for UK sort code financial address.
        */
-      type: 'aba';
+      type: 'sort_code';
     }
 
     export interface BicFinancialAddress {
@@ -12544,6 +12719,11 @@ export namespace CounterpartyUpdatedWebhookEvent {
        */
       account_number: string;
 
+      /**
+       * Whether the account is a checking or a savings account, or null if not provided.
+       */
+      account_type: 'checking' | 'savings' | null;
+
       /**
        * ISO 9362 Bank Identifier Code (8 or 11 characters).
        */