increase 0.376.0 → 0.378.0

package/resources/cards.js

@@ -1,10 +1,10 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CardsPage = exports.Cards = void 0;
-const resource_1 = require("../resource.js");
-const core_1 = require("../core.js");
-const pagination_1 = require("../pagination.js");
+exports.Cards = 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 Cards extends resource_1.APIResource {
     /**
      * Create a Card
@@ -29,8 +29,8 @@ class Cards extends resource_1.APIResource {
      * );
      * ```
      */
-    retrieve(cardId, options) {
-        return this._client.get(`/cards/${cardId}`, options);
+    retrieve(cardID, options) {
+        return this._client.get((0, path_1.path) `/cards/${cardID}`, options);
     }
     /**
      * Update a Card
@@ -42,14 +42,22 @@ class Cards extends resource_1.APIResource {
      * );
      * ```
      */
-    update(cardId, body, options) {
-        return this._client.patch(`/cards/${cardId}`, { body, ...options });
+    update(cardID, body, options) {
+        return this._client.patch((0, path_1.path) `/cards/${cardID}`, { body, ...options });
     }
+    /**
+     * List Cards
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const card of client.cards.list()) {
+     *   // ...
+     * }
+     * ```
+     */
     list(query = {}, options) {
-        if ((0, core_1.isRequestOptions)(query)) {
-            return this.list({}, query);
-        }
-        return this._client.getAPIList('/cards', CardsPage, { query, ...options });
+        return this._client.getAPIList('/cards', (pagination_1.Page), { query, ...options });
     }
     /**
      * Create an iframe URL for a Card to display the card details. More details about
@@ -64,8 +72,8 @@ class Cards extends resource_1.APIResource {
      *   );
      * ```
      */
-    createDetailsIframe(cardId, body, options) {
-        return this._client.post(`/cards/${cardId}/create_details_iframe`, { body, ...options });
+    createDetailsIframe(cardID, body, options) {
+        return this._client.post((0, path_1.path) `/cards/${cardID}/create_details_iframe`, { body, ...options });
     }
     /**
      * Sensitive details for a Card include the primary account number, expiry, card
@@ -78,8 +86,8 @@ class Cards extends resource_1.APIResource {
      * );
      * ```
      */
-    details(cardId, options) {
-        return this._client.get(`/cards/${cardId}/details`, options);
+    details(cardID, options) {
+        return this._client.get((0, path_1.path) `/cards/${cardID}/details`, options);
     }
     /**
      * Update a Card's PIN
@@ -92,13 +100,9 @@ class Cards extends resource_1.APIResource {
      * );
      * ```
      */
-    updatePin(cardId, body, options) {
-        return this._client.post(`/cards/${cardId}/update_pin`, { body, ...options });
+    updatePin(cardID, body, options) {
+        return this._client.post((0, path_1.path) `/cards/${cardID}/update_pin`, { body, ...options });
     }
 }
 exports.Cards = Cards;
-class CardsPage extends pagination_1.Page {
-}
-exports.CardsPage = CardsPage;
-Cards.CardsPage = CardsPage;
 //# sourceMappingURL=cards.js.map

package/resources/cards.js.map

@@ -1 +1 @@
-{"version":3,"file":"cards.js","sourceRoot":"","sources":["../src/resources/cards.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAE3C,iDAAsD;AAEtD,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAsB,EAAE,OAA6B;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,MAAc,EAAE,OAA6B;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAc,EAAE,IAAsB,EAAE,OAA6B;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAeD,IAAI,CACF,QAA8C,EAAE,EAChD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,mBAAmB,CACjB,MAAc,EACd,IAAmC,EACnC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,MAAM,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAC,MAAc,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,MAAM,UAAU,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;OAUG;IACH,SAAS,CACP,MAAc,EACd,IAAyB,EACzB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,MAAM,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF;AAxHD,sBAwHC;AAED,MAAa,SAAU,SAAQ,iBAAU;CAAG;AAA5C,8BAA4C;AAgd5C,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC"}
+{"version":3,"file":"cards.js","sourceRoot":"","sources":["../src/resources/cards.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAwE;AAExE,oDAA8C;AAE9C,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,MAAc,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAc,EAAE,IAAsB,EAAE,OAAwB;QACrE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAA,iBAAU,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,mBAAmB,CACjB,MAAc,EACd,IAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAC,MAAc,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,UAAU,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;OAUG;IACH,SAAS,CAAC,MAAc,EAAE,IAAyB,EAAE,OAAwB;QAC3E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;CACF;AA/GD,sBA+GC"}

package/resources/cards.mjs

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-import { APIResource } from "../resource.mjs";
-import { isRequestOptions } from "../core.mjs";
-import { Page } from "../pagination.mjs";
+import { APIResource } from "../core/resource.mjs";
+import { Page } from "../core/pagination.mjs";
+import { path } from "../internal/utils/path.mjs";
 export class Cards extends APIResource {
     /**
      * Create a Card
@@ -26,8 +26,8 @@ export class Cards extends APIResource {
      * );
      * ```
      */
-    retrieve(cardId, options) {
-        return this._client.get(`/cards/${cardId}`, options);
+    retrieve(cardID, options) {
+        return this._client.get(path `/cards/${cardID}`, options);
     }
     /**
      * Update a Card
@@ -39,14 +39,22 @@ export class Cards extends APIResource {
      * );
      * ```
      */
-    update(cardId, body, options) {
-        return this._client.patch(`/cards/${cardId}`, { body, ...options });
+    update(cardID, body, options) {
+        return this._client.patch(path `/cards/${cardID}`, { body, ...options });
     }
+    /**
+     * List Cards
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const card of client.cards.list()) {
+     *   // ...
+     * }
+     * ```
+     */
     list(query = {}, options) {
-        if (isRequestOptions(query)) {
-            return this.list({}, query);
-        }
-        return this._client.getAPIList('/cards', CardsPage, { query, ...options });
+        return this._client.getAPIList('/cards', (Page), { query, ...options });
     }
     /**
      * Create an iframe URL for a Card to display the card details. More details about
@@ -61,8 +69,8 @@ export class Cards extends APIResource {
      *   );
      * ```
      */
-    createDetailsIframe(cardId, body, options) {
-        return this._client.post(`/cards/${cardId}/create_details_iframe`, { body, ...options });
+    createDetailsIframe(cardID, body, options) {
+        return this._client.post(path `/cards/${cardID}/create_details_iframe`, { body, ...options });
     }
     /**
      * Sensitive details for a Card include the primary account number, expiry, card
@@ -75,8 +83,8 @@ export class Cards extends APIResource {
      * );
      * ```
      */
-    details(cardId, options) {
-        return this._client.get(`/cards/${cardId}/details`, options);
+    details(cardID, options) {
+        return this._client.get(path `/cards/${cardID}/details`, options);
     }
     /**
      * Update a Card's PIN
@@ -89,11 +97,8 @@ export class Cards extends APIResource {
      * );
      * ```
      */
-    updatePin(cardId, body, options) {
-        return this._client.post(`/cards/${cardId}/update_pin`, { body, ...options });
+    updatePin(cardID, body, options) {
+        return this._client.post(path `/cards/${cardID}/update_pin`, { body, ...options });
     }
 }
-export class CardsPage extends Page {
-}
-Cards.CardsPage = CardsPage;
 //# sourceMappingURL=cards.mjs.map

package/resources/cards.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"cards.mjs","sourceRoot":"","sources":["../src/resources/cards.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAsB,EAAE,OAA6B;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,MAAc,EAAE,OAA6B;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAc,EAAE,IAAsB,EAAE,OAA6B;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAeD,IAAI,CACF,QAA8C,EAAE,EAChD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,mBAAmB,CACjB,MAAc,EACd,IAAmC,EACnC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,MAAM,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAC,MAAc,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,MAAM,UAAU,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;OAUG;IACH,SAAS,CACP,MAAc,EACd,IAAyB,EACzB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,MAAM,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF;AAED,MAAM,OAAO,SAAU,SAAQ,IAAU;CAAG;AAgd5C,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC"}
+{"version":3,"file":"cards.mjs","sourceRoot":"","sources":["../src/resources/cards.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,IAAI,EAAgC;OAEtC,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,MAAc,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAc,EAAE,IAAsB,EAAE,OAAwB;QACrE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,UAAU,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAA,IAAU,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,mBAAmB,CACjB,MAAc,EACd,IAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,UAAU,MAAM,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAC,MAAc,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,MAAM,UAAU,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;OAUG;IACH,SAAS,CAAC,MAAc,EAAE,IAAyB,EAAE,OAAwB;QAC3E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,UAAU,MAAM,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;CACF"}

package/resources/check-deposits.d.mts

@@ -0,0 +1,453 @@
+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 CheckDeposits extends APIResource {
+    /**
+     * Create a Check Deposit
+     *
+     * @example
+     * ```ts
+     * const checkDeposit = await client.checkDeposits.create({
+     *   account_id: 'account_in71c4amph0vgo2qllky',
+     *   amount: 1000,
+     *   back_image_file_id: 'file_26khfk98mzfz90a11oqx',
+     *   front_image_file_id: 'file_hkv175ovmc2tb2v2zbrm',
+     * });
+     * ```
+     */
+    create(body: CheckDepositCreateParams, options?: RequestOptions): APIPromise<CheckDeposit>;
+    /**
+     * Retrieve a Check Deposit
+     *
+     * @example
+     * ```ts
+     * const checkDeposit = await client.checkDeposits.retrieve(
+     *   'check_deposit_f06n9gpg7sxn8t19lfc1',
+     * );
+     * ```
+     */
+    retrieve(checkDepositID: string, options?: RequestOptions): APIPromise<CheckDeposit>;
+    /**
+     * List Check Deposits
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const checkDeposit of client.checkDeposits.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query?: CheckDepositListParams | null | undefined, options?: RequestOptions): PagePromise<CheckDepositsPage, CheckDeposit>;
+}
+export type CheckDepositsPage = Page<CheckDeposit>;
+/**
+ * Check Deposits allow you to deposit images of paper checks into your account.
+ */
+export interface CheckDeposit {
+    /**
+     * The deposit's identifier.
+     */
+    id: string;
+    /**
+     * The Account the check was deposited into.
+     */
+    account_id: string;
+    /**
+     * The deposited amount in USD cents.
+     */
+    amount: number;
+    /**
+     * The ID for the File containing the image of the back of the check.
+     */
+    back_image_file_id: string | null;
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+     * the transfer was created.
+     */
+    created_at: string;
+    /**
+     * Once your deposit is successfully parsed and accepted by Increase, this will
+     * contain details of the parsed check.
+     */
+    deposit_acceptance: CheckDeposit.DepositAcceptance | null;
+    /**
+     * If your deposit is rejected by Increase, this will contain details as to why it
+     * was rejected.
+     */
+    deposit_rejection: CheckDeposit.DepositRejection | null;
+    /**
+     * If your deposit is returned, this will contain details as to why it was
+     * returned.
+     */
+    deposit_return: CheckDeposit.DepositReturn | null;
+    /**
+     * After the check is parsed, it is submitted to the Check21 network for
+     * processing. This will contain details of the submission.
+     */
+    deposit_submission: CheckDeposit.DepositSubmission | null;
+    /**
+     * The description of the Check Deposit, for display purposes only.
+     */
+    description: string | null;
+    /**
+     * The ID for the File containing the image of the front of the check.
+     */
+    front_image_file_id: string;
+    /**
+     * 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;
+    /**
+     * Increase will sometimes hold the funds for Check Deposits. If funds are held,
+     * this sub-object will contain details of the hold.
+     */
+    inbound_funds_hold: CheckDeposit.InboundFundsHold | null;
+    /**
+     * If the Check Deposit was the result of an Inbound Mail Item, this will contain
+     * the identifier of the Inbound Mail Item.
+     */
+    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.
+     */
+    lockbox_id: string | null;
+    /**
+     * The status of the Check Deposit.
+     *
+     * - `pending` - The Check Deposit is pending review.
+     * - `submitted` - The Check Deposit has been deposited.
+     * - `rejected` - The Check Deposit has been rejected.
+     * - `returned` - The Check Deposit has been returned.
+     */
+    status: 'pending' | 'submitted' | 'rejected' | 'returned';
+    /**
+     * The ID for the Transaction created by the deposit.
+     */
+    transaction_id: string | null;
+    /**
+     * A constant representing the object's type. For this resource it will always be
+     * `check_deposit`.
+     */
+    type: 'check_deposit';
+    [k: string]: unknown;
+}
+export declare namespace CheckDeposit {
+    /**
+     * Once your deposit is successfully parsed and accepted by Increase, this will
+     * contain details of the parsed check.
+     */
+    interface DepositAcceptance {
+        /**
+         * The account number printed on the check. This is an account at the bank that
+         * issued the check.
+         */
+        account_number: string;
+        /**
+         * The amount to be deposited in the minor unit of the transaction's currency. For
+         * dollars, for example, this is cents.
+         */
+        amount: number;
+        /**
+         * An additional line of metadata printed on the check. This typically includes the
+         * check number for business checks.
+         */
+        auxiliary_on_us: string | null;
+        /**
+         * The ID of the Check Deposit that was accepted.
+         */
+        check_deposit_id: string;
+        /**
+         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
+         * transaction's currency.
+         *
+         * - `USD` - US Dollar (USD)
+         */
+        currency: 'USD';
+        /**
+         * The routing number printed on the check. This is a routing number for the bank
+         * that issued the check.
+         */
+        routing_number: string;
+        /**
+         * The check serial number, if present, for consumer checks. For business checks,
+         * the serial number is usually in the `auxiliary_on_us` field.
+         */
+        serial_number: string | null;
+        [k: string]: unknown;
+    }
+    /**
+     * If your deposit is rejected by Increase, this will contain details as to why it
+     * was rejected.
+     */
+    interface DepositRejection {
+        /**
+         * The rejected amount in the minor unit of check's currency. For dollars, for
+         * example, this is cents.
+         */
+        amount: number;
+        /**
+         * The identifier of the Check Deposit that was rejected.
+         */
+        check_deposit_id: string;
+        /**
+         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
+         * currency.
+         *
+         * - `USD` - US Dollar (USD)
+         */
+        currency: 'USD';
+        /**
+         * The identifier of the associated declined transaction.
+         */
+        declined_transaction_id: string;
+        /**
+         * Why the check deposit was rejected.
+         *
+         * - `incomplete_image` - The check's image is incomplete.
+         * - `duplicate` - This is a duplicate check submission.
+         * - `poor_image_quality` - This check has poor image quality.
+         * - `incorrect_amount` - The check was deposited with the incorrect amount.
+         * - `incorrect_recipient` - The check is made out to someone other than the
+         *   account holder.
+         * - `not_eligible_for_mobile_deposit` - This check was not eligible for mobile
+         *   deposit.
+         * - `missing_required_data_elements` - This check is missing at least one required
+         *   field.
+         * - `suspected_fraud` - This check is suspected to be fraudulent.
+         * - `deposit_window_expired` - This check's deposit window has expired.
+         * - `requested_by_user` - The check was rejected at the user's request.
+         * - `unknown` - The check was rejected for an unknown reason.
+         */
+        reason: 'incomplete_image' | 'duplicate' | 'poor_image_quality' | 'incorrect_amount' | 'incorrect_recipient' | 'not_eligible_for_mobile_deposit' | 'missing_required_data_elements' | 'suspected_fraud' | 'deposit_window_expired' | 'requested_by_user' | 'unknown';
+        /**
+         * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+         * the check deposit was rejected.
+         */
+        rejected_at: string;
+        [k: string]: unknown;
+    }
+    /**
+     * If your deposit is returned, this will contain details as to why it was
+     * returned.
+     */
+    interface DepositReturn {
+        /**
+         * The returned amount in USD cents.
+         */
+        amount: number;
+        /**
+         * The identifier of the Check Deposit that was returned.
+         */
+        check_deposit_id: string;
+        /**
+         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
+         * transaction's currency.
+         *
+         * - `USD` - US Dollar (USD)
+         */
+        currency: 'USD';
+        /**
+         * Why this check was returned by the bank holding the account it was drawn
+         * against.
+         *
+         * - `ach_conversion_not_supported` - The check doesn't allow ACH conversion.
+         * - `closed_account` - The account is closed. (Check21 return code `D`)
+         * - `duplicate_submission` - The check has already been deposited. (Check21 return
+         *   code `Y`)
+         * - `insufficient_funds` - Insufficient funds (Check21 return code `A`)
+         * - `no_account` - No account was found matching the check details. (Check21
+         *   return code `E`)
+         * - `not_authorized` - The check was not authorized. (Check21 return code `Q`)
+         * - `stale_dated` - The check is too old. (Check21 return code `G`)
+         * - `stop_payment` - The payment has been stopped by the account holder. (Check21
+         *   return code `C`)
+         * - `unknown_reason` - The reason for the return is unknown.
+         * - `unmatched_details` - The image doesn't match the details submitted.
+         * - `unreadable_image` - The image could not be read. (Check21 return code `U`)
+         * - `endorsement_irregular` - The check endorsement was irregular. (Check21 return
+         *   code `J`)
+         * - `altered_or_fictitious_item` - The check present was either altered or fake.
+         *   (Check21 return code `N`)
+         * - `frozen_or_blocked_account` - The account this check is drawn on is frozen.
+         *   (Check21 return code `F`)
+         * - `post_dated` - The check is post dated. (Check21 return code `H`)
+         * - `endorsement_missing` - The endorsement was missing. (Check21 return code `I`)
+         * - `signature_missing` - The check signature was missing. (Check21 return code
+         *   `K`)
+         * - `stop_payment_suspect` - The bank suspects a stop payment will be placed.
+         *   (Check21 return code `T`)
+         * - `unusable_image` - The bank cannot read the image. (Check21 return code `U`)
+         * - `image_fails_security_check` - The check image fails the bank's security
+         *   check. (Check21 return code `V`)
+         * - `cannot_determine_amount` - The bank cannot determine the amount. (Check21
+         *   return code `W`)
+         * - `signature_irregular` - The signature is inconsistent with prior signatures.
+         *   (Check21 return code `L`)
+         * - `non_cash_item` - The check is a non-cash item and cannot be drawn against the
+         *   account. (Check21 return code `M`)
+         * - `unable_to_process` - The bank is unable to process this check. (Check21
+         *   return code `O`)
+         * - `item_exceeds_dollar_limit` - The check exceeds the bank or customer's limit.
+         *   (Check21 return code `P`)
+         * - `branch_or_account_sold` - The bank sold this account and no longer services
+         *   this customer. (Check21 return code `R`)
+         */
+        return_reason: 'ach_conversion_not_supported' | 'closed_account' | 'duplicate_submission' | 'insufficient_funds' | 'no_account' | 'not_authorized' | 'stale_dated' | 'stop_payment' | 'unknown_reason' | 'unmatched_details' | 'unreadable_image' | 'endorsement_irregular' | 'altered_or_fictitious_item' | 'frozen_or_blocked_account' | 'post_dated' | 'endorsement_missing' | 'signature_missing' | 'stop_payment_suspect' | 'unusable_image' | 'image_fails_security_check' | 'cannot_determine_amount' | 'signature_irregular' | 'non_cash_item' | 'unable_to_process' | 'item_exceeds_dollar_limit' | 'branch_or_account_sold';
+        /**
+         * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+         * the check deposit was returned.
+         */
+        returned_at: string;
+        /**
+         * The identifier of the transaction that reversed the original check deposit
+         * transaction.
+         */
+        transaction_id: string;
+        [k: string]: unknown;
+    }
+    /**
+     * After the check is parsed, it is submitted to the Check21 network for
+     * processing. This will contain details of the submission.
+     */
+    interface DepositSubmission {
+        /**
+         * The ID for the File containing the check back image that was submitted to the
+         * Check21 network.
+         */
+        back_file_id: string;
+        /**
+         * The ID for the File containing the check front image that was submitted to the
+         * Check21 network.
+         */
+        front_file_id: string;
+        /**
+         * When the check deposit was submitted to the Check21 network for processing.
+         * During business days, this happens within a few hours of the check being
+         * accepted by Increase.
+         */
+        submitted_at: string;
+    }
+    /**
+     * Increase will sometimes hold the funds for Check Deposits. If funds are held,
+     * this sub-object will contain details of the hold.
+     */
+    interface InboundFundsHold {
+        /**
+         * The held amount in the minor unit of the account's currency. For dollars, for
+         * example, this is cents.
+         */
+        amount: number;
+        /**
+         * When the hold will be released automatically. Certain conditions may cause it to
+         * be released before this time.
+         */
+        automatically_releases_at: string;
+        /**
+         * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold
+         * was created.
+         */
+        created_at: string;
+        /**
+         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's
+         * currency.
+         *
+         * - `USD` - US Dollar (USD)
+         */
+        currency: 'USD';
+        /**
+         * The ID of the Transaction for which funds were held.
+         */
+        held_transaction_id: string | null;
+        /**
+         * The ID of the Pending Transaction representing the held funds.
+         */
+        pending_transaction_id: string | null;
+        /**
+         * When the hold was released (if it has been released).
+         */
+        released_at: string | null;
+        /**
+         * The status of the hold.
+         *
+         * - `held` - Funds are still being held.
+         * - `complete` - Funds have been released.
+         */
+        status: 'held' | 'complete';
+        /**
+         * A constant representing the object's type. For this resource it will always be
+         * `inbound_funds_hold`.
+         */
+        type: 'inbound_funds_hold';
+        [k: string]: unknown;
+    }
+}
+export interface CheckDepositCreateParams {
+    /**
+     * The identifier for the Account to deposit the check in.
+     */
+    account_id: string;
+    /**
+     * The deposit amount in USD cents.
+     */
+    amount: number;
+    /**
+     * The File containing the check's back image.
+     */
+    back_image_file_id: string;
+    /**
+     * The File containing the check's front image.
+     */
+    front_image_file_id: string;
+    /**
+     * The description you choose to give the Check Deposit, for display purposes only.
+     */
+    description?: string;
+    [k: string]: unknown;
+}
+export interface CheckDepositListParams extends PageParams {
+    /**
+     * Filter Check Deposits to those belonging to the specified Account.
+     */
+    account_id?: string;
+    created_at?: CheckDepositListParams.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 CheckDepositListParams {
+    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 CheckDeposits {
+    export { type CheckDeposit as CheckDeposit, type CheckDepositsPage as CheckDepositsPage, type CheckDepositCreateParams as CheckDepositCreateParams, type CheckDepositListParams as CheckDepositListParams, };
+}
+//# sourceMappingURL=check-deposits.d.mts.map

package/resources/check-deposits.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"check-deposits.d.mts","sourceRoot":"","sources":["../src/resources/check-deposits.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,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAI1F;;;;;;;;;OASG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAIpF;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iBAAiB,EAAE,YAAY,CAAC;CAGhD;AAED,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,kBAAkB,EAAE,YAAY,CAAC,iBAAiB,GAAG,IAAI,CAAC;IAE1D;;;OAGG;IACH,iBAAiB,EAAE,YAAY,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAExD;;;OAGG;IACH,cAAc,EAAE,YAAY,CAAC,aAAa,GAAG,IAAI,CAAC;IAElD;;;OAGG;IACH,kBAAkB,EAAE,YAAY,CAAC,iBAAiB,GAAG,IAAI,CAAC;IAE1D;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;;;OAIG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,kBAAkB,EAAE,YAAY,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAEzD;;;OAGG;IACH,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;;;;;OAOG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC;IAE1D;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,IAAI,EAAE,eAAe,CAAC;IAEtB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,YAAY,CAAC;IAC5B;;;OAGG;IACH,UAAiB,iBAAiB;QAChC;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;;;;WAKG;QACH,QAAQ,EAAE,KAAK,CAAC;QAEhB;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;;WAGG;QACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;IAED;;;OAGG;IACH,UAAiB,gBAAgB;QAC/B;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;;;;WAKG;QACH,QAAQ,EAAE,KAAK,CAAC;QAEhB;;WAEG;QACH,uBAAuB,EAAE,MAAM,CAAC;QAEhC;;;;;;;;;;;;;;;;;WAiBG;QACH,MAAM,EACF,kBAAkB,GAClB,WAAW,GACX,oBAAoB,GACpB,kBAAkB,GAClB,qBAAqB,GACrB,iCAAiC,GACjC,gCAAgC,GAChC,iBAAiB,GACjB,wBAAwB,GACxB,mBAAmB,GACnB,SAAS,CAAC;QAEd;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;IAED;;;OAGG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;;;;WAKG;QACH,QAAQ,EAAE,KAAK,CAAC;QAEhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA6CG;QACH,aAAa,EACT,8BAA8B,GAC9B,gBAAgB,GAChB,sBAAsB,GACtB,oBAAoB,GACpB,YAAY,GACZ,gBAAgB,GAChB,aAAa,GACb,cAAc,GACd,gBAAgB,GAChB,mBAAmB,GACnB,kBAAkB,GAClB,uBAAuB,GACvB,4BAA4B,GAC5B,2BAA2B,GAC3B,YAAY,GACZ,qBAAqB,GACrB,mBAAmB,GACnB,sBAAsB,GACtB,gBAAgB,GAChB,4BAA4B,GAC5B,yBAAyB,GACzB,qBAAqB,GACrB,eAAe,GACf,mBAAmB,GACnB,2BAA2B,GAC3B,wBAAwB,CAAC;QAE7B;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;IAED;;;OAGG;IACH,UAAiB,iBAAiB;QAChC;;;WAGG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;;;WAIG;QACH,YAAY,EAAE,MAAM,CAAC;KACtB;IAED;;;OAGG;IACH,UAAiB,gBAAgB;QAC/B;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,yBAAyB,EAAE,MAAM,CAAC;QAElC;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;;;WAKG;QACH,QAAQ,EAAE,KAAK,CAAC;QAEhB;;WAEG;QACH,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnC;;WAEG;QACH,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtC;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;;;WAKG;QACH,MAAM,EAAE,MAAM,GAAG,UAAU,CAAC;QAE5B;;;WAGG;QACH,IAAI,EAAE,oBAAoB,CAAC;QAE3B,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,sBAAuB,SAAQ,UAAU;IACxD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,sBAAsB,CAAC,SAAS,CAAC;IAE9C;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,yBAAiB,sBAAsB,CAAC;IACtC,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,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}