vapi_client/models/create_make_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 CreateMakeToolDto {
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. \"make\" for Make tool.
20 #[serde(rename = "type")]
21 pub r#type: TypeTrue,
22 #[serde(rename = "metadata")]
23 pub metadata: models::MakeToolMetadata,
24 /// 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.
25 #[serde(rename = "function", skip_serializing_if = "Option::is_none")]
26 pub function: Option<models::OpenAiFunction>,
27}
28
29impl CreateMakeToolDto {
30 pub fn new(r#type: TypeTrue, metadata: models::MakeToolMetadata) -> CreateMakeToolDto {
31 CreateMakeToolDto {
32 messages: None,
33 r#type,
34 metadata,
35 function: None,
36 }
37 }
38}
39/// The type of tool. \"make\" for Make tool.
40#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
41pub enum TypeTrue {
42 #[serde(rename = "make")]
43 Make,
44}
45
46impl Default for TypeTrue {
47 fn default() -> TypeTrue {
48 Self::Make
49 }
50}