vapi_client/models/computer_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 ComputerTool {
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. \"computer\" for Computer 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 'computer'
44 #[serde(rename = "name")]
45 pub name: NameTrue,
46 /// The display width in pixels
47 #[serde(rename = "displayWidthPx")]
48 pub display_width_px: f64,
49 /// The display height in pixels
50 #[serde(rename = "displayHeightPx")]
51 pub display_height_px: f64,
52 /// Optional display number
53 #[serde(rename = "displayNumber", skip_serializing_if = "Option::is_none")]
54 pub display_number: Option<f64>,
55}
56
57impl ComputerTool {
58 pub fn new(
59 r#type: TypeTrue,
60 sub_type: SubTypeTrue,
61 id: String,
62 org_id: String,
63 created_at: String,
64 updated_at: String,
65 name: NameTrue,
66 display_width_px: f64,
67 display_height_px: f64,
68 ) -> ComputerTool {
69 ComputerTool {
70 messages: None,
71 r#type,
72 sub_type,
73 server: None,
74 id,
75 org_id,
76 created_at,
77 updated_at,
78 function: None,
79 name,
80 display_width_px,
81 display_height_px,
82 display_number: None,
83 }
84 }
85}
86/// The type of tool. \"computer\" for Computer tool.
87#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
88pub enum TypeTrue {
89 #[serde(rename = "computer")]
90 Computer,
91}
92
93impl Default for TypeTrue {
94 fn default() -> TypeTrue {
95 Self::Computer
96 }
97}
98/// The sub type of tool.
99#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
100pub enum SubTypeTrue {
101 #[serde(rename = "computer_20241022")]
102 Computer20241022,
103}
104
105impl Default for SubTypeTrue {
106 fn default() -> SubTypeTrue {
107 Self::Computer20241022
108 }
109}
110/// The name of the tool, fixed to 'computer'
111#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
112pub enum NameTrue {
113 #[serde(rename = "computer")]
114 Computer,
115}
116
117impl Default for NameTrue {
118 fn default() -> NameTrue {
119 Self::Computer
120 }
121}