increase 0.1.0

package/resources/cards.ts

@@ -0,0 +1,398 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '~/core';
+import { APIResource } from '~/resource';
+import { isRequestOptions } from '~/core';
+import { Page, PageParams } from '~/pagination';
+
+export class Cards extends APIResource {
+  /**
+   * Create a Card
+   */
+  create(body: CardCreateParams, options?: Core.RequestOptions): Promise<Core.APIResponse<Card>> {
+    return this.post('/cards', { body, ...options });
+  }
+
+  /**
+   * Retrieve a Card
+   */
+  retrieve(cardId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Card>> {
+    return this.get(`/cards/${cardId}`, options);
+  }
+
+  /**
+   * Update a Card
+   */
+  update(
+    cardId: string,
+    body: CardUpdateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<Card>> {
+    return this.patch(`/cards/${cardId}`, { body, ...options });
+  }
+
+  /**
+   * List Cards
+   */
+  list(query?: CardListParams, options?: Core.RequestOptions): Core.PagePromise<CardsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<CardsPage>;
+  list(
+    query: CardListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<CardsPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+
+    return this.getAPIList('/cards', CardsPage, { query, ...options });
+  }
+
+  /**
+   * Retrieve sensitive details for a Card
+   */
+  retrieveSensitiveDetails(
+    cardId: string,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<CardDetails>> {
+    return this.get(`/cards/${cardId}/details`, options);
+  }
+}
+
+export 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 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 card identifier.
+   */
+  id: string;
+
+  /**
+   * 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 namespace Card {
+  export 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;
+  }
+
+  export 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. At least one field must be present to complete the digital wallet
+   * steps.
+   */
+  digital_wallet?: CardCreateParams.DigitalWallet;
+}
+
+export namespace CardCreateParams {
+  export 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;
+  }
+
+  export 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 namespace CardUpdateParams {
+  export 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;
+  }
+
+  export 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 CardListParams extends PageParams {
+  /**
+   * Filter Cards to ones belonging to the specified Account.
+   */
+  account_id?: string;
+
+  created_at?: CardListParams.CreatedAt;
+}
+
+export namespace CardListParams {
+  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;
+  }
+}

package/resources/check-deposits.ts

@@ -0,0 +1,303 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '~/core';
+import { APIResource } from '~/resource';
+import { isRequestOptions } from '~/core';
+import { Page, PageParams } from '~/pagination';
+
+export class CheckDeposits extends APIResource {
+  /**
+   * Create a Check Deposit
+   */
+  create(
+    body: CheckDepositCreateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<CheckDeposit>> {
+    return this.post('/check_deposits', { body, ...options });
+  }
+
+  /**
+   * Retrieve a Check Deposit
+   */
+  retrieve(checkDepositId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<CheckDeposit>> {
+    return this.get(`/check_deposits/${checkDepositId}`, options);
+  }
+
+  /**
+   * List Check Deposits
+   */
+  list(query?: CheckDepositListParams, options?: Core.RequestOptions): Core.PagePromise<CheckDepositsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<CheckDepositsPage>;
+  list(
+    query: CheckDepositListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<CheckDepositsPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+
+    return this.getAPIList('/check_deposits', CheckDepositsPage, { query, ...options });
+  }
+}
+
+export class CheckDepositsPage extends Page<CheckDeposit> {}
+
+/**
+ * Check Deposits allow you to deposit images of paper checks into your account.
+ */
+export interface CheckDeposit {
+  /**
+   * 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 deposit's identifier.
+   */
+  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 namespace CheckDeposit {
+  export 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;
+  }
+
+  export 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'
+      | 'unknown';
+
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+     * the check deposit was rejected.
+     */
+    rejected_at: string;
+  }
+
+  export 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';
+
+    /**
+     * 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 namespace CheckDepositListParams {
+  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;
+  }
+}