Class: Increase::Models::CheckTransfer::Submission

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

Overview

See Also:

Defined Under Namespace

Modules: AddressCorrectionAction Classes: SubmittedAddress

Instance Attribute Summary collapse

Class Method 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(address_correction_action: , submitted_address: , submitted_at: ) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::CheckTransfer::Submission for more details.

After the transfer is submitted, this will contain supplemental details.

Parameters:




# File 'lib/increase/models/check_transfer.rb', line 898

Instance Attribute Details

#address_correction_action ⇒ Symbol, Increase::Models::CheckTransfer::Submission::AddressCorrectionAction

Per USPS requirements, Increase will standardize the address to USPS standards and check it against the USPS National Change of Address (NCOA) database before mailing it. This indicates what modifications, if any, were made to the address before printing and mailing the check.

Returns:



882
883
 
# File 'lib/increase/models/check_transfer.rb', line 882

required :address_correction_action,
enum: -> { Increase::CheckTransfer::Submission::AddressCorrectionAction }

#submitted_address ⇒ Increase::Models::CheckTransfer::Submission::SubmittedAddress

The address we submitted to the printer. This is what is physically printed on the check.

Returns:



890
 
# File 'lib/increase/models/check_transfer.rb', line 890

required :submitted_address, -> { Increase::CheckTransfer::Submission::SubmittedAddress }

#submitted_at ⇒ Time

When this check transfer was submitted to our check printer.

Returns:

  • (Time) 


896
 
# File 'lib/increase/models/check_transfer.rb', line 896

required :submitted_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/check_transfer.rb', line 931