Class: Vapi::ServerMessagePhoneCallControl

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request:, phone_number: OMIT, destination: OMIT, timestamp: OMIT, artifact: OMIT, assistant: OMIT, customer: OMIT, call: OMIT, additional_properties: nil) ⇒ Vapi::ServerMessagePhoneCallControl

Parameters:

  • phone_number (Vapi::ServerMessagePhoneCallControlPhoneNumber) (defaults to: OMIT) —

    This is the phone number associated with the call. This matches one of the following:

    • ‘call.phoneNumber`,

    • ‘call.phoneNumberId`.

  • request (Vapi::ServerMessagePhoneCallControlRequest) —

    This is the request to control the phone call.

  • destination (Vapi::ServerMessagePhoneCallControlDestination) (defaults to: OMIT) —

    This is the destination to forward the call to if the request is “forward”.

  • timestamp (String) (defaults to: OMIT) —

    This is the ISO-8601 formatted timestamp of when the message was sent.

  • artifact (Vapi::Artifact) (defaults to: OMIT) —

    This is a live version of the ‘call.artifact`. This matches what is stored on `call.artifact` after the call.

  • assistant (Vapi::CreateAssistantDto) (defaults to: OMIT) —

    This is the assistant that is currently active. This is provided for convenience. This matches one of the following:

  • customer (Vapi::CreateCustomerDto) (defaults to: OMIT) —

    This is the customer associated with the call. This matches one of the following:

    • ‘call.customer`,

    • ‘call.customerId`.

  • call (Vapi::Call) (defaults to: OMIT) —

    This is the call object. This matches what was returned in POST /call. Note: This might get stale during the call. To get the latest call object, especially after the call is ended, use GET /call/:id.

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

    Additional properties unmapped to the current class definition



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/vapi_server_sdk/types/server_message_phone_call_control.rb', line 85

def initialize(request:, phone_number: OMIT, destination: OMIT, timestamp: OMIT, artifact: OMIT, assistant: OMIT,
               customer: OMIT, call: OMIT, additional_properties: nil)
  @phone_number = phone_number if phone_number != OMIT
  @request = request
  @destination = destination if destination != OMIT
  @timestamp = timestamp if timestamp != OMIT
  @artifact = artifact if artifact != OMIT
  @assistant = assistant if assistant != OMIT
  @customer = customer if customer != OMIT
  @call = call if call != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "phoneNumber": phone_number,
    "request": request,
    "destination": destination,
    "timestamp": timestamp,
    "artifact": artifact,
    "assistant": assistant,
    "customer": customer,
    "call": call
  }.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



50
51
52
 
# File 'lib/vapi_server_sdk/types/server_message_phone_call_control.rb', line 50

def additional_properties
  @additional_properties
end

#artifact ⇒ Vapi::Artifact (readonly)

Returns This is a live version of the ‘call.artifact`. This matches what is stored on `call.artifact` after the call.

Returns:

  • (Vapi::Artifact) —

    This is a live version of the ‘call.artifact`. This matches what is stored on `call.artifact` after the call.



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

def artifact
  @artifact
end

#assistant ⇒ Vapi::CreateAssistantDto (readonly)

Returns This is the assistant that is currently active. This is provided for convenience. This matches one of the following:

Returns:



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

def assistant
  @assistant
end

#call ⇒ Vapi::Call (readonly)

Returns This is the call object. This matches what was returned in POST /call. Note: This might get stale during the call. To get the latest call object, especially after the call is ended, use GET /call/:id.

Returns:

  • (Vapi::Call) —

    This is the call object. This matches what was returned in POST /call. Note: This might get stale during the call. To get the latest call object, especially after the call is ended, use GET /call/:id.



48
49
50
 
# File 'lib/vapi_server_sdk/types/server_message_phone_call_control.rb', line 48

def call
  @call
end

#customer ⇒ Vapi::CreateCustomerDto (readonly)

Returns This is the customer associated with the call. This matches one of the following:

  • ‘call.customer`,

  • ‘call.customerId`.

Returns:

  • (Vapi::CreateCustomerDto) —

    This is the customer associated with the call. This matches one of the following:

    • ‘call.customer`,

    • ‘call.customerId`.



43
44
45
 
# File 'lib/vapi_server_sdk/types/server_message_phone_call_control.rb', line 43

def customer
  @customer
end

#destination ⇒ Vapi::ServerMessagePhoneCallControlDestination (readonly)

Returns This is the destination to forward the call to if the request is “forward”.

Returns:



23
24
25
 
# File 'lib/vapi_server_sdk/types/server_message_phone_call_control.rb', line 23

def destination
  @destination
end

#phone_number ⇒ Vapi::ServerMessagePhoneCallControlPhoneNumber (readonly)

Returns This is the phone number associated with the call. This matches one of the following:

  • ‘call.phoneNumber`,

  • ‘call.phoneNumberId`.

Returns:



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

def phone_number
  @phone_number
end

#request ⇒ Vapi::ServerMessagePhoneCallControlRequest (readonly)

Returns This is the request to control the phone call.

Returns:



21
22
23
 
# File 'lib/vapi_server_sdk/types/server_message_phone_call_control.rb', line 21

def request
  @request
end

#timestamp ⇒ String (readonly)

Returns This is the ISO-8601 formatted timestamp of when the message was sent.

Returns:

  • (String) —

    This is the ISO-8601 formatted timestamp of when the message was sent.



25
26
27
 
# File 'lib/vapi_server_sdk/types/server_message_phone_call_control.rb', line 25

def timestamp
  @timestamp
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::ServerMessagePhoneCallControl

Deserialize a JSON object to an instance of ServerMessagePhoneCallControl

Parameters:

  • json_object (String)

Returns:



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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/vapi_server_sdk/types/server_message_phone_call_control.rb', line 114

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  if parsed_json["phoneNumber"].nil?
    phone_number = nil
  else
    phone_number = parsed_json["phoneNumber"].to_json
    phone_number = Vapi::ServerMessagePhoneCallControlPhoneNumber.from_json(json_object: phone_number)
  end
  request = parsed_json["request"]
  if parsed_json["destination"].nil?
    destination = nil
  else
    destination = parsed_json["destination"].to_json
    destination = Vapi::ServerMessagePhoneCallControlDestination.from_json(json_object: destination)
  end
  timestamp = parsed_json["timestamp"]
  if parsed_json["artifact"].nil?
    artifact = nil
  else
    artifact = parsed_json["artifact"].to_json
    artifact = Vapi::Artifact.from_json(json_object: artifact)
  end
  if parsed_json["assistant"].nil?
    assistant = nil
  else
    assistant = parsed_json["assistant"].to_json
    assistant = Vapi::CreateAssistantDto.from_json(json_object: assistant)
  end
  if parsed_json["customer"].nil?
    customer = nil
  else
    customer = parsed_json["customer"].to_json
    customer = Vapi::CreateCustomerDto.from_json(json_object: customer)
  end
  if parsed_json["call"].nil?
    call = nil
  else
    call = parsed_json["call"].to_json
    call = Vapi::Call.from_json(json_object: call)
  end
  new(
    phone_number: phone_number,
    request: request,
    destination: destination,
    timestamp: timestamp,
    artifact: artifact,
    assistant: assistant,
    customer: customer,
    call: call,
    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) 


181
182
183
184
185
186
187
188
189
190
 
# File 'lib/vapi_server_sdk/types/server_message_phone_call_control.rb', line 181

def self.validate_raw(obj:)
  obj.phone_number.nil? || Vapi::ServerMessagePhoneCallControlPhoneNumber.validate_raw(obj: obj.phone_number)
  obj.request.is_a?(Vapi::ServerMessagePhoneCallControlRequest) != false || raise("Passed value for field obj.request is not the expected type, validation failed.")
  obj.destination.nil? || Vapi::ServerMessagePhoneCallControlDestination.validate_raw(obj: obj.destination)
  obj.timestamp&.is_a?(String) != false || raise("Passed value for field obj.timestamp is not the expected type, validation failed.")
  obj.artifact.nil? || Vapi::Artifact.validate_raw(obj: obj.artifact)
  obj.assistant.nil? || Vapi::CreateAssistantDto.validate_raw(obj: obj.assistant)
  obj.customer.nil? || Vapi::CreateCustomerDto.validate_raw(obj: obj.customer)
  obj.call.nil? || Vapi::Call.validate_raw(obj: obj.call)
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of ServerMessagePhoneCallControl to a JSON object

Returns:

  • (String) 


171
172
173
 
# File 'lib/vapi_server_sdk/types/server_message_phone_call_control.rb', line 171

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