vapi_client/models/
bash_tool.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 BashTool {
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    /// This is the unique identifier for the tool.
29    #[serde(rename = "id")]
30    pub id: String,
31    /// This is the unique identifier for the organization that this tool belongs to.
32    #[serde(rename = "orgId")]
33    pub org_id: String,
34    /// This is the ISO 8601 date-time string of when the tool was created.
35    #[serde(rename = "createdAt")]
36    pub created_at: String,
37    /// This is the ISO 8601 date-time string of when the tool was last updated.
38    #[serde(rename = "updatedAt")]
39    pub updated_at: String,
40    /// 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.
41    #[serde(rename = "function", skip_serializing_if = "Option::is_none")]
42    pub function: Option<models::OpenAiFunction>,
43    /// The name of the tool, fixed to 'bash'
44    #[serde(rename = "name")]
45    pub name: NameTrue,
46}
47
48impl BashTool {
49    pub fn new(
50        r#type: TypeTrue,
51        sub_type: SubTypeTrue,
52        id: String,
53        org_id: String,
54        created_at: String,
55        updated_at: String,
56        name: NameTrue,
57    ) -> BashTool {
58        BashTool {
59            messages: None,
60            r#type,
61            sub_type,
62            server: None,
63            id,
64            org_id,
65            created_at,
66            updated_at,
67            function: None,
68            name,
69        }
70    }
71}
72/// The type of tool. \"bash\" for Bash tool.
73#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
74pub enum TypeTrue {
75    #[serde(rename = "bash")]
76    Bash,
77}
78
79impl Default for TypeTrue {
80    fn default() -> TypeTrue {
81        Self::Bash
82    }
83}
84/// The sub type of tool.
85#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
86pub enum SubTypeTrue {
87    #[serde(rename = "bash_20241022")]
88    Bash20241022,
89}
90
91impl Default for SubTypeTrue {
92    fn default() -> SubTypeTrue {
93        Self::Bash20241022
94    }
95}
96/// The name of the tool, fixed to 'bash'
97#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
98pub enum NameTrue {
99    #[serde(rename = "bash")]
100    Bash,
101}
102
103impl Default for NameTrue {
104    fn default() -> NameTrue {
105        Self::Bash
106    }
107}
vapi_client/models/bash_tool.rs

vapi_client/models/
bash_tool.rs
