increase 0.3.0 → 0.5.0

package/resources/simulations/wire-transfers.ts

@@ -2,6 +2,7 @@
 
 import * as Core from '~/core';
 import { APIResource } from '~/resource';
+import * as API from './';
 
 export class WireTransfers extends APIResource {
   /**
@@ -40,6 +41,11 @@ export namespace WireTransferSimulation {
    * `category: inbound_wire_transfer`.
    */
   export interface Transaction {
+    /**
+     * The Transaction identifier.
+     */
+    id: string;
+
     /**
      * The identifier for the Account the Transaction belongs to.
      */
@@ -71,11 +77,6 @@ export namespace WireTransferSimulation {
      */
     description: string;
 
-    /**
-     * The Transaction identifier.
-     */
-    id: string;
-
     /**
      * The identifier for the route this Transaction came through. Routes are things
      * like cards and ACH details.
@@ -116,18 +117,6 @@ export namespace WireTransferSimulation {
        */
       account_transfer_intention: Source.AccountTransferIntention | null;
 
-      /**
-       * A ACH Check Conversion object. This field will be present in the JSON response
-       * if and only if `category` is equal to `ach_check_conversion`.
-       */
-      ach_check_conversion: Source.ACHCheckConversion | null;
-
-      /**
-       * A ACH Check Conversion Return object. This field will be present in the JSON
-       * response if and only if `category` is equal to `ach_check_conversion_return`.
-       */
-      ach_check_conversion_return: Source.ACHCheckConversionReturn | null;
-
       /**
        * A ACH Transfer Intention object. This field will be present in the JSON response
        * if and only if `category` is equal to `ach_transfer_intention`.
@@ -164,18 +153,6 @@ export namespace WireTransferSimulation {
        */
       card_revenue_payment: Source.CardRevenuePayment | null;
 
-      /**
-       * A Deprecated Card Refund object. This field will be present in the JSON response
-       * if and only if `category` is equal to `card_route_refund`.
-       */
-      card_route_refund: Source.CardRouteRefund | null;
-
-      /**
-       * A Deprecated Card Settlement object. This field will be present in the JSON
-       * response if and only if `category` is equal to `card_route_settlement`.
-       */
-      card_route_settlement: Source.CardRouteSettlement | null;
-
       /**
        * A Card Settlement object. This field will be present in the JSON response if and
        * only if `category` is equal to `card_settlement`.
@@ -189,42 +166,34 @@ export namespace WireTransferSimulation {
        */
       category:
         | 'account_transfer_intention'
-        | 'ach_check_conversion_return'
-        | 'ach_check_conversion'
         | 'ach_transfer_intention'
         | 'ach_transfer_rejection'
         | 'ach_transfer_return'
         | 'card_dispute_acceptance'
         | 'card_refund'
-        | 'card_settlement'
         | 'card_revenue_payment'
+        | 'card_settlement'
         | 'check_deposit_acceptance'
         | 'check_deposit_return'
+        | 'check_transfer_deposit'
         | 'check_transfer_intention'
-        | 'check_transfer_return'
         | 'check_transfer_rejection'
+        | 'check_transfer_return'
         | 'check_transfer_stop_payment_request'
-        | 'dispute_resolution'
-        | 'empyreal_cash_deposit'
         | 'fee_payment'
         | 'inbound_ach_transfer'
         | 'inbound_ach_transfer_return_intention'
         | 'inbound_check'
         | 'inbound_international_ach_transfer'
         | 'inbound_real_time_payments_transfer_confirmation'
-        | 'inbound_wire_drawdown_payment_reversal'
         | 'inbound_wire_drawdown_payment'
+        | 'inbound_wire_drawdown_payment_reversal'
         | 'inbound_wire_reversal'
         | 'inbound_wire_transfer'
         | 'interest_payment'
-        | 'internal_general_ledger_transaction'
         | 'internal_source'
-        | 'card_route_refund'
-        | 'card_route_settlement'
         | 'real_time_payments_transfer_acknowledgement'
         | 'sample_funds'
-        | 'wire_drawdown_payment_intention'
-        | 'wire_drawdown_payment_rejection'
         | 'wire_transfer_intention'
         | 'wire_transfer_rejection'
         | 'other';
@@ -241,6 +210,12 @@ export namespace WireTransferSimulation {
        */
       check_deposit_return: Source.CheckDepositReturn | null;
 
+      /**
+       * A Check Transfer Deposit object. This field will be present in the JSON response
+       * if and only if `category` is equal to `check_transfer_deposit`.
+       */
+      check_transfer_deposit: Source.CheckTransferDeposit | null;
+
       /**
        * A Check Transfer Intention object. This field will be present in the JSON
        * response if and only if `category` is equal to `check_transfer_intention`.
@@ -266,18 +241,6 @@ export namespace WireTransferSimulation {
        */
       check_transfer_stop_payment_request: Source.CheckTransferStopPaymentRequest | null;
 
-      /**
-       * A Dispute Resolution object. This field will be present in the JSON response if
-       * and only if `category` is equal to `dispute_resolution`.
-       */
-      dispute_resolution: Source.DisputeResolution | null;
-
-      /**
-       * A Empyreal Cash Deposit object. This field will be present in the JSON response
-       * if and only if `category` is equal to `empyreal_cash_deposit`.
-       */
-      empyreal_cash_deposit: Source.EmpyrealCashDeposit | null;
-
       /**
        * A Fee Payment object. This field will be present in the JSON response if and
        * only if `category` is equal to `fee_payment`.
@@ -360,20 +323,6 @@ export namespace WireTransferSimulation {
        */
       sample_funds: Source.SampleFunds | null;
 
-      /**
-       * A Wire Drawdown Payment Intention object. This field will be present in the JSON
-       * response if and only if `category` is equal to
-       * `wire_drawdown_payment_intention`.
-       */
-      wire_drawdown_payment_intention: Source.WireDrawdownPaymentIntention | null;
-
-      /**
-       * A Wire Drawdown Payment Rejection object. This field will be present in the JSON
-       * response if and only if `category` is equal to
-       * `wire_drawdown_payment_rejection`.
-       */
-      wire_drawdown_payment_rejection: Source.WireDrawdownPaymentRejection | null;
-
       /**
        * A Wire Transfer Intention object. This field will be present in the JSON
        * response if and only if `category` is equal to `wire_transfer_intention`.
@@ -426,40 +375,6 @@ export namespace WireTransferSimulation {
         transfer_id: string;
       }
 
-      /**
-       * A ACH Check Conversion Return object. This field will be present in the JSON
-       * response if and only if `category` is equal to `ach_check_conversion_return`.
-       */
-      export interface ACHCheckConversionReturn {
-        /**
-         * The amount in the minor unit of the transaction's currency. For dollars, for
-         * example, this is cents.
-         */
-        amount: number;
-
-        /**
-         * Why the transfer was returned.
-         */
-        return_reason_code: string;
-      }
-
-      /**
-       * A ACH Check Conversion object. This field will be present in the JSON response
-       * if and only if `category` is equal to `ach_check_conversion`.
-       */
-      export interface ACHCheckConversion {
-        /**
-         * The amount in the minor unit of the transaction's currency. For dollars, for
-         * example, this is cents.
-         */
-        amount: number;
-
-        /**
-         * The identifier of the File containing an image of the returned check.
-         */
-        file_id: string;
-      }
-
       /**
        * A ACH Transfer Intention object. This field will be present in the JSON response
        * if and only if `category` is equal to `ach_transfer_intention`.
@@ -505,6 +420,11 @@ export namespace WireTransferSimulation {
          */
         created_at: string;
 
+        /**
+         * The three character ACH return code, in the range R01 to R85.
+         */
+        raw_return_reason_code: string;
+
         /**
          * Why the ACH Transfer was returned.
          */
@@ -528,10 +448,57 @@ export namespace WireTransferSimulation {
           | 'file_record_edit_criteria'
           | 'enr_invalid_individual_name'
           | 'returned_per_odfi_request'
-          | 'addenda_error'
           | 'limited_participation_dfi'
           | 'incorrectly_coded_outbound_international_payment'
-          | 'other';
+          | 'account_sold_to_another_dfi'
+          | 'addenda_error'
+          | 'beneficiary_or_account_holder_deceased'
+          | 'customer_advised_not_within_authorization_terms'
+          | 'corrected_return'
+          | 'duplicate_entry'
+          | 'duplicate_return'
+          | 'enr_duplicate_enrollment'
+          | 'enr_invalid_dfi_account_number'
+          | 'enr_invalid_individual_id_number'
+          | 'enr_invalid_representative_payee_indicator'
+          | 'enr_invalid_transaction_code'
+          | 'enr_return_of_enr_entry'
+          | 'enr_routing_number_check_digit_error'
+          | 'entry_not_processed_by_gateway'
+          | 'field_error'
+          | 'foreign_receiving_dfi_unable_to_settle'
+          | 'iat_entry_coding_error'
+          | 'improper_effective_entry_date'
+          | 'improper_source_document_source_document_presented'
+          | 'invalid_company_id'
+          | 'invalid_foreign_receiving_dfi_identification'
+          | 'invalid_individual_id_number'
+          | 'item_and_rck_entry_presented_for_payment'
+          | 'item_related_to_rck_entry_is_ineligible'
+          | 'mandatory_field_error'
+          | 'misrouted_dishonored_return'
+          | 'misrouted_return'
+          | 'no_errors_found'
+          | 'non_acceptance_of_r62_dishonored_return'
+          | 'non_participant_in_iat_program'
+          | 'permissible_return_entry'
+          | 'permissible_return_entry_not_accepted'
+          | 'rdfi_non_settlement'
+          | 'rdfi_participant_in_check_truncation_program'
+          | 'representative_payee_deceased_or_unable_to_continue_in_that_capacity'
+          | 'return_not_a_duplicate'
+          | 'return_of_erroneous_or_reversing_debit'
+          | 'return_of_improper_credit_entry'
+          | 'return_of_improper_debit_entry'
+          | 'return_of_xck_entry'
+          | 'source_document_presented_for_payment'
+          | 'state_law_affecting_rck_acceptance'
+          | 'stop_payment_on_item_related_to_rck_entry'
+          | 'stop_payment_on_source_document'
+          | 'timely_original_return'
+          | 'trace_number_error'
+          | 'untimely_dishonored_return'
+          | 'untimely_return';
 
         /**
          * The identifier of the Tranasaction associated with this return.
@@ -572,6 +539,11 @@ export namespace WireTransferSimulation {
        * only if `category` is equal to `card_refund`.
        */
       export interface CardRefund {
+        /**
+         * The Card Refund identifier.
+         */
+        id: string;
+
         /**
          * The pending amount in the minor unit of the transaction's currency. For dollars,
          * for example, this is cents.
@@ -584,11 +556,6 @@ export namespace WireTransferSimulation {
          */
         currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
 
-        /**
-         * The Card Refund identifier.
-         */
-        id: string;
-
         /**
          * The merchant identifier (commonly abbreviated as MID) of the merchant the card
          * is transacting with.
@@ -627,11 +594,49 @@ export namespace WireTransferSimulation {
         type: 'card_refund';
       }
 
+      /**
+       * A Card Revenue Payment object. This field will be present in the JSON response
+       * if and only if `category` is equal to `card_revenue_payment`.
+       */
+      export interface CardRevenuePayment {
+        /**
+         * The amount in the minor unit of the transaction's currency. For dollars, for
+         * example, this is cents.
+         */
+        amount: number;
+
+        /**
+         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
+         * currency.
+         */
+        currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+
+        /**
+         * The end of the period for which this transaction paid interest.
+         */
+        period_end: string;
+
+        /**
+         * The start of the period for which this transaction paid interest.
+         */
+        period_start: string;
+
+        /**
+         * The account the card belonged to.
+         */
+        transacted_on_account_id: string | null;
+      }
+
       /**
        * A Card Settlement object. This field will be present in the JSON response if and
        * only if `category` is equal to `card_settlement`.
        */
       export interface CardSettlement {
+        /**
+         * The Card Settlement identifier.
+         */
+        id: string;
+
         /**
          * The amount in the minor unit of the transaction's settlement currency. For
          * dollars, for example, this is cents.
@@ -650,11 +655,6 @@ export namespace WireTransferSimulation {
          */
         currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
 
-        /**
-         * The Card Settlement identifier.
-         */
-        id: string;
-
         /**
          * The merchant identifier (commonly abbreviated as MID) of the merchant the card
          * is transacting with.
@@ -709,39 +709,6 @@ export namespace WireTransferSimulation {
         type: 'card_settlement';
       }
 
-      /**
-       * A Card Revenue Payment object. This field will be present in the JSON response
-       * if and only if `category` is equal to `card_revenue_payment`.
-       */
-      export interface CardRevenuePayment {
-        /**
-         * The amount in the minor unit of the transaction's currency. For dollars, for
-         * example, this is cents.
-         */
-        amount: number;
-
-        /**
-         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
-         * currency.
-         */
-        currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
-
-        /**
-         * The end of the period for which this transaction paid interest.
-         */
-        period_end: string;
-
-        /**
-         * The start of the period for which this transaction paid interest.
-         */
-        period_start: string;
-
-        /**
-         * The account the card belonged to.
-         */
-        transacted_on_account_id: string | null;
-      }
-
       /**
        * A Check Deposit Acceptance object. This field will be present in the JSON
        * response if and only if `category` is equal to `check_deposit_acceptance`.
@@ -820,7 +787,8 @@ export namespace WireTransferSimulation {
           | 'stop_payment'
           | 'unknown_reason'
           | 'unmatched_details'
-          | 'unreadable_image';
+          | 'unreadable_image'
+          | 'endorsement_irregular';
 
         /**
          * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -835,6 +803,35 @@ export namespace WireTransferSimulation {
         transaction_id: string;
       }
 
+      /**
+       * A Check Transfer Deposit object. This field will be present in the JSON response
+       * if and only if `category` is equal to `check_transfer_deposit`.
+       */
+      export interface CheckTransferDeposit {
+        /**
+         * The identifier of the API File object containing an image of the back of the
+         * deposited check.
+         */
+        back_image_file_id: string | null;
+
+        /**
+         * When the check was deposited.
+         */
+        deposited_at: string;
+
+        /**
+         * The identifier of the API File object containing an image of the front of the
+         * deposited check.
+         */
+        front_image_file_id: string | null;
+
+        /**
+         * A constant representing the object's type. For this resource it will always be
+         * `check_transfer_deposit`.
+         */
+        type: 'check_transfer_deposit';
+      }
+
       /**
        * A Check Transfer Intention object. This field will be present in the JSON
        * response if and only if `category` is equal to `check_transfer_intention`.
@@ -843,12 +840,12 @@ export namespace WireTransferSimulation {
         /**
          * The city of the check's destination.
          */
-        address_city: string;
+        address_city: string | null;
 
         /**
          * The street address of the check's destination.
          */
-        address_line1: string;
+        address_line1: string | null;
 
         /**
          * The second line of the address of the check's destination.
@@ -858,12 +855,12 @@ export namespace WireTransferSimulation {
         /**
          * The state of the check's destination.
          */
-        address_state: string;
+        address_state: string | null;
 
         /**
          * The postal code of the check's destination.
          */
-        address_zip: string;
+        address_zip: string | null;
 
         /**
          * The transfer amount in USD cents.
@@ -879,7 +876,7 @@ export namespace WireTransferSimulation {
         /**
          * The name that will be printed on the check.
          */
-        recipient_name: string;
+        recipient_name: string | null;
 
         /**
          * The identifier of the Check Transfer with which this is associated.
@@ -887,6 +884,17 @@ export namespace WireTransferSimulation {
         transfer_id: string;
       }
 
+      /**
+       * A Check Transfer Rejection object. This field will be present in the JSON
+       * response if and only if `category` is equal to `check_transfer_rejection`.
+       */
+      export interface CheckTransferRejection {
+        /**
+         * The identifier of the Check Transfer that led to this Transaction.
+         */
+        transfer_id: string;
+      }
+
       /**
        * A Check Transfer Return object. This field will be present in the JSON response
        * if and only if `category` is equal to `check_transfer_return`.
@@ -920,17 +928,6 @@ export namespace WireTransferSimulation {
         transfer_id: string;
       }
 
-      /**
-       * A Check Transfer Rejection object. This field will be present in the JSON
-       * response if and only if `category` is equal to `check_transfer_rejection`.
-       */
-      export interface CheckTransferRejection {
-        /**
-         * The identifier of the Check Transfer that led to this Transaction.
-         */
-        transfer_id: string;
-      }
-
       /**
        * A Check Transfer Stop Payment Request object. This field will be present in the
        * JSON response if and only if `category` is equal to
@@ -959,45 +956,6 @@ export namespace WireTransferSimulation {
         type: 'check_transfer_stop_payment_request';
       }
 
-      /**
-       * A Dispute Resolution object. This field will be present in the JSON response if
-       * and only if `category` is equal to `dispute_resolution`.
-       */
-      export interface DisputeResolution {
-        /**
-         * The amount in the minor unit of the transaction's currency. For dollars, for
-         * example, this is cents.
-         */
-        amount: number;
-
-        /**
-         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
-         * transaction's currency.
-         */
-        currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
-
-        /**
-         * The identifier of the Transaction that was disputed.
-         */
-        disputed_transaction_id: string;
-      }
-
-      /**
-       * A Empyreal Cash Deposit object. This field will be present in the JSON response
-       * if and only if `category` is equal to `empyreal_cash_deposit`.
-       */
-      export interface EmpyrealCashDeposit {
-        /**
-         * The amount in the minor unit of the transaction's currency. For dollars, for
-         * example, this is cents.
-         */
-        amount: number;
-
-        bag_id: string;
-
-        deposit_date: string;
-      }
-
       /**
        * A Fee Payment object. This field will be present in the JSON response if and
        * only if `category` is equal to `fee_payment`.
@@ -1200,6 +1158,42 @@ export namespace WireTransferSimulation {
         transaction_identification: string;
       }
 
+      /**
+       * A Inbound Wire Drawdown Payment object. This field will be present in the JSON
+       * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
+       */
+      export interface InboundWireDrawdownPayment {
+        /**
+         * The amount in the minor unit of the transaction's currency. For dollars, for
+         * example, this is cents.
+         */
+        amount: number;
+
+        beneficiary_address_line1: string | null;
+
+        beneficiary_address_line2: string | null;
+
+        beneficiary_address_line3: string | null;
+
+        beneficiary_name: string | null;
+
+        beneficiary_reference: string | null;
+
+        description: string;
+
+        input_message_accountability_data: string | null;
+
+        originator_address_line1: string | null;
+
+        originator_address_line2: string | null;
+
+        originator_address_line3: string | null;
+
+        originator_name: string | null;
+
+        originator_to_beneficiary_information: string | null;
+      }
+
       /**
        * A Inbound Wire Drawdown Payment Reversal object. This field will be present in
        * the JSON response if and only if `category` is equal to
@@ -1257,42 +1251,6 @@ export namespace WireTransferSimulation {
         previous_message_input_source: string;
       }
 
-      /**
-       * A Inbound Wire Drawdown Payment object. This field will be present in the JSON
-       * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
-       */
-      export interface InboundWireDrawdownPayment {
-        /**
-         * The amount in the minor unit of the transaction's currency. For dollars, for
-         * example, this is cents.
-         */
-        amount: number;
-
-        beneficiary_address_line1: string | null;
-
-        beneficiary_address_line2: string | null;
-
-        beneficiary_address_line3: string | null;
-
-        beneficiary_name: string | null;
-
-        beneficiary_reference: string | null;
-
-        description: string;
-
-        input_message_accountability_data: string | null;
-
-        originator_address_line1: string | null;
-
-        originator_address_line2: string | null;
-
-        originator_address_line3: string | null;
-
-        originator_name: string | null;
-
-        originator_to_beneficiary_information: string | null;
-      }
-
       /**
        * A Inbound Wire Reversal object. This field will be present in the JSON response
        * if and only if `category` is equal to `inbound_wire_reversal`.
@@ -1471,6 +1429,7 @@ export namespace WireTransferSimulation {
         currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
 
         reason:
+          | 'account_closure'
           | 'bank_migration'
           | 'cashback'
           | 'collection_receivable'
@@ -1484,66 +1443,6 @@ export namespace WireTransferSimulation {
           | 'sample_funds_return';
       }
 
-      /**
-       * A Deprecated Card Refund object. This field will be present in the JSON response
-       * if and only if `category` is equal to `card_route_refund`.
-       */
-      export interface CardRouteRefund {
-        /**
-         * The refunded amount in the minor unit of the refunded currency. For dollars, for
-         * example, this is cents.
-         */
-        amount: number;
-
-        /**
-         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the refund
-         * currency.
-         */
-        currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
-
-        merchant_acceptor_id: string;
-
-        merchant_category_code: string | null;
-
-        merchant_city: string | null;
-
-        merchant_country: string;
-
-        merchant_descriptor: string;
-
-        merchant_state: string | null;
-      }
-
-      /**
-       * A Deprecated Card Settlement object. This field will be present in the JSON
-       * response if and only if `category` is equal to `card_route_settlement`.
-       */
-      export interface CardRouteSettlement {
-        /**
-         * The settled amount in the minor unit of the settlement currency. For dollars,
-         * for example, this is cents.
-         */
-        amount: number;
-
-        /**
-         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the settlement
-         * currency.
-         */
-        currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
-
-        merchant_acceptor_id: string;
-
-        merchant_category_code: string | null;
-
-        merchant_city: string | null;
-
-        merchant_country: string | null;
-
-        merchant_descriptor: string;
-
-        merchant_state: string | null;
-      }
-
       /**
        * A Real Time Payments Transfer Acknowledgement object. This field will be present
        * in the JSON response if and only if `category` is equal to
@@ -1587,35 +1486,6 @@ export namespace WireTransferSimulation {
         originator: string;
       }
 
-      /**
-       * A Wire Drawdown Payment Intention object. This field will be present in the JSON
-       * response if and only if `category` is equal to
-       * `wire_drawdown_payment_intention`.
-       */
-      export interface WireDrawdownPaymentIntention {
-        account_number: string;
-
-        /**
-         * The transfer amount in USD cents.
-         */
-        amount: number;
-
-        message_to_recipient: string;
-
-        routing_number: string;
-
-        transfer_id: string;
-      }
-
-      /**
-       * A Wire Drawdown Payment Rejection object. This field will be present in the JSON
-       * response if and only if `category` is equal to
-       * `wire_drawdown_payment_rejection`.
-       */
-      export interface WireDrawdownPaymentRejection {
-        transfer_id: string;
-      }
-
       /**
        * A Wire Transfer Intention object. This field will be present in the JSON
        * response if and only if `category` is equal to `wire_transfer_intention`.
@@ -1744,3 +1614,8 @@ export interface WireTransferCreateInboundParams {
    */
   originator_to_beneficiary_information_line4?: string;
 }
+
+export namespace WireTransfers {
+  export import WireTransferSimulation = API.WireTransferSimulation;
+  export import WireTransferCreateInboundParams = API.WireTransferCreateInboundParams;
+}