vapi_client/models/transfer_call_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 TransferCallTool {
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 #[serde(rename = "type")]
20 pub r#type: TypeTrue,
21 /// These are the destinations that the call can be transferred to. If no destinations are provided, server.url will be used to get the transfer destination once the tool is called.
22 #[serde(rename = "destinations", skip_serializing_if = "Option::is_none")]
23 pub destinations: Option<Vec<models::CreateTransferCallToolDtoDestinationsInner>>,
24 /// This is the unique identifier for the tool.
25 #[serde(rename = "id")]
26 pub id: String,
27 /// This is the unique identifier for the organization that this tool belongs to.
28 #[serde(rename = "orgId")]
29 pub org_id: String,
30 /// This is the ISO 8601 date-time string of when the tool was created.
31 #[serde(rename = "createdAt")]
32 pub created_at: String,
33 /// This is the ISO 8601 date-time string of when the tool was last updated.
34 #[serde(rename = "updatedAt")]
35 pub updated_at: String,
36 /// 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.
37 #[serde(rename = "function", skip_serializing_if = "Option::is_none")]
38 pub function: Option<models::OpenAiFunction>,
39}
40
41impl TransferCallTool {
42 pub fn new(
43 r#type: TypeTrue,
44 id: String,
45 org_id: String,
46 created_at: String,
47 updated_at: String,
48 ) -> TransferCallTool {
49 TransferCallTool {
50 messages: None,
51 r#type,
52 destinations: None,
53 id,
54 org_id,
55 created_at,
56 updated_at,
57 function: None,
58 }
59 }
60}
61///
62#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
63pub enum TypeTrue {
64 #[serde(rename = "transferCall")]
65 TransferCall,
66}
67
68impl Default for TypeTrue {
69 fn default() -> TypeTrue {
70 Self::TransferCall
71 }
72}