Class: Revox::Models::CampaignLaunchParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/revox/models/campaign_launch_params.rb,
sig/revox/models/campaign_launch_params.rbs

Overview

See Also:

  • Revox::Resources::Campaigns#launch

Defined Under Namespace

Modules: Mode Classes: Selection

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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

#initializeObject



26
# File 'sig/revox/models/campaign_launch_params.rbs', line 26

def initialize: (

Instance Attribute Details

#idString

Parameters:

  • value (String)

Returns:

  • (String)


13
# File 'lib/revox/models/campaign_launch_params.rb', line 13

required :id, String

#modeSymbol, Revox::Models::CampaignLaunchParams::Mode

Parameters:

  • value (Revox::Models::CampaignLaunchParams::mode)

Returns:



18
# File 'lib/revox/models/campaign_launch_params.rb', line 18

required :mode, enum: -> { Revox::CampaignLaunchParams::Mode }

#scheduled_atTime?

When to place the calls (ISO 8601). Omit to launch now. ai_first only — a speed dial session cannot be scheduled.

Parameters:

  • (Time)

Returns:

  • (Time, nil)


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

optional :scheduled_at, Time

#selectionRevox::Models::CampaignLaunchParams::Selection

Parameters:

  • value (Revox::CampaignLaunchParams::Selection)

Returns:



23
# File 'lib/revox/models/campaign_launch_params.rb', line 23

required :selection, -> { Revox::CampaignLaunchParams::Selection }

Class Method Details

.valuesArray<Symbol>

Returns:

  • (Array<Symbol>)


# File 'lib/revox/models/campaign_launch_params.rb', line 52

Instance Method Details

#to_hash{

Returns:

  • ({)


34
# File 'sig/revox/models/campaign_launch_params.rbs', line 34

def to_hash: -> {