Class: Increase::Models::Export

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

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseModel

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

Instance Attribute Details

#category ⇒ Symbol

The category of the Export. We may add additional possible values for this enum over time; your application should be able to handle that gracefully.

Returns:

  • (Symbol) 


14
15
16
17
18
19
20
21
22
 
# File 'lib/increase/models/export.rb', line 14

required :category,
Increase::Enum.new(
  :account_statement_ofx,
  :transaction_csv,
  :balance_csv,
  :bookkeeping_account_balance_csv,
  :entity_csv,
  :vendor_csv
)

#created_at ⇒ String

The time the Export was created.

Returns:

  • (String) 


27
 
# File 'lib/increase/models/export.rb', line 27

required :created_at, String

#file_download_url ⇒ String

A URL at which the Export's file can be downloaded. This will be present when the Export's status transitions to complete.

Returns:

  • (String) 


32
 
# File 'lib/increase/models/export.rb', line 32

required :file_download_url, String

#file_id ⇒ String

The File containing the contents of the Export. This will be present when the Export's status transitions to complete.

Returns:

  • (String) 


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

required :file_id, String

#id ⇒ String

The Export identifier.

Returns:

  • (String) 


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


42
 
# File 'lib/increase/models/export.rb', line 42

required :idempotency_key, String

#status ⇒ Symbol

The status of the Export.

Returns:

  • (Symbol) 


47
 
# File 'lib/increase/models/export.rb', line 47

required :status, Increase::Enum.new(:pending, :complete, :failed)

#type ⇒ Symbol

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

Returns:

  • (Symbol) 


52
 
# File 'lib/increase/models/export.rb', line 52

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