vapi_client/models/update_workflow_block_dto.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};
12use utoipa::ToSchema;
13
14
15use crate::models;
16
17#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, ToSchema)]
18pub struct UpdateWorkflowBlockDto {
19 /// These are the pre-configured messages that will be spoken to the user while the block is running.
20 #[serde(rename = "messages", skip_serializing_if = "Option::is_none")]
21 pub messages: Option<Vec<models::ConversationBlockMessagesInner>>,
22 /// 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
23 #[serde(rename = "inputSchema", skip_serializing_if = "Option::is_none")]
24 pub input_schema: Option<models::JsonSchema>,
25 /// 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.
26 #[serde(rename = "outputSchema", skip_serializing_if = "Option::is_none")]
27 pub output_schema: Option<models::JsonSchema>,
28 /// These are the steps in the workflow.
29 #[serde(rename = "steps", skip_serializing_if = "Option::is_none")]
30 pub steps: Option<Vec<models::VapiModelStepsInner>>,
31 /// This is the name of the block. This is just for your reference.
32 #[serde(rename = "name", skip_serializing_if = "Option::is_none")]
33 pub name: Option<String>,
34}
35
36impl UpdateWorkflowBlockDto {
37 pub fn new() -> UpdateWorkflowBlockDto {
38 UpdateWorkflowBlockDto {
39 messages: None,
40 input_schema: None,
41 output_schema: None,
42 steps: None,
43 name: None,
44 }
45 }
46}