vapi_client/models/
update_computer_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 UpdateComputerToolDto {
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 'computer'
29    #[serde(rename = "name", skip_serializing_if = "Option::is_none")]
30    pub name: Option<NameTrue>,
31    /// The display width in pixels
32    #[serde(rename = "displayWidthPx", skip_serializing_if = "Option::is_none")]
33    pub display_width_px: Option<f64>,
34    /// The display height in pixels
35    #[serde(rename = "displayHeightPx", skip_serializing_if = "Option::is_none")]
36    pub display_height_px: Option<f64>,
37    /// Optional display number
38    #[serde(rename = "displayNumber", skip_serializing_if = "Option::is_none")]
39    pub display_number: Option<f64>,
40}
41
42impl UpdateComputerToolDto {
43    pub fn new() -> UpdateComputerToolDto {
44        UpdateComputerToolDto {
45            messages: None,
46            sub_type: None,
47            server: None,
48            function: None,
49            name: None,
50            display_width_px: None,
51            display_height_px: None,
52            display_number: None,
53        }
54    }
55}
56/// The sub type of tool.
57#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
58pub enum SubTypeTrue {
59    #[serde(rename = "computer_20241022")]
60    Computer20241022,
61}
62
63impl Default for SubTypeTrue {
64    fn default() -> SubTypeTrue {
65        Self::Computer20241022
66    }
67}
68/// The name of the tool, fixed to 'computer'
69#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
70pub enum NameTrue {
71    #[serde(rename = "computer")]
72    Computer,
73}
74
75impl Default for NameTrue {
76    fn default() -> NameTrue {
77        Self::Computer
78    }
79}
vapi_client/models/update_computer_tool_dto.rs

vapi_client/models/
update_computer_tool_dto.rs
