increase 0.3.0 → 0.5.0

package/dist/esm/resources/cards.d.ts

@@ -0,0 +1,354 @@
+import * as Core from '../core.js';
+import { APIResource } from '../resource.js';
+import * as API from './index.js';
+import { Page, PageParams } from '../pagination.js';
+export declare class Cards extends APIResource {
+  /**
+   * Create a Card
+   */
+  create(body: CardCreateParams, options?: Core.RequestOptions): Promise<Core.APIResponse<Card>>;
+  /**
+   * Retrieve a Card
+   */
+  retrieve(cardId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Card>>;
+  /**
+   * Update a Card
+   */
+  update(
+    cardId: string,
+    body: CardUpdateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<Card>>;
+  /**
+   * List Cards
+   */
+  list(query?: CardListParams, options?: Core.RequestOptions): Core.PagePromise<CardsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<CardsPage>;
+  /**
+   * Retrieve sensitive details for a Card
+   */
+  retrieveSensitiveDetails(
+    cardId: string,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<CardDetails>>;
+}
+export declare class CardsPage extends Page<Card> {}
+/**
+ * Cards are commercial credit cards. They'll immediately work for online purchases
+ * after you create them. All cards maintain a credit limit of 100% of the
+ * Account’s available balance at the time of transaction. Funds are deducted from
+ * the Account upon transaction settlement.
+ */
+export interface Card {
+  /**
+   * The card identifier.
+   */
+  id: string;
+  /**
+   * The identifier for the account this card belongs to.
+   */
+  account_id: string;
+  /**
+   * The Card's billing address.
+   */
+  billing_address: Card.BillingAddress;
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+   * the Card was created.
+   */
+  created_at: string;
+  /**
+   * The card's description for display purposes.
+   */
+  description: string | null;
+  /**
+   * The contact information used in the two-factor steps for digital wallet card
+   * creation. At least one field must be present to complete the digital wallet
+   * steps.
+   */
+  digital_wallet: Card.DigitalWallet | null;
+  /**
+   * The month the card expires in M format (e.g., August is 8).
+   */
+  expiration_month: number;
+  /**
+   * The year the card expires in YYYY format (e.g., 2025).
+   */
+  expiration_year: number;
+  /**
+   * The last 4 digits of the Card's Primary Account Number.
+   */
+  last4: string;
+  /**
+   * This indicates if payments can be made with the card.
+   */
+  status: 'active' | 'disabled' | 'canceled';
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `card`.
+   */
+  type: 'card';
+}
+export declare namespace Card {
+  /**
+   * The Card's billing address.
+   */
+  interface BillingAddress {
+    /**
+     * The city of the billing address.
+     */
+    city: string | null;
+    /**
+     * The first line of the billing address.
+     */
+    line1: string | null;
+    /**
+     * The second line of the billing address.
+     */
+    line2: string | null;
+    /**
+     * The postal code of the billing address.
+     */
+    postal_code: string | null;
+    /**
+     * The US state of the billing address.
+     */
+    state: string | null;
+  }
+  /**
+   * The contact information used in the two-factor steps for digital wallet card
+   * creation. At least one field must be present to complete the digital wallet
+   * steps.
+   */
+  interface DigitalWallet {
+    /**
+     * The card profile assigned to this digital card. Card profiles may also be
+     * assigned at the program level.
+     */
+    card_profile_id: string | null;
+    /**
+     * An email address that can be used to verify the cardholder via one-time passcode
+     * over email.
+     */
+    email: string | null;
+    /**
+     * A phone number that can be used to verify the cardholder via one-time passcode
+     * over SMS.
+     */
+    phone: string | null;
+  }
+}
+/**
+ * An object containing the sensitive details (card number, cvc, etc) for a Card.
+ */
+export interface CardDetails {
+  /**
+   * The identifier for the Card for which sensitive details have been returned.
+   */
+  card_id: string;
+  /**
+   * The month the card expires in M format (e.g., August is 8).
+   */
+  expiration_month: number;
+  /**
+   * The year the card expires in YYYY format (e.g., 2025).
+   */
+  expiration_year: number;
+  /**
+   * The card number.
+   */
+  primary_account_number: string;
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `card_details`.
+   */
+  type: 'card_details';
+  /**
+   * The three-digit verification code for the card. It's also known as the Card
+   * Verification Code (CVC), the Card Verification Value (CVV), or the Card
+   * Identification (CID).
+   */
+  verification_code: string;
+}
+export interface CardCreateParams {
+  /**
+   * The Account the card should belong to.
+   */
+  account_id: string;
+  /**
+   * The card's billing address.
+   */
+  billing_address?: CardCreateParams.BillingAddress;
+  /**
+   * The description you choose to give the card.
+   */
+  description?: string;
+  /**
+   * The contact information used in the two-factor steps for digital wallet card
+   * creation. To add the card to a digital wallet, you may supply an email or phone
+   * number with this request. Otherwise, subscribe and then action a Real Time
+   * Decision with the category `digital_wallet_token_requested` or
+   * `digital_wallet_authentication_requested`.
+   */
+  digital_wallet?: CardCreateParams.DigitalWallet;
+}
+export declare namespace CardCreateParams {
+  /**
+   * The card's billing address.
+   */
+  interface BillingAddress {
+    /**
+     * The city of the billing address.
+     */
+    city: string;
+    /**
+     * The first line of the billing address.
+     */
+    line1: string;
+    /**
+     * The postal code of the billing address.
+     */
+    postal_code: string;
+    /**
+     * The US state of the billing address.
+     */
+    state: string;
+    /**
+     * The second line of the billing address.
+     */
+    line2?: string;
+  }
+  /**
+   * The contact information used in the two-factor steps for digital wallet card
+   * creation. To add the card to a digital wallet, you may supply an email or phone
+   * number with this request. Otherwise, subscribe and then action a Real Time
+   * Decision with the category `digital_wallet_token_requested` or
+   * `digital_wallet_authentication_requested`.
+   */
+  interface DigitalWallet {
+    /**
+     * The card profile assigned to this digital card. Card profiles may also be
+     * assigned at the program level.
+     */
+    card_profile_id?: string;
+    /**
+     * An email address that can be used to verify the cardholder via one-time passcode
+     * over email.
+     */
+    email?: string;
+    /**
+     * A phone number that can be used to verify the cardholder via one-time passcode
+     * over SMS.
+     */
+    phone?: string;
+  }
+}
+export interface CardUpdateParams {
+  /**
+   * The card's updated billing address.
+   */
+  billing_address?: CardUpdateParams.BillingAddress;
+  /**
+   * The description you choose to give the card.
+   */
+  description?: string;
+  /**
+   * The contact information used in the two-factor steps for digital wallet card
+   * creation. At least one field must be present to complete the digital wallet
+   * steps.
+   */
+  digital_wallet?: CardUpdateParams.DigitalWallet;
+  /**
+   * The status to update the Card with.
+   */
+  status?: 'active' | 'disabled' | 'canceled';
+}
+export declare namespace CardUpdateParams {
+  /**
+   * The card's updated billing address.
+   */
+  interface BillingAddress {
+    /**
+     * The city of the billing address.
+     */
+    city: string;
+    /**
+     * The first line of the billing address.
+     */
+    line1: string;
+    /**
+     * The postal code of the billing address.
+     */
+    postal_code: string;
+    /**
+     * The US state of the billing address.
+     */
+    state: string;
+    /**
+     * The second line of the billing address.
+     */
+    line2?: string;
+  }
+  /**
+   * The contact information used in the two-factor steps for digital wallet card
+   * creation. At least one field must be present to complete the digital wallet
+   * steps.
+   */
+  interface DigitalWallet {
+    /**
+     * The card profile assigned to this card. Card profiles may also be assigned at
+     * the program level.
+     */
+    card_profile_id?: string;
+    /**
+     * An email address that can be used to verify the cardholder via one-time passcode
+     * over email.
+     */
+    email?: string;
+    /**
+     * A phone number that can be used to verify the cardholder via one-time passcode
+     * over SMS.
+     */
+    phone?: string;
+  }
+}
+export interface CardListParams extends PageParams {
+  /**
+   * Filter Cards to ones belonging to the specified Account.
+   */
+  account_id?: string;
+  created_at?: CardListParams.CreatedAt;
+}
+export declare namespace CardListParams {
+  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 Cards {
+  export import Card = API.Card;
+  export import CardDetails = API.CardDetails;
+  export import CardsPage = API.CardsPage;
+  export import CardCreateParams = API.CardCreateParams;
+  export import CardUpdateParams = API.CardUpdateParams;
+  export import CardListParams = API.CardListParams;
+}
+//# sourceMappingURL=cards.d.ts.map

package/dist/esm/resources/cards.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cards.d.ts","sourceRoot":"","sources":["../../../resources/cards.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,OAAO,KAAK,GAAG,MAAM,IAAI,CAAC;AAC1B,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAEhD,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAI9F;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAIxF;;OAEG;IACH,MAAM,CACJ,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,gBAAgB,EACtB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAIlC;;OAEG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC;IACxF,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC;IAWhE;;OAEG;IACH,wBAAwB,CACtB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;CAG1C;AAED,qBAAa,SAAU,SAAQ,IAAI,CAAC,IAAI,CAAC;CAAG;AAE5C;;;;;GAKG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,IAAI,CAAC,cAAc,CAAC;IAErC;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;OAIG;IACH,cAAc,EAAE,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,UAAU,CAAC;IAE3C;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,IAAI,CAAC;IACpB;;OAEG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;IAED;;;;OAIG;IACH,UAAiB,aAAa;QAC5B;;;WAGG;QACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B;;;WAGG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;;WAGG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;;;OAIG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,CAAC,EAAE,gBAAgB,CAAC,cAAc,CAAC;IAElD;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,gBAAgB,CAAC,aAAa,CAAC;CACjD;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;;;;;OAMG;IACH,UAAiB,aAAa;QAC5B;;;WAGG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,eAAe,CAAC,EAAE,gBAAgB,CAAC,cAAc,CAAC;IAElD;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,cAAc,CAAC,EAAE,gBAAgB,CAAC,aAAa,CAAC;IAEhD;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,UAAU,CAAC;CAC7C;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;;;OAIG;IACH,UAAiB,aAAa;QAC5B;;;WAGG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,cAAc,CAAC,SAAS,CAAC;CACvC;AAED,yBAAiB,cAAc,CAAC;IAC9B,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,yBAAiB,KAAK,CAAC;IACrB,MAAM,QAAQ,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;IAC9B,MAAM,QAAQ,WAAW,GAAG,GAAG,CAAC,WAAW,CAAC;IAC5C,MAAM,QAAQ,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC;IACxC,MAAM,QAAQ,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAC;IACtD,MAAM,QAAQ,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAC;IACtD,MAAM,QAAQ,cAAc,GAAG,GAAG,CAAC,cAAc,CAAC;CACnD"}

package/dist/esm/resources/cards.js

@@ -0,0 +1,42 @@
+// File generated from our OpenAPI spec by Stainless.
+import { APIResource } from '../resource.js';
+import { isRequestOptions } from '../core.js';
+import * as API from './index.js';
+import { Page } from '../pagination.js';
+export class Cards extends APIResource {
+  /**
+   * Create a Card
+   */
+  create(body, options) {
+    return this.post('/cards', { body, ...options });
+  }
+  /**
+   * Retrieve a Card
+   */
+  retrieve(cardId, options) {
+    return this.get(`/cards/${cardId}`, options);
+  }
+  /**
+   * Update a Card
+   */
+  update(cardId, body, options) {
+    return this.patch(`/cards/${cardId}`, { body, ...options });
+  }
+  list(query = {}, options) {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this.getAPIList('/cards', CardsPage, { query, ...options });
+  }
+  /**
+   * Retrieve sensitive details for a Card
+   */
+  retrieveSensitiveDetails(cardId, options) {
+    return this.get(`/cards/${cardId}/details`, options);
+  }
+}
+export class CardsPage extends Page {}
+(function (Cards) {
+  Cards.CardsPage = API.CardsPage;
+})(Cards || (Cards = {}));
+//# sourceMappingURL=cards.js.map

package/dist/esm/resources/cards.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cards.js","sourceRoot":"","sources":["../../../resources/cards.ts"],"names":[],"mappings":"AAAA,qDAAqD;AAGrD,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,KAAK,GAAG,MAAM,IAAI,CAAC;AAC1B,OAAO,EAAE,IAAI,EAAc,MAAM,cAAc,CAAC;AAEhD,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,MAAM,CAAC,IAAsB,EAAE,OAA6B;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,MAAc,EAAE,OAA6B;QACpD,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,MAAc,EACd,IAAsB,EACtB,OAA6B;QAE7B,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAOD,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,UAAU,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACH,wBAAwB,CACtB,MAAc,EACd,OAA6B;QAE7B,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,MAAM,UAAU,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;CACF;AAED,MAAM,OAAO,SAAU,SAAQ,IAAU;CAAG;AA+W5C,WAAiB,KAAK;IAGN,eAAS,GAAG,GAAG,CAAC,SAAS,CAAC;AAI1C,CAAC,EAPgB,KAAK,KAAL,KAAK,QAOrB"}

package/dist/esm/resources/check-deposits.d.ts

@@ -0,0 +1,263 @@
+import * as Core from '../core.js';
+import { APIResource } from '../resource.js';
+import * as API from './index.js';
+import { Page, PageParams } from '../pagination.js';
+export declare class CheckDeposits extends APIResource {
+  /**
+   * Create a Check Deposit
+   */
+  create(
+    body: CheckDepositCreateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<CheckDeposit>>;
+  /**
+   * Retrieve a Check Deposit
+   */
+  retrieve(checkDepositId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<CheckDeposit>>;
+  /**
+   * List Check Deposits
+   */
+  list(query?: CheckDepositListParams, options?: Core.RequestOptions): Core.PagePromise<CheckDepositsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<CheckDepositsPage>;
+}
+export declare class CheckDepositsPage extends 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 the minor unit of the destination account currency. For
+   * dollars, for example, this is 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;
+  /**
+   * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the deposit.
+   */
+  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+  /**
+   * If 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;
+  /**
+   * The ID for the File containing the image of the front of the check.
+   */
+  front_image_file_id: string;
+  /**
+   * The status of the Check Deposit.
+   */
+  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';
+}
+export declare namespace CheckDeposit {
+  /**
+   * If 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.
+     */
+    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.
+     */
+    currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+    /**
+     * The routing number printed on 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;
+  }
+  /**
+   * 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 [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
+     * currency.
+     */
+    currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+    /**
+     * Why the check deposit was rejected.
+     */
+    reason:
+      | 'incomplete_image'
+      | 'duplicate'
+      | 'poor_image_quality'
+      | 'incorrect_amount'
+      | 'incorrect_recipient'
+      | 'not_eligible_for_mobile_deposit'
+      | 'missing_required_data_elements'
+      | 'unknown';
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+     * the check deposit was rejected.
+     */
+    rejected_at: string;
+  }
+  /**
+   * If your deposit is returned, this will contain details as to why it was
+   * returned.
+   */
+  interface DepositReturn {
+    /**
+     * The amount in the minor unit of the transaction's currency. For dollars, for
+     * example, this is 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.
+     */
+    currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+    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';
+    /**
+     * 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;
+  }
+}
+export interface CheckDepositCreateParams {
+  /**
+   * The identifier for the Account to deposit the check in.
+   */
+  account_id: string;
+  /**
+   * The deposit amount in the minor unit of the account currency. For dollars, for
+   * example, this is cents.
+   */
+  amount: number;
+  /**
+   * The File containing the check's back image.
+   */
+  back_image_file_id: string;
+  /**
+   * The currency to use for the deposit.
+   */
+  currency: string;
+  /**
+   * The File containing the check's front image.
+   */
+  front_image_file_id: string;
+}
+export interface CheckDepositListParams extends PageParams {
+  /**
+   * Filter Check Deposits to those belonging to the specified Account.
+   */
+  account_id?: string;
+  created_at?: CheckDepositListParams.CreatedAt;
+}
+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 import CheckDeposit = API.CheckDeposit;
+  export import CheckDepositsPage = API.CheckDepositsPage;
+  export import CheckDepositCreateParams = API.CheckDepositCreateParams;
+  export import CheckDepositListParams = API.CheckDepositListParams;
+}
+//# sourceMappingURL=check-deposits.d.ts.map

package/dist/esm/resources/check-deposits.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"check-deposits.d.ts","sourceRoot":"","sources":["../../../resources/check-deposits.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,OAAO,KAAK,GAAG,MAAM,IAAI,CAAC;AAC1B,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAEhD,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IAI1C;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IAIxG;;OAEG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC;IACxG,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC;CAUzE;AAED,qBAAa,iBAAkB,SAAQ,IAAI,CAAC,YAAY,CAAC;CAAG;AAE5D;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAExD;;;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;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;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;CACvB;AAED,yBAAiB,YAAY,CAAC;IAC5B;;;OAGG;IACH,UAAiB,iBAAiB;QAChC;;WAEG;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;;;WAGG;QACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;QAExD;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;;WAGG;QACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;KAC9B;IAED;;;OAGG;IACH,UAAiB,gBAAgB;QAC/B;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;QAExD;;WAEG;QACH,MAAM,EACF,kBAAkB,GAClB,WAAW,GACX,oBAAoB,GACpB,kBAAkB,GAClB,qBAAqB,GACrB,iCAAiC,GACjC,gCAAgC,GAChC,SAAS,CAAC;QAEd;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;KACrB;IAED;;;OAGG;IACH,UAAiB,aAAa;QAC5B;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;;WAGG;QACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;QAExD,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,CAAC;QAE5B;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;KACxB;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,sBAAuB,SAAQ,UAAU;IACxD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,sBAAsB,CAAC,SAAS,CAAC;CAC/C;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,yBAAiB,aAAa,CAAC;IAC7B,MAAM,QAAQ,YAAY,GAAG,GAAG,CAAC,YAAY,CAAC;IAC9C,MAAM,QAAQ,iBAAiB,GAAG,GAAG,CAAC,iBAAiB,CAAC;IACxD,MAAM,QAAQ,wBAAwB,GAAG,GAAG,CAAC,wBAAwB,CAAC;IACtE,MAAM,QAAQ,sBAAsB,GAAG,GAAG,CAAC,sBAAsB,CAAC;CACnE"}