@augustusbank/typescript-sdk 0.18.0 → 0.20.0

package/src/resources/accounts.ts

@@ -86,7 +86,7 @@ export interface AccountCreateResponse {
   /**
    * ISO 4217 currency code for the account.
    */
-  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
   /**
    * Payment identifiers (e.g. IBAN, account number, wallet address) through which
@@ -237,7 +237,7 @@ export interface AccountRetrieveResponse {
   /**
    * ISO 4217 currency code for the account.
    */
-  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
   /**
    * Payment identifiers (e.g. IBAN, account number, wallet address) through which
@@ -388,7 +388,7 @@ export interface AccountListResponse {
   /**
    * ISO 4217 currency code for the account.
    */
-  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
   /**
    * Payment identifiers (e.g. IBAN, account number, wallet address) through which
@@ -539,7 +539,7 @@ export interface AccountCloseResponse {
   /**
    * ISO 4217 currency code for the account.
    */
-  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
   /**
    * Payment identifiers (e.g. IBAN, account number, wallet address) through which
@@ -690,7 +690,7 @@ export interface AccountFreezeResponse {
   /**
    * ISO 4217 currency code for the account.
    */
-  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
   /**
    * Payment identifiers (e.g. IBAN, account number, wallet address) through which
@@ -836,7 +836,7 @@ export interface AccountRetrieveBalanceResponse {
   /**
    * ISO 4217 currency code for the balance.
    */
-  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
   /**
    * Resource type discriminator.
@@ -868,7 +868,7 @@ export interface AccountUnfreezeResponse {
   /**
    * ISO 4217 currency code for the account.
    */
-  currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
   /**
    * Payment identifiers (e.g. IBAN, account number, wallet address) through which
@@ -996,6 +996,11 @@ export namespace AccountUnfreezeResponse {
 }
 
 export interface AccountCreateParams {
+  /**
+   * ID of an existing virtual account holder to provision the account for.
+   */
+  account_holder_id: string;
+
   /**
    * ID of the account program to create the account under.
    */
@@ -1005,960 +1010,6 @@ export interface AccountCreateParams {
    * Type of account. Currently only virtual account.
    */
   account_type: 'virtual_account';
-
-  /**
-   * Personal information of the account beneficiary.
-   */
-  beneficiary_data: AccountCreateParams.UsBeneficiaryData | AccountCreateParams.NonUsBeneficiaryData;
-}
-
-export namespace AccountCreateParams {
-  export interface UsBeneficiaryData {
-    /**
-     * ISO 3166-1 alpha-2 country code of citizenship.
-     */
-    country_of_citizenship: 'US';
-
-    /**
-     * Date of birth as an ISO 8601 calendar date (YYYY-MM-DD).
-     */
-    date_of_birth: string;
-
-    /**
-     * Government-issued identification with type: "ssn" (Social Security Number,
-     * format ###-##-####) or "itin" (Individual Taxpayer ID, format 9##-##-####).
-     */
-    identification: UsBeneficiaryData.SsnIdentification | UsBeneficiaryData.ItinIdentification;
-
-    /**
-     * Full legal name of the account holder.
-     */
-    legal_name: string;
-
-    /**
-     * Residential address of the account holder.
-     */
-    residential_address: UsBeneficiaryData.UsResidentialAddress | UsBeneficiaryData.NonUsResidentialAddress;
-  }
-
-  export namespace UsBeneficiaryData {
-    export interface SsnIdentification {
-      type: 'ssn';
-
-      value: string;
-    }
-
-    export interface ItinIdentification {
-      type: 'itin';
-
-      value: string;
-    }
-
-    export interface UsResidentialAddress {
-      /**
-       * City name.
-       */
-      city: string;
-
-      /**
-       * ISO 3166-1 alpha-2 country code.
-       */
-      country: 'US';
-
-      /**
-       * Postal or ZIP code.
-       */
-      postal_code: string;
-
-      /**
-       * Two-letter state code.
-       */
-      state: string;
-
-      /**
-       * Primary street address.
-       */
-      street_line_1: string;
-
-      /**
-       * Secondary street address (apartment, suite, etc.).
-       */
-      street_line_2?: string;
-    }
-
-    export interface NonUsResidentialAddress {
-      /**
-       * City name.
-       */
-      city: string;
-
-      /**
-       * ISO 3166-1 alpha-2 country code.
-       */
-      country:
-        | 'AF'
-        | 'AL'
-        | 'DZ'
-        | 'AS'
-        | 'AD'
-        | 'AO'
-        | 'AI'
-        | 'AQ'
-        | 'AG'
-        | 'AR'
-        | 'AM'
-        | 'AW'
-        | 'AU'
-        | 'AT'
-        | 'AZ'
-        | 'BS'
-        | 'BH'
-        | 'BD'
-        | 'BB'
-        | 'BY'
-        | 'BE'
-        | 'BZ'
-        | 'BJ'
-        | 'BM'
-        | 'BT'
-        | 'BO'
-        | 'BA'
-        | 'BW'
-        | 'BV'
-        | 'BR'
-        | 'IO'
-        | 'BN'
-        | 'BG'
-        | 'BF'
-        | 'BI'
-        | 'KH'
-        | 'CM'
-        | 'CA'
-        | 'CV'
-        | 'KY'
-        | 'CF'
-        | 'TD'
-        | 'CL'
-        | 'CN'
-        | 'CX'
-        | 'CC'
-        | 'CO'
-        | 'KM'
-        | 'CG'
-        | 'CD'
-        | 'CK'
-        | 'CR'
-        | 'CI'
-        | 'HR'
-        | 'CU'
-        | 'CY'
-        | 'CZ'
-        | 'DK'
-        | 'DJ'
-        | 'DM'
-        | 'DO'
-        | 'EC'
-        | 'EG'
-        | 'SV'
-        | 'GQ'
-        | 'ER'
-        | 'EE'
-        | 'ET'
-        | 'FK'
-        | 'FO'
-        | 'FJ'
-        | 'FI'
-        | 'FR'
-        | 'GF'
-        | 'PF'
-        | 'TF'
-        | 'GA'
-        | 'GM'
-        | 'GE'
-        | 'DE'
-        | 'GH'
-        | 'GI'
-        | 'GR'
-        | 'GL'
-        | 'GD'
-        | 'GP'
-        | 'GU'
-        | 'GT'
-        | 'GN'
-        | 'GW'
-        | 'GY'
-        | 'HT'
-        | 'HM'
-        | 'VA'
-        | 'HN'
-        | 'HK'
-        | 'HU'
-        | 'IS'
-        | 'IN'
-        | 'ID'
-        | 'IR'
-        | 'IQ'
-        | 'IE'
-        | 'IL'
-        | 'IT'
-        | 'JM'
-        | 'JP'
-        | 'JO'
-        | 'KZ'
-        | 'KE'
-        | 'KI'
-        | 'KP'
-        | 'KR'
-        | 'KW'
-        | 'KG'
-        | 'LA'
-        | 'LV'
-        | 'LB'
-        | 'LS'
-        | 'LR'
-        | 'LY'
-        | 'LI'
-        | 'LT'
-        | 'LU'
-        | 'MO'
-        | 'MG'
-        | 'MW'
-        | 'MY'
-        | 'MV'
-        | 'ML'
-        | 'MT'
-        | 'MH'
-        | 'MQ'
-        | 'MR'
-        | 'MU'
-        | 'YT'
-        | 'MX'
-        | 'FM'
-        | 'MD'
-        | 'MC'
-        | 'MN'
-        | 'MS'
-        | 'MA'
-        | 'MZ'
-        | 'MM'
-        | 'NA'
-        | 'NR'
-        | 'NP'
-        | 'NL'
-        | 'NC'
-        | 'NZ'
-        | 'NI'
-        | 'NE'
-        | 'NG'
-        | 'NU'
-        | 'NF'
-        | 'MP'
-        | 'MK'
-        | 'NO'
-        | 'OM'
-        | 'PK'
-        | 'PW'
-        | 'PS'
-        | 'PA'
-        | 'PG'
-        | 'PY'
-        | 'PE'
-        | 'PH'
-        | 'PN'
-        | 'PL'
-        | 'PT'
-        | 'PR'
-        | 'QA'
-        | 'RE'
-        | 'RO'
-        | 'RU'
-        | 'RW'
-        | 'SH'
-        | 'KN'
-        | 'LC'
-        | 'PM'
-        | 'VC'
-        | 'WS'
-        | 'SM'
-        | 'ST'
-        | 'SA'
-        | 'SN'
-        | 'SC'
-        | 'SL'
-        | 'SG'
-        | 'SK'
-        | 'SI'
-        | 'SB'
-        | 'SO'
-        | 'ZA'
-        | 'GS'
-        | 'ES'
-        | 'LK'
-        | 'SD'
-        | 'SR'
-        | 'SJ'
-        | 'SZ'
-        | 'SE'
-        | 'CH'
-        | 'SY'
-        | 'TW'
-        | 'TJ'
-        | 'TZ'
-        | 'TH'
-        | 'TL'
-        | 'TG'
-        | 'TK'
-        | 'TO'
-        | 'TT'
-        | 'TN'
-        | 'TR'
-        | 'TM'
-        | 'TC'
-        | 'TV'
-        | 'UG'
-        | 'UA'
-        | 'AE'
-        | 'GB'
-        | 'UM'
-        | 'UY'
-        | 'UZ'
-        | 'VU'
-        | 'VE'
-        | 'VN'
-        | 'VG'
-        | 'VI'
-        | 'WF'
-        | 'EH'
-        | 'YE'
-        | 'ZM'
-        | 'ZW'
-        | 'AX'
-        | 'BQ'
-        | 'CW'
-        | 'GG'
-        | 'IM'
-        | 'JE'
-        | 'ME'
-        | 'BL'
-        | 'MF'
-        | 'RS'
-        | 'SX'
-        | 'SS'
-        | 'XK';
-
-      /**
-       * Postal or ZIP code.
-       */
-      postal_code: string;
-
-      /**
-       * Primary street address.
-       */
-      street_line_1: string;
-
-      /**
-       * Secondary street address (apartment, suite, etc.).
-       */
-      street_line_2?: string;
-    }
-  }
-
-  export interface NonUsBeneficiaryData {
-    /**
-     * ISO 3166-1 alpha-2 country code of citizenship.
-     */
-    country_of_citizenship:
-      | 'AF'
-      | 'AL'
-      | 'DZ'
-      | 'AS'
-      | 'AD'
-      | 'AO'
-      | 'AI'
-      | 'AQ'
-      | 'AG'
-      | 'AR'
-      | 'AM'
-      | 'AW'
-      | 'AU'
-      | 'AT'
-      | 'AZ'
-      | 'BS'
-      | 'BH'
-      | 'BD'
-      | 'BB'
-      | 'BY'
-      | 'BE'
-      | 'BZ'
-      | 'BJ'
-      | 'BM'
-      | 'BT'
-      | 'BO'
-      | 'BA'
-      | 'BW'
-      | 'BV'
-      | 'BR'
-      | 'IO'
-      | 'BN'
-      | 'BG'
-      | 'BF'
-      | 'BI'
-      | 'KH'
-      | 'CM'
-      | 'CA'
-      | 'CV'
-      | 'KY'
-      | 'CF'
-      | 'TD'
-      | 'CL'
-      | 'CN'
-      | 'CX'
-      | 'CC'
-      | 'CO'
-      | 'KM'
-      | 'CG'
-      | 'CD'
-      | 'CK'
-      | 'CR'
-      | 'CI'
-      | 'HR'
-      | 'CU'
-      | 'CY'
-      | 'CZ'
-      | 'DK'
-      | 'DJ'
-      | 'DM'
-      | 'DO'
-      | 'EC'
-      | 'EG'
-      | 'SV'
-      | 'GQ'
-      | 'ER'
-      | 'EE'
-      | 'ET'
-      | 'FK'
-      | 'FO'
-      | 'FJ'
-      | 'FI'
-      | 'FR'
-      | 'GF'
-      | 'PF'
-      | 'TF'
-      | 'GA'
-      | 'GM'
-      | 'GE'
-      | 'DE'
-      | 'GH'
-      | 'GI'
-      | 'GR'
-      | 'GL'
-      | 'GD'
-      | 'GP'
-      | 'GU'
-      | 'GT'
-      | 'GN'
-      | 'GW'
-      | 'GY'
-      | 'HT'
-      | 'HM'
-      | 'VA'
-      | 'HN'
-      | 'HK'
-      | 'HU'
-      | 'IS'
-      | 'IN'
-      | 'ID'
-      | 'IR'
-      | 'IQ'
-      | 'IE'
-      | 'IL'
-      | 'IT'
-      | 'JM'
-      | 'JP'
-      | 'JO'
-      | 'KZ'
-      | 'KE'
-      | 'KI'
-      | 'KP'
-      | 'KR'
-      | 'KW'
-      | 'KG'
-      | 'LA'
-      | 'LV'
-      | 'LB'
-      | 'LS'
-      | 'LR'
-      | 'LY'
-      | 'LI'
-      | 'LT'
-      | 'LU'
-      | 'MO'
-      | 'MG'
-      | 'MW'
-      | 'MY'
-      | 'MV'
-      | 'ML'
-      | 'MT'
-      | 'MH'
-      | 'MQ'
-      | 'MR'
-      | 'MU'
-      | 'YT'
-      | 'MX'
-      | 'FM'
-      | 'MD'
-      | 'MC'
-      | 'MN'
-      | 'MS'
-      | 'MA'
-      | 'MZ'
-      | 'MM'
-      | 'NA'
-      | 'NR'
-      | 'NP'
-      | 'NL'
-      | 'NC'
-      | 'NZ'
-      | 'NI'
-      | 'NE'
-      | 'NG'
-      | 'NU'
-      | 'NF'
-      | 'MP'
-      | 'MK'
-      | 'NO'
-      | 'OM'
-      | 'PK'
-      | 'PW'
-      | 'PS'
-      | 'PA'
-      | 'PG'
-      | 'PY'
-      | 'PE'
-      | 'PH'
-      | 'PN'
-      | 'PL'
-      | 'PT'
-      | 'PR'
-      | 'QA'
-      | 'RE'
-      | 'RO'
-      | 'RU'
-      | 'RW'
-      | 'SH'
-      | 'KN'
-      | 'LC'
-      | 'PM'
-      | 'VC'
-      | 'WS'
-      | 'SM'
-      | 'ST'
-      | 'SA'
-      | 'SN'
-      | 'SC'
-      | 'SL'
-      | 'SG'
-      | 'SK'
-      | 'SI'
-      | 'SB'
-      | 'SO'
-      | 'ZA'
-      | 'GS'
-      | 'ES'
-      | 'LK'
-      | 'SD'
-      | 'SR'
-      | 'SJ'
-      | 'SZ'
-      | 'SE'
-      | 'CH'
-      | 'SY'
-      | 'TW'
-      | 'TJ'
-      | 'TZ'
-      | 'TH'
-      | 'TL'
-      | 'TG'
-      | 'TK'
-      | 'TO'
-      | 'TT'
-      | 'TN'
-      | 'TR'
-      | 'TM'
-      | 'TC'
-      | 'TV'
-      | 'UG'
-      | 'UA'
-      | 'AE'
-      | 'GB'
-      | 'UM'
-      | 'UY'
-      | 'UZ'
-      | 'VU'
-      | 'VE'
-      | 'VN'
-      | 'VG'
-      | 'VI'
-      | 'WF'
-      | 'EH'
-      | 'YE'
-      | 'ZM'
-      | 'ZW'
-      | 'AX'
-      | 'BQ'
-      | 'CW'
-      | 'GG'
-      | 'IM'
-      | 'JE'
-      | 'ME'
-      | 'BL'
-      | 'MF'
-      | 'RS'
-      | 'SX'
-      | 'SS'
-      | 'XK';
-
-    /**
-     * Date of birth as an ISO 8601 calendar date (YYYY-MM-DD).
-     */
-    date_of_birth: string;
-
-    /**
-     * Government-issued identification with type: "id" (generic government-issued ID).
-     */
-    identification: NonUsBeneficiaryData.Identification;
-
-    /**
-     * Full legal name of the account holder.
-     */
-    legal_name: string;
-
-    /**
-     * Residential address of the account holder.
-     */
-    residential_address:
-      | NonUsBeneficiaryData.UsResidentialAddress
-      | NonUsBeneficiaryData.NonUsResidentialAddress;
-  }
-
-  export namespace NonUsBeneficiaryData {
-    /**
-     * Government-issued identification with type: "id" (generic government-issued ID).
-     */
-    export interface Identification {
-      type: 'id';
-
-      value: string;
-    }
-
-    export interface UsResidentialAddress {
-      /**
-       * City name.
-       */
-      city: string;
-
-      /**
-       * ISO 3166-1 alpha-2 country code.
-       */
-      country: 'US';
-
-      /**
-       * Postal or ZIP code.
-       */
-      postal_code: string;
-
-      /**
-       * Two-letter state code.
-       */
-      state: string;
-
-      /**
-       * Primary street address.
-       */
-      street_line_1: string;
-
-      /**
-       * Secondary street address (apartment, suite, etc.).
-       */
-      street_line_2?: string;
-    }
-
-    export interface NonUsResidentialAddress {
-      /**
-       * City name.
-       */
-      city: string;
-
-      /**
-       * ISO 3166-1 alpha-2 country code.
-       */
-      country:
-        | 'AF'
-        | 'AL'
-        | 'DZ'
-        | 'AS'
-        | 'AD'
-        | 'AO'
-        | 'AI'
-        | 'AQ'
-        | 'AG'
-        | 'AR'
-        | 'AM'
-        | 'AW'
-        | 'AU'
-        | 'AT'
-        | 'AZ'
-        | 'BS'
-        | 'BH'
-        | 'BD'
-        | 'BB'
-        | 'BY'
-        | 'BE'
-        | 'BZ'
-        | 'BJ'
-        | 'BM'
-        | 'BT'
-        | 'BO'
-        | 'BA'
-        | 'BW'
-        | 'BV'
-        | 'BR'
-        | 'IO'
-        | 'BN'
-        | 'BG'
-        | 'BF'
-        | 'BI'
-        | 'KH'
-        | 'CM'
-        | 'CA'
-        | 'CV'
-        | 'KY'
-        | 'CF'
-        | 'TD'
-        | 'CL'
-        | 'CN'
-        | 'CX'
-        | 'CC'
-        | 'CO'
-        | 'KM'
-        | 'CG'
-        | 'CD'
-        | 'CK'
-        | 'CR'
-        | 'CI'
-        | 'HR'
-        | 'CU'
-        | 'CY'
-        | 'CZ'
-        | 'DK'
-        | 'DJ'
-        | 'DM'
-        | 'DO'
-        | 'EC'
-        | 'EG'
-        | 'SV'
-        | 'GQ'
-        | 'ER'
-        | 'EE'
-        | 'ET'
-        | 'FK'
-        | 'FO'
-        | 'FJ'
-        | 'FI'
-        | 'FR'
-        | 'GF'
-        | 'PF'
-        | 'TF'
-        | 'GA'
-        | 'GM'
-        | 'GE'
-        | 'DE'
-        | 'GH'
-        | 'GI'
-        | 'GR'
-        | 'GL'
-        | 'GD'
-        | 'GP'
-        | 'GU'
-        | 'GT'
-        | 'GN'
-        | 'GW'
-        | 'GY'
-        | 'HT'
-        | 'HM'
-        | 'VA'
-        | 'HN'
-        | 'HK'
-        | 'HU'
-        | 'IS'
-        | 'IN'
-        | 'ID'
-        | 'IR'
-        | 'IQ'
-        | 'IE'
-        | 'IL'
-        | 'IT'
-        | 'JM'
-        | 'JP'
-        | 'JO'
-        | 'KZ'
-        | 'KE'
-        | 'KI'
-        | 'KP'
-        | 'KR'
-        | 'KW'
-        | 'KG'
-        | 'LA'
-        | 'LV'
-        | 'LB'
-        | 'LS'
-        | 'LR'
-        | 'LY'
-        | 'LI'
-        | 'LT'
-        | 'LU'
-        | 'MO'
-        | 'MG'
-        | 'MW'
-        | 'MY'
-        | 'MV'
-        | 'ML'
-        | 'MT'
-        | 'MH'
-        | 'MQ'
-        | 'MR'
-        | 'MU'
-        | 'YT'
-        | 'MX'
-        | 'FM'
-        | 'MD'
-        | 'MC'
-        | 'MN'
-        | 'MS'
-        | 'MA'
-        | 'MZ'
-        | 'MM'
-        | 'NA'
-        | 'NR'
-        | 'NP'
-        | 'NL'
-        | 'NC'
-        | 'NZ'
-        | 'NI'
-        | 'NE'
-        | 'NG'
-        | 'NU'
-        | 'NF'
-        | 'MP'
-        | 'MK'
-        | 'NO'
-        | 'OM'
-        | 'PK'
-        | 'PW'
-        | 'PS'
-        | 'PA'
-        | 'PG'
-        | 'PY'
-        | 'PE'
-        | 'PH'
-        | 'PN'
-        | 'PL'
-        | 'PT'
-        | 'PR'
-        | 'QA'
-        | 'RE'
-        | 'RO'
-        | 'RU'
-        | 'RW'
-        | 'SH'
-        | 'KN'
-        | 'LC'
-        | 'PM'
-        | 'VC'
-        | 'WS'
-        | 'SM'
-        | 'ST'
-        | 'SA'
-        | 'SN'
-        | 'SC'
-        | 'SL'
-        | 'SG'
-        | 'SK'
-        | 'SI'
-        | 'SB'
-        | 'SO'
-        | 'ZA'
-        | 'GS'
-        | 'ES'
-        | 'LK'
-        | 'SD'
-        | 'SR'
-        | 'SJ'
-        | 'SZ'
-        | 'SE'
-        | 'CH'
-        | 'SY'
-        | 'TW'
-        | 'TJ'
-        | 'TZ'
-        | 'TH'
-        | 'TL'
-        | 'TG'
-        | 'TK'
-        | 'TO'
-        | 'TT'
-        | 'TN'
-        | 'TR'
-        | 'TM'
-        | 'TC'
-        | 'TV'
-        | 'UG'
-        | 'UA'
-        | 'AE'
-        | 'GB'
-        | 'UM'
-        | 'UY'
-        | 'UZ'
-        | 'VU'
-        | 'VE'
-        | 'VN'
-        | 'VG'
-        | 'VI'
-        | 'WF'
-        | 'EH'
-        | 'YE'
-        | 'ZM'
-        | 'ZW'
-        | 'AX'
-        | 'BQ'
-        | 'CW'
-        | 'GG'
-        | 'IM'
-        | 'JE'
-        | 'ME'
-        | 'BL'
-        | 'MF'
-        | 'RS'
-        | 'SX'
-        | 'SS'
-        | 'XK';
-
-      /**
-       * Postal or ZIP code.
-       */
-      postal_code: string;
-
-      /**
-       * Primary street address.
-       */
-      street_line_1: string;
-
-      /**
-       * Secondary street address (apartment, suite, etc.).
-       */
-      street_line_2?: string;
-    }
-  }
 }
 
 export interface AccountListParams extends CursorPageParams {