increase 0.1.0

package/resources/ach-prenotifications.ts

@@ -0,0 +1,242 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '~/core';
+import { APIResource } from '~/resource';
+import { isRequestOptions } from '~/core';
+import { Page, PageParams } from '~/pagination';
+
+export class ACHPrenotifications extends APIResource {
+  /**
+   * Create an ACH Prenotification
+   */
+  create(
+    body: ACHPrenotificationCreateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<ACHPrenotification>> {
+    return this.post('/ach_prenotifications', { body, ...options });
+  }
+
+  /**
+   * Retrieve an ACH Prenotification
+   */
+  retrieve(
+    achPrenotificationId: string,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<ACHPrenotification>> {
+    return this.get(`/ach_prenotifications/${achPrenotificationId}`, options);
+  }
+
+  /**
+   * List ACH Prenotifications
+   */
+  list(
+    query?: ACHPrenotificationListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<ACHPrenotificationsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<ACHPrenotificationsPage>;
+  list(
+    query: ACHPrenotificationListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<ACHPrenotificationsPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+
+    return this.getAPIList('/ach_prenotifications', ACHPrenotificationsPage, { query, ...options });
+  }
+}
+
+export class ACHPrenotificationsPage extends Page<ACHPrenotification> {}
+
+/**
+ * ACH Prenotifications are one way you can verify account and routing numbers by
+ * Automated Clearing House (ACH).
+ */
+export interface ACHPrenotification {
+  /**
+   * The destination account number.
+   */
+  account_number: string;
+
+  /**
+   * Additional information for the recipient.
+   */
+  addendum: string | null;
+
+  /**
+   * The description of the date of the notification.
+   */
+  company_descriptive_date: string | null;
+
+  /**
+   * Optional data associated with the notification.
+   */
+  company_discretionary_data: string | null;
+
+  /**
+   * The description of the notification.
+   */
+  company_entry_description: string | null;
+
+  /**
+   * The name by which you know the company.
+   */
+  company_name: string | null;
+
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+   * the prenotification was created.
+   */
+  created_at: string;
+
+  /**
+   * If the notification is for a future credit or debit.
+   */
+  credit_debit_indicator: 'credit' | 'debit' | null;
+
+  /**
+   * The effective date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   */
+  effective_date: string | null;
+
+  /**
+   * The ACH Prenotification's identifier.
+   */
+  id: string;
+
+  /**
+   * If your prenotification is returned, this will contain details of the return.
+   */
+  prenotification_return: ACHPrenotification.PrenotificationReturn | null;
+
+  /**
+   * The American Bankers' Association (ABA) Routing Transit Number (RTN).
+   */
+  routing_number: string;
+
+  /**
+   * The lifecycle status of the ACH Prenotification.
+   */
+  status: 'pending_submitting' | 'requires_attention' | 'returned' | 'submitted';
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `ach_prenotification`.
+   */
+  type: 'ach_prenotification';
+}
+
+export namespace ACHPrenotification {
+  export interface PrenotificationReturn {
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+     * the Prenotification was returned.
+     */
+    created_at: string;
+
+    /**
+     * Why the Prenotification was returned.
+     */
+    return_reason_code: string;
+  }
+}
+
+export interface ACHPrenotificationCreateParams {
+  /**
+   * The account number for the destination account.
+   */
+  account_number: string;
+
+  /**
+   * The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
+   * destination account.
+   */
+  routing_number: string;
+
+  /**
+   * Additional information that will be sent to the recipient.
+   */
+  addendum?: string;
+
+  /**
+   * The description of the date of the transfer.
+   */
+  company_descriptive_date?: string;
+
+  /**
+   * The data you choose to associate with the transfer.
+   */
+  company_discretionary_data?: string;
+
+  /**
+   * The description of the transfer you wish to be shown to the recipient.
+   */
+  company_entry_description?: string;
+
+  /**
+   * The name by which the recipient knows you.
+   */
+  company_name?: string;
+
+  /**
+   * Whether the Prenotification is for a future debit or credit.
+   */
+  credit_debit_indicator?: 'credit' | 'debit';
+
+  /**
+   * The transfer effective date in
+   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   */
+  effective_date?: string;
+
+  /**
+   * Your identifer for the transfer recipient.
+   */
+  individual_id?: string;
+
+  /**
+   * The name of the transfer recipient. This value is information and not verified
+   * by the recipient's bank.
+   */
+  individual_name?: string;
+
+  /**
+   * The Standard Entry Class (SEC) code to use for the ACH Prenotification.
+   */
+  standard_entry_class_code?:
+    | 'corporate_credit_or_debit'
+    | 'prearranged_payments_and_deposit'
+    | 'internet_initiated';
+}
+
+export interface ACHPrenotificationListParams extends PageParams {
+  created_at?: ACHPrenotificationListParams.CreatedAt;
+}
+
+export namespace ACHPrenotificationListParams {
+  export 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;
+  }
+}

package/resources/ach-transfers.ts

@@ -0,0 +1,465 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '~/core';
+import { APIResource } from '~/resource';
+import { isRequestOptions } from '~/core';
+import { Page, PageParams } from '~/pagination';
+
+export class ACHTransfers extends APIResource {
+  /**
+   * Create an ACH Transfer
+   */
+  create(
+    body: ACHTransferCreateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<ACHTransfer>> {
+    return this.post('/ach_transfers', { body, ...options });
+  }
+
+  /**
+   * Retrieve an ACH Transfer
+   */
+  retrieve(achTransferId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<ACHTransfer>> {
+    return this.get(`/ach_transfers/${achTransferId}`, options);
+  }
+
+  /**
+   * List ACH Transfers
+   */
+  list(query?: ACHTransferListParams, options?: Core.RequestOptions): Core.PagePromise<ACHTransfersPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<ACHTransfersPage>;
+  list(
+    query: ACHTransferListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<ACHTransfersPage> {
+    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: string, options?: Core.RequestOptions): Promise<Core.APIResponse<ACHTransfer>> {
+    return this.post(`/ach_transfers/${achTransferId}/approve`, options);
+  }
+
+  /**
+   * Cancels an ACH Transfer in a pending_approval state.
+   */
+  cancel(achTransferId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<ACHTransfer>> {
+    return this.post(`/ach_transfers/${achTransferId}/cancel`, options);
+  }
+}
+
+export 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 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 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';
+
+  /**
+   * The ACH transfer's identifier.
+   */
+  id: string;
+
+  /**
+   * 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.
+   */
+  notification_of_change: ACHTransfer.NotificationOfChange | null;
+
+  /**
+   * 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_submission'
+    | 'submitted'
+    | 'returned'
+    | 'requires_attention'
+    | 'rejected';
+
+  /**
+   * After the transfer is submitted to FedACH, this will contain supplemental
+   * details.
+   */
+  submission: ACHTransfer.Submission | null;
+
+  /**
+   * If the transfer was created from a template, this will be the template's ID.
+   */
+  template_id: string | 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 namespace ACHTransfer {
+  export interface Approval {
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+     * the transfer was approved.
+     */
+    approved_at: string;
+  }
+
+  export interface Cancellation {
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+     * the Transfer was canceled.
+     */
+    canceled_at: string;
+  }
+
+  export interface NotificationOfChange {
+    /**
+     * 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;
+  }
+
+  export interface Return {
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+     * the transfer was created.
+     */
+    created_at: 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'
+      | 'addenda_error'
+      | 'limited_participation_dfi'
+      | 'incorrectly_coded_outbound_international_payment'
+      | 'other';
+
+    /**
+     * 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;
+  }
+
+  export 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 `YYYYMMDD`.
+   * 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 namespace ACHTransferListParams {
+  export 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;
+  }
+}