Class: Increase::Models::Lockbox

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

Overview

See Also:

Defined Under Namespace

Modules: CheckDepositBehavior, Type Classes: Address

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: , postal_code: , recipient: , state: ) ⇒ Object

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

The mailing address for the Lockbox.

Parameters:

  • city (String) (defaults to: ) —

    The city of the address.

  • line1 (String) (defaults to: ) —

    The first line of the address.

  • line2 (String) (defaults to: ) —

    The second line of the address.

  • postal_code (String) (defaults to: ) —

    The postal code of the address.

  • recipient (String, nil) (defaults to: ) —

    The recipient line of the address. This will include the recipient name you prov

  • state (String) (defaults to: ) —

    The two-letter United States Postal Service (USPS) abbreviation for the state of




# File 'lib/increase/models/lockbox.rb', line 66

Instance Attribute Details

#account_id ⇒ String

The identifier for the Account checks sent to this lockbox will be deposited into.

Returns:

  • (String) 


18
 
# File 'lib/increase/models/lockbox.rb', line 18

required :account_id, String

#address ⇒ Increase::Models::Lockbox::Address

The mailing address for the Lockbox.

Returns:



24
 
# File 'lib/increase/models/lockbox.rb', line 24

required :address, -> { Increase::Lockbox::Address }

#check_deposit_behavior ⇒ Symbol, Increase::Models::Lockbox::CheckDepositBehavior

Indicates if checks mailed to this lockbox will be deposited.

Returns:



30
 
# File 'lib/increase/models/lockbox.rb', line 30

required :check_deposit_behavior, enum: -> { Increase::Lockbox::CheckDepositBehavior }

#created_at ⇒ Time

The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox was created.

Returns:

  • (Time) 


37
 
# File 'lib/increase/models/lockbox.rb', line 37

required :created_at, Time

#description ⇒ String?

The description you choose for the Lockbox.

Returns:

  • (String, nil) 


43
 
# File 'lib/increase/models/lockbox.rb', line 43

required :description, String, nil?: true

#id ⇒ String

The Lockbox identifier.

Returns:

  • (String) 


11
 
# File 'lib/increase/models/lockbox.rb', line 11

required :id, String

#idempotency_key ⇒ String?

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](increase.com/documentation/idempotency-keys).

Returns:

  • (String, nil) 


51
 
# File 'lib/increase/models/lockbox.rb', line 51

required :idempotency_key, String, nil?: true

#recipient_name ⇒ String?

The recipient name you choose for the Lockbox.

Returns:

  • (String, nil) 


57
 
# File 'lib/increase/models/lockbox.rb', line 57

required :recipient_name, String, nil?: true

#type ⇒ Symbol, Increase::Models::Lockbox::Type

A constant representing the object’s type. For this resource it will always be ‘lockbox`.

Returns:



64
 
# File 'lib/increase/models/lockbox.rb', line 64

required :type, enum: -> { Increase::Lockbox::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/lockbox.rb', line 167