increase 0.54.0 → 0.57.0

package/src/resources/physical-cards.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 PhysicalCardsAPI from "./physical-cards";
-import { Page, type PageParams } from "../pagination";
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as PhysicalCardsAPI from './physical-cards';
+import { Page, type PageParams } from '../pagination';
 
 export class PhysicalCards extends APIResource {
   /**

package/src/resources/programs.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 ProgramsAPI from "./programs";
-import { Page, type PageParams } from "../pagination";
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as ProgramsAPI from './programs';
+import { Page, type PageParams } from '../pagination';
 
 export class Programs extends APIResource {
   /**
@@ -55,6 +55,18 @@ export interface Program {
    */
   created_at: string;
 
+  /**
+   * The default configuration for digital cards attached to this Program.
+   */
+  default_digital_card_profile_id: string | null;
+
+  /**
+   * The Interest Rate currently being earned on the accounts in this program, as a
+   * string containing a decimal number. For example, a 1% interest rate would be
+   * represented as "0.01".
+   */
+  interest_rate: string;
+
   /**
    * The name of the Program.
    */

package/src/resources/proof-of-authorization-request-submissions.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 ProofOfAuthorizationRequestSubmissionsAPI from "./proof-of-authorization-request-submissions";
-import { Page, type PageParams } from "../pagination";
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as ProofOfAuthorizationRequestSubmissionsAPI from './proof-of-authorization-request-submissions';
+import { Page, type PageParams } from '../pagination';
 
 export class ProofOfAuthorizationRequestSubmissions extends APIResource {
   /**

package/src/resources/proof-of-authorization-requests.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 ProofOfAuthorizationRequestsAPI from "./proof-of-authorization-requests";
-import { Page, type PageParams } from "../pagination";
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as ProofOfAuthorizationRequestsAPI from './proof-of-authorization-requests';
+import { Page, type PageParams } from '../pagination';
 
 export class ProofOfAuthorizationRequests extends APIResource {
   /**

package/src/resources/real-time-decisions.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../core";
-import { APIResource } from "../resource";
-import * as RealTimeDecisionsAPI from "./real-time-decisions";
+import { APIResource } from '../resource';
+import * as Core from '../core';
+import * as RealTimeDecisionsAPI from './real-time-decisions';
 
 export class RealTimeDecisions extends APIResource {
   /**
@@ -226,6 +226,12 @@ export namespace RealTimeDecision {
      */
     settlement_currency: string;
 
+    /**
+     * The identifier of the Card Payment this authorization will belong to. Available
+     * in the API once the card authorization has completed.
+     */
+    upcoming_card_payment_id: string;
+
     /**
      * Fields related to verification of cardholder-provided values.
      */

package/src/resources/real-time-payments-request-for-payments.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 RealTimePaymentsRequestForPaymentsAPI from "./real-time-payments-request-for-payments";
-import { Page, type PageParams } from "../pagination";
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as RealTimePaymentsRequestForPaymentsAPI from './real-time-payments-request-for-payments';
+import { Page, type PageParams } from '../pagination';
 
 export class RealTimePaymentsRequestForPayments extends APIResource {
   /**

package/src/resources/real-time-payments-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 RealTimePaymentsTransfersAPI from "./real-time-payments-transfers";
-import { Page, type PageParams } from "../pagination";
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as RealTimePaymentsTransfersAPI from './real-time-payments-transfers';
+import { Page, type PageParams } from '../pagination';
 
 export class RealTimePaymentsTransfers extends APIResource {
   /**
@@ -92,7 +92,13 @@ export interface RealTimePaymentsTransfer {
   created_at: string;
 
   /**
-   * The name of the transfer's recipient as provided by the sender.
+   * What object created the transfer, either via the API or the dashboard.
+   */
+  created_by: RealTimePaymentsTransfer.CreatedBy | null;
+
+  /**
+   * The name of the transfer's recipient. This is set by the sender when creating
+   * the transfer.
    */
   creditor_name: string;
 
@@ -110,8 +116,8 @@ export interface RealTimePaymentsTransfer {
   currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
 
   /**
-   * The name of the transfer's sender. If not provided, the account's entity name
-   * will be used.
+   * The name of the transfer's sender. If not provided, defaults to the name of the
+   * account's entity.
    */
   debtor_name: string | null;
 
@@ -205,12 +211,14 @@ export interface RealTimePaymentsTransfer {
   type: 'real_time_payments_transfer';
 
   /**
-   * The name of the party on whose behalf the creditor is receiving the payment.
+   * The name of the ultimate recipient of the transfer. Set this if the creditor is
+   * an intermediary receiving the payment for someone else.
    */
   ultimate_creditor_name: string | null;
 
   /**
-   * The name of the the party on whose behalf the debtor is instructing the payment.
+   * The name of the ultimate sender of the transfer. Set this if the funds are being
+   * sent on behalf of someone who is not the account holder at Increase.
    */
   ultimate_debtor_name: string | null;
 }
@@ -252,6 +260,69 @@ export namespace RealTimePaymentsTransfer {
     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 transfer is rejected by Real-Time Payments or the destination financial
    * institution, this will contain supplemental details.
@@ -387,8 +458,8 @@ export interface RealTimePaymentsTransferCreateParams {
   source_account_number_id: string;
 
   /**
-   * The name of the transfer's sender. If not provided, the account's entity name
-   * will be used.
+   * The name of the transfer's sender. If not provided, defaults to the name of the
+   * account's entity.
    */
   debtor_name?: string;
 
@@ -416,12 +487,14 @@ export interface RealTimePaymentsTransferCreateParams {
   require_approval?: boolean;
 
   /**
-   * The name of the party on whose behalf the creditor is receiving the payment.
+   * The name of the ultimate recipient of the transfer. Set this if the creditor is
+   * an intermediary receiving the payment for someone else.
    */
   ultimate_creditor_name?: string;
 
   /**
-   * The name of the the party on whose behalf the debtor is instructing the payment.
+   * The name of the ultimate sender of the transfer. Set this if the funds are being
+   * sent on behalf of someone who is not the account holder at Increase.
    */
   ultimate_debtor_name?: string;
 }

package/src/resources/routing-numbers.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 RoutingNumbersAPI from "./routing-numbers";
-import { Page, type PageParams } from "../pagination";
+import { APIResource } from '../resource';
+import * as Core from '../core';
+import * as RoutingNumbersAPI from './routing-numbers';
+import { Page, type PageParams } from '../pagination';
 
 export class RoutingNumbers extends APIResource {
   /**

package/src/resources/simulations/account-statements.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 SimulationsAccountStatementsAPI from "./account-statements";
-import * as AccountStatementsAPI from "../account-statements";
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as SimulationsAccountStatementsAPI from './account-statements';
+import * as AccountStatementsAPI from '../account-statements';
 
 export class AccountStatements extends APIResource {
   /**

package/src/resources/simulations/account-transfers.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../../core";
-import { APIResource } from "../../resource";
-import * as AccountTransfersAPI from "../account-transfers";
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as AccountTransfersAPI from '../account-transfers';
 
 export class AccountTransfers extends APIResource {
   /**

package/src/resources/simulations/ach-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 * as SimulationsACHTransfersAPI from "./ach-transfers";
-import * as ACHTransfersAPI from "../ach-transfers";
-import * as InboundACHTransfersAPI from "../inbound-ach-transfers";
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as SimulationsACHTransfersAPI from './ach-transfers';
+import * as ACHTransfersAPI from '../ach-transfers';
+import * as InboundACHTransfersAPI from '../inbound-ach-transfers';
 
 export class ACHTransfers extends APIResource {
   /**

package/src/resources/simulations/card-disputes.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 SimulationsCardDisputesAPI from "./card-disputes";
-import * as CardDisputesAPI from "../card-disputes";
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as SimulationsCardDisputesAPI from './card-disputes';
+import * as CardDisputesAPI from '../card-disputes';
 
 export class CardDisputes extends APIResource {
   /**
@@ -26,10 +26,14 @@ export interface CardDisputeActionParams {
    * The status to move the dispute to.
    *
    * - `accepted` - The Card Dispute has been accepted and your funds have been
-   *   returned.
+   *   returned. The card dispute will eventually transition into `won` or `lost`
+   *   depending on the outcome.
    * - `rejected` - The Card Dispute has been rejected.
+   * - `lost` - The Card Dispute has been lost and funds previously credited from the
+   *   acceptance have been debited.
+   * - `won` - The Card Dispute has been won and no further action can be taken.
    */
-  status: 'accepted' | 'rejected';
+  status: 'accepted' | 'rejected' | 'lost' | 'won';
 
   /**
    * Why the dispute was rejected. Not required for accepting disputes.

package/src/resources/simulations/card-refunds.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 CardRefundsAPI from "./card-refunds";
-import * as TransactionsAPI from "../transactions";
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as CardRefundsAPI from './card-refunds';
+import * as TransactionsAPI from '../transactions';
 
 export class CardRefunds extends APIResource {
   /**

package/src/resources/simulations/cards.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 CardsAPI from "./cards";
-import * as TransactionsAPI from "../transactions";
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as CardsAPI from './cards';
+import * as TransactionsAPI from '../transactions';
 
 export class Cards extends APIResource {
   /**
@@ -121,8 +121,9 @@ export namespace CardAuthorizationSimulation {
      *
      * - `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
@@ -177,6 +178,8 @@ export namespace CardAuthorizationSimulation {
        *   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.
        */
@@ -187,6 +190,7 @@ export namespace CardAuthorizationSimulation {
         | 'inbound_real_time_payments_transfer_decline'
         | 'international_ach_decline'
         | 'wire_decline'
+        | 'check_deposit_rejection'
         | 'other';
 
       /**
@@ -195,6 +199,12 @@ export namespace CardAuthorizationSimulation {
        */
       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
@@ -269,6 +279,7 @@ export namespace CardAuthorizationSimulation {
          * - `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
@@ -289,6 +300,7 @@ export namespace CardAuthorizationSimulation {
           | 'credit_entry_refused_by_receiver'
           | 'duplicate_return'
           | 'entity_not_active'
+          | 'field_error'
           | 'group_locked'
           | 'insufficient_funds'
           | 'misrouted_return'
@@ -350,7 +362,7 @@ export namespace CardAuthorizationSimulation {
         /**
          * 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
@@ -365,6 +377,11 @@ export namespace CardAuthorizationSimulation {
          */
         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.
@@ -425,6 +442,17 @@ export namespace CardAuthorizationSimulation {
          */
         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.
@@ -466,6 +494,8 @@ export namespace CardAuthorizationSimulation {
          * - `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.
@@ -487,6 +517,7 @@ export namespace CardAuthorizationSimulation {
           | 'group_locked'
           | 'insufficient_funds'
           | 'cvv2_mismatch'
+          | 'card_expiration_mismatch'
           | 'transaction_not_allowed'
           | 'breaches_limit'
           | 'webhook_declined'
@@ -795,6 +826,71 @@ export namespace CardAuthorizationSimulation {
           | '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
@@ -1256,8 +1352,9 @@ export namespace CardAuthorizationSimulation {
      *
      * - `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
@@ -1454,7 +1551,7 @@ export namespace CardAuthorizationSimulation {
         /**
          * 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
@@ -1546,6 +1643,17 @@ export namespace CardAuthorizationSimulation {
          */
         physical_card_id: string | null;
 
+        /**
+         * The pending 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.

package/src/resources/simulations/check-deposits.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../../core";
-import { APIResource } from "../../resource";
-import * as CheckDepositsAPI from "../check-deposits";
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as CheckDepositsAPI from '../check-deposits';
 
 export class CheckDeposits extends APIResource {
   /**

package/src/resources/simulations/check-transfers.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../../core";
-import { APIResource } from "../../resource";
-import * as CheckTransfersAPI from "../check-transfers";
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as CheckTransfersAPI from '../check-transfers';
 
 export class CheckTransfers extends APIResource {
   /**