@augustusbank/typescript-sdk 0.26.0 → 0.28.0

package/resources/webhooks.d.mts

@@ -2949,6 +2949,10 @@ export declare namespace CounterpartyCreatedWebhookEvent {
          * Date of birth in YYYY-MM-DD format, or null if not recorded.
          */
         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.
          */
@@ -2956,12 +2960,16 @@ export declare namespace CounterpartyCreatedWebhookEvent {
         /**
          * Financial address of the counterparty.
          */
-        financial_address: Payload.IbanFinancialAddress | Payload.SortCodeFinancialAddress | Payload.AbaFinancialAddress | Payload.BicFinancialAddress | Payload.CryptoWalletFinancialAddress;
+        financial_address: Payload.AbaFinancialAddress | Payload.IbanFinancialAddress | Payload.SortCodeFinancialAddress | Payload.BicFinancialAddress | Payload.CryptoWalletFinancialAddress;
         /**
          * Whether the counterparty is self-owned. `false` if the counterparty is not owned
          * by you, `true` if it is.
          */
         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
@@ -2974,6 +2982,10 @@ export declare namespace CounterpartyCreatedWebhookEvent {
          * Name of the counterparty, or null if not recorded.
          */
         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.
          */
@@ -2984,11 +2996,37 @@ export declare namespace CounterpartyCreatedWebhookEvent {
         type: 'counterparty';
     }
     namespace Payload {
+        interface AbaFinancialAddress {
+            /**
+             * Name of the account holder.
+             */
+            account_holder_name: string;
+            /**
+             * Bank account number.
+             */
+            account_number: string;
+            /**
+             * Whether the account is a checking or a savings account, or null if not provided.
+             */
+            account_type: 'checking' | 'savings' | null;
+            /**
+             * ABA routing number (9 digits).
+             */
+            routing_number: string;
+            /**
+             * Discriminator for ABA wire financial address.
+             */
+            type: 'aba';
+        }
         interface IbanFinancialAddress {
             /**
              * Name of the account holder.
              */
             account_holder_name: string;
+            /**
+             * Whether the account is a checking or a savings account, or null if not provided.
+             */
+            account_type: 'checking' | 'savings' | null;
             /**
              * Bank Identifier Code, or null if not provided.
              */
@@ -3020,24 +3058,6 @@ export declare namespace CounterpartyCreatedWebhookEvent {
              */
             type: 'sort_code';
         }
-        interface AbaFinancialAddress {
-            /**
-             * 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';
-        }
         interface BicFinancialAddress {
             /**
              * Name of the account holder.
@@ -3047,6 +3067,10 @@ export declare namespace CounterpartyCreatedWebhookEvent {
              * Local-format bank account number.
              */
             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).
              */
@@ -3145,6 +3169,10 @@ export declare namespace CounterpartyVerifiedWebhookEvent {
          * Date of birth in YYYY-MM-DD format, or null if not recorded.
          */
         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.
          */
@@ -3152,12 +3180,16 @@ export declare namespace CounterpartyVerifiedWebhookEvent {
         /**
          * Financial address of the counterparty.
          */
-        financial_address: Payload.IbanFinancialAddress | Payload.SortCodeFinancialAddress | Payload.AbaFinancialAddress | Payload.BicFinancialAddress | Payload.CryptoWalletFinancialAddress;
+        financial_address: Payload.AbaFinancialAddress | Payload.IbanFinancialAddress | Payload.SortCodeFinancialAddress | Payload.BicFinancialAddress | Payload.CryptoWalletFinancialAddress;
         /**
          * Whether the counterparty is self-owned. `false` if the counterparty is not owned
          * by you, `true` if it is.
          */
         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
@@ -3170,6 +3202,10 @@ export declare namespace CounterpartyVerifiedWebhookEvent {
          * Name of the counterparty, or null if not recorded.
          */
         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.
          */
@@ -3180,11 +3216,37 @@ export declare namespace CounterpartyVerifiedWebhookEvent {
         type: 'counterparty';
     }
     namespace Payload {
+        interface AbaFinancialAddress {
+            /**
+             * Name of the account holder.
+             */
+            account_holder_name: string;
+            /**
+             * Bank account number.
+             */
+            account_number: string;
+            /**
+             * Whether the account is a checking or a savings account, or null if not provided.
+             */
+            account_type: 'checking' | 'savings' | null;
+            /**
+             * ABA routing number (9 digits).
+             */
+            routing_number: string;
+            /**
+             * Discriminator for ABA wire financial address.
+             */
+            type: 'aba';
+        }
         interface IbanFinancialAddress {
             /**
              * Name of the account holder.
              */
             account_holder_name: string;
+            /**
+             * Whether the account is a checking or a savings account, or null if not provided.
+             */
+            account_type: 'checking' | 'savings' | null;
             /**
              * Bank Identifier Code, or null if not provided.
              */
@@ -3216,24 +3278,6 @@ export declare namespace CounterpartyVerifiedWebhookEvent {
              */
             type: 'sort_code';
         }
-        interface AbaFinancialAddress {
-            /**
-             * 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';
-        }
         interface BicFinancialAddress {
             /**
              * Name of the account holder.
@@ -3243,6 +3287,10 @@ export declare namespace CounterpartyVerifiedWebhookEvent {
              * Local-format bank account number.
              */
             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).
              */
@@ -3341,6 +3389,10 @@ export declare namespace CounterpartyRejectedWebhookEvent {
          * Date of birth in YYYY-MM-DD format, or null if not recorded.
          */
         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.
          */
@@ -3348,12 +3400,16 @@ export declare namespace CounterpartyRejectedWebhookEvent {
         /**
          * Financial address of the counterparty.
          */
-        financial_address: Payload.IbanFinancialAddress | Payload.SortCodeFinancialAddress | Payload.AbaFinancialAddress | Payload.BicFinancialAddress | Payload.CryptoWalletFinancialAddress;
+        financial_address: Payload.AbaFinancialAddress | Payload.IbanFinancialAddress | Payload.SortCodeFinancialAddress | Payload.BicFinancialAddress | Payload.CryptoWalletFinancialAddress;
         /**
          * Whether the counterparty is self-owned. `false` if the counterparty is not owned
          * by you, `true` if it is.
          */
         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
@@ -3366,6 +3422,10 @@ export declare namespace CounterpartyRejectedWebhookEvent {
          * Name of the counterparty, or null if not recorded.
          */
         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.
          */
@@ -3376,11 +3436,37 @@ export declare namespace CounterpartyRejectedWebhookEvent {
         type: 'counterparty';
     }
     namespace Payload {
+        interface AbaFinancialAddress {
+            /**
+             * Name of the account holder.
+             */
+            account_holder_name: string;
+            /**
+             * Bank account number.
+             */
+            account_number: string;
+            /**
+             * Whether the account is a checking or a savings account, or null if not provided.
+             */
+            account_type: 'checking' | 'savings' | null;
+            /**
+             * ABA routing number (9 digits).
+             */
+            routing_number: string;
+            /**
+             * Discriminator for ABA wire financial address.
+             */
+            type: 'aba';
+        }
         interface IbanFinancialAddress {
             /**
              * Name of the account holder.
              */
             account_holder_name: string;
+            /**
+             * Whether the account is a checking or a savings account, or null if not provided.
+             */
+            account_type: 'checking' | 'savings' | null;
             /**
              * Bank Identifier Code, or null if not provided.
              */
@@ -3412,24 +3498,6 @@ export declare namespace CounterpartyRejectedWebhookEvent {
              */
             type: 'sort_code';
         }
-        interface AbaFinancialAddress {
-            /**
-             * 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';
-        }
         interface BicFinancialAddress {
             /**
              * Name of the account holder.
@@ -3439,6 +3507,10 @@ export declare namespace CounterpartyRejectedWebhookEvent {
              * Local-format bank account number.
              */
             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).
              */
@@ -3537,6 +3609,10 @@ export declare namespace CounterpartyBlockedWebhookEvent {
          * Date of birth in YYYY-MM-DD format, or null if not recorded.
          */
         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.
          */
@@ -3544,12 +3620,16 @@ export declare namespace CounterpartyBlockedWebhookEvent {
         /**
          * Financial address of the counterparty.
          */
-        financial_address: Payload.IbanFinancialAddress | Payload.SortCodeFinancialAddress | Payload.AbaFinancialAddress | Payload.BicFinancialAddress | Payload.CryptoWalletFinancialAddress;
+        financial_address: Payload.AbaFinancialAddress | Payload.IbanFinancialAddress | Payload.SortCodeFinancialAddress | Payload.BicFinancialAddress | Payload.CryptoWalletFinancialAddress;
         /**
          * Whether the counterparty is self-owned. `false` if the counterparty is not owned
          * by you, `true` if it is.
          */
         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
@@ -3562,6 +3642,10 @@ export declare namespace CounterpartyBlockedWebhookEvent {
          * Name of the counterparty, or null if not recorded.
          */
         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.
          */
@@ -3572,11 +3656,37 @@ export declare namespace CounterpartyBlockedWebhookEvent {
         type: 'counterparty';
     }
     namespace Payload {
+        interface AbaFinancialAddress {
+            /**
+             * Name of the account holder.
+             */
+            account_holder_name: string;
+            /**
+             * Bank account number.
+             */
+            account_number: string;
+            /**
+             * Whether the account is a checking or a savings account, or null if not provided.
+             */
+            account_type: 'checking' | 'savings' | null;
+            /**
+             * ABA routing number (9 digits).
+             */
+            routing_number: string;
+            /**
+             * Discriminator for ABA wire financial address.
+             */
+            type: 'aba';
+        }
         interface IbanFinancialAddress {
             /**
              * Name of the account holder.
              */
             account_holder_name: string;
+            /**
+             * Whether the account is a checking or a savings account, or null if not provided.
+             */
+            account_type: 'checking' | 'savings' | null;
             /**
              * Bank Identifier Code, or null if not provided.
              */
@@ -3608,24 +3718,6 @@ export declare namespace CounterpartyBlockedWebhookEvent {
              */
             type: 'sort_code';
         }
-        interface AbaFinancialAddress {
-            /**
-             * 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';
-        }
         interface BicFinancialAddress {
             /**
              * Name of the account holder.
@@ -3635,6 +3727,10 @@ export declare namespace CounterpartyBlockedWebhookEvent {
              * Local-format bank account number.
              */
             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).
              */
@@ -3733,6 +3829,10 @@ export declare namespace CounterpartyUnblockedWebhookEvent {
          * Date of birth in YYYY-MM-DD format, or null if not recorded.
          */
         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.
          */
@@ -3740,12 +3840,16 @@ export declare namespace CounterpartyUnblockedWebhookEvent {
         /**
          * Financial address of the counterparty.
          */
-        financial_address: Payload.IbanFinancialAddress | Payload.SortCodeFinancialAddress | Payload.AbaFinancialAddress | Payload.BicFinancialAddress | Payload.CryptoWalletFinancialAddress;
+        financial_address: Payload.AbaFinancialAddress | Payload.IbanFinancialAddress | Payload.SortCodeFinancialAddress | Payload.BicFinancialAddress | Payload.CryptoWalletFinancialAddress;
         /**
          * Whether the counterparty is self-owned. `false` if the counterparty is not owned
          * by you, `true` if it is.
          */
         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
@@ -3758,6 +3862,10 @@ export declare namespace CounterpartyUnblockedWebhookEvent {
          * Name of the counterparty, or null if not recorded.
          */
         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.
          */
@@ -3768,11 +3876,37 @@ export declare namespace CounterpartyUnblockedWebhookEvent {
         type: 'counterparty';
     }
     namespace Payload {
+        interface AbaFinancialAddress {
+            /**
+             * Name of the account holder.
+             */
+            account_holder_name: string;
+            /**
+             * Bank account number.
+             */
+            account_number: string;
+            /**
+             * Whether the account is a checking or a savings account, or null if not provided.
+             */
+            account_type: 'checking' | 'savings' | null;
+            /**
+             * ABA routing number (9 digits).
+             */
+            routing_number: string;
+            /**
+             * Discriminator for ABA wire financial address.
+             */
+            type: 'aba';
+        }
         interface IbanFinancialAddress {
             /**
              * Name of the account holder.
              */
             account_holder_name: string;
+            /**
+             * Whether the account is a checking or a savings account, or null if not provided.
+             */
+            account_type: 'checking' | 'savings' | null;
             /**
              * Bank Identifier Code, or null if not provided.
              */
@@ -3804,24 +3938,6 @@ export declare namespace CounterpartyUnblockedWebhookEvent {
              */
             type: 'sort_code';
         }
-        interface AbaFinancialAddress {
-            /**
-             * 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';
-        }
         interface BicFinancialAddress {
             /**
              * Name of the account holder.
@@ -3831,6 +3947,10 @@ export declare namespace CounterpartyUnblockedWebhookEvent {
              * Local-format bank account number.
              */
             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).
              */
@@ -3929,6 +4049,10 @@ export declare namespace CounterpartyUpdatedWebhookEvent {
          * Date of birth in YYYY-MM-DD format, or null if not recorded.
          */
         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.
          */
@@ -3936,12 +4060,16 @@ export declare namespace CounterpartyUpdatedWebhookEvent {
         /**
          * Financial address of the counterparty.
          */
-        financial_address: Payload.IbanFinancialAddress | Payload.SortCodeFinancialAddress | Payload.AbaFinancialAddress | Payload.BicFinancialAddress | Payload.CryptoWalletFinancialAddress;
+        financial_address: Payload.AbaFinancialAddress | Payload.IbanFinancialAddress | Payload.SortCodeFinancialAddress | Payload.BicFinancialAddress | Payload.CryptoWalletFinancialAddress;
         /**
          * Whether the counterparty is self-owned. `false` if the counterparty is not owned
          * by you, `true` if it is.
          */
         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
@@ -3954,6 +4082,10 @@ export declare namespace CounterpartyUpdatedWebhookEvent {
          * Name of the counterparty, or null if not recorded.
          */
         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.
          */
@@ -3964,11 +4096,37 @@ export declare namespace CounterpartyUpdatedWebhookEvent {
         type: 'counterparty';
     }
     namespace Payload {
+        interface AbaFinancialAddress {
+            /**
+             * Name of the account holder.
+             */
+            account_holder_name: string;
+            /**
+             * Bank account number.
+             */
+            account_number: string;
+            /**
+             * Whether the account is a checking or a savings account, or null if not provided.
+             */
+            account_type: 'checking' | 'savings' | null;
+            /**
+             * ABA routing number (9 digits).
+             */
+            routing_number: string;
+            /**
+             * Discriminator for ABA wire financial address.
+             */
+            type: 'aba';
+        }
         interface IbanFinancialAddress {
             /**
              * Name of the account holder.
              */
             account_holder_name: string;
+            /**
+             * Whether the account is a checking or a savings account, or null if not provided.
+             */
+            account_type: 'checking' | 'savings' | null;
             /**
              * Bank Identifier Code, or null if not provided.
              */
@@ -4000,24 +4158,6 @@ export declare namespace CounterpartyUpdatedWebhookEvent {
              */
             type: 'sort_code';
         }
-        interface AbaFinancialAddress {
-            /**
-             * 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';
-        }
         interface BicFinancialAddress {
             /**
              * Name of the account holder.
@@ -4027,6 +4167,10 @@ export declare namespace CounterpartyUpdatedWebhookEvent {
              * Local-format bank account number.
              */
             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).
              */