vapi_client/models/server_message_hang.rs
1/*
2 * Vapi API
3 *
4 * API for building voice assistants
5 *
6 * The version of the OpenAPI document: 1.0
7 *
8 * Generated by: https://openapi-generator.tech
9 */
10
11use serde::{Deserialize, Serialize};
12use utoipa::ToSchema;
13
14
15use crate::models;
16
17#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, ToSchema)]
18pub struct ServerMessageHang {
19 #[serde(rename = "phoneNumber", skip_serializing_if = "Option::is_none")]
20 pub phone_number: Option<models::ServerMessageAssistantRequestPhoneNumber>,
21 /// This is the type of the message. \"hang\" is sent when the assistant is hanging due to a delay. The delay can be caused by many factors, such as: - the model is too slow to respond - the voice is too slow to respond - the tool call is still waiting for a response from your server - etc.
22 #[serde(rename = "type")]
23 pub r#type: Type,
24 /// This is the ISO-8601 formatted timestamp of when the message was sent.
25 #[serde(rename = "timestamp", skip_serializing_if = "Option::is_none")]
26 pub timestamp: Option<f64>,
27 /// This is a live version of the `call.artifact`. This matches what is stored on `call.artifact` after the call.
28 #[serde(rename = "artifact", skip_serializing_if = "Option::is_none")]
29 pub artifact: Option<models::Artifact>,
30 /// This is the assistant that is currently active. This is provided for convenience. This matches one of the following: - `call.assistant`, - `call.assistantId`, - `call.squad[n].assistant`, - `call.squad[n].assistantId`, - `call.squadId->[n].assistant`, - `call.squadId->[n].assistantId`.
31 #[serde(rename = "assistant", skip_serializing_if = "Option::is_none")]
32 pub assistant: Option<models::CreateAssistantDto>,
33 /// This is the customer associated with the call. This matches one of the following: - `call.customer`, - `call.customerId`.
34 #[serde(rename = "customer", skip_serializing_if = "Option::is_none")]
35 pub customer: Option<models::CreateCustomerDto>,
36 /// 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.
37 #[serde(rename = "call", skip_serializing_if = "Option::is_none")]
38 pub call: Option<models::Call>,
39}
40
41impl ServerMessageHang {
42 pub fn new(r#type: Type) -> ServerMessageHang {
43 ServerMessageHang {
44 phone_number: None,
45 r#type,
46 timestamp: None,
47 artifact: None,
48 assistant: None,
49 customer: None,
50 call: None,
51 }
52 }
53}
54/// This is the type of the message. \"hang\" is sent when the assistant is hanging due to a delay. The delay can be caused by many factors, such as: - the model is too slow to respond - the voice is too slow to respond - the tool call is still waiting for a response from your server - etc.
55#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize, ToSchema)]
56pub enum Type {
57 #[serde(rename = "hang")]
58 Hang,
59}
60
61impl Default for Type {
62 fn default() -> Type {
63 Self::Hang
64 }
65}