vapi_client/models/update_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 UpdateBashToolDto {
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 sub type of tool.
20 #[serde(rename = "subType", skip_serializing_if = "Option::is_none")]
21 pub sub_type: Option<SubTypeTrue>,
22 /// 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.
23 #[serde(rename = "server", skip_serializing_if = "Option::is_none")]
24 pub server: Option<models::Server>,
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<models::OpenAiFunction>,
28 /// The name of the tool, fixed to 'bash'
29 #[serde(rename = "name", skip_serializing_if = "Option::is_none")]
30 pub name: Option<NameTrue>,
31}
32
33impl UpdateBashToolDto {
34 pub fn new() -> UpdateBashToolDto {
35 UpdateBashToolDto {
36 messages: None,
37 sub_type: None,
38 server: None,
39 function: None,
40 name: None,
41 }
42 }
43}
44/// The sub type of tool.
45#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
46pub enum SubTypeTrue {
47 #[serde(rename = "bash_20241022")]
48 Bash20241022,
49}
50
51impl Default for SubTypeTrue {
52 fn default() -> SubTypeTrue {
53 Self::Bash20241022
54 }
55}
56/// The name of the tool, fixed to 'bash'
57#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
58pub enum NameTrue {
59 #[serde(rename = "bash")]
60 Bash,
61}
62
63impl Default for NameTrue {
64 fn default() -> NameTrue {
65 Self::Bash
66 }
67}