Class: Vapi::FunctionToolProviderDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/vapi_server_sdk/types/function_tool_provider_details.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(template_url: OMIT, setup_instructions: OMIT, additional_properties: nil) ⇒ Vapi::FunctionToolProviderDetails

Parameters:

  • template_url (String) (defaults to: OMIT) —

    This is the Template URL or the Snapshot URL corresponding to the Template.

  • setup_instructions (Array<Vapi::ToolTemplateSetup>) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



25
26
27
28
29
30
31
32
 
# File 'lib/vapi_server_sdk/types/function_tool_provider_details.rb', line 25

def initialize(template_url: OMIT, setup_instructions: OMIT, additional_properties: nil)
  @template_url = template_url if template_url != OMIT
  @setup_instructions = setup_instructions if setup_instructions != OMIT
  @additional_properties = additional_properties
  @_field_set = { "templateUrl": template_url, "setupInstructions": setup_instructions }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



14
15
16
 
# File 'lib/vapi_server_sdk/types/function_tool_provider_details.rb', line 14

def additional_properties
  @additional_properties
end

#setup_instructions ⇒ Array<Vapi::ToolTemplateSetup> (readonly)

Returns:



12
13
14
 
# File 'lib/vapi_server_sdk/types/function_tool_provider_details.rb', line 12

def setup_instructions
  @setup_instructions
end

#template_url ⇒ String (readonly)

Returns This is the Template URL or the Snapshot URL corresponding to the Template.

Returns:

  • (String) —

    This is the Template URL or the Snapshot URL corresponding to the Template.



10
11
12
 
# File 'lib/vapi_server_sdk/types/function_tool_provider_details.rb', line 10

def template_url
  @template_url
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::FunctionToolProviderDetails

Deserialize a JSON object to an instance of FunctionToolProviderDetails

Parameters:

  • json_object (String)

Returns:



38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/vapi_server_sdk/types/function_tool_provider_details.rb', line 38

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  template_url = parsed_json["templateUrl"]
  setup_instructions = parsed_json["setupInstructions"]&.map do |item|
    item = item.to_json
    Vapi::ToolTemplateSetup.from_json(json_object: item)
  end
  new(
    template_url: template_url,
    setup_instructions: setup_instructions,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


66
67
68
69
 
# File 'lib/vapi_server_sdk/types/function_tool_provider_details.rb', line 66

def self.validate_raw(obj:)
  obj.template_url&.is_a?(String) != false || raise("Passed value for field obj.template_url is not the expected type, validation failed.")
  obj.setup_instructions&.is_a?(Array) != false || raise("Passed value for field obj.setup_instructions is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of FunctionToolProviderDetails to a JSON object

Returns:

  • (String) 


56
57
58
 
# File 'lib/vapi_server_sdk/types/function_tool_provider_details.rb', line 56

def to_json(*_args)
  @_field_set&.to_json
end