vapi_server_sdk 0.4.0 → 0.9.1

data/lib/vapi_server_sdk/types/bash_tool_with_tool_call.rb

@@ -1,21 +1,14 @@
 # frozen_string_literal: true
 
 require_relative "bash_tool_with_tool_call_messages_item"
+require_relative "server"
 require_relative "tool_call"
 require_relative "open_ai_function"
-require_relative "server"
 require "ostruct"
 require "json"
 
 module Vapi
   class BashToolWithToolCall
-    # @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::BashToolWithToolCallMessagesItem>] 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
@@ -23,6 +16,17 @@ module Vapi
     attr_reader :messages
     # @return [String] The sub type of tool.
     attr_reader :sub_type
+    # @return [Vapi::Server]
+    #  This is the server where a `tool-calls` webhook will be sent.
+    #  Notes:
+    #  - Webhook is sent to this server when a tool call is made.
+    #  - Webhook contains the call, assistant, and phone number objects.
+    #  - Webhook contains the variables set on the assistant.
+    #  - Webhook is sent to the first available URL in this order:
+    #  {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}},
+    #  {{org.server.url}}.
+    #  - Webhook expects a response with tool call result.
+    attr_reader :server
     # @return [Vapi::ToolCall]
     attr_reader :tool_call
     # @return [String] The name of the tool, fixed to 'bash'
@@ -37,13 +41,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]
@@ -52,17 +49,21 @@ 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::BashToolWithToolCallMessagesItem>] 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 sub_type [String] The sub type of tool.
+    # @param server [Vapi::Server]
+    #  This is the server where a `tool-calls` webhook will be sent.
+    #  Notes:
+    #  - Webhook is sent to this server when a tool call is made.
+    #  - Webhook contains the call, assistant, and phone number objects.
+    #  - Webhook contains the variables set on the assistant.
+    #  - Webhook is sent to the first available URL in this order:
+    #  {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}},
+    #  {{org.server.url}}.
+    #  - Webhook expects a response with tool call result.
     # @param tool_call [Vapi::ToolCall]
     # @param name [String] The name of the tool, fixed to 'bash'
     # @param function [Vapi::OpenAiFunction] This is the function definition of the tool.
@@ -74,32 +75,24 @@ 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::BashToolWithToolCall]
-    def initialize(sub_type:, tool_call:, name:, async: OMIT, messages: OMIT, function: OMIT, server: OMIT,
+    def initialize(sub_type:, tool_call:, name:, messages: OMIT, server: OMIT, function: OMIT,
                    additional_properties: nil)
-      @async = async if async != OMIT
       @messages = messages if messages != OMIT
       @sub_type = sub_type
+      @server = server if server != OMIT
       @tool_call = tool_call
       @name = name
       @function = function if function != OMIT
-      @server = server if server != OMIT
       @additional_properties = additional_properties
       @_field_set = {
-        "async": async,
         "messages": messages,
         "subType": sub_type,
+        "server": server,
         "toolCall": tool_call,
         "name": name,
-        "function": function,
-        "server": server
+        "function": function
       }.reject do |_k, v|
         v == OMIT
       end
@@ -112,12 +105,17 @@ 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::BashToolWithToolCallMessagesItem.from_json(json_object: item)
       end
       sub_type = parsed_json["subType"]
+      if parsed_json["server"].nil?
+        server = nil
+      else
+        server = parsed_json["server"].to_json
+        server = Vapi::Server.from_json(json_object: server)
+      end
       if parsed_json["toolCall"].nil?
         tool_call = nil
       else
@@ -131,20 +129,13 @@ module Vapi
         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,
         sub_type: sub_type,
+        server: server,
         tool_call: tool_call,
         name: name,
         function: function,
-        server: server,
         additional_properties: struct
       )
     end
@@ -163,13 +154,12 @@ 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.sub_type.is_a?(String) != false || raise("Passed value for field obj.sub_type is not the expected type, validation failed.")
+      obj.server.nil? || Vapi::Server.validate_raw(obj: obj.server)
       Vapi::ToolCall.validate_raw(obj: obj.tool_call)
       obj.name.is_a?(String) != false || raise("Passed value for field obj.name 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/bucket_plan.rb

@@ -13,6 +13,7 @@ module Vapi
     #  - If `credential.type` is `gcp`, then this is optional since GCP allows buckets
     #  to be accessed without a region but region is required for data residency
     #  requirements. Read here: https://cloud.google.com/storage/docs/request-endpoints
+    #  This overrides the `credential.region` field if it is provided.
     attr_reader :region
     # @return [String] This is the path where call artifacts will be stored.
     #  Usage:
@@ -52,6 +53,7 @@ module Vapi
     #  - If `credential.type` is `gcp`, then this is optional since GCP allows buckets
     #  to be accessed without a region but region is required for data residency
     #  requirements. Read here: https://cloud.google.com/storage/docs/request-endpoints
+    #  This overrides the `credential.region` field if it is provided.
     # @param path [String] This is the path where call artifacts will be stored.
     #  Usage:
     #  - To store call artifacts in a specific folder, set this to the full path. Eg.

data/lib/vapi_server_sdk/types/byo_phone_number.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require_relative "byo_phone_number_fallback_destination"
+require_relative "phone_number_hook_call_ringing"
 require "date"
+require_relative "byo_phone_number_status"
 require_relative "server"
 require "ostruct"
 require "json"
@@ -15,6 +17,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 [Boolean] This is the flag to toggle the E164 check for the `number` field. This is an
     #  advanced property which should be used if you know your use case requires it.
     #  Use cases:
@@ -34,17 +38,27 @@ module Vapi
     attr_reader :created_at
     # @return [DateTime] This is the ISO 8601 date-time string of when the phone number was last updated.
     attr_reader :updated_at
+    # @return [Vapi::ByoPhoneNumberStatus] This is the status of the phone number.
+    attr_reader :status
     # @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.
@@ -74,6 +88,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_e_164_check_enabled [Boolean] This is the flag to toggle the E164 check for the `number` field. This is an
     #  advanced property which should be used if you know your use case requires it.
     #  Use cases:
@@ -88,15 +103,23 @@ module Vapi
     # @param org_id [String] This is the unique identifier for the org that this phone number belongs to.
     # @param created_at [DateTime] This is the ISO 8601 date-time string of when the phone number was created.
     # @param updated_at [DateTime] This is the ISO 8601 date-time string of when the phone number was last updated.
+    # @param status [Vapi::ByoPhoneNumberStatus] This is the status of the phone number.
     # @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:
@@ -110,16 +133,19 @@ module Vapi
     #  on the Dashboard to get the credentialId.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::ByoPhoneNumber]
-    def initialize(id:, org_id:, created_at:, updated_at:, credential_id:, fallback_destination: OMIT,
-                   number_e_164_check_enabled: OMIT, name: OMIT, assistant_id: OMIT, squad_id: OMIT, server: OMIT, number: OMIT, additional_properties: nil)
+    def initialize(id:, org_id:, created_at:, updated_at:, credential_id:, fallback_destination: OMIT, hooks: OMIT,
+                   number_e_164_check_enabled: OMIT, status: OMIT, name: OMIT, assistant_id: OMIT, workflow_id: OMIT, squad_id: OMIT, server: OMIT, number: OMIT, additional_properties: nil)
       @fallback_destination = fallback_destination if fallback_destination != OMIT
+      @hooks = hooks if hooks != OMIT
       @number_e_164_check_enabled = number_e_164_check_enabled if number_e_164_check_enabled != OMIT
       @id = id
       @org_id = org_id
       @created_at = created_at
       @updated_at = updated_at
+      @status = status if status != 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
       @number = number if number != OMIT
@@ -127,13 +153,16 @@ module Vapi
       @additional_properties = additional_properties
       @_field_set = {
         "fallbackDestination": fallback_destination,
+        "hooks": hooks,
         "numberE164CheckEnabled": number_e_164_check_enabled,
         "id": id,
         "orgId": org_id,
         "createdAt": created_at,
         "updatedAt": updated_at,
+        "status": status,
         "name": name,
         "assistantId": assistant_id,
+        "workflowId": workflow_id,
         "squadId": squad_id,
         "server": server,
         "number": number,
@@ -156,13 +185,19 @@ module Vapi
         fallback_destination = parsed_json["fallbackDestination"].to_json
         fallback_destination = Vapi::ByoPhoneNumberFallbackDestination.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_e_164_check_enabled = parsed_json["numberE164CheckEnabled"]
       id = parsed_json["id"]
       org_id = parsed_json["orgId"]
       created_at = (DateTime.parse(parsed_json["createdAt"]) unless parsed_json["createdAt"].nil?)
       updated_at = (DateTime.parse(parsed_json["updatedAt"]) unless parsed_json["updatedAt"].nil?)
+      status = parsed_json["status"]
       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
@@ -174,13 +209,16 @@ module Vapi
       credential_id = parsed_json["credentialId"]
       new(
         fallback_destination: fallback_destination,
+        hooks: hooks,
         number_e_164_check_enabled: number_e_164_check_enabled,
         id: id,
         org_id: org_id,
         created_at: created_at,
         updated_at: updated_at,
+        status: status,
         name: name,
         assistant_id: assistant_id,
+        workflow_id: workflow_id,
         squad_id: squad_id,
         server: server,
         number: number,
@@ -204,13 +242,16 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       obj.fallback_destination.nil? || Vapi::ByoPhoneNumberFallbackDestination.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_e_164_check_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.number_e_164_check_enabled is not the expected type, validation failed.")
       obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
       obj.org_id.is_a?(String) != false || raise("Passed value for field obj.org_id is not the expected type, validation failed.")
       obj.created_at.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
       obj.updated_at.is_a?(DateTime) != false || raise("Passed value for field obj.updated_at is not the expected type, validation failed.")
+      obj.status&.is_a?(Vapi::ByoPhoneNumberStatus) != false || raise("Passed value for field obj.status 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)
       obj.number&.is_a?(String) != false || raise("Passed value for field obj.number is not the expected type, validation failed.")

data/lib/vapi_server_sdk/types/byo_phone_number_status.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the status of the phone number.
+  class ByoPhoneNumberStatus
+    ACTIVE = "active"
+    ACTIVATING = "activating"
+    BLOCKED = "blocked"
+  end
+end