increase 0.4.0 → 0.5.0

package/dist/esm/resources/ach-transfers.d.ts

@@ -0,0 +1,461 @@
+import * as Core from '../core.js';
+import { APIResource } from '../resource.js';
+import * as API from './index.js';
+import { Page, PageParams } from '../pagination.js';
+export declare class ACHTransfers extends APIResource {
+  /**
+   * Create an ACH Transfer
+   */
+  create(
+    body: ACHTransferCreateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<ACHTransfer>>;
+  /**
+   * Retrieve an ACH Transfer
+   */
+  retrieve(achTransferId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<ACHTransfer>>;
+  /**
+   * List ACH Transfers
+   */
+  list(query?: ACHTransferListParams, options?: Core.RequestOptions): Core.PagePromise<ACHTransfersPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<ACHTransfersPage>;
+  /**
+   * Approves an ACH Transfer in a pending_approval state.
+   */
+  approve(achTransferId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<ACHTransfer>>;
+  /**
+   * Cancels an ACH Transfer in a pending_approval state.
+   */
+  cancel(achTransferId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<ACHTransfer>>;
+}
+export declare class ACHTransfersPage extends Page<ACHTransfer> {}
+/**
+ * ACH transfers move funds between your Increase account and any other account
+ * accessible by the Automated Clearing House (ACH).
+ */
+export interface ACHTransfer {
+  /**
+   * The ACH transfer's identifier.
+   */
+  id: string;
+  /**
+   * The Account to which the transfer belongs.
+   */
+  account_id: string;
+  /**
+   * The destination account number.
+   */
+  account_number: string;
+  /**
+   * Additional information that will be sent to the recipient.
+   */
+  addendum: string | null;
+  /**
+   * The transfer amount in USD cents. A positive amount indicates a credit transfer
+   * pushing funds to the receiving account. A negative amount indicates a debit
+   * transfer pulling funds from the receiving account.
+   */
+  amount: number;
+  /**
+   * If your account requires approvals for transfers and the transfer was approved,
+   * this will contain details of the approval.
+   */
+  approval: ACHTransfer.Approval | null;
+  /**
+   * If your account requires approvals for transfers and the transfer was not
+   * approved, this will contain details of the cancellation.
+   */
+  cancellation: ACHTransfer.Cancellation | null;
+  /**
+   * The description of the date of the transfer.
+   */
+  company_descriptive_date: string | null;
+  /**
+   * The data you chose to associate with the transfer.
+   */
+  company_discretionary_data: string | null;
+  /**
+   * The description of the transfer you set to be shown to the recipient.
+   */
+  company_entry_description: string | null;
+  /**
+   * The name by which the recipient knows you.
+   */
+  company_name: string | null;
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+   * the transfer was created.
+   */
+  created_at: string;
+  /**
+   * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
+   * currency. For ACH transfers this is always equal to `usd`.
+   */
+  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+  /**
+   * The transfer effective date in
+   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   */
+  effective_date: string | null;
+  /**
+   * The identifier of the External Account the transfer was made to, if any.
+   */
+  external_account_id: string | null;
+  /**
+   * The type of the account to which the transfer will be sent.
+   */
+  funding: 'checking' | 'savings';
+  /**
+   * Your identifer for the transfer recipient.
+   */
+  individual_id: string | null;
+  /**
+   * The name of the transfer recipient. This value is information and not verified
+   * by the recipient's bank.
+   */
+  individual_name: string | null;
+  /**
+   * The transfer's network.
+   */
+  network: 'ach';
+  /**
+   * If the receiving bank accepts the transfer but notifies that future transfers
+   * should use different details, this will contain those details.
+   */
+  notifications_of_change: Array<ACHTransfer.NotificationsOfChange>;
+  /**
+   * If your transfer is returned, this will contain details of the return.
+   */
+  return: ACHTransfer.Return | null;
+  /**
+   * The American Bankers' Association (ABA) Routing Transit Number (RTN).
+   */
+  routing_number: string;
+  /**
+   * The Standard Entry Class (SEC) code to use for the transfer.
+   */
+  standard_entry_class_code:
+    | 'corporate_credit_or_debit'
+    | 'prearranged_payments_and_deposit'
+    | 'internet_initiated';
+  /**
+   * The descriptor that will show on the recipient's bank statement.
+   */
+  statement_descriptor: string;
+  /**
+   * The lifecycle status of the transfer.
+   */
+  status:
+    | 'pending_approval'
+    | 'canceled'
+    | 'pending_reviewing'
+    | 'pending_submission'
+    | 'submitted'
+    | 'returned'
+    | 'requires_attention'
+    | 'rejected';
+  /**
+   * After the transfer is submitted to FedACH, this will contain supplemental
+   * details.
+   */
+  submission: ACHTransfer.Submission | null;
+  /**
+   * The ID for the transaction funding the transfer.
+   */
+  transaction_id: string | null;
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `ach_transfer`.
+   */
+  type: 'ach_transfer';
+}
+export declare namespace ACHTransfer {
+  /**
+   * If your account requires approvals for transfers and the transfer was approved,
+   * this will contain details of the approval.
+   */
+  interface Approval {
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+     * the transfer was approved.
+     */
+    approved_at: string;
+    /**
+     * If the Transfer was approved by a user in the dashboard, the email address of
+     * that user.
+     */
+    approved_by: string | null;
+  }
+  /**
+   * If your account requires approvals for transfers and the transfer was not
+   * approved, this will contain details of the cancellation.
+   */
+  interface Cancellation {
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+     * the Transfer was canceled.
+     */
+    canceled_at: string;
+    /**
+     * If the Transfer was canceled by a user in the dashboard, the email address of
+     * that user.
+     */
+    canceled_by: string | null;
+  }
+  interface NotificationsOfChange {
+    /**
+     * The type of change that occurred.
+     */
+    change_code: string;
+    /**
+     * The corrected data.
+     */
+    corrected_data: string;
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+     * the notification occurred.
+     */
+    created_at: string;
+  }
+  /**
+   * If your transfer is returned, this will contain details of the return.
+   */
+  interface Return {
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+     * the transfer was created.
+     */
+    created_at: string;
+    /**
+     * The three character ACH return code, in the range R01 to R85.
+     */
+    raw_return_reason_code: string;
+    /**
+     * Why the ACH Transfer was returned.
+     */
+    return_reason_code:
+      | 'insufficient_fund'
+      | 'no_account'
+      | 'account_closed'
+      | 'invalid_account_number_structure'
+      | 'account_frozen_entry_returned_per_ofac_instruction'
+      | 'credit_entry_refused_by_receiver'
+      | 'unauthorized_debit_to_consumer_account_using_corporate_sec_code'
+      | 'corporate_customer_advised_not_authorized'
+      | 'payment_stopped'
+      | 'non_transaction_account'
+      | 'uncollected_funds'
+      | 'routing_number_check_digit_error'
+      | 'customer_advised_unauthorized_improper_ineligible_or_incomplete'
+      | 'amount_field_error'
+      | 'authorization_revoked_by_customer'
+      | 'invalid_ach_routing_number'
+      | 'file_record_edit_criteria'
+      | 'enr_invalid_individual_name'
+      | 'returned_per_odfi_request'
+      | 'limited_participation_dfi'
+      | 'incorrectly_coded_outbound_international_payment'
+      | 'account_sold_to_another_dfi'
+      | 'addenda_error'
+      | 'beneficiary_or_account_holder_deceased'
+      | 'customer_advised_not_within_authorization_terms'
+      | 'corrected_return'
+      | 'duplicate_entry'
+      | 'duplicate_return'
+      | 'enr_duplicate_enrollment'
+      | 'enr_invalid_dfi_account_number'
+      | 'enr_invalid_individual_id_number'
+      | 'enr_invalid_representative_payee_indicator'
+      | 'enr_invalid_transaction_code'
+      | 'enr_return_of_enr_entry'
+      | 'enr_routing_number_check_digit_error'
+      | 'entry_not_processed_by_gateway'
+      | 'field_error'
+      | 'foreign_receiving_dfi_unable_to_settle'
+      | 'iat_entry_coding_error'
+      | 'improper_effective_entry_date'
+      | 'improper_source_document_source_document_presented'
+      | 'invalid_company_id'
+      | 'invalid_foreign_receiving_dfi_identification'
+      | 'invalid_individual_id_number'
+      | 'item_and_rck_entry_presented_for_payment'
+      | 'item_related_to_rck_entry_is_ineligible'
+      | 'mandatory_field_error'
+      | 'misrouted_dishonored_return'
+      | 'misrouted_return'
+      | 'no_errors_found'
+      | 'non_acceptance_of_r62_dishonored_return'
+      | 'non_participant_in_iat_program'
+      | 'permissible_return_entry'
+      | 'permissible_return_entry_not_accepted'
+      | 'rdfi_non_settlement'
+      | 'rdfi_participant_in_check_truncation_program'
+      | 'representative_payee_deceased_or_unable_to_continue_in_that_capacity'
+      | 'return_not_a_duplicate'
+      | 'return_of_erroneous_or_reversing_debit'
+      | 'return_of_improper_credit_entry'
+      | 'return_of_improper_debit_entry'
+      | 'return_of_xck_entry'
+      | 'source_document_presented_for_payment'
+      | 'state_law_affecting_rck_acceptance'
+      | 'stop_payment_on_item_related_to_rck_entry'
+      | 'stop_payment_on_source_document'
+      | 'timely_original_return'
+      | 'trace_number_error'
+      | 'untimely_dishonored_return'
+      | 'untimely_return';
+    /**
+     * The identifier of the Tranasaction associated with this return.
+     */
+    transaction_id: string;
+    /**
+     * The identifier of the ACH Transfer associated with this return.
+     */
+    transfer_id: string;
+  }
+  /**
+   * After the transfer is submitted to FedACH, this will contain supplemental
+   * details.
+   */
+  interface Submission {
+    /**
+     * When the ACH transfer was sent to FedACH.
+     */
+    submitted_at: string;
+    /**
+     * The trace number for the submission.
+     */
+    trace_number: string;
+  }
+}
+export interface ACHTransferCreateParams {
+  /**
+   * The Increase identifier for the account that will send the transfer.
+   */
+  account_id: string;
+  /**
+   * The transfer amount in cents. A positive amount originates a credit transfer
+   * pushing funds to the receiving account. A negative amount originates a debit
+   * transfer pulling funds from the receiving account.
+   */
+  amount: number;
+  /**
+   * A description you choose to give the transfer. This will be saved with the
+   * transfer details, displayed in the dashboard, and returned by the API. If
+   * `individual_name` and `company_name` are not explicitly set by this API, the
+   * `statement_descriptor` will be sent in those fields to the receiving bank to
+   * help the customer recognize the transfer. You are highly encouraged to pass
+   * `individual_name` and `company_name` instead of relying on this fallback.
+   */
+  statement_descriptor: string;
+  /**
+   * The account number for the destination account.
+   */
+  account_number?: string;
+  /**
+   * Additional information that will be sent to the recipient. This is included in
+   * the transfer data sent to the receiving bank.
+   */
+  addendum?: string;
+  /**
+   * The description of the date of the transfer, usually in the format `YYMMDD`.
+   * This is included in the transfer data sent to the receiving bank.
+   */
+  company_descriptive_date?: string;
+  /**
+   * The data you choose to associate with the transfer. This is included in the
+   * transfer data sent to the receiving bank.
+   */
+  company_discretionary_data?: string;
+  /**
+   * A description of the transfer. This is included in the transfer data sent to the
+   * receiving bank.
+   */
+  company_entry_description?: string;
+  /**
+   * The name by which the recipient knows you. This is included in the transfer data
+   * sent to the receiving bank.
+   */
+  company_name?: string;
+  /**
+   * The transfer effective date in
+   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   */
+  effective_date?: string;
+  /**
+   * The ID of an External Account to initiate a transfer to. If this parameter is
+   * provided, `account_number`, `routing_number`, and `funding` must be absent.
+   */
+  external_account_id?: string;
+  /**
+   * The type of the account to which the transfer will be sent.
+   */
+  funding?: 'checking' | 'savings';
+  /**
+   * Your identifer for the transfer recipient.
+   */
+  individual_id?: string;
+  /**
+   * The name of the transfer recipient. This value is informational and not verified
+   * by the recipient's bank.
+   */
+  individual_name?: string;
+  /**
+   * Whether the transfer requires explicit approval via the dashboard or API.
+   */
+  require_approval?: boolean;
+  /**
+   * The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
+   * destination account.
+   */
+  routing_number?: string;
+  /**
+   * The Standard Entry Class (SEC) code to use for the transfer.
+   */
+  standard_entry_class_code?:
+    | 'corporate_credit_or_debit'
+    | 'prearranged_payments_and_deposit'
+    | 'internet_initiated';
+}
+export interface ACHTransferListParams extends PageParams {
+  /**
+   * Filter ACH Transfers to those that originated from the specified Account.
+   */
+  account_id?: string;
+  created_at?: ACHTransferListParams.CreatedAt;
+  /**
+   * Filter ACH Transfers to those made to the specified External Account.
+   */
+  external_account_id?: string;
+}
+export declare namespace ACHTransferListParams {
+  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 declare namespace ACHTransfers {
+  export import ACHTransfer = API.ACHTransfer;
+  export import ACHTransfersPage = API.ACHTransfersPage;
+  export import ACHTransferCreateParams = API.ACHTransferCreateParams;
+  export import ACHTransferListParams = API.ACHTransferListParams;
+}
+//# sourceMappingURL=ach-transfers.d.ts.map

package/dist/esm/resources/ach-transfers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ach-transfers.d.ts","sourceRoot":"","sources":["../../../resources/ach-transfers.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,OAAO,KAAK,GAAG,MAAM,IAAI,CAAC;AAC1B,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAEhD,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IAIzC;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IAItG;;OAEG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC;IACtG,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC;IAWvE;;OAEG;IACH,OAAO,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IAIrG;;OAEG;IACH,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;CAGrG;AAED,qBAAa,gBAAiB,SAAQ,IAAI,CAAC,WAAW,CAAC;CAAG;AAE1D;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,QAAQ,EAAE,WAAW,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,YAAY,EAAE,WAAW,CAAC,YAAY,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,wBAAwB,EAAE,MAAM,GAAG,IAAI,CAAC;IAExC;;OAEG;IACH,0BAA0B,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,yBAAyB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAExD;;;OAGG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,OAAO,EAAE,UAAU,GAAG,SAAS,CAAC;IAEhC;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC;IAEf;;;OAGG;IACH,uBAAuB,EAAE,KAAK,CAAC,WAAW,CAAC,qBAAqB,CAAC,CAAC;IAElE;;OAEG;IACH,MAAM,EAAE,WAAW,CAAC,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,yBAAyB,EACrB,2BAA2B,GAC3B,kCAAkC,GAClC,oBAAoB,CAAC;IAEzB;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,MAAM,EACF,kBAAkB,GAClB,UAAU,GACV,mBAAmB,GACnB,oBAAoB,GACpB,WAAW,GACX,UAAU,GACV,oBAAoB,GACpB,UAAU,CAAC;IAEf;;;OAGG;IACH,UAAU,EAAE,WAAW,CAAC,UAAU,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,IAAI,EAAE,cAAc,CAAC;CACtB;AAED,yBAAiB,WAAW,CAAC;IAC3B;;;OAGG;IACH,UAAiB,QAAQ;QACvB;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;IAED;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;IAED,UAAiB,qBAAqB;QACpC;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,sBAAsB,EAAE,MAAM,CAAC;QAE/B;;WAEG;QACH,kBAAkB,EACd,mBAAmB,GACnB,YAAY,GACZ,gBAAgB,GAChB,kCAAkC,GAClC,oDAAoD,GACpD,kCAAkC,GAClC,iEAAiE,GACjE,2CAA2C,GAC3C,iBAAiB,GACjB,yBAAyB,GACzB,mBAAmB,GACnB,kCAAkC,GAClC,iEAAiE,GACjE,oBAAoB,GACpB,mCAAmC,GACnC,4BAA4B,GAC5B,2BAA2B,GAC3B,6BAA6B,GAC7B,2BAA2B,GAC3B,2BAA2B,GAC3B,kDAAkD,GAClD,6BAA6B,GAC7B,eAAe,GACf,wCAAwC,GACxC,iDAAiD,GACjD,kBAAkB,GAClB,iBAAiB,GACjB,kBAAkB,GAClB,0BAA0B,GAC1B,gCAAgC,GAChC,kCAAkC,GAClC,4CAA4C,GAC5C,8BAA8B,GAC9B,yBAAyB,GACzB,sCAAsC,GACtC,gCAAgC,GAChC,aAAa,GACb,wCAAwC,GACxC,wBAAwB,GACxB,+BAA+B,GAC/B,oDAAoD,GACpD,oBAAoB,GACpB,8CAA8C,GAC9C,8BAA8B,GAC9B,0CAA0C,GAC1C,yCAAyC,GACzC,uBAAuB,GACvB,6BAA6B,GAC7B,kBAAkB,GAClB,iBAAiB,GACjB,yCAAyC,GACzC,gCAAgC,GAChC,0BAA0B,GAC1B,uCAAuC,GACvC,qBAAqB,GACrB,8CAA8C,GAC9C,sEAAsE,GACtE,wBAAwB,GACxB,wCAAwC,GACxC,iCAAiC,GACjC,gCAAgC,GAChC,qBAAqB,GACrB,uCAAuC,GACvC,oCAAoC,GACpC,2CAA2C,GAC3C,iCAAiC,GACjC,wBAAwB,GACxB,oBAAoB,GACpB,4BAA4B,GAC5B,iBAAiB,CAAC;QAEtB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;KACrB;IAED;;;OAGG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;OAOG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;OAGG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAEpC;;;OAGG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,OAAO,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IAEjC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,yBAAyB,CAAC,EACtB,2BAA2B,GAC3B,kCAAkC,GAClC,oBAAoB,CAAC;CAC1B;AAED,MAAM,WAAW,qBAAsB,SAAQ,UAAU;IACvD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,qBAAqB,CAAC,SAAS,CAAC;IAE7C;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,SAAS;QACxB;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB;CACF;AAED,yBAAiB,YAAY,CAAC;IAC5B,MAAM,QAAQ,WAAW,GAAG,GAAG,CAAC,WAAW,CAAC;IAC5C,MAAM,QAAQ,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAC;IACtD,MAAM,QAAQ,uBAAuB,GAAG,GAAG,CAAC,uBAAuB,CAAC;IACpE,MAAM,QAAQ,qBAAqB,GAAG,GAAG,CAAC,qBAAqB,CAAC;CACjE"}

package/dist/esm/resources/ach-transfers.js

@@ -0,0 +1,42 @@
+// File generated from our OpenAPI spec by Stainless.
+import { APIResource } from '../resource.js';
+import { isRequestOptions } from '../core.js';
+import * as API from './index.js';
+import { Page } from '../pagination.js';
+export class ACHTransfers extends APIResource {
+  /**
+   * Create an ACH Transfer
+   */
+  create(body, options) {
+    return this.post('/ach_transfers', { body, ...options });
+  }
+  /**
+   * Retrieve an ACH Transfer
+   */
+  retrieve(achTransferId, options) {
+    return this.get(`/ach_transfers/${achTransferId}`, options);
+  }
+  list(query = {}, options) {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this.getAPIList('/ach_transfers', ACHTransfersPage, { query, ...options });
+  }
+  /**
+   * Approves an ACH Transfer in a pending_approval state.
+   */
+  approve(achTransferId, options) {
+    return this.post(`/ach_transfers/${achTransferId}/approve`, options);
+  }
+  /**
+   * Cancels an ACH Transfer in a pending_approval state.
+   */
+  cancel(achTransferId, options) {
+    return this.post(`/ach_transfers/${achTransferId}/cancel`, options);
+  }
+}
+export class ACHTransfersPage extends Page {}
+(function (ACHTransfers) {
+  ACHTransfers.ACHTransfersPage = API.ACHTransfersPage;
+})(ACHTransfers || (ACHTransfers = {}));
+//# sourceMappingURL=ach-transfers.js.map

package/dist/esm/resources/ach-transfers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ach-transfers.js","sourceRoot":"","sources":["../../../resources/ach-transfers.ts"],"names":[],"mappings":"AAAA,qDAAqD;AAGrD,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,KAAK,GAAG,MAAM,IAAI,CAAC;AAC1B,OAAO,EAAE,IAAI,EAAc,MAAM,cAAc,CAAC;AAEhD,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,MAAM,CACJ,IAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,aAAqB,EAAE,OAA6B;QAC3D,OAAO,IAAI,CAAC,GAAG,CAAC,kBAAkB,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAOD,IAAI,CACF,QAAqD,EAAE,EACvD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,aAAqB,EAAE,OAA6B;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,kBAAkB,aAAa,UAAU,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,aAAqB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,IAAI,CAAC,kBAAkB,aAAa,SAAS,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;CACF;AAED,MAAM,OAAO,gBAAiB,SAAQ,IAAiB;CAAG;AA2e1D,WAAiB,YAAY;IAEb,6BAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAC;AAGxD,CAAC,EALgB,YAAY,KAAZ,YAAY,QAK5B"}

package/dist/esm/resources/balance-lookups.d.ts

@@ -0,0 +1,52 @@
+import * as Core from '../core.js';
+import { APIResource } from '../resource.js';
+import * as API from './index.js';
+export declare class BalanceLookups extends APIResource {
+  /**
+   * Look up the balance for an Account
+   */
+  lookup(
+    body: BalanceLookupLookupParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<BalanceLookupLookupResponse>>;
+}
+/**
+ * Represents a request to lookup the balance of an Account at a given point in
+ * time.
+ */
+export interface BalanceLookupLookupResponse {
+  /**
+   * The identifier for the account for which the balance was queried.
+   */
+  account_id: string;
+  /**
+   * The Account's available balance, representing the current balance less any open
+   * Pending Transactions on the Account.
+   */
+  available_balance: number;
+  /**
+   * The Account's current balance, representing the sum of all posted Transactions
+   * on the Account.
+   */
+  current_balance: number;
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `balance_lookup`.
+   */
+  type: 'balance_lookup';
+}
+export interface BalanceLookupLookupParams {
+  /**
+   * The Account to query the balance for.
+   */
+  account_id: string;
+  /**
+   * The moment to query the balance at. If not set, returns the current balances.
+   */
+  at_time?: string;
+}
+export declare namespace BalanceLookups {
+  export import BalanceLookupLookupResponse = API.BalanceLookupLookupResponse;
+  export import BalanceLookupLookupParams = API.BalanceLookupLookupParams;
+}
+//# sourceMappingURL=balance-lookups.d.ts.map

package/dist/esm/resources/balance-lookups.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"balance-lookups.d.ts","sourceRoot":"","sources":["../../../resources/balance-lookups.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,KAAK,GAAG,MAAM,IAAI,CAAC;AAE1B,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAAC;CAG1D;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,IAAI,EAAE,gBAAgB,CAAC;CACxB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,cAAc,CAAC;IAC9B,MAAM,QAAQ,2BAA2B,GAAG,GAAG,CAAC,2BAA2B,CAAC;IAC5E,MAAM,QAAQ,yBAAyB,GAAG,GAAG,CAAC,yBAAyB,CAAC;CACzE"}

package/dist/esm/resources/balance-lookups.js

@@ -0,0 +1,12 @@
+// File generated from our OpenAPI spec by Stainless.
+import { APIResource } from '../resource.js';
+export class BalanceLookups extends APIResource {
+  /**
+   * Look up the balance for an Account
+   */
+  lookup(body, options) {
+    return this.post('/balance_lookups', { body, ...options });
+  }
+}
+(function (BalanceLookups) {})(BalanceLookups || (BalanceLookups = {}));
+//# sourceMappingURL=balance-lookups.js.map

package/dist/esm/resources/balance-lookups.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"balance-lookups.js","sourceRoot":"","sources":["../../../resources/balance-lookups.ts"],"names":[],"mappings":"AAAA,qDAAqD;AAGrD,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAGzC,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC7C;;OAEG;IACH,MAAM,CACJ,IAA+B,EAC/B,OAA6B;QAE7B,OAAO,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;CACF;AA2CD,WAAiB,cAAc;AAG/B,CAAC,EAHgB,cAAc,KAAd,cAAc,QAG9B"}

package/dist/esm/resources/bookkeeping-accounts.d.ts

@@ -0,0 +1,78 @@
+import * as Core from '../core.js';
+import { APIResource } from '../resource.js';
+import * as API from './index.js';
+import { Page, PageParams } from '../pagination.js';
+export declare class BookkeepingAccounts extends APIResource {
+  /**
+   * Create a Bookkeeping Account
+   */
+  create(
+    body: BookkeepingAccountCreateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<BookkeepingAccount>>;
+  /**
+   * List Bookkeeping Accounts
+   */
+  list(
+    query?: BookkeepingAccountListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<BookkeepingAccountsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<BookkeepingAccountsPage>;
+}
+export declare class BookkeepingAccountsPage extends Page<BookkeepingAccount> {}
+/**
+ * Accounts are T-accounts. They can store accounting entries.
+ */
+export interface BookkeepingAccount {
+  /**
+   * The account identifier.
+   */
+  id: string;
+  /**
+   * The API Account associated with this bookkeeping account.
+   */
+  account_id: string | null;
+  /**
+   * The compliance category of the account.
+   */
+  compliance_category: 'commingled_cash' | 'customer_balance' | null;
+  /**
+   * The Entity associated with this bookkeeping account.
+   */
+  entity_id: string | null;
+  /**
+   * The name you choose for the account.
+   */
+  name: string;
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `bookkeeping_account`.
+   */
+  type: 'bookkeeping_account';
+}
+export interface BookkeepingAccountCreateParams {
+  /**
+   * The name you choose for the account.
+   */
+  name: string;
+  /**
+   * The entity, if `compliance_category` is `commingled_cash`.
+   */
+  account_id?: string;
+  /**
+   * The account compliance category.
+   */
+  compliance_category?: 'commingled_cash' | 'customer_balance';
+  /**
+   * The entity, if `compliance_category` is `customer_balance`.
+   */
+  entity_id?: string;
+}
+export interface BookkeepingAccountListParams extends PageParams {}
+export declare namespace BookkeepingAccounts {
+  export import BookkeepingAccount = API.BookkeepingAccount;
+  export import BookkeepingAccountsPage = API.BookkeepingAccountsPage;
+  export import BookkeepingAccountCreateParams = API.BookkeepingAccountCreateParams;
+  export import BookkeepingAccountListParams = API.BookkeepingAccountListParams;
+}
+//# sourceMappingURL=bookkeeping-accounts.d.ts.map

package/dist/esm/resources/bookkeeping-accounts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bookkeeping-accounts.d.ts","sourceRoot":"","sources":["../../../resources/bookkeeping-accounts.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,OAAO,KAAK,GAAG,MAAM,IAAI,CAAC;AAC1B,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAEhD,qBAAa,mBAAoB,SAAQ,WAAW;IAClD;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC;IAIhD;;OAEG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,4BAA4B,EACpC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,uBAAuB,CAAC;IAC5C,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,uBAAuB,CAAC;CAU/E;AAED,qBAAa,uBAAwB,SAAQ,IAAI,CAAC,kBAAkB,CAAC;CAAG;AAExE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,mBAAmB,EAAE,iBAAiB,GAAG,kBAAkB,GAAG,IAAI,CAAC;IAEnE;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,IAAI,EAAE,qBAAqB,CAAC;CAC7B;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,mBAAmB,CAAC,EAAE,iBAAiB,GAAG,kBAAkB,CAAC;IAE7D;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,4BAA6B,SAAQ,UAAU;CAAG;AAEnE,yBAAiB,mBAAmB,CAAC;IACnC,MAAM,QAAQ,kBAAkB,GAAG,GAAG,CAAC,kBAAkB,CAAC;IAC1D,MAAM,QAAQ,uBAAuB,GAAG,GAAG,CAAC,uBAAuB,CAAC;IACpE,MAAM,QAAQ,8BAA8B,GAAG,GAAG,CAAC,8BAA8B,CAAC;IAClF,MAAM,QAAQ,4BAA4B,GAAG,GAAG,CAAC,4BAA4B,CAAC;CAC/E"}