Class: Increase::Models::Lockbox

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

Defined Under Namespace

Classes: Address

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseModel

#[], #inspect, #to_h, #to_s

Instance Attribute Details

#account_id ⇒ String

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

Returns:

  • (String) 


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

required :account_id, String

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

The mailing address for the Lockbox.

Returns:



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

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

#created_at ⇒ String

The ISO 8601 time at which the Lockbox was created.

Returns:

  • (String) 


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

required :created_at, String

#description ⇒ String

The description you choose for the Lockbox.

Returns:

  • (String) 


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

required :description, String

#id ⇒ String

The Lockbox identifier.

Returns:

  • (String) 


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

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.

Returns:

  • (String) 


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

required :idempotency_key, String

#status ⇒ Symbol

This indicates if mail can be sent to this address.

Returns:

  • (Symbol) 


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

required :status, Increase::Enum.new(:active, :inactive)

#type ⇒ Symbol

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

Returns:

  • (Symbol) 


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

required :type, Increase::Enum.new(:lockbox)