vapi_client/models/
update_text_editor_tool_dto.rs

1/*
2 * Vapi API
3 *
4 * Voice AI for developers.
5 *
6 * The version of the OpenAPI document: 1.0
7 * 
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
15pub struct UpdateTextEditorToolDto {
16    /// This determines if the tool is async.  If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.  If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.  Defaults to synchronous (`false`).
17    #[serde(rename = "async", skip_serializing_if = "Option::is_none")]
18    pub r#async: Option<bool>,
19    /// These are the messages that will be spoken to the user as the tool is running.  For some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.
20    #[serde(rename = "messages", skip_serializing_if = "Option::is_none")]
21    pub messages: Option<Vec<models::CreateDtmfToolDtoMessagesInner>>,
22    /// The sub type of tool.
23    #[serde(rename = "subType", skip_serializing_if = "Option::is_none")]
24    pub sub_type: Option<SubType>,
25    /// This is the function definition of the tool.  For `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.  An example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.
26    #[serde(rename = "function", skip_serializing_if = "Option::is_none")]
27    pub function: Option<Box<models::OpenAiFunction>>,
28    /// This is the server that will be hit when this tool is requested by the model.  All requests will be sent with the call object among other things. You can find more details in the Server URL documentation.  This overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.
29    #[serde(rename = "server", skip_serializing_if = "Option::is_none")]
30    pub server: Option<Box<models::Server>>,
31    /// The name of the tool, fixed to 'str_replace_editor'
32    #[serde(rename = "name", skip_serializing_if = "Option::is_none")]
33    pub name: Option<Name>,
34}
35
36impl UpdateTextEditorToolDto {
37    pub fn new() -> UpdateTextEditorToolDto {
38        UpdateTextEditorToolDto {
39            r#async: None,
40            messages: None,
41            sub_type: None,
42            function: None,
43            server: None,
44            name: None,
45        }
46    }
47}
48/// The sub type of tool.
49#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
50pub enum SubType {
51    #[serde(rename = "text_editor_20241022")]
52    TextEditor20241022,
53}
54
55impl Default for SubType {
56    fn default() -> SubType {
57        Self::TextEditor20241022
58    }
59}
60/// The name of the tool, fixed to 'str_replace_editor'
61#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
62pub enum Name {
63    #[serde(rename = "str_replace_editor")]
64    StrReplaceEditor,
65}
66
67impl Default for Name {
68    fn default() -> Name {
69        Self::StrReplaceEditor
70    }
71}
72
vapi_client/models/update_text_editor_tool_dto.rs

vapi_client/models/
update_text_editor_tool_dto.rs
