Class: Revox::Models::CallRetrieveResponse::Call

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Revox::Models::CallRetrieveResponse::Call

Defined in:

lib/revox/models/call_retrieve_response.rb,
sig/revox/models/call_retrieve_response.rbs

Overview

See Also:

• Revox::Models::CallRetrieveResponse#call

Defined Under Namespace

Modules: Direction, LlmModel, Outcome, Status Classes: Assignee, Assistant, CallAttempt, CallRetryConfig, Campaign, Contact, LastCallAttempt

Instance Attribute Summary

• #assignee ⇒ Revox::Models::CallRetrieveResponse::Call::Assignee^?

  The team member responsible for following up on this call.

• #assistant ⇒ Revox::Models::CallRetrieveResponse::Call::Assistant^?
• #call_attempts ⇒ Array<Revox::Models::CallRetrieveResponse::Call::CallAttempt>

  All call attempts for this call order, ordered by most recent first.

• #call_retry_config ⇒ Revox::Models::CallRetrieveResponse::Call::CallRetryConfig^?

  Configuration for call retry behavior including time windows, delays, and max iterations.

• #calls_count ⇒ Float

  The number of call attempts made.

• #campaign ⇒ Revox::Models::CallRetrieveResponse::Call::Campaign^?
• #contact ⇒ Revox::Models::CallRetrieveResponse::Call::Contact

  Magic contact variables (prospect identity) extracted from the call's input data and transcript.

• #created_at ⇒ Object

  The time the call order was created.

• #direction ⇒ Symbol, Revox::Models::CallRetrieveResponse::Call::Direction

  Whether the call is inbound or outbound.

• #first_sentence_delay_ms ⇒ Integer

  Delay in milliseconds before speaking the first sentence.

• #from_phone_number ⇒ String

  The phone number that made the call.

• #id ⇒ String

  The ID of the call.

• #is_cancelled ⇒ Boolean

  DEPRECATED: Whether the call has been cancelled.

• #is_completed ⇒ Boolean

  DEPRECATED: Whether the call has completed.

• #last_call_attempt ⇒ Revox::Models::CallRetrieveResponse::Call::LastCallAttempt^?

  This represent a single call attempt.

• #llm_model ⇒ Revox::Models::CallRetrieveResponse::Call::LlmModel::UnionMember0, ...
• #metadata ⇒ Hash{Symbol=>String}^?

  Metadata stored with the call.

• #organization_id ⇒ String

  The ID of the organization that owns the call.

• #outcome ⇒ Symbol, ...

  Business outcome of the call.

• #outcome_summary ⇒ String^?

  LLM explanation for the outcome, when outcome was computed from the transcript.

• #prompt_variables ⇒ Hash{Symbol=>String}^?

  Variables used to interpolate the prompt.

• #scheduled_at ⇒ Object

  The time the call order is scheduled to start.

• #status ⇒ Symbol, Revox::Models::CallRetrieveResponse::Call::Status

  The status of the call.

• #to_phone_number ⇒ String

  The phone number that received the call.

• #updated_at ⇒ Object

  The time the call order was last updated (any state change, retry, or analysis result).

Class Method Summary

• .values ⇒ Array<Symbol>
• .variants ⇒ Array(Revox::Models::CallRetrieveResponse::Call::LlmModel::UnionMember0, Revox::Models::CallRetrieveResponse::Call::LlmModel::UnionMember1, Revox::Models::CallRetrieveResponse::Call::LlmModel::UnionMember2, Revox::Models::CallRetrieveResponse::Call::LlmModel::UnionMember3)

Instance Method Summary

• #initialize(company:, email:, first_name:, last_name:) ⇒ Object constructor

  Magic contact variables (prospect identity) extracted from the call's input data and transcript.

• #to_hash ⇒ {

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(company:, email:, first_name:, last_name:) ⇒ Object

Magic contact variables (prospect identity) extracted from the call's input data and transcript.

Parameters:

• company (String, nil)
• email (String, nil)
• first_name (String, nil)
• last_name (String, nil)

# File 'lib/revox/models/call_retrieve_response.rb', line 178

Instance Attribute Details

#assignee ⇒ Revox::Models::CallRetrieveResponse::Call::Assignee^?

The team member responsible for following up on this call.

Parameters:

• value (Revox::Models::CallRetrieveResponse::Call::Assignee, nil)

Returns:

• (Revox::Models::CallRetrieveResponse::Call::Assignee, nil)

# File 'lib/revox/models/call_retrieve_response.rb', line 32

required :assignee, -> { Revox::Models::CallRetrieveResponse::Call::Assignee }, nil?: true

#assistant ⇒ Revox::Models::CallRetrieveResponse::Call::Assistant^?

Parameters:

• value (Revox::Models::CallRetrieveResponse::Call::Assistant, nil)

Returns:

• (Revox::Models::CallRetrieveResponse::Call::Assistant, nil)

# File 'lib/revox/models/call_retrieve_response.rb', line 37

required :assistant, -> { Revox::Models::CallRetrieveResponse::Call::Assistant }, nil?: true

#call_attempts ⇒ Array<Revox::Models::CallRetrieveResponse::Call::CallAttempt>

All call attempts for this call order, ordered by most recent first.

Parameters:

• value (::Array[Revox::Models::CallRetrieveResponse::Call::CallAttempt])

Returns:

• (Array<Revox::Models::CallRetrieveResponse::Call::CallAttempt>)

# File 'lib/revox/models/call_retrieve_response.rb', line 43

required :call_attempts,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::CallRetrieveResponse::Call::CallAttempt] }

#call_retry_config ⇒ Revox::Models::CallRetrieveResponse::Call::CallRetryConfig^?

Configuration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.

Parameters:

• value (Revox::Models::CallRetrieveResponse::Call::CallRetryConfig, nil)

Returns:

• (Revox::Models::CallRetrieveResponse::Call::CallRetryConfig, nil)

# File 'lib/revox/models/call_retrieve_response.rb', line 51

required :call_retry_config, -> { Revox::Models::CallRetrieveResponse::Call::CallRetryConfig }, nil?: true

#calls_count ⇒ Float

The number of call attempts made.

Parameters:

• value (Float)

Returns:

• (Float)

# File 'lib/revox/models/call_retrieve_response.rb', line 57

required :calls_count, Float

#campaign ⇒ Revox::Models::CallRetrieveResponse::Call::Campaign^?

Parameters:

• value (Revox::Models::CallRetrieveResponse::Call::Campaign, nil)

Returns:

• (Revox::Models::CallRetrieveResponse::Call::Campaign, nil)

# File 'lib/revox/models/call_retrieve_response.rb', line 62

required :campaign, -> { Revox::Models::CallRetrieveResponse::Call::Campaign }, nil?: true

#contact ⇒ Revox::Models::CallRetrieveResponse::Call::Contact

Magic contact variables (prospect identity) extracted from the call's input data and transcript.

Parameters:

• value (Revox::Models::CallRetrieveResponse::Call::Contact)

Returns:

• (Revox::Models::CallRetrieveResponse::Call::Contact)

# File 'lib/revox/models/call_retrieve_response.rb', line 69

required :contact, -> { Revox::Models::CallRetrieveResponse::Call::Contact }

#created_at ⇒ Object

The time the call order was created.

Parameters:

• value (top)

Returns:

• (Object)

# File 'lib/revox/models/call_retrieve_response.rb', line 75

required :created_at, Revox::Internal::Type::Unknown

#direction ⇒ Symbol, Revox::Models::CallRetrieveResponse::Call::Direction

Whether the call is inbound or outbound.

Parameters:

• value (Revox::Models::CallRetrieveResponse::Call::direction)

Returns:

• (Symbol, Revox::Models::CallRetrieveResponse::Call::Direction)

# File 'lib/revox/models/call_retrieve_response.rb', line 81

required :direction, enum: -> { Revox::Models::CallRetrieveResponse::Call::Direction }

#first_sentence_delay_ms ⇒ Integer

Delay in milliseconds before speaking the first sentence. Default: 400.

Parameters:

• value (Integer)

Returns:

• (Integer)

# File 'lib/revox/models/call_retrieve_response.rb', line 87

required :first_sentence_delay_ms, Integer

#from_phone_number ⇒ String

The phone number that made the call. Formatted in E.164 format. Example: +1234567890

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/revox/models/call_retrieve_response.rb', line 94

required :from_phone_number, String

#id ⇒ String

The ID of the call.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/revox/models/call_retrieve_response.rb', line 26

required :id, String

#is_cancelled ⇒ Boolean

DEPRECATED: Whether the call has been cancelled. This is derived from status. Use status instead.

Parameters:

• value (Boolean)

Returns:

• (Boolean)

# File 'lib/revox/models/call_retrieve_response.rb', line 101

required :is_cancelled, Revox::Internal::Type::Boolean

#is_completed ⇒ Boolean

DEPRECATED: Whether the call has completed. This is derived from status. Use status instead.

Parameters:

• value (Boolean)

Returns:

• (Boolean)

# File 'lib/revox/models/call_retrieve_response.rb', line 108

required :is_completed, Revox::Internal::Type::Boolean

#last_call_attempt ⇒ Revox::Models::CallRetrieveResponse::Call::LastCallAttempt^?

This represent a single call attempt. A call attempt is a single call made to the phone number.

Parameters:

• value (Revox::Models::CallRetrieveResponse::Call::LastCallAttempt, nil)

Returns:

• (Revox::Models::CallRetrieveResponse::Call::LastCallAttempt, nil)

# File 'lib/revox/models/call_retrieve_response.rb', line 115

required :last_call_attempt, -> { Revox::Models::CallRetrieveResponse::Call::LastCallAttempt }, nil?: true

#llm_model ⇒ Revox::Models::CallRetrieveResponse::Call::LlmModel::UnionMember0, ...

Parameters:

• value (Revox::Models::CallRetrieveResponse::Call::llm_model)

Returns:

• (Revox::Models::CallRetrieveResponse::Call::LlmModel::UnionMember0, Revox::Models::CallRetrieveResponse::Call::LlmModel::UnionMember1, Revox::Models::CallRetrieveResponse::Call::LlmModel::UnionMember2, Revox::Models::CallRetrieveResponse::Call::LlmModel::UnionMember3)

# File 'lib/revox/models/call_retrieve_response.rb', line 120

required :llm_model, union: -> { Revox::Models::CallRetrieveResponse::Call::LlmModel }

#metadata ⇒ Hash{Symbol=>String}^?

Metadata stored with the call.

Parameters:

• value (::Hash[Symbol, String], nil)

Returns:

• (Hash{Symbol=>String}, nil)

# File 'lib/revox/models/call_retrieve_response.rb', line 126

required :metadata, Revox::Internal::Type::HashOf[String], nil?: true

#organization_id ⇒ String

The ID of the organization that owns the call.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/revox/models/call_retrieve_response.rb', line 132

required :organization_id, String

#outcome ⇒ Symbol, ...

Business outcome of the call. Null if not computed or no transcript.

Parameters:

• value (Revox::Models::CallRetrieveResponse::Call::outcome, nil)

Returns:

• (Symbol, Revox::Models::CallRetrieveResponse::Call::Outcome, nil)

# File 'lib/revox/models/call_retrieve_response.rb', line 170

optional :outcome, enum: -> { Revox::Models::CallRetrieveResponse::Call::Outcome }, nil?: true

#outcome_summary ⇒ String^?

LLM explanation for the outcome, when outcome was computed from the transcript.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/revox/models/call_retrieve_response.rb', line 176

optional :outcome_summary, String, nil?: true

#prompt_variables ⇒ Hash{Symbol=>String}^?

Variables used to interpolate the prompt.

Parameters:

• value (::Hash[Symbol, String], nil)

Returns:

• (Hash{Symbol=>String}, nil)

# File 'lib/revox/models/call_retrieve_response.rb', line 138

required :prompt_variables, Revox::Internal::Type::HashOf[String], nil?: true

#scheduled_at ⇒ Object

The time the call order is scheduled to start.

Parameters:

• value (top)

Returns:

• (Object)

# File 'lib/revox/models/call_retrieve_response.rb', line 144

required :scheduled_at, Revox::Internal::Type::Unknown

#status ⇒ Symbol, Revox::Models::CallRetrieveResponse::Call::Status

The status of the call.

Parameters:

• value (Revox::Models::CallRetrieveResponse::Call::status)

Returns:

• (Symbol, Revox::Models::CallRetrieveResponse::Call::Status)

# File 'lib/revox/models/call_retrieve_response.rb', line 150

required :status, enum: -> { Revox::Models::CallRetrieveResponse::Call::Status }

#to_phone_number ⇒ String

The phone number that received the call. Formatted in E.164 format. Example: +1234567890

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/revox/models/call_retrieve_response.rb', line 157

required :to_phone_number, String

#updated_at ⇒ Object

The time the call order was last updated (any state change, retry, or analysis result).

Parameters:

• value (top)

Returns:

• (Object)

# File 'lib/revox/models/call_retrieve_response.rb', line 164

required :updated_at, Revox::Internal::Type::Unknown

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/revox/models/call_retrieve_response.rb', line 1845

.variants ⇒ Array(Revox::Models::CallRetrieveResponse::Call::LlmModel::UnionMember0, Revox::Models::CallRetrieveResponse::Call::LlmModel::UnionMember1, Revox::Models::CallRetrieveResponse::Call::LlmModel::UnionMember2, Revox::Models::CallRetrieveResponse::Call::LlmModel::UnionMember3)

Returns:

• (Array(Revox::Models::CallRetrieveResponse::Call::LlmModel::UnionMember0, Revox::Models::CallRetrieveResponse::Call::LlmModel::UnionMember1, Revox::Models::CallRetrieveResponse::Call::LlmModel::UnionMember2, Revox::Models::CallRetrieveResponse::Call::LlmModel::UnionMember3))

# File 'lib/revox/models/call_retrieve_response.rb', line 3065

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/revox/models/call_retrieve_response.rbs', line 121

def to_hash: -> {