increase 0.573.0 → 0.575.0

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/supplemental-documents.ts

@@ -53,7 +53,7 @@ export type EntitySupplementalDocumentsPage = Page<EntitySupplementalDocument>;
 
 /**
  * Supplemental Documents are uploaded files connected to an Entity during
- * onboarding.
+ * onboarding. Not all programs require supplemental documents.
  */
 export interface EntitySupplementalDocument {
   /**

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.573.0'; // x-release-please-version
+export const VERSION = '0.575.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.573.0";
+export declare const VERSION = "0.575.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.573.0'; // x-release-please-version
+exports.VERSION = '0.575.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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