increase 0.539.0 → 0.541.0

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,
+  };
+}

package/src/resources/simulations/card-tokens.ts

@@ -75,8 +75,9 @@ export namespace CardTokenCreateParams {
      *
      * - `visa` - Visa and Interlink
      * - `mastercard` - Mastercard and Maestro
+     * - `pulse` - Pulse
      */
-    route: 'visa' | 'mastercard';
+    route: 'visa' | 'mastercard' | 'pulse';
   }
 
   /**

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

@@ -15,7 +15,6 @@ export class InboundMailItems extends APIResource {
    * const inboundMailItem =
    *   await client.simulations.inboundMailItems.create({
    *     amount: 1000,
-   *     lockbox_id: 'lockbox_3xt21ok13q19advds4t5',
    *   });
    * ```
    */
@@ -33,16 +32,23 @@ export interface InboundMailItemCreateParams {
    */
   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 {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.539.0'; // x-release-please-version
+export const VERSION = '0.541.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.539.0";
+export declare const VERSION = "0.541.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.539.0";
+export declare const VERSION = "0.541.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.539.0'; // x-release-please-version
+exports.VERSION = '0.541.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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

package/resources/lockboxes.d.mts

@@ -1,217 +0,0 @@
-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 Lockboxes extends APIResource {
-    /**
-     * Create a Lockbox
-     *
-     * @example
-     * ```ts
-     * const lockbox = await client.lockboxes.create({
-     *   account_id: 'account_in71c4amph0vgo2qllky',
-     * });
-     * ```
-     */
-    create(body: LockboxCreateParams, options?: RequestOptions): APIPromise<Lockbox>;
-    /**
-     * Retrieve a Lockbox
-     *
-     * @example
-     * ```ts
-     * const lockbox = await client.lockboxes.retrieve(
-     *   'lockbox_3xt21ok13q19advds4t5',
-     * );
-     * ```
-     */
-    retrieve(lockboxID: string, options?: RequestOptions): APIPromise<Lockbox>;
-    /**
-     * Update a Lockbox
-     *
-     * @example
-     * ```ts
-     * const lockbox = await client.lockboxes.update(
-     *   'lockbox_3xt21ok13q19advds4t5',
-     * );
-     * ```
-     */
-    update(lockboxID: string, body: LockboxUpdateParams, options?: RequestOptions): APIPromise<Lockbox>;
-    /**
-     * List Lockboxes
-     *
-     * @example
-     * ```ts
-     * // Automatically fetches more pages as needed.
-     * for await (const lockbox of client.lockboxes.list()) {
-     *   // ...
-     * }
-     * ```
-     */
-    list(query?: LockboxListParams | null | undefined, options?: RequestOptions): PagePromise<LockboxesPage, Lockbox>;
-}
-export type LockboxesPage = 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;
-    /**
-     * Indicates if checks mailed to this lockbox will be deposited.
-     *
-     * - `enabled` - Checks mailed to this Lockbox will be deposited.
-     * - `disabled` - Checks mailed to this Lockbox will not be deposited.
-     * - `pend_for_processing` - Checks mailed to this Lockbox will be pending until
-     *   actioned.
-     */
-    check_deposit_behavior: 'enabled' | 'disabled' | 'pend_for_processing';
-    /**
-     * 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;
-    /**
-     * The recipient name you choose for the Lockbox.
-     */
-    recipient_name: string | null;
-    /**
-     * A constant representing the object's type. For this resource it will always be
-     * `lockbox`.
-     */
-    type: 'lockbox';
-    [k: string]: unknown;
-}
-export declare namespace Lockbox {
-    /**
-     * The mailing address for the Lockbox.
-     */
-    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 recipient line of the address. This will include the recipient name you
-         * provide when creating the address, as well as an ATTN suffix to help route the
-         * mail to your lockbox. Mail senders must include this ATTN line to receive mail
-         * at this Lockbox.
-         */
-        recipient: string | null;
-        /**
-         * The two-letter United States Postal Service (USPS) abbreviation for the state of
-         * the address.
-         */
-        state: string;
-    }
-}
-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;
-    /**
-     * The name of the recipient that will receive mail at this location.
-     */
-    recipient_name?: string;
-    [k: string]: unknown;
-}
-export interface LockboxUpdateParams {
-    /**
-     * This indicates if checks mailed to this lockbox will be deposited.
-     *
-     * - `enabled` - Checks mailed to this Lockbox will be deposited.
-     * - `disabled` - Checks mailed to this Lockbox will not be deposited.
-     * - `pend_for_processing` - Checks mailed to this Lockbox will be pending until
-     *   actioned.
-     */
-    check_deposit_behavior?: 'enabled' | 'disabled' | 'pend_for_processing';
-    /**
-     * The description you choose for the Lockbox.
-     */
-    description?: string;
-    /**
-     * The recipient name you choose for the Lockbox.
-     */
-    recipient_name?: string;
-    [k: string]: unknown;
-}
-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 declare namespace LockboxListParams {
-    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 Lockboxes {
-    export { type Lockbox as Lockbox, type LockboxesPage as LockboxesPage, type LockboxCreateParams as LockboxCreateParams, type LockboxUpdateParams as LockboxUpdateParams, type LockboxListParams as LockboxListParams, };
-}
-//# sourceMappingURL=lockboxes.d.mts.map

package/resources/lockboxes.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"lockboxes.d.mts","sourceRoot":"","sources":["../src/resources/lockboxes.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,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAIhF;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAI1E;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAInG;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,aAAa,EAAE,OAAO,CAAC;CAGvC;AAED,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;AAE1C;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC;IAEzB;;;;;;;OAOG;IACH,sBAAsB,EAAE,SAAS,GAAG,UAAU,GAAG,qBAAqB,CAAC;IAEvE;;;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;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,IAAI,EAAE,SAAS,CAAC;IAEhB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,OAAO,CAAC;IACvB;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;;;;WAKG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;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,mBAAmB;IAClC;;;;;;;OAOG;IACH,sBAAsB,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,qBAAqB,CAAC;IAExE;;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,iBAAkB,SAAQ,UAAU;IACnD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,iBAAiB,CAAC,SAAS,CAAC;IAEzC;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,yBAAiB,iBAAiB,CAAC;IACjC,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,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}