Class: Telnyx::Models::PhoneNumbers::CsvDownload

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/phone_numbers/csv_download.rb,
sig/telnyx/models/phone_numbers/csv_download.rbs

Overview

See Also:

  • Telnyx::Resources::PhoneNumbers::CsvDownloads#list

Defined Under Namespace

Modules: Status

Instance Attribute 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: nil, record_type: nil, status: nil, url: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::PhoneNumbers::CsvDownload for more details.

Parameters:

  • id (String) (defaults to: nil) —

    Identifies the resource.

  • record_type (String) (defaults to: nil) —

    Identifies the type of the resource.

  • status (Symbol, Telnyx::Models::PhoneNumbers::CsvDownload::Status) (defaults to: nil) —

    Indicates the completion level of the CSV report. Only complete CSV download req

  • url (String) (defaults to: nil) —

    The URL at which the CSV file can be retrieved.




# File 'lib/telnyx/models/phone_numbers/csv_download.rb', line 35

Instance Attribute Details

#id ⇒ String? (readonly)

Returns the value of attribute id.

Returns:

  • (String, nil) 


23
24
25
 
# File 'sig/telnyx/models/phone_numbers/csv_download.rbs', line 23

def id
  @id
end

#record_type ⇒ String? (readonly)

Returns the value of attribute record_type.

Returns:

  • (String, nil) 


27
28
29
 
# File 'sig/telnyx/models/phone_numbers/csv_download.rbs', line 27

def record_type
  @record_type
end

#status ⇒ Symbol, ...

Indicates the completion level of the CSV report. Only complete CSV download requests will be able to be retrieved.

Returns:



13
 
# File 'lib/telnyx/models/phone_numbers/csv_download.rb', line 13

optional :status, enum: -> { Telnyx::PhoneNumbers::CsvDownload::Status }

#url ⇒ String?

The URL at which the CSV file can be retrieved.

Parameters:

  • (String)

Returns:

  • (String, nil) 


19
 
# File 'lib/telnyx/models/phone_numbers/csv_download.rb', line 19

optional :url, String

Instance Method Details

#id= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


25
 
# File 'sig/telnyx/models/phone_numbers/csv_download.rbs', line 25

def id=: (String) -> String

#record_type= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


29
 
# File 'sig/telnyx/models/phone_numbers/csv_download.rbs', line 29

def record_type=: (String) -> String

#to_hash ⇒ {

Returns:

  • ({) 


38
 
# File 'sig/telnyx/models/phone_numbers/csv_download.rbs', line 38

def to_hash: -> {