Class: Vapi::CreateVoicemailToolDto
- Inherits:
-
Object
- Object
- Vapi::CreateVoicemailToolDto
- Defined in:
- lib/vapi_server_sdk/types/create_voicemail_tool_dto.rb
Constant Summary collapse
- OMIT =
Object.new
Instance Attribute Summary collapse
-
#additional_properties ⇒ OpenStruct
readonly
Additional properties unmapped to the current class definition.
-
#async ⇒ Boolean
readonly
This determines if the tool is async.
-
#function ⇒ Vapi::OpenAiFunction
readonly
This is the function definition of the tool.
-
#messages ⇒ Array<Vapi::CreateVoicemailToolDtoMessagesItem>
readonly
These are the messages that will be spoken to the user as the tool is running.
-
#server ⇒ Vapi::Server
readonly
This is the server that will be hit when this tool is requested by the model.
Class Method Summary collapse
-
.from_json(json_object:) ⇒ Vapi::CreateVoicemailToolDto
Deserialize a JSON object to an instance of CreateVoicemailToolDto.
-
.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.
Instance Method Summary collapse
- #initialize(async: OMIT, messages: OMIT, function: OMIT, server: OMIT, additional_properties: nil) ⇒ Vapi::CreateVoicemailToolDto constructor
-
#to_json(*_args) ⇒ String
Serialize an instance of CreateVoicemailToolDto to a JSON object.
Constructor Details
#initialize(async: OMIT, messages: OMIT, function: OMIT, server: OMIT, additional_properties: nil) ⇒ Vapi::CreateVoicemailToolDto
75 76 77 78 79 80 81 82 83 84 |
# File 'lib/vapi_server_sdk/types/create_voicemail_tool_dto.rb', line 75 def initialize(async: OMIT, messages: OMIT, function: OMIT, server: OMIT, additional_properties: nil) @async = async if async != OMIT @messages = if != OMIT @function = function if function != OMIT @server = server if server != OMIT @additional_properties = additional_properties @_field_set = { "async": async, "messages": , "function": function, "server": server }.reject do |_k, v| v == OMIT end end |
Instance Attribute Details
#additional_properties ⇒ OpenStruct (readonly)
Returns Additional properties unmapped to the current class definition.
41 42 43 |
# File 'lib/vapi_server_sdk/types/create_voicemail_tool_dto.rb', line 41 def additional_properties @additional_properties end |
#async ⇒ Boolean (readonly)
Returns This determines if the tool is async. If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server. If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server. Defaults to synchronous (‘false`).
17 18 19 |
# File 'lib/vapi_server_sdk/types/create_voicemail_tool_dto.rb', line 17 def async @async end |
#function ⇒ Vapi::OpenAiFunction (readonly)
Returns This is the function definition of the tool. For ‘endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases. An example of an advanced use case is if you want to customize the message that’s spoken for ‘endCall` tool. You can specify a function where it returns an argument “reason”. Then, in `messages` array, you can have many “request-complete” messages. One of these messages will be triggered if the `messages[].conditions` matches the “reason” argument.
32 33 34 |
# File 'lib/vapi_server_sdk/types/create_voicemail_tool_dto.rb', line 32 def function @function end |
#messages ⇒ Array<Vapi::CreateVoicemailToolDtoMessagesItem> (readonly)
Returns These are the messages that will be spoken to the user as the tool is running. For some tools, this is auto-filled based on special fields like ‘tool.destinations`. For others like the function tool, these can be custom configured.
22 23 24 |
# File 'lib/vapi_server_sdk/types/create_voicemail_tool_dto.rb', line 22 def @messages end |
#server ⇒ Vapi::Server (readonly)
Returns This is the server that will be hit when this tool is requested by the model. All requests will be sent with the call object among other things. You can find more details in the Server URL documentation. This overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.
39 40 41 |
# File 'lib/vapi_server_sdk/types/create_voicemail_tool_dto.rb', line 39 def server @server end |
Class Method Details
.from_json(json_object:) ⇒ Vapi::CreateVoicemailToolDto
Deserialize a JSON object to an instance of CreateVoicemailToolDto
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/vapi_server_sdk/types/create_voicemail_tool_dto.rb', line 90 def self.from_json(json_object:) struct = JSON.parse(json_object, object_class: OpenStruct) parsed_json = JSON.parse(json_object) async = parsed_json["async"] = parsed_json["messages"]&.map do |item| item = item.to_json Vapi::CreateVoicemailToolDtoMessagesItem.from_json(json_object: item) end if parsed_json["function"].nil? function = nil else function = parsed_json["function"].to_json function = Vapi::OpenAiFunction.from_json(json_object: function) end if parsed_json["server"].nil? server = nil else server = parsed_json["server"].to_json server = Vapi::Server.from_json(json_object: server) end new( async: async, messages: , function: function, server: server, 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.
132 133 134 135 136 137 |
# File 'lib/vapi_server_sdk/types/create_voicemail_tool_dto.rb', line 132 def self.validate_raw(obj:) obj.async&.is_a?(Boolean) != false || raise("Passed value for field obj.async is not the expected type, validation failed.") obj.&.is_a?(Array) != false || raise("Passed value for field obj.messages is not the expected type, validation failed.") obj.function.nil? || Vapi::OpenAiFunction.validate_raw(obj: obj.function) obj.server.nil? || Vapi::Server.validate_raw(obj: obj.server) end |
Instance Method Details
#to_json(*_args) ⇒ String
Serialize an instance of CreateVoicemailToolDto to a JSON object
122 123 124 |
# File 'lib/vapi_server_sdk/types/create_voicemail_tool_dto.rb', line 122 def to_json(*_args) @_field_set&.to_json end |