vapi_server_sdk 0.5.0 → 0.9.1

data/lib/vapi_server_sdk/types/create_vapi_phone_number_dto.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "create_vapi_phone_number_dto_fallback_destination"
+require_relative "phone_number_hook_call_ringing"
 require_relative "sip_authentication"
 require_relative "server"
 require "ostruct"
@@ -15,6 +16,8 @@ module Vapi
     #  If this is not set and above conditions are met, the inbound call is hung up
     #  with an error message.
     attr_reader :fallback_destination
+    # @return [Array<Vapi::PhoneNumberHookCallRinging>] This is the hooks that will be used for incoming calls to this phone number.
+    attr_reader :hooks
     # @return [String] This is the area code of the phone number to purchase.
     attr_reader :number_desired_area_code
     # @return [String] This is the SIP URI of the phone number. You can SIP INVITE this. The assistant
@@ -28,14 +31,22 @@ module Vapi
     # @return [String] This is the name of the phone number. This is just for your own reference.
     attr_reader :name
     # @return [String] This is the assistant that will be used for incoming calls to this phone number.
-    #  If neither `assistantId` nor `squadId` is set, `assistant-request` will be sent
-    #  to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the
-    #  shape of the message and response that is expected.
+    #  If neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request`
+    #  will be sent to your Server URL. Check `ServerMessage` and
+    #  `ServerMessageResponse` for the shape of the message and response that is
+    #  expected.
     attr_reader :assistant_id
+    # @return [String] This is the workflow that will be used for incoming calls to this phone number.
+    #  If neither `assistantId`, `squadId`, nor `workflowId` is set,
+    #  `assistant-request` will be sent to your Server URL. Check `ServerMessage` and
+    #  `ServerMessageResponse` for the shape of the message and response that is
+    #  expected.
+    attr_reader :workflow_id
     # @return [String] This is the squad that will be used for incoming calls to this phone number.
-    #  If neither `assistantId` nor `squadId` is set, `assistant-request` will be sent
-    #  to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the
-    #  shape of the message and response that is expected.
+    #  If neither `assistantId`, `squadId`, nor `workflowId` is set,
+    #  `assistant-request` will be sent to your Server URL. Check `ServerMessage` and
+    #  `ServerMessageResponse` for the shape of the message and response that is
+    #  expected.
     attr_reader :squad_id
     # @return [Vapi::Server] This is where Vapi will send webhooks. You can find all webhooks available along
     #  with their shape in ServerMessage schema.
@@ -58,6 +69,7 @@ module Vapi
     #  3. and, `assistant-request` message to the `serverUrl` fails
     #  If this is not set and above conditions are met, the inbound call is hung up
     #  with an error message.
+    # @param hooks [Array<Vapi::PhoneNumberHookCallRinging>] This is the hooks that will be used for incoming calls to this phone number.
     # @param number_desired_area_code [String] This is the area code of the phone number to purchase.
     # @param sip_uri [String] This is the SIP URI of the phone number. You can SIP INVITE this. The assistant
     #  attached to this number will answer.
@@ -67,13 +79,20 @@ module Vapi
     #  accepted.
     # @param name [String] This is the name of the phone number. This is just for your own reference.
     # @param assistant_id [String] This is the assistant that will be used for incoming calls to this phone number.
-    #  If neither `assistantId` nor `squadId` is set, `assistant-request` will be sent
-    #  to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the
-    #  shape of the message and response that is expected.
+    #  If neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request`
+    #  will be sent to your Server URL. Check `ServerMessage` and
+    #  `ServerMessageResponse` for the shape of the message and response that is
+    #  expected.
+    # @param workflow_id [String] This is the workflow that will be used for incoming calls to this phone number.
+    #  If neither `assistantId`, `squadId`, nor `workflowId` is set,
+    #  `assistant-request` will be sent to your Server URL. Check `ServerMessage` and
+    #  `ServerMessageResponse` for the shape of the message and response that is
+    #  expected.
     # @param squad_id [String] This is the squad that will be used for incoming calls to this phone number.
-    #  If neither `assistantId` nor `squadId` is set, `assistant-request` will be sent
-    #  to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the
-    #  shape of the message and response that is expected.
+    #  If neither `assistantId`, `squadId`, nor `workflowId` is set,
+    #  `assistant-request` will be sent to your Server URL. Check `ServerMessage` and
+    #  `ServerMessageResponse` for the shape of the message and response that is
+    #  expected.
     # @param server [Vapi::Server] This is where Vapi will send webhooks. You can find all webhooks available along
     #  with their shape in ServerMessage schema.
     #  The order of precedence is:
@@ -82,24 +101,28 @@ module Vapi
     #  3. org.server
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::CreateVapiPhoneNumberDto]
-    def initialize(fallback_destination: OMIT, number_desired_area_code: OMIT, sip_uri: OMIT, authentication: OMIT,
-                   name: OMIT, assistant_id: OMIT, squad_id: OMIT, server: OMIT, additional_properties: nil)
+    def initialize(fallback_destination: OMIT, hooks: OMIT, number_desired_area_code: OMIT, sip_uri: OMIT,
+                   authentication: OMIT, name: OMIT, assistant_id: OMIT, workflow_id: OMIT, squad_id: OMIT, server: OMIT, additional_properties: nil)
       @fallback_destination = fallback_destination if fallback_destination != OMIT
+      @hooks = hooks if hooks != OMIT
       @number_desired_area_code = number_desired_area_code if number_desired_area_code != OMIT
       @sip_uri = sip_uri if sip_uri != OMIT
       @authentication = authentication if authentication != OMIT
       @name = name if name != OMIT
       @assistant_id = assistant_id if assistant_id != OMIT
+      @workflow_id = workflow_id if workflow_id != OMIT
       @squad_id = squad_id if squad_id != OMIT
       @server = server if server != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "fallbackDestination": fallback_destination,
+        "hooks": hooks,
         "numberDesiredAreaCode": number_desired_area_code,
         "sipUri": sip_uri,
         "authentication": authentication,
         "name": name,
         "assistantId": assistant_id,
+        "workflowId": workflow_id,
         "squadId": squad_id,
         "server": server
       }.reject do |_k, v|
@@ -120,6 +143,10 @@ module Vapi
         fallback_destination = parsed_json["fallbackDestination"].to_json
         fallback_destination = Vapi::CreateVapiPhoneNumberDtoFallbackDestination.from_json(json_object: fallback_destination)
       end
+      hooks = parsed_json["hooks"]&.map do |item|
+        item = item.to_json
+        Vapi::PhoneNumberHookCallRinging.from_json(json_object: item)
+      end
       number_desired_area_code = parsed_json["numberDesiredAreaCode"]
       sip_uri = parsed_json["sipUri"]
       if parsed_json["authentication"].nil?
@@ -130,6 +157,7 @@ module Vapi
       end
       name = parsed_json["name"]
       assistant_id = parsed_json["assistantId"]
+      workflow_id = parsed_json["workflowId"]
       squad_id = parsed_json["squadId"]
       if parsed_json["server"].nil?
         server = nil
@@ -139,11 +167,13 @@ module Vapi
       end
       new(
         fallback_destination: fallback_destination,
+        hooks: hooks,
         number_desired_area_code: number_desired_area_code,
         sip_uri: sip_uri,
         authentication: authentication,
         name: name,
         assistant_id: assistant_id,
+        workflow_id: workflow_id,
         squad_id: squad_id,
         server: server,
         additional_properties: struct
@@ -165,11 +195,13 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       obj.fallback_destination.nil? || Vapi::CreateVapiPhoneNumberDtoFallbackDestination.validate_raw(obj: obj.fallback_destination)
+      obj.hooks&.is_a?(Array) != false || raise("Passed value for field obj.hooks is not the expected type, validation failed.")
       obj.number_desired_area_code&.is_a?(String) != false || raise("Passed value for field obj.number_desired_area_code is not the expected type, validation failed.")
       obj.sip_uri&.is_a?(String) != false || raise("Passed value for field obj.sip_uri is not the expected type, validation failed.")
       obj.authentication.nil? || Vapi::SipAuthentication.validate_raw(obj: obj.authentication)
       obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
       obj.assistant_id&.is_a?(String) != false || raise("Passed value for field obj.assistant_id is not the expected type, validation failed.")
+      obj.workflow_id&.is_a?(String) != false || raise("Passed value for field obj.workflow_id is not the expected type, validation failed.")
       obj.squad_id&.is_a?(String) != false || raise("Passed value for field obj.squad_id is not the expected type, validation failed.")
       obj.server.nil? || Vapi::Server.validate_raw(obj: obj.server)
     end

data/lib/vapi_server_sdk/types/create_voicemail_tool_dto.rb

@@ -2,24 +2,20 @@
 
 require_relative "create_voicemail_tool_dto_messages_item"
 require_relative "open_ai_function"
-require_relative "server"
 require "ostruct"
 require "json"
 
 module Vapi
   class CreateVoicemailToolDto
-    # @return [Boolean] This determines if the tool is async.
-    #  If async, the assistant will move forward without waiting for your server to
-    #  respond. This is useful if you just want to trigger something on your server.
-    #  If sync, the assistant will wait for your server to respond. This is useful if
-    #  want assistant to respond with the result from your server.
-    #  Defaults to synchronous (`false`).
-    attr_reader :async
     # @return [Array<Vapi::CreateVoicemailToolDtoMessagesItem>] 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.
     attr_reader :messages
+    # @return [String] The type of tool. "voicemail". This uses the model itself to determine if a
+    #  voicemil was reached. Can be used alternatively/alongside with
+    #  TwilioVoicemailDetection
+    attr_reader :type
     # @return [Vapi::OpenAiFunction] 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
@@ -30,13 +26,6 @@ module Vapi
     #  "request-complete" messages. One of these messages will be triggered if the
     #  `messages[].conditions` matches the "reason" argument.
     attr_reader :function
-    # @return [Vapi::Server] This is the server that will be hit when this tool is requested by the model.
-    #  All requests will be sent with the call object among other things. You can find
-    #  more details in the Server URL documentation.
-    #  This overrides the serverUrl set on the org and the phoneNumber. Order of
-    #  precedence: highest tool.server.url, then assistant.serverUrl, then
-    #  phoneNumber.serverUrl, then org.serverUrl.
-    attr_reader :server
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -45,16 +34,13 @@ module Vapi
 
     OMIT = Object.new
 
-    # @param async [Boolean] This determines if the tool is async.
-    #  If async, the assistant will move forward without waiting for your server to
-    #  respond. This is useful if you just want to trigger something on your server.
-    #  If sync, the assistant will wait for your server to respond. This is useful if
-    #  want assistant to respond with the result from your server.
-    #  Defaults to synchronous (`false`).
     # @param messages [Array<Vapi::CreateVoicemailToolDtoMessagesItem>] 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.
+    # @param type [String] The type of tool. "voicemail". This uses the model itself to determine if a
+    #  voicemil was reached. Can be used alternatively/alongside with
+    #  TwilioVoicemailDetection
     # @param function [Vapi::OpenAiFunction] 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
@@ -64,21 +50,14 @@ module Vapi
     #  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.
-    # @param server [Vapi::Server] This is the server that will be hit when this tool is requested by the model.
-    #  All requests will be sent with the call object among other things. You can find
-    #  more details in the Server URL documentation.
-    #  This overrides the serverUrl set on the org and the phoneNumber. Order of
-    #  precedence: highest tool.server.url, then assistant.serverUrl, then
-    #  phoneNumber.serverUrl, then org.serverUrl.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::CreateVoicemailToolDto]
-    def initialize(async: OMIT, messages: OMIT, function: OMIT, server: OMIT, additional_properties: nil)
-      @async = async if async != OMIT
+    def initialize(type:, messages: OMIT, function: OMIT, additional_properties: nil)
       @messages = messages if messages != OMIT
+      @type = type
       @function = function if function != OMIT
-      @server = server if server != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "async": async, "messages": messages, "function": function, "server": server }.reject do |_k, v|
+      @_field_set = { "messages": messages, "type": type, "function": function }.reject do |_k, v|
         v == OMIT
       end
     end
@@ -90,28 +69,21 @@ module Vapi
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      async = parsed_json["async"]
       messages = parsed_json["messages"]&.map do |item|
         item = item.to_json
         Vapi::CreateVoicemailToolDtoMessagesItem.from_json(json_object: item)
       end
+      type = parsed_json["type"]
       if parsed_json["function"].nil?
         function = nil
       else
         function = parsed_json["function"].to_json
         function = Vapi::OpenAiFunction.from_json(json_object: function)
       end
-      if parsed_json["server"].nil?
-        server = nil
-      else
-        server = parsed_json["server"].to_json
-        server = Vapi::Server.from_json(json_object: server)
-      end
       new(
-        async: async,
         messages: messages,
+        type: type,
         function: function,
-        server: server,
         additional_properties: struct
       )
     end
@@ -130,10 +102,9 @@ module Vapi
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
-      obj.async&.is_a?(Boolean) != false || raise("Passed value for field obj.async is not the expected type, validation failed.")
       obj.messages&.is_a?(Array) != false || raise("Passed value for field obj.messages is not the expected type, validation failed.")
+      obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
       obj.function.nil? || Vapi::OpenAiFunction.validate_raw(obj: obj.function)
-      obj.server.nil? || Vapi::Server.validate_raw(obj: obj.server)
     end
   end
 end

data/lib/vapi_server_sdk/types/create_vonage_phone_number_dto.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "create_vonage_phone_number_dto_fallback_destination"
+require_relative "phone_number_hook_call_ringing"
 require_relative "server"
 require "ostruct"
 require "json"
@@ -14,22 +15,33 @@ module Vapi
     #  If this is not set and above conditions are met, the inbound call is hung up
     #  with an error message.
     attr_reader :fallback_destination
+    # @return [Array<Vapi::PhoneNumberHookCallRinging>] This is the hooks that will be used for incoming calls to this phone number.
+    attr_reader :hooks
     # @return [String] These are the digits of the phone number you own on your Vonage.
     attr_reader :number
-    # @return [String] This is the credential that is used to make outgoing calls, and do operations
-    #  like call transfer and hang up.
+    # @return [String] This is the credential you added in dashboard.vapi.ai/keys. This is used to
+    #  configure the number to send inbound calls to Vapi, make outbound calls and do
+    #  live call updates like transfers and hangups.
     attr_reader :credential_id
     # @return [String] This is the name of the phone number. This is just for your own reference.
     attr_reader :name
     # @return [String] This is the assistant that will be used for incoming calls to this phone number.
-    #  If neither `assistantId` nor `squadId` is set, `assistant-request` will be sent
-    #  to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the
-    #  shape of the message and response that is expected.
+    #  If neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request`
+    #  will be sent to your Server URL. Check `ServerMessage` and
+    #  `ServerMessageResponse` for the shape of the message and response that is
+    #  expected.
     attr_reader :assistant_id
+    # @return [String] This is the workflow that will be used for incoming calls to this phone number.
+    #  If neither `assistantId`, `squadId`, nor `workflowId` is set,
+    #  `assistant-request` will be sent to your Server URL. Check `ServerMessage` and
+    #  `ServerMessageResponse` for the shape of the message and response that is
+    #  expected.
+    attr_reader :workflow_id
     # @return [String] This is the squad that will be used for incoming calls to this phone number.
-    #  If neither `assistantId` nor `squadId` is set, `assistant-request` will be sent
-    #  to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the
-    #  shape of the message and response that is expected.
+    #  If neither `assistantId`, `squadId`, nor `workflowId` is set,
+    #  `assistant-request` will be sent to your Server URL. Check `ServerMessage` and
+    #  `ServerMessageResponse` for the shape of the message and response that is
+    #  expected.
     attr_reader :squad_id
     # @return [Vapi::Server] This is where Vapi will send webhooks. You can find all webhooks available along
     #  with their shape in ServerMessage schema.
@@ -52,18 +64,27 @@ module Vapi
     #  3. and, `assistant-request` message to the `serverUrl` fails
     #  If this is not set and above conditions are met, the inbound call is hung up
     #  with an error message.
+    # @param hooks [Array<Vapi::PhoneNumberHookCallRinging>] This is the hooks that will be used for incoming calls to this phone number.
     # @param number [String] These are the digits of the phone number you own on your Vonage.
-    # @param credential_id [String] This is the credential that is used to make outgoing calls, and do operations
-    #  like call transfer and hang up.
+    # @param credential_id [String] This is the credential you added in dashboard.vapi.ai/keys. This is used to
+    #  configure the number to send inbound calls to Vapi, make outbound calls and do
+    #  live call updates like transfers and hangups.
     # @param name [String] This is the name of the phone number. This is just for your own reference.
     # @param assistant_id [String] This is the assistant that will be used for incoming calls to this phone number.
-    #  If neither `assistantId` nor `squadId` is set, `assistant-request` will be sent
-    #  to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the
-    #  shape of the message and response that is expected.
+    #  If neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request`
+    #  will be sent to your Server URL. Check `ServerMessage` and
+    #  `ServerMessageResponse` for the shape of the message and response that is
+    #  expected.
+    # @param workflow_id [String] This is the workflow that will be used for incoming calls to this phone number.
+    #  If neither `assistantId`, `squadId`, nor `workflowId` is set,
+    #  `assistant-request` will be sent to your Server URL. Check `ServerMessage` and
+    #  `ServerMessageResponse` for the shape of the message and response that is
+    #  expected.
     # @param squad_id [String] This is the squad that will be used for incoming calls to this phone number.
-    #  If neither `assistantId` nor `squadId` is set, `assistant-request` will be sent
-    #  to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the
-    #  shape of the message and response that is expected.
+    #  If neither `assistantId`, `squadId`, nor `workflowId` is set,
+    #  `assistant-request` will be sent to your Server URL. Check `ServerMessage` and
+    #  `ServerMessageResponse` for the shape of the message and response that is
+    #  expected.
     # @param server [Vapi::Server] This is where Vapi will send webhooks. You can find all webhooks available along
     #  with their shape in ServerMessage schema.
     #  The order of precedence is:
@@ -72,22 +93,26 @@ module Vapi
     #  3. org.server
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::CreateVonagePhoneNumberDto]
-    def initialize(number:, credential_id:, fallback_destination: OMIT, name: OMIT, assistant_id: OMIT, squad_id: OMIT,
-                   server: OMIT, additional_properties: nil)
+    def initialize(number:, credential_id:, fallback_destination: OMIT, hooks: OMIT, name: OMIT, assistant_id: OMIT,
+                   workflow_id: OMIT, squad_id: OMIT, server: OMIT, additional_properties: nil)
       @fallback_destination = fallback_destination if fallback_destination != OMIT
+      @hooks = hooks if hooks != OMIT
       @number = number
       @credential_id = credential_id
       @name = name if name != OMIT
       @assistant_id = assistant_id if assistant_id != OMIT
+      @workflow_id = workflow_id if workflow_id != OMIT
       @squad_id = squad_id if squad_id != OMIT
       @server = server if server != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "fallbackDestination": fallback_destination,
+        "hooks": hooks,
         "number": number,
         "credentialId": credential_id,
         "name": name,
         "assistantId": assistant_id,
+        "workflowId": workflow_id,
         "squadId": squad_id,
         "server": server
       }.reject do |_k, v|
@@ -108,10 +133,15 @@ module Vapi
         fallback_destination = parsed_json["fallbackDestination"].to_json
         fallback_destination = Vapi::CreateVonagePhoneNumberDtoFallbackDestination.from_json(json_object: fallback_destination)
       end
+      hooks = parsed_json["hooks"]&.map do |item|
+        item = item.to_json
+        Vapi::PhoneNumberHookCallRinging.from_json(json_object: item)
+      end
       number = parsed_json["number"]
       credential_id = parsed_json["credentialId"]
       name = parsed_json["name"]
       assistant_id = parsed_json["assistantId"]
+      workflow_id = parsed_json["workflowId"]
       squad_id = parsed_json["squadId"]
       if parsed_json["server"].nil?
         server = nil
@@ -121,10 +151,12 @@ module Vapi
       end
       new(
         fallback_destination: fallback_destination,
+        hooks: hooks,
         number: number,
         credential_id: credential_id,
         name: name,
         assistant_id: assistant_id,
+        workflow_id: workflow_id,
         squad_id: squad_id,
         server: server,
         additional_properties: struct
@@ -146,10 +178,12 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       obj.fallback_destination.nil? || Vapi::CreateVonagePhoneNumberDtoFallbackDestination.validate_raw(obj: obj.fallback_destination)
+      obj.hooks&.is_a?(Array) != false || raise("Passed value for field obj.hooks is not the expected type, validation failed.")
       obj.number.is_a?(String) != false || raise("Passed value for field obj.number is not the expected type, validation failed.")
       obj.credential_id.is_a?(String) != false || raise("Passed value for field obj.credential_id 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.")
       obj.assistant_id&.is_a?(String) != false || raise("Passed value for field obj.assistant_id is not the expected type, validation failed.")
+      obj.workflow_id&.is_a?(String) != false || raise("Passed value for field obj.workflow_id is not the expected type, validation failed.")
       obj.squad_id&.is_a?(String) != false || raise("Passed value for field obj.squad_id is not the expected type, validation failed.")
       obj.server.nil? || Vapi::Server.validate_raw(obj: obj.server)
     end

data/lib/vapi_server_sdk/types/create_web_call_dto.rb

@@ -3,26 +3,61 @@
 require_relative "create_assistant_dto"
 require_relative "assistant_overrides"
 require_relative "create_squad_dto"
+require_relative "create_workflow_dto"
+require_relative "workflow_overrides"
 require "ostruct"
 require "json"
 
 module Vapi
   class CreateWebCallDto
-    # @return [String] This is the assistant that will be used for the call. To use a transient
+    # @return [String] This is the assistant ID that will be used for the call. To use a transient
     #  assistant, use `assistant` instead.
+    #  To start a call with:
+    #  - Assistant, use `assistantId` or `assistant`
+    #  - Squad, use `squadId` or `squad`
+    #  - Workflow, use `workflowId` or `workflow`
     attr_reader :assistant_id
     # @return [Vapi::CreateAssistantDto] This is the assistant that will be used for the call. To use an existing
     #  assistant, use `assistantId` instead.
+    #  To start a call with:
+    #  - Assistant, use `assistant`
+    #  - Squad, use `squad`
+    #  - Workflow, use `workflow`
     attr_reader :assistant
     # @return [Vapi::AssistantOverrides] These are the overrides for the `assistant` or `assistantId`'s settings and
     #  template variables.
     attr_reader :assistant_overrides
     # @return [String] This is the squad that will be used for the call. To use a transient squad, use
     #  `squad` instead.
+    #  To start a call with:
+    #  - Assistant, use `assistant` or `assistantId`
+    #  - Squad, use `squad` or `squadId`
+    #  - Workflow, use `workflow` or `workflowId`
     attr_reader :squad_id
     # @return [Vapi::CreateSquadDto] This is a squad that will be used for the call. To use an existing squad, use
     #  `squadId` instead.
+    #  To start a call with:
+    #  - Assistant, use `assistant` or `assistantId`
+    #  - Squad, use `squad` or `squadId`
+    #  - Workflow, use `workflow` or `workflowId`
     attr_reader :squad
+    # @return [String] This is the workflow that will be used for the call. To use a transient
+    #  workflow, use `workflow` instead.
+    #  To start a call with:
+    #  - Assistant, use `assistant` or `assistantId`
+    #  - Squad, use `squad` or `squadId`
+    #  - Workflow, use `workflow` or `workflowId`
+    attr_reader :workflow_id
+    # @return [Vapi::CreateWorkflowDto] This is a workflow that will be used for the call. To use an existing workflow,
+    #  use `workflowId` instead.
+    #  To start a call with:
+    #  - Assistant, use `assistant` or `assistantId`
+    #  - Squad, use `squad` or `squadId`
+    #  - Workflow, use `workflow` or `workflowId`
+    attr_reader :workflow
+    # @return [Vapi::WorkflowOverrides] These are the overrides for the `workflow` or `workflowId`'s settings and
+    #  template variables.
+    attr_reader :workflow_overrides
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -31,32 +66,68 @@ module Vapi
 
     OMIT = Object.new
 
-    # @param assistant_id [String] This is the assistant that will be used for the call. To use a transient
+    # @param assistant_id [String] This is the assistant ID that will be used for the call. To use a transient
     #  assistant, use `assistant` instead.
+    #  To start a call with:
+    #  - Assistant, use `assistantId` or `assistant`
+    #  - Squad, use `squadId` or `squad`
+    #  - Workflow, use `workflowId` or `workflow`
     # @param assistant [Vapi::CreateAssistantDto] This is the assistant that will be used for the call. To use an existing
     #  assistant, use `assistantId` instead.
+    #  To start a call with:
+    #  - Assistant, use `assistant`
+    #  - Squad, use `squad`
+    #  - Workflow, use `workflow`
     # @param assistant_overrides [Vapi::AssistantOverrides] These are the overrides for the `assistant` or `assistantId`'s settings and
     #  template variables.
     # @param squad_id [String] This is the squad that will be used for the call. To use a transient squad, use
     #  `squad` instead.
+    #  To start a call with:
+    #  - Assistant, use `assistant` or `assistantId`
+    #  - Squad, use `squad` or `squadId`
+    #  - Workflow, use `workflow` or `workflowId`
     # @param squad [Vapi::CreateSquadDto] This is a squad that will be used for the call. To use an existing squad, use
     #  `squadId` instead.
+    #  To start a call with:
+    #  - Assistant, use `assistant` or `assistantId`
+    #  - Squad, use `squad` or `squadId`
+    #  - Workflow, use `workflow` or `workflowId`
+    # @param workflow_id [String] This is the workflow that will be used for the call. To use a transient
+    #  workflow, use `workflow` instead.
+    #  To start a call with:
+    #  - Assistant, use `assistant` or `assistantId`
+    #  - Squad, use `squad` or `squadId`
+    #  - Workflow, use `workflow` or `workflowId`
+    # @param workflow [Vapi::CreateWorkflowDto] This is a workflow that will be used for the call. To use an existing workflow,
+    #  use `workflowId` instead.
+    #  To start a call with:
+    #  - Assistant, use `assistant` or `assistantId`
+    #  - Squad, use `squad` or `squadId`
+    #  - Workflow, use `workflow` or `workflowId`
+    # @param workflow_overrides [Vapi::WorkflowOverrides] These are the overrides for the `workflow` or `workflowId`'s settings and
+    #  template variables.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::CreateWebCallDto]
     def initialize(assistant_id: OMIT, assistant: OMIT, assistant_overrides: OMIT, squad_id: OMIT, squad: OMIT,
-                   additional_properties: nil)
+                   workflow_id: OMIT, workflow: OMIT, workflow_overrides: OMIT, additional_properties: nil)
       @assistant_id = assistant_id if assistant_id != OMIT
       @assistant = assistant if assistant != OMIT
       @assistant_overrides = assistant_overrides if assistant_overrides != OMIT
       @squad_id = squad_id if squad_id != OMIT
       @squad = squad if squad != OMIT
+      @workflow_id = workflow_id if workflow_id != OMIT
+      @workflow = workflow if workflow != OMIT
+      @workflow_overrides = workflow_overrides if workflow_overrides != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "assistantId": assistant_id,
         "assistant": assistant,
         "assistantOverrides": assistant_overrides,
         "squadId": squad_id,
-        "squad": squad
+        "squad": squad,
+        "workflowId": workflow_id,
+        "workflow": workflow,
+        "workflowOverrides": workflow_overrides
       }.reject do |_k, v|
         v == OMIT
       end
@@ -89,12 +160,28 @@ module Vapi
         squad = parsed_json["squad"].to_json
         squad = Vapi::CreateSquadDto.from_json(json_object: squad)
       end
+      workflow_id = parsed_json["workflowId"]
+      if parsed_json["workflow"].nil?
+        workflow = nil
+      else
+        workflow = parsed_json["workflow"].to_json
+        workflow = Vapi::CreateWorkflowDto.from_json(json_object: workflow)
+      end
+      if parsed_json["workflowOverrides"].nil?
+        workflow_overrides = nil
+      else
+        workflow_overrides = parsed_json["workflowOverrides"].to_json
+        workflow_overrides = Vapi::WorkflowOverrides.from_json(json_object: workflow_overrides)
+      end
       new(
         assistant_id: assistant_id,
         assistant: assistant,
         assistant_overrides: assistant_overrides,
         squad_id: squad_id,
         squad: squad,
+        workflow_id: workflow_id,
+        workflow: workflow,
+        workflow_overrides: workflow_overrides,
         additional_properties: struct
       )
     end
@@ -118,6 +205,9 @@ module Vapi
       obj.assistant_overrides.nil? || Vapi::AssistantOverrides.validate_raw(obj: obj.assistant_overrides)
       obj.squad_id&.is_a?(String) != false || raise("Passed value for field obj.squad_id is not the expected type, validation failed.")
       obj.squad.nil? || Vapi::CreateSquadDto.validate_raw(obj: obj.squad)
+      obj.workflow_id&.is_a?(String) != false || raise("Passed value for field obj.workflow_id is not the expected type, validation failed.")
+      obj.workflow.nil? || Vapi::CreateWorkflowDto.validate_raw(obj: obj.workflow)
+      obj.workflow_overrides.nil? || Vapi::WorkflowOverrides.validate_raw(obj: obj.workflow_overrides)
     end
   end
 end