@augustusbank/typescript-sdk 0.33.0 → 0.35.0

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;
 
     /**
@@ -3607,7 +3567,7 @@ export namespace ConversionCreatedWebhookEvent {
     /**
      * Current status of the conversion.
      */
-    status: 'pending' | 'completed' | 'failed';
+    status: 'initiated' | 'pending' | 'completed' | 'failed';
 
     /**
      * ID of the target account, or null.
@@ -3698,7 +3658,7 @@ export namespace ConversionCompletedWebhookEvent {
     /**
      * Current status of the conversion.
      */
-    status: 'pending' | 'completed' | 'failed';
+    status: 'initiated' | 'pending' | 'completed' | 'failed';
 
     /**
      * ID of the target account, or null.
@@ -3789,7 +3749,7 @@ export namespace ConversionFailedWebhookEvent {
     /**
      * Current status of the conversion.
      */
-    status: 'pending' | 'completed' | 'failed';
+    status: 'initiated' | 'pending' | 'completed' | 'failed';
 
     /**
      * ID of the target account, or null.
@@ -5158,11 +5118,14 @@ export namespace AccountHolderActiveWebhookEvent {
 
       /**
        * Business registration number: type "ein" (Employer Identification Number, format
-       * ##-#######) or "ssn" (Social Security Number, format ###-##-####).
+       * ##-#######), "ssn" (Social Security Number, format ###-##-####), or "other" (any
+       * other registration number, 1-32 characters, non-US businesses only, with a
+       * required `description` of what the number is).
        */
       registration_number:
         | V1BusinessBeneficiaryDataResponse.V1EinIdentification
-        | V1BusinessBeneficiaryDataResponse.V1SsnIdentification;
+        | V1BusinessBeneficiaryDataResponse.V1SsnIdentification
+        | V1BusinessBeneficiaryDataResponse.V1OtherRegistrationNumber;
 
       /**
        * State or subdivision where the business is incorporated.
@@ -7749,6 +7712,21 @@ export namespace AccountHolderActiveWebhookEvent {
 
         value: string;
       }
+
+      export interface V1OtherRegistrationNumber {
+        /**
+         * A short explanation of what this number is and which authority issued it.
+         */
+        description: string;
+
+        type: 'other';
+
+        /**
+         * The registration number, 1-32 characters. Any characters are allowed, but at
+         * least one must be a letter or digit.
+         */
+        value: string;
+      }
     }
   }
 }
@@ -9098,11 +9076,14 @@ export namespace AccountHolderClosedWebhookEvent {
 
       /**
        * Business registration number: type "ein" (Employer Identification Number, format
-       * ##-#######) or "ssn" (Social Security Number, format ###-##-####).
+       * ##-#######), "ssn" (Social Security Number, format ###-##-####), or "other" (any
+       * other registration number, 1-32 characters, non-US businesses only, with a
+       * required `description` of what the number is).
        */
       registration_number:
         | V1BusinessBeneficiaryDataResponse.V1EinIdentification
-        | V1BusinessBeneficiaryDataResponse.V1SsnIdentification;
+        | V1BusinessBeneficiaryDataResponse.V1SsnIdentification
+        | V1BusinessBeneficiaryDataResponse.V1OtherRegistrationNumber;
 
       /**
        * State or subdivision where the business is incorporated.
@@ -11689,6 +11670,21 @@ export namespace AccountHolderClosedWebhookEvent {
 
         value: string;
       }
+
+      export interface V1OtherRegistrationNumber {
+        /**
+         * A short explanation of what this number is and which authority issued it.
+         */
+        description: string;
+
+        type: 'other';
+
+        /**
+         * The registration number, 1-32 characters. Any characters are allowed, but at
+         * least one must be a letter or digit.
+         */
+        value: string;
+      }
     }
   }
 }
@@ -14945,13 +14941,21 @@ export namespace PayoutTrackingEventCreatedWebhookEvent {
     fee: Payload.Fee | null;
 
     /**
-     * Institution that acted on or reported this step. Null when unknown.
+     * 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 later event, such as returned,
-     * can still follow.
+     * 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;
 
@@ -15060,18 +15064,62 @@ export namespace PayoutTrackingEventCreatedWebhookEvent {
     }
 
     /**
-     * Institution that acted on or reported this step. Null when unknown.
+     * 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.
+       * 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.
        */
-      identifier: Institution.Identifier;
+      name: string | null;
     }
 
     export namespace Institution {
       /**
-       * Identifier of the institution, typed by scheme.
+       * Identifier of the institution, typed by scheme. Null when only its name is
+       * known.
        */
       export interface Identifier {
         /**
@@ -15080,7 +15128,8 @@ export namespace PayoutTrackingEventCreatedWebhookEvent {
         type: 'bic';
 
         /**
-         * ISO 9362 Bank Identifier Code (8 or 11 characters).
+         * ISO 9362 Bank Identifier Code, always 11 characters. An 8-character BIC is
+         * padded with the XXX head office branch code.
          */
         value: string;
       }
@@ -15106,7 +15155,8 @@ export namespace PayoutTrackingEventCreatedWebhookEvent {
      */
     export interface StatusReason {
       /**
-       * Normalized reason code assigned by Augustus. New codes may be added.
+       * 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;
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.33.0'; // x-release-please-version
+export const VERSION = '0.35.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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