Class: Increase::Models::Document

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

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseModel

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

Instance Attribute Details

#category ⇒ Symbol

The type of document.

Returns:

  • (Symbol) 


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

required :category, Increase::Enum.new(:form_1099_int, :proof_of_authorization, :company_information)

#created_at ⇒ String

The ISO 8601 time at which the Document was created.

Returns:

  • (String) 


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

required :created_at, String

#entity_id ⇒ String

The identifier of the Entity the document was generated for.

Returns:

  • (String) 


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

required :entity_id, String

#file_id ⇒ String

The identifier of the File containing the Document's contents.

Returns:

  • (String) 


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

required :file_id, String

#id ⇒ String

The Document identifier.

Returns:

  • (String) 


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

required :id, String

#type ⇒ Symbol

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

Returns:

  • (Symbol) 


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

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