increase 0.572.0 → 0.574.0

package/src/resources/entities.ts

@@ -1325,7 +1325,8 @@ export namespace EntityCreateParams {
 
     /**
      * The legal identifier of the corporation. This is usually the Employer
-     * Identification Number (EIN).
+     * Identification Number (EIN). This replaces the deprecated `tax_identifier`
+     * field.
      */
     legal_identifier: Corporation.LegalIdentifier;
 
@@ -1539,7 +1540,8 @@ export namespace EntityCreateParams {
            * An identification number that can be used to verify the individual's identity,
            * such as a social security number. For Social Security Numbers and Individual
            * Taxpayer Identification Numbers, submit nine digits with no dashes or other
-           * separators.
+           * separators. When testing in sandbox, use one of our
+           * [sandbox test values](https://increase.com/documentation/sandbox-test-values).
            */
           number: string;
 
@@ -1651,12 +1653,14 @@ export namespace EntityCreateParams {
 
     /**
      * The legal identifier of the corporation. This is usually the Employer
-     * Identification Number (EIN).
+     * Identification Number (EIN). This replaces the deprecated `tax_identifier`
+     * field.
      */
     export interface LegalIdentifier {
       /**
        * The legal identifier. For US Employer Identification Numbers, submit nine digits
-       * with no dashes or other separators.
+       * with no dashes or other separators. When testing in sandbox, use one of our
+       * [sandbox test values](https://increase.com/documentation/sandbox-test-values).
        */
       value: string;
 
@@ -1865,7 +1869,8 @@ export namespace EntityCreateParams {
          * An identification number that can be used to verify the individual's identity,
          * such as a social security number. For Social Security Numbers and Individual
          * Taxpayer Identification Numbers, submit nine digits with no dashes or other
-         * separators.
+         * separators. When testing in sandbox, use one of our
+         * [sandbox test values](https://increase.com/documentation/sandbox-test-values).
          */
         number: string;
 
@@ -2075,7 +2080,8 @@ export namespace EntityCreateParams {
        * An identification number that can be used to verify the individual's identity,
        * such as a social security number. For Social Security Numbers and Individual
        * Taxpayer Identification Numbers, submit nine digits with no dashes or other
-       * separators.
+       * separators. When testing in sandbox, use one of our
+       * [sandbox test values](https://increase.com/documentation/sandbox-test-values).
        */
       number: string;
 
@@ -2453,7 +2459,8 @@ export namespace EntityCreateParams {
            * An identification number that can be used to verify the individual's identity,
            * such as a social security number. For Social Security Numbers and Individual
            * Taxpayer Identification Numbers, submit nine digits with no dashes or other
-           * separators.
+           * separators. When testing in sandbox, use one of our
+           * [sandbox test values](https://increase.com/documentation/sandbox-test-values).
            */
           number: string;
 
@@ -2660,7 +2667,8 @@ export namespace EntityCreateParams {
          * An identification number that can be used to verify the individual's identity,
          * such as a social security number. For Social Security Numbers and Individual
          * Taxpayer Identification Numbers, submit nine digits with no dashes or other
-         * separators.
+         * separators. When testing in sandbox, use one of our
+         * [sandbox test values](https://increase.com/documentation/sandbox-test-values).
          */
         number: string;
 
@@ -3081,7 +3089,8 @@ export namespace EntityUpdateParams {
        * An identification number that can be used to verify the individual's identity,
        * such as a social security number. For Social Security Numbers and Individual
        * Taxpayer Identification Numbers, submit nine digits with no dashes or other
-       * separators.
+       * separators. When testing in sandbox, use one of our
+       * [sandbox test values](https://increase.com/documentation/sandbox-test-values).
        */
       number: string;
 

package/src/resources/fednow-transfers.ts

@@ -199,25 +199,25 @@ export interface FednowTransfer {
   /**
    * The lifecycle status of the transfer.
    *
+   * - `pending_submitting` - The transfer is queued to be submitted to FedNow.
    * - `pending_reviewing` - The transfer is pending review by Increase.
    * - `canceled` - The transfer has been canceled.
    * - `reviewing_rejected` - The transfer has been rejected by Increase.
    * - `requires_attention` - The transfer requires attention from an Increase
    *   operator.
    * - `pending_approval` - The transfer is pending approval.
-   * - `pending_submitting` - The transfer is queued to be submitted to FedNow.
    * - `pending_response` - The transfer has been submitted and is pending a response
    *   from FedNow.
    * - `complete` - The transfer has been sent successfully and is complete.
    * - `rejected` - The transfer was rejected by the network or the recipient's bank.
    */
   status:
+    | 'pending_submitting'
     | 'pending_reviewing'
     | 'canceled'
     | 'reviewing_rejected'
     | 'requires_attention'
     | 'pending_approval'
-    | 'pending_submitting'
     | 'pending_response'
     | 'complete'
     | 'rejected';
@@ -632,12 +632,12 @@ export namespace FednowTransferListParams {
      * should be encoded as a comma-delimited string, such as `?in=one,two,three`.
      */
     in?: Array<
+      | 'pending_submitting'
       | 'pending_reviewing'
       | 'canceled'
       | 'reviewing_rejected'
       | 'requires_attention'
       | 'pending_approval'
-      | 'pending_submitting'
       | 'pending_response'
       | 'complete'
       | 'rejected'

package/src/resources/inbound-fednow-transfers.ts

@@ -139,6 +139,13 @@ export interface InboundFednowTransfer {
    */
   type: 'inbound_fednow_transfer';
 
+  /**
+   * The Unique End-to-end Transaction Reference
+   * ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr))
+   * of the transfer.
+   */
+  unique_end_to_end_transaction_reference: string | null;
+
   /**
    * Additional information included with the transfer.
    */

package/src/resources/inbound-mail-items.ts

@@ -41,7 +41,9 @@ export class InboundMailItems extends APIResource {
   }
 
   /**
-   * Action an Inbound Mail Item
+   * Deposits or ignores each check contained in a pending Inbound Mail Item.
+   * Depositing a check creates a [Check Deposit](#check-deposits) into the Account
+   * you specify.
    *
    * @example
    * ```ts
@@ -67,7 +69,9 @@ export type InboundMailItemsPage = Page<InboundMailItem>;
 
 /**
  * Inbound Mail Items represent pieces of physical mail delivered to a Lockbox
- * Address.
+ * Address. Increase automatically deposits checks mailed to a Lockbox Recipient
+ * into the recipient's Account. Checks that are not matched to a Lockbox Recipient
+ * must be deposited or ignored using the Action an Inbound Mail Item endpoint.
  */
 export interface InboundMailItem {
   /**

package/src/resources/inbound-real-time-payments-transfers.ts

@@ -126,7 +126,8 @@ export interface InboundRealTimePaymentsTransfer {
    * The lifecycle status of the transfer.
    *
    * - `pending_confirming` - The transfer is pending confirmation.
-   * - `timed_out` - The transfer was not responded to in time.
+   * - `timed_out` - The transfer was not responded to in time. This is rare and
+   *   represents an error at Increase.
    * - `confirmed` - The transfer has been received successfully and is confirmed.
    * - `declined` - The transfer has been declined.
    */

package/src/resources/lockbox-addresses.ts

@@ -8,7 +8,10 @@ import { path } from '../internal/utils/path';
 
 export class LockboxAddresses extends APIResource {
   /**
-   * Create a Lockbox Address
+   * The Lockbox Address starts with a `pending` status and a null `address`. Shortly
+   * after creation, Increase generates the mailing address and the status becomes
+   * `active`. You can only create Lockbox Recipients for an `active` Lockbox
+   * Address.
    *
    * @example
    * ```ts
@@ -76,7 +79,11 @@ export type LockboxAddressesPage = Page<LockboxAddress>;
 
 /**
  * Lockbox Addresses are physical locations that can receive mail containing paper
- * checks.
+ * checks. A Lockbox Address is not itself linked to an Account; Lockbox Recipients
+ * determine where checks received at the address are deposited. Lockbox Addresses
+ * are created with a `pending` status and a null `address`. Increase generates the
+ * mailing address shortly after creation, at which point the status becomes
+ * `active`.
  */
 export interface LockboxAddress {
   /**

package/src/resources/lockbox-recipients.ts

@@ -156,7 +156,8 @@ export interface LockboxRecipientCreateParams {
   account_id: string;
 
   /**
-   * The Lockbox Address where this Lockbox Recipient may receive mail.
+   * The Lockbox Address where this Lockbox Recipient may receive mail. The Lockbox
+   * Address must have a `status` of `active`.
    */
   lockbox_address_id: string;
 

package/src/resources/pending-transactions.ts

@@ -100,7 +100,10 @@ export interface PendingTransaction {
 
   /**
    * The Pending Transaction amount in the minor unit of its currency. For dollars,
-   * for example, this is cents.
+   * for example, this is cents. This amount does not change after the Pending
+   * Transaction is created. If a card authorization settles for a different amount,
+   * the settled amount is available on the resulting Transaction and on the Card
+   * Payment's `state.settled_amount`.
    */
   amount: number;
 
@@ -168,7 +171,9 @@ export interface PendingTransaction {
    * - `pending` - The Pending Transaction is still awaiting confirmation.
    * - `complete` - The Pending Transaction is confirmed. An associated Transaction
    *   exists for this object. The Pending Transaction will no longer count against
-   *   your balance and can generally be hidden from UIs, etc.
+   *   your balance and can generally be hidden from UIs, etc. The Pending
+   *   Transaction's `amount` is not updated if the associated Transaction settles
+   *   for a different amount.
    */
   status: 'pending' | 'complete';
 

package/src/resources/physical-cards.ts

@@ -329,15 +329,18 @@ export namespace PhysicalCard {
          *   event.
          * - `delivery_issue` - There is an issue preventing delivery. The delivery will be
          *   attempted again if possible. If the issue cannot be resolved, the physical
-         *   card will be returned to sender.
-         * - `returned_to_sender` - Delivery failed and the physical card was returned to
-         *   sender.
+         *   card will be rerouted to the return address.
+         * - `returning_to_sender` - The physical card has been rerouted to the return
+         *   address.
+         * - `returned_to_sender` - The physical card has been delivered to the return
+         *   address.
          */
         category:
           | 'in_transit'
           | 'processed_for_delivery'
           | 'delivered'
           | 'delivery_issue'
+          | 'returning_to_sender'
           | 'returned_to_sender';
 
         /**

package/src/resources/real-time-payments-transfers.ts

@@ -226,12 +226,12 @@ export interface RealTimePaymentsTransfer {
    *
    * - `pending_approval` - The transfer is pending approval.
    * - `canceled` - The transfer has been canceled.
+   * - `pending_submission` - The transfer is queued to be submitted to Real-Time
+   *   Payments.
    * - `pending_reviewing` - The transfer is pending review by Increase.
    * - `requires_attention` - The transfer requires attention from an Increase
    *   operator.
    * - `rejected` - The transfer was rejected by the network or the recipient's bank.
-   * - `pending_submission` - The transfer is queued to be submitted to Real-Time
-   *   Payments.
    * - `submitted` - The transfer has been submitted and is pending a response from
    *   Real-Time Payments.
    * - `complete` - The transfer has been sent successfully and is complete.
@@ -239,10 +239,10 @@ export interface RealTimePaymentsTransfer {
   status:
     | 'pending_approval'
     | 'canceled'
+    | 'pending_submission'
     | 'pending_reviewing'
     | 'requires_attention'
     | 'rejected'
-    | 'pending_submission'
     | 'submitted'
     | 'complete';
 
@@ -631,10 +631,10 @@ export namespace RealTimePaymentsTransferListParams {
     in?: Array<
       | 'pending_approval'
       | 'canceled'
+      | 'pending_submission'
       | 'pending_reviewing'
       | 'requires_attention'
       | 'rejected'
-      | 'pending_submission'
       | 'submitted'
       | 'complete'
     >;

package/src/resources/simulations/card-authorizations.ts

@@ -14,7 +14,10 @@ export class CardAuthorizations extends APIResource {
    * `card_authorization` or a [Declined Transaction](#declined-transactions) of type
    * `card_decline`. You can pass either a Card id or a
    * [Digital Wallet Token](#digital-wallet-tokens) id to simulate the two different
-   * ways purchases can be made.
+   * ways purchases can be made. The response will contain either a
+   * `pending_transaction` or a `declined_transaction`; the other attribute will be
+   * null. If the authorization is declined, the reason is available on the Declined
+   * Transaction at `source.card_decline.reason`.
    *
    * @example
    * ```ts

package/src/resources/simulations/inbound-ach-transfers.ts

@@ -75,7 +75,8 @@ export interface InboundACHTransferCreateParams {
   company_id?: string;
 
   /**
-   * The name of the sender.
+   * The name of the sender. This corresponds to the `originator_company_name` field
+   * on the resulting Inbound ACH Transfer.
    */
   company_name?: string;
 

package/src/resources/simulations/inbound-mail-items.ts

@@ -8,7 +8,10 @@ import { RequestOptions } from '../../internal/request-options';
 export class InboundMailItems extends APIResource {
   /**
    * Simulates an Inbound Mail Item to one of your Lockbox Addresses or Lockbox
-   * Recipients, as if someone had mailed a physical check.
+   * Recipients, as if someone had mailed a physical check. Increase automatically
+   * deposits a check mailed to a Lockbox Recipient into the recipient's Account. A
+   * check mailed to a Lockbox Address must be deposited or ignored with the
+   * [Action an Inbound Mail Item](#inbound-mail-items) endpoint.
    *
    * @example
    * ```ts
@@ -39,12 +42,14 @@ export interface InboundMailItemCreateParams {
   contents_file_id?: string;
 
   /**
-   * The identifier of the Lockbox Address to simulate inbound mail to.
+   * The identifier of the Lockbox Address to simulate inbound mail to. Exactly one
+   * lockbox identifier parameter must be provided.
    */
   lockbox_address_id?: string;
 
   /**
-   * The identifier of the Lockbox Recipient to simulate inbound mail to.
+   * The identifier of the Lockbox Recipient to simulate inbound mail to. Exactly one
+   * lockbox identifier parameter must be provided.
    */
   lockbox_recipient_id?: string;
 

package/src/resources/simulations/physical-cards.ts

@@ -69,11 +69,19 @@ export interface PhysicalCardCreateParams {
    *   event.
    * - `delivery_issue` - There is an issue preventing delivery. The delivery will be
    *   attempted again if possible. If the issue cannot be resolved, the physical
-   *   card will be returned to sender.
-   * - `returned_to_sender` - Delivery failed and the physical card was returned to
-   *   sender.
+   *   card will be rerouted to the return address.
+   * - `returning_to_sender` - The physical card has been rerouted to the return
+   *   address.
+   * - `returned_to_sender` - The physical card has been delivered to the return
+   *   address.
    */
-  category: 'in_transit' | 'processed_for_delivery' | 'delivered' | 'delivery_issue' | 'returned_to_sender';
+  category:
+    | 'in_transit'
+    | 'processed_for_delivery'
+    | 'delivered'
+    | 'delivery_issue'
+    | 'returning_to_sender'
+    | 'returned_to_sender';
 
   /**
    * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time when the

package/src/resources/swift-transfers.ts

@@ -205,10 +205,10 @@ export interface SwiftTransfer {
    *
    * - `pending_approval` - The transfer is pending approval.
    * - `canceled` - The transfer has been canceled.
+   * - `pending_initiating` - The transfer is pending initiation.
    * - `pending_reviewing` - The transfer is pending review by Increase.
    * - `requires_attention` - The transfer requires attention from an Increase
    *   operator.
-   * - `pending_initiating` - The transfer is pending initiation.
    * - `initiated` - The transfer has been initiated.
    * - `rejected` - The transfer has been rejected by Increase.
    * - `returned` - The transfer has been returned.
@@ -216,9 +216,9 @@ export interface SwiftTransfer {
   status:
     | 'pending_approval'
     | 'canceled'
+    | 'pending_initiating'
     | 'pending_reviewing'
     | 'requires_attention'
-    | 'pending_initiating'
     | 'initiated'
     | 'rejected'
     | 'returned';
@@ -592,9 +592,9 @@ export namespace SwiftTransferListParams {
     in?: Array<
       | 'pending_approval'
       | 'canceled'
+      | 'pending_initiating'
       | 'pending_reviewing'
       | 'requires_attention'
-      | 'pending_initiating'
       | 'initiated'
       | 'rejected'
       | 'returned'

package/src/resources/transactions.ts

@@ -288,7 +288,8 @@ export namespace Transaction {
      * Return is created when an ACH Transfer is returned by the receiving bank. It
      * offsets the ACH Transfer Intention. ACH Transfer Returns usually occur within
      * the first two business days after the transfer is initiated, but can occur much
-     * later.
+     * later. The return appears as a new posted Transaction; no Pending Transaction is
+     * created.
      */
     ach_transfer_return?: Source.ACHTransferReturn | null;
 
@@ -686,7 +687,8 @@ export namespace Transaction {
      * Return is created when an ACH Transfer is returned by the receiving bank. It
      * offsets the ACH Transfer Intention. ACH Transfer Returns usually occur within
      * the first two business days after the transfer is initiated, but can occur much
-     * later.
+     * later. The return appears as a new posted Transaction; no Pending Transaction is
+     * created.
      */
     export interface ACHTransferReturn {
       /**
@@ -941,7 +943,8 @@ export namespace Transaction {
       transaction_id: string;
 
       /**
-       * The identifier of the ACH Transfer associated with this return.
+       * The identifier of the ACH Transfer associated with this return. This matches the
+       * original Transaction's `source.ach_transfer_intention.transfer_id`.
        */
       transfer_id: string;
 

package/src/resources/wire-transfers.ts

@@ -209,11 +209,11 @@ export interface WireTransfer {
    *
    * - `pending_approval` - The transfer is pending approval.
    * - `canceled` - The transfer has been canceled.
+   * - `pending_creating` - The transfer is pending creation.
    * - `pending_reviewing` - The transfer is pending review by Increase.
    * - `rejected` - The transfer has been rejected by Increase.
    * - `requires_attention` - The transfer requires attention from an Increase
    *   operator.
-   * - `pending_creating` - The transfer is pending creation.
    * - `reversed` - The transfer has been reversed.
    * - `submitted` - The transfer has been submitted to Fedwire.
    * - `complete` - The transfer has been acknowledged by Fedwire and can be
@@ -222,10 +222,10 @@ export interface WireTransfer {
   status:
     | 'pending_approval'
     | 'canceled'
+    | 'pending_creating'
     | 'pending_reviewing'
     | 'rejected'
     | 'requires_attention'
-    | 'pending_creating'
     | 'reversed'
     | 'submitted'
     | 'complete';
@@ -904,10 +904,10 @@ export namespace WireTransferListParams {
     in?: Array<
       | 'pending_approval'
       | 'canceled'
+      | 'pending_creating'
       | 'pending_reviewing'
       | 'rejected'
       | 'requires_attention'
-      | 'pending_creating'
       | 'reversed'
       | 'submitted'
       | 'complete'

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.572.0'; // x-release-please-version
+export const VERSION = '0.574.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.572.0";
+export declare const VERSION = "0.574.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.572.0";
+export declare const VERSION = "0.574.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.572.0'; // x-release-please-version
+exports.VERSION = '0.574.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.572.0'; // x-release-please-version
+export const VERSION = '0.574.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map