increase 0.54.0 → 0.58.0

package/src/resources/lockboxes.ts

@@ -0,0 +1,238 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as LockboxesAPI from './lockboxes';
+import { Page, type PageParams } from '../pagination';
+
+export class Lockboxes extends APIResource {
+  /**
+   * Create a Lockbox
+   */
+  create(body: LockboxCreateParams, options?: Core.RequestOptions): Core.APIPromise<Lockbox> {
+    return this._client.post('/lockboxes', { body, ...options });
+  }
+
+  /**
+   * Retrieve a Lockbox
+   */
+  retrieve(lockboxId: string, options?: Core.RequestOptions): Core.APIPromise<Lockbox> {
+    return this._client.get(`/lockboxes/${lockboxId}`, options);
+  }
+
+  /**
+   * Update a Lockbox
+   */
+  update(
+    lockboxId: string,
+    body: LockboxUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Lockbox> {
+    return this._client.patch(`/lockboxes/${lockboxId}`, { body, ...options });
+  }
+
+  /**
+   * List Lockboxes
+   */
+  list(query?: LockboxListParams, options?: Core.RequestOptions): Core.PagePromise<LockboxesPage, Lockbox>;
+  list(options?: Core.RequestOptions): Core.PagePromise<LockboxesPage, Lockbox>;
+  list(
+    query: LockboxListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<LockboxesPage, Lockbox> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.getAPIList('/lockboxes', LockboxesPage, { query, ...options });
+  }
+}
+
+export class LockboxesPage extends Page<Lockbox> {}
+
+/**
+ * Lockboxes are physical locations that can receive mail containing paper checks.
+ * Increase will automatically create a Check Deposit for checks received this way.
+ */
+export interface Lockbox {
+  /**
+   * The Lockbox identifier.
+   */
+  id: string;
+
+  /**
+   * The identifier for the Account checks sent to this lockbox will be deposited
+   * into.
+   */
+  account_id: string;
+
+  /**
+   * The mailing address for the Lockbox.
+   */
+  address: Lockbox.Address;
+
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
+   * was created.
+   */
+  created_at: string;
+
+  /**
+   * The description you choose for the Lockbox.
+   */
+  description: string | null;
+
+  /**
+   * The idempotency key you chose for this object. This value is unique across
+   * Increase and is used to ensure that a request is only processed once. Learn more
+   * about [idempotency](https://increase.com/documentation/idempotency-keys).
+   */
+  idempotency_key: string | null;
+
+  /**
+   * This indicates if mail can be sent to this address.
+   *
+   * - `active` - This Lockbox is active. Checks mailed to it will be deposited
+   *   automatically.
+   * - `inactive` - This Lockbox is inactive. Checks mailed to it will not be
+   *   deposited.
+   */
+  status: 'active' | 'inactive';
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `lockbox`.
+   */
+  type: 'lockbox';
+}
+
+export namespace Lockbox {
+  /**
+   * The mailing address for the Lockbox.
+   */
+  export interface Address {
+    /**
+     * The city of the address.
+     */
+    city: string;
+
+    /**
+     * The first line of the address.
+     */
+    line1: string;
+
+    /**
+     * The second line of the address.
+     */
+    line2: string;
+
+    /**
+     * The postal code of the address.
+     */
+    postal_code: string;
+
+    /**
+     * The two-letter United States Postal Service (USPS) abbreviation for the state of
+     * the address.
+     */
+    state: string;
+  }
+}
+
+/**
+ * A list of Lockbox objects.
+ */
+export interface LockboxList {
+  /**
+   * The contents of the list.
+   */
+  data: Array<Lockbox>;
+
+  /**
+   * A pointer to a place in the list.
+   */
+  next_cursor: string | null;
+}
+
+export interface LockboxCreateParams {
+  /**
+   * The Account checks sent to this Lockbox should be deposited into.
+   */
+  account_id: string;
+
+  /**
+   * The description you choose for the Lockbox, for display purposes.
+   */
+  description?: string;
+}
+
+export interface LockboxUpdateParams {
+  /**
+   * The description you choose for the Lockbox.
+   */
+  description?: string;
+
+  /**
+   * This indicates if checks can be sent to the Lockbox.
+   *
+   * - `active` - This Lockbox is active. Checks mailed to it will be deposited
+   *   automatically.
+   * - `inactive` - This Lockbox is inactive. Checks mailed to it will not be
+   *   deposited.
+   */
+  status?: 'active' | 'inactive';
+}
+
+export interface LockboxListParams extends PageParams {
+  /**
+   * Filter Lockboxes to those associated with the provided Account.
+   */
+  account_id?: string;
+
+  created_at?: LockboxListParams.CreatedAt;
+
+  /**
+   * Filter records to the one with the specified `idempotency_key` you chose for
+   * that object. This value is unique across Increase and is used to ensure that a
+   * request is only processed once. Learn more about
+   * [idempotency](https://increase.com/documentation/idempotency-keys).
+   */
+  idempotency_key?: string;
+}
+
+export namespace LockboxListParams {
+  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;
+  }
+}
+
+export namespace Lockboxes {
+  export import Lockbox = LockboxesAPI.Lockbox;
+  export import LockboxList = LockboxesAPI.LockboxList;
+  export import LockboxesPage = LockboxesAPI.LockboxesPage;
+  export import LockboxCreateParams = LockboxesAPI.LockboxCreateParams;
+  export import LockboxUpdateParams = LockboxesAPI.LockboxUpdateParams;
+  export import LockboxListParams = LockboxesAPI.LockboxListParams;
+}

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

package/src/resources/oauth-tokens.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 OAuthTokensAPI from "./oauth-tokens";
+import { APIResource } from '../resource';
+import * as Core from '../core';
+import * as OAuthTokensAPI from './oauth-tokens';
 
 export class OAuthTokens extends APIResource {
   /**

package/src/resources/pending-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 PendingTransactionsAPI from "./pending-transactions";
-import { Page, type PageParams } from "../pagination";
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as PendingTransactionsAPI from './pending-transactions';
+import { Page, type PageParams } from '../pagination';
 
 export class PendingTransactions extends APIResource {
   /**
@@ -100,8 +100,9 @@ export interface PendingTransaction {
    *
    * - `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
@@ -298,7 +299,7 @@ export namespace PendingTransaction {
       /**
        * 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
@@ -390,6 +391,17 @@ export namespace PendingTransaction {
        */
       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/physical-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 PhysicalCardProfilesAPI from "./physical-card-profiles";
-import { Page, type PageParams } from "../pagination";
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as PhysicalCardProfilesAPI from './physical-card-profiles';
+import { Page, type PageParams } from '../pagination';
 
 export class PhysicalCardProfiles extends APIResource {
   /**

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 {
   /**