increase 0.28.0 → 0.30.0

package/src/resources/account-transfers.ts

@@ -122,6 +122,13 @@ export interface AccountTransfer {
    */
   destination_transaction_id: 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;
+
   /**
    * The transfer's network.
    */
@@ -154,11 +161,6 @@ export interface AccountTransfer {
    * `account_transfer`.
    */
   type: 'account_transfer';
-
-  /**
-   * The unique identifier you chose for this object.
-   */
-  unique_identifier: string | null;
 }
 
 export namespace AccountTransfer {
@@ -225,13 +227,6 @@ export interface AccountTransferCreateParams {
    * Whether the transfer requires explicit approval via the dashboard or API.
    */
   require_approval?: boolean;
-
-  /**
-   * A unique identifier you choose for the object. Reusing this identifier for
-   * another object will result in an error. You can query for the object associated
-   * with this identifier using the List endpoint.
-   */
-  unique_identifier?: string;
 }
 
 export interface AccountTransferListParams extends PageParams {
@@ -243,9 +238,12 @@ export interface AccountTransferListParams extends PageParams {
   created_at?: AccountTransferListParams.CreatedAt;
 
   /**
-   * Filter records to the one with the specified `unique_identifier`.
+   * 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).
    */
-  unique_identifier?: string;
+  idempotency_key?: string;
 }
 
 export namespace AccountTransferListParams {

package/src/resources/accounts.ts

@@ -119,6 +119,13 @@ export interface Account {
    */
   entity_id: 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;
+
   /**
    * The identifier of an Entity that, while not owning the Account, is associated
    * with its activity.
@@ -232,6 +239,14 @@ export interface AccountListParams extends PageParams {
    */
   entity_id?: string;
 
+  /**
+   * 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;
+
   /**
    * Filter Accounts for those belonging to the specified Entity as informational.
    */

package/src/resources/ach-prenotifications.ts

@@ -104,6 +104,13 @@ export interface ACHPrenotification {
    */
   effective_date: 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;
+
   /**
    * If the receiving bank notifies that future transfers should use different
    * details, this will contain those details.
@@ -527,6 +534,14 @@ export interface ACHPrenotificationCreateParams {
 
 export interface ACHPrenotificationListParams extends PageParams {
   created_at?: ACHPrenotificationListParams.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 ACHPrenotificationListParams {

package/src/resources/ach-transfers.ts

@@ -86,7 +86,7 @@ export interface ACHTransfer {
   /**
    * Additional information that will be sent to the recipient.
    */
-  addendum: string | null;
+  addenda: ACHTransfer.Addenda | null;
 
   /**
    * The transfer amount in USD cents. A positive amount indicates a credit transfer
@@ -146,6 +146,16 @@ export interface ACHTransfer {
    */
   currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
 
+  /**
+   * The type of entity that owns the account to which the ACH Transfer is being
+   * sent.
+   *
+   * - `business` - The External Account is owned by a business.
+   * - `individual` - The External Account is owned by an individual.
+   * - `unknown` - It's unknown what kind of entity owns the External Account.
+   */
+  destination_account_holder: 'business' | 'individual' | 'unknown';
+
   /**
    * The transfer effective date in
    * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
@@ -165,6 +175,13 @@ export interface ACHTransfer {
    */
   funding: 'checking' | 'savings';
 
+  /**
+   * 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;
+
   /**
    * Your identifier for the transfer recipient.
    */
@@ -265,11 +282,6 @@ export interface ACHTransfer {
    * `ach_transfer`.
    */
   type: 'ach_transfer';
-
-  /**
-   * The unique identifier you chose for this object.
-   */
-  unique_identifier: string | null;
 }
 
 export namespace ACHTransfer {
@@ -286,6 +298,82 @@ export namespace ACHTransfer {
     acknowledged_at: string;
   }
 
+  /**
+   * Additional information that will be sent to the recipient.
+   */
+  export interface Addenda {
+    /**
+     * The type of the resource. We may add additional possible values for this enum
+     * over time; your application should be able to handle such additions gracefully.
+     *
+     * - `freeform` - Unstructured `payment_related_information` passed through with
+     *   the transfer.
+     * - `payment_order_remittance_advice` - Structured ASC X12 820 remittance advice
+     *   records. Please reach out to
+     *   [support@increase.com](mailto:support@increase.com) for more information.
+     * - `other` - Unknown addenda type.
+     */
+    category: 'freeform' | 'payment_order_remittance_advice' | 'other';
+
+    /**
+     * Unstructured `payment_related_information` passed through with the transfer.
+     */
+    freeform: Addenda.Freeform | null;
+
+    /**
+     * Structured ASC X12 820 remittance advice records. Please reach out to
+     * [support@increase.com](mailto:support@increase.com) for more information.
+     */
+    payment_order_remittance_advice: Addenda.PaymentOrderRemittanceAdvice | null;
+  }
+
+  export namespace Addenda {
+    /**
+     * Unstructured `payment_related_information` passed through with the transfer.
+     */
+    export interface Freeform {
+      /**
+       * Each entry represents an addendum sent with the transfer.
+       */
+      entries: Array<Freeform.Entry>;
+    }
+
+    export namespace Freeform {
+      export interface Entry {
+        /**
+         * The payment related information passed in the addendum.
+         */
+        payment_related_information: string;
+      }
+    }
+
+    /**
+     * Structured ASC X12 820 remittance advice records. Please reach out to
+     * [support@increase.com](mailto:support@increase.com) for more information.
+     */
+    export interface PaymentOrderRemittanceAdvice {
+      /**
+       * ASC X12 RMR records for this specific transfer.
+       */
+      invoices: Array<PaymentOrderRemittanceAdvice.Invoice>;
+    }
+
+    export namespace PaymentOrderRemittanceAdvice {
+      export interface Invoice {
+        /**
+         * The invoice number for this reference, determined in advance with the receiver.
+         */
+        invoice_number: string;
+
+        /**
+         * The amount that was paid for this invoice in the minor unit of its currency. For
+         * dollars, for example, this is cents.
+         */
+        paid_amount: number;
+      }
+    }
+  }
+
   /**
    * If your account requires approvals for transfers and the transfer was approved,
    * this will contain details of the approval.
@@ -721,7 +809,7 @@ export interface ACHTransferCreateParams {
    * Additional information that will be sent to the recipient. This is included in
    * the transfer data sent to the receiving bank.
    */
-  addendum?: string;
+  addenda?: ACHTransferCreateParams.Addenda;
 
   /**
    * The description of the date of the transfer, usually in the format `YYMMDD`.
@@ -747,6 +835,16 @@ export interface ACHTransferCreateParams {
    */
   company_name?: string;
 
+  /**
+   * The type of entity that owns the account to which the ACH Transfer is being
+   * sent.
+   *
+   * - `business` - The External Account is owned by a business.
+   * - `individual` - The External Account is owned by an individual.
+   * - `unknown` - It's unknown what kind of entity owns the External Account.
+   */
+  destination_account_holder?: 'business' | 'individual' | 'unknown';
+
   /**
    * The transfer effective date in
    * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
@@ -800,13 +898,85 @@ export interface ACHTransferCreateParams {
     | 'corporate_credit_or_debit'
     | 'prearranged_payments_and_deposit'
     | 'internet_initiated';
+}
 
+export namespace ACHTransferCreateParams {
   /**
-   * A unique identifier you choose for the object. Reusing this identifier for
-   * another object will result in an error. You can query for the object associated
-   * with this identifier using the List endpoint.
+   * Additional information that will be sent to the recipient. This is included in
+   * the transfer data sent to the receiving bank.
    */
-  unique_identifier?: string;
+  export interface Addenda {
+    /**
+     * The type of addenda to pass with the transfer.
+     *
+     * - `freeform` - Unstructured `payment_related_information` passed through with
+     *   the transfer.
+     * - `payment_order_remittance_advice` - Structured ASC X12 820 remittance advice
+     *   records. Please reach out to
+     *   [support@increase.com](mailto:support@increase.com) for more information.
+     */
+    category: 'freeform' | 'payment_order_remittance_advice';
+
+    /**
+     * Unstructured `payment_related_information` passed through with the transfer.
+     */
+    freeform?: Addenda.Freeform;
+
+    /**
+     * Structured ASC X12 820 remittance advice records. Please reach out to
+     * [support@increase.com](mailto:support@increase.com) for more information.
+     */
+    payment_order_remittance_advice?: Addenda.PaymentOrderRemittanceAdvice;
+  }
+
+  export namespace Addenda {
+    /**
+     * Unstructured `payment_related_information` passed through with the transfer.
+     */
+    export interface Freeform {
+      /**
+       * Each entry represents an addendum sent with the transfer. Please reach out to
+       * [support@increase.com](mailto:support@increase.com) to send more than one
+       * addendum.
+       */
+      entries: Array<Freeform.Entry>;
+    }
+
+    export namespace Freeform {
+      export interface Entry {
+        /**
+         * The payment related information passed in the addendum.
+         */
+        payment_related_information: string;
+      }
+    }
+
+    /**
+     * Structured ASC X12 820 remittance advice records. Please reach out to
+     * [support@increase.com](mailto:support@increase.com) for more information.
+     */
+    export interface PaymentOrderRemittanceAdvice {
+      /**
+       * ASC X12 RMR records for this specific transfer.
+       */
+      invoices: Array<PaymentOrderRemittanceAdvice.Invoice>;
+    }
+
+    export namespace PaymentOrderRemittanceAdvice {
+      export interface Invoice {
+        /**
+         * The invoice number for this reference, determined in advance with the receiver.
+         */
+        invoice_number: string;
+
+        /**
+         * The amount that was paid for this invoice in the minor unit of its currency. For
+         * dollars, for example, this is cents.
+         */
+        paid_amount: number;
+      }
+    }
+  }
 }
 
 export interface ACHTransferListParams extends PageParams {
@@ -823,9 +993,12 @@ export interface ACHTransferListParams extends PageParams {
   external_account_id?: string;
 
   /**
-   * Filter records to the one with the specified `unique_identifier`.
+   * 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).
    */
-  unique_identifier?: string;
+  idempotency_key?: string;
 }
 
 export namespace ACHTransferListParams {

package/src/resources/bookkeeping-accounts.ts

@@ -101,6 +101,13 @@ export interface BookkeepingAccount {
    */
   entity_id: 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;
+
   /**
    * The name you choose for the account.
    */
@@ -168,7 +175,15 @@ export interface BookkeepingAccountUpdateParams {
   name: string;
 }
 
-export interface BookkeepingAccountListParams extends PageParams {}
+export interface BookkeepingAccountListParams extends PageParams {
+  /**
+   * 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 interface BookkeepingAccountBalanceParams {
   /**

package/src/resources/bookkeeping-entry-sets.ts

@@ -78,6 +78,13 @@ export interface BookkeepingEntrySet {
    */
   entries: Array<BookkeepingEntrySet.Entry>;
 
+  /**
+   * 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;
+
   /**
    * The transaction identifier, if any.
    */
@@ -144,6 +151,14 @@ export namespace BookkeepingEntrySetCreateParams {
 }
 
 export interface BookkeepingEntrySetListParams extends PageParams {
+  /**
+   * 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;
+
   /**
    * Filter to the Bookkeeping Entry Set that maps to this Transaction.
    */

package/src/resources/card-disputes.ts

@@ -74,6 +74,13 @@ export interface CardDispute {
    */
   explanation: string;
 
+  /**
+   * 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;
+
   /**
    * If the Card Dispute's status is `rejected`, this will contain details of the
    * unsuccessful dispute.
@@ -160,6 +167,14 @@ export interface CardDisputeCreateParams {
 export interface CardDisputeListParams extends PageParams {
   created_at?: CardDisputeListParams.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;
+
   status?: CardDisputeListParams.Status;
 }
 

package/src/resources/cards.ts

@@ -108,6 +108,13 @@ export interface Card {
    */
   expiration_year: number;
 
+  /**
+   * 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;
+
   /**
    * The last 4 digits of the Card's Primary Account Number.
    */
@@ -295,11 +302,6 @@ export namespace CardCreateParams {
    * `digital_wallet_authentication_requested`.
    */
   export interface DigitalWallet {
-    /**
-     * The card profile assigned to this digital card.
-     */
-    card_profile_id?: string;
-
     /**
      * The digital card profile assigned to this digital card.
      */
@@ -396,6 +398,11 @@ export namespace CardUpdateParams {
      */
     card_profile_id?: string;
 
+    /**
+     * The digital card profile assigned to this digital card.
+     */
+    digital_card_profile_id?: string;
+
     /**
      * An email address that can be used to verify the cardholder via one-time passcode
      * over email.
@@ -417,6 +424,14 @@ export interface CardListParams extends PageParams {
   account_id?: string;
 
   created_at?: CardListParams.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 CardListParams {

package/src/resources/check-deposits.ts

@@ -114,6 +114,13 @@ export interface CheckDeposit {
    */
   front_image_file_id: string;
 
+  /**
+   * 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;
+
   /**
    * The status of the Check Deposit.
    *
@@ -225,8 +232,9 @@ export namespace CheckDeposit {
      * - `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
+     *   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:
@@ -238,6 +246,7 @@ export namespace CheckDeposit {
       | 'not_eligible_for_mobile_deposit'
       | 'missing_required_data_elements'
       | 'suspected_fraud'
+      | 'deposit_window_expired'
       | 'unknown';
 
     /**
@@ -400,6 +409,14 @@ export interface CheckDepositListParams extends PageParams {
   account_id?: string;
 
   created_at?: CheckDepositListParams.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 CheckDepositListParams {

package/src/resources/check-transfers.ts

@@ -143,6 +143,13 @@ export interface CheckTransfer {
    */
   fulfillment_method: 'physical_check' | 'third_party';
 
+  /**
+   * 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;
+
   /**
    * If the check has been mailed by Increase, this will contain details of the
    * shipment.
@@ -219,11 +226,6 @@ export interface CheckTransfer {
    * `check_transfer`.
    */
   type: 'check_transfer';
-
-  /**
-   * The unique identifier you chose for this object.
-   */
-  unique_identifier: string | null;
 }
 
 export namespace CheckTransfer {
@@ -511,13 +513,6 @@ export interface CheckTransferCreateParams {
    * on the check.
    */
   source_account_number_id?: string;
-
-  /**
-   * A unique identifier you choose for the transfer. Reusing this identifier for
-   * another transfer will result in an error. You can query for the transfer
-   * associated with this identifier using the List endpoint.
-   */
-  unique_identifier?: string;
 }
 
 export namespace CheckTransferCreateParams {
@@ -638,9 +633,12 @@ export interface CheckTransferListParams extends PageParams {
   created_at?: CheckTransferListParams.CreatedAt;
 
   /**
-   * Filter records to the one with the specified `unique_identifier`.
+   * 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).
    */
-  unique_identifier?: string;
+  idempotency_key?: string;
 }
 
 export namespace CheckTransferListParams {

package/src/resources/declined-transactions.ts

@@ -713,6 +713,9 @@ export namespace DeclinedTransaction {
        *   Increase.
        * - `no_account_number_found` - The account number on the check does not exist at
        *   Increase.
+       * - `refer_to_image` - The check is not readable. Please refer to the image.
+       * - `unable_to_process` - The check cannot be processed. This is rare: please
+       *   contact support.
        */
       reason:
         | 'ach_route_disabled'
@@ -726,7 +729,9 @@ export namespace DeclinedTransaction {
         | 'not_authorized'
         | 'amount_mismatch'
         | 'not_our_item'
-        | 'no_account_number_found';
+        | 'no_account_number_found'
+        | 'refer_to_image'
+        | 'unable_to_process';
     }
 
     /**