increase 0.54.0 → 0.57.0

package/src/resources/check-deposits.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../core";
-import { APIResource } from "../resource";
-import { isRequestOptions } from "../core";
-import * as CheckDepositsAPI from "./check-deposits";
-import { Page, type PageParams } from "../pagination";
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as CheckDepositsAPI from './check-deposits';
+import { Page, type PageParams } from '../pagination';
 
 export class CheckDeposits extends APIResource {
   /**
@@ -73,18 +73,6 @@ export interface CheckDeposit {
    */
   created_at: string;
 
-  /**
-   * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the deposit.
-   *
-   * - `CAD` - Canadian Dollar (CAD)
-   * - `CHF` - Swiss Franc (CHF)
-   * - `EUR` - Euro (EUR)
-   * - `GBP` - British Pound (GBP)
-   * - `JPY` - Japanese Yen (JPY)
-   * - `USD` - US Dollar (USD)
-   */
-  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.
@@ -109,6 +97,11 @@ export interface CheckDeposit {
    */
   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.
    */
@@ -121,6 +114,18 @@ export interface CheckDeposit {
    */
   idempotency_key: string | 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.
    *
@@ -207,6 +212,11 @@ export namespace CheckDeposit {
      */
     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.
@@ -365,6 +375,18 @@ export namespace CheckDeposit {
    * processing. This will contain details of the submission.
    */
   export 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
@@ -392,14 +414,14 @@ export interface CheckDepositCreateParams {
   back_image_file_id: string;
 
   /**
-   * The currency to use for the deposit.
+   * The File containing the check's front image.
    */
-  currency: string;
+  front_image_file_id: string;
 
   /**
-   * The File containing the check's front image.
+   * The description you choose to give the Check Deposit, for display purposes only.
    */
-  front_image_file_id: string;
+  description?: string;
 }
 
 export interface CheckDepositListParams extends PageParams {

package/src/resources/check-transfers.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../core";
-import { APIResource } from "../resource";
-import { isRequestOptions } from "../core";
-import * as CheckTransfersAPI from "./check-transfers";
-import { Page, type PageParams } from "../pagination";
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as CheckTransfersAPI from './check-transfers';
+import { Page, type PageParams } from '../pagination';
 
 export class CheckTransfers extends APIResource {
   /**
@@ -121,6 +121,11 @@ export interface CheckTransfer {
    */
   created_at: string;
 
+  /**
+   * What object created the transfer, either via the API or the dashboard.
+   */
+  created_by: CheckTransfer.CreatedBy | null;
+
   /**
    * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
    * currency.
@@ -270,6 +275,69 @@ export namespace CheckTransfer {
     canceled_by: string | null;
   }
 
+  /**
+   * What object created the transfer, either via the API or the dashboard.
+   */
+  export interface CreatedBy {
+    /**
+     * If present, details about the API key that created the transfer.
+     */
+    api_key: CreatedBy.APIKey | null;
+
+    /**
+     * The type of object that created this transfer.
+     *
+     * - `api_key` - An API key. Details will be under the `api_key` object.
+     * - `oauth_application` - An OAuth application you connected to Increase. Details
+     *   will be under the `oauth_application` object.
+     * - `user` - A User in the Increase dashboard. Details will be under the `user`
+     *   object.
+     */
+    category: 'api_key' | 'oauth_application' | 'user';
+
+    /**
+     * If present, details about the OAuth Application that created the transfer.
+     */
+    oauth_application: CreatedBy.OAuthApplication | null;
+
+    /**
+     * If present, details about the User that created the transfer.
+     */
+    user: CreatedBy.User | null;
+  }
+
+  export namespace CreatedBy {
+    /**
+     * If present, details about the API key that created the transfer.
+     */
+    export interface APIKey {
+      /**
+       * The description set for the API key when it was created.
+       */
+      description: string | null;
+    }
+
+    /**
+     * If present, details about the OAuth Application that created the transfer.
+     */
+    export interface OAuthApplication {
+      /**
+       * The name of the OAuth Application.
+       */
+      name: string;
+    }
+
+    /**
+     * If present, details about the User that created the transfer.
+     */
+    export interface User {
+      /**
+       * The email address of the User.
+       */
+      email: string;
+    }
+  }
+
   /**
    * If the check has been mailed by Increase, this will contain details of the
    * shipment.
@@ -317,6 +385,12 @@ export namespace CheckTransfer {
      * The return address to be printed on the check.
      */
     return_address: PhysicalCheck.ReturnAddress | null;
+
+    /**
+     * The text that will appear as the signature on the check in cursive font. If
+     * blank, the check will be printed with 'No signature required'.
+     */
+    signature_text: string | null;
   }
 
   export namespace PhysicalCheck {
@@ -525,6 +599,12 @@ export namespace CheckTransferCreateParams {
      * the address of the Entity of the Account used to make the Check Transfer.
      */
     return_address?: PhysicalCheck.ReturnAddress;
+
+    /**
+     * The text that will appear as the signature on the check in cursive font. If not
+     * provided, the check will be printed with 'No signature required'.
+     */
+    signature_text?: string;
   }
 
   export namespace PhysicalCheck {

package/src/resources/declined-transactions.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../core";
-import { APIResource } from "../resource";
-import { isRequestOptions } from "../core";
-import * as DeclinedTransactionsAPI from "./declined-transactions";
-import { Page, type PageParams } from "../pagination";
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as DeclinedTransactionsAPI from './declined-transactions';
+import { Page, type PageParams } from '../pagination';
 
 export class DeclinedTransactions extends APIResource {
   /**
@@ -96,8 +96,9 @@ export interface DeclinedTransaction {
    *
    * - `account_number` - An Account Number.
    * - `card` - A Card.
+   * - `lockbox` - A Lockbox.
    */
-  route_type: 'account_number' | 'card' | null;
+  route_type: 'account_number' | 'card' | 'lockbox' | null;
 
   /**
    * This is an object giving more details on the network-level event that caused the
@@ -152,6 +153,8 @@ export namespace DeclinedTransaction {
      *   the `international_ach_decline` object.
      * - `wire_decline` - Wire Decline: details will be under the `wire_decline`
      *   object.
+     * - `check_deposit_rejection` - Check Deposit Rejection: details will be under the
+     *   `check_deposit_rejection` object.
      * - `other` - The Declined Transaction was made for an undocumented or deprecated
      *   reason.
      */
@@ -162,6 +165,7 @@ export namespace DeclinedTransaction {
       | 'inbound_real_time_payments_transfer_decline'
       | 'international_ach_decline'
       | 'wire_decline'
+      | 'check_deposit_rejection'
       | 'other';
 
     /**
@@ -170,6 +174,12 @@ export namespace DeclinedTransaction {
      */
     check_decline: Source.CheckDecline | null;
 
+    /**
+     * A Check Deposit Rejection object. This field will be present in the JSON
+     * response if and only if `category` is equal to `check_deposit_rejection`.
+     */
+    check_deposit_rejection: Source.CheckDepositRejection | null;
+
     /**
      * An Inbound Real-Time Payments Transfer Decline object. This field will be
      * present in the JSON response if and only if `category` is equal to
@@ -244,6 +254,7 @@ export namespace DeclinedTransaction {
        * - `duplicate_return` - A rare return reason. The return this message refers to
        *   was a duplicate.
        * - `entity_not_active` - The account's entity is not active.
+       * - `field_error` - There was an error with one of the required fields.
        * - `group_locked` - Your account is inactive.
        * - `insufficient_funds` - Your account contains insufficient funds.
        * - `misrouted_return` - A rare return reason. The return this message refers to
@@ -264,6 +275,7 @@ export namespace DeclinedTransaction {
         | 'credit_entry_refused_by_receiver'
         | 'duplicate_return'
         | 'entity_not_active'
+        | 'field_error'
         | 'group_locked'
         | 'insufficient_funds'
         | 'misrouted_return'
@@ -325,7 +337,7 @@ export namespace DeclinedTransaction {
       /**
        * The ID of the Card Payment this transaction belongs to.
        */
-      card_payment_id: string | null;
+      card_payment_id: string;
 
       /**
        * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
@@ -340,6 +352,11 @@ export namespace DeclinedTransaction {
        */
       currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
 
+      /**
+       * The identifier of the declined transaction created for this Card Decline.
+       */
+      declined_transaction_id: string;
+
       /**
        * If the authorization was made via a Digital Wallet Token (such as an Apple Pay
        * purchase), the identifier of the token that was used.
@@ -400,6 +417,17 @@ export namespace DeclinedTransaction {
        */
       physical_card_id: string | null;
 
+      /**
+       * The declined amount in the minor unit of the transaction's presentment currency.
+       */
+      presentment_amount: number;
+
+      /**
+       * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
+       * transaction's presentment currency.
+       */
+      presentment_currency: string;
+
       /**
        * The processing category describes the intent behind the authorization, such as
        * whether it was used for bill payments or an automatic fuel dispenser.
@@ -441,6 +469,8 @@ export namespace DeclinedTransaction {
        * - `insufficient_funds` - The Card's Account did not have a sufficient available
        *   balance.
        * - `cvv2_mismatch` - The given CVV2 did not match the card's value.
+       * - `card_expiration_mismatch` - The given expiration date did not match the
+       *   card's value. Only applies when a CVV2 is present.
        * - `transaction_not_allowed` - The attempted card transaction is not allowed per
        *   Increase's terms.
        * - `breaches_limit` - The transaction was blocked by a Limit.
@@ -462,6 +492,7 @@ export namespace DeclinedTransaction {
         | 'group_locked'
         | 'insufficient_funds'
         | 'cvv2_mismatch'
+        | 'card_expiration_mismatch'
         | 'transaction_not_allowed'
         | 'breaches_limit'
         | 'webhook_declined'
@@ -770,6 +801,71 @@ export namespace DeclinedTransaction {
         | 'user_initiated';
     }
 
+    /**
+     * A Check Deposit Rejection object. This field will be present in the JSON
+     * response if and only if `category` is equal to `check_deposit_rejection`.
+     */
+    export interface CheckDepositRejection {
+      /**
+       * 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.
+       *
+       * - `CAD` - Canadian Dollar (CAD)
+       * - `CHF` - Swiss Franc (CHF)
+       * - `EUR` - Euro (EUR)
+       * - `GBP` - British Pound (GBP)
+       * - `JPY` - Japanese Yen (JPY)
+       * - `USD` - US Dollar (USD)
+       */
+      currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+
+      /**
+       * 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.
+       * - `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'
+        | 'unknown';
+
+      /**
+       * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+       * the check deposit was rejected.
+       */
+      rejected_at: string;
+    }
+
     /**
      * An Inbound Real-Time Payments Transfer Decline object. This field will be
      * present in the JSON response if and only if `category` is equal to
@@ -1194,6 +1290,7 @@ export namespace DeclinedTransactionListParams {
       | 'inbound_real_time_payments_transfer_decline'
       | 'international_ach_decline'
       | 'wire_decline'
+      | 'check_deposit_rejection'
       | 'other'
     >;
   }

package/src/resources/digital-card-profiles.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../core";
-import { APIResource } from "../resource";
-import { isRequestOptions } from "../core";
-import * as DigitalCardProfilesAPI from "./digital-card-profiles";
-import { Page, type PageParams } from "../pagination";
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as DigitalCardProfilesAPI from './digital-card-profiles';
+import { Page, type PageParams } from '../pagination';
 
 export class DigitalCardProfiles extends APIResource {
   /**
@@ -122,12 +122,6 @@ export interface DigitalCardProfile {
    */
   idempotency_key: string | null;
 
-  /**
-   * Whether this Digital Card Profile is the default for all cards in its Increase
-   * group.
-   */
-  is_default: boolean;
-
   /**
    * A user-facing description for whoever is issuing the card.
    */

package/src/resources/digital-wallet-tokens.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../core";
-import { APIResource } from "../resource";
-import { isRequestOptions } from "../core";
-import * as DigitalWalletTokensAPI from "./digital-wallet-tokens";
-import { Page, type PageParams } from "../pagination";
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as DigitalWalletTokensAPI from './digital-wallet-tokens';
+import { Page, type PageParams } from '../pagination';
 
 export class DigitalWalletTokens extends APIResource {
   /**

package/src/resources/documents.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../core";
-import { APIResource } from "../resource";
-import { isRequestOptions } from "../core";
-import * as DocumentsAPI from "./documents";
-import { Page, type PageParams } from "../pagination";
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as DocumentsAPI from './documents';
+import { Page, type PageParams } from '../pagination';
 
 export class Documents extends APIResource {
   /**

package/src/resources/entities/beneficial-owners.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../../core";
-import { APIResource } from "../../resource";
-import * as BeneficialOwnersAPI from "./beneficial-owners";
-import * as EntitiesAPI from "./entities";
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as BeneficialOwnersAPI from './beneficial-owners';
+import * as EntitiesAPI from './entities';
 
 export class BeneficialOwners extends APIResource {
   /**