Class: Vapi::ServerMessageTransferUpdate

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(phone_number: OMIT, destination: OMIT, timestamp: OMIT, artifact: OMIT, assistant: OMIT, customer: OMIT, call: OMIT, chat: OMIT, to_assistant: OMIT, from_assistant: OMIT, to_step_record: OMIT, from_step_record: OMIT, additional_properties: nil) ⇒ Vapi::ServerMessageTransferUpdate

Parameters:

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

    This is the phone number that the message is associated with.

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

    This is the destination of the transfer.

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

    This is the timestamp of the message.

  • 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 the message is associated with.

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

    This is the customer that the message is associated with.

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

    This is the call that the message is associated with.

  • chat (Vapi::Chat) (defaults to: OMIT) —

    This is the chat object.

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

    This is the assistant that the call is being transferred to. This is only sent if ‘destination.type` is “assistant”.

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

    This is the assistant that the call is being transferred from. This is only sent if ‘destination.type` is “assistant”.

  • to_step_record (Hash{String => Object}) (defaults to: OMIT) —

    This is the step that the conversation moved to.

  • from_step_record (Hash{String => Object}) (defaults to: OMIT) —

    This is the step that the conversation moved from. =

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

    Additional properties unmapped to the current class definition



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/vapi_server_sdk/types/server_message_transfer_update.rb', line 67

def initialize(phone_number: OMIT, destination: OMIT, timestamp: OMIT, artifact: OMIT, assistant: OMIT,
               customer: OMIT, call: OMIT, chat: OMIT, to_assistant: OMIT, from_assistant: OMIT, to_step_record: OMIT, from_step_record: OMIT, additional_properties: nil)
  @phone_number = phone_number if phone_number != OMIT
  @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
  @chat = chat if chat != OMIT
  @to_assistant = to_assistant if to_assistant != OMIT
  @from_assistant = from_assistant if from_assistant != OMIT
  @to_step_record = to_step_record if to_step_record != OMIT
  @from_step_record = from_step_record if from_step_record != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "phoneNumber": phone_number,
    "destination": destination,
    "timestamp": timestamp,
    "artifact": artifact,
    "assistant": assistant,
    "customer": customer,
    "call": call,
    "chat": chat,
    "toAssistant": to_assistant,
    "fromAssistant": from_assistant,
    "toStepRecord": to_step_record,
    "fromStepRecord": from_step_record
  }.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



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

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.



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

def artifact
  @artifact
end

#assistant ⇒ Vapi::CreateAssistantDto (readonly)

Returns This is the assistant that the message is associated with.

Returns:



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

def assistant
  @assistant
end

#call ⇒ Vapi::Call (readonly)

Returns This is the call that the message is associated with.

Returns:

  • (Vapi::Call) —

    This is the call that the message is associated with.



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

def call
  @call
end

#chat ⇒ Vapi::Chat (readonly)

Returns This is the chat object.

Returns:



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

def chat
  @chat
end

#customer ⇒ Vapi::CreateCustomerDto (readonly)

Returns This is the customer that the message is associated with.

Returns:



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

def customer
  @customer
end

#destination ⇒ Vapi::ServerMessageTransferUpdateDestination (readonly)

Returns This is the destination of the transfer.

Returns:



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

def destination
  @destination
end

#from_assistant ⇒ Vapi::CreateAssistantDto (readonly)

Returns This is the assistant that the call is being transferred from. This is only sent if ‘destination.type` is “assistant”.

Returns:

  • (Vapi::CreateAssistantDto) —

    This is the assistant that the call is being transferred from. This is only sent if ‘destination.type` is “assistant”.



37
38
39
 
# File 'lib/vapi_server_sdk/types/server_message_transfer_update.rb', line 37

def from_assistant
  @from_assistant
end

#from_step_record ⇒ Hash{String => Object} (readonly)

Returns This is the step that the conversation moved from. =.

Returns:

  • (Hash{String => Object}) —

    This is the step that the conversation moved from. =



41
42
43
 
# File 'lib/vapi_server_sdk/types/server_message_transfer_update.rb', line 41

def from_step_record
  @from_step_record
end

#phone_number ⇒ Vapi::ServerMessageTransferUpdatePhoneNumber (readonly)

Returns This is the phone number that the message is associated with.

Returns:



16
17
18
 
# File 'lib/vapi_server_sdk/types/server_message_transfer_update.rb', line 16

def phone_number
  @phone_number
end

#timestamp ⇒ Float (readonly)

Returns This is the timestamp of the message.

Returns:

  • (Float) —

    This is the timestamp of the message.



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

def timestamp
  @timestamp
end

#to_assistant ⇒ Vapi::CreateAssistantDto (readonly)

Returns This is the assistant that the call is being transferred to. This is only sent if ‘destination.type` is “assistant”.

Returns:

  • (Vapi::CreateAssistantDto) —

    This is the assistant that the call is being transferred to. This is only sent if ‘destination.type` is “assistant”.



34
35
36
 
# File 'lib/vapi_server_sdk/types/server_message_transfer_update.rb', line 34

def to_assistant
  @to_assistant
end

#to_step_record ⇒ Hash{String => Object} (readonly)

Returns This is the step that the conversation moved to.

Returns:

  • (Hash{String => Object}) —

    This is the step that the conversation moved to.



39
40
41
 
# File 'lib/vapi_server_sdk/types/server_message_transfer_update.rb', line 39

def to_step_record
  @to_step_record
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::ServerMessageTransferUpdate

Deserialize a JSON object to an instance of ServerMessageTransferUpdate

Parameters:

  • json_object (String)

Returns:



104
105
106
107
108
109
110
111
112
113
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
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/vapi_server_sdk/types/server_message_transfer_update.rb', line 104

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::ServerMessageTransferUpdatePhoneNumber.from_json(json_object: phone_number)
  end
  if parsed_json["destination"].nil?
    destination = nil
  else
    destination = parsed_json["destination"].to_json
    destination = Vapi::ServerMessageTransferUpdateDestination.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
  if parsed_json["chat"].nil?
    chat = nil
  else
    chat = parsed_json["chat"].to_json
    chat = Vapi::Chat.from_json(json_object: chat)
  end
  if parsed_json["toAssistant"].nil?
    to_assistant = nil
  else
    to_assistant = parsed_json["toAssistant"].to_json
    to_assistant = Vapi::CreateAssistantDto.from_json(json_object: to_assistant)
  end
  if parsed_json["fromAssistant"].nil?
    from_assistant = nil
  else
    from_assistant = parsed_json["fromAssistant"].to_json
    from_assistant = Vapi::CreateAssistantDto.from_json(json_object: from_assistant)
  end
  to_step_record = parsed_json["toStepRecord"]
  from_step_record = parsed_json["fromStepRecord"]
  new(
    phone_number: phone_number,
    destination: destination,
    timestamp: timestamp,
    artifact: artifact,
    assistant: assistant,
    customer: customer,
    call: call,
    chat: chat,
    to_assistant: to_assistant,
    from_assistant: from_assistant,
    to_step_record: to_step_record,
    from_step_record: from_step_record,
    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) 


194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/vapi_server_sdk/types/server_message_transfer_update.rb', line 194

def self.validate_raw(obj:)
  obj.phone_number.nil? || Vapi::ServerMessageTransferUpdatePhoneNumber.validate_raw(obj: obj.phone_number)
  obj.destination.nil? || Vapi::ServerMessageTransferUpdateDestination.validate_raw(obj: obj.destination)
  obj.timestamp&.is_a?(Float) != 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)
  obj.chat.nil? || Vapi::Chat.validate_raw(obj: obj.chat)
  obj.to_assistant.nil? || Vapi::CreateAssistantDto.validate_raw(obj: obj.to_assistant)
  obj.from_assistant.nil? || Vapi::CreateAssistantDto.validate_raw(obj: obj.from_assistant)
  obj.to_step_record&.is_a?(Hash) != false || raise("Passed value for field obj.to_step_record is not the expected type, validation failed.")
  obj.from_step_record&.is_a?(Hash) != false || raise("Passed value for field obj.from_step_record is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of ServerMessageTransferUpdate to a JSON object

Returns:

  • (String) 


184
185
186
 
# File 'lib/vapi_server_sdk/types/server_message_transfer_update.rb', line 184

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