Class: Vapi::CreateToolCallBlockDtoTool

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

Overview

This is the tool that the block will call. To use an existing tool, use toolId.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Parameters:

  • member (Object)
  • discriminant (String) 


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

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

Instance Attribute Details

#discriminant ⇒ String (readonly)

Returns:

  • (String) 


19
20
21
 
# File 'lib/vapi_server_sdk/types/create_tool_call_block_dto_tool.rb', line 19

def discriminant
  @discriminant
end

#member ⇒ Object (readonly)

Returns:

  • (Object) 


17
18
19
 
# File 'lib/vapi_server_sdk/types/create_tool_call_block_dto_tool.rb', line 17

def member
  @member
end

Class Method Details

.dtmf(member:) ⇒ Vapi::CreateToolCallBlockDtoTool

Parameters:

Returns:



121
122
123
 
# File 'lib/vapi_server_sdk/types/create_tool_call_block_dto_tool.rb', line 121

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

.end_call(member:) ⇒ Vapi::CreateToolCallBlockDtoTool

Parameters:

Returns:



127
128
129
 
# File 'lib/vapi_server_sdk/types/create_tool_call_block_dto_tool.rb', line 127

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

.from_json(json_object:) ⇒ Vapi::CreateToolCallBlockDtoTool

Deserialize a JSON object to an instance of CreateToolCallBlockDtoTool

Parameters:

  • json_object (String)

Returns:



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/vapi_server_sdk/types/create_tool_call_block_dto_tool.rb', line 36

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  member = case struct.type
           when "dtmf"
             Vapi::CreateDtmfToolDto.from_json(json_object: json_object)
           when "endCall"
             Vapi::CreateEndCallToolDto.from_json(json_object: json_object)
           when "voicemail"
             Vapi::CreateVoicemailToolDto.from_json(json_object: json_object)
           when "function"
             Vapi::CreateFunctionToolDto.from_json(json_object: json_object)
           when "ghl"
             Vapi::CreateGhlToolDto.from_json(json_object: json_object)
           when "make"
             Vapi::CreateMakeToolDto.from_json(json_object: json_object)
           when "transferCall"
             Vapi::CreateTransferCallToolDto.from_json(json_object: json_object)
           else
             Vapi::CreateDtmfToolDto.from_json(json_object: json_object)
           end
  new(member: member, discriminant: struct.type)
end

.function(member:) ⇒ Vapi::CreateToolCallBlockDtoTool

Parameters:

Returns:



139
140
141
 
# File 'lib/vapi_server_sdk/types/create_tool_call_block_dto_tool.rb', line 139

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

.ghl(member:) ⇒ Vapi::CreateToolCallBlockDtoTool

Parameters:

Returns:



145
146
147
 
# File 'lib/vapi_server_sdk/types/create_tool_call_block_dto_tool.rb', line 145

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

.make(member:) ⇒ Vapi::CreateToolCallBlockDtoTool

Parameters:

Returns:



151
152
153
 
# File 'lib/vapi_server_sdk/types/create_tool_call_block_dto_tool.rb', line 151

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

.transfer_call(member:) ⇒ Vapi::CreateToolCallBlockDtoTool

Parameters:

Returns:



157
158
159
 
# File 'lib/vapi_server_sdk/types/create_tool_call_block_dto_tool.rb', line 157

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.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/vapi_server_sdk/types/create_tool_call_block_dto_tool.rb', line 90

def self.validate_raw(obj:)
  case obj.type
  when "dtmf"
    Vapi::CreateDtmfToolDto.validate_raw(obj: obj)
  when "endCall"
    Vapi::CreateEndCallToolDto.validate_raw(obj: obj)
  when "voicemail"
    Vapi::CreateVoicemailToolDto.validate_raw(obj: obj)
  when "function"
    Vapi::CreateFunctionToolDto.validate_raw(obj: obj)
  when "ghl"
    Vapi::CreateGhlToolDto.validate_raw(obj: obj)
  when "make"
    Vapi::CreateMakeToolDto.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

.voicemail(member:) ⇒ Vapi::CreateToolCallBlockDtoTool

Parameters:

Returns:



133
134
135
 
# File 'lib/vapi_server_sdk/types/create_tool_call_block_dto_tool.rb', line 133

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

Instance Method Details

#is_a?(obj) ⇒ Boolean

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

Parameters:

  • obj (Object)

Returns:

  • (Boolean) 


115
116
117
 
# File 'lib/vapi_server_sdk/types/create_tool_call_block_dto_tool.rb', line 115

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

#kind_of? ⇒ Object 



22
 
# File 'lib/vapi_server_sdk/types/create_tool_call_block_dto_tool.rb', line 22

alias kind_of? is_a?

#to_json(*_args) ⇒ String

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

Returns:

  • (String) 


62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/vapi_server_sdk/types/create_tool_call_block_dto_tool.rb', line 62

def to_json(*_args)
  case @discriminant
  when "dtmf"
    { **@member.to_json, type: @discriminant }.to_json
  when "endCall"
    { **@member.to_json, type: @discriminant }.to_json
  when "voicemail"
    { **@member.to_json, type: @discriminant }.to_json
  when "function"
    { **@member.to_json, type: @discriminant }.to_json
  when "ghl"
    { **@member.to_json, type: @discriminant }.to_json
  when "make"
    { **@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