increase 0.10.3 → 0.11.0

package/src/resources/card-purchase-supplements.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core';
-import { APIResource } from '../resource';
-import { isRequestOptions } from '../core';
-import * as API from './index';
-import { Page, PageParams } from '../pagination';
+import * as Core from '../core.js';
+import { APIResource } from '../resource.js';
+import { isRequestOptions } from '../core.js';
+import * as API from './index.js';
+import { Page, PageParams } from '../pagination.js';
 
 export class CardPurchaseSupplements extends APIResource {
   /**
@@ -259,7 +259,7 @@ export namespace CardPurchaseSupplement {
     sales_tax_rate: string | null;
 
     /**
-     * Total amount of all line items
+     * Total amount of all line items.
      */
     total_amount: number | null;
 
@@ -280,7 +280,7 @@ export namespace CardPurchaseSupplement {
     unit_cost_currency: string | null;
 
     /**
-     * Code indicating unit of measure (gallons, etc.)
+     * Code indicating unit of measure (gallons, etc.).
      */
     unit_of_measure_code: string | null;
   }

package/src/resources/cards.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core';
-import { APIResource } from '../resource';
-import { isRequestOptions } from '../core';
-import * as API from './index';
-import { Page, PageParams } from '../pagination';
+import * as Core from '../core.js';
+import { APIResource } from '../resource.js';
+import { isRequestOptions } from '../core.js';
+import * as API from './index.js';
+import { Page, PageParams } from '../pagination.js';
 
 export class Cards extends APIResource {
   /**

package/src/resources/check-deposits.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core';
-import { APIResource } from '../resource';
-import { isRequestOptions } from '../core';
-import * as API from './index';
-import { Page, PageParams } from '../pagination';
+import * as Core from '../core.js';
+import { APIResource } from '../resource.js';
+import { isRequestOptions } from '../core.js';
+import * as API from './index.js';
+import { Page, PageParams } from '../pagination.js';
 
 export class CheckDeposits extends APIResource {
   /**
@@ -271,6 +271,9 @@ export namespace CheckDeposit {
     currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
 
     /**
+     * Why this check was returned by the bank holding the account it was drawn
+     * against.
+     *
      * - `ach_conversion_not_supported` - The check doesn't allow ACH conversion.
      * - `closed_account` - The account is closed.
      * - `duplicate_submission` - The check has already been deposited.

package/src/resources/check-transfers.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core';
-import { APIResource } from '../resource';
-import { isRequestOptions } from '../core';
-import * as API from './index';
-import { Page, PageParams } from '../pagination';
+import * as Core from '../core.js';
+import { APIResource } from '../resource.js';
+import { isRequestOptions } from '../core.js';
+import * as API from './index.js';
+import { Page, PageParams } from '../pagination.js';
 
 export class CheckTransfers extends APIResource {
   /**
@@ -273,6 +273,13 @@ export namespace CheckTransfer {
      */
     back_image_file_id: string | null;
 
+    /**
+     * The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
+     * bank depositing this check. In some rare cases, this is not transmitted via
+     * Check21 and the value will be null.
+     */
+    bank_of_first_deposit_routing_number: string | null;
+
     /**
      * When the check was deposited.
      */

package/src/resources/declined-transactions.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core';
-import { APIResource } from '../resource';
-import { isRequestOptions } from '../core';
-import * as API from './index';
-import { Page, PageParams } from '../pagination';
+import * as Core from '../core.js';
+import { APIResource } from '../resource.js';
+import { isRequestOptions } from '../core.js';
+import * as API from './index.js';
+import { Page, PageParams } from '../pagination.js';
 
 export class DeclinedTransactions extends APIResource {
   /**
@@ -234,16 +234,22 @@ export namespace DeclinedTransaction {
        *
        * - `ach_route_canceled` - The account number is canceled.
        * - `ach_route_disabled` - The account number is disabled.
-       * - `breaches_limit` - The transaction would cause a limit to be exceeded.
-       * - `credit_entry_refused_by_receiver` - A credit was refused.
-       * - `duplicate_return` - Other.
+       * - `breaches_limit` - The transaction would cause an Increase limit to be
+       *   exceeded.
+       * - `credit_entry_refused_by_receiver` - A credit was refused. This is a
+       *   reasonable default reason for decline of credits.
+       * - `duplicate_return` - A rare return reason. The return this message refers to
+       *   was a duplicate.
        * - `entity_not_active` - The account's entity is not active.
        * - `group_locked` - Your account is inactive.
        * - `insufficient_funds` - Your account contains insufficient funds.
-       * - `misrouted_return` - Other.
-       * - `return_of_erroneous_or_reversing_debit` - Other.
+       * - `misrouted_return` - A rare return reason. The return this message refers to
+       *   was misrouted.
+       * - `return_of_erroneous_or_reversing_debit` - The originating financial
+       *   institution made a mistake and this return corrects it.
        * - `no_ach_route` - The account number that was debited does not exist.
-       * - `originator_request` - Other.
+       * - `originator_request` - The originating financial institution asked for this
+       *   transfer to be returned.
        * - `transaction_not_allowed` - The transaction is not allowed per Increase's
        *   terms.
        * - `user_initiated` - The user initiated the decline.
@@ -349,7 +355,7 @@ export namespace DeclinedTransaction {
       merchant_state: string | null;
 
       /**
-       * Fields specific to the `network`
+       * Fields specific to the `network`.
        */
       network_details: CardDecline.NetworkDetails;
 
@@ -408,25 +414,25 @@ export namespace DeclinedTransaction {
 
     export namespace CardDecline {
       /**
-       * Fields specific to the `network`
+       * Fields specific to the `network`.
        */
       export interface NetworkDetails {
         /**
-         * The payment network used to process this card authorization
+         * The payment network used to process this card authorization.
          *
          * - `visa` - Visa
          */
         category: 'visa';
 
         /**
-         * Fields specific to the `visa` network
+         * Fields specific to the `visa` network.
          */
         visa: NetworkDetails.Visa | null;
       }
 
       export namespace NetworkDetails {
         /**
-         * Fields specific to the `visa` network
+         * Fields specific to the `visa` network.
          */
         export interface Visa {
           /**
@@ -477,7 +483,7 @@ export namespace DeclinedTransaction {
 
           /**
            * The method used to enter the cardholder's primary account number and card
-           * expiration date
+           * expiration date.
            *
            * - `unknown` - Unknown
            * - `manual` - Manual key entry
@@ -520,43 +526,42 @@ export namespace DeclinedTransaction {
        */
       amount: number;
 
+      /**
+       * A computer-readable number printed on the MICR line of business checks, usually
+       * the check number. This is useful for positive pay checks, but can be unreliably
+       * transmitted by the bank of first deposit.
+       */
       auxiliary_on_us: string | null;
 
       /**
        * Why the check was declined.
        *
-       * - `ach_route_canceled` - The account number is canceled.
        * - `ach_route_disabled` - The account number is disabled.
+       * - `ach_route_canceled` - The account number is canceled.
        * - `breaches_limit` - The transaction would cause a limit to be exceeded.
        * - `entity_not_active` - The account's entity is not active.
        * - `group_locked` - Your account is inactive.
        * - `insufficient_funds` - Your account contains insufficient funds.
-       * - `unable_to_locate_account` - Unable to locate account.
-       * - `not_our_item` - Routing number on the check is not ours.
-       * - `unable_to_process` - Unable to process.
-       * - `refer_to_image` - Refer to image.
        * - `stop_payment_requested` - Stop payment requested for this check.
-       * - `returned` - Check was returned to sender.
        * - `duplicate_presentment` - The check was a duplicate deposit.
-       * - `not_authorized` - The transaction is not allowed.
-       * - `altered_or_fictitious` - The check was altered or fictitious.
+       * - `not_authorized` - The check was not authorized.
+       * - `amount_mismatch` - The amount the receiving bank is attempting to deposit
+       *   does not match the amount on the check.
+       * - `not_our_item` - The check attempting to be deposited does not belong to
+       *   Increase.
        */
       reason:
-        | 'ach_route_canceled'
         | 'ach_route_disabled'
+        | 'ach_route_canceled'
         | 'breaches_limit'
         | 'entity_not_active'
         | 'group_locked'
         | 'insufficient_funds'
-        | 'unable_to_locate_account'
-        | 'not_our_item'
-        | 'unable_to_process'
-        | 'refer_to_image'
         | 'stop_payment_requested'
-        | 'returned'
         | 'duplicate_presentment'
         | 'not_authorized'
-        | 'altered_or_fictitious';
+        | 'amount_mismatch'
+        | 'not_our_item';
     }
 
     /**
@@ -646,74 +651,279 @@ export namespace DeclinedTransaction {
        */
       amount: number;
 
+      /**
+       * The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2
+       * country code of the destination country.
+       */
       destination_country_code: string;
 
+      /**
+       * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
+       * destination bank account.
+       */
       destination_currency_code: string;
 
-      foreign_exchange_indicator: string;
+      /**
+       * A description of how the foreign exchange rate was calculated.
+       *
+       * - `fixed_to_variable` - The originator chose an amount in their own currency.
+       *   The settled amount in USD was converted using the exchange rate.
+       * - `variable_to_fixed` - The originator chose an amount to settle in USD. The
+       *   originator's amount was variable; known only after the foreign exchange
+       *   conversion.
+       * - `fixed_to_fixed` - The amount was originated and settled as a fixed amount in
+       *   USD. There is no foreign exchange conversion.
+       */
+      foreign_exchange_indicator: 'fixed_to_variable' | 'variable_to_fixed' | 'fixed_to_fixed';
 
+      /**
+       * Depending on the `foreign_exchange_reference_indicator`, an exchange rate or a
+       * reference to a well-known rate.
+       */
       foreign_exchange_reference: string | null;
 
-      foreign_exchange_reference_indicator: string;
+      /**
+       * An instruction of how to interpret the `foreign_exchange_reference` field for
+       * this Transaction.
+       *
+       * - `foreign_exchange_rate` - The ACH file contains a foreign exchange rate.
+       * - `foreign_exchange_reference_number` - The ACH file contains a reference to a
+       *   well-known foreign exchange rate.
+       * - `blank` - There is no foreign exchange for this transfer, so the
+       *   `foreign_exchange_reference` field is blank.
+       */
+      foreign_exchange_reference_indicator:
+        | 'foreign_exchange_rate'
+        | 'foreign_exchange_reference_number'
+        | 'blank';
 
+      /**
+       * The amount in the minor unit of the foreign payment currency. For dollars, for
+       * example, this is cents.
+       */
       foreign_payment_amount: number;
 
+      /**
+       * A reference number in the foreign banking infrastructure.
+       */
       foreign_trace_number: string | null;
 
-      international_transaction_type_code: string;
+      /**
+       * The type of transfer. Set by the originator.
+       *
+       * - `annuity` - Sent as `ANN` in the Nacha file.
+       * - `business_or_commercial` - Sent as `BUS` in the Nacha file.
+       * - `deposit` - Sent as `DEP` in the Nacha file.
+       * - `loan` - Sent as `LOA` in the Nacha file.
+       * - `miscellaneous` - Sent as `MIS` in the Nacha file.
+       * - `mortgage` - Sent as `MOR` in the Nacha file.
+       * - `pension` - Sent as `PEN` in the Nacha file.
+       * - `remittance` - Sent as `REM` in the Nacha file.
+       * - `rent_or_lease` - Sent as `RLS` in the Nacha file.
+       * - `salary_or_payroll` - Sent as `SAL` in the Nacha file.
+       * - `tax` - Sent as `TAX` in the Nacha file.
+       * - `accounts_receivable` - Sent as `ARC` in the Nacha file.
+       * - `back_office_conversion` - Sent as `BOC` in the Nacha file.
+       * - `machine_transfer` - Sent as `MTE` in the Nacha file.
+       * - `point_of_purchase` - Sent as `POP` in the Nacha file.
+       * - `point_of_sale` - Sent as `POS` in the Nacha file.
+       * - `represented_check` - Sent as `RCK` in the Nacha file.
+       * - `shared_network_transaction` - Sent as `SHR` in the Nacha file.
+       * - `telphone_initiated` - Sent as `TEL` in the Nacha file.
+       * - `internet_initiated` - Sent as `WEB` in the Nacha file.
+       */
+      international_transaction_type_code:
+        | 'annuity'
+        | 'business_or_commercial'
+        | 'deposit'
+        | 'loan'
+        | 'miscellaneous'
+        | 'mortgage'
+        | 'pension'
+        | 'remittance'
+        | 'rent_or_lease'
+        | 'salary_or_payroll'
+        | 'tax'
+        | 'accounts_receivable'
+        | 'back_office_conversion'
+        | 'machine_transfer'
+        | 'point_of_purchase'
+        | 'point_of_sale'
+        | 'represented_check'
+        | 'shared_network_transaction'
+        | 'telphone_initiated'
+        | 'internet_initiated';
 
+      /**
+       * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
+       * originating bank account.
+       */
       originating_currency_code: string;
 
+      /**
+       * The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2
+       * country code of the originating branch country.
+       */
       originating_depository_financial_institution_branch_country: string;
 
+      /**
+       * An identifier for the originating bank. One of an International Bank Account
+       * Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
+       * domestic identifier like a US Routing Number.
+       */
       originating_depository_financial_institution_id: string;
 
-      originating_depository_financial_institution_id_qualifier: string;
+      /**
+       * An instruction of how to interpret the
+       * `originating_depository_financial_institution_id` field for this Transaction.
+       *
+       * - `national_clearing_system_number` - A domestic clearing system number. In the
+       *   US, for example, this is the American Banking Association (ABA) routing
+       *   number.
+       * - `bic_code` - The SWIFT Bank Identifier Code (BIC) of the bank.
+       * - `iban` - An International Bank Account Number.
+       */
+      originating_depository_financial_institution_id_qualifier:
+        | 'national_clearing_system_number'
+        | 'bic_code'
+        | 'iban';
 
+      /**
+       * The name of the originating bank. Sometimes this will refer to an American bank
+       * and obscure the correspondent foreign bank.
+       */
       originating_depository_financial_institution_name: string;
 
+      /**
+       * A portion of the originator address. This may be incomplete.
+       */
       originator_city: string;
 
+      /**
+       * A description field set by the originator.
+       */
       originator_company_entry_description: string;
 
+      /**
+       * A portion of the originator address. The
+       * [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country
+       * code of the originator country.
+       */
       originator_country: string;
 
+      /**
+       * An identifier for the originating company. This is generally stable across
+       * multiple ACH transfers.
+       */
       originator_identification: string;
 
+      /**
+       * Either the name of the originator or an intermediary money transmitter.
+       */
       originator_name: string;
 
+      /**
+       * A portion of the originator address. This may be incomplete.
+       */
       originator_postal_code: string | null;
 
+      /**
+       * A portion of the originator address. This may be incomplete.
+       */
       originator_state_or_province: string | null;
 
+      /**
+       * A portion of the originator address. This may be incomplete.
+       */
       originator_street_address: string;
 
+      /**
+       * A description field set by the originator.
+       */
       payment_related_information: string | null;
 
+      /**
+       * A description field set by the originator.
+       */
       payment_related_information2: string | null;
 
+      /**
+       * A portion of the receiver address. This may be incomplete.
+       */
       receiver_city: string;
 
+      /**
+       * A portion of the receiver address. The
+       * [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country
+       * code of the receiver country.
+       */
       receiver_country: string;
 
+      /**
+       * An identification number the originator uses for the receiver.
+       */
       receiver_identification_number: string | null;
 
+      /**
+       * A portion of the receiver address. This may be incomplete.
+       */
       receiver_postal_code: string | null;
 
+      /**
+       * A portion of the receiver address. This may be incomplete.
+       */
       receiver_state_or_province: string | null;
 
+      /**
+       * A portion of the receiver address. This may be incomplete.
+       */
       receiver_street_address: string;
 
+      /**
+       * The name of the receiver of the transfer. This is not verified by Increase.
+       */
       receiving_company_or_individual_name: string;
 
+      /**
+       * The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2
+       * country code of the receiving bank country.
+       */
       receiving_depository_financial_institution_country: string;
 
+      /**
+       * An identifier for the receiving bank. One of an International Bank Account
+       * Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
+       * domestic identifier like a US Routing Number.
+       */
       receiving_depository_financial_institution_id: string;
 
-      receiving_depository_financial_institution_id_qualifier: string;
+      /**
+       * An instruction of how to interpret the
+       * `receiving_depository_financial_institution_id` field for this Transaction.
+       *
+       * - `national_clearing_system_number` - A domestic clearing system number. In the
+       *   US, for example, this is the American Banking Association (ABA) routing
+       *   number.
+       * - `bic_code` - The SWIFT Bank Identifier Code (BIC) of the bank.
+       * - `iban` - An International Bank Account Number.
+       */
+      receiving_depository_financial_institution_id_qualifier:
+        | 'national_clearing_system_number'
+        | 'bic_code'
+        | 'iban';
 
+      /**
+       * The name of the receiving bank, as set by the sending financial institution.
+       */
       receiving_depository_financial_institution_name: string;
 
+      /**
+       * A 15 digit number recorded in the Nacha file and available to both the
+       * originating and receiving bank. Along with the amount, date, and originating
+       * routing number, this can be used to identify the ACH transfer at either bank.
+       * ACH trace numbers are not unique, but are
+       * [used to correlate returns](https://increase.com/documentation/ach#returns).
+       */
       trace_number: string;
     }
 
@@ -728,34 +938,81 @@ export namespace DeclinedTransaction {
        */
       amount: number;
 
+      /**
+       * A free-form address field set by the sender.
+       */
       beneficiary_address_line1: string | null;
 
+      /**
+       * A free-form address field set by the sender.
+       */
       beneficiary_address_line2: string | null;
 
+      /**
+       * A free-form address field set by the sender.
+       */
       beneficiary_address_line3: string | null;
 
+      /**
+       * A name set by the sender.
+       */
       beneficiary_name: string | null;
 
+      /**
+       * A free-form reference string set by the sender, to help identify the transfer.
+       */
       beneficiary_reference: string | null;
 
+      /**
+       * An Increase-constructed description of the declined transaction.
+       */
       description: string;
 
+      /**
+       * A unique identifier available to the originating and receiving banks, commonly
+       * abbreviated as IMAD. It is created when the wire is submitted to the Fedwire
+       * service and is helpful when debugging wires with the originating bank.
+       */
       input_message_accountability_data: string | null;
 
+      /**
+       * The address of the wire originator, set by the sending bank.
+       */
       originator_address_line1: string | null;
 
+      /**
+       * The address of the wire originator, set by the sending bank.
+       */
       originator_address_line2: string | null;
 
+      /**
+       * The address of the wire originator, set by the sending bank.
+       */
       originator_address_line3: string | null;
 
+      /**
+       * The originator of the wire, set by the sending bank.
+       */
       originator_name: string | null;
 
+      /**
+       * A free-form message set by the wire originator.
+       */
       originator_to_beneficiary_information_line1: string | null;
 
+      /**
+       * A free-form message set by the wire originator.
+       */
       originator_to_beneficiary_information_line2: string | null;
 
+      /**
+       * A free-form message set by the wire originator.
+       */
       originator_to_beneficiary_information_line3: string | null;
 
+      /**
+       * A free-form message set by the wire originator.
+       */
       originator_to_beneficiary_information_line4: string | null;
 
       /**

package/src/resources/digital-wallet-tokens.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core';
-import { APIResource } from '../resource';
-import { isRequestOptions } from '../core';
-import * as API from './index';
-import { Page, PageParams } from '../pagination';
+import * as Core from '../core.js';
+import { APIResource } from '../resource.js';
+import { isRequestOptions } from '../core.js';
+import * as API from './index.js';
+import { Page, PageParams } from '../pagination.js';
 
 export class DigitalWalletTokens extends APIResource {
   /**
@@ -75,8 +75,9 @@ export interface DigitalWalletToken {
    *
    * - `apple_pay` - Apple Pay
    * - `google_pay` - Google Pay
+   * - `unknown` - Unknown
    */
-  token_requestor: 'apple_pay' | 'google_pay';
+  token_requestor: 'apple_pay' | 'google_pay' | 'unknown';
 
   /**
    * A constant representing the object's type. For this resource it will always be

package/src/resources/documents.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core';
-import { APIResource } from '../resource';
-import { isRequestOptions } from '../core';
-import * as API from './index';
-import { Page, PageParams } from '../pagination';
+import * as Core from '../core.js';
+import { APIResource } from '../resource.js';
+import { isRequestOptions } from '../core.js';
+import * as API from './index.js';
+import { Page, PageParams } from '../pagination.js';
 
 export class Documents extends APIResource {
   /**