@augustusbank/typescript-sdk 0.32.0 → 0.34.0

package/src/resources/webhook-subscriptions.ts

@@ -155,6 +155,7 @@ export interface WebhookSubscriptionCreateResponse {
     | 'counterparty.blocked'
     | 'counterparty.unblocked'
     | 'counterparty.updated'
+    | 'payout_tracking_event.created'
   >;
 
   /**
@@ -217,6 +218,7 @@ export interface WebhookSubscriptionRetrieveResponse {
     | 'counterparty.blocked'
     | 'counterparty.unblocked'
     | 'counterparty.updated'
+    | 'payout_tracking_event.created'
   >;
 
   /**
@@ -279,6 +281,7 @@ export interface WebhookSubscriptionUpdateResponse {
     | 'counterparty.blocked'
     | 'counterparty.unblocked'
     | 'counterparty.updated'
+    | 'payout_tracking_event.created'
   >;
 
   /**
@@ -341,6 +344,7 @@ export interface WebhookSubscriptionListResponse {
     | 'counterparty.blocked'
     | 'counterparty.unblocked'
     | 'counterparty.updated'
+    | 'payout_tracking_event.created'
   >;
 
   /**
@@ -403,6 +407,7 @@ export interface WebhookSubscriptionDeleteResponse {
     | 'counterparty.blocked'
     | 'counterparty.unblocked'
     | 'counterparty.updated'
+    | 'payout_tracking_event.created'
   >;
 
   /**
@@ -477,6 +482,7 @@ export interface WebhookSubscriptionSendTestEventResponse {
     | 'counterparty.blocked'
     | 'counterparty.unblocked'
     | 'counterparty.updated'
+    | 'payout_tracking_event.created'
     | 'ping.test';
 
   /**
@@ -512,6 +518,7 @@ export interface WebhookSubscriptionCreateParams {
     | 'counterparty.blocked'
     | 'counterparty.unblocked'
     | 'counterparty.updated'
+    | 'payout_tracking_event.created'
     | '*'
   >;
 
@@ -556,6 +563,7 @@ export interface WebhookSubscriptionUpdateParams {
     | 'counterparty.blocked'
     | 'counterparty.unblocked'
     | 'counterparty.updated'
+    | 'payout_tracking_event.created'
     | '*'
   > | null;
 

package/src/resources/webhooks.ts

@@ -93,9 +93,7 @@ export namespace PayoutInitiatedWebhookEvent {
     metadata: { [key: string]: string };
 
     /**
-     * Purpose of the payout. Use an ISO 20022 external purpose code unless the
-     * beneficiary bank country requires a national code. Only supported on fedwire and
-     * swift payouts.
+     * ISO 20022 external purpose code. Only supported on fedwire and swift payouts.
      */
     purpose_code:
       | 'BKDF'
@@ -426,12 +424,6 @@ export namespace PayoutInitiatedWebhookEvent {
       | 'DEPD'
       | 'RETL'
       | 'DEBT'
-      | 'CAP'
-      | 'GDS'
-      | 'SRV'
-      | 'CAC'
-      | 'FTF'
-      | (string & {})
       | null;
 
     /**
@@ -619,9 +611,7 @@ export namespace PayoutSubmittedWebhookEvent {
     metadata: { [key: string]: string };
 
     /**
-     * Purpose of the payout. Use an ISO 20022 external purpose code unless the
-     * beneficiary bank country requires a national code. Only supported on fedwire and
-     * swift payouts.
+     * ISO 20022 external purpose code. Only supported on fedwire and swift payouts.
      */
     purpose_code:
       | 'BKDF'
@@ -952,12 +942,6 @@ export namespace PayoutSubmittedWebhookEvent {
       | 'DEPD'
       | 'RETL'
       | 'DEBT'
-      | 'CAP'
-      | 'GDS'
-      | 'SRV'
-      | 'CAC'
-      | 'FTF'
-      | (string & {})
       | null;
 
     /**
@@ -1145,9 +1129,7 @@ export namespace PayoutSentWebhookEvent {
     metadata: { [key: string]: string };
 
     /**
-     * Purpose of the payout. Use an ISO 20022 external purpose code unless the
-     * beneficiary bank country requires a national code. Only supported on fedwire and
-     * swift payouts.
+     * ISO 20022 external purpose code. Only supported on fedwire and swift payouts.
      */
     purpose_code:
       | 'BKDF'
@@ -1478,12 +1460,6 @@ export namespace PayoutSentWebhookEvent {
       | 'DEPD'
       | 'RETL'
       | 'DEBT'
-      | 'CAP'
-      | 'GDS'
-      | 'SRV'
-      | 'CAC'
-      | 'FTF'
-      | (string & {})
       | null;
 
     /**
@@ -1671,9 +1647,7 @@ export namespace PayoutFailedWebhookEvent {
     metadata: { [key: string]: string };
 
     /**
-     * Purpose of the payout. Use an ISO 20022 external purpose code unless the
-     * beneficiary bank country requires a national code. Only supported on fedwire and
-     * swift payouts.
+     * ISO 20022 external purpose code. Only supported on fedwire and swift payouts.
      */
     purpose_code:
       | 'BKDF'
@@ -2004,12 +1978,6 @@ export namespace PayoutFailedWebhookEvent {
       | 'DEPD'
       | 'RETL'
       | 'DEBT'
-      | 'CAP'
-      | 'GDS'
-      | 'SRV'
-      | 'CAC'
-      | 'FTF'
-      | (string & {})
       | null;
 
     /**
@@ -2197,9 +2165,7 @@ export namespace PayoutReturnedWebhookEvent {
     metadata: { [key: string]: string };
 
     /**
-     * Purpose of the payout. Use an ISO 20022 external purpose code unless the
-     * beneficiary bank country requires a national code. Only supported on fedwire and
-     * swift payouts.
+     * ISO 20022 external purpose code. Only supported on fedwire and swift payouts.
      */
     purpose_code:
       | 'BKDF'
@@ -2530,12 +2496,6 @@ export namespace PayoutReturnedWebhookEvent {
       | 'DEPD'
       | 'RETL'
       | 'DEBT'
-      | 'CAP'
-      | 'GDS'
-      | 'SRV'
-      | 'CAC'
-      | 'FTF'
-      | (string & {})
       | null;
 
     /**
@@ -11746,9 +11706,9 @@ export namespace CounterpartyPendingWebhookEvent {
     email: string | null;
 
     /**
-     * Whether the counterparty is a business or an individual.
+     * Classification of the counterparty.
      */
-    entity_type: 'business' | 'individual';
+    entity_type: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
 
     /**
      * Financial address of the counterparty.
@@ -12279,9 +12239,9 @@ export namespace CounterpartyActiveWebhookEvent {
     email: string | null;
 
     /**
-     * Whether the counterparty is a business or an individual.
+     * Classification of the counterparty.
      */
-    entity_type: 'business' | 'individual';
+    entity_type: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
 
     /**
      * Financial address of the counterparty.
@@ -12812,9 +12772,9 @@ export namespace CounterpartyRejectedWebhookEvent {
     email: string | null;
 
     /**
-     * Whether the counterparty is a business or an individual.
+     * Classification of the counterparty.
      */
-    entity_type: 'business' | 'individual';
+    entity_type: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
 
     /**
      * Financial address of the counterparty.
@@ -13345,9 +13305,9 @@ export namespace CounterpartyBlockedWebhookEvent {
     email: string | null;
 
     /**
-     * Whether the counterparty is a business or an individual.
+     * Classification of the counterparty.
      */
-    entity_type: 'business' | 'individual';
+    entity_type: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
 
     /**
      * Financial address of the counterparty.
@@ -13878,9 +13838,9 @@ export namespace CounterpartyUnblockedWebhookEvent {
     email: string | null;
 
     /**
-     * Whether the counterparty is a business or an individual.
+     * Classification of the counterparty.
      */
-    entity_type: 'business' | 'individual';
+    entity_type: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
 
     /**
      * Financial address of the counterparty.
@@ -14411,9 +14371,9 @@ export namespace CounterpartyUpdatedWebhookEvent {
     email: string | null;
 
     /**
-     * Whether the counterparty is a business or an individual.
+     * Classification of the counterparty.
      */
-    entity_type: 'business' | 'individual';
+    entity_type: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
 
     /**
      * Financial address of the counterparty.
@@ -14891,6 +14851,287 @@ export namespace CounterpartyUpdatedWebhookEvent {
   }
 }
 
+export interface PayoutTrackingEventCreatedWebhookEvent {
+  /**
+   * Unique identifier for the event. Stable across retries.
+   */
+  id: string;
+
+  /**
+   * API version the payload was rendered at. Stable across retries and redeliveries.
+   */
+  api_version: string;
+
+  /**
+   * ISO 8601 UTC timestamp when the event was created.
+   */
+  date: string;
+
+  /**
+   * Full resource snapshot at the time of the event.
+   */
+  payload: PayoutTrackingEventCreatedWebhookEvent.Payload;
+
+  /**
+   * Event type in resource.action format.
+   */
+  type: 'payout_tracking_event.created';
+}
+
+export namespace PayoutTrackingEventCreatedWebhookEvent {
+  /**
+   * Full resource snapshot at the time of the event.
+   */
+  export interface Payload {
+    /**
+     * Unique identifier of the tracking event.
+     */
+    id: string;
+
+    /**
+     * Amount credited to the beneficiary. Set only on a credited event, otherwise
+     * null.
+     */
+    beneficiary_amount: Payload.BeneficiaryAmount | null;
+
+    /**
+     * ISO 8601 UTC timestamp when Augustus recorded the event.
+     */
+    created_at: string;
+
+    /**
+     * Fee deducted at this step. Null when none was reported.
+     */
+    fee: Payload.Fee | null;
+
+    /**
+     * Institution that sent the payout in this step. Null when unknown or not reported
+     * by the source.
+     */
+    from_institution: Payload.FromInstitution | null;
+
+    /**
+     * Institution holding the payout after this step: the bank that received it, or
+     * the bank that reported this status. Null when unknown.
+     */
+    institution: Payload.Institution | null;
+
+    /**
+     * Whether Augustus considers delivery finished. A credit reported by a bank that
+     * passes the payout on is a forwarded step and is not terminal. A later event,
+     * such as returned, can still follow.
+     */
+    is_terminal: boolean;
+
+    /**
+     * Normalized point in the payout journey. New values may be added.
+     */
+    milestone:
+      | 'initiated'
+      | 'submitted'
+      | 'sent'
+      | 'failed'
+      | 'returned'
+      | 'accepted'
+      | 'settled'
+      | 'forwarded'
+      | 'credited'
+      | 'rejected'
+      | 'returning'
+      | 'visibility_lost'
+      | 'other';
+
+    /**
+     * Raw network status. Null when the step has none.
+     */
+    network_status: Payload.NetworkStatus | null;
+
+    /**
+     * ISO 8601 UTC timestamp when the step happened. Null when the source has no
+     * timestamp. Can be out of order with sequence.
+     */
+    occurred_at: string | null;
+
+    /**
+     * ID of the payout this event belongs to.
+     */
+    payout_id: string;
+
+    /**
+     * How far Augustus can follow the payout: end_to_end when the rail confirms the
+     * beneficiary credit, network when it only confirms settlement. New values may be
+     * added.
+     */
+    scope: 'network' | 'end_to_end';
+
+    /**
+     * Gap-free counter per payout, in the order Augustus recorded the events. A gap
+     * means you missed a recorded event, such as a dropped webhook. A sequence without
+     * gaps does not mean every network step was observed.
+     */
+    sequence: number;
+
+    /**
+     * Where Augustus learned this step: augustus for steps Augustus records itself,
+     * swift_gpi for SWIFT gpi statuses, other for any other source. New values may be
+     * added.
+     */
+    source: 'augustus' | 'swift_gpi' | 'other';
+
+    /**
+     * Reason for the current state. Null when none applies.
+     */
+    status_reason: Payload.StatusReason | null;
+
+    /**
+     * Resource type discriminator.
+     */
+    type: 'payout_tracking_event';
+  }
+
+  export namespace Payload {
+    /**
+     * Amount credited to the beneficiary. Set only on a credited event, otherwise
+     * null.
+     */
+    export interface BeneficiaryAmount {
+      /**
+       * Credited amount as a string decimal (e.g. "100.50").
+       */
+      amount: string;
+
+      /**
+       * ISO 4217 currency code of the credited amount.
+       */
+      currency: string;
+    }
+
+    /**
+     * Fee deducted at this step. Null when none was reported.
+     */
+    export interface Fee {
+      /**
+       * Fee amount as a string decimal (e.g. "10.00").
+       */
+      amount: string;
+
+      /**
+       * Who bears the charges under the payment charge agreement: debtor (OUR), creditor
+       * (BEN), shared (SHA), or other for any other agreement. New values may be added.
+       */
+      borne_by: 'debtor' | 'creditor' | 'shared' | 'other';
+
+      /**
+       * ISO 4217 currency code of the fee.
+       */
+      currency: string;
+    }
+
+    /**
+     * Institution that sent the payout in this step. Null when unknown or not reported
+     * by the source.
+     */
+    export interface FromInstitution {
+      /**
+       * Identifier of the institution, typed by scheme. Null when only its name is
+       * known.
+       */
+      identifier: FromInstitution.Identifier | null;
+
+      /**
+       * Name of the institution. Null when unknown.
+       */
+      name: string | null;
+    }
+
+    export namespace FromInstitution {
+      /**
+       * Identifier of the institution, typed by scheme. Null when only its name is
+       * known.
+       */
+      export interface Identifier {
+        /**
+         * Identifier scheme. Only bic today.
+         */
+        type: 'bic';
+
+        /**
+         * ISO 9362 Bank Identifier Code, always 11 characters. An 8-character BIC is
+         * padded with the XXX head office branch code.
+         */
+        value: string;
+      }
+    }
+
+    /**
+     * Institution holding the payout after this step: the bank that received it, or
+     * the bank that reported this status. Null when unknown.
+     */
+    export interface Institution {
+      /**
+       * Identifier of the institution, typed by scheme. Null when only its name is
+       * known.
+       */
+      identifier: Institution.Identifier | null;
+
+      /**
+       * Name of the institution. Null when unknown.
+       */
+      name: string | null;
+    }
+
+    export namespace Institution {
+      /**
+       * Identifier of the institution, typed by scheme. Null when only its name is
+       * known.
+       */
+      export interface Identifier {
+        /**
+         * Identifier scheme. Only bic today.
+         */
+        type: 'bic';
+
+        /**
+         * ISO 9362 Bank Identifier Code, always 11 characters. An 8-character BIC is
+         * padded with the XXX head office branch code.
+         */
+        value: string;
+      }
+    }
+
+    /**
+     * Raw network status. Null when the step has none.
+     */
+    export interface NetworkStatus {
+      /**
+       * Status code reported by the network, such as ACSP, ACSC, ACCC or RJCT.
+       */
+      code: string;
+
+      /**
+       * Reason code for the status, such as G000. Null when the network reports none.
+       */
+      reason_code: string | null;
+    }
+
+    /**
+     * Reason for the current state. Null when none applies.
+     */
+    export interface StatusReason {
+      /**
+       * Normalized reason code assigned by Augustus. Current codes: `CREDIT_PENDING`
+       * (the beneficiary bank reported the credit as pending). New codes may be added.
+       */
+      code: string;
+
+      /**
+       * Explanation of the reason code, written by Augustus.
+       */
+      description: string;
+    }
+  }
+}
+
 export interface PingTestWebhookEvent {
   /**
    * Unique identifier for the event. Stable across retries.
@@ -14974,6 +15215,7 @@ export type UnwrapWebhookEvent =
   | CounterpartyBlockedWebhookEvent
   | CounterpartyUnblockedWebhookEvent
   | CounterpartyUpdatedWebhookEvent
+  | PayoutTrackingEventCreatedWebhookEvent
   | PingTestWebhookEvent;
 
 export declare namespace Webhooks {
@@ -15000,6 +15242,7 @@ export declare namespace Webhooks {
     type CounterpartyBlockedWebhookEvent as CounterpartyBlockedWebhookEvent,
     type CounterpartyUnblockedWebhookEvent as CounterpartyUnblockedWebhookEvent,
     type CounterpartyUpdatedWebhookEvent as CounterpartyUpdatedWebhookEvent,
+    type PayoutTrackingEventCreatedWebhookEvent as PayoutTrackingEventCreatedWebhookEvent,
     type PingTestWebhookEvent as PingTestWebhookEvent,
     type UnwrapWebhookEvent as UnwrapWebhookEvent,
   };

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.32.0'; // x-release-please-version
+export const VERSION = '0.34.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.32.0";
+export declare const VERSION = "0.34.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.32.0'; // x-release-please-version
+exports.VERSION = '0.34.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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