increase 0.538.0 → 0.540.0

package/resources/lockbox-recipients.d.mts

@@ -0,0 +1,202 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { Page, type PageParams, PagePromise } from "../core/pagination.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare 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>;
+    /**
+     * Retrieve a Lockbox Recipient
+     *
+     * @example
+     * ```ts
+     * const lockboxRecipient =
+     *   await client.lockboxRecipients.retrieve(
+     *     'lockbox_3xt21ok13q19advds4t5',
+     *   );
+     * ```
+     */
+    retrieve(lockboxRecipientID: string, options?: RequestOptions): APIPromise<LockboxRecipient>;
+    /**
+     * Update a Lockbox Recipient
+     *
+     * @example
+     * ```ts
+     * const lockboxRecipient =
+     *   await client.lockboxRecipients.update(
+     *     'lockbox_3xt21ok13q19advds4t5',
+     *   );
+     * ```
+     */
+    update(lockboxRecipientID: string, body: LockboxRecipientUpdateParams, options?: RequestOptions): APIPromise<LockboxRecipient>;
+    /**
+     * 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>;
+}
+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 declare namespace LockboxRecipientListParams {
+    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, };
+}
+//# sourceMappingURL=lockbox-recipients.d.mts.map

package/resources/lockbox-recipients.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lockbox-recipients.d.mts","sourceRoot":"","sources":["../src/resources/lockbox-recipients.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,WAAW,EAAE;OACtC,EAAE,cAAc,EAAE;AAGzB,qBAAa,iBAAkB,SAAQ,WAAW;IAChD;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,4BAA4B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAIlG;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,kBAAkB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAI5F;;;;;;;;;;OAUG;IACH,MAAM,CACJ,kBAAkB,EAAE,MAAM,EAC1B,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qBAAqB,EAAE,gBAAgB,CAAC;CAGxD;AAED,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC;AAE3D;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;OAIG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;;;;;;OAQG;IACH,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,UAAU,GAAG,IAAI,CAAC;IAElD;;;OAGG;IACH,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,UAAU,CAAC;CAC7C;AAED,MAAM,WAAW,0BAA2B,SAAQ,UAAU;IAC5D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,0BAA0B,CAAC,SAAS,CAAC;IAElD;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,SAAS;QACxB;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,iBAAiB,CAAC;IACzC,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}

package/resources/lockbox-recipients.d.ts

@@ -0,0 +1,202 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { Page, type PageParams, PagePromise } from "../core/pagination.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare 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>;
+    /**
+     * Retrieve a Lockbox Recipient
+     *
+     * @example
+     * ```ts
+     * const lockboxRecipient =
+     *   await client.lockboxRecipients.retrieve(
+     *     'lockbox_3xt21ok13q19advds4t5',
+     *   );
+     * ```
+     */
+    retrieve(lockboxRecipientID: string, options?: RequestOptions): APIPromise<LockboxRecipient>;
+    /**
+     * Update a Lockbox Recipient
+     *
+     * @example
+     * ```ts
+     * const lockboxRecipient =
+     *   await client.lockboxRecipients.update(
+     *     'lockbox_3xt21ok13q19advds4t5',
+     *   );
+     * ```
+     */
+    update(lockboxRecipientID: string, body: LockboxRecipientUpdateParams, options?: RequestOptions): APIPromise<LockboxRecipient>;
+    /**
+     * 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>;
+}
+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 declare namespace LockboxRecipientListParams {
+    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, };
+}
+//# sourceMappingURL=lockbox-recipients.d.ts.map

package/resources/lockbox-recipients.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lockbox-recipients.d.ts","sourceRoot":"","sources":["../src/resources/lockbox-recipients.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,WAAW,EAAE;OACtC,EAAE,cAAc,EAAE;AAGzB,qBAAa,iBAAkB,SAAQ,WAAW;IAChD;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,4BAA4B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAIlG;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,kBAAkB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAI5F;;;;;;;;;;OAUG;IACH,MAAM,CACJ,kBAAkB,EAAE,MAAM,EAC1B,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qBAAqB,EAAE,gBAAgB,CAAC;CAGxD;AAED,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC;AAE3D;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;OAIG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;;;;;;OAQG;IACH,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,UAAU,GAAG,IAAI,CAAC;IAElD;;;OAGG;IACH,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,UAAU,CAAC;CAC7C;AAED,MAAM,WAAW,0BAA2B,SAAQ,UAAU;IAC5D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,0BAA0B,CAAC,SAAS,CAAC;IAElD;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,SAAS;QACxB;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,iBAAiB,CAAC;IACzC,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}

package/resources/lockbox-recipients.js

@@ -0,0 +1,69 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LockboxRecipients = void 0;
+const resource_1 = require("../core/resource.js");
+const pagination_1 = require("../core/pagination.js");
+const path_1 = require("../internal/utils/path.js");
+class LockboxRecipients extends resource_1.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, options) {
+        return this._client.post('/lockbox_recipients', { body, ...options });
+    }
+    /**
+     * Retrieve a Lockbox Recipient
+     *
+     * @example
+     * ```ts
+     * const lockboxRecipient =
+     *   await client.lockboxRecipients.retrieve(
+     *     'lockbox_3xt21ok13q19advds4t5',
+     *   );
+     * ```
+     */
+    retrieve(lockboxRecipientID, options) {
+        return this._client.get((0, path_1.path) `/lockbox_recipients/${lockboxRecipientID}`, options);
+    }
+    /**
+     * Update a Lockbox Recipient
+     *
+     * @example
+     * ```ts
+     * const lockboxRecipient =
+     *   await client.lockboxRecipients.update(
+     *     'lockbox_3xt21ok13q19advds4t5',
+     *   );
+     * ```
+     */
+    update(lockboxRecipientID, body, options) {
+        return this._client.patch((0, path_1.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 = {}, options) {
+        return this._client.getAPIList('/lockbox_recipients', (pagination_1.Page), { query, ...options });
+    }
+}
+exports.LockboxRecipients = LockboxRecipients;
+//# sourceMappingURL=lockbox-recipients.js.map

package/resources/lockbox-recipients.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lockbox-recipients.js","sourceRoot":"","sources":["../src/resources/lockbox-recipients.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAwE;AAExE,oDAA8C;AAE9C,MAAa,iBAAkB,SAAQ,sBAAW;IAChD;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAkC,EAAE,OAAwB;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,kBAA0B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,uBAAuB,kBAAkB,EAAE,EAAE,OAAO,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CACJ,kBAA0B,EAC1B,IAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,uBAAuB,kBAAkB,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,qBAAqB,EAAE,CAAA,iBAAsB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;CACF;AArED,8CAqEC"}

package/resources/lockbox-recipients.mjs

@@ -0,0 +1,65 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { Page } from "../core/pagination.mjs";
+import { path } from "../internal/utils/path.mjs";
+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, options) {
+        return this._client.post('/lockbox_recipients', { body, ...options });
+    }
+    /**
+     * Retrieve a Lockbox Recipient
+     *
+     * @example
+     * ```ts
+     * const lockboxRecipient =
+     *   await client.lockboxRecipients.retrieve(
+     *     'lockbox_3xt21ok13q19advds4t5',
+     *   );
+     * ```
+     */
+    retrieve(lockboxRecipientID, options) {
+        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, body, options) {
+        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 = {}, options) {
+        return this._client.getAPIList('/lockbox_recipients', (Page), { query, ...options });
+    }
+}
+//# sourceMappingURL=lockbox-recipients.mjs.map

package/resources/lockbox-recipients.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"lockbox-recipients.mjs","sourceRoot":"","sources":["../src/resources/lockbox-recipients.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,IAAI,EAAgC;OAEtC,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,iBAAkB,SAAQ,WAAW;IAChD;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAkC,EAAE,OAAwB;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,kBAA0B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,uBAAuB,kBAAkB,EAAE,EAAE,OAAO,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CACJ,kBAA0B,EAC1B,IAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,uBAAuB,kBAAkB,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,qBAAqB,EAAE,CAAA,IAAsB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;CACF"}

package/resources/simulations/inbound-mail-items.d.mts

@@ -12,7 +12,6 @@ export declare class InboundMailItems extends APIResource {
      * const inboundMailItem =
      *   await client.simulations.inboundMailItems.create({
      *     amount: 1000,
-     *     lockbox_id: 'lockbox_3xt21ok13q19advds4t5',
      *   });
      * ```
      */
@@ -23,15 +22,20 @@ export interface InboundMailItemCreateParams {
      * The amount of the check to be simulated, in cents.
      */
     amount: number;
-    /**
-     * The identifier of the Lockbox to simulate inbound mail to.
-     */
-    lockbox_id: string;
     /**
      * The file containing the PDF contents. If not present, a default check image file
      * will be used.
      */
     contents_file_id?: string;
+    /**
+     * The identifier of the Lockbox Address to simulate inbound mail to.
+     */
+    lockbox_address_id?: string;
+    /**
+     * The identifier of the Lockbox Recipient to simulate inbound mail to.
+     */
+    lockbox_recipient_id?: string;
+    [k: string]: unknown;
 }
 export declare namespace InboundMailItems {
     export { type InboundMailItemCreateParams as InboundMailItemCreateParams };

package/resources/simulations/inbound-mail-items.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"inbound-mail-items.d.mts","sourceRoot":"","sources":["../../src/resources/simulations/inbound-mail-items.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,mBAAmB;OACxB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC,eAAe,CAAC;CAGnD;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EAAE,KAAK,2BAA2B,IAAI,2BAA2B,EAAE,CAAC;CAC5E"}
+{"version":3,"file":"inbound-mail-items.d.mts","sourceRoot":"","sources":["../../src/resources/simulations/inbound-mail-items.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,mBAAmB;OACxB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC,eAAe,CAAC;CAGnD;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EAAE,KAAK,2BAA2B,IAAI,2BAA2B,EAAE,CAAC;CAC5E"}

package/resources/simulations/inbound-mail-items.d.ts

@@ -12,7 +12,6 @@ export declare class InboundMailItems extends APIResource {
      * const inboundMailItem =
      *   await client.simulations.inboundMailItems.create({
      *     amount: 1000,
-     *     lockbox_id: 'lockbox_3xt21ok13q19advds4t5',
      *   });
      * ```
      */
@@ -23,15 +22,20 @@ export interface InboundMailItemCreateParams {
      * The amount of the check to be simulated, in cents.
      */
     amount: number;
-    /**
-     * The identifier of the Lockbox to simulate inbound mail to.
-     */
-    lockbox_id: string;
     /**
      * The file containing the PDF contents. If not present, a default check image file
      * will be used.
      */
     contents_file_id?: string;
+    /**
+     * The identifier of the Lockbox Address to simulate inbound mail to.
+     */
+    lockbox_address_id?: string;
+    /**
+     * The identifier of the Lockbox Recipient to simulate inbound mail to.
+     */
+    lockbox_recipient_id?: string;
+    [k: string]: unknown;
 }
 export declare namespace InboundMailItems {
     export { type InboundMailItemCreateParams as InboundMailItemCreateParams };

package/resources/simulations/inbound-mail-items.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"inbound-mail-items.d.ts","sourceRoot":"","sources":["../../src/resources/simulations/inbound-mail-items.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,mBAAmB;OACxB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC,eAAe,CAAC;CAGnD;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EAAE,KAAK,2BAA2B,IAAI,2BAA2B,EAAE,CAAC;CAC5E"}
+{"version":3,"file":"inbound-mail-items.d.ts","sourceRoot":"","sources":["../../src/resources/simulations/inbound-mail-items.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,mBAAmB;OACxB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC,eAAe,CAAC;CAGnD;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EAAE,KAAK,2BAA2B,IAAI,2BAA2B,EAAE,CAAC;CAC5E"}

package/resources/simulations/inbound-mail-items.js

@@ -13,7 +13,6 @@ class InboundMailItems extends resource_1.APIResource {
      * const inboundMailItem =
      *   await client.simulations.inboundMailItems.create({
      *     amount: 1000,
-     *     lockbox_id: 'lockbox_3xt21ok13q19advds4t5',
      *   });
      * ```
      */

package/resources/simulations/inbound-mail-items.js.map

@@ -1 +1 @@
-{"version":3,"file":"inbound-mail-items.js","sourceRoot":"","sources":["../../src/resources/simulations/inbound-mail-items.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAKlD,MAAa,gBAAiB,SAAQ,sBAAW;IAC/C;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;CACF;AApBD,4CAoBC"}
+{"version":3,"file":"inbound-mail-items.js","sourceRoot":"","sources":["../../src/resources/simulations/inbound-mail-items.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAKlD,MAAa,gBAAiB,SAAQ,sBAAW;IAC/C;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;CACF;AAnBD,4CAmBC"}

package/resources/simulations/inbound-mail-items.mjs

@@ -10,7 +10,6 @@ export class InboundMailItems extends APIResource {
      * const inboundMailItem =
      *   await client.simulations.inboundMailItems.create({
      *     amount: 1000,
-     *     lockbox_id: 'lockbox_3xt21ok13q19advds4t5',
      *   });
      * ```
      */

package/resources/simulations/inbound-mail-items.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"inbound-mail-items.mjs","sourceRoot":"","sources":["../../src/resources/simulations/inbound-mail-items.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAKtB,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;CACF"}
+{"version":3,"file":"inbound-mail-items.mjs","sourceRoot":"","sources":["../../src/resources/simulations/inbound-mail-items.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAKtB,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;CACF"}