@augustusbank/typescript-sdk 0.22.0 → 0.22.1

package/src/resources/transactions.ts

@@ -56,6 +56,13 @@ export interface TransactionRetrieveResponse {
    */
   counterparty: TransactionRetrieveResponse.Counterparty | null;
 
+  /**
+   * ID of the counterparty this transaction is associated with, or null when none
+   * was resolved. Correlates with the counterparties API and a payout's
+   * counterparty_id.
+   */
+  counterparty_id: string | null;
+
   /**
    * Currency code (ISO 4217 or crypto).
    */
@@ -88,11 +95,23 @@ export interface TransactionRetrieveResponse {
    */
   side: 'credit' | 'debit';
 
+  /**
+   * The resource that originated this transaction, or null when it does not map to a
+   * retrievable resource.
+   */
+  source: TransactionRetrieveResponse.Source | null;
+
   /**
    * State of the transaction. Transactions are by definition booked.
    */
   status: 'booked';
 
+  /**
+   * 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 transactions, or null when not known. Only
    * blockchain rails support this field.
@@ -537,6 +556,22 @@ export namespace TransactionRetrieveResponse {
       state: string | null;
     }
   }
+
+  /**
+   * The resource that originated this transaction, or null when it does not map to a
+   * retrievable resource.
+   */
+  export interface Source {
+    /**
+     * Identifier of the originating resource, retrievable on its own endpoint.
+     */
+    id: string;
+
+    /**
+     * Type of the resource that originated this transaction.
+     */
+    type: 'deposit' | 'payout' | 'return';
+  }
 }
 
 export interface TransactionListResponse {
@@ -565,6 +600,13 @@ export interface TransactionListResponse {
    */
   counterparty: TransactionListResponse.Counterparty | null;
 
+  /**
+   * ID of the counterparty this transaction is associated with, or null when none
+   * was resolved. Correlates with the counterparties API and a payout's
+   * counterparty_id.
+   */
+  counterparty_id: string | null;
+
   /**
    * Currency code (ISO 4217 or crypto).
    */
@@ -597,11 +639,23 @@ export interface TransactionListResponse {
    */
   side: 'credit' | 'debit';
 
+  /**
+   * The resource that originated this transaction, or null when it does not map to a
+   * retrievable resource.
+   */
+  source: TransactionListResponse.Source | null;
+
   /**
    * State of the transaction. Transactions are by definition booked.
    */
   status: 'booked';
 
+  /**
+   * 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 transactions, or null when not known. Only
    * blockchain rails support this field.
@@ -1046,6 +1100,22 @@ export namespace TransactionListResponse {
       state: string | null;
     }
   }
+
+  /**
+   * The resource that originated this transaction, or null when it does not map to a
+   * retrievable resource.
+   */
+  export interface Source {
+    /**
+     * Identifier of the originating resource, retrievable on its own endpoint.
+     */
+    id: string;
+
+    /**
+     * Type of the resource that originated this transaction.
+     */
+    type: 'deposit' | 'payout' | 'return';
+  }
 }
 
 export interface TransactionListParams extends CursorPageParams {

package/src/resources/webhook-subscriptions.ts

@@ -14,7 +14,7 @@ export class WebhookSubscriptions extends APIResource {
    * ```ts
    * const webhookSubscription =
    *   await client.webhookSubscriptions.create({
-   *     events: ['payout.paid'],
+   *     events: ['payout.sent'],
    *     url: 'https://sandbox.example.com/webhooks/augustus',
    *   });
    * ```
@@ -133,15 +133,17 @@ export interface WebhookSubscriptionCreateResponse {
    * Event types this subscription receives.
    */
   events: Array<
-    | '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'
@@ -180,15 +182,17 @@ export interface WebhookSubscriptionRetrieveResponse {
    * Event types this subscription receives.
    */
   events: Array<
-    | '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'
@@ -227,15 +231,17 @@ export interface WebhookSubscriptionUpdateResponse {
    * Event types this subscription receives.
    */
   events: Array<
-    | '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'
@@ -274,15 +280,17 @@ export interface WebhookSubscriptionListResponse {
    * Event types this subscription receives.
    */
   events: Array<
-    | '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'
@@ -321,15 +329,17 @@ export interface WebhookSubscriptionDeleteResponse {
    * Event types this subscription receives.
    */
   events: Array<
-    | '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'
@@ -380,15 +390,17 @@ export interface WebhookSubscriptionSendTestEventResponse {
    * 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'
@@ -407,15 +419,17 @@ export interface WebhookSubscriptionCreateParams {
    * Event types to subscribe to. Use ["*"] for all events.
    */
   events: Array<
-    | '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'
@@ -436,15 +450,17 @@ export interface WebhookSubscriptionUpdateParams {
    * events.
    */
   events?: Array<
-    | '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'