increase 0.54.0 → 0.57.0

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(

package/src/resources/lockboxes.ts

@@ -0,0 +1,238 @@
+// 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 LockboxesAPI from './lockboxes';
+import { Page, type PageParams } from '../pagination';
+
+export class Lockboxes extends APIResource {
+  /**
+   * Create a Lockbox
+   */
+  create(body: LockboxCreateParams, options?: Core.RequestOptions): Core.APIPromise<Lockbox> {
+    return this._client.post('/lockboxes', { body, ...options });
+  }
+
+  /**
+   * Retrieve a Lockbox
+   */
+  retrieve(lockboxId: string, options?: Core.RequestOptions): Core.APIPromise<Lockbox> {
+    return this._client.get(`/lockboxes/${lockboxId}`, options);
+  }
+
+  /**
+   * Update a Lockbox
+   */
+  update(
+    lockboxId: string,
+    body: LockboxUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Lockbox> {
+    return this._client.patch(`/lockboxes/${lockboxId}`, { body, ...options });
+  }
+
+  /**
+   * List Lockboxes
+   */
+  list(query?: LockboxListParams, options?: Core.RequestOptions): Core.PagePromise<LockboxesPage, Lockbox>;
+  list(options?: Core.RequestOptions): Core.PagePromise<LockboxesPage, Lockbox>;
+  list(
+    query: LockboxListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<LockboxesPage, Lockbox> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.getAPIList('/lockboxes', LockboxesPage, { query, ...options });
+  }
+}
+
+export class LockboxesPage extends Page<Lockbox> {}
+
+/**
+ * Lockboxes are physical locations that can receive mail containing paper checks.
+ * Increase will automatically create a Check Deposit for checks received this way.
+ */
+export interface Lockbox {
+  /**
+   * The Lockbox identifier.
+   */
+  id: string;
+
+  /**
+   * The identifier for the Account checks sent to this lockbox will be deposited
+   * into.
+   */
+  account_id: string;
+
+  /**
+   * The mailing address for the Lockbox.
+   */
+  address: Lockbox.Address;
+
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
+   * was created.
+   */
+  created_at: string;
+
+  /**
+   * The description you choose for the Lockbox.
+   */
+  description: string | null;
+
+  /**
+   * The idempotency key you chose for this object. This value is unique across
+   * Increase and is used to ensure that a request is only processed once. Learn more
+   * about [idempotency](https://increase.com/documentation/idempotency-keys).
+   */
+  idempotency_key: string | null;
+
+  /**
+   * This indicates if mail can be sent to this address.
+   *
+   * - `active` - This Lockbox is active. Checks mailed to it will be deposited
+   *   automatically.
+   * - `inactive` - This Lockbox is inactive. Checks mailed to it will not be
+   *   deposited.
+   */
+  status: 'active' | 'inactive';
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `lockbox`.
+   */
+  type: 'lockbox';
+}
+
+export namespace Lockbox {
+  /**
+   * The mailing address for the Lockbox.
+   */
+  export interface Address {
+    /**
+     * The city of the address.
+     */
+    city: string;
+
+    /**
+     * The first line of the address.
+     */
+    line1: string;
+
+    /**
+     * The second line of the address.
+     */
+    line2: string;
+
+    /**
+     * The postal code of the address.
+     */
+    postal_code: string;
+
+    /**
+     * The two-letter United States Postal Service (USPS) abbreviation for the state of
+     * the address.
+     */
+    state: string;
+  }
+}
+
+/**
+ * A list of Lockbox objects.
+ */
+export interface LockboxList {
+  /**
+   * The contents of the list.
+   */
+  data: Array<Lockbox>;
+
+  /**
+   * A pointer to a place in the list.
+   */
+  next_cursor: string | null;
+}
+
+export interface LockboxCreateParams {
+  /**
+   * The Account checks sent to this Lockbox should be deposited into.
+   */
+  account_id: string;
+
+  /**
+   * The description you choose for the Lockbox, for display purposes.
+   */
+  description?: string;
+}
+
+export interface LockboxUpdateParams {
+  /**
+   * The description you choose for the Lockbox.
+   */
+  description?: string;
+
+  /**
+   * This indicates if checks can be sent to the Lockbox.
+   *
+   * - `active` - This Lockbox is active. Checks mailed to it will be deposited
+   *   automatically.
+   * - `inactive` - This Lockbox is inactive. Checks mailed to it will not be
+   *   deposited.
+   */
+  status?: 'active' | 'inactive';
+}
+
+export interface LockboxListParams extends PageParams {
+  /**
+   * Filter Lockboxes to those associated with the provided Account.
+   */
+  account_id?: string;
+
+  created_at?: LockboxListParams.CreatedAt;
+
+  /**
+   * Filter records to the one with the specified `idempotency_key` you chose for
+   * that object. This value is unique across Increase and is used to ensure that a
+   * request is only processed once. Learn more about
+   * [idempotency](https://increase.com/documentation/idempotency-keys).
+   */
+  idempotency_key?: string;
+}
+
+export namespace LockboxListParams {
+  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 Lockboxes {
+  export import Lockbox = LockboxesAPI.Lockbox;
+  export import LockboxList = LockboxesAPI.LockboxList;
+  export import LockboxesPage = LockboxesAPI.LockboxesPage;
+  export import LockboxCreateParams = LockboxesAPI.LockboxCreateParams;
+  export import LockboxUpdateParams = LockboxesAPI.LockboxUpdateParams;
+  export import LockboxListParams = LockboxesAPI.LockboxListParams;
+}

package/src/resources/oauth-connections.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 OAuthConnectionsAPI from "./oauth-connections";
-import { Page, type PageParams } from "../pagination";
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as OAuthConnectionsAPI from './oauth-connections';
+import { Page, type PageParams } from '../pagination';
 
 export class OAuthConnections extends APIResource {
   /**

package/src/resources/oauth-tokens.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 OAuthTokensAPI from "./oauth-tokens";
+import { APIResource } from '../resource';
+import * as Core from '../core';
+import * as OAuthTokensAPI from './oauth-tokens';
 
 export class OAuthTokens extends APIResource {
   /**

package/src/resources/pending-transactions.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 PendingTransactionsAPI from "./pending-transactions";
-import { Page, type PageParams } from "../pagination";
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as PendingTransactionsAPI from './pending-transactions';
+import { Page, type PageParams } from '../pagination';
 
 export class PendingTransactions extends APIResource {
   /**
@@ -100,8 +100,9 @@ export interface PendingTransaction {
    *
    * - `account_number` - An Account Number.
    * - `card` - A Card.
+   * - `lockbox` - A Lockbox.
    */
-  route_type: 'account_number' | 'card' | null;
+  route_type: 'account_number' | 'card' | 'lockbox' | null;
 
   /**
    * This is an object giving more details on the network-level event that caused the
@@ -298,7 +299,7 @@ export namespace PendingTransaction {
       /**
        * The ID of the Card Payment this transaction belongs to.
        */
-      card_payment_id: string | null;
+      card_payment_id: string;
 
       /**
        * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
@@ -390,6 +391,17 @@ export namespace PendingTransaction {
        */
       physical_card_id: string | null;
 
+      /**
+       * The pending amount in the minor unit of the transaction's presentment currency.
+       */
+      presentment_amount: number;
+
+      /**
+       * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
+       * transaction's presentment currency.
+       */
+      presentment_currency: string;
+
       /**
        * The processing category describes the intent behind the authorization, such as
        * whether it was used for bill payments or an automatic fuel dispenser.

package/src/resources/physical-card-profiles.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 PhysicalCardProfilesAPI from "./physical-card-profiles";
-import { Page, type PageParams } from "../pagination";
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as PhysicalCardProfilesAPI from './physical-card-profiles';
+import { Page, type PageParams } from '../pagination';
 
 export class PhysicalCardProfiles extends APIResource {
   /**