@augustusbank/typescript-sdk 0.22.0 → 0.22.1

package/src/resources/accounts.ts

@@ -94,8 +94,12 @@ export class Accounts extends APIResource {
    * );
    * ```
    */
-  retrieveBalance(id: string, options?: RequestOptions): APIPromise<AccountRetrieveBalanceResponse> {
-    return this._client.get(path`/v1/accounts/${id}/balance`, options);
+  retrieveBalance(
+    id: string,
+    query: AccountRetrieveBalanceParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AccountRetrieveBalanceResponse> {
+    return this._client.get(path`/v1/accounts/${id}/balance`, { query, ...options });
   }
 
   /**
@@ -996,10 +1000,7 @@ export interface AccountRetrieveBalanceResponse {
    */
   account_id: string;
 
-  /**
-   * Available balance as a string decimal (e.g. "100.50").
-   */
-  amount: string;
+  amount: AccountRetrieveBalanceResponse.Amount;
 
   /**
    * ISO 8601 UTC timestamp when the balance was retrieved.
@@ -1017,6 +1018,20 @@ export interface AccountRetrieveBalanceResponse {
   type: 'account_balance';
 }
 
+export namespace AccountRetrieveBalanceResponse {
+  export interface Amount {
+    /**
+     * Available balance as a string decimal (e.g. "100.50").
+     */
+    available: string;
+
+    /**
+     * Pending balance as a string decimal (e.g. "7.50").
+     */
+    pending: string;
+  }
+}
+
 export interface AccountUnfreezeResponse {
   /**
    * Unique identifier of the account.
@@ -1234,6 +1249,13 @@ export interface AccountCloseParams {
   reason: 'aml_risk_fraud' | 'client_request';
 }
 
+export interface AccountRetrieveBalanceParams {
+  /**
+   * ISO 8601 UTC timestamp to retrieve balance at.
+   */
+  as_of?: string;
+}
+
 export declare namespace Accounts {
   export {
     type AccountCreateResponse as AccountCreateResponse,
@@ -1247,5 +1269,6 @@ export declare namespace Accounts {
     type AccountCreateParams as AccountCreateParams,
     type AccountListParams as AccountListParams,
     type AccountCloseParams as AccountCloseParams,
+    type AccountRetrieveBalanceParams as AccountRetrieveBalanceParams,
   };
 }

package/src/resources/counterparties.ts

@@ -2774,24 +2774,24 @@ export namespace CounterpartyCreateParams {
       | 'XK';
 
     /**
-     * Primary street address, or null if not recorded.
+     * Primary street address. Optional; omit or send null if not recorded.
      */
-    line_1: string | null;
+    line_1?: string | null;
 
     /**
-     * Secondary street address, or null if not recorded.
+     * Secondary street address. Optional; omit or send null if not recorded.
      */
-    line_2: string | null;
+    line_2?: string | null;
 
     /**
-     * Postal or ZIP code, or null if not recorded.
+     * Postal or ZIP code. Optional; omit or send null if not recorded.
      */
-    postal_code: string | null;
+    postal_code?: string | null;
 
     /**
-     * State, province, or region, or null if not recorded.
+     * State, province, or region. Optional; omit or send null if not recorded.
      */
-    state: string | null;
+    state?: string | null;
   }
 }
 
@@ -3089,24 +3089,24 @@ export namespace CounterpartyUpdateParams {
       | 'XK';
 
     /**
-     * Primary street address, or null if not recorded.
+     * Primary street address. Optional; omit or send null if not recorded.
      */
-    line_1: string | null;
+    line_1?: string | null;
 
     /**
-     * Secondary street address, or null if not recorded.
+     * Secondary street address. Optional; omit or send null if not recorded.
      */
-    line_2: string | null;
+    line_2?: string | null;
 
     /**
-     * Postal or ZIP code, or null if not recorded.
+     * Postal or ZIP code. Optional; omit or send null if not recorded.
      */
-    postal_code: string | null;
+    postal_code?: string | null;
 
     /**
-     * State, province, or region, or null if not recorded.
+     * State, province, or region. Optional; omit or send null if not recorded.
      */
-    state: string | null;
+    state?: string | null;
   }
 }
 

package/src/resources/deposits.ts

@@ -90,6 +90,12 @@ export interface DepositRetrieveResponse {
    */
   status: 'settled';
 
+  /**
+   * Reference used to track the payment across the payment network, such as the UETR
+   * for SWIFT payments.
+   */
+  tracking_reference: string | null;
+
   /**
    * Transaction hash for crypto deposits, or null when not known. Only blockchain
    * rails support this field.
@@ -171,6 +177,12 @@ export interface DepositListResponse {
    */
   status: 'settled';
 
+  /**
+   * Reference used to track the payment across the payment network, such as the UETR
+   * for SWIFT payments.
+   */
+  tracking_reference: string | null;
+
   /**
    * Transaction hash for crypto deposits, or null when not known. Only blockchain
    * rails support this field.

package/src/resources/events.ts

@@ -55,15 +55,17 @@ export interface EventRetrieveResponse {
    * Event type.
    */
   event_type:
-    | 'payout.created'
     | 'payout.initiated'
-    | 'payout.paid'
+    | 'payout.submitted'
+    | 'payout.sent'
     | 'payout.failed'
+    | 'payout.returned'
     | 'return.initiated'
-    | 'return.paid'
+    | 'return.submitted'
+    | 'return.sent'
     | 'return.failed'
     | 'return.returned'
-    | 'deposit.received'
+    | 'deposit.settled'
     | 'conversion.created'
     | 'conversion.completed'
     | 'conversion.failed'
@@ -104,15 +106,17 @@ export interface EventListResponse {
    * Event type.
    */
   event_type:
-    | 'payout.created'
     | 'payout.initiated'
-    | 'payout.paid'
+    | 'payout.submitted'
+    | 'payout.sent'
     | 'payout.failed'
+    | 'payout.returned'
     | 'return.initiated'
-    | 'return.paid'
+    | 'return.submitted'
+    | 'return.sent'
     | 'return.failed'
     | 'return.returned'
-    | 'deposit.received'
+    | 'deposit.settled'
     | 'conversion.created'
     | 'conversion.completed'
     | 'conversion.failed'
@@ -133,15 +137,17 @@ export interface EventListParams extends CursorPageParams {
    * Filter by event type.
    */
   event_type?:
-    | 'payout.created'
     | 'payout.initiated'
-    | 'payout.paid'
+    | 'payout.submitted'
+    | 'payout.sent'
     | 'payout.failed'
+    | 'payout.returned'
     | 'return.initiated'
-    | 'return.paid'
+    | 'return.submitted'
+    | 'return.sent'
     | 'return.failed'
     | 'return.returned'
-    | 'deposit.received'
+    | 'deposit.settled'
     | 'conversion.created'
     | 'conversion.completed'
     | 'conversion.failed'

package/src/resources/index.ts

@@ -19,6 +19,7 @@ export {
   type AccountProgramListResponse,
   type AccountProgramRetrieveBalanceResponse,
   type AccountProgramListParams,
+  type AccountProgramRetrieveBalanceParams,
   type AccountProgramListResponsesCursorPage,
 } from './account-programs';
 export {
@@ -33,6 +34,7 @@ export {
   type AccountCreateParams,
   type AccountListParams,
   type AccountCloseParams,
+  type AccountRetrieveBalanceParams,
   type AccountListResponsesCursorPage,
 } from './accounts';
 export {
@@ -121,15 +123,17 @@ export {
 } from './webhook-subscriptions';
 export {
   Webhooks,
-  type PayoutCreatedWebhookEvent,
   type PayoutInitiatedWebhookEvent,
-  type PayoutPaidWebhookEvent,
+  type PayoutSubmittedWebhookEvent,
+  type PayoutSentWebhookEvent,
   type PayoutFailedWebhookEvent,
+  type PayoutReturnedWebhookEvent,
   type ReturnInitiatedWebhookEvent,
-  type ReturnPaidWebhookEvent,
+  type ReturnSubmittedWebhookEvent,
+  type ReturnSentWebhookEvent,
   type ReturnFailedWebhookEvent,
   type ReturnReturnedWebhookEvent,
-  type DepositReceivedWebhookEvent,
+  type DepositSettledWebhookEvent,
   type ConversionCreatedWebhookEvent,
   type ConversionCompletedWebhookEvent,
   type ConversionFailedWebhookEvent,