increase 0.10.1 → 0.10.3

package/src/resources/simulations/cards.ts

@@ -3,7 +3,6 @@
 import * as Core from '../../core';
 import { APIResource } from '../../resource';
 import * as Transactions from '../transactions';
-import * as Shared from '../shared';
 import * as API from './index';
 
 export class Cards extends APIResource {
@@ -88,14 +87,14 @@ export namespace CardAuthorizationSimulation {
 
     /**
      * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
-     * Transaction occured.
+     * Transaction occurred.
      */
     created_at: string;
 
     /**
      * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined
      * Transaction's currency. This will match the currency on the Declined
-     * Transcation's Account.
+     * Transaction's Account.
      *
      * - `CAD` - Canadian Dollar (CAD)
      * - `CHF` - Swiss Franc (CHF)
@@ -171,7 +170,7 @@ export namespace CardAuthorizationSimulation {
        *   object.
        * - `check_decline` - Check Decline: details will be under the `check_decline`
        *   object.
-       * - `inbound_real_time_payments_transfer_decline` - Inbound Real Time Payments
+       * - `inbound_real_time_payments_transfer_decline` - Inbound Real-Time Payments
        *   Transfer Decline: details will be under the
        *   `inbound_real_time_payments_transfer_decline` object.
        * - `international_ach_decline` - International ACH Decline: details will be under
@@ -197,7 +196,7 @@ export namespace CardAuthorizationSimulation {
       check_decline: Source.CheckDecline | null;
 
       /**
-       * An Inbound Real Time Payments Transfer Decline object. This field will be
+       * An Inbound Real-Time Payments Transfer Decline object. This field will be
        * present in the JSON response if and only if `category` is equal to
        * `inbound_real_time_payments_transfer_decline`.
        */
@@ -222,18 +221,35 @@ export namespace CardAuthorizationSimulation {
        * only if `category` is equal to `ach_decline`.
        */
       export interface ACHDecline {
+        /**
+         * The ACH Decline's identifier.
+         */
+        id: string;
+
         /**
          * The declined amount in the minor unit of the destination account currency. For
          * dollars, for example, this is cents.
          */
         amount: number;
 
+        /**
+         * The descriptive date of the transfer.
+         */
         originator_company_descriptive_date: string | null;
 
+        /**
+         * The additional information included with the transfer.
+         */
         originator_company_discretionary_data: string | null;
 
+        /**
+         * The identifier of the company that initiated the transfer.
+         */
         originator_company_id: string;
 
+        /**
+         * The name of the company that initiated the transfer.
+         */
         originator_company_name: string;
 
         /**
@@ -253,6 +269,7 @@ export namespace CardAuthorizationSimulation {
          * - `originator_request` - Other.
          * - `transaction_not_allowed` - The transaction is not allowed per Increase's
          *   terms.
+         * - `user_initiated` - The user initiated the decline.
          */
         reason:
           | 'ach_route_canceled'
@@ -267,13 +284,29 @@ export namespace CardAuthorizationSimulation {
           | 'return_of_erroneous_or_reversing_debit'
           | 'no_ach_route'
           | 'originator_request'
-          | 'transaction_not_allowed';
+          | 'transaction_not_allowed'
+          | 'user_initiated';
 
+        /**
+         * The id of the receiver of the transfer.
+         */
         receiver_id_number: string | null;
 
+        /**
+         * The name of the receiver of the transfer.
+         */
         receiver_name: string | null;
 
+        /**
+         * The trace number of the transfer.
+         */
         trace_number: string;
+
+        /**
+         * A constant representing the object's type. For this resource it will always be
+         * `ach_decline`.
+         */
+        type: 'ach_decline';
       }
 
       /**
@@ -301,8 +334,8 @@ export namespace CardAuthorizationSimulation {
         currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
 
         /**
-         * If the authorization was attempted using a Digital Wallet Token (such as an
-         * Apple Pay purchase), the identifier of the token that was used.
+         * If the authorization was made via a Digital Wallet Token (such as an Apple Pay
+         * purchase), the identifier of the token that was used.
          */
         digital_wallet_token_id: string | null;
 
@@ -359,6 +392,7 @@ export namespace CardAuthorizationSimulation {
          * Why the transaction was declined.
          *
          * - `card_not_active` - The Card was not active.
+         * - `physical_card_not_active` - The Physical Card was not active.
          * - `entity_not_active` - The account's entity was not active.
          * - `group_locked` - The account was inactive.
          * - `insufficient_funds` - The Card's Account did not have a sufficient available
@@ -366,8 +400,6 @@ export namespace CardAuthorizationSimulation {
          * - `cvv2_mismatch` - The given CVV2 did not match the card's value.
          * - `transaction_not_allowed` - The attempted card transaction is not allowed per
          *   Increase's terms.
-         * - `breaches_internal_limit` - The transaction was blocked by an internal limit
-         *   for new Increase accounts.
          * - `breaches_limit` - The transaction was blocked by a Limit.
          * - `webhook_declined` - Your application declined the transaction via webhook.
          * - `webhook_timed_out` - Your application webhook did not respond without the
@@ -377,21 +409,24 @@ export namespace CardAuthorizationSimulation {
          *   authorization request cryptogram.
          * - `missing_original_authorization` - The original card authorization for this
          *   incremental authorization does not exist.
+         * - `suspected_fraud` - The transaction was suspected to be fraudulent. Please
+         *   reach out to support@increase.com for more information.
          */
         reason:
           | 'card_not_active'
+          | 'physical_card_not_active'
           | 'entity_not_active'
           | 'group_locked'
           | 'insufficient_funds'
           | 'cvv2_mismatch'
           | 'transaction_not_allowed'
-          | 'breaches_internal_limit'
           | 'breaches_limit'
           | 'webhook_declined'
           | 'webhook_timed_out'
           | 'declined_by_stand_in_processing'
           | 'invalid_physical_card'
-          | 'missing_original_authorization';
+          | 'missing_original_authorization'
+          | 'suspected_fraud';
       }
 
       export namespace CardDecline {
@@ -466,8 +501,33 @@ export namespace CardAuthorizationSimulation {
             /**
              * The method used to enter the cardholder's primary account number and card
              * expiration date
+             *
+             * - `unknown` - Unknown
+             * - `manual` - Manual key entry
+             * - `magnetic_stripe_no_cvv` - Magnetic stripe read, without card verification
+             *   value
+             * - `optical_code` - Optical code
+             * - `integrated_circuit_card` - Contact chip card
+             * - `contactless` - Contactless read of chip card
+             * - `credential_on_file` - Transaction initiated using a credential that has
+             *   previously been stored on file
+             * - `magnetic_stripe` - Magnetic stripe read
+             * - `contactless_magnetic_stripe` - Contactless read of magnetic stripe data
+             * - `integrated_circuit_card_no_cvv` - Contact chip card, without card
+             *   verification value
              */
-            point_of_service_entry_mode: Shared.PointOfServiceEntryMode | null;
+            point_of_service_entry_mode:
+              | 'unknown'
+              | 'manual'
+              | 'magnetic_stripe_no_cvv'
+              | 'optical_code'
+              | 'integrated_circuit_card'
+              | 'contactless'
+              | 'credential_on_file'
+              | 'magnetic_stripe'
+              | 'contactless_magnetic_stripe'
+              | 'integrated_circuit_card_no_cvv'
+              | null;
           }
         }
       }
@@ -523,7 +583,7 @@ export namespace CardAuthorizationSimulation {
       }
 
       /**
-       * An Inbound Real Time Payments Transfer Decline object. This field will be
+       * An Inbound Real-Time Payments Transfer Decline object. This field will be
        * present in the JSON response if and only if `category` is equal to
        * `inbound_real_time_payments_transfer_decline`.
        */
@@ -541,7 +601,7 @@ export namespace CardAuthorizationSimulation {
 
         /**
          * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined
-         * transfer's currency. This will always be "USD" for a Real Time Payments
+         * transfer's currency. This will always be "USD" for a Real-Time Payments
          * transfer.
          *
          * - `CAD` - Canadian Dollar (CAD)
@@ -576,8 +636,8 @@ export namespace CardAuthorizationSimulation {
          * - `account_restricted` - Your account is restricted.
          * - `group_locked` - Your account is inactive.
          * - `entity_not_active` - The account's entity is not active.
-         * - `real_time_payments_not_enabled` - Your account is not enabled to receive Real
-         *   Time Payments transfers.
+         * - `real_time_payments_not_enabled` - Your account is not enabled to receive
+         *   Real-Time Payments transfers.
          */
         reason:
           | 'account_number_canceled'
@@ -593,7 +653,7 @@ export namespace CardAuthorizationSimulation {
         remittance_information: string | null;
 
         /**
-         * The Real Time Payments network identification of the declined transfer.
+         * The Real-Time Payments network identification of the declined transfer.
          */
         transaction_identification: string;
       }
@@ -773,14 +833,14 @@ export namespace CardAuthorizationSimulation {
 
     /**
      * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
-     * Transaction occured.
+     * Transaction occurred.
      */
     created_at: string;
 
     /**
      * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Pending
      * Transaction's currency. This will match the currency on the Pending
-     * Transcation's Account.
+     * Transaction's Account.
      *
      * - `CAD` - Canadian Dollar (CAD)
      * - `CHF` - Swiss Franc (CHF)
@@ -878,7 +938,7 @@ export namespace CardAuthorizationSimulation {
        *   under the `check_transfer_instruction` object.
        * - `inbound_funds_hold` - Inbound Funds Hold: details will be under the
        *   `inbound_funds_hold` object.
-       * - `real_time_payments_transfer_instruction` - Real Time Payments Transfer
+       * - `real_time_payments_transfer_instruction` - Real-Time Payments Transfer
        *   Instruction: details will be under the
        *   `real_time_payments_transfer_instruction` object.
        * - `wire_transfer_instruction` - Wire Transfer Instruction: details will be under
@@ -916,7 +976,7 @@ export namespace CardAuthorizationSimulation {
       inbound_funds_hold: Source.InboundFundsHold | null;
 
       /**
-       * A Real Time Payments Transfer Instruction object. This field will be present in
+       * A Real-Time Payments Transfer Instruction object. This field will be present in
        * the JSON response if and only if `category` is equal to
        * `real_time_payments_transfer_instruction`.
        */
@@ -1146,8 +1206,33 @@ export namespace CardAuthorizationSimulation {
             /**
              * The method used to enter the cardholder's primary account number and card
              * expiration date
+             *
+             * - `unknown` - Unknown
+             * - `manual` - Manual key entry
+             * - `magnetic_stripe_no_cvv` - Magnetic stripe read, without card verification
+             *   value
+             * - `optical_code` - Optical code
+             * - `integrated_circuit_card` - Contact chip card
+             * - `contactless` - Contactless read of chip card
+             * - `credential_on_file` - Transaction initiated using a credential that has
+             *   previously been stored on file
+             * - `magnetic_stripe` - Magnetic stripe read
+             * - `contactless_magnetic_stripe` - Contactless read of magnetic stripe data
+             * - `integrated_circuit_card_no_cvv` - Contact chip card, without card
+             *   verification value
              */
-            point_of_service_entry_mode: Shared.PointOfServiceEntryMode | null;
+            point_of_service_entry_mode:
+              | 'unknown'
+              | 'manual'
+              | 'magnetic_stripe_no_cvv'
+              | 'optical_code'
+              | 'integrated_circuit_card'
+              | 'contactless'
+              | 'credential_on_file'
+              | 'magnetic_stripe'
+              | 'contactless_magnetic_stripe'
+              | 'integrated_circuit_card_no_cvv'
+              | null;
           }
         }
       }
@@ -1296,7 +1381,7 @@ export namespace CardAuthorizationSimulation {
       }
 
       /**
-       * A Real Time Payments Transfer Instruction object. This field will be present in
+       * A Real-Time Payments Transfer Instruction object. This field will be present in
        * the JSON response if and only if `category` is equal to
        * `real_time_payments_transfer_instruction`.
        */
@@ -1308,7 +1393,7 @@ export namespace CardAuthorizationSimulation {
         amount: number;
 
         /**
-         * The identifier of the Real Time Payments Transfer that led to this Pending
+         * The identifier of the Real-Time Payments Transfer that led to this Pending
          * Transaction.
          */
         transfer_id: string;

package/src/resources/simulations/inbound-wire-drawdown-requests.ts

@@ -7,7 +7,7 @@ import * as API from './index';
 
 export class InboundWireDrawdownRequests extends APIResource {
   /**
-   * Simulates the receival of an
+   * Simulates receiving an
    * [Inbound Wire Drawdown Request](#inbound-wire-drawdown-requests).
    */
   create(

package/src/resources/simulations/interest-payments.ts

@@ -58,13 +58,13 @@ export namespace InterestPaymentSimulationResult {
 
     /**
      * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
-     * Transaction occured.
+     * Transaction occurred.
      */
     created_at: string;
 
     /**
      * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
-     * Transaction's currency. This will match the currency on the Transcation's
+     * Transaction's currency. This will match the currency on the Transaction's
      * Account.
      *
      * - `CAD` - Canadian Dollar (CAD)
@@ -207,7 +207,7 @@ export namespace InterestPaymentSimulationResult {
        *   object.
        * - `inbound_international_ach_transfer` - Inbound International ACH Transfer:
        *   details will be under the `inbound_international_ach_transfer` object.
-       * - `inbound_real_time_payments_transfer_confirmation` - Inbound Real Time
+       * - `inbound_real_time_payments_transfer_confirmation` - Inbound Real-Time
        *   Payments Transfer Confirmation: details will be under the
        *   `inbound_real_time_payments_transfer_confirmation` object.
        * - `inbound_wire_drawdown_payment` - Inbound Wire Drawdown Payment: details will
@@ -223,7 +223,7 @@ export namespace InterestPaymentSimulationResult {
        *   `interest_payment` object.
        * - `internal_source` - Internal Source: details will be under the
        *   `internal_source` object.
-       * - `real_time_payments_transfer_acknowledgement` - Real Time Payments Transfer
+       * - `real_time_payments_transfer_acknowledgement` - Real-Time Payments Transfer
        *   Acknowledgement: details will be under the
        *   `real_time_payments_transfer_acknowledgement` object.
        * - `sample_funds` - Sample Funds: details will be under the `sample_funds`
@@ -323,7 +323,7 @@ export namespace InterestPaymentSimulationResult {
       inbound_international_ach_transfer: Source.InboundInternationalACHTransfer | null;
 
       /**
-       * An Inbound Real Time Payments Transfer Confirmation object. This field will be
+       * An Inbound Real-Time Payments Transfer Confirmation object. This field will be
        * present in the JSON response if and only if `category` is equal to
        * `inbound_real_time_payments_transfer_confirmation`.
        */
@@ -367,7 +367,7 @@ export namespace InterestPaymentSimulationResult {
       internal_source: Source.InternalSource | null;
 
       /**
-       * A Real Time Payments Transfer Acknowledgement object. This field will be present
+       * A Real-Time Payments Transfer Acknowledgement object. This field will be present
        * in the JSON response if and only if `category` is equal to
        * `real_time_payments_transfer_acknowledgement`.
        */
@@ -709,7 +709,7 @@ export namespace InterestPaymentSimulationResult {
           | 'untimely_return';
 
         /**
-         * The identifier of the Tranasaction associated with this return.
+         * The identifier of the Transaction associated with this return.
          */
         transaction_id: string;
 
@@ -1060,7 +1060,7 @@ export namespace InterestPaymentSimulationResult {
             food_beverage_charges_amount: number | null;
 
             /**
-             * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the foor and
+             * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
              * beverage charges.
              */
             food_beverage_charges_currency: string | null;
@@ -1729,7 +1729,7 @@ export namespace InterestPaymentSimulationResult {
             food_beverage_charges_amount: number | null;
 
             /**
-             * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the foor and
+             * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
              * beverage charges.
              */
             food_beverage_charges_currency: string | null;
@@ -2243,7 +2243,7 @@ export namespace InterestPaymentSimulationResult {
          * The reason why this transfer was stopped.
          *
          * - `mail_delivery_failed` - The check could not be delivered.
-         * - `rejected_by_increase` - The check was cancelled by an Increase operator who
+         * - `rejected_by_increase` - The check was canceled by an Increase operator who
          *   will provide details out-of-band.
          * - `unknown` - The check was stopped for another reason.
          */
@@ -2439,7 +2439,7 @@ export namespace InterestPaymentSimulationResult {
       }
 
       /**
-       * An Inbound Real Time Payments Transfer Confirmation object. This field will be
+       * An Inbound Real-Time Payments Transfer Confirmation object. This field will be
        * present in the JSON response if and only if `category` is equal to
        * `inbound_real_time_payments_transfer_confirmation`.
        */
@@ -2457,7 +2457,7 @@ export namespace InterestPaymentSimulationResult {
 
         /**
          * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's
-         * currency. This will always be "USD" for a Real Time Payments transfer.
+         * currency. This will always be "USD" for a Real-Time Payments transfer.
          *
          * - `CAD` - Canadian Dollar (CAD)
          * - `CHF` - Swiss Franc (CHF)
@@ -2489,7 +2489,7 @@ export namespace InterestPaymentSimulationResult {
         remittance_information: string | null;
 
         /**
-         * The Real Time Payments network identification of the transfer
+         * The Real-Time Payments network identification of the transfer
          */
         transaction_identification: string;
       }
@@ -2662,7 +2662,7 @@ export namespace InterestPaymentSimulationResult {
         /**
          * The ID for the Transaction associated with the transfer reversal.
          */
-        transaction_id: string | null;
+        transaction_id: string;
 
         /**
          * The ID for the Wire Transfer that is being reversed.
@@ -2810,7 +2810,7 @@ export namespace InterestPaymentSimulationResult {
       }
 
       /**
-       * A Real Time Payments Transfer Acknowledgement object. This field will be present
+       * A Real-Time Payments Transfer Acknowledgement object. This field will be present
        * in the JSON response if and only if `category` is equal to
        * `real_time_payments_transfer_acknowledgement`.
        */
@@ -2836,7 +2836,7 @@ export namespace InterestPaymentSimulationResult {
         remittance_information: string;
 
         /**
-         * The identifier of the Real Time Payments Transfer that led to this Transaction.
+         * The identifier of the Real-Time Payments Transfer that led to this Transaction.
          */
         transfer_id: string;
       }