increase 0.3.0 → 0.4.0

package/resources/simulations/cards.ts

@@ -167,12 +167,6 @@ export namespace CardAuthorizationSimulation {
        */
       card_authorization: Source.CardAuthorization | null;
 
-      /**
-       * A Deprecated Card Authorization object. This field will be present in the JSON
-       * response if and only if `category` is equal to `card_route_authorization`.
-       */
-      card_route_authorization: Source.CardRouteAuthorization | null;
-
       /**
        * The type of transaction that took place. We may add additional possible values
        * for this enum over time; your application should be able to handle such
@@ -185,9 +179,7 @@ export namespace CardAuthorizationSimulation {
         | 'check_deposit_instruction'
         | 'check_transfer_instruction'
         | 'inbound_funds_hold'
-        | 'card_route_authorization'
         | 'real_time_payments_transfer_instruction'
-        | 'wire_drawdown_payment_instruction'
         | 'wire_transfer_instruction'
         | 'other';
 
@@ -216,13 +208,6 @@ export namespace CardAuthorizationSimulation {
        */
       real_time_payments_transfer_instruction: Source.RealTimePaymentsTransferInstruction | null;
 
-      /**
-       * A Wire Drawdown Payment Instruction object. This field will be present in the
-       * JSON response if and only if `category` is equal to
-       * `wire_drawdown_payment_instruction`.
-       */
-      wire_drawdown_payment_instruction: Source.WireDrawdownPaymentInstruction | null;
-
       /**
        * A Wire Transfer Instruction object. This field will be present in the JSON
        * response if and only if `category` is equal to `wire_transfer_instruction`.
@@ -509,36 +494,6 @@ export namespace CardAuthorizationSimulation {
         status: 'held' | 'complete';
       }
 
-      /**
-       * A Deprecated Card Authorization object. This field will be present in the JSON
-       * response if and only if `category` is equal to `card_route_authorization`.
-       */
-      export interface CardRouteAuthorization {
-        /**
-         * The pending 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';
-
-        merchant_acceptor_id: string;
-
-        merchant_category_code: string;
-
-        merchant_city: string | null;
-
-        merchant_country: string;
-
-        merchant_descriptor: string;
-
-        merchant_state: string | null;
-      }
-
       /**
        * A Real Time Payments Transfer Instruction object. This field will be present in
        * the JSON response if and only if `category` is equal to
@@ -558,25 +513,6 @@ export namespace CardAuthorizationSimulation {
         transfer_id: string;
       }
 
-      /**
-       * A Wire Drawdown Payment Instruction object. This field will be present in the
-       * JSON response if and only if `category` is equal to
-       * `wire_drawdown_payment_instruction`.
-       */
-      export interface WireDrawdownPaymentInstruction {
-        account_number: string;
-
-        /**
-         * The pending amount in the minor unit of the transaction's currency. For dollars,
-         * for example, this is cents.
-         */
-        amount: number;
-
-        message_to_recipient: string;
-
-        routing_number: string;
-      }
-
       /**
        * A Wire Transfer Instruction object. This field will be present in the JSON
        * response if and only if `category` is equal to `wire_transfer_instruction`.
@@ -687,12 +623,6 @@ export namespace CardAuthorizationSimulation {
        */
       card_decline: Source.CardDecline | null;
 
-      /**
-       * A Deprecated Card Decline object. This field will be present in the JSON
-       * response if and only if `category` is equal to `card_route_decline`.
-       */
-      card_route_decline: Source.CardRouteDecline | null;
-
       /**
        * The type of decline that took place. We may add additional possible values for
        * this enum over time; your application should be able to handle such additions
@@ -704,7 +634,6 @@ export namespace CardAuthorizationSimulation {
         | 'check_decline'
         | 'inbound_real_time_payments_transfer_decline'
         | 'international_ach_decline'
-        | 'card_route_decline'
         | 'wire_decline'
         | 'other';
 
@@ -933,6 +862,7 @@ export namespace CardAuthorizationSimulation {
           | 'group_locked'
           | 'insufficient_funds'
           | 'unable_to_locate_account'
+          | 'not_our_item'
           | 'unable_to_process'
           | 'refer_to_image'
           | 'stop_payment_requested'
@@ -1085,36 +1015,6 @@ export namespace CardAuthorizationSimulation {
         trace_number: string;
       }
 
-      /**
-       * A Deprecated Card Decline object. This field will be present in the JSON
-       * response if and only if `category` is equal to `card_route_decline`.
-       */
-      export interface CardRouteDecline {
-        /**
-         * The declined amount in the minor unit of the destination account currency. For
-         * dollars, for example, this is cents.
-         */
-        amount: number;
-
-        /**
-         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
-         * account 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 Wire Decline object. This field will be present in the JSON response if and
        * only if `category` is equal to `wire_decline`.
@@ -1197,12 +1097,6 @@ export interface CardAuthorizeParams {
 }
 
 export interface CardSettlementParams {
-  /**
-   * The amount to be settled. This defaults to the amount of the Pending Transaction
-   * being settled.
-   */
-  amount?: number;
-
   /**
    * The identifier of the Card to create a settlement on.
    */
@@ -1213,4 +1107,10 @@ export interface CardSettlementParams {
    * settle.
    */
   pending_transaction_id: string;
+
+  /**
+   * The amount to be settled. This defaults to the amount of the Pending Transaction
+   * being settled.
+   */
+  amount?: number;
 }

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

@@ -29,45 +29,56 @@ export interface InboundWireDrawdownRequestCreateParams {
   beneficiary_account_number: string;
 
   /**
-   * Line 1 of the drawdown request's beneficiary's address.
+   * The drawdown request's beneficiary's routing number.
    */
-  beneficiary_address_line1?: string;
+  beneficiary_routing_number: string;
 
   /**
-   * Line 2 of the drawdown request's beneficiary's address.
+   * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being
+   * requested. Will always be "USD".
    */
-  beneficiary_address_line2?: string;
+  currency: string;
 
   /**
-   * Line 3 of the drawdown request's beneficiary's address.
+   * A message from the drawdown request's originator.
    */
-  beneficiary_address_line3?: string;
+  message_to_recipient: string;
 
   /**
-   * The drawdown request's beneficiary's name.
+   * The drawdown request's originator's account number.
    */
-  beneficiary_name?: string;
+  originator_account_number: string;
 
   /**
-   * The drawdown request's beneficiary's routing number.
+   * The drawdown request's originator's routing number.
    */
-  beneficiary_routing_number: string;
+  originator_routing_number: string;
 
   /**
-   * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being
-   * requested. Will always be "USD".
+   * The Account Number to which the recipient of this request is being requested to
+   * send funds from.
    */
-  currency: string;
+  recipient_account_number_id: string;
 
   /**
-   * A message from the drawdown request's originator.
+   * Line 1 of the drawdown request's beneficiary's address.
    */
-  message_to_recipient: string;
+  beneficiary_address_line1?: string;
 
   /**
-   * The drawdown request's originator's account number.
+   * Line 2 of the drawdown request's beneficiary's address.
    */
-  originator_account_number: string;
+  beneficiary_address_line2?: string;
+
+  /**
+   * Line 3 of the drawdown request's beneficiary's address.
+   */
+  beneficiary_address_line3?: string;
+
+  /**
+   * The drawdown request's beneficiary's name.
+   */
+  beneficiary_name?: string;
 
   /**
    * Line 1 of the drawdown request's originator's address.
@@ -89,11 +100,6 @@ export interface InboundWireDrawdownRequestCreateParams {
    */
   originator_name?: string;
 
-  /**
-   * The drawdown request's originator's routing number.
-   */
-  originator_routing_number: string;
-
   /**
    * Line 1 of the information conveyed from the originator of the message to the
    * beneficiary.
@@ -117,10 +123,4 @@ export interface InboundWireDrawdownRequestCreateParams {
    * beneficiary.
    */
   originator_to_beneficiary_information_line4?: string;
-
-  /**
-   * The Account Number to which the recipient of this request is being requested to
-   * send funds from.
-   */
-  recipient_account_number_id: string;
 }

package/resources/simulations/index.ts

@@ -22,4 +22,5 @@ export {
 } from './real-time-payments-transfers';
 export { InboundWireDrawdownRequestCreateParams } from './inbound-wire-drawdown-requests';
 export { InterestPaymentSimulationResult, InterestPaymentCreateParams } from './interest-payments';
+export { ProgramCreateParams } from './programs';
 export { WireTransferSimulation, WireTransferCreateInboundParams } from './wire-transfers';

package/resources/simulations/interest-payments.ts

@@ -115,18 +115,6 @@ export namespace InterestPaymentSimulationResult {
        */
       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`.
@@ -163,18 +151,6 @@ export namespace InterestPaymentSimulationResult {
        */
       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`.
@@ -188,8 +164,6 @@ export namespace InterestPaymentSimulationResult {
        */
       category:
         | 'account_transfer_intention'
-        | 'ach_check_conversion_return'
-        | 'ach_check_conversion'
         | 'ach_transfer_intention'
         | 'ach_transfer_rejection'
         | 'ach_transfer_return'
@@ -203,8 +177,6 @@ export namespace InterestPaymentSimulationResult {
         | 'check_transfer_return'
         | 'check_transfer_rejection'
         | 'check_transfer_stop_payment_request'
-        | 'dispute_resolution'
-        | 'empyreal_cash_deposit'
         | 'fee_payment'
         | 'inbound_ach_transfer'
         | 'inbound_ach_transfer_return_intention'
@@ -216,14 +188,9 @@ export namespace InterestPaymentSimulationResult {
         | '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';
@@ -265,18 +232,6 @@ export namespace InterestPaymentSimulationResult {
        */
       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`.
@@ -359,20 +314,6 @@ export namespace InterestPaymentSimulationResult {
        */
       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`.
@@ -425,40 +366,6 @@ export namespace InterestPaymentSimulationResult {
         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`.
@@ -504,6 +411,11 @@ export namespace InterestPaymentSimulationResult {
          */
         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.
          */
@@ -527,10 +439,58 @@ export namespace InterestPaymentSimulationResult {
           | 'file_record_edit_criteria'
           | 'enr_invalid_individual_name'
           | 'returned_per_odfi_request'
-          | 'addenda_error'
           | 'limited_participation_dfi'
           | 'incorrectly_coded_outbound_international_payment'
-          | 'other';
+          | '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.
@@ -819,7 +779,8 @@ export namespace InterestPaymentSimulationResult {
           | '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
@@ -958,45 +919,6 @@ export namespace InterestPaymentSimulationResult {
         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`.
@@ -1470,6 +1392,7 @@ export namespace InterestPaymentSimulationResult {
         currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
 
         reason:
+          | 'account_closure'
           | 'bank_migration'
           | 'cashback'
           | 'collection_receivable'
@@ -1483,66 +1406,6 @@ export namespace InterestPaymentSimulationResult {
           | '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
@@ -1586,35 +1449,6 @@ export namespace InterestPaymentSimulationResult {
         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`.