Class: Increase::Models::File

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

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseModel

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

Instance Attribute Details

#created_at ⇒ String

The time the File was created.

Returns:

  • (String) 


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

required :created_at, String

#description ⇒ String

A description of the File.

Returns:

  • (String) 


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

required :description, String

#direction ⇒ Symbol

Whether the File was generated by Increase or by you and sent to Increase.

Returns:

  • (Symbol) 


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

required :direction, Increase::Enum.new(:to_increase, :from_increase)

#download_url ⇒ String

A URL from where the File can be downloaded at this point in time. The location of this URL may change over time.

Returns:

  • (String) 


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

required :download_url, String

#filename ⇒ String

The filename that was provided upon upload or generated by Increase.

Returns:

  • (String) 


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

required :filename, String

#id ⇒ String

The File's identifier.

Returns:

  • (String) 


9
 
# File 'lib/increase/models/file.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) 


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

required :idempotency_key, String

#mime_type ⇒ String

The MIME type of the file.

Returns:

  • (String) 


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

required :mime_type, String

#purpose ⇒ Symbol

What the File will be used for. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.

Returns:

  • (Symbol) 


49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/increase/models/file.rb', line 49

required :purpose,
Increase::Enum.new(
  :check_image_front,
  :check_image_back,
  :processed_check_image_front,
  :processed_check_image_back,
  :mailed_check_image,
  :inbound_mail_item,
  :form_1099_int,
  :form_ss_4,
  :identity_document,
  :increase_statement,
  :other,
  :trust_formation_document,
  :digital_wallet_artwork,
  :digital_wallet_app_icon,
  :physical_card_front,
  :physical_card_back,
  :physical_card_carrier,
  :document_request,
  :entity_supplemental_document,
  :export,
  :unusual_activity_report_attachment,
  :deposit_account_control_agreement
)

#type ⇒ Symbol

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

Returns:

  • (Symbol) 


78
 
# File 'lib/increase/models/file.rb', line 78

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