@augustusbank/typescript-sdk 0.32.0 → 0.34.0

package/src/client.ts

@@ -67,6 +67,7 @@ import {
 } from './resources/conversions';
 import {
   Counterparties,
+  CounterpartyActivateResponse,
   CounterpartyCreateParams,
   CounterpartyCreateResponse,
   CounterpartyListParams,
@@ -90,6 +91,13 @@ import {
   EventRetrieveResponse,
   Events,
 } from './resources/events';
+import {
+  PayoutTrackingEventListParams,
+  PayoutTrackingEventListResponse,
+  PayoutTrackingEventListResponsesCursorPage,
+  PayoutTrackingEventRetrieveResponse,
+  PayoutTrackingEvents,
+} from './resources/payout-tracking-events';
 import {
   PayoutCreateParams,
   PayoutCreateResponse,
@@ -155,6 +163,7 @@ import {
   PayoutReturnedWebhookEvent,
   PayoutSentWebhookEvent,
   PayoutSubmittedWebhookEvent,
+  PayoutTrackingEventCreatedWebhookEvent,
   PingTestWebhookEvent,
   ReturnFailedWebhookEvent,
   ReturnInitiatedWebhookEvent,
@@ -957,6 +966,7 @@ export class Augustus {
 
   webhooks: API.Webhooks = new API.Webhooks(this);
   payouts: API.Payouts = new API.Payouts(this);
+  payoutTrackingEvents: API.PayoutTrackingEvents = new API.PayoutTrackingEvents(this);
   deposits: API.Deposits = new API.Deposits(this);
   simulations: API.Simulations = new API.Simulations(this);
   transactions: API.Transactions = new API.Transactions(this);
@@ -977,6 +987,7 @@ export class Augustus {
 
 Augustus.Webhooks = Webhooks;
 Augustus.Payouts = Payouts;
+Augustus.PayoutTrackingEvents = PayoutTrackingEvents;
 Augustus.Deposits = Deposits;
 Augustus.Simulations = Simulations;
 Augustus.Transactions = Transactions;
@@ -1024,6 +1035,7 @@ export declare namespace Augustus {
     type CounterpartyBlockedWebhookEvent as CounterpartyBlockedWebhookEvent,
     type CounterpartyUnblockedWebhookEvent as CounterpartyUnblockedWebhookEvent,
     type CounterpartyUpdatedWebhookEvent as CounterpartyUpdatedWebhookEvent,
+    type PayoutTrackingEventCreatedWebhookEvent as PayoutTrackingEventCreatedWebhookEvent,
     type PingTestWebhookEvent as PingTestWebhookEvent,
     type UnwrapWebhookEvent as UnwrapWebhookEvent,
   };
@@ -1038,6 +1050,14 @@ export declare namespace Augustus {
     type PayoutListParams as PayoutListParams,
   };
 
+  export {
+    PayoutTrackingEvents as PayoutTrackingEvents,
+    type PayoutTrackingEventRetrieveResponse as PayoutTrackingEventRetrieveResponse,
+    type PayoutTrackingEventListResponse as PayoutTrackingEventListResponse,
+    type PayoutTrackingEventListResponsesCursorPage as PayoutTrackingEventListResponsesCursorPage,
+    type PayoutTrackingEventListParams as PayoutTrackingEventListParams,
+  };
+
   export {
     Deposits as Deposits,
     type DepositRetrieveResponse as DepositRetrieveResponse,
@@ -1112,6 +1132,7 @@ export declare namespace Augustus {
     type CounterpartyRetrieveResponse as CounterpartyRetrieveResponse,
     type CounterpartyUpdateResponse as CounterpartyUpdateResponse,
     type CounterpartyListResponse as CounterpartyListResponse,
+    type CounterpartyActivateResponse as CounterpartyActivateResponse,
     type CounterpartyListResponsesCursorPage as CounterpartyListResponsesCursorPage,
     type CounterpartyCreateParams as CounterpartyCreateParams,
     type CounterpartyUpdateParams as CounterpartyUpdateParams,

package/src/resources/accounts.ts

@@ -147,7 +147,10 @@ export interface AccountCreateResponse {
 
   /**
    * Payment identifiers (e.g. IBAN, account number, wallet address) through which
-   * this account can send or receive funds.
+   * this account can send or receive funds. US dollar accounts that use an ABA
+   * routing number also include a companion `bic` entry for inbound wires: it
+   * carries the bank’s SWIFT code, reuses the same `account_number` as the `aba`
+   * entry, and leaves `local_bank_code` null.
    */
   financial_addresses: Array<
     | AccountCreateResponse.AbaFinancialAddress
@@ -158,7 +161,8 @@ export interface AccountCreateResponse {
   >;
 
   /**
-   * Human-readable label for the account.
+   * Human-readable label for the account. For FBO accounts the label is set to the
+   * account holder’s name.
    */
   label: string;
 
@@ -344,7 +348,10 @@ export interface AccountRetrieveResponse {
 
   /**
    * Payment identifiers (e.g. IBAN, account number, wallet address) through which
-   * this account can send or receive funds.
+   * this account can send or receive funds. US dollar accounts that use an ABA
+   * routing number also include a companion `bic` entry for inbound wires: it
+   * carries the bank’s SWIFT code, reuses the same `account_number` as the `aba`
+   * entry, and leaves `local_bank_code` null.
    */
   financial_addresses: Array<
     | AccountRetrieveResponse.AbaFinancialAddress
@@ -355,7 +362,8 @@ export interface AccountRetrieveResponse {
   >;
 
   /**
-   * Human-readable label for the account.
+   * Human-readable label for the account. For FBO accounts the label is set to the
+   * account holder’s name.
    */
   label: string;
 
@@ -541,7 +549,10 @@ export interface AccountListResponse {
 
   /**
    * Payment identifiers (e.g. IBAN, account number, wallet address) through which
-   * this account can send or receive funds.
+   * this account can send or receive funds. US dollar accounts that use an ABA
+   * routing number also include a companion `bic` entry for inbound wires: it
+   * carries the bank’s SWIFT code, reuses the same `account_number` as the `aba`
+   * entry, and leaves `local_bank_code` null.
    */
   financial_addresses: Array<
     | AccountListResponse.AbaFinancialAddress
@@ -552,7 +563,8 @@ export interface AccountListResponse {
   >;
 
   /**
-   * Human-readable label for the account.
+   * Human-readable label for the account. For FBO accounts the label is set to the
+   * account holder’s name.
    */
   label: string;
 
@@ -738,7 +750,10 @@ export interface AccountCloseResponse {
 
   /**
    * Payment identifiers (e.g. IBAN, account number, wallet address) through which
-   * this account can send or receive funds.
+   * this account can send or receive funds. US dollar accounts that use an ABA
+   * routing number also include a companion `bic` entry for inbound wires: it
+   * carries the bank’s SWIFT code, reuses the same `account_number` as the `aba`
+   * entry, and leaves `local_bank_code` null.
    */
   financial_addresses: Array<
     | AccountCloseResponse.AbaFinancialAddress
@@ -749,7 +764,8 @@ export interface AccountCloseResponse {
   >;
 
   /**
-   * Human-readable label for the account.
+   * Human-readable label for the account. For FBO accounts the label is set to the
+   * account holder’s name.
    */
   label: string;
 
@@ -935,7 +951,10 @@ export interface AccountFreezeResponse {
 
   /**
    * Payment identifiers (e.g. IBAN, account number, wallet address) through which
-   * this account can send or receive funds.
+   * this account can send or receive funds. US dollar accounts that use an ABA
+   * routing number also include a companion `bic` entry for inbound wires: it
+   * carries the bank’s SWIFT code, reuses the same `account_number` as the `aba`
+   * entry, and leaves `local_bank_code` null.
    */
   financial_addresses: Array<
     | AccountFreezeResponse.AbaFinancialAddress
@@ -946,7 +965,8 @@ export interface AccountFreezeResponse {
   >;
 
   /**
-   * Human-readable label for the account.
+   * Human-readable label for the account. For FBO accounts the label is set to the
+   * account holder’s name.
    */
   label: string;
 
@@ -1170,7 +1190,10 @@ export interface AccountUnfreezeResponse {
 
   /**
    * Payment identifiers (e.g. IBAN, account number, wallet address) through which
-   * this account can send or receive funds.
+   * this account can send or receive funds. US dollar accounts that use an ABA
+   * routing number also include a companion `bic` entry for inbound wires: it
+   * carries the bank’s SWIFT code, reuses the same `account_number` as the `aba`
+   * entry, and leaves `local_bank_code` null.
    */
   financial_addresses: Array<
     | AccountUnfreezeResponse.AbaFinancialAddress
@@ -1181,7 +1204,8 @@ export interface AccountUnfreezeResponse {
   >;
 
   /**
-   * Human-readable label for the account.
+   * Human-readable label for the account. For FBO accounts the label is set to the
+   * account holder’s name.
    */
   label: string;
 

package/src/resources/api-keys.ts

@@ -76,6 +76,7 @@ export interface APIKeyIntrospectResponse {
     | 'webhook_deliveries:write'
     | 'transactions:read'
     | 'simulations:write'
+    | 'payout_tracking_events:read'
   >;
 
   /**