Class: Zavudev::Models::DataExport

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/zavudev/models/data_export.rb,
sig/zavudev/models/data_export.rbs

Overview

See Also:

  • Zavudev::Resources::Exports#list

Defined Under Namespace

Modules: DataType, Status

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, meta_info, new_coerce_state, 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:, created_at:, data_types:, expires_at:, status:, completed_at: nil, date_from: nil, date_to: nil, download_url: nil, error_message: nil, file_size: nil) ⇒ Object

Parameters:

  • id (String)
  • created_at (Time)
  • data_types (Array<Symbol, Zavudev::Models::DataExport::DataType>)
  • expires_at (Time) —

    When the export download link expires (24 hours after creation).

  • status (Symbol, Zavudev::Models::DataExport::Status) —

    Status of a data export job.

  • completed_at (Time, nil) (defaults to: nil)
  • date_from (Time, nil) (defaults to: nil)
  • date_to (Time, nil) (defaults to: nil)
  • download_url (String, nil) (defaults to: nil) —

    URL to download the export file. Only available when status is 'completed'.

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

    Error message if the export failed.

  • file_size (Integer, nil) (defaults to: nil) —

    Size of the export file in bytes.




# File 'lib/zavudev/models/data_export.rb', line 69

Instance Attribute Details

#completed_at ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


39
 
# File 'lib/zavudev/models/data_export.rb', line 39

optional :completed_at, Time, api_name: :completedAt, nil?: true

#created_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


15
 
# File 'lib/zavudev/models/data_export.rb', line 15

required :created_at, Time, api_name: :createdAt

#data_types ⇒ Array<Symbol, Zavudev::Models::DataExport::DataType>

Parameters:

  • value (::Array[Zavudev::Models::DataExport::data_type])

Returns:



20
21
22
 
# File 'lib/zavudev/models/data_export.rb', line 20

required :data_types,
-> { Zavudev::Internal::Type::ArrayOf[enum: Zavudev::DataExport::DataType] },
api_name: :dataTypes

#date_from ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


44
 
# File 'lib/zavudev/models/data_export.rb', line 44

optional :date_from, Time, api_name: :dateFrom, nil?: true

#date_to ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


49
 
# File 'lib/zavudev/models/data_export.rb', line 49

optional :date_to, Time, api_name: :dateTo, nil?: true

#download_url ⇒ String?

URL to download the export file. Only available when status is 'completed'.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


55
 
# File 'lib/zavudev/models/data_export.rb', line 55

optional :download_url, String, api_name: :downloadUrl, nil?: true

#error_message ⇒ String?

Error message if the export failed.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


61
 
# File 'lib/zavudev/models/data_export.rb', line 61

optional :error_message, String, api_name: :errorMessage, nil?: true

#expires_at ⇒ Time

When the export download link expires (24 hours after creation).

Parameters:

  • value (Time)

Returns:

  • (Time) 


28
 
# File 'lib/zavudev/models/data_export.rb', line 28

required :expires_at, Time, api_name: :expiresAt

#file_size ⇒ Integer?

Size of the export file in bytes.

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


67
 
# File 'lib/zavudev/models/data_export.rb', line 67

optional :file_size, Integer, api_name: :fileSize, nil?: true

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


10
 
# File 'lib/zavudev/models/data_export.rb', line 10

required :id, String

#status ⇒ Symbol, Zavudev::Models::DataExport::Status

Status of a data export job.

Parameters:

  • value (Zavudev::Models::DataExport::status)

Returns:



34
 
# File 'lib/zavudev/models/data_export.rb', line 34

required :status, enum: -> { Zavudev::DataExport::Status }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/zavudev/models/data_export.rb', line 102

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


55
 
# File 'sig/zavudev/models/data_export.rbs', line 55

def to_hash: -> {