Class: Increase::Models::CheckTransferCreateParams::PhysicalCheck

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/check_transfer_create_params.rb,
sig/increase/models/check_transfer_create_params.rbs

Defined Under Namespace

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

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

Details for where the courier will return the check to if it is unable to be delivered. Defaults to an Increase-owned address that will mark checks as delivery failed and shred them.

Parameters:

  • city (String) —

    The city of the return address.

  • line1 (String) —

    The first line of the return address.

  • name (String) —

    The name of the return address.

  • postal_code (String) —

    The postal code of the return address.

  • state (String) —

    The US state of the return address.

  • line2 (String) (defaults to: nil) —

    The second line of the return address.

  • phone (String) (defaults to: nil) —

    The phone number to associate with the shipper. The phone number is only used when shipping_method is fedex_overnight and will be supplied to FedEx to be used in case of delivery issues.




# File 'lib/increase/models/check_transfer_create_params.rb', line 239

Instance Attribute Details

#attachment_file_id ⇒ String?

The ID of a File to be attached to the check. This must have purpose: check_attachment. For details on pricing and restrictions, see https://increase.com/documentation/originating-checks#printing-checks .

Parameters:

  • (String)

Returns:

  • (String, nil) 


187
 
# File 'lib/increase/models/check_transfer_create_params.rb', line 187

optional :attachment_file_id, String

#check_voucher_image_file_id ⇒ String?

The ID of a File to be used as the check voucher image. This must have purpose: check_voucher_image. For details on pricing and restrictions, see https://increase.com/documentation/originating-checks#printing-checks .

Parameters:

  • (String)

Returns:

  • (String, nil) 


195
 
# File 'lib/increase/models/check_transfer_create_params.rb', line 195

optional :check_voucher_image_file_id, String

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

Details for where Increase will mail the check. When physical_check_batch_id is set, the address must match the Physical Check Batch.

Parameters:

  • value (Increase::CheckTransferCreateParams::PhysicalCheck::MailingAddress)

Returns:



158
 
# File 'lib/increase/models/check_transfer_create_params.rb', line 158

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

#memo ⇒ String

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

Parameters:

  • value (String)

Returns:

  • (String) 


164
 
# File 'lib/increase/models/check_transfer_create_params.rb', line 164

required :memo, String

#note ⇒ String?

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

Parameters:

  • (String)

Returns:

  • (String, nil) 


201
 
# File 'lib/increase/models/check_transfer_create_params.rb', line 201

optional :note, String

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

The payer of the check. This will be printed on the top-left portion of the check. This should be an array of up to 4 elements, each of which represents a line of the payer.

Parameters:

  • value (::Array[Increase::CheckTransferCreateParams::PhysicalCheck::Payer])

Returns:



172
173
 
# File 'lib/increase/models/check_transfer_create_params.rb', line 172

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

#physical_check_batch_id ⇒ String?

The identifier of the Physical Check Batch to mail this check as a part of.

Parameters:

  • (String)

Returns:

  • (String, nil) 


207
 
# File 'lib/increase/models/check_transfer_create_params.rb', line 207

optional :physical_check_batch_id, String

#recipient_name ⇒ String

The name that will be printed on the check in the 'To:' field.

Parameters:

  • value (String)

Returns:

  • (String) 


179
 
# File 'lib/increase/models/check_transfer_create_params.rb', line 179

required :recipient_name, String

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

Details for where the courier will return the check to if it is unable to be delivered. Defaults to an Increase-owned address that will mark checks as delivery failed and shred them.

Returns:



215
 
# File 'lib/increase/models/check_transfer_create_params.rb', line 215

optional :return_address, -> { Increase::CheckTransferCreateParams::PhysicalCheck::ReturnAddress }

#return_address_name ⇒ String?

A custom name to print above the default return address. Cannot be provided together with return_address.

Parameters:

  • (String)

Returns:

  • (String, nil) 


222
 
# File 'lib/increase/models/check_transfer_create_params.rb', line 222

optional :return_address_name, String

#shipping_method ⇒ Symbol, ...

How to ship the check. For details on pricing, timing, and restrictions, see https://increase.com/documentation/originating-checks#printing-checks .

Returns:



229
 
# File 'lib/increase/models/check_transfer_create_params.rb', line 229

optional :shipping_method, enum: -> { Increase::CheckTransferCreateParams::PhysicalCheck::ShippingMethod }

#signature ⇒ Increase::Models::CheckTransferCreateParams::PhysicalCheck::Signature?

The signature that will appear on the check. If not provided, the check will be printed with 'No Signature Required'. At most one of text and image_file_id may be provided.

Returns:



237
 
# File 'lib/increase/models/check_transfer_create_params.rb', line 237

optional :signature, -> { Increase::CheckTransferCreateParams::PhysicalCheck::Signature }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/check_transfer_create_params.rb', line 454

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


194
 
# File 'sig/increase/models/check_transfer_create_params.rbs', line 194

def to_hash: -> {