Class: Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync

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

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(status:, task_id:) ⇒ Object

Asynchronous research response (when background is true).

Parameters:




# File 'lib/telnyx/models/web_search/research_create_response.rb', line 64

Instance Attribute Details

#status ⇒ Symbol, Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync::Status

Current status of the research task.

Parameters:

  • value (Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync::status)

Returns:



55
56
 
# File 'lib/telnyx/models/web_search/research_create_response.rb', line 55

required :status,
enum: -> { Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync::Status }

#task_id ⇒ String

Unique identifier for the research task. Use this to poll the status.

Parameters:

  • value (String)

Returns:

  • (String) 


62
 
# File 'lib/telnyx/models/web_search/research_create_response.rb', line 62

required :task_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


71
 
# File 'sig/telnyx/models/web_search/research_create_response.rbs', line 71

def to_hash: -> {