Class: Increase::Models::CheckTransfer::PhysicalCheck

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

Overview

See Also:

Defined Under Namespace

Modules: ShippingMethod Classes: MailingAddress, Payer, ReturnAddress, TrackingUpdate

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(city:, line1:, line2:, name:, phone:, postal_code:, state:) ⇒ Object

Some parameter documentations has been truncated, see ReturnAddress for more details.

The return address to be printed on the check.

Parameters:

  • city (String, nil) —

    The city of the check’s destination.

  • line1 (String, nil) —

    The street address of the check’s destination.

  • line2 (String, nil) —

    The second line of the address of the check’s destination.

  • name (String, nil) —

    The name component of the check’s return address.

  • phone (String, nil) —

    The shipper’s phone number to be used in case of delivery issues. Only used for

  • postal_code (String, nil) —

    The postal code of the check’s destination.

  • state (String, nil) —

    The state of the check’s destination.




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

Instance Attribute Details

#attachment_file_id ⇒ String?

The ID of the file for the check attachment.

Returns:

  • (String, nil) 


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

required :attachment_file_id, String, nil?: true

#check_voucher_image_file_id ⇒ String?

The ID of the file for the check voucher image.

Returns:

  • (String, nil) 


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

required :check_voucher_image_file_id, String, nil?: true

#mailing_address ⇒ Increase::Models::CheckTransfer::PhysicalCheck::MailingAddress

Details for where Increase will mail the check.

Returns:



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

required :mailing_address, -> { Increase::CheckTransfer::PhysicalCheck::MailingAddress }

#memo ⇒ String?

The descriptor that will be printed on the memo field on the check.

Returns:

  • (String, nil) 


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

required :memo, String, nil?: true

#note ⇒ String?

The descriptor that will be printed on the letter included with the check.

Returns:

  • (String, nil) 


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

required :note, String, nil?: true

#payer ⇒ Array<Increase::Models::CheckTransfer::PhysicalCheck::Payer>

The payer of the check. This will be printed on the top-left portion of the check and defaults to the return address if unspecified.

Returns:



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

required :payer, -> { Increase::Internal::Type::ArrayOf[Increase::CheckTransfer::PhysicalCheck::Payer] }

#recipient_name ⇒ String

The name that will be printed on the check.

Returns:

  • (String) 


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

required :recipient_name, String

#return_address ⇒ Increase::Models::CheckTransfer::PhysicalCheck::ReturnAddress?

The return address to be printed on the check.

Returns:



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

required :return_address, -> { Increase::CheckTransfer::PhysicalCheck::ReturnAddress }, nil?: true

#shipping_method ⇒ Symbol, ...

The shipping method for the check.

Returns:



508
509
510
511
512
 
# File 'lib/increase/models/check_transfer.rb', line 508

required :shipping_method,
enum: -> {
  Increase::CheckTransfer::PhysicalCheck::ShippingMethod
},
nil?: true

#signature_text ⇒ String?

The text that will appear as the signature on the check in cursive font. If blank, the check will be printed with ‘No signature required’.

Returns:

  • (String, nil) 


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

required :signature_text, String, nil?: true

#tracking_updates ⇒ Array<Increase::Models::CheckTransfer::PhysicalCheck::TrackingUpdate>

Tracking updates relating to the physical check’s delivery.

Returns:



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

required :tracking_updates,
-> { Increase::Internal::Type::ArrayOf[Increase::CheckTransfer::PhysicalCheck::TrackingUpdate] }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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