increase 0.419.0 → 0.431.0

package/src/resources/check-transfers.ts

@@ -337,11 +337,6 @@ export namespace CheckTransfer {
    * What object created the transfer, either via the API or the dashboard.
    */
   export interface CreatedBy {
-    /**
-     * If present, details about the API key that created the transfer.
-     */
-    api_key: CreatedBy.APIKey | null;
-
     /**
      * The type of object that created this transfer.
      *
@@ -353,15 +348,20 @@ export namespace CheckTransfer {
      */
     category: 'api_key' | 'oauth_application' | 'user';
 
+    /**
+     * If present, details about the API key that created the transfer.
+     */
+    api_key?: CreatedBy.APIKey | null;
+
     /**
      * If present, details about the OAuth Application that created the transfer.
      */
-    oauth_application: CreatedBy.OAuthApplication | null;
+    oauth_application?: CreatedBy.OAuthApplication | null;
 
     /**
      * If present, details about the User that created the transfer.
      */
-    user: CreatedBy.User | null;
+    user?: CreatedBy.User | null;
   }
 
   export namespace CreatedBy {

package/src/resources/declined-transactions.ts

@@ -130,18 +130,6 @@ export namespace DeclinedTransaction {
    * as deprecated and will be removed in the future.
    */
   export interface Source {
-    /**
-     * An ACH Decline object. This field will be present in the JSON response if and
-     * only if `category` is equal to `ach_decline`.
-     */
-    ach_decline: Source.ACHDecline | null;
-
-    /**
-     * A Card Decline object. This field will be present in the JSON response if and
-     * only if `category` is equal to `card_decline`.
-     */
-    card_decline: Source.CardDecline | null;
-
     /**
      * The type of the resource. We may add additional possible values for this enum
      * over time; your application should be able to handle such additions gracefully.
@@ -173,43 +161,55 @@ export namespace DeclinedTransaction {
       | 'check_deposit_rejection'
       | 'other';
 
+    /**
+     * An ACH Decline object. This field will be present in the JSON response if and
+     * only if `category` is equal to `ach_decline`.
+     */
+    ach_decline?: Source.ACHDecline | null;
+
+    /**
+     * A Card Decline object. This field will be present in the JSON response if and
+     * only if `category` is equal to `card_decline`.
+     */
+    card_decline?: Source.CardDecline | null;
+
     /**
      * A Check Decline object. This field will be present in the JSON response if and
      * only if `category` is equal to `check_decline`.
      */
-    check_decline: Source.CheckDecline | null;
+    check_decline?: Source.CheckDecline | null;
 
     /**
      * A Check Deposit Rejection object. This field will be present in the JSON
      * response if and only if `category` is equal to `check_deposit_rejection`.
      */
-    check_deposit_rejection: Source.CheckDepositRejection | null;
+    check_deposit_rejection?: Source.CheckDepositRejection | null;
 
     /**
      * An Inbound FedNow Transfer Decline object. This field will be present in the
      * JSON response if and only if `category` is equal to
      * `inbound_fednow_transfer_decline`.
      */
-    inbound_fednow_transfer_decline: Source.InboundFednowTransferDecline | null;
+    inbound_fednow_transfer_decline?: Source.InboundFednowTransferDecline | null;
 
     /**
      * An Inbound Real-Time Payments Transfer Decline object. This field will be
      * present in the JSON response if and only if `category` is equal to
      * `inbound_real_time_payments_transfer_decline`.
      */
-    inbound_real_time_payments_transfer_decline: Source.InboundRealTimePaymentsTransferDecline | null;
+    inbound_real_time_payments_transfer_decline?: Source.InboundRealTimePaymentsTransferDecline | null;
 
     /**
      * If the category of this Transaction source is equal to `other`, this field will
      * contain an empty object, otherwise it will contain null.
      */
-    other: Source.Other | null;
+    other?: Source.Other | null;
 
     /**
      * A Wire Decline object. This field will be present in the JSON response if and
      * only if `category` is equal to `wire_decline`.
      */
-    wire_decline: Source.WireDecline | null;
+    wire_decline?: Source.WireDecline | null;
 
     [k: string]: unknown;
   }

package/src/resources/digital-card-profiles.ts

@@ -184,6 +184,8 @@ export interface DigitalCardProfile {
    * `digital_card_profile`.
    */
   type: 'digital_card_profile';
+
+  [k: string]: unknown;
 }
 
 export namespace DigitalCardProfile {

package/src/resources/entities.ts

@@ -350,6 +350,8 @@ export interface Entity {
    * `entity`.
    */
   type: 'entity';
+
+  [k: string]: unknown;
 }
 
 export namespace Entity {
@@ -1215,7 +1217,7 @@ export interface EntityCreateParams {
   natural_person?: EntityCreateParams.NaturalPerson;
 
   /**
-   * An assessment of the entity’s potential risk of involvement in financial crimes,
+   * An assessment of the entity's potential risk of involvement in financial crimes,
    * such as money laundering.
    */
   risk_rating?: EntityCreateParams.RiskRating;
@@ -2077,7 +2079,7 @@ export namespace EntityCreateParams {
   }
 
   /**
-   * An assessment of the entity’s potential risk of involvement in financial crimes,
+   * An assessment of the entity's potential risk of involvement in financial crimes,
    * such as money laundering.
    */
   export interface RiskRating {

package/src/resources/exports.ts

@@ -153,18 +153,6 @@ export interface Export {
    */
   entity_csv: Export.EntityCsv | null;
 
-  /**
-   * A URL at which the Export's file can be downloaded. This will be present when
-   * the Export's status transitions to `complete`.
-   */
-  file_download_url: string | null;
-
-  /**
-   * The File containing the contents of the Export. This will be present when the
-   * Export's status transitions to `complete`.
-   */
-  file_id: string | null;
-
   /**
    * Details of the Form 1099-INT export. This field will be present when the
    * `category` is equal to `form_1099_int`.
@@ -190,6 +178,12 @@ export interface Export {
    */
   idempotency_key: string | null;
 
+  /**
+   * The result of the Export. This will be present when the Export's status
+   * transitions to `complete`.
+   */
+  result: Export.Result | null;
+
   /**
    * The status of the Export.
    *
@@ -217,6 +211,8 @@ export interface Export {
    * is equal to `vendor_csv`.
    */
   vendor_csv: Export.VendorCsv | null;
+
+  [k: string]: unknown;
 }
 
 export namespace Export {
@@ -426,6 +422,17 @@ export namespace Export {
     account_number_id: string;
   }
 
+  /**
+   * The result of the Export. This will be present when the Export's status
+   * transitions to `complete`.
+   */
+  export interface Result {
+    /**
+     * The File containing the contents of the Export.
+     */
+    file_id: string;
+  }
+
   /**
    * Details of the transaction CSV export. This field will be present when the
    * `category` is equal to `transaction_csv`.
@@ -806,10 +813,48 @@ export namespace ExportCreateParams {
 }
 
 export interface ExportListParams extends PageParams {
-  category?: ExportListParams.Category;
+  /**
+   * Filter Exports for those with the specified category.
+   *
+   * - `account_statement_ofx` - Export an Open Financial Exchange (OFX) file of
+   *   transactions and balances for a given time range and Account.
+   * - `account_statement_bai2` - Export a BAI2 file of transactions and balances for
+   *   a given date and optional Account.
+   * - `transaction_csv` - Export a CSV of all transactions for a given time range.
+   * - `balance_csv` - Export a CSV of account balances for the dates in a given
+   *   range.
+   * - `bookkeeping_account_balance_csv` - Export a CSV of bookkeeping account
+   *   balances for the dates in a given range.
+   * - `entity_csv` - Export a CSV of entities with a given status.
+   * - `vendor_csv` - Export a CSV of vendors added to the third-party risk
+   *   management dashboard.
+   * - `dashboard_table_csv` - Certain dashboard tables are available as CSV exports.
+   *   This export cannot be created via the API.
+   * - `account_verification_letter` - A PDF of an account verification letter.
+   * - `funding_instructions` - A PDF of funding instructions.
+   * - `form_1099_int` - A PDF of an Internal Revenue Service Form 1099-INT.
+   * - `form_1099_misc` - A PDF of an Internal Revenue Service Form 1099-MISC.
+   */
+  category?:
+    | 'account_statement_ofx'
+    | 'account_statement_bai2'
+    | 'transaction_csv'
+    | 'balance_csv'
+    | 'bookkeeping_account_balance_csv'
+    | 'entity_csv'
+    | 'vendor_csv'
+    | 'dashboard_table_csv'
+    | 'account_verification_letter'
+    | 'funding_instructions'
+    | 'form_1099_int'
+    | 'form_1099_misc';
 
   created_at?: ExportListParams.CreatedAt;
 
+  form_1099_int?: ExportListParams.Form1099Int;
+
+  form_1099_misc?: ExportListParams.Form1099Misc;
+
   /**
    * Filter records to the one with the specified `idempotency_key` you chose for
    * that object. This value is unique across Increase and is used to ensure that a
@@ -822,28 +867,6 @@ export interface ExportListParams extends PageParams {
 }
 
 export namespace ExportListParams {
-  export interface Category {
-    /**
-     * Filter Exports for those with the specified category or categories. For GET
-     * requests, this should be encoded as a comma-delimited string, such as
-     * `?in=one,two,three`.
-     */
-    in?: Array<
-      | 'account_statement_ofx'
-      | 'account_statement_bai2'
-      | 'transaction_csv'
-      | 'balance_csv'
-      | 'bookkeeping_account_balance_csv'
-      | 'entity_csv'
-      | 'vendor_csv'
-      | 'dashboard_table_csv'
-      | 'account_verification_letter'
-      | 'funding_instructions'
-      | 'form_1099_int'
-      | 'form_1099_misc'
-    >;
-  }
-
   export interface CreatedAt {
     /**
      * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
@@ -870,6 +893,20 @@ export namespace ExportListParams {
     on_or_before?: string;
   }
 
+  export interface Form1099Int {
+    /**
+     * Filter Form 1099-INT Exports to those for the specified Account.
+     */
+    account_id?: string;
+  }
+
+  export interface Form1099Misc {
+    /**
+     * Filter Form 1099-MISC Exports to those for the specified Account.
+     */
+    account_id?: string;
+  }
+
   export interface Status {
     /**
      * Filter Exports for those with the specified status or statuses. For GET

package/src/resources/fednow-transfers.ts

@@ -259,11 +259,6 @@ export namespace FednowTransfer {
    * What object created the transfer, either via the API or the dashboard.
    */
   export interface CreatedBy {
-    /**
-     * If present, details about the API key that created the transfer.
-     */
-    api_key: CreatedBy.APIKey | null;
-
     /**
      * The type of object that created this transfer.
      *
@@ -275,15 +270,20 @@ export namespace FednowTransfer {
      */
     category: 'api_key' | 'oauth_application' | 'user';
 
+    /**
+     * If present, details about the API key that created the transfer.
+     */
+    api_key?: CreatedBy.APIKey | null;
+
     /**
      * If present, details about the OAuth Application that created the transfer.
      */
-    oauth_application: CreatedBy.OAuthApplication | null;
+    oauth_application?: CreatedBy.OAuthApplication | null;
 
     /**
      * If present, details about the User that created the transfer.
      */
-    user: CreatedBy.User | null;
+    user?: CreatedBy.User | null;
   }
 
   export namespace CreatedBy {

package/src/resources/inbound-ach-transfers.ts

@@ -301,6 +301,8 @@ export interface InboundACHTransfer {
    * `inbound_ach_transfer`.
    */
   type: 'inbound_ach_transfer';
+
+  [k: string]: unknown;
 }
 
 export namespace InboundACHTransfer {

package/src/resources/inbound-wire-transfers.ts

@@ -79,6 +79,11 @@ export interface InboundWireTransfer {
    */
   id: string;
 
+  /**
+   * If the transfer is accepted, this will contain details of the acceptance.
+   */
+  acceptance: InboundWireTransfer.Acceptance | null;
+
   /**
    * The Account to which the transfer belongs.
    */
@@ -169,8 +174,7 @@ export interface InboundWireTransfer {
   instruction_identification: string | null;
 
   /**
-   * Information about the reversal of the inbound wire transfer if it has been
-   * reversed.
+   * If the transfer is reversed, this will contain details of the reversal.
    */
   reversal: InboundWireTransfer.Reversal | null;
 
@@ -213,8 +217,23 @@ export interface InboundWireTransfer {
 
 export namespace InboundWireTransfer {
   /**
-   * Information about the reversal of the inbound wire transfer if it has been
-   * reversed.
+   * If the transfer is accepted, this will contain details of the acceptance.
+   */
+  export interface Acceptance {
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+     * the transfer was accepted.
+     */
+    accepted_at: string;
+
+    /**
+     * The identifier of the transaction for the accepted transfer.
+     */
+    transaction_id: string;
+  }
+
+  /**
+   * If the transfer is reversed, this will contain details of the reversal.
    */
   export interface Reversal {
     /**

package/src/resources/lockboxes.ts

@@ -129,6 +129,8 @@ export interface Lockbox {
    * `lockbox`.
    */
   type: 'lockbox';
+
+  [k: string]: unknown;
 }
 
 export namespace Lockbox {
@@ -211,6 +213,8 @@ export interface LockboxUpdateParams {
    * The recipient name you choose for the Lockbox.
    */
   recipient_name?: string;
+
+  [k: string]: unknown;
 }
 
 export interface LockboxListParams extends PageParams {

package/src/resources/pending-transactions.ts

@@ -188,46 +188,6 @@ export namespace PendingTransaction {
    * merchant's industry and location.
    */
   export interface Source {
-    /**
-     * An Account Transfer Instruction object. This field will be present in the JSON
-     * response if and only if `category` is equal to `account_transfer_instruction`.
-     */
-    account_transfer_instruction: Source.AccountTransferInstruction | null;
-
-    /**
-     * An ACH Transfer Instruction object. This field will be present in the JSON
-     * response if and only if `category` is equal to `ach_transfer_instruction`.
-     */
-    ach_transfer_instruction: Source.ACHTransferInstruction | null;
-
-    /**
-     * A Blockchain Off-Ramp Transfer Intention object. This field will be present in
-     * the JSON response if and only if `category` is equal to
-     * `blockchain_offramp_transfer_intention`.
-     */
-    blockchain_offramp_transfer_intention: Source.BlockchainOfframpTransferIntention | null;
-
-    /**
-     * A Blockchain On-Ramp Transfer Instruction object. This field will be present in
-     * the JSON response if and only if `category` is equal to
-     * `blockchain_onramp_transfer_instruction`.
-     */
-    blockchain_onramp_transfer_instruction: Source.BlockchainOnrampTransferInstruction | null;
-
-    /**
-     * A Card Authorization object. This field will be present in the JSON response if
-     * and only if `category` is equal to `card_authorization`. Card Authorizations are
-     * temporary holds placed on a customers funds with the intent to later clear a
-     * transaction.
-     */
-    card_authorization: Source.CardAuthorization | null;
-
-    /**
-     * A Card Push Transfer Instruction object. This field will be present in the JSON
-     * response if and only if `category` is equal to `card_push_transfer_instruction`.
-     */
-    card_push_transfer_instruction: Source.CardPushTransferInstruction | null;
-
     /**
      * The type of the resource. We may add additional possible values for this enum
      * over time; your application should be able to handle such additions gracefully.
@@ -262,9 +222,9 @@ export namespace PendingTransaction {
      * - `blockchain_onramp_transfer_instruction` - Blockchain On-Ramp Transfer
      *   Instruction: details will be under the
      *   `blockchain_onramp_transfer_instruction` object.
-     * - `blockchain_offramp_transfer_intention` - Blockchain Off-Ramp Transfer
-     *   Intention: details will be under the `blockchain_offramp_transfer_intention`
-     *   object.
+     * - `blockchain_offramp_transfer_instruction` - Blockchain Off-Ramp Transfer
+     *   Instruction: details will be under the
+     *   `blockchain_offramp_transfer_instruction` object.
      * - `other` - The Pending Transaction was made for an undocumented or deprecated
      *   reason.
      */
@@ -283,26 +243,66 @@ export namespace PendingTransaction {
       | 'swift_transfer_instruction'
       | 'card_push_transfer_instruction'
       | 'blockchain_onramp_transfer_instruction'
-      | 'blockchain_offramp_transfer_intention'
+      | 'blockchain_offramp_transfer_instruction'
       | 'other';
 
+    /**
+     * An Account Transfer Instruction object. This field will be present in the JSON
+     * response if and only if `category` is equal to `account_transfer_instruction`.
+     */
+    account_transfer_instruction?: Source.AccountTransferInstruction | null;
+
+    /**
+     * An ACH Transfer Instruction object. This field will be present in the JSON
+     * response if and only if `category` is equal to `ach_transfer_instruction`.
+     */
+    ach_transfer_instruction?: Source.ACHTransferInstruction | null;
+
+    /**
+     * A Blockchain Off-Ramp Transfer Instruction object. This field will be present in
+     * the JSON response if and only if `category` is equal to
+     * `blockchain_offramp_transfer_instruction`.
+     */
+    blockchain_offramp_transfer_instruction?: Source.BlockchainOfframpTransferInstruction | null;
+
+    /**
+     * A Blockchain On-Ramp Transfer Instruction object. This field will be present in
+     * the JSON response if and only if `category` is equal to
+     * `blockchain_onramp_transfer_instruction`.
+     */
+    blockchain_onramp_transfer_instruction?: Source.BlockchainOnrampTransferInstruction | null;
+
+    /**
+     * A Card Authorization object. This field will be present in the JSON response if
+     * and only if `category` is equal to `card_authorization`. Card Authorizations are
+     * temporary holds placed on a customers funds with the intent to later clear a
+     * transaction.
+     */
+    card_authorization?: Source.CardAuthorization | null;
+
+    /**
+     * A Card Push Transfer Instruction object. This field will be present in the JSON
+     * response if and only if `category` is equal to `card_push_transfer_instruction`.
+     */
+    card_push_transfer_instruction?: Source.CardPushTransferInstruction | null;
+
     /**
      * A Check Deposit Instruction object. This field will be present in the JSON
      * response if and only if `category` is equal to `check_deposit_instruction`.
      */
-    check_deposit_instruction: Source.CheckDepositInstruction | null;
+    check_deposit_instruction?: Source.CheckDepositInstruction | null;
 
     /**
      * A Check Transfer Instruction object. This field will be present in the JSON
      * response if and only if `category` is equal to `check_transfer_instruction`.
      */
-    check_transfer_instruction: Source.CheckTransferInstruction | null;
+    check_transfer_instruction?: Source.CheckTransferInstruction | null;
 
     /**
      * A FedNow Transfer Instruction object. This field will be present in the JSON
      * response if and only if `category` is equal to `fednow_transfer_instruction`.
      */
-    fednow_transfer_instruction: Source.FednowTransferInstruction | null;
+    fednow_transfer_instruction?: Source.FednowTransferInstruction | null;
 
     /**
      * An Inbound Funds Hold object. This field will be present in the JSON response if
@@ -310,7 +310,7 @@ export namespace PendingTransaction {
      * certain transaction types to account for return windows where funds might still
      * be clawed back by the sending institution.
      */
-    inbound_funds_hold: Source.InboundFundsHold | null;
+    inbound_funds_hold?: Source.InboundFundsHold | null;
 
     /**
      * An Inbound Wire Transfer Reversal object. This field will be present in the JSON
@@ -318,39 +318,39 @@ export namespace PendingTransaction {
      * An Inbound Wire Transfer Reversal is created when Increase has received a wire
      * and the User requests that it be reversed.
      */
-    inbound_wire_transfer_reversal: Source.InboundWireTransferReversal | null;
+    inbound_wire_transfer_reversal?: Source.InboundWireTransferReversal | null;
 
     /**
      * If the category of this Transaction source is equal to `other`, this field will
      * contain an empty object, otherwise it will contain null.
      */
-    other: Source.Other | null;
+    other?: Source.Other | null;
 
     /**
      * A Real-Time Payments Transfer Instruction object. This field will be present in
      * the JSON response if and only if `category` is equal to
      * `real_time_payments_transfer_instruction`.
      */
-    real_time_payments_transfer_instruction: Source.RealTimePaymentsTransferInstruction | null;
+    real_time_payments_transfer_instruction?: Source.RealTimePaymentsTransferInstruction | null;
 
     /**
      * A Swift Transfer Instruction object. This field will be present in the JSON
      * response if and only if `category` is equal to `swift_transfer_instruction`.
      */
-    swift_transfer_instruction: Source.SwiftTransferInstruction | null;
+    swift_transfer_instruction?: Source.SwiftTransferInstruction | null;
 
     /**
      * An User Initiated Hold object. This field will be present in the JSON response
      * if and only if `category` is equal to `user_initiated_hold`. Created when a user
      * initiates a hold on funds in their account.
      */
-    user_initiated_hold: { [key: string]: unknown } | null;
+    user_initiated_hold?: { [key: string]: unknown } | null;
 
     /**
      * A Wire Transfer Instruction object. This field will be present in the JSON
      * response if and only if `category` is equal to `wire_transfer_instruction`.
      */
-    wire_transfer_instruction: Source.WireTransferInstruction | null;
+    wire_transfer_instruction?: Source.WireTransferInstruction | null;
 
     [k: string]: unknown;
   }
@@ -402,11 +402,11 @@ export namespace PendingTransaction {
     }
 
     /**
-     * A Blockchain Off-Ramp Transfer Intention object. This field will be present in
+     * A Blockchain Off-Ramp Transfer Instruction object. This field will be present in
      * the JSON response if and only if `category` is equal to
-     * `blockchain_offramp_transfer_intention`.
+     * `blockchain_offramp_transfer_instruction`.
      */
-    export interface BlockchainOfframpTransferIntention {
+    export interface BlockchainOfframpTransferInstruction {
       /**
        * The identifier of the Blockchain Address the funds were received at.
        */
@@ -1484,7 +1484,7 @@ export namespace PendingTransactionListParams {
       | 'swift_transfer_instruction'
       | 'card_push_transfer_instruction'
       | 'blockchain_onramp_transfer_instruction'
-      | 'blockchain_offramp_transfer_intention'
+      | 'blockchain_offramp_transfer_instruction'
       | 'other'
     >;
   }

package/src/resources/real-time-payments-transfers.ts

@@ -335,11 +335,6 @@ export namespace RealTimePaymentsTransfer {
    * What object created the transfer, either via the API or the dashboard.
    */
   export interface CreatedBy {
-    /**
-     * If present, details about the API key that created the transfer.
-     */
-    api_key: CreatedBy.APIKey | null;
-
     /**
      * The type of object that created this transfer.
      *
@@ -351,15 +346,20 @@ export namespace RealTimePaymentsTransfer {
      */
     category: 'api_key' | 'oauth_application' | 'user';
 
+    /**
+     * If present, details about the API key that created the transfer.
+     */
+    api_key?: CreatedBy.APIKey | null;
+
     /**
      * If present, details about the OAuth Application that created the transfer.
      */
-    oauth_application: CreatedBy.OAuthApplication | null;
+    oauth_application?: CreatedBy.OAuthApplication | null;
 
     /**
      * If present, details about the User that created the transfer.
      */
-    user: CreatedBy.User | null;
+    user?: CreatedBy.User | null;
   }
 
   export namespace CreatedBy {