Class: Telnyx::Models::AI::ToolCreateParams

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

Overview

See Also:

  • Telnyx::Resources::AI::Tools#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(display_name:, type:, function: nil, handoff: nil, invite: nil, retrieval: nil, timeout_ms: nil, webhook: nil, request_options: {}) ⇒ Object

Parameters:

  • display_name (String)
  • type (String)
  • function (Hash{Symbol=>Object}) (defaults to: nil)
  • handoff (Hash{Symbol=>Object}) (defaults to: nil)
  • invite (Hash{Symbol=>Object}) (defaults to: nil)
  • retrieval (Hash{Symbol=>Object}) (defaults to: nil)
  • timeout_ms (Integer) (defaults to: nil)
  • webhook (Hash{Symbol=>Object}) (defaults to: nil)
  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/telnyx/models/ai/tool_create_params.rb', line 51

Instance Attribute Details

#display_name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/telnyx/models/ai/tool_create_params.rb', line 14

required :display_name, String

#function ⇒ Hash{Symbol=>Object}?

Parameters:

  • (::Hash[Symbol, top])

Returns:

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


24
 
# File 'lib/telnyx/models/ai/tool_create_params.rb', line 24

optional :function, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

#handoff ⇒ Hash{Symbol=>Object}?

Parameters:

  • (::Hash[Symbol, top])

Returns:

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


29
 
# File 'lib/telnyx/models/ai/tool_create_params.rb', line 29

optional :handoff, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

#invite ⇒ Hash{Symbol=>Object}?

Parameters:

  • (::Hash[Symbol, top])

Returns:

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


34
 
# File 'lib/telnyx/models/ai/tool_create_params.rb', line 34

optional :invite, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

#retrieval ⇒ Hash{Symbol=>Object}?

Parameters:

  • (::Hash[Symbol, top])

Returns:

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


39
 
# File 'lib/telnyx/models/ai/tool_create_params.rb', line 39

optional :retrieval, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

#timeout_ms ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


44
 
# File 'lib/telnyx/models/ai/tool_create_params.rb', line 44

optional :timeout_ms, Integer

#type ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


19
 
# File 'lib/telnyx/models/ai/tool_create_params.rb', line 19

required :type, String

#webhook ⇒ Hash{Symbol=>Object}?

Parameters:

  • (::Hash[Symbol, top])

Returns:

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


49
 
# File 'lib/telnyx/models/ai/tool_create_params.rb', line 49

optional :webhook, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


61
 
# File 'sig/telnyx/models/ai/tool_create_params.rbs', line 61

def to_hash: -> {