Class: Vapi::ToolNodeTool

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

Overview

This is the tool to call. To use an existing tool, send ‘toolId` instead.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(member:, discriminant:) ⇒ Vapi::ToolNodeTool



38
39
40
41
# File 'lib/vapi_server_sdk/types/tool_node_tool.rb', line 38

def initialize(member:, discriminant:)
  @member = member
  @discriminant = discriminant
end

Instance Attribute Details

#discriminantString (readonly)



30
31
32
# File 'lib/vapi_server_sdk/types/tool_node_tool.rb', line 30

def discriminant
  @discriminant
end

#memberObject (readonly)



28
29
30
# File 'lib/vapi_server_sdk/types/tool_node_tool.rb', line 28

def member
  @member
end

Class Method Details

.api_request(member:) ⇒ Vapi::ToolNodeTool



204
205
206
# File 'lib/vapi_server_sdk/types/tool_node_tool.rb', line 204

def self.api_request(member:)
  new(member: member, discriminant: "apiRequest")
end

.bash(member:) ⇒ Vapi::ToolNodeTool



210
211
212
# File 'lib/vapi_server_sdk/types/tool_node_tool.rb', line 210

def self.bash(member:)
  new(member: member, discriminant: "bash")
end

.computer(member:) ⇒ Vapi::ToolNodeTool



216
217
218
# File 'lib/vapi_server_sdk/types/tool_node_tool.rb', line 216

def self.computer(member:)
  new(member: member, discriminant: "computer")
end

.dtmf(member:) ⇒ Vapi::ToolNodeTool



222
223
224
# File 'lib/vapi_server_sdk/types/tool_node_tool.rb', line 222

def self.dtmf(member:)
  new(member: member, discriminant: "dtmf")
end

.end_call(member:) ⇒ Vapi::ToolNodeTool



228
229
230
# File 'lib/vapi_server_sdk/types/tool_node_tool.rb', line 228

def self.end_call(member:)
  new(member: member, discriminant: "endCall")
end

.from_json(json_object:) ⇒ Vapi::ToolNodeTool

Deserialize a JSON object to an instance of ToolNodeTool



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# File 'lib/vapi_server_sdk/types/tool_node_tool.rb', line 47

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  member = case struct.type
           when "apiRequest"
             Vapi::CreateApiRequestToolDto.from_json(json_object: json_object)
           when "bash"
             Vapi::CreateBashToolDto.from_json(json_object: json_object)
           when "computer"
             Vapi::CreateComputerToolDto.from_json(json_object: json_object)
           when "dtmf"
             Vapi::CreateDtmfToolDto.from_json(json_object: json_object)
           when "endCall"
             Vapi::CreateEndCallToolDto.from_json(json_object: json_object)
           when "function"
             Vapi::CreateFunctionToolDto.from_json(json_object: json_object)
           when "gohighlevel.calendar.availability.check"
             Vapi::CreateGoHighLevelCalendarAvailabilityToolDto.from_json(json_object: json_object)
           when "gohighlevel.calendar.event.create"
             Vapi::CreateGoHighLevelCalendarEventCreateToolDto.from_json(json_object: json_object)
           when "gohighlevel.contact.create"
             Vapi::CreateGoHighLevelContactCreateToolDto.from_json(json_object: json_object)
           when "gohighlevel.contact.get"
             Vapi::CreateGoHighLevelContactGetToolDto.from_json(json_object: json_object)
           when "google.calendar.availability.check"
             Vapi::CreateGoogleCalendarCheckAvailabilityToolDto.from_json(json_object: json_object)
           when "google.calendar.event.create"
             Vapi::CreateGoogleCalendarCreateEventToolDto.from_json(json_object: json_object)
           when "google.sheets.row.append"
             Vapi::CreateGoogleSheetsRowAppendToolDto.from_json(json_object: json_object)
           when "mcp"
             Vapi::CreateMcpToolDto.from_json(json_object: json_object)
           when "query"
             Vapi::CreateQueryToolDto.from_json(json_object: json_object)
           when "slack.message.send"
             Vapi::CreateSlackSendMessageToolDto.from_json(json_object: json_object)
           when "sms"
             Vapi::CreateSmsToolDto.from_json(json_object: json_object)
           when "textEditor"
             Vapi::CreateTextEditorToolDto.from_json(json_object: json_object)
           when "transferCall"
             Vapi::CreateTransferCallToolDto.from_json(json_object: json_object)
           else
             Vapi::CreateApiRequestToolDto.from_json(json_object: json_object)
           end
  new(member: member, discriminant: struct.type)
end

.function(member:) ⇒ Vapi::ToolNodeTool



234
235
236
# File 'lib/vapi_server_sdk/types/tool_node_tool.rb', line 234

def self.function(member:)
  new(member: member, discriminant: "function")
end

.gohighlevel_calendar_availability_check(member:) ⇒ Vapi::ToolNodeTool



240
241
242
# File 'lib/vapi_server_sdk/types/tool_node_tool.rb', line 240

def self.gohighlevel_calendar_availability_check(member:)
  new(member: member, discriminant: "gohighlevel.calendar.availability.check")
end

.gohighlevel_calendar_event_create(member:) ⇒ Vapi::ToolNodeTool



246
247
248
# File 'lib/vapi_server_sdk/types/tool_node_tool.rb', line 246

def self.gohighlevel_calendar_event_create(member:)
  new(member: member, discriminant: "gohighlevel.calendar.event.create")
end

.gohighlevel_contact_create(member:) ⇒ Vapi::ToolNodeTool



252
253
254
# File 'lib/vapi_server_sdk/types/tool_node_tool.rb', line 252

def self.gohighlevel_contact_create(member:)
  new(member: member, discriminant: "gohighlevel.contact.create")
end

.gohighlevel_contact_get(member:) ⇒ Vapi::ToolNodeTool



258
259
260
# File 'lib/vapi_server_sdk/types/tool_node_tool.rb', line 258

def self.gohighlevel_contact_get(member:)
  new(member: member, discriminant: "gohighlevel.contact.get")
end

.google_calendar_availability_check(member:) ⇒ Vapi::ToolNodeTool



264
265
266
# File 'lib/vapi_server_sdk/types/tool_node_tool.rb', line 264

def self.google_calendar_availability_check(member:)
  new(member: member, discriminant: "google.calendar.availability.check")
end

.google_calendar_event_create(member:) ⇒ Vapi::ToolNodeTool



270
271
272
# File 'lib/vapi_server_sdk/types/tool_node_tool.rb', line 270

def self.google_calendar_event_create(member:)
  new(member: member, discriminant: "google.calendar.event.create")
end

.google_sheets_row_append(member:) ⇒ Vapi::ToolNodeTool



276
277
278
# File 'lib/vapi_server_sdk/types/tool_node_tool.rb', line 276

def self.google_sheets_row_append(member:)
  new(member: member, discriminant: "google.sheets.row.append")
end

.mcp(member:) ⇒ Vapi::ToolNodeTool



282
283
284
# File 'lib/vapi_server_sdk/types/tool_node_tool.rb', line 282

def self.mcp(member:)
  new(member: member, discriminant: "mcp")
end

.query(member:) ⇒ Vapi::ToolNodeTool



288
289
290
# File 'lib/vapi_server_sdk/types/tool_node_tool.rb', line 288

def self.query(member:)
  new(member: member, discriminant: "query")
end

.slack_message_send(member:) ⇒ Vapi::ToolNodeTool



294
295
296
# File 'lib/vapi_server_sdk/types/tool_node_tool.rb', line 294

def self.slack_message_send(member:)
  new(member: member, discriminant: "slack.message.send")
end

.sms(member:) ⇒ Vapi::ToolNodeTool



300
301
302
# File 'lib/vapi_server_sdk/types/tool_node_tool.rb', line 300

def self.sms(member:)
  new(member: member, discriminant: "sms")
end

.text_editor(member:) ⇒ Vapi::ToolNodeTool



306
307
308
# File 'lib/vapi_server_sdk/types/tool_node_tool.rb', line 306

def self.text_editor(member:)
  new(member: member, discriminant: "textEditor")
end

.transfer_call(member:) ⇒ Vapi::ToolNodeTool



312
313
314
# File 'lib/vapi_server_sdk/types/tool_node_tool.rb', line 312

def self.transfer_call(member:)
  new(member: member, discriminant: "transferCall")
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.


149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
# File 'lib/vapi_server_sdk/types/tool_node_tool.rb', line 149

def self.validate_raw(obj:)
  case obj.type
  when "apiRequest"
    Vapi::CreateApiRequestToolDto.validate_raw(obj: obj)
  when "bash"
    Vapi::CreateBashToolDto.validate_raw(obj: obj)
  when "computer"
    Vapi::CreateComputerToolDto.validate_raw(obj: obj)
  when "dtmf"
    Vapi::CreateDtmfToolDto.validate_raw(obj: obj)
  when "endCall"
    Vapi::CreateEndCallToolDto.validate_raw(obj: obj)
  when "function"
    Vapi::CreateFunctionToolDto.validate_raw(obj: obj)
  when "gohighlevel.calendar.availability.check"
    Vapi::CreateGoHighLevelCalendarAvailabilityToolDto.validate_raw(obj: obj)
  when "gohighlevel.calendar.event.create"
    Vapi::CreateGoHighLevelCalendarEventCreateToolDto.validate_raw(obj: obj)
  when "gohighlevel.contact.create"
    Vapi::CreateGoHighLevelContactCreateToolDto.validate_raw(obj: obj)
  when "gohighlevel.contact.get"
    Vapi::CreateGoHighLevelContactGetToolDto.validate_raw(obj: obj)
  when "google.calendar.availability.check"
    Vapi::CreateGoogleCalendarCheckAvailabilityToolDto.validate_raw(obj: obj)
  when "google.calendar.event.create"
    Vapi::CreateGoogleCalendarCreateEventToolDto.validate_raw(obj: obj)
  when "google.sheets.row.append"
    Vapi::CreateGoogleSheetsRowAppendToolDto.validate_raw(obj: obj)
  when "mcp"
    Vapi::CreateMcpToolDto.validate_raw(obj: obj)
  when "query"
    Vapi::CreateQueryToolDto.validate_raw(obj: obj)
  when "slack.message.send"
    Vapi::CreateSlackSendMessageToolDto.validate_raw(obj: obj)
  when "sms"
    Vapi::CreateSmsToolDto.validate_raw(obj: obj)
  when "textEditor"
    Vapi::CreateTextEditorToolDto.validate_raw(obj: obj)
  when "transferCall"
    Vapi::CreateTransferCallToolDto.validate_raw(obj: obj)
  else
    raise("Passed value matched no type within the union, validation failed.")
  end
end

Instance Method Details

#is_a?(obj) ⇒ Boolean

For Union Types, is_a? functionality is delegated to the wrapped member.



198
199
200
# File 'lib/vapi_server_sdk/types/tool_node_tool.rb', line 198

def is_a?(obj)
  @member.is_a?(obj)
end

#kind_of?Object



33
# File 'lib/vapi_server_sdk/types/tool_node_tool.rb', line 33

alias kind_of? is_a?

#to_json(*_args) ⇒ String

For Union Types, to_json functionality is delegated to the wrapped member.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# File 'lib/vapi_server_sdk/types/tool_node_tool.rb', line 97

def to_json(*_args)
  case @discriminant
  when "apiRequest"
    { **@member.to_json, type: @discriminant }.to_json
  when "bash"
    { **@member.to_json, type: @discriminant }.to_json
  when "computer"
    { **@member.to_json, type: @discriminant }.to_json
  when "dtmf"
    { **@member.to_json, type: @discriminant }.to_json
  when "endCall"
    { **@member.to_json, type: @discriminant }.to_json
  when "function"
    { **@member.to_json, type: @discriminant }.to_json
  when "gohighlevel.calendar.availability.check"
    { **@member.to_json, type: @discriminant }.to_json
  when "gohighlevel.calendar.event.create"
    { **@member.to_json, type: @discriminant }.to_json
  when "gohighlevel.contact.create"
    { **@member.to_json, type: @discriminant }.to_json
  when "gohighlevel.contact.get"
    { **@member.to_json, type: @discriminant }.to_json
  when "google.calendar.availability.check"
    { **@member.to_json, type: @discriminant }.to_json
  when "google.calendar.event.create"
    { **@member.to_json, type: @discriminant }.to_json
  when "google.sheets.row.append"
    { **@member.to_json, type: @discriminant }.to_json
  when "mcp"
    { **@member.to_json, type: @discriminant }.to_json
  when "query"
    { **@member.to_json, type: @discriminant }.to_json
  when "slack.message.send"
    { **@member.to_json, type: @discriminant }.to_json
  when "sms"
    { **@member.to_json, type: @discriminant }.to_json
  when "textEditor"
    { **@member.to_json, type: @discriminant }.to_json
  when "transferCall"
    { **@member.to_json, type: @discriminant }.to_json
  else
    { "type": @discriminant, value: @member }.to_json
  end
  @member.to_json
end