increase 0.11.0 → 0.11.2

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

@@ -1,223 +1,284 @@
 import * as Core from 'increase/core';
 import { APIResource } from 'increase/resource';
-import * as API from './index.js';
+import * as API from "./index.js";
 import { Page, PageParams } from 'increase/pagination';
 export declare class InboundACHTransfers extends APIResource {
-  /**
-   * Retrieve an Inbound ACH Transfer
-   */
-  retrieve(inboundACHTransferId: string, options?: Core.RequestOptions): Core.APIPromise<InboundACHTransfer>;
-  /**
-   * List Inbound ACH Transfers
-   */
-  list(
-    query?: InboundACHTransferListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<InboundACHTransfersPage, InboundACHTransfer>;
-  list(options?: Core.RequestOptions): Core.PagePromise<InboundACHTransfersPage, InboundACHTransfer>;
-  /**
-   * Decline an Inbound ACH Transfer
-   */
-  decline(inboundACHTransferId: string, options?: Core.RequestOptions): Core.APIPromise<InboundACHTransfer>;
-  /**
-   * Create a notification of change for an Inbound ACH Transfer
-   */
-  notificationOfChange(
-    inboundACHTransferId: string,
-    body: InboundACHTransferNotificationOfChangeParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<InboundACHTransfer>;
-  /**
-   * Return an Inbound ACH Transfer
-   */
-  transferReturn(
-    inboundACHTransferId: string,
-    body: InboundACHTransferTransferReturnParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<InboundACHTransfer>;
+    /**
+     * Retrieve an Inbound ACH Transfer
+     */
+    retrieve(inboundACHTransferId: string, options?: Core.RequestOptions): Core.APIPromise<InboundACHTransfer>;
+    /**
+     * List Inbound ACH Transfers
+     */
+    list(query?: InboundACHTransferListParams, options?: Core.RequestOptions): Core.PagePromise<InboundACHTransfersPage, InboundACHTransfer>;
+    list(options?: Core.RequestOptions): Core.PagePromise<InboundACHTransfersPage, InboundACHTransfer>;
+    /**
+     * Decline an Inbound ACH Transfer
+     */
+    decline(inboundACHTransferId: string, options?: Core.RequestOptions): Core.APIPromise<InboundACHTransfer>;
+    /**
+     * Create a notification of change for an Inbound ACH Transfer
+     */
+    notificationOfChange(inboundACHTransferId: string, body: InboundACHTransferNotificationOfChangeParams, options?: Core.RequestOptions): Core.APIPromise<InboundACHTransfer>;
+    /**
+     * Return an Inbound ACH Transfer
+     */
+    transferReturn(inboundACHTransferId: string, body: InboundACHTransferTransferReturnParams, options?: Core.RequestOptions): Core.APIPromise<InboundACHTransfer>;
+}
+export declare class InboundACHTransfersPage extends Page<InboundACHTransfer> {
 }
-export declare class InboundACHTransfersPage extends Page<InboundACHTransfer> {}
 type _InboundACHTransfersPage = InboundACHTransfersPage;
 /**
  * An Inbound ACH Transfer is an ACH transfer initiated outside of Increase to your
  * account.
  */
 export interface InboundACHTransfer {
-  /**
-   * The inbound ach transfer's identifier.
-   */
-  id: string;
-  /**
-   * If your transfer is accepted, this will contain details of the acceptance.
-   */
-  acceptance: InboundACHTransfer.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: InboundACHTransfer.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: InboundACHTransfer.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 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: InboundACHTransfer.TransferReturn | null;
-  /**
-   * A constant representing the object's type. For this resource it will always be
-   * `inbound_ach_transfer`.
-   */
-  type: 'inbound_ach_transfer';
+    /**
+     * The inbound ach transfer's identifier.
+     */
+    id: string;
+    /**
+     * If your transfer is accepted, this will contain details of the acceptance.
+     */
+    acceptance: InboundACHTransfer.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: InboundACHTransfer.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: InboundACHTransfer.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 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: InboundACHTransfer.TransferReturn | null;
+    /**
+     * A constant representing the object's type. For this resource it will always be
+     * `inbound_ach_transfer`.
+     */
+    type: 'inbound_ach_transfer';
 }
 export declare namespace InboundACHTransfer {
-  /**
-   * If your transfer is accepted, this will contain details of the acceptance.
-   */
-  interface Acceptance {
     /**
-     * The time at which the transfer was accepted.
+     * If your transfer is accepted, this will contain details of the acceptance.
+     */
+    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.
      */
-    accepted_at: string;
+    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';
+    }
     /**
-     * The id of the transaction for the accepted transfer.
+     * If you initiate a notification of change in response to the transfer, this will
+     * contain its details.
      */
-    transaction_id: string;
-  }
-  /**
-   * If your transfer is declined, this will contain details of the decline.
-   */
-  interface Decline {
+    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;
+    }
     /**
-     * The time at which the transfer was declined.
+     * If your transfer is returned, this will contain details of the return.
      */
-    declined_at: string;
+    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 InboundACHTransferListParams extends PageParams {
     /**
-     * The id of the transaction for the declined transfer.
+     * Filter Inbound ACH Tranfers to ones belonging to the specified Account.
      */
-    declined_transaction_id: string;
+    account_id?: string;
+    created_at?: InboundACHTransferListParams.CreatedAt;
     /**
-     * The reason for the transfer decline.
+     * Filter Inbound ACH Transfers to those with the specified status.
      *
-     * - `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.
-   */
-  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.
-   */
-  interface TransferReturn {
-    /**
-     * The reason for the transfer return.
+     * - `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';
+}
+export declare namespace InboundACHTransferListParams {
+    interface CreatedAt {
+        /**
+         * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+         * timestamp.
+         */
+        after?: string;
+        /**
+         * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+         * timestamp.
+         */
+        before?: string;
+        /**
+         * Return results on or after this
+         * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+         */
+        on_or_after?: string;
+        /**
+         * Return results on or before this
+         * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+         */
+        on_or_before?: string;
+    }
+}
+export interface InboundACHTransferNotificationOfChangeParams {
+    /**
+     * The updated account number to send in the notification of change.
+     */
+    updated_account_number?: string;
+    /**
+     * The updated routing number to send in the notification of change.
+     */
+    updated_routing_number?: string;
+}
+export interface InboundACHTransferTransferReturnParams {
+    /**
+     * The reason why this transfer will be returned. The most usual return codes are
+     * `payment_stopped` for debits and `credit_entry_refused_by_receiver` for credits.
      *
      * - `authorization_revoked_by_customer` - The customer no longer authorizes this
      *   transaction. The Nacha return code is R07.
@@ -237,115 +298,14 @@ export declare namespace InboundACHTransfer {
      * - `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 InboundACHTransferListParams extends PageParams {
-  /**
-   * Filter Inbound ACH Tranfers to ones belonging to the specified Account.
-   */
-  account_id?: string;
-  created_at?: InboundACHTransferListParams.CreatedAt;
-  /**
-   * Filter Inbound ACH Transfers to those with the specified status.
-   *
-   * - `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';
-}
-export declare namespace InboundACHTransferListParams {
-  interface CreatedAt {
-    /**
-     * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
-     * timestamp.
-     */
-    after?: string;
-    /**
-     * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
-     * timestamp.
-     */
-    before?: string;
-    /**
-     * Return results on or after this
-     * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
-     */
-    on_or_after?: string;
-    /**
-     * Return results on or before this
-     * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
-     */
-    on_or_before?: string;
-  }
-}
-export interface InboundACHTransferNotificationOfChangeParams {
-  /**
-   * The updated account number to send in the notification of change.
-   */
-  updated_account_number?: string;
-  /**
-   * The updated routing number to send in the notification of change.
-   */
-  updated_routing_number?: string;
-}
-export interface InboundACHTransferTransferReturnParams {
-  /**
-   * The reason why this transfer will be returned. The most usual return codes are
-   * `payment_stopped` for debits and `credit_entry_refused_by_receiver` for credits.
-   *
-   * - `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';
+    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';
 }
 export declare namespace InboundACHTransfers {
-  export import InboundACHTransfer = API.InboundACHTransfer;
-  type InboundACHTransfersPage = _InboundACHTransfersPage;
-  export import InboundACHTransferListParams = API.InboundACHTransferListParams;
-  export import InboundACHTransferNotificationOfChangeParams = API.InboundACHTransferNotificationOfChangeParams;
-  export import InboundACHTransferTransferReturnParams = API.InboundACHTransferTransferReturnParams;
+    export import InboundACHTransfer = API.InboundACHTransfer;
+    type InboundACHTransfersPage = _InboundACHTransfersPage;
+    export import InboundACHTransferListParams = API.InboundACHTransferListParams;
+    export import InboundACHTransferNotificationOfChangeParams = API.InboundACHTransferNotificationOfChangeParams;
+    export import InboundACHTransferTransferReturnParams = API.InboundACHTransferTransferReturnParams;
 }
 export {};
-//# sourceMappingURL=inbound-ach-transfers.d.ts.map
+//# sourceMappingURL=inbound-ach-transfers.d.ts.map