vapi_client/models/
create_bash_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 CreateBashToolDto {
16    /// 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.
17    #[serde(rename = "messages", skip_serializing_if = "Option::is_none")]
18    pub messages: Option<Vec<models::CreateDtmfToolDtoMessagesInner>>,
19    /// The type of tool. \"bash\" for Bash tool.
20    #[serde(rename = "type")]
21    pub r#type: TypeTrue,
22    /// The sub type of tool.
23    #[serde(rename = "subType")]
24    pub sub_type: SubTypeTrue,
25    ///    This is the server where a `tool-calls` webhook will be sent.    Notes:   - Webhook is sent to this server when a tool call is made.   - Webhook contains the call, assistant, and phone number objects.   - Webhook contains the variables set on the assistant.   - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.   - Webhook expects a response with tool call result.
26    #[serde(rename = "server", skip_serializing_if = "Option::is_none")]
27    pub server: Option<models::Server>,
28    /// The name of the tool, fixed to 'bash'
29    #[serde(rename = "name")]
30    pub name: NameTrue,
31    /// 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.
32    #[serde(rename = "function", skip_serializing_if = "Option::is_none")]
33    pub function: Option<models::OpenAiFunction>,
34}
35
36impl CreateBashToolDto {
37    pub fn new(r#type: TypeTrue, sub_type: SubTypeTrue, name: NameTrue) -> CreateBashToolDto {
38        CreateBashToolDto {
39            messages: None,
40            r#type,
41            sub_type,
42            server: None,
43            name,
44            function: None,
45        }
46    }
47}
48/// The type of tool. \"bash\" for Bash tool.
49#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
50pub enum TypeTrue {
51    #[serde(rename = "bash")]
52    Bash,
53}
54
55impl Default for TypeTrue {
56    fn default() -> TypeTrue {
57        Self::Bash
58    }
59}
60/// The sub type of tool.
61#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
62pub enum SubTypeTrue {
63    #[serde(rename = "bash_20241022")]
64    Bash20241022,
65}
66
67impl Default for SubTypeTrue {
68    fn default() -> SubTypeTrue {
69        Self::Bash20241022
70    }
71}
72/// The name of the tool, fixed to 'bash'
73#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
74pub enum NameTrue {
75    #[serde(rename = "bash")]
76    Bash,
77}
78
79impl Default for NameTrue {
80    fn default() -> NameTrue {
81        Self::Bash
82    }
83}
vapi_client/models/create_bash_tool_dto.rs

vapi_client/models/
create_bash_tool_dto.rs
