Class: Revox::Models::CampaignRetrieveResponse::Campaign

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

Overview

See Also:

  • Revox::Models::CampaignRetrieveResponse#campaign

Defined Under Namespace

Modules: PausedReason, Status, StructuredOutputExtraction, Type Classes: Assistant, CallRetryConfig, CreatedBy, FunnelStats, RowStats

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(calling:, completed:, failed:, pending:, retry_:, total:) ⇒ Object

Parameters:

  • calling (Float)
  • completed (Float)
  • failed (Float)
  • pending (Float)
  • retry_ (Float)
  • total (Float) 



# File 'lib/revox/models/campaign_retrieve_response.rb', line 131

Instance Attribute Details

#active_takeover_call_id ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


65
 
# File 'lib/revox/models/campaign_retrieve_response.rb', line 65

optional :active_takeover_call_id, String, nil?: true

#assistant ⇒ Revox::Models::CampaignRetrieveResponse::Campaign::Assistant?

Returns:



70
 
# File 'lib/revox/models/campaign_retrieve_response.rb', line 70

optional :assistant, -> { Revox::Models::CampaignRetrieveResponse::Campaign::Assistant }

#assistant_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


25
 
# File 'lib/revox/models/campaign_retrieve_response.rb', line 25

required :assistant_id, String

#call_retry_config ⇒ Revox::Models::CampaignRetrieveResponse::Campaign::CallRetryConfig?

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

Parameters:

Returns:



77
78
79
 
# File 'lib/revox/models/campaign_retrieve_response.rb', line 77

optional :call_retry_config,
-> { Revox::Models::CampaignRetrieveResponse::Campaign::CallRetryConfig },
nil?: true

#created_at ⇒ Object

Parameters:

  • value (top)

Returns:

  • (Object) 


30
 
# File 'lib/revox/models/campaign_retrieve_response.rb', line 30

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

#created_by ⇒ Revox::Models::CampaignRetrieveResponse::Campaign::CreatedBy?

A member of the current organization.

Parameters:

Returns:



85
 
# File 'lib/revox/models/campaign_retrieve_response.rb', line 85

optional :created_by, -> { Revox::Models::CampaignRetrieveResponse::Campaign::CreatedBy }, nil?: true

#from_phone_number ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


90
 
# File 'lib/revox/models/campaign_retrieve_response.rb', line 90

optional :from_phone_number, String, nil?: true

#funnel_stats ⇒ Revox::Models::CampaignRetrieveResponse::Campaign::FunnelStats?

Returns:



95
 
# File 'lib/revox/models/campaign_retrieve_response.rb', line 95

optional :funnel_stats, -> { Revox::Models::CampaignRetrieveResponse::Campaign::FunnelStats }

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


20
 
# File 'lib/revox/models/campaign_retrieve_response.rb', line 20

required :id, String

#is_cancelled ⇒ Boolean

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


35
 
# File 'lib/revox/models/campaign_retrieve_response.rb', line 35

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

#max_concurrent_calls ⇒ Float?

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


100
 
# File 'lib/revox/models/campaign_retrieve_response.rb', line 100

optional :max_concurrent_calls, Float, nil?: true

#name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


40
 
# File 'lib/revox/models/campaign_retrieve_response.rb', line 40

required :name, String

#organization_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


45
 
# File 'lib/revox/models/campaign_retrieve_response.rb', line 45

required :organization_id, String

#paused_reason ⇒ Symbol, ...

Parameters:

  • value (Revox::Models::CampaignRetrieveResponse::Campaign::paused_reason, nil)

Returns:



105
106
107
 
# File 'lib/revox/models/campaign_retrieve_response.rb', line 105

optional :paused_reason,
enum: -> { Revox::Models::CampaignRetrieveResponse::Campaign::PausedReason },
nil?: true

#present_count ⇒ Float?

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


112
 
# File 'lib/revox/models/campaign_retrieve_response.rb', line 112

optional :present_count, Float

#row_stats ⇒ Revox::Models::CampaignRetrieveResponse::Campaign::RowStats?

Returns:



117
 
# File 'lib/revox/models/campaign_retrieve_response.rb', line 117

optional :row_stats, -> { Revox::Models::CampaignRetrieveResponse::Campaign::RowStats }

#scheduled_at ⇒ Object?

Parameters:

  • (top)

Returns:

  • (Object, nil) 


122
 
# File 'lib/revox/models/campaign_retrieve_response.rb', line 122

optional :scheduled_at, Revox::Internal::Type::Unknown

#status ⇒ Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Status

Parameters:

  • value (Revox::Models::CampaignRetrieveResponse::Campaign::status)

Returns:



50
 
# File 'lib/revox/models/campaign_retrieve_response.rb', line 50

required :status, enum: -> { Revox::Models::CampaignRetrieveResponse::Campaign::Status }

#structured_output_extraction ⇒ Symbol, ...

The status of the structured output extraction.

Returns:



128
129
 
# File 'lib/revox/models/campaign_retrieve_response.rb', line 128

optional :structured_output_extraction,
enum: -> { Revox::Models::CampaignRetrieveResponse::Campaign::StructuredOutputExtraction }

#type ⇒ Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Type

Parameters:

  • value (Revox::Models::CampaignRetrieveResponse::Campaign::type_)

Returns:



55
 
# File 'lib/revox/models/campaign_retrieve_response.rb', line 55

required :type, enum: -> { Revox::Models::CampaignRetrieveResponse::Campaign::Type }

#updated_at ⇒ Object

Parameters:

  • value (top)

Returns:

  • (Object) 


60
 
# File 'lib/revox/models/campaign_retrieve_response.rb', line 60

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/revox/models/campaign_retrieve_response.rb', line 186

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


129
 
# File 'sig/revox/models/campaign_retrieve_response.rbs', line 129

def to_hash: -> {