Class: Increase::Models::Export

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

Overview

See Also:

Defined Under Namespace

Modules: Category, Status, Type

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id: , category: , created_at: , file_download_url: , file_id: , idempotency_key: , status: , type: ) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::Export for more details.

Exports are batch summaries of your Increase data. You can make them from the API or dashboard. Since they can take a while, they are generated asynchronously. We send a webhook when they are ready. For more information, please read our [Exports documentation](increase.com/documentation/exports).

Parameters:

  • id (String) (defaults to: ) —

    The Export identifier.

  • category (Symbol, Increase::Models::Export::Category) (defaults to: ) —

    The category of the Export. We may add additional possible values for this enum

  • created_at (Time) (defaults to: ) —

    The time the Export was created.

  • file_download_url (String, nil) (defaults to: ) —

    A URL at which the Export’s file can be downloaded. This will be present when th

  • file_id (String, nil) (defaults to: ) —

    The File containing the contents of the Export. This will be present when the Ex

  • idempotency_key (String, nil) (defaults to: ) —

    The idempotency key you chose for this object. This value is unique across Incre

  • status (Symbol, Increase::Models::Export::Status) (defaults to: ) —

    The status of the Export.

  • type (Symbol, Increase::Models::Export::Type) (defaults to: ) —

    A constant representing the object’s type. For this resource it will always be ‘




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

Instance Attribute Details

#category ⇒ Symbol, Increase::Models::Export::Category

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:



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

required :category, enum: -> { Increase::Export::Category }

#created_at ⇒ Time

The time the Export was created.

Returns:

  • (Time) 


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

required :created_at, Time

#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, nil) 


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

required :file_download_url, String, nil?: true

#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, nil) 


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

required :file_id, String, nil?: true

#id ⇒ String

The Export identifier.

Returns:

  • (String) 


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

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](increase.com/documentation/idempotency-keys).

Returns:

  • (String, nil) 


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

required :idempotency_key, String, nil?: true

#status ⇒ Symbol, Increase::Models::Export::Status

The status of the Export.

Returns:



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

required :status, enum: -> { Increase::Export::Status }

#type ⇒ Symbol, Increase::Models::Export::Type

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

Returns:



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

required :type, enum: -> { Increase::Export::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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