Class: Increase::Models::InboundCheckDeposit::Adjustment

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/inbound_check_deposit.rb

Defined Under Namespace

Modules: Reason

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(adjusted_at: , amount: , reason: , transaction_id: ) ⇒ Object

Parameters:

  • adjusted_at (Time) (defaults to: ) —

    The time at which the return adjustment was received.

  • amount (Integer) (defaults to: ) —

    The amount of the adjustment.

  • reason (Symbol, Increase::Models::InboundCheckDeposit::Adjustment::Reason) (defaults to: ) —

    The reason for the adjustment.

  • transaction_id (String) (defaults to: ) —

    The id of the transaction for the adjustment.



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/increase/models/inbound_check_deposit.rb', line 188

class Adjustment < Increase::Internal::Type::BaseModel
  # @!attribute adjusted_at
  #   The time at which the return adjustment was received.
  #
  #   @return [Time]
  required :adjusted_at, Time

  # @!attribute amount
  #   The amount of the adjustment.
  #
  #   @return [Integer]
  required :amount, Integer

  # @!attribute reason
  #   The reason for the adjustment.
  #
  #   @return [Symbol, Increase::Models::InboundCheckDeposit::Adjustment::Reason]
  required :reason, enum: -> { Increase::InboundCheckDeposit::Adjustment::Reason }

  # @!attribute transaction_id
  #   The id of the transaction for the adjustment.
  #
  #   @return [String]
  required :transaction_id, String

  # @!method initialize(adjusted_at:, amount:, reason:, transaction_id:)
  #   @param adjusted_at [Time] The time at which the return adjustment was received.
  #
  #   @param amount [Integer] The amount of the adjustment.
  #
  #   @param reason [Symbol, Increase::Models::InboundCheckDeposit::Adjustment::Reason] The reason for the adjustment.
  #
  #   @param transaction_id [String] The id of the transaction for the adjustment.

  # The reason for the adjustment.
  #
  # @see Increase::Models::InboundCheckDeposit::Adjustment#reason
  module Reason
    extend Increase::Internal::Type::Enum

    # The return was initiated too late and the receiving institution has responded with a Late Return Claim.
    LATE_RETURN = :late_return

    # The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit.
    WRONG_PAYEE_CREDIT = :wrong_payee_credit

    # The check was deposited with a different amount than what was written on the check.
    ADJUSTED_AMOUNT = :adjusted_amount

    # The recipient was not able to process the check. This usually happens for e.g., low quality images.
    NON_CONFORMING_ITEM = :non_conforming_item

    # The check has already been deposited elsewhere and so this is a duplicate.
    PAID = :paid

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#adjusted_at ⇒ Time

The time at which the return adjustment was received.

Returns:

  • (Time) 


193
 
# File 'lib/increase/models/inbound_check_deposit.rb', line 193

required :adjusted_at, Time

#amount ⇒ Integer

The amount of the adjustment.

Returns:

  • (Integer) 


199
 
# File 'lib/increase/models/inbound_check_deposit.rb', line 199

required :amount, Integer

#reason ⇒ Symbol, Increase::Models::InboundCheckDeposit::Adjustment::Reason

The reason for the adjustment.

Returns:



205
 
# File 'lib/increase/models/inbound_check_deposit.rb', line 205

required :reason, enum: -> { Increase::InboundCheckDeposit::Adjustment::Reason }

#transaction_id ⇒ String

The id of the transaction for the adjustment.

Returns:

  • (String) 


211
 
# File 'lib/increase/models/inbound_check_deposit.rb', line 211

required :transaction_id, String