increase 0.339.0 → 0.340.0

package/src/resources/inbound-fednow-transfers.ts

@@ -0,0 +1,255 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import { Page, type PageParams } from '../pagination';
+
+export class InboundFednowTransfers extends APIResource {
+  /**
+   * Retrieve an Inbound FedNow Transfer
+   *
+   * @example
+   * ```ts
+   * const inboundFednowTransfer =
+   *   await client.inboundFednowTransfers.retrieve(
+   *     'inbound_fednow_transfer_ctxxbc07oh5ke5w1hk20',
+   *   );
+   * ```
+   */
+  retrieve(
+    inboundFednowTransferId: string,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<InboundFednowTransfer> {
+    return this._client.get(`/inbound_fednow_transfers/${inboundFednowTransferId}`, options);
+  }
+
+  /**
+   * List Inbound FedNow Transfers
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const inboundFednowTransfer of client.inboundFednowTransfers.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query?: InboundFednowTransferListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<InboundFednowTransfersPage, InboundFednowTransfer>;
+  list(options?: Core.RequestOptions): Core.PagePromise<InboundFednowTransfersPage, InboundFednowTransfer>;
+  list(
+    query: InboundFednowTransferListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<InboundFednowTransfersPage, InboundFednowTransfer> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.getAPIList('/inbound_fednow_transfers', InboundFednowTransfersPage, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export class InboundFednowTransfersPage extends Page<InboundFednowTransfer> {}
+
+/**
+ * An Inbound FedNow Transfer is a FedNow transfer initiated outside of Increase to
+ * your account.
+ */
+export interface InboundFednowTransfer {
+  /**
+   * The inbound FedNow transfer's identifier.
+   */
+  id: string;
+
+  /**
+   * The Account to which the transfer was sent.
+   */
+  account_id: string;
+
+  /**
+   * The identifier of the Account Number to which this transfer was sent.
+   */
+  account_number_id: string;
+
+  /**
+   * The amount in USD cents.
+   */
+  amount: number;
+
+  /**
+   * If your transfer is confirmed, this will contain details of the confirmation.
+   */
+  confirmation: InboundFednowTransfer.Confirmation | null;
+
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+   * the transfer was created.
+   */
+  created_at: string;
+
+  /**
+   * The name the sender of the transfer specified as the recipient of the transfer.
+   */
+  creditor_name: string;
+
+  /**
+   * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's
+   * currency. This will always be "USD" for a FedNow transfer.
+   *
+   * - `CAD` - Canadian Dollar (CAD)
+   * - `CHF` - Swiss Franc (CHF)
+   * - `EUR` - Euro (EUR)
+   * - `GBP` - British Pound (GBP)
+   * - `JPY` - Japanese Yen (JPY)
+   * - `USD` - US Dollar (USD)
+   */
+  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+
+  /**
+   * The account number of the account that sent the transfer.
+   */
+  debtor_account_number: string;
+
+  /**
+   * The name provided by the sender of the transfer.
+   */
+  debtor_name: string;
+
+  /**
+   * The routing number of the account that sent the transfer.
+   */
+  debtor_routing_number: string;
+
+  /**
+   * If your transfer is declined, this will contain details of the decline.
+   */
+  decline: InboundFednowTransfer.Decline | null;
+
+  /**
+   * The lifecycle status of the transfer.
+   *
+   * - `pending_confirming` - The transfer is pending confirmation.
+   * - `timed_out` - The transfer was not responded to in time.
+   * - `confirmed` - The transfer has been received successfully and is confirmed.
+   * - `declined` - The transfer has been declined.
+   * - `requires_attention` - The transfer requires attention from an Increase
+   *   operator.
+   */
+  status: 'pending_confirming' | 'timed_out' | 'confirmed' | 'declined' | 'requires_attention';
+
+  /**
+   * The identifier of the Transaction object created when the transfer was
+   * confirmed.
+   */
+  transaction_id: string | null;
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `inbound_fednow_transfer`.
+   */
+  type: 'inbound_fednow_transfer';
+
+  /**
+   * Additional information included with the transfer.
+   */
+  unstructured_remittance_information: string | null;
+}
+
+export namespace InboundFednowTransfer {
+  /**
+   * If your transfer is confirmed, this will contain details of the confirmation.
+   */
+  export interface Confirmation {
+    /**
+     * The identifier of the FedNow Transfer that led to this Transaction.
+     */
+    transfer_id: string;
+  }
+
+  /**
+   * If your transfer is declined, this will contain details of the decline.
+   */
+  export interface Decline {
+    /**
+     * Why the transfer was declined.
+     *
+     * - `account_number_canceled` - The account number is canceled.
+     * - `account_number_disabled` - The account number is disabled.
+     * - `account_restricted` - Your account is restricted.
+     * - `group_locked` - Your account is inactive.
+     * - `entity_not_active` - The account's entity is not active.
+     * - `fednow_not_enabled` - Your account is not enabled to receive FedNow
+     *   transfers.
+     */
+    reason:
+      | 'account_number_canceled'
+      | 'account_number_disabled'
+      | 'account_restricted'
+      | 'group_locked'
+      | 'entity_not_active'
+      | 'fednow_not_enabled';
+
+    /**
+     * The identifier of the FedNow Transfer that led to this declined transaction.
+     */
+    transfer_id: string;
+  }
+}
+
+export interface InboundFednowTransferListParams extends PageParams {
+  /**
+   * Filter Inbound FedNow Transfers to those belonging to the specified Account.
+   */
+  account_id?: string;
+
+  /**
+   * Filter Inbound FedNow Transfers to ones belonging to the specified Account
+   * Number.
+   */
+  account_number_id?: string;
+
+  created_at?: InboundFednowTransferListParams.CreatedAt;
+}
+
+export namespace InboundFednowTransferListParams {
+  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;
+  }
+}
+
+InboundFednowTransfers.InboundFednowTransfersPage = InboundFednowTransfersPage;
+
+export declare namespace InboundFednowTransfers {
+  export {
+    type InboundFednowTransfer as InboundFednowTransfer,
+    InboundFednowTransfersPage as InboundFednowTransfersPage,
+    type InboundFednowTransferListParams as InboundFednowTransferListParams,
+  };
+}

package/src/resources/index.ts

@@ -202,6 +202,13 @@ export {
   type ExternalAccountUpdateParams,
   type ExternalAccountListParams,
 } from './external-accounts';
+export {
+  FednowTransfersPage,
+  FednowTransfers,
+  type FednowTransfer,
+  type FednowTransferCreateParams,
+  type FednowTransferListParams,
+} from './fednow-transfers';
 export { FileLinks, type FileLink, type FileLinkCreateParams } from './file-links';
 export { FilesPage, Files, type File, type FileCreateParams, type FileListParams } from './files';
 export { Groups, type Group } from './groups';
@@ -221,6 +228,12 @@ export {
   type InboundCheckDepositListParams,
   type InboundCheckDepositReturnParams,
 } from './inbound-check-deposits';
+export {
+  InboundFednowTransfersPage,
+  InboundFednowTransfers,
+  type InboundFednowTransfer,
+  type InboundFednowTransferListParams,
+} from './inbound-fednow-transfers';
 export {
   InboundMailItemsPage,
   InboundMailItems,

package/src/resources/simulations/inbound-fednow-transfers.ts

@@ -0,0 +1,64 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as InboundFednowTransfersAPI from '../inbound-fednow-transfers';
+
+export class InboundFednowTransfers extends APIResource {
+  /**
+   * Simulates an [Inbound FedNow Transfer](#inbound-fednow-transfers) to your
+   * account.
+   *
+   * @example
+   * ```ts
+   * const inboundFednowTransfer =
+   *   await client.simulations.inboundFednowTransfers.create({
+   *     account_number_id:
+   *       'account_number_v18nkfqm6afpsrvy82b2',
+   *     amount: 1000,
+   *   });
+   * ```
+   */
+  create(
+    body: InboundFednowTransferCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<InboundFednowTransfersAPI.InboundFednowTransfer> {
+    return this._client.post('/simulations/inbound_fednow_transfers', { body, ...options });
+  }
+}
+
+export interface InboundFednowTransferCreateParams {
+  /**
+   * The identifier of the Account Number the inbound FedNow Transfer is for.
+   */
+  account_number_id: string;
+
+  /**
+   * The transfer amount in USD cents. Must be positive.
+   */
+  amount: number;
+
+  /**
+   * The account number of the account that sent the transfer.
+   */
+  debtor_account_number?: string;
+
+  /**
+   * The name provided by the sender of the transfer.
+   */
+  debtor_name?: string;
+
+  /**
+   * The routing number of the account that sent the transfer.
+   */
+  debtor_routing_number?: string;
+
+  /**
+   * Additional information included with the transfer.
+   */
+  unstructured_remittance_information?: string;
+}
+
+export declare namespace InboundFednowTransfers {
+  export { type InboundFednowTransferCreateParams as InboundFednowTransferCreateParams };
+}

package/src/resources/simulations/index.ts

@@ -34,6 +34,7 @@ export {
 export { Documents, type DocumentCreateParams } from './documents';
 export { InboundACHTransfers, type InboundACHTransferCreateParams } from './inbound-ach-transfers';
 export { InboundCheckDeposits, type InboundCheckDepositCreateParams } from './inbound-check-deposits';
+export { InboundFednowTransfers, type InboundFednowTransferCreateParams } from './inbound-fednow-transfers';
 export { InboundMailItems, type InboundMailItemCreateParams } from './inbound-mail-items';
 export {
   InboundRealTimePaymentsTransfers,

package/src/resources/simulations/simulations.ts

@@ -53,6 +53,8 @@ import * as InboundACHTransfersAPI from './inbound-ach-transfers';
 import { InboundACHTransferCreateParams, InboundACHTransfers } from './inbound-ach-transfers';
 import * as InboundCheckDepositsAPI from './inbound-check-deposits';
 import { InboundCheckDepositCreateParams, InboundCheckDeposits } from './inbound-check-deposits';
+import * as InboundFednowTransfersAPI from './inbound-fednow-transfers';
+import { InboundFednowTransferCreateParams, InboundFednowTransfers } from './inbound-fednow-transfers';
 import * as InboundMailItemsAPI from './inbound-mail-items';
 import { InboundMailItemCreateParams, InboundMailItems } from './inbound-mail-items';
 import * as InboundRealTimePaymentsTransfersAPI from './inbound-real-time-payments-transfers';
@@ -126,6 +128,8 @@ export class Simulations extends APIResource {
     new RealTimePaymentsTransfersAPI.RealTimePaymentsTransfers(this._client);
   inboundRealTimePaymentsTransfers: InboundRealTimePaymentsTransfersAPI.InboundRealTimePaymentsTransfers =
     new InboundRealTimePaymentsTransfersAPI.InboundRealTimePaymentsTransfers(this._client);
+  inboundFednowTransfers: InboundFednowTransfersAPI.InboundFednowTransfers =
+    new InboundFednowTransfersAPI.InboundFednowTransfers(this._client);
   checkDeposits: CheckDepositsAPI.CheckDeposits = new CheckDepositsAPI.CheckDeposits(this._client);
   inboundMailItems: InboundMailItemsAPI.InboundMailItems = new InboundMailItemsAPI.InboundMailItems(
     this._client,
@@ -161,6 +165,7 @@ Simulations.CheckTransfers = CheckTransfers;
 Simulations.InboundCheckDeposits = InboundCheckDeposits;
 Simulations.RealTimePaymentsTransfers = RealTimePaymentsTransfers;
 Simulations.InboundRealTimePaymentsTransfers = InboundRealTimePaymentsTransfers;
+Simulations.InboundFednowTransfers = InboundFednowTransfers;
 Simulations.CheckDeposits = CheckDeposits;
 Simulations.InboundMailItems = InboundMailItems;
 Simulations.Programs = Programs;
@@ -262,6 +267,11 @@ export declare namespace Simulations {
     type InboundRealTimePaymentsTransferCreateParams as InboundRealTimePaymentsTransferCreateParams,
   };
 
+  export {
+    InboundFednowTransfers as InboundFednowTransfers,
+    type InboundFednowTransferCreateParams as InboundFednowTransferCreateParams,
+  };
+
   export { CheckDeposits as CheckDeposits };
 
   export {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.339.0'; // x-release-please-version
+export const VERSION = '0.340.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.339.0";
+export declare const VERSION = "0.340.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.339.0'; // x-release-please-version
+exports.VERSION = '0.340.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.339.0'; // x-release-please-version
+export const VERSION = '0.340.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map