increase 0.539.0 → 0.540.0

package/src/client.ts

@@ -268,13 +268,21 @@ import {
   IntrafiExclusionsPage,
 } from './resources/intrafi-exclusions';
 import {
-  Lockbox,
-  LockboxCreateParams,
-  LockboxListParams,
-  LockboxUpdateParams,
-  Lockboxes,
-  LockboxesPage,
-} from './resources/lockboxes';
+  LockboxAddress,
+  LockboxAddressCreateParams,
+  LockboxAddressListParams,
+  LockboxAddressUpdateParams,
+  LockboxAddresses,
+  LockboxAddressesPage,
+} from './resources/lockbox-addresses';
+import {
+  LockboxRecipient,
+  LockboxRecipientCreateParams,
+  LockboxRecipientListParams,
+  LockboxRecipientUpdateParams,
+  LockboxRecipients,
+  LockboxRecipientsPage,
+} from './resources/lockbox-recipients';
 import {
   OAuthApplication,
   OAuthApplicationListParams,
@@ -1162,7 +1170,8 @@ export class Increase {
   inboundFednowTransfers: API.InboundFednowTransfers = new API.InboundFednowTransfers(this);
   swiftTransfers: API.SwiftTransfers = new API.SwiftTransfers(this);
   checkDeposits: API.CheckDeposits = new API.CheckDeposits(this);
-  lockboxes: API.Lockboxes = new API.Lockboxes(this);
+  lockboxAddresses: API.LockboxAddresses = new API.LockboxAddresses(this);
+  lockboxRecipients: API.LockboxRecipients = new API.LockboxRecipients(this);
   inboundMailItems: API.InboundMailItems = new API.InboundMailItems(this);
   routingNumbers: API.RoutingNumbers = new API.RoutingNumbers(this);
   externalAccounts: API.ExternalAccounts = new API.ExternalAccounts(this);
@@ -1220,7 +1229,8 @@ Increase.FednowTransfers = FednowTransfers;
 Increase.InboundFednowTransfers = InboundFednowTransfers;
 Increase.SwiftTransfers = SwiftTransfers;
 Increase.CheckDeposits = CheckDeposits;
-Increase.Lockboxes = Lockboxes;
+Increase.LockboxAddresses = LockboxAddresses;
+Increase.LockboxRecipients = LockboxRecipients;
 Increase.InboundMailItems = InboundMailItems;
 Increase.RoutingNumbers = RoutingNumbers;
 Increase.ExternalAccounts = ExternalAccounts;
@@ -1496,12 +1506,21 @@ export declare namespace Increase {
   };
 
   export {
-    Lockboxes as Lockboxes,
-    type Lockbox as Lockbox,
-    type LockboxesPage as LockboxesPage,
-    type LockboxCreateParams as LockboxCreateParams,
-    type LockboxUpdateParams as LockboxUpdateParams,
-    type LockboxListParams as LockboxListParams,
+    LockboxAddresses as LockboxAddresses,
+    type LockboxAddress as LockboxAddress,
+    type LockboxAddressesPage as LockboxAddressesPage,
+    type LockboxAddressCreateParams as LockboxAddressCreateParams,
+    type LockboxAddressUpdateParams as LockboxAddressUpdateParams,
+    type LockboxAddressListParams as LockboxAddressListParams,
+  };
+
+  export {
+    LockboxRecipients as LockboxRecipients,
+    type LockboxRecipient as LockboxRecipient,
+    type LockboxRecipientsPage as LockboxRecipientsPage,
+    type LockboxRecipientCreateParams as LockboxRecipientCreateParams,
+    type LockboxRecipientUpdateParams as LockboxRecipientUpdateParams,
+    type LockboxRecipientListParams as LockboxRecipientListParams,
   };
 
   export {

package/src/resources/check-deposits.ts

@@ -149,10 +149,11 @@ export interface CheckDeposit {
   inbound_mail_item_id: string | null;
 
   /**
-   * If the Check Deposit was the result of an Inbound Mail Item, this will contain
-   * the identifier of the Lockbox that received it.
+   * If the Check Deposit was the result of an Inbound Mail Item routed to a Lockbox
+   * Recipient, this will contain the identifier of the Lockbox Recipient that
+   * received it.
    */
-  lockbox_id: string | null;
+  lockbox_recipient_id: string | null;
 
   /**
    * The status of the Check Deposit.

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

@@ -66,7 +66,8 @@ export class InboundMailItems extends APIResource {
 export type InboundMailItemsPage = Page<InboundMailItem>;
 
 /**
- * Inbound Mail Items represent pieces of physical mail delivered to a Lockbox.
+ * Inbound Mail Items represent pieces of physical mail delivered to a Lockbox
+ * Address.
  */
 export interface InboundMailItem {
   /**
@@ -91,10 +92,15 @@ export interface InboundMailItem {
   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.
+   * The identifier for the Lockbox Address that received this mail item.
    */
-  lockbox_id: string | null;
+  lockbox_address_id: string | null;
+
+  /**
+   * The identifier for the Lockbox Recipient that received this mail item. For mail
+   * items that could not be routed to a Lockbox Recipient, this will be null.
+   */
+  lockbox_recipient_id: string | null;
 
   /**
    * The recipient name as written on the mail item.
@@ -107,8 +113,17 @@ export interface InboundMailItem {
    * - `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 associated Account is not active.
+   * - `lockbox_address_not_active` - The Lockbox Address is not active.
+   * - `lockbox_recipient_not_active` - The Lockbox Recipient or its associated
+   *   Account is not active.
    */
-  rejection_reason: 'no_matching_lockbox' | 'no_check' | 'lockbox_not_active' | null;
+  rejection_reason:
+    | 'no_matching_lockbox'
+    | 'no_check'
+    | 'lockbox_not_active'
+    | 'lockbox_address_not_active'
+    | 'lockbox_recipient_not_active'
+    | null;
 
   /**
    * If the mail item has been processed.
@@ -168,9 +183,14 @@ export interface InboundMailItemListParams extends PageParams {
   created_at?: InboundMailItemListParams.CreatedAt;
 
   /**
-   * Filter Inbound Mail Items to ones sent to the provided Lockbox.
+   * Filter Inbound Mail Items to ones sent to the provided Lockbox Address.
+   */
+  lockbox_address_id?: string;
+
+  /**
+   * Filter Inbound Mail Items to ones sent to the provided Lockbox Recipient.
    */
-  lockbox_id?: string;
+  lockbox_recipient_id?: string;
 }
 
 export namespace InboundMailItemListParams {

package/src/resources/index.ts

@@ -255,13 +255,21 @@ export {
   type IntrafiExclusionsPage,
 } from './intrafi-exclusions';
 export {
-  Lockboxes,
-  type Lockbox,
-  type LockboxCreateParams,
-  type LockboxUpdateParams,
-  type LockboxListParams,
-  type LockboxesPage,
-} from './lockboxes';
+  LockboxAddresses,
+  type LockboxAddress,
+  type LockboxAddressCreateParams,
+  type LockboxAddressUpdateParams,
+  type LockboxAddressListParams,
+  type LockboxAddressesPage,
+} from './lockbox-addresses';
+export {
+  LockboxRecipients,
+  type LockboxRecipient,
+  type LockboxRecipientCreateParams,
+  type LockboxRecipientUpdateParams,
+  type LockboxRecipientListParams,
+  type LockboxRecipientsPage,
+} from './lockbox-recipients';
 export {
   OAuthApplications,
   type OAuthApplication,

package/src/resources/lockbox-addresses.ts

@@ -0,0 +1,235 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { Page, type PageParams, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class LockboxAddresses extends APIResource {
+  /**
+   * Create a Lockbox Address
+   *
+   * @example
+   * ```ts
+   * const lockboxAddress =
+   *   await client.lockboxAddresses.create();
+   * ```
+   */
+  create(body: LockboxAddressCreateParams, options?: RequestOptions): APIPromise<LockboxAddress> {
+    return this._client.post('/lockbox_addresses', { body, ...options });
+  }
+
+  /**
+   * Retrieve a Lockbox Address
+   *
+   * @example
+   * ```ts
+   * const lockboxAddress =
+   *   await client.lockboxAddresses.retrieve(
+   *     'lockbox_address_lw6sbzl9ol5dfd8hdml6',
+   *   );
+   * ```
+   */
+  retrieve(lockboxAddressID: string, options?: RequestOptions): APIPromise<LockboxAddress> {
+    return this._client.get(path`/lockbox_addresses/${lockboxAddressID}`, options);
+  }
+
+  /**
+   * Update a Lockbox Address
+   *
+   * @example
+   * ```ts
+   * const lockboxAddress = await client.lockboxAddresses.update(
+   *   'lockbox_address_lw6sbzl9ol5dfd8hdml6',
+   * );
+   * ```
+   */
+  update(
+    lockboxAddressID: string,
+    body: LockboxAddressUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<LockboxAddress> {
+    return this._client.patch(path`/lockbox_addresses/${lockboxAddressID}`, { body, ...options });
+  }
+
+  /**
+   * List Lockbox Addresses
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const lockboxAddress of client.lockboxAddresses.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: LockboxAddressListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<LockboxAddressesPage, LockboxAddress> {
+    return this._client.getAPIList('/lockbox_addresses', Page<LockboxAddress>, { query, ...options });
+  }
+}
+
+export type LockboxAddressesPage = Page<LockboxAddress>;
+
+/**
+ * Lockbox Addresses are physical locations that can receive mail containing paper
+ * checks.
+ */
+export interface LockboxAddress {
+  /**
+   * The Lockbox Address identifier.
+   */
+  id: string;
+
+  /**
+   * The mailing address for the Lockbox Address. It will be present after Increase
+   * generates it.
+   */
+  address: LockboxAddress.Address | null;
+
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
+   * Address was created.
+   */
+  created_at: string;
+
+  /**
+   * The description you choose for the Lockbox Address.
+   */
+  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;
+
+  /**
+   * The status of the Lockbox Address.
+   *
+   * - `pending` - Increase is generating this Lockbox Address.
+   * - `active` - This Lockbox Address is active.
+   * - `disabled` - This Lockbox Address is disabled.
+   * - `canceled` - This Lockbox Address is permanently disabled.
+   */
+  status: 'pending' | 'active' | 'disabled' | 'canceled';
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `lockbox_address`.
+   */
+  type: 'lockbox_address';
+}
+
+export namespace LockboxAddress {
+  /**
+   * The mailing address for the Lockbox Address. It will be present after Increase
+   * generates it.
+   */
+  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;
+  }
+}
+
+export interface LockboxAddressCreateParams {
+  /**
+   * The description you choose for the Lockbox Address.
+   */
+  description?: string;
+
+  [k: string]: unknown;
+}
+
+export interface LockboxAddressUpdateParams {
+  /**
+   * The description you choose for the Lockbox Address.
+   */
+  description?: string;
+
+  /**
+   * The status of the Lockbox Address.
+   *
+   * - `active` - This Lockbox Address is active.
+   * - `disabled` - This Lockbox Address is disabled.
+   * - `canceled` - This Lockbox Address is permanently disabled.
+   */
+  status?: 'active' | 'disabled' | 'canceled';
+}
+
+export interface LockboxAddressListParams extends PageParams {
+  created_at?: LockboxAddressListParams.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 LockboxAddressListParams {
+  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 declare namespace LockboxAddresses {
+  export {
+    type LockboxAddress as LockboxAddress,
+    type LockboxAddressesPage as LockboxAddressesPage,
+    type LockboxAddressCreateParams as LockboxAddressCreateParams,
+    type LockboxAddressUpdateParams as LockboxAddressUpdateParams,
+    type LockboxAddressListParams as LockboxAddressListParams,
+  };
+}

package/src/resources/lockbox-recipients.ts

@@ -0,0 +1,257 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { Page, type PageParams, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class LockboxRecipients extends APIResource {
+  /**
+   * Create a Lockbox Recipient
+   *
+   * @example
+   * ```ts
+   * const lockboxRecipient =
+   *   await client.lockboxRecipients.create({
+   *     account_id: 'account_in71c4amph0vgo2qllky',
+   *     lockbox_address_id:
+   *       'lockbox_address_lw6sbzl9ol5dfd8hdml6',
+   *   });
+   * ```
+   */
+  create(body: LockboxRecipientCreateParams, options?: RequestOptions): APIPromise<LockboxRecipient> {
+    return this._client.post('/lockbox_recipients', { body, ...options });
+  }
+
+  /**
+   * Retrieve a Lockbox Recipient
+   *
+   * @example
+   * ```ts
+   * const lockboxRecipient =
+   *   await client.lockboxRecipients.retrieve(
+   *     'lockbox_3xt21ok13q19advds4t5',
+   *   );
+   * ```
+   */
+  retrieve(lockboxRecipientID: string, options?: RequestOptions): APIPromise<LockboxRecipient> {
+    return this._client.get(path`/lockbox_recipients/${lockboxRecipientID}`, options);
+  }
+
+  /**
+   * Update a Lockbox Recipient
+   *
+   * @example
+   * ```ts
+   * const lockboxRecipient =
+   *   await client.lockboxRecipients.update(
+   *     'lockbox_3xt21ok13q19advds4t5',
+   *   );
+   * ```
+   */
+  update(
+    lockboxRecipientID: string,
+    body: LockboxRecipientUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<LockboxRecipient> {
+    return this._client.patch(path`/lockbox_recipients/${lockboxRecipientID}`, { body, ...options });
+  }
+
+  /**
+   * List Lockbox Recipients
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const lockboxRecipient of client.lockboxRecipients.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: LockboxRecipientListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<LockboxRecipientsPage, LockboxRecipient> {
+    return this._client.getAPIList('/lockbox_recipients', Page<LockboxRecipient>, { query, ...options });
+  }
+}
+
+export type LockboxRecipientsPage = Page<LockboxRecipient>;
+
+/**
+ * Lockbox Recipients represent an inbox at a Lockbox Address. Checks received for
+ * a Lockbox Recipient are deposited into its associated Account.
+ */
+export interface LockboxRecipient {
+  /**
+   * The Lockbox Recipient identifier.
+   */
+  id: string;
+
+  /**
+   * The identifier for the Account that checks sent to this Lockbox Recipient will
+   * be deposited into.
+   */
+  account_id: string;
+
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
+   * Recipient was created.
+   */
+  created_at: string;
+
+  /**
+   * The description of the Lockbox Recipient.
+   */
+  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;
+
+  /**
+   * The identifier for the Lockbox Address where this Lockbox Recipient may receive
+   * physical mail.
+   */
+  lockbox_address_id: string;
+
+  /**
+   * The mail stop code uniquely identifying this Lockbox Recipient at its Lockbox
+   * Address. It should be included in the mailing address intended for this Lockbox
+   * Recipient.
+   */
+  mail_stop_code: string;
+
+  /**
+   * The name of the Lockbox Recipient.
+   */
+  recipient_name: string | null;
+
+  /**
+   * The status of the Lockbox Recipient.
+   *
+   * - `active` - This Lockbox Recipient is active.
+   * - `disabled` - This Lockbox Recipient is disabled. Checks mailed to this Lockbox
+   *   Recipient will be rejected.
+   * - `canceled` - This Lockbox Recipient is canceled and cannot be modified. Checks
+   *   mailed to this Lockbox Recipient will be rejected.
+   */
+  status: 'active' | 'disabled' | 'canceled' | null;
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `lockbox_recipient`.
+   */
+  type: 'lockbox_recipient';
+}
+
+export interface LockboxRecipientCreateParams {
+  /**
+   * The Account that checks sent to this Lockbox Recipient should be deposited into.
+   */
+  account_id: string;
+
+  /**
+   * The Lockbox Address where this Lockbox Recipient may receive mail.
+   */
+  lockbox_address_id: string;
+
+  /**
+   * The description you choose for the Lockbox Recipient.
+   */
+  description?: string;
+
+  /**
+   * The name of the Lockbox Recipient
+   */
+  recipient_name?: string;
+
+  [k: string]: unknown;
+}
+
+export interface LockboxRecipientUpdateParams {
+  /**
+   * The description you choose for the Lockbox Recipient.
+   */
+  description?: string;
+
+  /**
+   * The name of the Lockbox Recipient.
+   */
+  recipient_name?: string;
+
+  /**
+   * The status of the Lockbox Recipient.
+   *
+   * - `active` - This Lockbox Recipient is active.
+   * - `disabled` - This Lockbox Recipient is disabled. Checks mailed to this Lockbox
+   *   Recipient will be rejected.
+   * - `canceled` - This Lockbox Recipient is canceled and cannot be modified. Checks
+   *   mailed to this Lockbox Recipient will be rejected.
+   */
+  status?: 'active' | 'disabled' | 'canceled';
+}
+
+export interface LockboxRecipientListParams extends PageParams {
+  /**
+   * Filter Lockbox Recipients to those associated with the provided Account.
+   */
+  account_id?: string;
+
+  created_at?: LockboxRecipientListParams.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;
+
+  /**
+   * Filter Lockbox Recipients to those associated with the provided Lockbox Address.
+   */
+  lockbox_address_id?: string;
+}
+
+export namespace LockboxRecipientListParams {
+  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 declare namespace LockboxRecipients {
+  export {
+    type LockboxRecipient as LockboxRecipient,
+    type LockboxRecipientsPage as LockboxRecipientsPage,
+    type LockboxRecipientCreateParams as LockboxRecipientCreateParams,
+    type LockboxRecipientUpdateParams as LockboxRecipientUpdateParams,
+    type LockboxRecipientListParams as LockboxRecipientListParams,
+  };
+}