Class: Vapi::ServerMessage

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(message:, additional_properties: nil) ⇒ Vapi::ServerMessage

Parameters:

  • message (Vapi::ServerMessageMessage) —

    These are all the messages that can be sent to your server before, after and during the call. Configure the messages you’d like to receive in assistant.serverMessages. The server where the message is sent is determined by the following precedence order:

    1. tool.server.url (if configured, and only for “tool-calls” message)

    2. assistant.serverUrl (if configure)

    3. phoneNumber.serverUrl (if configured)

    4. org.serverUrl (if configured)

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

    Additional properties unmapped to the current class definition



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

def initialize(message:, additional_properties: nil)
  @message = message
  @additional_properties = additional_properties
  @_field_set = { "message": message }
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



20
21
22
 
# File 'lib/vapi_server_sdk/types/server_message.rb', line 20

def additional_properties
  @additional_properties
end

#message ⇒ Vapi::ServerMessageMessage (readonly)

Returns These are all the messages that can be sent to your server before, after and during the call. Configure the messages you’d like to receive in assistant.serverMessages. The server where the message is sent is determined by the following precedence order:

  1. tool.server.url (if configured, and only for “tool-calls” message)

  2. assistant.serverUrl (if configure)

  3. phoneNumber.serverUrl (if configured)

  4. org.serverUrl (if configured).

Returns:

  • (Vapi::ServerMessageMessage) —

    These are all the messages that can be sent to your server before, after and during the call. Configure the messages you’d like to receive in assistant.serverMessages. The server where the message is sent is determined by the following precedence order:

    1. tool.server.url (if configured, and only for “tool-calls” message)

    2. assistant.serverUrl (if configure)

    3. phoneNumber.serverUrl (if configured)

    4. org.serverUrl (if configured)



18
19
20
 
# File 'lib/vapi_server_sdk/types/server_message.rb', line 18

def message
  @message
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::ServerMessage

Deserialize a JSON object to an instance of ServerMessage

Parameters:

  • json_object (String)

Returns:



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/vapi_server_sdk/types/server_message.rb', line 48

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  if parsed_json["message"].nil?
    message = nil
  else
    message = parsed_json["message"].to_json
    message = Vapi::ServerMessageMessage.from_json(json_object: message)
  end
  new(message: message, 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) 


73
74
75
 
# File 'lib/vapi_server_sdk/types/server_message.rb', line 73

def self.validate_raw(obj:)
  Vapi::ServerMessageMessage.validate_raw(obj: obj.message)
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of ServerMessage to a JSON object

Returns:

  • (String) 


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

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