Class: Vapi::CreateWorkflowBlockDto

Inherits:
Object
  • Object
show all
Defined in:
lib/vapi_server_sdk/types/create_workflow_block_dto.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(messages: OMIT, input_schema: OMIT, output_schema: OMIT, steps: OMIT, name: OMIT, additional_properties: nil) ⇒ Vapi::CreateWorkflowBlockDto

Parameters:

  • messages (Array<Vapi::CreateWorkflowBlockDtoMessagesItem>) (defaults to: OMIT) —

    These are the pre-configured messages that will be spoken to the user while the block is running.

  • input_schema (Vapi::JsonSchema) (defaults to: OMIT) —

    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.input` These are accessible as variables:

    • (Vapi::CreateWorkflowBlockDto.{input{input.propertyName}) in context of the block execution (step)

    • (Vapi::CreateWorkflowBlockDto.{stepName{stepName.input{stepName.input.propertyName}) in context of the workflow

  • output_schema (Vapi::JsonSchema) (defaults to: OMIT) —

    This is the output schema for the block. This is the output the block will return to the workflow (‘Vapi::CreateWorkflowBlockDto.{stepName{stepName.output}`). These are accessible as variables:

    • (Vapi::CreateWorkflowBlockDto.{output{output.propertyName}) in context of the block execution (step)

    • (Vapi::CreateWorkflowBlockDto.{stepName{stepName.output{stepName.output.propertyName}) in context of the workflow (read caveat #1)

    • (Vapi::CreateWorkflowBlockDto.{blockName{blockName.output{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. Vapi::CreateWorkflowBlockDto.{stepName{stepName.output{stepName.output.propertyName} will reference the latest usage of the step.

    1. 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. Vapi::CreateWorkflowBlockDto.{blockName{blockName.output{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.

  • steps (Array<Vapi::CreateWorkflowBlockDtoStepsItem>) (defaults to: OMIT) —

    These are the steps in the workflow.

  • name (String) (defaults to: OMIT) —

    This is the name of the block. This is just for your reference.

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/vapi_server_sdk/types/create_workflow_block_dto.rb', line 76

def initialize(messages: OMIT, input_schema: OMIT, output_schema: OMIT, steps: OMIT, name: OMIT,
               additional_properties: nil)
  @messages = messages if messages != OMIT
  @input_schema = input_schema if input_schema != OMIT
  @output_schema = output_schema if output_schema != OMIT
  @steps = steps if steps != OMIT
  @name = name if name != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "messages": messages,
    "inputSchema": input_schema,
    "outputSchema": output_schema,
    "steps": steps,
    "name": name
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



42
43
44
 
# File 'lib/vapi_server_sdk/types/create_workflow_block_dto.rb', line 42

def additional_properties
  @additional_properties
end

#input_schema ⇒ Vapi::JsonSchema (readonly)

Returns 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.input` These are accessible as variables:

  • (Vapi::CreateWorkflowBlockDto.{input{input.propertyName}) in context of the block execution (step)

  • (Vapi::CreateWorkflowBlockDto.{stepName{stepName.input{stepName.input.propertyName}) in context of the workflow.

Returns:

  • (Vapi::JsonSchema) —

    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.input` These are accessible as variables:

    • (Vapi::CreateWorkflowBlockDto.{input{input.propertyName}) in context of the block execution (step)

    • (Vapi::CreateWorkflowBlockDto.{stepName{stepName.input{stepName.input.propertyName}) in context of the workflow



19
20
21
 
# File 'lib/vapi_server_sdk/types/create_workflow_block_dto.rb', line 19

def input_schema
  @input_schema
end

#messages ⇒ Array<Vapi::CreateWorkflowBlockDtoMessagesItem> (readonly)

Returns These are the pre-configured messages that will be spoken to the user while the block is running.

Returns:



13
14
15
 
# File 'lib/vapi_server_sdk/types/create_workflow_block_dto.rb', line 13

def messages
  @messages
end

#name ⇒ String (readonly)

Returns This is the name of the block. This is just for your reference.

Returns:

  • (String) —

    This is the name of the block. This is just for your reference.



40
41
42
 
# File 'lib/vapi_server_sdk/types/create_workflow_block_dto.rb', line 40

def name
  @name
end

#output_schema ⇒ Vapi::JsonSchema (readonly)

This is the output schema for the block. This is the output the block will return to the workflow (‘Vapi::CreateWorkflowBlockDto.{stepName{stepName.output}`). These are accessible as variables:

  • (Vapi::CreateWorkflowBlockDto.{output{output.propertyName}) in context of the block execution (step)

  • (Vapi::CreateWorkflowBlockDto.{stepName{stepName.output{stepName.output.propertyName}) in context of the workflow (read caveat #1)

  • (Vapi::CreateWorkflowBlockDto.{blockName{blockName.output{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. Vapi::CreateWorkflowBlockDto.{stepName{stepName.output{stepName.output.propertyName} will reference the latest usage of the step.

  1. 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. Vapi::CreateWorkflowBlockDto.{blockName{blockName.output{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.

Returns:

  • (Vapi::JsonSchema) —

    This is the output schema for the block. This is the output the block will return to the workflow (‘Vapi::CreateWorkflowBlockDto.{stepName{stepName.output}`). These are accessible as variables:

    • (Vapi::CreateWorkflowBlockDto.{output{output.propertyName}) in context of the block execution (step)

    • (Vapi::CreateWorkflowBlockDto.{stepName{stepName.output{stepName.output.propertyName}) in context of the workflow (read caveat #1)

    • (Vapi::CreateWorkflowBlockDto.{blockName{blockName.output{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. Vapi::CreateWorkflowBlockDto.{stepName{stepName.output{stepName.output.propertyName} will reference the latest usage of the step.

    1. 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. Vapi::CreateWorkflowBlockDto.{blockName{blockName.output{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.



36
37
38
 
# File 'lib/vapi_server_sdk/types/create_workflow_block_dto.rb', line 36

def output_schema
  @output_schema
end

#steps ⇒ Array<Vapi::CreateWorkflowBlockDtoStepsItem> (readonly)

Returns These are the steps in the workflow.

Returns:



38
39
40
 
# File 'lib/vapi_server_sdk/types/create_workflow_block_dto.rb', line 38

def steps
  @steps
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::CreateWorkflowBlockDto

Deserialize a JSON object to an instance of CreateWorkflowBlockDto

Parameters:

  • json_object (String)

Returns:



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/vapi_server_sdk/types/create_workflow_block_dto.rb', line 99

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  messages = parsed_json["messages"]&.map do |item|
    item = item.to_json
    Vapi::CreateWorkflowBlockDtoMessagesItem.from_json(json_object: item)
  end
  if parsed_json["inputSchema"].nil?
    input_schema = nil
  else
    input_schema = parsed_json["inputSchema"].to_json
    input_schema = Vapi::JsonSchema.from_json(json_object: input_schema)
  end
  if parsed_json["outputSchema"].nil?
    output_schema = nil
  else
    output_schema = parsed_json["outputSchema"].to_json
    output_schema = Vapi::JsonSchema.from_json(json_object: output_schema)
  end
  steps = parsed_json["steps"]&.map do |item|
    item = item.to_json
    Vapi::CreateWorkflowBlockDtoStepsItem.from_json(json_object: item)
  end
  name = parsed_json["name"]
  new(
    messages: messages,
    input_schema: input_schema,
    output_schema: output_schema,
    steps: steps,
    name: name,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


146
147
148
149
150
151
152
 
# File 'lib/vapi_server_sdk/types/create_workflow_block_dto.rb', line 146

def self.validate_raw(obj:)
  obj.messages&.is_a?(Array) != false || raise("Passed value for field obj.messages is not the expected type, validation failed.")
  obj.input_schema.nil? || Vapi::JsonSchema.validate_raw(obj: obj.input_schema)
  obj.output_schema.nil? || Vapi::JsonSchema.validate_raw(obj: obj.output_schema)
  obj.steps&.is_a?(Array) != false || raise("Passed value for field obj.steps is not the expected type, validation failed.")
  obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of CreateWorkflowBlockDto to a JSON object

Returns:

  • (String) 


136
137
138
 
# File 'lib/vapi_server_sdk/types/create_workflow_block_dto.rb', line 136

def to_json(*_args)
  @_field_set&.to_json
end