Class: Telnyx::Models::Rcs::AgentCreateParams

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

Overview

See Also:

  • Telnyx::Resources::Rcs::Agents#create

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

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

#initialize(brand_id:, configuration:, display_name:, use_case:, idempotency_key:, hosting_region: nil, profile_id: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::Rcs::AgentCreateParams for more details.

Parameters:




# File 'lib/telnyx/models/rcs/agent_create_params.rb', line 48

Instance Attribute Details

#brand_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/telnyx/models/rcs/agent_create_params.rb', line 14

required :brand_id, String

#configuration ⇒ Telnyx::Models::Rcs::AgentConfiguration

Parameters:

  • value (Telnyx::Rcs::AgentConfiguration)

Returns:



19
 
# File 'lib/telnyx/models/rcs/agent_create_params.rb', line 19

required :configuration, -> { Telnyx::Rcs::AgentConfiguration }

#display_name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


24
 
# File 'lib/telnyx/models/rcs/agent_create_params.rb', line 24

required :display_name, String

#hosting_region ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


39
 
# File 'lib/telnyx/models/rcs/agent_create_params.rb', line 39

optional :hosting_region, String, nil?: true

#idempotency_key ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


34
 
# File 'lib/telnyx/models/rcs/agent_create_params.rb', line 34

required :idempotency_key, String

#profile_id ⇒ String?

A Messaging Profile owned by the authenticated organization. When omitted, the agent inherits the brand profile.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


46
 
# File 'lib/telnyx/models/rcs/agent_create_params.rb', line 46

optional :profile_id, String, nil?: true

#use_case ⇒ Symbol, Telnyx::Models::Rcs::AgentUseCase

Parameters:

  • value (Telnyx::Models::Rcs::agent_use_case)

Returns:



29
 
# File 'lib/telnyx/models/rcs/agent_create_params.rb', line 29

required :use_case, enum: -> { Telnyx::Rcs::AgentUseCase }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


45
 
# File 'sig/telnyx/models/rcs/agent_create_params.rbs', line 45

def to_hash: -> {