vapi_client/models/
server_message_speech_update.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::OpenApi;
13
14
15use crate::models;
16
17#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, OpenApi)]
18pub struct ServerMessageSpeechUpdate {
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. \"speech-update\" is sent whenever assistant or user start or stop speaking.
22    #[serde(rename = "type")]
23    pub r#type: Type,
24    /// This is the status of the speech update.
25    #[serde(rename = "status")]
26    pub status: Status,
27    /// This is the role which the speech update is for.
28    #[serde(rename = "role")]
29    pub role: Role,
30    /// This is the ISO-8601 formatted timestamp of when the message was sent.
31    #[serde(rename = "timestamp", skip_serializing_if = "Option::is_none")]
32    pub timestamp: Option<f64>,
33    /// This is a live version of the `call.artifact`.  This matches what is stored on `call.artifact` after the call.
34    #[serde(rename = "artifact", skip_serializing_if = "Option::is_none")]
35    pub artifact: Option<models::Artifact>,
36    /// 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`.
37    #[serde(rename = "assistant", skip_serializing_if = "Option::is_none")]
38    pub assistant: Option<models::CreateAssistantDto>,
39    /// This is the customer associated with the call.  This matches one of the following: - `call.customer`, - `call.customerId`.
40    #[serde(rename = "customer", skip_serializing_if = "Option::is_none")]
41    pub customer: Option<models::CreateCustomerDto>,
42    /// 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.
43    #[serde(rename = "call", skip_serializing_if = "Option::is_none")]
44    pub call: Option<models::Call>,
45}
46
47impl ServerMessageSpeechUpdate {
48    pub fn new(r#type: Type, status: Status, role: Role) -> ServerMessageSpeechUpdate {
49        ServerMessageSpeechUpdate {
50            phone_number: None,
51            r#type,
52            status,
53            role,
54            timestamp: None,
55            artifact: None,
56            assistant: None,
57            customer: None,
58            call: None,
59        }
60    }
61}
62/// This is the type of the message. \"speech-update\" is sent whenever assistant or user start or stop speaking.
63#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize, OpenApi)]
64pub enum Type {
65    #[serde(rename = "speech-update")]
66    SpeechUpdate,
67}
68
69impl Default for Type {
70    fn default() -> Type {
71        Self::SpeechUpdate
72    }
73}
74/// This is the status of the speech update.
75#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize, OpenApi)]
76pub enum Status {
77    #[serde(rename = "started")]
78    Started,
79    #[serde(rename = "stopped")]
80    Stopped,
81}
82
83impl Default for Status {
84    fn default() -> Status {
85        Self::Started
86    }
87}
88/// This is the role which the speech update is for.
89#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize, OpenApi)]
90pub enum Role {
91    #[serde(rename = "assistant")]
92    Assistant,
93    #[serde(rename = "user")]
94    User,
95}
96
97impl Default for Role {
98    fn default() -> Role {
99        Self::Assistant
100    }
101}
vapi_client/models/server_message_speech_update.rs

vapi_client/models/
server_message_speech_update.rs
