Class: Vapi::CreateTransferCallToolDto

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(messages: OMIT, destinations: OMIT, function: OMIT, additional_properties: nil) ⇒ Vapi::CreateTransferCallToolDto

Parameters:

  • messages (Array<Vapi::CreateTransferCallToolDtoMessagesItem>) (defaults to: OMIT) —

    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.

  • destinations (Array<Vapi::CreateTransferCallToolDtoDestinationsItem>) (defaults to: OMIT) —

    These are the destinations that the call can be transferred to. If no destinations are provided, server.url will be used to get the transfer destination once the tool is called.

  • function (Vapi::OpenAiFunction) (defaults to: OMIT) —

    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.

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



56
57
58
59
60
61
62
63
64
 
# File 'lib/vapi_server_sdk/types/create_transfer_call_tool_dto.rb', line 56

def initialize(messages: OMIT, destinations: OMIT, function: OMIT, additional_properties: nil)
  @messages = messages if messages != OMIT
  @destinations = destinations if destinations != OMIT
  @function = function if function != OMIT
  @additional_properties = additional_properties
  @_field_set = { "messages": messages, "destinations": destinations, "function": function }.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



31
32
33
 
# File 'lib/vapi_server_sdk/types/create_transfer_call_tool_dto.rb', line 31

def additional_properties
  @additional_properties
end

#destinations ⇒ Array<Vapi::CreateTransferCallToolDtoDestinationsItem> (readonly)

Returns These are the destinations that the call can be transferred to. If no destinations are provided, server.url will be used to get the transfer destination once the tool is called.

Returns:

  • (Array<Vapi::CreateTransferCallToolDtoDestinationsItem>) —

    These are the destinations that the call can be transferred to. If no destinations are provided, server.url will be used to get the transfer destination once the tool is called.



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

def destinations
  @destinations
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.

Returns:

  • (Vapi::OpenAiFunction) —

    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.



29
30
31
 
# File 'lib/vapi_server_sdk/types/create_transfer_call_tool_dto.rb', line 29

def function
  @function
end

#messages ⇒ Array<Vapi::CreateTransferCallToolDtoMessagesItem> (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.

Returns:

  • (Array<Vapi::CreateTransferCallToolDtoMessagesItem>) —

    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.



15
16
17
 
# File 'lib/vapi_server_sdk/types/create_transfer_call_tool_dto.rb', line 15

def messages
  @messages
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::CreateTransferCallToolDto

Deserialize a JSON object to an instance of CreateTransferCallToolDto

Parameters:

  • json_object (String)

Returns:



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/vapi_server_sdk/types/create_transfer_call_tool_dto.rb', line 70

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  messages = parsed_json["messages"]&.map do |item|
    item = item.to_json
    Vapi::CreateTransferCallToolDtoMessagesItem.from_json(json_object: item)
  end
  destinations = parsed_json["destinations"]&.map do |item|
    item = item.to_json
    Vapi::CreateTransferCallToolDtoDestinationsItem.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
  new(
    messages: messages,
    destinations: destinations,
    function: function,
    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) 


108
109
110
111
112
 
# File 'lib/vapi_server_sdk/types/create_transfer_call_tool_dto.rb', line 108

def self.validate_raw(obj:)
  obj.messages&.is_a?(Array) != false || raise("Passed value for field obj.messages is not the expected type, validation failed.")
  obj.destinations&.is_a?(Array) != false || raise("Passed value for field obj.destinations is not the expected type, validation failed.")
  obj.function.nil? || Vapi::OpenAiFunction.validate_raw(obj: obj.function)
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of CreateTransferCallToolDto to a JSON object

Returns:

  • (String) 


98
99
100
 
# File 'lib/vapi_server_sdk/types/create_transfer_call_tool_dto.rb', line 98

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