Class: Revox::Models::CampaignLaunchResponse::Session::InFlightCall

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

Defined Under Namespace

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

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(company:, email:, first_name:, job_title:, 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)
  • job_title (String, nil)
  • last_name (String, nil) 



# File 'lib/revox/models/campaign_launch_response.rb', line 332

Instance Attribute Details

#assignee ⇒ Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assignee?

The team member responsible for following up on this call.

Parameters:

Returns:



157
158
159
 
# File 'lib/revox/models/campaign_launch_response.rb', line 157

required :assignee,
-> { Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assignee },
nil?: true

#assistant ⇒ Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant?

Parameters:

Returns:



164
165
166
 
# File 'lib/revox/models/campaign_launch_response.rb', line 164

required :assistant,
-> { Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant },
nil?: true

#call_attempts ⇒ Array<Revox::Models::CampaignLaunchResponse::Session::InFlightCall::CallAttempt>

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

Parameters:

Returns:



172
173
 
# File 'lib/revox/models/campaign_launch_response.rb', line 172

required :call_attempts,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::CampaignLaunchResponse::Session::InFlightCall::CallAttempt] }

#call_retry_config ⇒ Revox::Models::CampaignLaunchResponse::Session::InFlightCall::CallRetryConfig?

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

Parameters:

Returns:



180
181
182
 
# File 'lib/revox/models/campaign_launch_response.rb', line 180

required :call_retry_config,
-> { Revox::Models::CampaignLaunchResponse::Session::InFlightCall::CallRetryConfig },
nil?: true

#calls_count ⇒ Float

The number of call attempts made.

Parameters:

  • value (Float)

Returns:

  • (Float) 


188
 
# File 'lib/revox/models/campaign_launch_response.rb', line 188

required :calls_count, Float

#campaign ⇒ Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Campaign?

Parameters:

Returns:



193
194
195
 
# File 'lib/revox/models/campaign_launch_response.rb', line 193

required :campaign,
-> { Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Campaign },
nil?: true

#contact ⇒ Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Contact

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

Parameters:

Returns:



202
 
# File 'lib/revox/models/campaign_launch_response.rb', line 202

required :contact, -> { Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Contact }

#created_at ⇒ Object

The time the call order was created.

Parameters:

  • value (top)

Returns:

  • (Object) 


208
 
# File 'lib/revox/models/campaign_launch_response.rb', line 208

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

#direction ⇒ Symbol, Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Direction

Whether the call is inbound or outbound.

Parameters:

  • value (Revox::Models::CampaignLaunchResponse::Session::InFlightCall::direction)

Returns:



214
 
# File 'lib/revox/models/campaign_launch_response.rb', line 214

required :direction, enum: -> { Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Direction }

#first_sentence_delay_ms ⇒ Integer

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

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


220
 
# File 'lib/revox/models/campaign_launch_response.rb', line 220

required :first_sentence_delay_ms, Integer

#follow_up_emails ⇒ Array<String>?

Extra notification recipients resolved from the agent prompt's own routing rules, when it defines any. Added to the assistant's configured notification recipients; never replaces them. Null when the prompt defines no routing rules.

Parameters:

  • value (::Array[String], nil)

Returns:

  • (Array<String>, nil) 


307
 
# File 'lib/revox/models/campaign_launch_response.rb', line 307

optional :follow_up_emails, Revox::Internal::Type::ArrayOf[String], nil?: true

#from_phone_number ⇒ String

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

Parameters:

  • value (String)

Returns:

  • (String) 


227
 
# File 'lib/revox/models/campaign_launch_response.rb', line 227

required :from_phone_number, String

#id ⇒ String

The ID of the call.

Parameters:

  • value (String)

Returns:

  • (String) 


151
 
# File 'lib/revox/models/campaign_launch_response.rb', line 151

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) 


234
 
# File 'lib/revox/models/campaign_launch_response.rb', line 234

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) 


241
 
# File 'lib/revox/models/campaign_launch_response.rb', line 241

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

#last_call_attempt ⇒ Revox::Models::CampaignLaunchResponse::Session::InFlightCall::LastCallAttempt?

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

Parameters:

Returns:



248
249
250
 
# File 'lib/revox/models/campaign_launch_response.rb', line 248

required :last_call_attempt,
-> { Revox::Models::CampaignLaunchResponse::Session::InFlightCall::LastCallAttempt },
nil?: true

#llm_model ⇒ Revox::Models::CampaignLaunchResponse::Session::InFlightCall::LlmModel::UnionMember0, ...

Parameters:

  • value (Revox::Models::CampaignLaunchResponse::Session::InFlightCall::llm_model)

Returns:



255
 
# File 'lib/revox/models/campaign_launch_response.rb', line 255

required :llm_model, union: -> { Revox::Models::CampaignLaunchResponse::Session::InFlightCall::LlmModel }

#metadata ⇒ Hash{Symbol=>String}?

Metadata stored with the call.

Parameters:

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

Returns:

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


261
 
# File 'lib/revox/models/campaign_launch_response.rb', line 261

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) 


267
 
# File 'lib/revox/models/campaign_launch_response.rb', line 267

required :organization_id, String

#outcome ⇒ Symbol, ...

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

Parameters:

  • value (Revox::Models::CampaignLaunchResponse::Session::InFlightCall::outcome, nil)

Returns:



313
314
315
 
# File 'lib/revox/models/campaign_launch_response.rb', line 313

optional :outcome,
enum: -> { Revox::Models::CampaignLaunchResponse::Session::InFlightCall::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) 


321
 
# File 'lib/revox/models/campaign_launch_response.rb', line 321

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) 


273
 
# File 'lib/revox/models/campaign_launch_response.rb', line 273

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) 


279
 
# File 'lib/revox/models/campaign_launch_response.rb', line 279

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

#slack_channel_ids ⇒ Array<String>?

Slack channels resolved from the agent prompt's own routing rules, when it defines any. Always a subset of the channels configured on the assistant. Null when the prompt defines no routing rules, in which case every configured channel is notified.

Parameters:

  • value (::Array[String], nil)

Returns:

  • (Array<String>, nil) 


330
 
# File 'lib/revox/models/campaign_launch_response.rb', line 330

optional :slack_channel_ids, Revox::Internal::Type::ArrayOf[String], nil?: true

#status ⇒ Symbol, Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Status

The status of the call.

Parameters:

  • value (Revox::Models::CampaignLaunchResponse::Session::InFlightCall::status)

Returns:



285
 
# File 'lib/revox/models/campaign_launch_response.rb', line 285

required :status, enum: -> { Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Status }

#to_phone_number ⇒ String

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

Parameters:

  • value (String)

Returns:

  • (String) 


292
 
# File 'lib/revox/models/campaign_launch_response.rb', line 292

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) 


299
 
# File 'lib/revox/models/campaign_launch_response.rb', line 299

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


254
 
# File 'sig/revox/models/campaign_launch_response.rbs', line 254

def to_hash: -> {