@augustusbank/typescript-sdk 0.26.0 → 0.27.0

package/src/resources/counterparties.ts

@@ -77,21 +77,6 @@ export class Counterparties extends APIResource {
       ...options,
     });
   }
-
-  /**
-   * Blocks payments to and from a counterparty owned by the merchant. Blocking an
-   * already-blocked counterparty succeeds without changing the existing block.
-   *
-   * @example
-   * ```ts
-   * const response = await client.counterparties.block(
-   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   * );
-   * ```
-   */
-  block(id: string, options?: RequestOptions): APIPromise<CounterpartyBlockResponse> {
-    return this._client.post(path`/v1/counterparties/${id}/block`, options);
-  }
 }
 
 export type CounterpartyListResponsesCursorPage = CursorPage<CounterpartyListResponse>;
@@ -1960,480 +1945,14 @@ export namespace CounterpartyListResponse {
   }
 }
 
-export interface CounterpartyBlockResponse {
-  /**
-   * Unique identifier of the counterparty.
-   */
-  id: string;
-
-  /**
-   * Whether payments to or from this counterparty are currently blocked.
-   */
-  blocked: boolean;
-
-  /**
-   * Date of birth in YYYY-MM-DD format, or null if not recorded.
-   */
-  date_of_birth: string | null;
-
-  /**
-   * Whether the counterparty is a business or an individual.
-   */
-  entity_type: 'business' | 'individual';
-
-  /**
-   * Financial address of the counterparty.
-   */
-  financial_address:
-    | CounterpartyBlockResponse.IbanFinancialAddress
-    | CounterpartyBlockResponse.SortCodeFinancialAddress
-    | CounterpartyBlockResponse.AbaFinancialAddress
-    | CounterpartyBlockResponse.BicFinancialAddress
-    | CounterpartyBlockResponse.CryptoWalletFinancialAddress;
-
-  /**
-   * Whether the counterparty is self-owned. `false` if the counterparty is not owned
-   * by you, `true` if it is.
-   */
-  is_self_owned: boolean;
-
-  /**
-   * 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
-   * system. Keys may be up to 40 characters and values up to 500 characters.
-   */
-  metadata: { [key: string]: string };
-
-  /**
-   * Name of the counterparty, or null if not recorded.
-   */
-  name: string | null;
-
-  /**
-   * Physical address of the counterparty, or null if not recorded.
-   */
-  physical_address: CounterpartyBlockResponse.PhysicalAddress | null;
-
-  /**
-   * Resource type discriminator.
-   */
-  type: 'counterparty';
-}
-
-export namespace CounterpartyBlockResponse {
-  export interface IbanFinancialAddress {
-    /**
-     * Name of the account holder.
-     */
-    account_holder_name: string;
-
-    /**
-     * Bank Identifier Code, or null if not provided.
-     */
-    bic: string | null;
-
-    /**
-     * International Bank Account Number.
-     */
-    iban: string;
-
-    /**
-     * Discriminator for IBAN financial address.
-     */
-    type: 'iban';
-  }
-
-  export interface SortCodeFinancialAddress {
-    /**
-     * Name of the account holder.
-     */
-    account_holder_name: string;
-
-    /**
-     * UK account number (8 digits).
-     */
-    account_number: string;
-
-    /**
-     * UK sort code (6 digits).
-     */
-    sort_code: string;
-
-    /**
-     * Discriminator for UK sort code financial address.
-     */
-    type: 'sort_code';
-  }
-
-  export 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';
-  }
-
-  export interface BicFinancialAddress {
-    /**
-     * Name of the account holder.
-     */
-    account_holder_name: string;
-
-    /**
-     * Local-format bank account number.
-     */
-    account_number: string;
-
-    /**
-     * ISO 9362 Bank Identifier Code (8 or 11 characters).
-     */
-    bic: string;
-
-    /**
-     * Domestic bank or branch code where the destination country uses one (for example
-     * the BSB in Australia), or null.
-     */
-    local_bank_code: string | null;
-
-    /**
-     * Discriminator for BIC + local account financial address.
-     */
-    type: 'bic';
-  }
-
-  export interface CryptoWalletFinancialAddress {
-    /**
-     * Wallet address on the specified blockchain.
-     */
-    address: string;
-
-    /**
-     * Blockchain network for the crypto wallet.
-     */
-    blockchain:
-      | 'bitcoin'
-      | 'ethereum'
-      | 'solana'
-      | 'polygon'
-      | 'bitcoin_testnet4'
-      | 'ethereum_sepolia'
-      | 'solana_devnet'
-      | 'polygon_amoy';
-
-    /**
-     * Discriminator for crypto wallet financial address.
-     */
-    type: 'crypto_wallet';
-  }
-
-  /**
-   * Physical address of the counterparty, or null if not recorded.
-   */
-  export interface PhysicalAddress {
-    /**
-     * City or locality.
-     */
-    city: string;
-
-    /**
-     * ISO 3166-1 alpha-2 country code.
-     */
-    country_code:
-      | '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'
-      | 'US'
-      | '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';
-
-    /**
-     * Primary street address, or null if not recorded.
-     */
-    line_1: string | null;
-
-    /**
-     * Secondary street address, or null if not recorded.
-     */
-    line_2: string | null;
-
-    /**
-     * Postal or ZIP code, or null if not recorded.
-     */
-    postal_code: string | null;
-
-    /**
-     * State, province, or region, or null if not recorded.
-     */
-    state: string | null;
-  }
-}
-
 export interface CounterpartyCreateParams {
   /**
    * Financial address of the counterparty.
    */
   financial_address:
     | CounterpartyCreateParams.IbanFinancialAddressRequest
-    | CounterpartyCreateParams.SortCodeFinancialAddress
-    | CounterpartyCreateParams.AbaFinancialAddress
+    | CounterpartyCreateParams.SortCodeFinancialAddressRequest
+    | CounterpartyCreateParams.AbaFinancialAddressRequest
     | CounterpartyCreateParams.BicFinancialAddressRequest
     | CounterpartyCreateParams.CryptoWalletFinancialAddress;
 
@@ -2494,7 +2013,7 @@ export namespace CounterpartyCreateParams {
     bic?: string | null;
   }
 
-  export interface SortCodeFinancialAddress {
+  export interface SortCodeFinancialAddressRequest {
     /**
      * Name of the account holder.
      */
@@ -2516,7 +2035,7 @@ export namespace CounterpartyCreateParams {
     type: 'sort_code';
   }
 
-  export interface AbaFinancialAddress {
+  export interface AbaFinancialAddressRequest {
     /**
      * Name of the account holder.
      */
@@ -3200,7 +2719,6 @@ export declare namespace Counterparties {
     type CounterpartyRetrieveResponse as CounterpartyRetrieveResponse,
     type CounterpartyUpdateResponse as CounterpartyUpdateResponse,
     type CounterpartyListResponse as CounterpartyListResponse,
-    type CounterpartyBlockResponse as CounterpartyBlockResponse,
     type CounterpartyListResponsesCursorPage as CounterpartyListResponsesCursorPage,
     type CounterpartyCreateParams as CounterpartyCreateParams,
     type CounterpartyUpdateParams as CounterpartyUpdateParams,

package/src/resources/index.ts

@@ -52,7 +52,6 @@ export {
   type CounterpartyRetrieveResponse,
   type CounterpartyUpdateResponse,
   type CounterpartyListResponse,
-  type CounterpartyBlockResponse,
   type CounterpartyCreateParams,
   type CounterpartyUpdateParams,
   type CounterpartyListParams,

package/src/resources/simulations/account-programs.ts

@@ -202,8 +202,8 @@ export interface AccountProgramDrainParams {
    */
   destination:
     | AccountProgramDrainParams.IbanFinancialAddressRequest
-    | AccountProgramDrainParams.SortCodeFinancialAddress
-    | AccountProgramDrainParams.AbaFinancialAddress;
+    | AccountProgramDrainParams.SortCodeFinancialAddressRequest
+    | AccountProgramDrainParams.AbaFinancialAddressRequest;
 }
 
 export namespace AccountProgramDrainParams {
@@ -229,7 +229,7 @@ export namespace AccountProgramDrainParams {
     bic?: string | null;
   }
 
-  export interface SortCodeFinancialAddress {
+  export interface SortCodeFinancialAddressRequest {
     /**
      * Name of the account holder.
      */
@@ -251,7 +251,7 @@ export namespace AccountProgramDrainParams {
     type: 'sort_code';
   }
 
-  export interface AbaFinancialAddress {
+  export interface AbaFinancialAddressRequest {
     /**
      * Name of the account holder.
      */

package/src/resources/simulations/accounts.ts

@@ -185,8 +185,8 @@ export interface AccountDrainParams {
    */
   destination:
     | AccountDrainParams.IbanFinancialAddressRequest
-    | AccountDrainParams.SortCodeFinancialAddress
-    | AccountDrainParams.AbaFinancialAddress;
+    | AccountDrainParams.SortCodeFinancialAddressRequest
+    | AccountDrainParams.AbaFinancialAddressRequest;
 }
 
 export namespace AccountDrainParams {
@@ -212,7 +212,7 @@ export namespace AccountDrainParams {
     bic?: string | null;
   }
 
-  export interface SortCodeFinancialAddress {
+  export interface SortCodeFinancialAddressRequest {
     /**
      * Name of the account holder.
      */
@@ -234,7 +234,7 @@ export namespace AccountDrainParams {
     type: 'sort_code';
   }
 
-  export interface AbaFinancialAddress {
+  export interface AbaFinancialAddressRequest {
     /**
      * Name of the account holder.
      */

package/src/resources/simulations/deposits.ts

@@ -96,8 +96,8 @@ export namespace DepositCreateParams {
      */
     financial_address:
       | Counterparty.IbanFinancialAddressRequest
-      | Counterparty.SortCodeFinancialAddress
-      | Counterparty.AbaFinancialAddress
+      | Counterparty.SortCodeFinancialAddressRequest
+      | Counterparty.AbaFinancialAddressRequest
       | Counterparty.BicFinancialAddressRequest
       | Counterparty.CryptoWalletFinancialAddress;
 
@@ -130,7 +130,7 @@ export namespace DepositCreateParams {
       bic?: string | null;
     }
 
-    export interface SortCodeFinancialAddress {
+    export interface SortCodeFinancialAddressRequest {
       /**
        * Name of the account holder.
        */
@@ -152,7 +152,7 @@ export namespace DepositCreateParams {
       type: 'sort_code';
     }
 
-    export interface AbaFinancialAddress {
+    export interface AbaFinancialAddressRequest {
       /**
        * Name of the account holder.
        */

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.26.0'; // x-release-please-version
+export const VERSION = '0.27.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.26.0";
+export declare const VERSION = "0.27.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.26.0";
+export declare const VERSION = "0.27.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.26.0'; // x-release-please-version
+exports.VERSION = '0.27.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.26.0'; // x-release-please-version
+export const VERSION = '0.27.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map