increase 0.54.0 → 0.57.0

package/src/resources/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 { isRequestOptions } from "../core";
-import * as ACHTransfersAPI from "./ach-transfers";
-import { Page, type PageParams } from "../pagination";
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as ACHTransfersAPI from './ach-transfers';
+import { Page, type PageParams } from '../pagination';
 
 export class ACHTransfers extends APIResource {
   /**
@@ -133,6 +133,11 @@ export interface ACHTransfer {
    */
   created_at: string;
 
+  /**
+   * What object created the transfer, either via the API or the dashboard.
+   */
+  created_by: ACHTransfer.CreatedBy | null;
+
   /**
    * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
    * currency. For ACH transfers this is always equal to `usd`.
@@ -156,12 +161,6 @@ export interface ACHTransfer {
    */
   destination_account_holder: 'business' | 'individual' | 'unknown';
 
-  /**
-   * The transfer effective date in
-   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
-   */
-  effective_date: string | null;
-
   /**
    * The identifier of the External Account the transfer was made to, if any.
    */
@@ -212,6 +211,14 @@ export interface ACHTransfer {
    */
   pending_transaction_id: string | null;
 
+  /**
+   * Configuration for how the effective date of the transfer will be set. This
+   * determines same-day vs future-dated settlement timing. If not set, defaults to a
+   * `settlement_schedule` of `same_day`. If set, exactly one of the child atributes
+   * must be set.
+   */
+  preferred_effective_date: ACHTransfer.PreferredEffectiveDate;
+
   /**
    * If your transfer is returned, this will contain details of the return.
    */
@@ -412,6 +419,69 @@ export namespace ACHTransfer {
     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;
+    }
+  }
+
   export interface NotificationsOfChange {
     /**
      * The required type of change that is being signaled by the receiving financial
@@ -489,6 +559,33 @@ export namespace ACHTransfer {
     created_at: string;
   }
 
+  /**
+   * Configuration for how the effective date of the transfer will be set. This
+   * determines same-day vs future-dated settlement timing. If not set, defaults to a
+   * `settlement_schedule` of `same_day`. If set, exactly one of the child atributes
+   * must be set.
+   */
+  export interface PreferredEffectiveDate {
+    /**
+     * A specific date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format to
+     * use as the effective date when submitting this transfer.
+     */
+    date: string | null;
+
+    /**
+     * A schedule by which Increase whill choose an effective date for the transfer.
+     *
+     * - `same_day` - The chosen effective date will be the same as the ACH processing
+     *   date on which the transfer is submitted. This is necessary, but not sufficient
+     *   for the transfer to be settled same-day: it must also be submitted before the
+     *   last same-day cutoff and be less than or equal to $1,000.000.00.
+     * - `future_dated` - The chosen effective date will be the business day following
+     *   the ACH processing date on which the transfer is submitted. The transfer will
+     *   be settled on that future day.
+     */
+    settlement_schedule: 'same_day' | 'future_dated' | null;
+  }
+
   /**
    * If your transfer is returned, this will contain details of the return.
    */
@@ -728,6 +825,14 @@ export namespace ACHTransfer {
       | 'untimely_dishonored_return'
       | 'untimely_return';
 
+    /**
+     * A 15 digit number that was generated by the bank that initiated the return. The
+     * trace number of the return is different than that of the original transfer. ACH
+     * trace numbers are not unique, but along with the amount and date this number can
+     * be used to identify the ACH return at the bank that initiated it.
+     */
+    trace_number: string;
+
     /**
      * The identifier of the Transaction associated with this return.
      */
@@ -748,21 +853,31 @@ export namespace ACHTransfer {
    */
   export interface Submission {
     /**
-     * The ACH's effective date sent to the receiving bank. If `effective_date` is
-     * configured in the ACH transfer, this will match the value there. Otherwise, it
-     * will the date that the ACH transfer was processed, which is usually the current
-     * or subsequent business day.
+     * The ACH transfer's effective date as sent to the Federal Reserve. If a specific
+     * date was configured using `preferred_effective_date`, this will match that
+     * value. Otherwise, it will be the date selected (following the specified
+     * settlement schedule) at the time the transfer was submitted.
      */
     effective_date: string;
 
     /**
-     * When the funds transfer is expected to settle in the recipient's account.
-     * Credits may be available sooner, at the receiving banks discretion. The FedACH
-     * schedule is published
+     * When the transfer is expected to settle in the recipient's account. Credits may
+     * be available sooner, at the receiving banks discretion. The FedACH schedule is
+     * published
      * [here](https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html).
      */
     expected_funds_settlement_at: string;
 
+    /**
+     * The settlement schedule the transfer is expected to follow. This expectation
+     * takes into account the `effective_date`, `submitted_at`, and the amount of the
+     * transfer.
+     *
+     * - `same_day` - The transfer is expected to settle same-day.
+     * - `future_dated` - The transfer is expected to settle on a future date.
+     */
+    expected_settlement_schedule: 'same_day' | 'future_dated';
+
     /**
      * When the ACH transfer was sent to FedACH.
      */
@@ -878,6 +993,14 @@ export interface ACHTransferCreateParams {
    */
   individual_name?: string;
 
+  /**
+   * Configuration for how the effective date of the transfer will be set. This
+   * determines same-day vs future-dated settlement timing. If not set, defaults to a
+   * `settlement_schedule` of `same_day`. If set, exactly one of the child atributes
+   * must be set.
+   */
+  preferred_effective_date?: ACHTransferCreateParams.PreferredEffectiveDate;
+
   /**
    * Whether the transfer requires explicit approval via the dashboard or API.
    */
@@ -981,6 +1104,33 @@ export namespace ACHTransferCreateParams {
       }
     }
   }
+
+  /**
+   * Configuration for how the effective date of the transfer will be set. This
+   * determines same-day vs future-dated settlement timing. If not set, defaults to a
+   * `settlement_schedule` of `same_day`. If set, exactly one of the child atributes
+   * must be set.
+   */
+  export interface PreferredEffectiveDate {
+    /**
+     * A specific date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format to
+     * use as the effective date when submitting this transfer.
+     */
+    date?: string;
+
+    /**
+     * A schedule by which Increase whill choose an effective date for the transfer.
+     *
+     * - `same_day` - The chosen effective date will be the same as the ACH processing
+     *   date on which the transfer is submitted. This is necessary, but not sufficient
+     *   for the transfer to be settled same-day: it must also be submitted before the
+     *   last same-day cutoff and be less than or equal to $1,000.000.00.
+     * - `future_dated` - The chosen effective date will be the business day following
+     *   the ACH processing date on which the transfer is submitted. The transfer will
+     *   be settled on that future day.
+     */
+    settlement_schedule?: 'same_day' | 'future_dated';
+  }
 }
 
 export interface ACHTransferListParams extends PageParams {

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

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

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

package/src/resources/card-disputes.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 CardDisputesAPI from "./card-disputes";
-import { Page, type PageParams } from "../pagination";
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as CardDisputesAPI from './card-disputes';
+import { Page, type PageParams } from '../pagination';
 
 export class CardDisputes extends APIResource {
   /**
@@ -81,6 +81,12 @@ export interface CardDispute {
    */
   idempotency_key: string | null;
 
+  /**
+   * If the Card Dispute's status is `lost`, this will contain details of the lost
+   * dispute.
+   */
+  loss: CardDispute.Loss | null;
+
   /**
    * If the Card Dispute's status is `rejected`, this will contain details of the
    * unsuccessful dispute.
@@ -92,16 +98,26 @@ export interface CardDispute {
    *
    * - `pending_reviewing` - The Card Dispute is pending review.
    * - `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: 'pending_reviewing' | 'accepted' | 'rejected';
+  status: 'pending_reviewing' | 'accepted' | 'rejected' | 'lost' | 'won';
 
   /**
    * A constant representing the object's type. For this resource it will always be
    * `card_dispute`.
    */
   type: 'card_dispute';
+
+  /**
+   * If the Card Dispute's status is `won`, this will contain details of the won
+   * dispute.
+   */
+  win: CardDispute.Win | null;
 }
 
 export namespace CardDispute {
@@ -128,6 +144,34 @@ export namespace CardDispute {
     transaction_id: string;
   }
 
+  /**
+   * If the Card Dispute's status is `lost`, this will contain details of the lost
+   * dispute.
+   */
+  export interface Loss {
+    /**
+     * The identifier of the Card Dispute that was lost.
+     */
+    card_dispute_id: string;
+
+    /**
+     * Why the Card Dispute was lost.
+     */
+    explanation: string;
+
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+     * the Card Dispute was lost.
+     */
+    lost_at: string;
+
+    /**
+     * The identifier of the Transaction that was created to debit the disputed funds
+     * from your account.
+     */
+    transaction_id: string;
+  }
+
   /**
    * If the Card Dispute's status is `rejected`, this will contain details of the
    * unsuccessful dispute.
@@ -149,6 +193,23 @@ export namespace CardDispute {
      */
     rejected_at: string;
   }
+
+  /**
+   * If the Card Dispute's status is `won`, this will contain details of the won
+   * dispute.
+   */
+  export interface Win {
+    /**
+     * The identifier of the Card Dispute that was won.
+     */
+    card_dispute_id: string;
+
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+     * the Card Dispute was won.
+     */
+    won_at: string;
+  }
 }
 
 export interface CardDisputeCreateParams {
@@ -211,7 +272,7 @@ export namespace CardDisputeListParams {
      * requests, this should be encoded as a comma-delimited string, such as
      * `?in=one,two,three`.
      */
-    in?: Array<'pending_reviewing' | 'accepted' | 'rejected'>;
+    in?: Array<'pending_reviewing' | 'accepted' | 'rejected' | 'lost' | 'won'>;
   }
 }
 

package/src/resources/card-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 CardPaymentsAPI from "./card-payments";
-import { Page, type PageParams } from "../pagination";
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as CardPaymentsAPI from './card-payments';
+import { Page, type PageParams } from '../pagination';
 
 export class CardPayments extends APIResource {
   /**
@@ -61,11 +61,21 @@ export interface CardPayment {
    */
   created_at: string;
 
+  /**
+   * The Digital Wallet Token identifier for this payment.
+   */
+  digital_wallet_token_id: string | null;
+
   /**
    * The interactions related to this card payment.
    */
   elements: Array<CardPayment.Element>;
 
+  /**
+   * The Physical Card identifier for this payment.
+   */
+  physical_card_id: string | null;
+
   /**
    * The summarized state of this card payment.
    */
@@ -207,7 +217,7 @@ export namespace CardPayment {
       /**
        * 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
@@ -299,6 +309,17 @@ export namespace CardPayment {
        */
       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.
@@ -630,7 +651,7 @@ export namespace CardPayment {
       /**
        * 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
@@ -645,6 +666,11 @@ export namespace CardPayment {
        */
       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.
@@ -705,6 +731,17 @@ export namespace CardPayment {
        */
       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.
@@ -746,6 +783,8 @@ export namespace CardPayment {
        * - `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.
@@ -767,6 +806,7 @@ export namespace CardPayment {
         | 'group_locked'
         | 'insufficient_funds'
         | 'cvv2_mismatch'
+        | 'card_expiration_mismatch'
         | 'transaction_not_allowed'
         | 'breaches_limit'
         | 'webhook_declined'
@@ -1201,19 +1241,19 @@ export namespace CardPayment {
       id: string;
 
       /**
-       * The pending amount in the minor unit of the transaction's currency. For dollars,
-       * for example, this is cents.
+       * The amount in the minor unit of the transaction's settlement currency. For
+       * dollars, for example, this is cents.
        */
       amount: number;
 
       /**
        * 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
-       * transaction's currency.
+       * transaction's settlement currency.
        *
        * - `CAD` - Canadian Dollar (CAD)
        * - `CHF` - Swiss Franc (CHF)
@@ -1260,6 +1300,17 @@ export namespace CardPayment {
        */
       network_identifiers: CardRefund.NetworkIdentifiers;
 
+      /**
+       * The 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;
+
       /**
        * Additional details about the card purchase, such as tax and industry-specific
        * fields.
@@ -1944,7 +1995,7 @@ export namespace CardPayment {
       /**
        * 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
@@ -2604,7 +2655,7 @@ export namespace CardPayment {
       /**
        * 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

package/src/resources/card-purchase-supplements.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 CardPurchaseSupplementsAPI from "./card-purchase-supplements";
-import { Page, type PageParams } from "../pagination";
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as CardPurchaseSupplementsAPI from './card-purchase-supplements';
+import { Page, type PageParams } from '../pagination';
 
 export class CardPurchaseSupplements extends APIResource {
   /**
@@ -189,6 +189,11 @@ export namespace CardPurchaseSupplement {
   }
 
   export interface LineItem {
+    /**
+     * The Card Purchase Supplement Line Item identifier.
+     */
+    id: string;
+
     /**
      * Indicates the type of line item.
      *

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