Class: Increase::Models::EntitySupplementalDocument

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/increase/models/entity_supplemental_document.rb

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseModel

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

Instance Attribute Details

#created_at ⇒ String

The ISO 8601 time at which the Supplemental Document was created.

Returns:

  • (String) 


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

required :created_at, String

#entity_id ⇒ String

The Entity the supplemental document is attached to.

Returns:

  • (String) 


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

required :entity_id, String

#file_id ⇒ String

The File containing the document.

Returns:

  • (String) 


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

required :file_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) 


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

required :idempotency_key, String

#type ⇒ Symbol

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

Returns:

  • (Symbol) 


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

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