increase 1.113.0 → 1.114.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/README.md +1 -1
- data/lib/increase/client.rb +8 -0
- data/lib/increase/models/fednow_transfer.rb +516 -0
- data/lib/increase/models/fednow_transfer_approve_params.rb +14 -0
- data/lib/increase/models/fednow_transfer_cancel_params.rb +14 -0
- data/lib/increase/models/fednow_transfer_create_params.rb +188 -0
- data/lib/increase/models/fednow_transfer_list_params.rb +170 -0
- data/lib/increase/models/fednow_transfer_retrieve_params.rb +14 -0
- data/lib/increase/models/inbound_fednow_transfer.rb +278 -0
- data/lib/increase/models/inbound_fednow_transfer_list_params.rb +100 -0
- data/lib/increase/models/inbound_fednow_transfer_retrieve_params.rb +14 -0
- data/lib/increase/models/simulations/inbound_fednow_transfer_create_params.rb +64 -0
- data/lib/increase/models.rb +18 -0
- data/lib/increase/resources/fednow_transfers.rb +159 -0
- data/lib/increase/resources/inbound_fednow_transfers.rb +68 -0
- data/lib/increase/resources/simulations/inbound_fednow_transfers.rb +49 -0
- data/lib/increase/resources/simulations.rb +4 -0
- data/lib/increase/version.rb +1 -1
- data/lib/increase.rb +13 -0
- data/rbi/increase/client.rbi +6 -0
- data/rbi/increase/models/fednow_transfer.rbi +877 -0
- data/rbi/increase/models/fednow_transfer_approve_params.rbi +30 -0
- data/rbi/increase/models/fednow_transfer_cancel_params.rbi +30 -0
- data/rbi/increase/models/fednow_transfer_create_params.rbi +289 -0
- data/rbi/increase/models/fednow_transfer_list_params.rbi +334 -0
- data/rbi/increase/models/fednow_transfer_retrieve_params.rbi +30 -0
- data/rbi/increase/models/inbound_fednow_transfer.rbi +444 -0
- data/rbi/increase/models/inbound_fednow_transfer_list_params.rbi +177 -0
- data/rbi/increase/models/inbound_fednow_transfer_retrieve_params.rbi +30 -0
- data/rbi/increase/models/simulations/inbound_fednow_transfer_create_params.rbi +100 -0
- data/rbi/increase/models.rbi +20 -0
- data/rbi/increase/resources/fednow_transfers.rbi +138 -0
- data/rbi/increase/resources/inbound_fednow_transfers.rbi +54 -0
- data/rbi/increase/resources/simulations/inbound_fednow_transfers.rbi +44 -0
- data/rbi/increase/resources/simulations.rbi +3 -0
- data/sig/increase/client.rbs +4 -0
- data/sig/increase/models/fednow_transfer.rbs +404 -0
- data/sig/increase/models/fednow_transfer_approve_params.rbs +15 -0
- data/sig/increase/models/fednow_transfer_cancel_params.rbs +15 -0
- data/sig/increase/models/fednow_transfer_create_params.rbs +155 -0
- data/sig/increase/models/fednow_transfer_list_params.rbs +174 -0
- data/sig/increase/models/fednow_transfer_retrieve_params.rbs +15 -0
- data/sig/increase/models/inbound_fednow_transfer.rbs +223 -0
- data/sig/increase/models/inbound_fednow_transfer_list_params.rbs +93 -0
- data/sig/increase/models/inbound_fednow_transfer_retrieve_params.rbs +15 -0
- data/sig/increase/models/simulations/inbound_fednow_transfer_create_params.rbs +61 -0
- data/sig/increase/models.rbs +18 -0
- data/sig/increase/resources/fednow_transfers.rbs +49 -0
- data/sig/increase/resources/inbound_fednow_transfers.rbs +21 -0
- data/sig/increase/resources/simulations/inbound_fednow_transfers.rbs +19 -0
- data/sig/increase/resources/simulations.rbs +2 -0
- metadata +41 -2
    
        checksums.yaml
    CHANGED
    
    | @@ -1,7 +1,7 @@ | |
| 1 1 | 
             
            ---
         | 
| 2 2 | 
             
            SHA256:
         | 
| 3 | 
            -
              metadata.gz:  | 
| 4 | 
            -
              data.tar.gz:  | 
| 3 | 
            +
              metadata.gz: bac78d29bbc1cba753854b3addc6af6d3d8b8c158f2f58c5f85dd0f015eed0d7
         | 
| 4 | 
            +
              data.tar.gz: a1310b2589f4f6e0847396f1bed5e8b0d1fbcfd665e5a18c714a751ea7e7ead6
         | 
| 5 5 | 
             
            SHA512:
         | 
| 6 | 
            -
              metadata.gz:  | 
| 7 | 
            -
              data.tar.gz:  | 
| 6 | 
            +
              metadata.gz: 8d30619f8f721c612be918a69da82bbbae2a942e3aeaa00c471d46df240e44ac8a7eeee02c41ef685c6b9c56090414298e1f30dc6f267b6342d66b300d250def
         | 
| 7 | 
            +
              data.tar.gz: c288c5e847fb48a1041df7236d43612c18ee23e61b3fbf300fb82cae9b855794783ef750a7712f892033722c7b070d1d0dc43f1bd3f1306a6327d72a7b91f497
         | 
    
        data/CHANGELOG.md
    CHANGED
    
    | @@ -1,5 +1,13 @@ | |
| 1 1 | 
             
            # Changelog
         | 
| 2 2 |  | 
| 3 | 
            +
            ## 1.114.0 (2025-10-24)
         | 
| 4 | 
            +
             | 
| 5 | 
            +
            Full Changelog: [v1.113.0...v1.114.0](https://github.com/Increase/increase-ruby/compare/v1.113.0...v1.114.0)
         | 
| 6 | 
            +
             | 
| 7 | 
            +
            ### Features
         | 
| 8 | 
            +
             | 
| 9 | 
            +
            * **api:** api update ([67322ef](https://github.com/Increase/increase-ruby/commit/67322ef5131aee957a9fc9cb34b3d0ce89675409))
         | 
| 10 | 
            +
             | 
| 3 11 | 
             
            ## 1.113.0 (2025-10-23)
         | 
| 4 12 |  | 
| 5 13 | 
             
            Full Changelog: [v1.112.0...v1.113.0](https://github.com/Increase/increase-ruby/compare/v1.112.0...v1.113.0)
         | 
    
        data/README.md
    CHANGED
    
    
    
        data/lib/increase/client.rb
    CHANGED
    
    | @@ -98,6 +98,12 @@ module Increase | |
| 98 98 | 
             
                # @return [Increase::Resources::InboundRealTimePaymentsTransfers]
         | 
| 99 99 | 
             
                attr_reader :inbound_real_time_payments_transfers
         | 
| 100 100 |  | 
| 101 | 
            +
                # @return [Increase::Resources::FednowTransfers]
         | 
| 102 | 
            +
                attr_reader :fednow_transfers
         | 
| 103 | 
            +
             | 
| 104 | 
            +
                # @return [Increase::Resources::InboundFednowTransfers]
         | 
| 105 | 
            +
                attr_reader :inbound_fednow_transfers
         | 
| 106 | 
            +
             | 
| 101 107 | 
             
                # @return [Increase::Resources::CheckDeposits]
         | 
| 102 108 | 
             
                attr_reader :check_deposits
         | 
| 103 109 |  | 
| @@ -276,6 +282,8 @@ module Increase | |
| 276 282 | 
             
                  @real_time_payments_transfers = Increase::Resources::RealTimePaymentsTransfers.new(client: self)
         | 
| 277 283 | 
             
                  @inbound_real_time_payments_transfers =
         | 
| 278 284 | 
             
                    Increase::Resources::InboundRealTimePaymentsTransfers.new(client: self)
         | 
| 285 | 
            +
                  @fednow_transfers = Increase::Resources::FednowTransfers.new(client: self)
         | 
| 286 | 
            +
                  @inbound_fednow_transfers = Increase::Resources::InboundFednowTransfers.new(client: self)
         | 
| 279 287 | 
             
                  @check_deposits = Increase::Resources::CheckDeposits.new(client: self)
         | 
| 280 288 | 
             
                  @lockboxes = Increase::Resources::Lockboxes.new(client: self)
         | 
| 281 289 | 
             
                  @inbound_mail_items = Increase::Resources::InboundMailItems.new(client: self)
         | 
| @@ -0,0 +1,516 @@ | |
| 1 | 
            +
            # frozen_string_literal: true
         | 
| 2 | 
            +
             | 
| 3 | 
            +
            module Increase
         | 
| 4 | 
            +
              module Models
         | 
| 5 | 
            +
                # @see Increase::Resources::FednowTransfers#create
         | 
| 6 | 
            +
                class FednowTransfer < Increase::Internal::Type::BaseModel
         | 
| 7 | 
            +
                  # @!attribute id
         | 
| 8 | 
            +
                  #   The FedNow Transfer's identifier.
         | 
| 9 | 
            +
                  #
         | 
| 10 | 
            +
                  #   @return [String]
         | 
| 11 | 
            +
                  required :id, String
         | 
| 12 | 
            +
             | 
| 13 | 
            +
                  # @!attribute account_id
         | 
| 14 | 
            +
                  #   The Account from which the transfer was sent.
         | 
| 15 | 
            +
                  #
         | 
| 16 | 
            +
                  #   @return [String]
         | 
| 17 | 
            +
                  required :account_id, String
         | 
| 18 | 
            +
             | 
| 19 | 
            +
                  # @!attribute account_number
         | 
| 20 | 
            +
                  #   The destination account number.
         | 
| 21 | 
            +
                  #
         | 
| 22 | 
            +
                  #   @return [String]
         | 
| 23 | 
            +
                  required :account_number, String
         | 
| 24 | 
            +
             | 
| 25 | 
            +
                  # @!attribute acknowledgement
         | 
| 26 | 
            +
                  #   If the transfer is acknowledged by the recipient bank, this will contain
         | 
| 27 | 
            +
                  #   supplemental details.
         | 
| 28 | 
            +
                  #
         | 
| 29 | 
            +
                  #   @return [Increase::Models::FednowTransfer::Acknowledgement, nil]
         | 
| 30 | 
            +
                  required :acknowledgement, -> { Increase::FednowTransfer::Acknowledgement }, nil?: true
         | 
| 31 | 
            +
             | 
| 32 | 
            +
                  # @!attribute amount
         | 
| 33 | 
            +
                  #   The transfer amount in USD cents.
         | 
| 34 | 
            +
                  #
         | 
| 35 | 
            +
                  #   @return [Integer]
         | 
| 36 | 
            +
                  required :amount, Integer
         | 
| 37 | 
            +
             | 
| 38 | 
            +
                  # @!attribute created_at
         | 
| 39 | 
            +
                  #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
         | 
| 40 | 
            +
                  #   the transfer was created.
         | 
| 41 | 
            +
                  #
         | 
| 42 | 
            +
                  #   @return [Time]
         | 
| 43 | 
            +
                  required :created_at, Time
         | 
| 44 | 
            +
             | 
| 45 | 
            +
                  # @!attribute created_by
         | 
| 46 | 
            +
                  #   What object created the transfer, either via the API or the dashboard.
         | 
| 47 | 
            +
                  #
         | 
| 48 | 
            +
                  #   @return [Increase::Models::FednowTransfer::CreatedBy, nil]
         | 
| 49 | 
            +
                  required :created_by, -> { Increase::FednowTransfer::CreatedBy }, nil?: true
         | 
| 50 | 
            +
             | 
| 51 | 
            +
                  # @!attribute creditor_name
         | 
| 52 | 
            +
                  #   The name of the transfer's recipient. This is set by the sender when creating
         | 
| 53 | 
            +
                  #   the transfer.
         | 
| 54 | 
            +
                  #
         | 
| 55 | 
            +
                  #   @return [String]
         | 
| 56 | 
            +
                  required :creditor_name, String
         | 
| 57 | 
            +
             | 
| 58 | 
            +
                  # @!attribute currency
         | 
| 59 | 
            +
                  #   The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
         | 
| 60 | 
            +
                  #   currency. For FedNow transfers this is always equal to `USD`.
         | 
| 61 | 
            +
                  #
         | 
| 62 | 
            +
                  #   @return [Symbol, Increase::Models::FednowTransfer::Currency]
         | 
| 63 | 
            +
                  required :currency, enum: -> { Increase::FednowTransfer::Currency }
         | 
| 64 | 
            +
             | 
| 65 | 
            +
                  # @!attribute debtor_name
         | 
| 66 | 
            +
                  #   The name of the transfer's sender. If not provided, defaults to the name of the
         | 
| 67 | 
            +
                  #   account's entity.
         | 
| 68 | 
            +
                  #
         | 
| 69 | 
            +
                  #   @return [String]
         | 
| 70 | 
            +
                  required :debtor_name, String
         | 
| 71 | 
            +
             | 
| 72 | 
            +
                  # @!attribute external_account_id
         | 
| 73 | 
            +
                  #   The identifier of the External Account the transfer was made to, if any.
         | 
| 74 | 
            +
                  #
         | 
| 75 | 
            +
                  #   @return [String, nil]
         | 
| 76 | 
            +
                  required :external_account_id, String, nil?: true
         | 
| 77 | 
            +
             | 
| 78 | 
            +
                  # @!attribute idempotency_key
         | 
| 79 | 
            +
                  #   The idempotency key you chose for this object. This value is unique across
         | 
| 80 | 
            +
                  #   Increase and is used to ensure that a request is only processed once. Learn more
         | 
| 81 | 
            +
                  #   about [idempotency](https://increase.com/documentation/idempotency-keys).
         | 
| 82 | 
            +
                  #
         | 
| 83 | 
            +
                  #   @return [String, nil]
         | 
| 84 | 
            +
                  required :idempotency_key, String, nil?: true
         | 
| 85 | 
            +
             | 
| 86 | 
            +
                  # @!attribute pending_transaction_id
         | 
| 87 | 
            +
                  #   The ID for the pending transaction representing the transfer.
         | 
| 88 | 
            +
                  #
         | 
| 89 | 
            +
                  #   @return [String, nil]
         | 
| 90 | 
            +
                  required :pending_transaction_id, String, nil?: true
         | 
| 91 | 
            +
             | 
| 92 | 
            +
                  # @!attribute rejection
         | 
| 93 | 
            +
                  #   If the transfer is rejected by FedNow or the destination financial institution,
         | 
| 94 | 
            +
                  #   this will contain supplemental details.
         | 
| 95 | 
            +
                  #
         | 
| 96 | 
            +
                  #   @return [Increase::Models::FednowTransfer::Rejection, nil]
         | 
| 97 | 
            +
                  required :rejection, -> { Increase::FednowTransfer::Rejection }, nil?: true
         | 
| 98 | 
            +
             | 
| 99 | 
            +
                  # @!attribute routing_number
         | 
| 100 | 
            +
                  #   The destination American Bankers' Association (ABA) Routing Transit Number
         | 
| 101 | 
            +
                  #   (RTN).
         | 
| 102 | 
            +
                  #
         | 
| 103 | 
            +
                  #   @return [String]
         | 
| 104 | 
            +
                  required :routing_number, String
         | 
| 105 | 
            +
             | 
| 106 | 
            +
                  # @!attribute source_account_number_id
         | 
| 107 | 
            +
                  #   The Account Number the recipient will see as having sent the transfer.
         | 
| 108 | 
            +
                  #
         | 
| 109 | 
            +
                  #   @return [String]
         | 
| 110 | 
            +
                  required :source_account_number_id, String
         | 
| 111 | 
            +
             | 
| 112 | 
            +
                  # @!attribute status
         | 
| 113 | 
            +
                  #   The lifecycle status of the transfer.
         | 
| 114 | 
            +
                  #
         | 
| 115 | 
            +
                  #   @return [Symbol, Increase::Models::FednowTransfer::Status]
         | 
| 116 | 
            +
                  required :status, enum: -> { Increase::FednowTransfer::Status }
         | 
| 117 | 
            +
             | 
| 118 | 
            +
                  # @!attribute submission
         | 
| 119 | 
            +
                  #   After the transfer is submitted to FedNow, this will contain supplemental
         | 
| 120 | 
            +
                  #   details.
         | 
| 121 | 
            +
                  #
         | 
| 122 | 
            +
                  #   @return [Increase::Models::FednowTransfer::Submission, nil]
         | 
| 123 | 
            +
                  required :submission, -> { Increase::FednowTransfer::Submission }, nil?: true
         | 
| 124 | 
            +
             | 
| 125 | 
            +
                  # @!attribute transaction_id
         | 
| 126 | 
            +
                  #   The Transaction funding the transfer once it is complete.
         | 
| 127 | 
            +
                  #
         | 
| 128 | 
            +
                  #   @return [String, nil]
         | 
| 129 | 
            +
                  required :transaction_id, String, nil?: true
         | 
| 130 | 
            +
             | 
| 131 | 
            +
                  # @!attribute type
         | 
| 132 | 
            +
                  #   A constant representing the object's type. For this resource it will always be
         | 
| 133 | 
            +
                  #   `fednow_transfer`.
         | 
| 134 | 
            +
                  #
         | 
| 135 | 
            +
                  #   @return [Symbol, Increase::Models::FednowTransfer::Type]
         | 
| 136 | 
            +
                  required :type, enum: -> { Increase::FednowTransfer::Type }
         | 
| 137 | 
            +
             | 
| 138 | 
            +
                  # @!attribute unique_end_to_end_transaction_reference
         | 
| 139 | 
            +
                  #   The Unique End-to-end Transaction Reference
         | 
| 140 | 
            +
                  #   ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr))
         | 
| 141 | 
            +
                  #   of the transfer.
         | 
| 142 | 
            +
                  #
         | 
| 143 | 
            +
                  #   @return [String]
         | 
| 144 | 
            +
                  required :unique_end_to_end_transaction_reference, String
         | 
| 145 | 
            +
             | 
| 146 | 
            +
                  # @!attribute unstructured_remittance_information
         | 
| 147 | 
            +
                  #   Unstructured information that will show on the recipient's bank statement.
         | 
| 148 | 
            +
                  #
         | 
| 149 | 
            +
                  #   @return [String]
         | 
| 150 | 
            +
                  required :unstructured_remittance_information, String
         | 
| 151 | 
            +
             | 
| 152 | 
            +
                  # @!method initialize(id:, account_id:, account_number:, acknowledgement:, amount:, created_at:, created_by:, creditor_name:, currency:, debtor_name:, external_account_id:, idempotency_key:, pending_transaction_id:, rejection:, routing_number:, source_account_number_id:, status:, submission:, transaction_id:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
         | 
| 153 | 
            +
                  #   Some parameter documentations has been truncated, see
         | 
| 154 | 
            +
                  #   {Increase::Models::FednowTransfer} for more details.
         | 
| 155 | 
            +
                  #
         | 
| 156 | 
            +
                  #   FedNow transfers move funds, within seconds, between your Increase account and
         | 
| 157 | 
            +
                  #   any other account supporting FedNow.
         | 
| 158 | 
            +
                  #
         | 
| 159 | 
            +
                  #   @param id [String] The FedNow Transfer's identifier.
         | 
| 160 | 
            +
                  #
         | 
| 161 | 
            +
                  #   @param account_id [String] The Account from which the transfer was sent.
         | 
| 162 | 
            +
                  #
         | 
| 163 | 
            +
                  #   @param account_number [String] The destination account number.
         | 
| 164 | 
            +
                  #
         | 
| 165 | 
            +
                  #   @param acknowledgement [Increase::Models::FednowTransfer::Acknowledgement, nil] If the transfer is acknowledged by the recipient bank, this will contain supplem
         | 
| 166 | 
            +
                  #
         | 
| 167 | 
            +
                  #   @param amount [Integer] The transfer amount in USD cents.
         | 
| 168 | 
            +
                  #
         | 
| 169 | 
            +
                  #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
         | 
| 170 | 
            +
                  #
         | 
| 171 | 
            +
                  #   @param created_by [Increase::Models::FednowTransfer::CreatedBy, nil] What object created the transfer, either via the API or the dashboard.
         | 
| 172 | 
            +
                  #
         | 
| 173 | 
            +
                  #   @param creditor_name [String] The name of the transfer's recipient. This is set by the sender when creating th
         | 
| 174 | 
            +
                  #
         | 
| 175 | 
            +
                  #   @param currency [Symbol, Increase::Models::FednowTransfer::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's c
         | 
| 176 | 
            +
                  #
         | 
| 177 | 
            +
                  #   @param debtor_name [String] The name of the transfer's sender. If not provided, defaults to the name of the
         | 
| 178 | 
            +
                  #
         | 
| 179 | 
            +
                  #   @param external_account_id [String, nil] The identifier of the External Account the transfer was made to, if any.
         | 
| 180 | 
            +
                  #
         | 
| 181 | 
            +
                  #   @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
         | 
| 182 | 
            +
                  #
         | 
| 183 | 
            +
                  #   @param pending_transaction_id [String, nil] The ID for the pending transaction representing the transfer.
         | 
| 184 | 
            +
                  #
         | 
| 185 | 
            +
                  #   @param rejection [Increase::Models::FednowTransfer::Rejection, nil] If the transfer is rejected by FedNow or the destination financial institution,
         | 
| 186 | 
            +
                  #
         | 
| 187 | 
            +
                  #   @param routing_number [String] The destination American Bankers' Association (ABA) Routing Transit Number (RTN)
         | 
| 188 | 
            +
                  #
         | 
| 189 | 
            +
                  #   @param source_account_number_id [String] The Account Number the recipient will see as having sent the transfer.
         | 
| 190 | 
            +
                  #
         | 
| 191 | 
            +
                  #   @param status [Symbol, Increase::Models::FednowTransfer::Status] The lifecycle status of the transfer.
         | 
| 192 | 
            +
                  #
         | 
| 193 | 
            +
                  #   @param submission [Increase::Models::FednowTransfer::Submission, nil] After the transfer is submitted to FedNow, this will contain supplemental detail
         | 
| 194 | 
            +
                  #
         | 
| 195 | 
            +
                  #   @param transaction_id [String, nil] The Transaction funding the transfer once it is complete.
         | 
| 196 | 
            +
                  #
         | 
| 197 | 
            +
                  #   @param type [Symbol, Increase::Models::FednowTransfer::Type] A constant representing the object's type. For this resource it will always be `
         | 
| 198 | 
            +
                  #
         | 
| 199 | 
            +
                  #   @param unique_end_to_end_transaction_reference [String] The Unique End-to-end Transaction Reference ([UETR](https://www.swift.com/paymen
         | 
| 200 | 
            +
                  #
         | 
| 201 | 
            +
                  #   @param unstructured_remittance_information [String] Unstructured information that will show on the recipient's bank statement.
         | 
| 202 | 
            +
             | 
| 203 | 
            +
                  # @see Increase::Models::FednowTransfer#acknowledgement
         | 
| 204 | 
            +
                  class Acknowledgement < Increase::Internal::Type::BaseModel
         | 
| 205 | 
            +
                    # @!attribute acknowledged_at
         | 
| 206 | 
            +
                    #   When the transfer was acknowledged.
         | 
| 207 | 
            +
                    #
         | 
| 208 | 
            +
                    #   @return [Time]
         | 
| 209 | 
            +
                    required :acknowledged_at, Time
         | 
| 210 | 
            +
             | 
| 211 | 
            +
                    # @!method initialize(acknowledged_at:)
         | 
| 212 | 
            +
                    #   If the transfer is acknowledged by the recipient bank, this will contain
         | 
| 213 | 
            +
                    #   supplemental details.
         | 
| 214 | 
            +
                    #
         | 
| 215 | 
            +
                    #   @param acknowledged_at [Time] When the transfer was acknowledged.
         | 
| 216 | 
            +
                  end
         | 
| 217 | 
            +
             | 
| 218 | 
            +
                  # @see Increase::Models::FednowTransfer#created_by
         | 
| 219 | 
            +
                  class CreatedBy < Increase::Internal::Type::BaseModel
         | 
| 220 | 
            +
                    # @!attribute api_key
         | 
| 221 | 
            +
                    #   If present, details about the API key that created the transfer.
         | 
| 222 | 
            +
                    #
         | 
| 223 | 
            +
                    #   @return [Increase::Models::FednowTransfer::CreatedBy::APIKey, nil]
         | 
| 224 | 
            +
                    required :api_key, -> { Increase::FednowTransfer::CreatedBy::APIKey }, nil?: true
         | 
| 225 | 
            +
             | 
| 226 | 
            +
                    # @!attribute category
         | 
| 227 | 
            +
                    #   The type of object that created this transfer.
         | 
| 228 | 
            +
                    #
         | 
| 229 | 
            +
                    #   @return [Symbol, Increase::Models::FednowTransfer::CreatedBy::Category]
         | 
| 230 | 
            +
                    required :category, enum: -> { Increase::FednowTransfer::CreatedBy::Category }
         | 
| 231 | 
            +
             | 
| 232 | 
            +
                    # @!attribute oauth_application
         | 
| 233 | 
            +
                    #   If present, details about the OAuth Application that created the transfer.
         | 
| 234 | 
            +
                    #
         | 
| 235 | 
            +
                    #   @return [Increase::Models::FednowTransfer::CreatedBy::OAuthApplication, nil]
         | 
| 236 | 
            +
                    required :oauth_application, -> { Increase::FednowTransfer::CreatedBy::OAuthApplication }, nil?: true
         | 
| 237 | 
            +
             | 
| 238 | 
            +
                    # @!attribute user
         | 
| 239 | 
            +
                    #   If present, details about the User that created the transfer.
         | 
| 240 | 
            +
                    #
         | 
| 241 | 
            +
                    #   @return [Increase::Models::FednowTransfer::CreatedBy::User, nil]
         | 
| 242 | 
            +
                    required :user, -> { Increase::FednowTransfer::CreatedBy::User }, nil?: true
         | 
| 243 | 
            +
             | 
| 244 | 
            +
                    # @!method initialize(api_key:, category:, oauth_application:, user:)
         | 
| 245 | 
            +
                    #   What object created the transfer, either via the API or the dashboard.
         | 
| 246 | 
            +
                    #
         | 
| 247 | 
            +
                    #   @param api_key [Increase::Models::FednowTransfer::CreatedBy::APIKey, nil] If present, details about the API key that created the transfer.
         | 
| 248 | 
            +
                    #
         | 
| 249 | 
            +
                    #   @param category [Symbol, Increase::Models::FednowTransfer::CreatedBy::Category] The type of object that created this transfer.
         | 
| 250 | 
            +
                    #
         | 
| 251 | 
            +
                    #   @param oauth_application [Increase::Models::FednowTransfer::CreatedBy::OAuthApplication, nil] If present, details about the OAuth Application that created the transfer.
         | 
| 252 | 
            +
                    #
         | 
| 253 | 
            +
                    #   @param user [Increase::Models::FednowTransfer::CreatedBy::User, nil] If present, details about the User that created the transfer.
         | 
| 254 | 
            +
             | 
| 255 | 
            +
                    # @see Increase::Models::FednowTransfer::CreatedBy#api_key
         | 
| 256 | 
            +
                    class APIKey < Increase::Internal::Type::BaseModel
         | 
| 257 | 
            +
                      # @!attribute description
         | 
| 258 | 
            +
                      #   The description set for the API key when it was created.
         | 
| 259 | 
            +
                      #
         | 
| 260 | 
            +
                      #   @return [String, nil]
         | 
| 261 | 
            +
                      required :description, String, nil?: true
         | 
| 262 | 
            +
             | 
| 263 | 
            +
                      # @!method initialize(description:)
         | 
| 264 | 
            +
                      #   If present, details about the API key that created the transfer.
         | 
| 265 | 
            +
                      #
         | 
| 266 | 
            +
                      #   @param description [String, nil] The description set for the API key when it was created.
         | 
| 267 | 
            +
                    end
         | 
| 268 | 
            +
             | 
| 269 | 
            +
                    # The type of object that created this transfer.
         | 
| 270 | 
            +
                    #
         | 
| 271 | 
            +
                    # @see Increase::Models::FednowTransfer::CreatedBy#category
         | 
| 272 | 
            +
                    module Category
         | 
| 273 | 
            +
                      extend Increase::Internal::Type::Enum
         | 
| 274 | 
            +
             | 
| 275 | 
            +
                      # An API key. Details will be under the `api_key` object.
         | 
| 276 | 
            +
                      API_KEY = :api_key
         | 
| 277 | 
            +
             | 
| 278 | 
            +
                      # An OAuth application you connected to Increase. Details will be under the `oauth_application` object.
         | 
| 279 | 
            +
                      OAUTH_APPLICATION = :oauth_application
         | 
| 280 | 
            +
             | 
| 281 | 
            +
                      # A User in the Increase dashboard. Details will be under the `user` object.
         | 
| 282 | 
            +
                      USER = :user
         | 
| 283 | 
            +
             | 
| 284 | 
            +
                      # @!method self.values
         | 
| 285 | 
            +
                      #   @return [Array<Symbol>]
         | 
| 286 | 
            +
                    end
         | 
| 287 | 
            +
             | 
| 288 | 
            +
                    # @see Increase::Models::FednowTransfer::CreatedBy#oauth_application
         | 
| 289 | 
            +
                    class OAuthApplication < Increase::Internal::Type::BaseModel
         | 
| 290 | 
            +
                      # @!attribute name
         | 
| 291 | 
            +
                      #   The name of the OAuth Application.
         | 
| 292 | 
            +
                      #
         | 
| 293 | 
            +
                      #   @return [String]
         | 
| 294 | 
            +
                      required :name, String
         | 
| 295 | 
            +
             | 
| 296 | 
            +
                      # @!method initialize(name:)
         | 
| 297 | 
            +
                      #   If present, details about the OAuth Application that created the transfer.
         | 
| 298 | 
            +
                      #
         | 
| 299 | 
            +
                      #   @param name [String] The name of the OAuth Application.
         | 
| 300 | 
            +
                    end
         | 
| 301 | 
            +
             | 
| 302 | 
            +
                    # @see Increase::Models::FednowTransfer::CreatedBy#user
         | 
| 303 | 
            +
                    class User < Increase::Internal::Type::BaseModel
         | 
| 304 | 
            +
                      # @!attribute email
         | 
| 305 | 
            +
                      #   The email address of the User.
         | 
| 306 | 
            +
                      #
         | 
| 307 | 
            +
                      #   @return [String]
         | 
| 308 | 
            +
                      required :email, String
         | 
| 309 | 
            +
             | 
| 310 | 
            +
                      # @!method initialize(email:)
         | 
| 311 | 
            +
                      #   If present, details about the User that created the transfer.
         | 
| 312 | 
            +
                      #
         | 
| 313 | 
            +
                      #   @param email [String] The email address of the User.
         | 
| 314 | 
            +
                    end
         | 
| 315 | 
            +
                  end
         | 
| 316 | 
            +
             | 
| 317 | 
            +
                  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
         | 
| 318 | 
            +
                  # currency. For FedNow transfers this is always equal to `USD`.
         | 
| 319 | 
            +
                  #
         | 
| 320 | 
            +
                  # @see Increase::Models::FednowTransfer#currency
         | 
| 321 | 
            +
                  module Currency
         | 
| 322 | 
            +
                    extend Increase::Internal::Type::Enum
         | 
| 323 | 
            +
             | 
| 324 | 
            +
                    # Canadian Dollar (CAD)
         | 
| 325 | 
            +
                    CAD = :CAD
         | 
| 326 | 
            +
             | 
| 327 | 
            +
                    # Swiss Franc (CHF)
         | 
| 328 | 
            +
                    CHF = :CHF
         | 
| 329 | 
            +
             | 
| 330 | 
            +
                    # Euro (EUR)
         | 
| 331 | 
            +
                    EUR = :EUR
         | 
| 332 | 
            +
             | 
| 333 | 
            +
                    # British Pound (GBP)
         | 
| 334 | 
            +
                    GBP = :GBP
         | 
| 335 | 
            +
             | 
| 336 | 
            +
                    # Japanese Yen (JPY)
         | 
| 337 | 
            +
                    JPY = :JPY
         | 
| 338 | 
            +
             | 
| 339 | 
            +
                    # US Dollar (USD)
         | 
| 340 | 
            +
                    USD = :USD
         | 
| 341 | 
            +
             | 
| 342 | 
            +
                    # @!method self.values
         | 
| 343 | 
            +
                    #   @return [Array<Symbol>]
         | 
| 344 | 
            +
                  end
         | 
| 345 | 
            +
             | 
| 346 | 
            +
                  # @see Increase::Models::FednowTransfer#rejection
         | 
| 347 | 
            +
                  class Rejection < Increase::Internal::Type::BaseModel
         | 
| 348 | 
            +
                    # @!attribute reject_reason_additional_information
         | 
| 349 | 
            +
                    #   Additional information about the rejection provided by the recipient bank.
         | 
| 350 | 
            +
                    #
         | 
| 351 | 
            +
                    #   @return [String, nil]
         | 
| 352 | 
            +
                    required :reject_reason_additional_information, String, nil?: true
         | 
| 353 | 
            +
             | 
| 354 | 
            +
                    # @!attribute reject_reason_code
         | 
| 355 | 
            +
                    #   The reason the transfer was rejected as provided by the recipient bank or the
         | 
| 356 | 
            +
                    #   FedNow network.
         | 
| 357 | 
            +
                    #
         | 
| 358 | 
            +
                    #   @return [Symbol, Increase::Models::FednowTransfer::Rejection::RejectReasonCode]
         | 
| 359 | 
            +
                    required :reject_reason_code, enum: -> { Increase::FednowTransfer::Rejection::RejectReasonCode }
         | 
| 360 | 
            +
             | 
| 361 | 
            +
                    # @!attribute rejected_at
         | 
| 362 | 
            +
                    #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
         | 
| 363 | 
            +
                    #   the transfer was rejected.
         | 
| 364 | 
            +
                    #
         | 
| 365 | 
            +
                    #   @return [Time, nil]
         | 
| 366 | 
            +
                    required :rejected_at, Time, nil?: true
         | 
| 367 | 
            +
             | 
| 368 | 
            +
                    # @!method initialize(reject_reason_additional_information:, reject_reason_code:, rejected_at:)
         | 
| 369 | 
            +
                    #   Some parameter documentations has been truncated, see
         | 
| 370 | 
            +
                    #   {Increase::Models::FednowTransfer::Rejection} for more details.
         | 
| 371 | 
            +
                    #
         | 
| 372 | 
            +
                    #   If the transfer is rejected by FedNow or the destination financial institution,
         | 
| 373 | 
            +
                    #   this will contain supplemental details.
         | 
| 374 | 
            +
                    #
         | 
| 375 | 
            +
                    #   @param reject_reason_additional_information [String, nil] Additional information about the rejection provided by the recipient bank.
         | 
| 376 | 
            +
                    #
         | 
| 377 | 
            +
                    #   @param reject_reason_code [Symbol, Increase::Models::FednowTransfer::Rejection::RejectReasonCode] The reason the transfer was rejected as provided by the recipient bank or the Fe
         | 
| 378 | 
            +
                    #
         | 
| 379 | 
            +
                    #   @param rejected_at [Time, nil] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
         | 
| 380 | 
            +
             | 
| 381 | 
            +
                    # The reason the transfer was rejected as provided by the recipient bank or the
         | 
| 382 | 
            +
                    # FedNow network.
         | 
| 383 | 
            +
                    #
         | 
| 384 | 
            +
                    # @see Increase::Models::FednowTransfer::Rejection#reject_reason_code
         | 
| 385 | 
            +
                    module RejectReasonCode
         | 
| 386 | 
            +
                      extend Increase::Internal::Type::Enum
         | 
| 387 | 
            +
             | 
| 388 | 
            +
                      # The destination account is closed. Corresponds to the FedNow reason code `AC04`.
         | 
| 389 | 
            +
                      ACCOUNT_CLOSED = :account_closed
         | 
| 390 | 
            +
             | 
| 391 | 
            +
                      # The destination account is currently blocked from receiving transactions. Corresponds to the FedNow reason code `AC06`.
         | 
| 392 | 
            +
                      ACCOUNT_BLOCKED = :account_blocked
         | 
| 393 | 
            +
             | 
| 394 | 
            +
                      # The destination account is ineligible to receive FedNow transfers. Corresponds to the FedNow reason code `AC14`.
         | 
| 395 | 
            +
                      INVALID_CREDITOR_ACCOUNT_TYPE = :invalid_creditor_account_type
         | 
| 396 | 
            +
             | 
| 397 | 
            +
                      # The destination account does not exist. Corresponds to the FedNow reason code `AC03`.
         | 
| 398 | 
            +
                      INVALID_CREDITOR_ACCOUNT_NUMBER = :invalid_creditor_account_number
         | 
| 399 | 
            +
             | 
| 400 | 
            +
                      # The destination routing number is invalid. Corresponds to the FedNow reason code `RC04`.
         | 
| 401 | 
            +
                      INVALID_CREDITOR_FINANCIAL_INSTITUTION_IDENTIFIER = :invalid_creditor_financial_institution_identifier
         | 
| 402 | 
            +
             | 
| 403 | 
            +
                      # The destination account holder is deceased. Corresponds to the FedNow reason code `MD07`.
         | 
| 404 | 
            +
                      END_CUSTOMER_DECEASED = :end_customer_deceased
         | 
| 405 | 
            +
             | 
| 406 | 
            +
                      # The reason is provided as narrative information in the additional information field. Corresponds to the FedNow reason code `NARR`.
         | 
| 407 | 
            +
                      NARRATIVE = :narrative
         | 
| 408 | 
            +
             | 
| 409 | 
            +
                      # FedNow transfers are not allowed to the destination account. Corresponds to the FedNow reason code `AG01`.
         | 
| 410 | 
            +
                      TRANSACTION_FORBIDDEN = :transaction_forbidden
         | 
| 411 | 
            +
             | 
| 412 | 
            +
                      # FedNow transfers are not enabled for the destination account. Corresponds to the FedNow reason code `AG03`.
         | 
| 413 | 
            +
                      TRANSACTION_TYPE_NOT_SUPPORTED = :transaction_type_not_supported
         | 
| 414 | 
            +
             | 
| 415 | 
            +
                      # The amount is higher than the recipient is authorized to send or receive. Corresponds to the FedNow reason code `E990`.
         | 
| 416 | 
            +
                      AMOUNT_EXCEEDS_BANK_LIMITS = :amount_exceeds_bank_limits
         | 
| 417 | 
            +
             | 
| 418 | 
            +
                      # The creditor's address is required, but missing or invalid. Corresponds to the FedNow reason code `BE04`.
         | 
| 419 | 
            +
                      INVALID_CREDITOR_ADDRESS = :invalid_creditor_address
         | 
| 420 | 
            +
             | 
| 421 | 
            +
                      # The debtor's address is required, but missing or invalid. Corresponds to the FedNow reason code `BE07`.
         | 
| 422 | 
            +
                      INVALID_DEBTOR_ADDRESS = :invalid_debtor_address
         | 
| 423 | 
            +
             | 
| 424 | 
            +
                      # There was a timeout processing the transfer. Corresponds to the FedNow reason code `E997`.
         | 
| 425 | 
            +
                      TIMEOUT = :timeout
         | 
| 426 | 
            +
             | 
| 427 | 
            +
                      # The transfer was rejected due to an internal Increase issue. We have been notified.
         | 
| 428 | 
            +
                      PROCESSING_ERROR = :processing_error
         | 
| 429 | 
            +
             | 
| 430 | 
            +
                      # Some other error or issue has occurred.
         | 
| 431 | 
            +
                      OTHER = :other
         | 
| 432 | 
            +
             | 
| 433 | 
            +
                      # @!method self.values
         | 
| 434 | 
            +
                      #   @return [Array<Symbol>]
         | 
| 435 | 
            +
                    end
         | 
| 436 | 
            +
                  end
         | 
| 437 | 
            +
             | 
| 438 | 
            +
                  # The lifecycle status of the transfer.
         | 
| 439 | 
            +
                  #
         | 
| 440 | 
            +
                  # @see Increase::Models::FednowTransfer#status
         | 
| 441 | 
            +
                  module Status
         | 
| 442 | 
            +
                    extend Increase::Internal::Type::Enum
         | 
| 443 | 
            +
             | 
| 444 | 
            +
                    # The transfer is pending review by Increase.
         | 
| 445 | 
            +
                    PENDING_REVIEWING = :pending_reviewing
         | 
| 446 | 
            +
             | 
| 447 | 
            +
                    # The transfer has been canceled.
         | 
| 448 | 
            +
                    CANCELED = :canceled
         | 
| 449 | 
            +
             | 
| 450 | 
            +
                    # The transfer has been rejected by Increase.
         | 
| 451 | 
            +
                    REVIEWING_REJECTED = :reviewing_rejected
         | 
| 452 | 
            +
             | 
| 453 | 
            +
                    # The transfer requires attention from an Increase operator.
         | 
| 454 | 
            +
                    REQUIRES_ATTENTION = :requires_attention
         | 
| 455 | 
            +
             | 
| 456 | 
            +
                    # The transfer is pending approval.
         | 
| 457 | 
            +
                    PENDING_APPROVAL = :pending_approval
         | 
| 458 | 
            +
             | 
| 459 | 
            +
                    # The transfer is queued to be submitted to FedNow.
         | 
| 460 | 
            +
                    PENDING_SUBMITTING = :pending_submitting
         | 
| 461 | 
            +
             | 
| 462 | 
            +
                    # The transfer has been submitted and is pending a response from FedNow.
         | 
| 463 | 
            +
                    PENDING_RESPONSE = :pending_response
         | 
| 464 | 
            +
             | 
| 465 | 
            +
                    # The transfer has been sent successfully and is complete.
         | 
| 466 | 
            +
                    COMPLETE = :complete
         | 
| 467 | 
            +
             | 
| 468 | 
            +
                    # The transfer was rejected by the network or the recipient's bank.
         | 
| 469 | 
            +
                    REJECTED = :rejected
         | 
| 470 | 
            +
             | 
| 471 | 
            +
                    # @!method self.values
         | 
| 472 | 
            +
                    #   @return [Array<Symbol>]
         | 
| 473 | 
            +
                  end
         | 
| 474 | 
            +
             | 
| 475 | 
            +
                  # @see Increase::Models::FednowTransfer#submission
         | 
| 476 | 
            +
                  class Submission < Increase::Internal::Type::BaseModel
         | 
| 477 | 
            +
                    # @!attribute message_identification
         | 
| 478 | 
            +
                    #   The FedNow network identification of the message submitted.
         | 
| 479 | 
            +
                    #
         | 
| 480 | 
            +
                    #   @return [String]
         | 
| 481 | 
            +
                    required :message_identification, String
         | 
| 482 | 
            +
             | 
| 483 | 
            +
                    # @!attribute submitted_at
         | 
| 484 | 
            +
                    #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
         | 
| 485 | 
            +
                    #   the transfer was submitted to FedNow.
         | 
| 486 | 
            +
                    #
         | 
| 487 | 
            +
                    #   @return [Time, nil]
         | 
| 488 | 
            +
                    required :submitted_at, Time, nil?: true
         | 
| 489 | 
            +
             | 
| 490 | 
            +
                    # @!method initialize(message_identification:, submitted_at:)
         | 
| 491 | 
            +
                    #   Some parameter documentations has been truncated, see
         | 
| 492 | 
            +
                    #   {Increase::Models::FednowTransfer::Submission} for more details.
         | 
| 493 | 
            +
                    #
         | 
| 494 | 
            +
                    #   After the transfer is submitted to FedNow, this will contain supplemental
         | 
| 495 | 
            +
                    #   details.
         | 
| 496 | 
            +
                    #
         | 
| 497 | 
            +
                    #   @param message_identification [String] The FedNow network identification of the message submitted.
         | 
| 498 | 
            +
                    #
         | 
| 499 | 
            +
                    #   @param submitted_at [Time, nil] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
         | 
| 500 | 
            +
                  end
         | 
| 501 | 
            +
             | 
| 502 | 
            +
                  # A constant representing the object's type. For this resource it will always be
         | 
| 503 | 
            +
                  # `fednow_transfer`.
         | 
| 504 | 
            +
                  #
         | 
| 505 | 
            +
                  # @see Increase::Models::FednowTransfer#type
         | 
| 506 | 
            +
                  module Type
         | 
| 507 | 
            +
                    extend Increase::Internal::Type::Enum
         | 
| 508 | 
            +
             | 
| 509 | 
            +
                    FEDNOW_TRANSFER = :fednow_transfer
         | 
| 510 | 
            +
             | 
| 511 | 
            +
                    # @!method self.values
         | 
| 512 | 
            +
                    #   @return [Array<Symbol>]
         | 
| 513 | 
            +
                  end
         | 
| 514 | 
            +
                end
         | 
| 515 | 
            +
              end
         | 
| 516 | 
            +
            end
         | 
| @@ -0,0 +1,14 @@ | |
| 1 | 
            +
            # frozen_string_literal: true
         | 
| 2 | 
            +
             | 
| 3 | 
            +
            module Increase
         | 
| 4 | 
            +
              module Models
         | 
| 5 | 
            +
                # @see Increase::Resources::FednowTransfers#approve
         | 
| 6 | 
            +
                class FednowTransferApproveParams < Increase::Internal::Type::BaseModel
         | 
| 7 | 
            +
                  extend Increase::Internal::Type::RequestParameters::Converter
         | 
| 8 | 
            +
                  include Increase::Internal::Type::RequestParameters
         | 
| 9 | 
            +
             | 
| 10 | 
            +
                  # @!method initialize(request_options: {})
         | 
| 11 | 
            +
                  #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
         | 
| 12 | 
            +
                end
         | 
| 13 | 
            +
              end
         | 
| 14 | 
            +
            end
         | 
| @@ -0,0 +1,14 @@ | |
| 1 | 
            +
            # frozen_string_literal: true
         | 
| 2 | 
            +
             | 
| 3 | 
            +
            module Increase
         | 
| 4 | 
            +
              module Models
         | 
| 5 | 
            +
                # @see Increase::Resources::FednowTransfers#cancel
         | 
| 6 | 
            +
                class FednowTransferCancelParams < Increase::Internal::Type::BaseModel
         | 
| 7 | 
            +
                  extend Increase::Internal::Type::RequestParameters::Converter
         | 
| 8 | 
            +
                  include Increase::Internal::Type::RequestParameters
         | 
| 9 | 
            +
             | 
| 10 | 
            +
                  # @!method initialize(request_options: {})
         | 
| 11 | 
            +
                  #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
         | 
| 12 | 
            +
                end
         | 
| 13 | 
            +
              end
         | 
| 14 | 
            +
            end
         |