increase 0.418.0 → 0.430.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

@@ -69,6 +69,36 @@ export interface Export {
    */
   id: string;
 
+  /**
+   * Details of the account statement BAI2 export. This field will be present when
+   * the `category` is equal to `account_statement_bai2`.
+   */
+  account_statement_bai2: Export.AccountStatementBai2 | null;
+
+  /**
+   * Details of the account statement OFX export. This field will be present when the
+   * `category` is equal to `account_statement_ofx`.
+   */
+  account_statement_ofx: Export.AccountStatementOfx | null;
+
+  /**
+   * Details of the account verification letter export. This field will be present
+   * when the `category` is equal to `account_verification_letter`.
+   */
+  account_verification_letter: Export.AccountVerificationLetter | null;
+
+  /**
+   * Details of the balance CSV export. This field will be present when the
+   * `category` is equal to `balance_csv`.
+   */
+  balance_csv: Export.BalanceCsv | null;
+
+  /**
+   * Details of the bookkeeping account balance CSV export. This field will be
+   * present when the `category` is equal to `bookkeeping_account_balance_csv`.
+   */
+  bookkeeping_account_balance_csv: Export.BookkeepingAccountBalanceCsv | null;
+
   /**
    * The category of the Export. We may add additional possible values for this enum
    * over time; your application should be able to handle that gracefully.
@@ -112,16 +142,34 @@ export interface Export {
   created_at: string;
 
   /**
-   * A URL at which the Export's file can be downloaded. This will be present when
-   * the Export's status transitions to `complete`.
+   * Details of the dashboard table CSV export. This field will be present when the
+   * `category` is equal to `dashboard_table_csv`.
    */
-  file_download_url: string | null;
+  dashboard_table_csv: Export.DashboardTableCsv | null;
 
   /**
-   * The File containing the contents of the Export. This will be present when the
-   * Export's status transitions to `complete`.
+   * Details of the entity CSV export. This field will be present when the `category`
+   * is equal to `entity_csv`.
    */
-  file_id: string | null;
+  entity_csv: Export.EntityCsv | null;
+
+  /**
+   * Details of the Form 1099-INT export. This field will be present when the
+   * `category` is equal to `form_1099_int`.
+   */
+  form_1099_int: Export.Form1099Int | null;
+
+  /**
+   * Details of the Form 1099-MISC export. This field will be present when the
+   * `category` is equal to `form_1099_misc`.
+   */
+  form_1099_misc: Export.Form1099Misc | null;
+
+  /**
+   * Details of the funding instructions export. This field will be present when the
+   * `category` is equal to `funding_instructions`.
+   */
+  funding_instructions: Export.FundingInstructions | null;
 
   /**
    * The idempotency key you chose for this object. This value is unique across
@@ -130,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.
    *
@@ -140,11 +194,283 @@ export interface Export {
    */
   status: 'pending' | 'complete' | 'failed';
 
+  /**
+   * Details of the transaction CSV export. This field will be present when the
+   * `category` is equal to `transaction_csv`.
+   */
+  transaction_csv: Export.TransactionCsv | null;
+
   /**
    * A constant representing the object's type. For this resource it will always be
    * `export`.
    */
   type: 'export';
+
+  /**
+   * Details of the vendor CSV export. This field will be present when the `category`
+   * is equal to `vendor_csv`.
+   */
+  vendor_csv: Export.VendorCsv | null;
+
+  [k: string]: unknown;
+}
+
+export namespace Export {
+  /**
+   * Details of the account statement BAI2 export. This field will be present when
+   * the `category` is equal to `account_statement_bai2`.
+   */
+  export interface AccountStatementBai2 {
+    /**
+     * Filter results by Account.
+     */
+    account_id: string | null;
+
+    /**
+     * The date for which to retrieve the balance.
+     */
+    effective_date: string | null;
+
+    /**
+     * Filter results by Program.
+     */
+    program_id: string | null;
+  }
+
+  /**
+   * Details of the account statement OFX export. This field will be present when the
+   * `category` is equal to `account_statement_ofx`.
+   */
+  export interface AccountStatementOfx {
+    /**
+     * The Account to create a statement for.
+     */
+    account_id: string;
+
+    /**
+     * Filter transactions by their created date.
+     */
+    created_at: AccountStatementOfx.CreatedAt | null;
+  }
+
+  export namespace AccountStatementOfx {
+    /**
+     * Filter transactions by their created date.
+     */
+    export interface CreatedAt {
+      /**
+       * Filter results to transactions created after this time.
+       */
+      after: string | null;
+
+      /**
+       * Filter results to transactions created before this time.
+       */
+      before: string | null;
+    }
+  }
+
+  /**
+   * Details of the account verification letter export. This field will be present
+   * when the `category` is equal to `account_verification_letter`.
+   */
+  export interface AccountVerificationLetter {
+    /**
+     * The Account Number to create a letter for.
+     */
+    account_number_id: string;
+
+    /**
+     * The date of the balance to include in the letter.
+     */
+    balance_date: string | null;
+  }
+
+  /**
+   * Details of the balance CSV export. This field will be present when the
+   * `category` is equal to `balance_csv`.
+   */
+  export interface BalanceCsv {
+    /**
+     * Filter results by Account.
+     */
+    account_id: string | null;
+
+    /**
+     * Filter balances by their created date.
+     */
+    created_at: BalanceCsv.CreatedAt | null;
+  }
+
+  export namespace BalanceCsv {
+    /**
+     * Filter balances by their created date.
+     */
+    export interface CreatedAt {
+      /**
+       * Filter balances created after this time.
+       */
+      after: string | null;
+
+      /**
+       * Filter balances created before this time.
+       */
+      before: string | null;
+    }
+  }
+
+  /**
+   * Details of the bookkeeping account balance CSV export. This field will be
+   * present when the `category` is equal to `bookkeeping_account_balance_csv`.
+   */
+  export interface BookkeepingAccountBalanceCsv {
+    /**
+     * Filter results by Bookkeeping Account.
+     */
+    bookkeeping_account_id: string | null;
+
+    /**
+     * Filter balances by their created date.
+     */
+    created_at: BookkeepingAccountBalanceCsv.CreatedAt | null;
+  }
+
+  export namespace BookkeepingAccountBalanceCsv {
+    /**
+     * Filter balances by their created date.
+     */
+    export interface CreatedAt {
+      /**
+       * Filter balances created after this time.
+       */
+      after: string | null;
+
+      /**
+       * Filter balances created before this time.
+       */
+      before: string | null;
+    }
+  }
+
+  /**
+   * Details of the dashboard table CSV export. This field will be present when the
+   * `category` is equal to `dashboard_table_csv`.
+   */
+  export interface DashboardTableCsv {}
+
+  /**
+   * Details of the entity CSV export. This field will be present when the `category`
+   * is equal to `entity_csv`.
+   */
+  export interface EntityCsv {}
+
+  /**
+   * Details of the Form 1099-INT export. This field will be present when the
+   * `category` is equal to `form_1099_int`.
+   */
+  export interface Form1099Int {
+    /**
+     * The Account the tax form is for.
+     */
+    account_id: string;
+
+    /**
+     * Whether the tax form is a corrected form.
+     */
+    corrected: boolean;
+
+    /**
+     * A description of the tax form.
+     */
+    description: string;
+
+    /**
+     * The tax year for the tax form.
+     */
+    year: number;
+  }
+
+  /**
+   * Details of the Form 1099-MISC export. This field will be present when the
+   * `category` is equal to `form_1099_misc`.
+   */
+  export interface Form1099Misc {
+    /**
+     * The Account the tax form is for.
+     */
+    account_id: string;
+
+    /**
+     * Whether the tax form is a corrected form.
+     */
+    corrected: boolean;
+
+    /**
+     * The tax year for the tax form.
+     */
+    year: number;
+  }
+
+  /**
+   * Details of the funding instructions export. This field will be present when the
+   * `category` is equal to `funding_instructions`.
+   */
+  export interface FundingInstructions {
+    /**
+     * The Account Number to create funding instructions for.
+     */
+    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`.
+   */
+  export interface TransactionCsv {
+    /**
+     * Filter results by Account.
+     */
+    account_id: string | null;
+
+    /**
+     * Filter transactions by their created date.
+     */
+    created_at: TransactionCsv.CreatedAt | null;
+  }
+
+  export namespace TransactionCsv {
+    /**
+     * Filter transactions by their created date.
+     */
+    export interface CreatedAt {
+      /**
+       * Filter transactions created after this time.
+       */
+      after: string | null;
+
+      /**
+       * Filter transactions created before this time.
+       */
+      before: string | null;
+    }
+  }
+
+  /**
+   * Details of the vendor CSV export. This field will be present when the `category`
+   * is equal to `vendor_csv`.
+   */
+  export interface VendorCsv {}
 }
 
 export interface ExportCreateParams {
@@ -487,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
@@ -503,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)
@@ -551,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/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 {