increase 0.11.1 → 0.11.3

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

@@ -1,18 +1,22 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../../core.js';
-import { APIResource } from '../../resource.js';
-import * as ACHTransfers_ from '../ach-transfers.js';
-import * as API from './index.js';
+import * as Core from "../../e/core";
+import { APIResource } from "../../e/resource";
+import * as ACHTransfers_ from "../../e/resources/ach-transfers";
+import * as API from './index';
 
 export class ACHTransfers extends APIResource {
   /**
    * Simulates an inbound ACH transfer to your account. This imitates initiating a
-   * transaction to an Increase account from a different financial institution. The
+   * transfer to an Increase account from a different financial institution. The
    * transfer may be either a credit or a debit depending on if the `amount` is
-   * positive or negative. The result of calling this API will be either a
-   * [Transaction](#transactions) or a [Declined Transaction](#declined-transactions)
-   * depending on whether or not the transfer is allowed.
+   * positive or negative. The result of calling this API will contain the created
+   * transfer. You can pass a `resolve_at` parameter to allow for a window to
+   * [action on the Inbound ACH Transfer](https://increase.com/documentation/inbound-ach-transfers#inbound-ach-transfers).
+   * Alternatively, if you don't pass the `resolve_at` parameter the result will
+   * contain either a [Transaction](#transactions) or a
+   * [Declined Transaction](#declined-transactions) depending on whether or not the
+   * transfer is allowed.
    */
   createInbound(
     body: ACHTransferCreateInboundParams,
@@ -65,6 +69,11 @@ export interface ACHTransferSimulation {
    */
   transaction: ACHTransferSimulation.Transaction | null;
 
+  /**
+   * The Inbound ACH Transfer.
+   */
+  transfer: ACHTransferSimulation.Transfer;
+
   /**
    * A constant representing the object's type. For this resource it will always be
    * `inbound_ach_transfer_simulation_result`.
@@ -1038,6 +1047,12 @@ export namespace ACHTransferSimulation {
          */
         originator_name: string | null;
 
+        /**
+         * The American Banking Association (ABA) routing number of the bank originating
+         * the transfer.
+         */
+        originator_routing_number: string | null;
+
         /**
          * A free-form message set by the wire originator.
          */
@@ -1545,22 +1560,24 @@ export namespace ACHTransferSimulation {
         raw_return_reason_code: string;
 
         /**
-         * Why the ACH Transfer was returned.
+         * Why the ACH Transfer was returned. This reason code is sent by the receiving
+         * bank back to Increase.
          *
-         * - `insufficient_fund` - Code R01. Insufficient funds in the source account.
+         * - `insufficient_fund` - Code R01. Insufficient funds in the receiving account.
+         *   Sometimes abbreviated to NSF.
          * - `no_account` - Code R03. The account does not exist or the receiving bank was
          *   unable to locate it.
-         * - `account_closed` - Code R02. The account is closed.
+         * - `account_closed` - Code R02. The account is closed at the receiving bank.
          * - `invalid_account_number_structure` - Code R04. The account number is invalid
          *   at the receiving bank.
          * - `account_frozen_entry_returned_per_ofac_instruction` - Code R16. The account
-         *   was frozen per the Office of Foreign Assets Control.
+         *   at the receiving bank was frozen per the Office of Foreign Assets Control.
          * - `credit_entry_refused_by_receiver` - Code R23. The receiving bank account
          *   refused a credit transfer.
          * - `unauthorized_debit_to_consumer_account_using_corporate_sec_code` - Code R05.
          *   The receiving bank rejected because of an incorrect Standard Entry Class code.
          * - `corporate_customer_advised_not_authorized` - Code R29. The corporate customer
-         *   reversed the transfer.
+         *   at the receiving bank reversed the transfer.
          * - `payment_stopped` - Code R08. The receiving bank stopped payment on this
          *   transfer.
          * - `non_transaction_account` - Code R20. The receiving bank account does not
@@ -1570,19 +1587,21 @@ export namespace ACHTransferSimulation {
          * - `routing_number_check_digit_error` - Code R28. The routing number is
          *   incorrect.
          * - `customer_advised_unauthorized_improper_ineligible_or_incomplete` - Code R10.
-         *   The customer reversed the transfer.
+         *   The customer at the receiving bank reversed the transfer.
          * - `amount_field_error` - Code R19. The amount field is incorrect or too large.
-         * - `authorization_revoked_by_customer` - Code R07. The customer who initiated the
-         *   transfer revoked authorization.
+         * - `authorization_revoked_by_customer` - Code R07. The customer at the receiving
+         *   institution informed their bank that they have revoked authorization for a
+         *   previously authorized transfer.
          * - `invalid_ach_routing_number` - Code R13. The routing number is invalid.
          * - `file_record_edit_criteria` - Code R17. The receiving bank is unable to
          *   process a field in the transfer.
          * - `enr_invalid_individual_name` - Code R45. The individual name field was
          *   invalid.
          * - `returned_per_odfi_request` - Code R06. The originating financial institution
-         *   asked for this transfer to be returned.
+         *   asked for this transfer to be returned. The receiving bank is complying with
+         *   the request.
          * - `limited_participation_dfi` - Code R34. The receiving bank's regulatory
-         *   supervisor has limited their participation.
+         *   supervisor has limited their participation in the ACH network.
          * - `incorrectly_coded_outbound_international_payment` - Code R85. The outbound
          *   international ACH transfer was incorrect.
          * - `account_sold_to_another_dfi` - Code R12. A rare return reason. The account
@@ -1685,7 +1704,7 @@ export namespace ACHTransferSimulation {
          *   attached to the ACH, usually an ACH check conversion, includes a stop payment.
          * - `timely_original_return` - Code R73. A rare return reason. The bank receiving
          *   an `untimely_return` believes it was on time.
-         * - `trace_number_error` - Code R27. A rare return reason. An ACH Return's trace
+         * - `trace_number_error` - Code R27. A rare return reason. An ACH return's trace
          *   number does not match an originated ACH.
          * - `untimely_dishonored_return` - Code R72. A rare return reason. The dishonored
          *   return was sent too late.
@@ -3895,6 +3914,12 @@ export namespace ACHTransferSimulation {
          */
         originator_name: string | null;
 
+        /**
+         * The American Banking Association (ABA) routing number of the bank originating
+         * the transfer.
+         */
+        originator_routing_number: string | null;
+
         /**
          * An Increase-created concatenation of the Originator-to-Beneficiary lines.
          */
@@ -3957,6 +3982,12 @@ export namespace ACHTransferSimulation {
          */
         input_source: string;
 
+        /**
+         * The American Banking Association (ABA) routing number of the bank originating
+         * the transfer.
+         */
+        originator_routing_number: string | null;
+
         /**
          * The Fedwire cycle date for the wire transfer that was reversed.
          */
@@ -4025,6 +4056,12 @@ export namespace ACHTransferSimulation {
          */
         input_source: string;
 
+        /**
+         * The American Banking Association (ABA) routing number of the bank originating
+         * the transfer.
+         */
+        originator_routing_number: string | null;
+
         /**
          * The Fedwire cycle date for the wire transfer that is being reversed by this
          * message.
@@ -4130,6 +4167,12 @@ export namespace ACHTransferSimulation {
          */
         originator_name: string | null;
 
+        /**
+         * The American Banking Association (ABA) routing number of the bank originating
+         * the transfer.
+         */
+        originator_routing_number: string | null;
+
         /**
          * An Increase-created concatenation of the Originator-to-Beneficiary lines.
          */
@@ -4340,6 +4383,258 @@ export namespace ACHTransferSimulation {
       }
     }
   }
+
+  /**
+   * The Inbound ACH Transfer.
+   */
+  export interface Transfer {
+    /**
+     * The inbound ach transfer's identifier.
+     */
+    id: string;
+
+    /**
+     * If your transfer is accepted, this will contain details of the acceptance.
+     */
+    acceptance: Transfer.Acceptance | null;
+
+    /**
+     * The identifier of the Account Number to which this transfer was sent.
+     */
+    account_number_id: string;
+
+    /**
+     * The transfer amount in USD cents.
+     */
+    amount: number;
+
+    /**
+     * The time at which the transfer will be automatically resolved.
+     */
+    automatically_resolves_at: string;
+
+    /**
+     * If your transfer is declined, this will contain details of the decline.
+     */
+    decline: Transfer.Decline | null;
+
+    /**
+     * The direction of the transfer.
+     *
+     * - `credit` - Credit
+     * - `debit` - Debit
+     */
+    direction: 'credit' | 'debit';
+
+    /**
+     * If you initiate a notification of change in response to the transfer, this will
+     * contain its details.
+     */
+    notification_of_change: Transfer.NotificationOfChange | null;
+
+    /**
+     * The descriptive date of the transfer.
+     */
+    originator_company_descriptive_date: string | null;
+
+    /**
+     * The additional information included with the transfer.
+     */
+    originator_company_discretionary_data: string | null;
+
+    /**
+     * The description of the transfer.
+     */
+    originator_company_entry_description: string;
+
+    /**
+     * The id of the company that initiated the transfer.
+     */
+    originator_company_id: string;
+
+    /**
+     * The name of the company that initiated the transfer.
+     */
+    originator_company_name: string;
+
+    /**
+     * The American Banking Association (ABA) routing number of the bank originating
+     * the transfer.
+     */
+    originator_routing_number: string;
+
+    /**
+     * The id of the receiver of the transfer.
+     */
+    receiver_id_number: string | null;
+
+    /**
+     * The name of the receiver of the transfer.
+     */
+    receiver_name: string | null;
+
+    /**
+     * The status of the transfer.
+     *
+     * - `pending` - The Inbound ACH Transfer is awaiting action, will transition
+     *   automatically if no action is taken.
+     * - `declined` - The Inbound ACH Transfer has been declined.
+     * - `accepted` - The Inbound ACH Transfer is accepted.
+     * - `returned` - The Inbound ACH Transfer has been returned.
+     */
+    status: 'pending' | 'declined' | 'accepted' | 'returned';
+
+    /**
+     * The trace number of the transfer.
+     */
+    trace_number: string;
+
+    /**
+     * If your transfer is returned, this will contain details of the return.
+     */
+    transfer_return: Transfer.TransferReturn | null;
+
+    /**
+     * A constant representing the object's type. For this resource it will always be
+     * `inbound_ach_transfer`.
+     */
+    type: 'inbound_ach_transfer';
+  }
+
+  export namespace Transfer {
+    /**
+     * If your transfer is accepted, this will contain details of the acceptance.
+     */
+    export interface Acceptance {
+      /**
+       * The time at which the transfer was accepted.
+       */
+      accepted_at: string;
+
+      /**
+       * The id of the transaction for the accepted transfer.
+       */
+      transaction_id: string;
+    }
+
+    /**
+     * If your transfer is declined, this will contain details of the decline.
+     */
+    export interface Decline {
+      /**
+       * The time at which the transfer was declined.
+       */
+      declined_at: string;
+
+      /**
+       * The id of the transaction for the declined transfer.
+       */
+      declined_transaction_id: string;
+
+      /**
+       * The reason for the transfer decline.
+       *
+       * - `ach_route_canceled` - The account number is canceled.
+       * - `ach_route_disabled` - The account number is disabled.
+       * - `breaches_limit` - The transaction would cause an Increase limit to be
+       *   exceeded.
+       * - `credit_entry_refused_by_receiver` - A credit was refused. This is a
+       *   reasonable default reason for decline of credits.
+       * - `duplicate_return` - A rare return reason. The return this message refers to
+       *   was a duplicate.
+       * - `entity_not_active` - The account's entity is not active.
+       * - `group_locked` - Your account is inactive.
+       * - `insufficient_funds` - Your account contains insufficient funds.
+       * - `misrouted_return` - A rare return reason. The return this message refers to
+       *   was misrouted.
+       * - `return_of_erroneous_or_reversing_debit` - The originating financial
+       *   institution made a mistake and this return corrects it.
+       * - `no_ach_route` - The account number that was debited does not exist.
+       * - `originator_request` - The originating financial institution asked for this
+       *   transfer to be returned.
+       * - `transaction_not_allowed` - The transaction is not allowed per Increase's
+       *   terms.
+       * - `user_initiated` - The user initiated the decline.
+       */
+      reason:
+        | 'ach_route_canceled'
+        | 'ach_route_disabled'
+        | 'breaches_limit'
+        | 'credit_entry_refused_by_receiver'
+        | 'duplicate_return'
+        | 'entity_not_active'
+        | 'group_locked'
+        | 'insufficient_funds'
+        | 'misrouted_return'
+        | 'return_of_erroneous_or_reversing_debit'
+        | 'no_ach_route'
+        | 'originator_request'
+        | 'transaction_not_allowed'
+        | 'user_initiated';
+    }
+
+    /**
+     * If you initiate a notification of change in response to the transfer, this will
+     * contain its details.
+     */
+    export interface NotificationOfChange {
+      /**
+       * The new account number provided in the notification of change.
+       */
+      updated_account_number: string | null;
+
+      /**
+       * The new account number provided in the notification of change.
+       */
+      updated_routing_number: string | null;
+    }
+
+    /**
+     * If your transfer is returned, this will contain details of the return.
+     */
+    export interface TransferReturn {
+      /**
+       * The reason for the transfer return.
+       *
+       * - `authorization_revoked_by_customer` - The customer no longer authorizes this
+       *   transaction. The Nacha return code is R07.
+       * - `payment_stopped` - The customer asked for the payment to be stopped. This
+       *   reason is only allowed for debits. The Nacha return code is R08.
+       * - `customer_advised_unauthorized_improper_ineligible_or_incomplete` - The
+       *   customer advises that the debit was unauthorized. The Nacha return code is
+       *   R10.
+       * - `representative_payee_deceased_or_unable_to_continue_in_that_capacity` - The
+       *   payee is deceased. The Nacha return code is R14.
+       * - `beneficiary_or_account_holder_deceased` - The account holder is deceased. The
+       *   Nacha return code is R15.
+       * - `credit_entry_refused_by_receiver` - The customer refused a credit entry. This
+       *   reason is only allowed for credits. The Nacha return code is R23.
+       * - `duplicate_entry` - The account holder identified this transaction as a
+       *   duplicate. The Nacha return code is R24.
+       * - `corporate_customer_advised_not_authorized` - The corporate customer no longer
+       *   authorizes this transaction. The Nacha return code is R29.
+       */
+      reason:
+        | 'authorization_revoked_by_customer'
+        | 'payment_stopped'
+        | 'customer_advised_unauthorized_improper_ineligible_or_incomplete'
+        | 'representative_payee_deceased_or_unable_to_continue_in_that_capacity'
+        | 'beneficiary_or_account_holder_deceased'
+        | 'credit_entry_refused_by_receiver'
+        | 'duplicate_entry'
+        | 'corporate_customer_advised_not_authorized';
+
+      /**
+       * The time at which the transfer was returned.
+       */
+      returned_at: string;
+
+      /**
+       * The id of the transaction for the returned transfer.
+       */
+      transaction_id: string;
+    }
+  }
 }
 
 export interface ACHTransferCreateInboundParams {
@@ -4379,6 +4674,12 @@ export interface ACHTransferCreateInboundParams {
    * The name of the sender.
    */
   company_name?: string;
+
+  /**
+   * The time at which the transfer should be resolved. If not provided will resolve
+   * immediately.
+   */
+  resolve_at?: string;
 }
 
 export interface ACHTransferReturnParams {
@@ -4386,20 +4687,21 @@ export interface ACHTransferReturnParams {
    * The reason why the Federal Reserve or destination bank returned this transfer.
    * Defaults to `no_account`.
    *
-   * - `insufficient_fund` - Code R01. Insufficient funds in the source account.
+   * - `insufficient_fund` - Code R01. Insufficient funds in the receiving account.
+   *   Sometimes abbreviated to NSF.
    * - `no_account` - Code R03. The account does not exist or the receiving bank was
    *   unable to locate it.
-   * - `account_closed` - Code R02. The account is closed.
+   * - `account_closed` - Code R02. The account is closed at the receiving bank.
    * - `invalid_account_number_structure` - Code R04. The account number is invalid
    *   at the receiving bank.
    * - `account_frozen_entry_returned_per_ofac_instruction` - Code R16. The account
-   *   was frozen per the Office of Foreign Assets Control.
+   *   at the receiving bank was frozen per the Office of Foreign Assets Control.
    * - `credit_entry_refused_by_receiver` - Code R23. The receiving bank account
    *   refused a credit transfer.
    * - `unauthorized_debit_to_consumer_account_using_corporate_sec_code` - Code R05.
    *   The receiving bank rejected because of an incorrect Standard Entry Class code.
    * - `corporate_customer_advised_not_authorized` - Code R29. The corporate customer
-   *   reversed the transfer.
+   *   at the receiving bank reversed the transfer.
    * - `payment_stopped` - Code R08. The receiving bank stopped payment on this
    *   transfer.
    * - `non_transaction_account` - Code R20. The receiving bank account does not
@@ -4409,19 +4711,21 @@ export interface ACHTransferReturnParams {
    * - `routing_number_check_digit_error` - Code R28. The routing number is
    *   incorrect.
    * - `customer_advised_unauthorized_improper_ineligible_or_incomplete` - Code R10.
-   *   The customer reversed the transfer.
+   *   The customer at the receiving bank reversed the transfer.
    * - `amount_field_error` - Code R19. The amount field is incorrect or too large.
-   * - `authorization_revoked_by_customer` - Code R07. The customer who initiated the
-   *   transfer revoked authorization.
+   * - `authorization_revoked_by_customer` - Code R07. The customer at the receiving
+   *   institution informed their bank that they have revoked authorization for a
+   *   previously authorized transfer.
    * - `invalid_ach_routing_number` - Code R13. The routing number is invalid.
    * - `file_record_edit_criteria` - Code R17. The receiving bank is unable to
    *   process a field in the transfer.
    * - `enr_invalid_individual_name` - Code R45. The individual name field was
    *   invalid.
    * - `returned_per_odfi_request` - Code R06. The originating financial institution
-   *   asked for this transfer to be returned.
+   *   asked for this transfer to be returned. The receiving bank is complying with
+   *   the request.
    * - `limited_participation_dfi` - Code R34. The receiving bank's regulatory
-   *   supervisor has limited their participation.
+   *   supervisor has limited their participation in the ACH network.
    * - `incorrectly_coded_outbound_international_payment` - Code R85. The outbound
    *   international ACH transfer was incorrect.
    * - `account_sold_to_another_dfi` - Code R12. A rare return reason. The account
@@ -4524,7 +4828,7 @@ export interface ACHTransferReturnParams {
    *   attached to the ACH, usually an ACH check conversion, includes a stop payment.
    * - `timely_original_return` - Code R73. A rare return reason. The bank receiving
    *   an `untimely_return` believes it was on time.
-   * - `trace_number_error` - Code R27. A rare return reason. An ACH Return's trace
+   * - `trace_number_error` - Code R27. A rare return reason. An ACH return's trace
    *   number does not match an originated ACH.
    * - `untimely_dishonored_return` - Code R72. A rare return reason. The dishonored
    *   return was sent too late.

package/src/resources/simulations/card-disputes.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../../core.js';
-import { APIResource } from '../../resource.js';
-import * as CardDisputes_ from '../card-disputes.js';
-import * as API from './index.js';
+import * as Core from "../../e/core";
+import { APIResource } from "../../e/resource";
+import * as CardDisputes_ from "../../e/resources/card-disputes";
+import * as API from './index';
 
 export class CardDisputes extends APIResource {
   /**

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

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../../core.js';
-import { APIResource } from '../../resource.js';
-import * as CardProfiles_ from '../card-profiles.js';
+import * as Core from "../../e/core";
+import { APIResource } from "../../e/resource";
+import * as CardProfiles_ from "../../e/resources/card-profiles";
 
 export class CardProfiles extends APIResource {
   /**

package/src/resources/simulations/card-refunds.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../../core.js';
-import { APIResource } from '../../resource.js';
-import * as Transactions from '../transactions.js';
-import * as API from './index.js';
+import * as Core from "../../e/core";
+import { APIResource } from "../../e/resource";
+import * as Transactions from "../../e/resources/transactions";
+import * as API from './index';
 
 export class CardRefunds extends APIResource {
   /**

package/src/resources/simulations/cards.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../../core.js';
-import { APIResource } from '../../resource.js';
-import * as Transactions from '../transactions.js';
-import * as API from './index.js';
+import * as Core from "../../e/core";
+import { APIResource } from "../../e/resource";
+import * as Transactions from "../../e/resources/transactions";
+import * as API from './index';
 
 export class Cards extends APIResource {
   /**
@@ -1028,6 +1028,12 @@ export namespace CardAuthorizationSimulation {
          */
         originator_name: string | null;
 
+        /**
+         * The American Banking Association (ABA) routing number of the bank originating
+         * the transfer.
+         */
+        originator_routing_number: string | null;
+
         /**
          * A free-form message set by the wire originator.
          */

package/src/resources/simulations/check-deposits.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../../core.js';
-import { APIResource } from '../../resource.js';
-import * as CheckDeposits_ from '../check-deposits.js';
+import * as Core from "../../e/core";
+import { APIResource } from "../../e/resource";
+import * as CheckDeposits_ from "../../e/resources/check-deposits";
 
 export class CheckDeposits extends APIResource {
   /**

package/src/resources/simulations/check-transfers.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../../core.js';
-import { APIResource } from '../../resource.js';
-import * as CheckTransfers_ from '../check-transfers.js';
+import * as Core from "../../e/core";
+import { APIResource } from "../../e/resource";
+import * as CheckTransfers_ from "../../e/resources/check-transfers";
 
 export class CheckTransfers extends APIResource {
   /**

package/src/resources/simulations/digital-wallet-token-requests.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../../core.js';
-import { APIResource } from '../../resource.js';
-import * as API from './index.js';
+import * as Core from "../../e/core";
+import { APIResource } from "../../e/resource";
+import * as API from './index';
 
 export class DigitalWalletTokenRequests extends APIResource {
   /**

package/src/resources/simulations/documents.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../../core.js';
-import { APIResource } from '../../resource.js';
-import * as Documents_ from '../documents.js';
-import * as API from './index.js';
+import * as Core from "../../e/core";
+import { APIResource } from "../../e/resource";
+import * as Documents_ from "../../e/resources/documents";
+import * as API from './index';
 
 export class Documents extends APIResource {
   /**

package/src/resources/simulations/inbound-funds-holds.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../../core.js';
-import { APIResource } from '../../resource.js';
-import * as API from './index.js';
+import * as Core from "../../e/core";
+import { APIResource } from "../../e/resource";
+import * as API from './index';
 
 export class InboundFundsHolds extends APIResource {
   /**

package/src/resources/simulations/inbound-wire-drawdown-requests.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../../core.js';
-import { APIResource } from '../../resource.js';
-import * as InboundWireDrawdownRequests_ from '../inbound-wire-drawdown-requests.js';
-import * as API from './index.js';
+import * as Core from "../../e/core";
+import { APIResource } from "../../e/resource";
+import * as InboundWireDrawdownRequests_ from "../../e/resources/inbound-wire-drawdown-requests";
+import * as API from './index';
 
 export class InboundWireDrawdownRequests extends APIResource {
   /**