vapi_client/models/
workflow_block.rs

1/*
2 * Vapi API
3 *
4 * API for building voice assistants
5 *
6 * The version of the OpenAPI document: 1.0
7 *
8 * Generated by: https://openapi-generator.tech
9 */
10
11use serde::{Deserialize, Serialize};
12
13use crate::models;
14
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct WorkflowBlock {
17    /// These are the pre-configured messages that will be spoken to the user while the block is running.
18    #[serde(rename = "messages", skip_serializing_if = "Option::is_none")]
19    pub messages: Option<Vec<models::ConversationBlockMessagesInner>>,
20    /// This is the input schema for the block. This is the input the block needs to run. It's given to the block as `steps[0].input`  These are accessible as variables: - ({{input.propertyName}}) in context of the block execution (step) - ({{stepName.input.propertyName}}) in context of the workflow
21    #[serde(rename = "inputSchema", skip_serializing_if = "Option::is_none")]
22    pub input_schema: Option<models::JsonSchema>,
23    /// This is the output schema for the block. This is the output the block will return to the workflow (`{{stepName.output}}`).  These are accessible as variables: - ({{output.propertyName}}) in context of the block execution (step) - ({{stepName.output.propertyName}}) in context of the workflow (read caveat #1) - ({{blockName.output.propertyName}}) in context of the workflow (read caveat #2)  Caveats: 1. a workflow can execute a step multiple times. example, if a loop is used in the graph. {{stepName.output.propertyName}} will reference the latest usage of the step. 2. a workflow can execute a block multiple times. example, if a step is called multiple times or if a block is used in multiple steps. {{blockName.output.propertyName}} will reference the latest usage of the block. this liquid variable is just provided for convenience when creating blocks outside of a workflow with steps.
24    #[serde(rename = "outputSchema", skip_serializing_if = "Option::is_none")]
25    pub output_schema: Option<models::JsonSchema>,
26    /// This creates a workflow which can contain any number of steps (block executions).
27    #[serde(rename = "type")]
28    pub r#type: Type,
29    /// These are the steps in the workflow.
30    #[serde(rename = "steps", skip_serializing_if = "Option::is_none")]
31    pub steps: Option<Vec<models::VapiModelStepsInner>>,
32    /// This is the unique identifier for the block.
33    #[serde(rename = "id")]
34    pub id: String,
35    /// This is the unique identifier for the organization that this block belongs to.
36    #[serde(rename = "orgId")]
37    pub org_id: String,
38    /// This is the ISO 8601 date-time string of when the block was created.
39    #[serde(rename = "createdAt")]
40    pub created_at: String,
41    /// This is the ISO 8601 date-time string of when the block was last updated.
42    #[serde(rename = "updatedAt")]
43    pub updated_at: String,
44    /// This is the name of the block. This is just for your reference.
45    #[serde(rename = "name", skip_serializing_if = "Option::is_none")]
46    pub name: Option<String>,
47}
48
49impl WorkflowBlock {
50    pub fn new(
51        r#type: Type,
52        id: String,
53        org_id: String,
54        created_at: String,
55        updated_at: String,
56    ) -> WorkflowBlock {
57        WorkflowBlock {
58            messages: None,
59            input_schema: None,
60            output_schema: None,
61            r#type,
62            steps: None,
63            id,
64            org_id,
65            created_at,
66            updated_at,
67            name: None,
68        }
69    }
70}
71/// This creates a workflow which can contain any number of steps (block executions).
72#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
73pub enum Type {
74    #[serde(rename = "workflow")]
75    Workflow,
76}
77
78impl Default for Type {
79    fn default() -> Type {
80        Self::Workflow
81    }
82}
vapi_client/models/workflow_block.rs

vapi_client/models/
workflow_block.rs
