increase 0.54.0 → 0.58.0

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

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../core";
-import { APIResource } from "../resource";
-import { isRequestOptions } from "../core";
-import * as InboundACHTransfersAPI from "./inbound-ach-transfers";
-import { Page, type PageParams } from "../pagination";
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as InboundACHTransfersAPI from './inbound-ach-transfers';
+import { Page, type PageParams } from '../pagination';
 
 export class InboundACHTransfers extends APIResource {
   /**
@@ -170,6 +170,42 @@ export interface InboundACHTransfer {
    */
   receiver_name: string | null;
 
+  /**
+   * The Standard Entry Class (SEC) code of the transfer.
+   *
+   * - `corporate_credit_or_debit` - Corporate Credit and Debit (CCD).
+   * - `corporate_trade_exchange` - Corporate Trade Exchange (CTX).
+   * - `prearranged_payments_and_deposit` - Prearranged Payments and Deposits (PPD).
+   * - `internet_initiated` - Internet Initiated (WEB).
+   * - `point_of_sale` - Point of Sale (POS).
+   * - `telephone_initiated` - Telephone Initiated (TEL).
+   * - `customer_initiated` - Customer Initiated (CIE).
+   * - `accounts_receivable` - Accounts Receivable (ARC).
+   * - `machine_transfer` - Machine Transfer (MTE).
+   * - `shared_network_transaction` - Shared Network Transaction (SHR).
+   * - `represented_check` - Represented Check (RCK).
+   * - `back_office_conversion` - Back Office Conversion (BOC).
+   * - `point_of_purchase` - Point of Purchase (POP).
+   * - `check_truncation` - Check Truncation (TRC).
+   * - `destroyed_check` - Destroyed Check (XCK).
+   */
+  standard_entry_class_code:
+    | 'corporate_credit_or_debit'
+    | 'corporate_trade_exchange'
+    | 'prearranged_payments_and_deposit'
+    | 'internet_initiated'
+    | 'point_of_sale'
+    | 'telephone_initiated'
+    | 'customer_initiated'
+    | 'accounts_receivable'
+    | 'machine_transfer'
+    | 'shared_network_transaction'
+    | 'represented_check'
+    | 'back_office_conversion'
+    | 'point_of_purchase'
+    | 'check_truncation'
+    | 'destroyed_check';
+
   /**
    * The status of the transfer.
    *
@@ -278,6 +314,7 @@ export namespace InboundACHTransfer {
      * - `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.
+     * - `field_error` - There was an error with one of the required fields.
      * - `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
@@ -298,6 +335,7 @@ export namespace InboundACHTransfer {
       | 'credit_entry_refused_by_receiver'
       | 'duplicate_return'
       | 'entity_not_active'
+      | 'field_error'
       | 'group_locked'
       | 'insufficient_funds'
       | 'misrouted_return'

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

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../core";
-import { APIResource } from "../resource";
-import { isRequestOptions } from "../core";
-import * as InboundCheckDepositsAPI from "./inbound-check-deposits";
-import { Page, type PageParams } from "../pagination";
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as InboundCheckDepositsAPI from './inbound-check-deposits';
+import { Page, type PageParams } from '../pagination';
 
 export class InboundCheckDeposits extends APIResource {
   /**
@@ -138,6 +138,12 @@ export interface InboundCheckDeposit {
    */
   declined_transaction_id: string | null;
 
+  /**
+   * If you requested a return of this deposit, this will contain details of the
+   * return.
+   */
+  deposit_return: InboundCheckDeposit.DepositReturn | null;
+
   /**
    * The ID for the File containing the image of the front of the check.
    */
@@ -165,6 +171,24 @@ export interface InboundCheckDeposit {
   type: 'inbound_check_deposit';
 }
 
+export namespace InboundCheckDeposit {
+  /**
+   * If you requested a return of this deposit, this will contain details of the
+   * return.
+   */
+  export interface DepositReturn {
+    /**
+     * The time at which the deposit was returned.
+     */
+    returned_at: string;
+
+    /**
+     * The id of the transaction for the returned deposit.
+     */
+    transaction_id: string;
+  }
+}
+
 export interface InboundCheckDepositListParams extends PageParams {
   /**
    * Filter Inbound Check Deposits to those belonging to the specified Account.

package/src/resources/inbound-mail-items.ts

@@ -0,0 +1,193 @@
+// 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 * as InboundMailItemsAPI from './inbound-mail-items';
+import { Page, type PageParams } from '../pagination';
+
+export class InboundMailItems extends APIResource {
+  /**
+   * Retrieve an Inbound Mail Item
+   */
+  retrieve(inboundMailItemId: string, options?: Core.RequestOptions): Core.APIPromise<InboundMailItem> {
+    return this._client.get(`/inbound_mail_items/${inboundMailItemId}`, options);
+  }
+
+  /**
+   * List Inbound Mail Items
+   */
+  list(
+    query?: InboundMailItemListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<InboundMailItemsPage, InboundMailItem>;
+  list(options?: Core.RequestOptions): Core.PagePromise<InboundMailItemsPage, InboundMailItem>;
+  list(
+    query: InboundMailItemListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<InboundMailItemsPage, InboundMailItem> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.getAPIList('/inbound_mail_items', InboundMailItemsPage, { query, ...options });
+  }
+}
+
+export class InboundMailItemsPage extends Page<InboundMailItem> {}
+
+/**
+ * Inbound Mail Items represent pieces of physical mail delivered to a Lockbox.
+ */
+export interface InboundMailItem {
+  /**
+   * The Inbound Mail Item identifier.
+   */
+  id: string;
+
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Inbound
+   * Mail Item was created.
+   */
+  created_at: string;
+
+  /**
+   * The identifier for the File containing the scanned contents of the mail item.
+   */
+  file_id: string;
+
+  /**
+   * The identifier for the Lockbox that received this mail item. For mail items that
+   * could not be processed due to an invalid address, this will be null.
+   */
+  lockbox_id: string | null;
+
+  /**
+   * The recipient name as written on the mail item.
+   */
+  recipient_name: string | null;
+
+  /**
+   * If the mail item has been rejected, why it was rejected.
+   *
+   * - `no_matching_lockbox` - The mail item does not match any lockbox.
+   * - `no_check` - The mail item does not contain a check.
+   * - `lockbox_not_active` - The Lockbox or its associataed Account is not active.
+   */
+  rejection_reason: 'no_matching_lockbox' | 'no_check' | 'lockbox_not_active' | null;
+
+  /**
+   * The return address as written on the mail item.
+   */
+  return_address: InboundMailItem.ReturnAddress | null;
+
+  /**
+   * If the mail item has been processed.
+   *
+   * - `pending` - The mail item is pending processing.
+   * - `processed` - The mail item has been processed.
+   * - `rejected` - The mail item has been rejected.
+   */
+  status: 'pending' | 'processed' | 'rejected';
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `inbound_mail_item`.
+   */
+  type: 'inbound_mail_item';
+}
+
+export namespace InboundMailItem {
+  /**
+   * The return address as written on the mail item.
+   */
+  export interface ReturnAddress {
+    /**
+     * The return address city.
+     */
+    city: string | null;
+
+    /**
+     * The return address line1.
+     */
+    line1: string | null;
+
+    /**
+     * The return address line2.
+     */
+    line2: string | null;
+
+    /**
+     * The return address name.
+     */
+    name: string | null;
+
+    /**
+     * The return address postal code.
+     */
+    postal_code: string | null;
+
+    /**
+     * The return address state.
+     */
+    state: string | null;
+  }
+}
+
+/**
+ * A list of Inbound Mail Item objects.
+ */
+export interface InboundMailItemList {
+  /**
+   * The contents of the list.
+   */
+  data: Array<InboundMailItem>;
+
+  /**
+   * A pointer to a place in the list.
+   */
+  next_cursor: string | null;
+}
+
+export interface InboundMailItemListParams extends PageParams {
+  created_at?: InboundMailItemListParams.CreatedAt;
+
+  /**
+   * Filter Inbound Mail Items to ones sent to the provided Lockbox.
+   */
+  lockbox_id?: string;
+}
+
+export namespace InboundMailItemListParams {
+  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;
+  }
+}
+
+export namespace InboundMailItems {
+  export import InboundMailItem = InboundMailItemsAPI.InboundMailItem;
+  export import InboundMailItemList = InboundMailItemsAPI.InboundMailItemList;
+  export import InboundMailItemsPage = InboundMailItemsAPI.InboundMailItemsPage;
+  export import InboundMailItemListParams = InboundMailItemsAPI.InboundMailItemListParams;
+}

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

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../core";
-import { APIResource } from "../resource";
-import { isRequestOptions } from "../core";
-import * as InboundWireDrawdownRequestsAPI from "./inbound-wire-drawdown-requests";
-import { Page, type PageParams } from "../pagination";
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as InboundWireDrawdownRequestsAPI from './inbound-wire-drawdown-requests';
+import { Page, type PageParams } from '../pagination';
 
 export class InboundWireDrawdownRequests extends APIResource {
   /**

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

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../core";
-import { APIResource } from "../resource";
-import { isRequestOptions } from "../core";
-import * as InboundWireTransfersAPI from "./inbound-wire-transfers";
-import { Page, type PageParams } from "../pagination";
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as InboundWireTransfersAPI from './inbound-wire-transfers';
+import { Page, type PageParams } from '../pagination';
 
 export class InboundWireTransfers extends APIResource {
   /**

package/src/resources/index.ts

@@ -170,6 +170,13 @@ export {
   InboundCheckDepositsPage,
   InboundCheckDeposits,
 } from './inbound-check-deposits';
+export {
+  InboundMailItem,
+  InboundMailItemList,
+  InboundMailItemListParams,
+  InboundMailItemsPage,
+  InboundMailItems,
+} from './inbound-mail-items';
 export {
   InboundWireDrawdownRequest,
   InboundWireDrawdownRequestListParams,
@@ -183,6 +190,15 @@ export {
   InboundWireTransfers,
 } from './inbound-wire-transfers';
 export { Intrafi } from './intrafi/intrafi';
+export {
+  Lockbox,
+  LockboxList,
+  LockboxCreateParams,
+  LockboxUpdateParams,
+  LockboxListParams,
+  LockboxesPage,
+  Lockboxes,
+} from './lockboxes';
 export {
   OAuthConnection,
   OAuthConnectionListParams,

package/src/resources/intrafi/account-enrollments.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../../core";
-import { APIResource } from "../../resource";
-import { isRequestOptions } from "../../core";
-import * as AccountEnrollmentsAPI from "./account-enrollments";
-import { Page, type PageParams } from "../../pagination";
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as Core from '../../core';
+import * as AccountEnrollmentsAPI from './account-enrollments';
+import { Page, type PageParams } from '../../pagination';
 
 export class AccountEnrollments extends APIResource {
   /**

package/src/resources/intrafi/balances.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../../core";
-import { APIResource } from "../../resource";
-import * as BalancesAPI from "./balances";
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as BalancesAPI from './balances';
 
 export class Balances extends APIResource {
   /**
@@ -19,6 +19,11 @@ export class Balances extends APIResource {
  * banks as needed once per business day.
  */
 export interface IntrafiBalance {
+  /**
+   * The identifier of this balance.
+   */
+  id: string;
+
   /**
    * Each entry represents a balance held at a different bank. IntraFi separates the
    * total balance across many participating banks in the network.
@@ -58,6 +63,11 @@ export interface IntrafiBalance {
 
 export namespace IntrafiBalance {
   export interface Balance {
+    /**
+     * The identifier of this balance.
+     */
+    id: string;
+
     /**
      * The balance, in minor units of `currency`, held with this bank.
      */

package/src/resources/intrafi/exclusions.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../../core";
-import { APIResource } from "../../resource";
-import { isRequestOptions } from "../../core";
-import * as ExclusionsAPI from "./exclusions";
-import { Page, type PageParams } from "../../pagination";
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as Core from '../../core';
+import * as ExclusionsAPI from './exclusions';
+import { Page, type PageParams } from '../../pagination';
 
 export class Exclusions extends APIResource {
   /**

package/src/resources/intrafi/intrafi.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../../resource";
-import * as AccountEnrollmentsAPI from "./account-enrollments";
-import * as BalancesAPI from "./balances";
-import * as ExclusionsAPI from "./exclusions";
+import { APIResource } from '../../resource';
+import * as AccountEnrollmentsAPI from './account-enrollments';
+import * as BalancesAPI from './balances';
+import * as ExclusionsAPI from './exclusions';
 
 export class Intrafi extends APIResource {
   accountEnrollments: AccountEnrollmentsAPI.AccountEnrollments = new AccountEnrollmentsAPI.AccountEnrollments(