Class: Vapi::MakeToolMetadata

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

Constant Summary collapse

OMIT =
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scenario_id: OMIT, trigger_hook_id: OMIT, additional_properties: nil) ⇒ Vapi::MakeToolMetadata

Parameters:

  • scenario_id (Float) (defaults to: OMIT)
  • trigger_hook_id (Float) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil)

    Additional properties unmapped to the current class definition



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

def initialize(scenario_id: OMIT, trigger_hook_id: OMIT, additional_properties: nil)
  @scenario_id = scenario_id if scenario_id != OMIT
  @trigger_hook_id = trigger_hook_id if trigger_hook_id != OMIT
  @additional_properties = additional_properties
  @_field_set = { "scenarioId": scenario_id, "triggerHookId": trigger_hook_id }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_propertiesOpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct)

    Additional properties unmapped to the current class definition



13
14
15
# File 'lib/vapi_server_sdk/types/make_tool_metadata.rb', line 13

def additional_properties
  @additional_properties
end

#scenario_idFloat (readonly)

Returns:

  • (Float)


9
10
11
# File 'lib/vapi_server_sdk/types/make_tool_metadata.rb', line 9

def scenario_id
  @scenario_id
end

#trigger_hook_idFloat (readonly)

Returns:

  • (Float)


11
12
13
# File 'lib/vapi_server_sdk/types/make_tool_metadata.rb', line 11

def trigger_hook_id
  @trigger_hook_id
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::MakeToolMetadata

Deserialize a JSON object to an instance of MakeToolMetadata

Parameters:

  • json_object (String)

Returns:



37
38
39
40
41
42
43
44
45
46
47
# File 'lib/vapi_server_sdk/types/make_tool_metadata.rb', line 37

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  scenario_id = parsed_json["scenarioId"]
  trigger_hook_id = parsed_json["triggerHookId"]
  new(
    scenario_id: scenario_id,
    trigger_hook_id: trigger_hook_id,
    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)


62
63
64
65
# File 'lib/vapi_server_sdk/types/make_tool_metadata.rb', line 62

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

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of MakeToolMetadata to a JSON object

Returns:

  • (String)


52
53
54
# File 'lib/vapi_server_sdk/types/make_tool_metadata.rb', line 52

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