vapi_server_sdk 0.2.0 → 0.4.0

data/lib/vapi_server_sdk/types/update_azure_credential_dto.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
+require_relative "update_azure_credential_dto_service"
 require_relative "update_azure_credential_dto_region"
+require_relative "azure_blob_storage_bucket_plan"
 require "ostruct"
 require "json"
 
 module Vapi
   class UpdateAzureCredentialDto
-    # @return [String]
-    attr_reader :provider
-    # @return [String] This is the service being used in Azure.
+    # @return [Vapi::UpdateAzureCredentialDtoService] This is the service being used in Azure.
     attr_reader :service
     # @return [Vapi::UpdateAzureCredentialDtoRegion] This is the region of the Azure resource.
     attr_reader :region
@@ -16,6 +16,9 @@ module Vapi
     attr_reader :api_key
     # @return [String] This is the name of credential. This is just for your reference.
     attr_reader :name
+    # @return [Vapi::AzureBlobStorageBucketPlan] This is the bucket plan that can be provided to store call artifacts in Azure
+    #  Blob Storage.
+    attr_reader :bucket_plan
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -24,26 +27,28 @@ module Vapi
 
     OMIT = Object.new
 
-    # @param provider [String]
-    # @param service [String] This is the service being used in Azure.
+    # @param service [Vapi::UpdateAzureCredentialDtoService] This is the service being used in Azure.
     # @param region [Vapi::UpdateAzureCredentialDtoRegion] This is the region of the Azure resource.
     # @param api_key [String] This is not returned in the API.
     # @param name [String] This is the name of credential. This is just for your reference.
+    # @param bucket_plan [Vapi::AzureBlobStorageBucketPlan] This is the bucket plan that can be provided to store call artifacts in Azure
+    #  Blob Storage.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::UpdateAzureCredentialDto]
-    def initialize(provider:, service:, region: OMIT, api_key: OMIT, name: OMIT, additional_properties: nil)
-      @provider = provider
-      @service = service
+    def initialize(service: OMIT, region: OMIT, api_key: OMIT, name: OMIT, bucket_plan: OMIT,
+                   additional_properties: nil)
+      @service = service if service != OMIT
       @region = region if region != OMIT
       @api_key = api_key if api_key != OMIT
       @name = name if name != OMIT
+      @bucket_plan = bucket_plan if bucket_plan != OMIT
       @additional_properties = additional_properties
       @_field_set = {
-        "provider": provider,
         "service": service,
         "region": region,
         "apiKey": api_key,
-        "name": name
+        "name": name,
+        "bucketPlan": bucket_plan
       }.reject do |_k, v|
         v == OMIT
       end
@@ -56,17 +61,22 @@ module Vapi
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      provider = parsed_json["provider"]
       service = parsed_json["service"]
       region = parsed_json["region"]
       api_key = parsed_json["apiKey"]
       name = parsed_json["name"]
+      if parsed_json["bucketPlan"].nil?
+        bucket_plan = nil
+      else
+        bucket_plan = parsed_json["bucketPlan"].to_json
+        bucket_plan = Vapi::AzureBlobStorageBucketPlan.from_json(json_object: bucket_plan)
+      end
       new(
-        provider: provider,
         service: service,
         region: region,
         api_key: api_key,
         name: name,
+        bucket_plan: bucket_plan,
         additional_properties: struct
       )
     end
@@ -85,11 +95,11 @@ module Vapi
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
-      obj.provider.is_a?(String) != false || raise("Passed value for field obj.provider is not the expected type, validation failed.")
-      obj.service.is_a?(String) != false || raise("Passed value for field obj.service is not the expected type, validation failed.")
+      obj.service&.is_a?(Vapi::UpdateAzureCredentialDtoService) != false || raise("Passed value for field obj.service is not the expected type, validation failed.")
       obj.region&.is_a?(Vapi::UpdateAzureCredentialDtoRegion) != false || raise("Passed value for field obj.region is not the expected type, validation failed.")
       obj.api_key&.is_a?(String) != false || raise("Passed value for field obj.api_key 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.bucket_plan.nil? || Vapi::AzureBlobStorageBucketPlan.validate_raw(obj: obj.bucket_plan)
     end
   end
 end

data/lib/vapi_server_sdk/types/update_azure_credential_dto_region.rb

@@ -4,17 +4,19 @@ module Vapi
   # This is the region of the Azure resource.
   class UpdateAzureCredentialDtoRegion
     AUSTRALIA = "australia"
-    CANADA = "canada"
+    CANADAEAST = "canadaeast"
+    CANADACENTRAL = "canadacentral"
     EASTUS_2 = "eastus2"
     EASTUS = "eastus"
     FRANCE = "france"
     INDIA = "india"
-    JAPAN = "japan"
+    JAPANEAST = "japaneast"
+    JAPANWEST = "japanwest"
     UAENORTH = "uaenorth"
     NORTHCENTRALUS = "northcentralus"
     NORWAY = "norway"
     SOUTHCENTRALUS = "southcentralus"
-    SWEDEN = "sweden"
+    SWEDENCENTRAL = "swedencentral"
     SWITZERLAND = "switzerland"
     UK = "uk"
     WESTUS = "westus"

data/lib/vapi_server_sdk/types/update_azure_credential_dto_service.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the service being used in Azure.
+  class UpdateAzureCredentialDtoService
+    SPEECH = "speech"
+    BLOB_STORAGE = "blob_storage"
+  end
+end

data/lib/vapi_server_sdk/types/update_azure_open_ai_credential_dto.rb

@@ -7,18 +7,18 @@ require "json"
 
 module Vapi
   class UpdateAzureOpenAiCredentialDto
-    # @return [String]
-    attr_reader :provider
     # @return [Vapi::UpdateAzureOpenAiCredentialDtoRegion]
     attr_reader :region
     # @return [Array<Vapi::UpdateAzureOpenAiCredentialDtoModelsItem>]
     attr_reader :models
     # @return [String] This is not returned in the API.
     attr_reader :open_ai_key
-    # @return [String]
-    attr_reader :open_ai_endpoint
+    # @return [String] This is not returned in the API.
+    attr_reader :ocp_apim_subscription_key
     # @return [String] This is the name of credential. This is just for your reference.
     attr_reader :name
+    # @return [String]
+    attr_reader :open_ai_endpoint
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -27,29 +27,30 @@ module Vapi
 
     OMIT = Object.new
 
-    # @param provider [String]
     # @param region [Vapi::UpdateAzureOpenAiCredentialDtoRegion]
     # @param models [Array<Vapi::UpdateAzureOpenAiCredentialDtoModelsItem>]
     # @param open_ai_key [String] This is not returned in the API.
-    # @param open_ai_endpoint [String]
+    # @param ocp_apim_subscription_key [String] This is not returned in the API.
     # @param name [String] This is the name of credential. This is just for your reference.
+    # @param open_ai_endpoint [String]
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::UpdateAzureOpenAiCredentialDto]
-    def initialize(provider:, region:, models:, open_ai_key:, open_ai_endpoint:, name: OMIT, additional_properties: nil)
-      @provider = provider
-      @region = region
-      @models = models
-      @open_ai_key = open_ai_key
-      @open_ai_endpoint = open_ai_endpoint
+    def initialize(region: OMIT, models: OMIT, open_ai_key: OMIT, ocp_apim_subscription_key: OMIT, name: OMIT,
+                   open_ai_endpoint: OMIT, additional_properties: nil)
+      @region = region if region != OMIT
+      @models = models if models != OMIT
+      @open_ai_key = open_ai_key if open_ai_key != OMIT
+      @ocp_apim_subscription_key = ocp_apim_subscription_key if ocp_apim_subscription_key != OMIT
       @name = name if name != OMIT
+      @open_ai_endpoint = open_ai_endpoint if open_ai_endpoint != OMIT
       @additional_properties = additional_properties
       @_field_set = {
-        "provider": provider,
         "region": region,
         "models": models,
         "openAIKey": open_ai_key,
-        "openAIEndpoint": open_ai_endpoint,
-        "name": name
+        "ocpApimSubscriptionKey": ocp_apim_subscription_key,
+        "name": name,
+        "openAIEndpoint": open_ai_endpoint
       }.reject do |_k, v|
         v == OMIT
       end
@@ -62,19 +63,19 @@ module Vapi
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      provider = parsed_json["provider"]
       region = parsed_json["region"]
       models = parsed_json["models"]
       open_ai_key = parsed_json["openAIKey"]
-      open_ai_endpoint = parsed_json["openAIEndpoint"]
+      ocp_apim_subscription_key = parsed_json["ocpApimSubscriptionKey"]
       name = parsed_json["name"]
+      open_ai_endpoint = parsed_json["openAIEndpoint"]
       new(
-        provider: provider,
         region: region,
         models: models,
         open_ai_key: open_ai_key,
-        open_ai_endpoint: open_ai_endpoint,
+        ocp_apim_subscription_key: ocp_apim_subscription_key,
         name: name,
+        open_ai_endpoint: open_ai_endpoint,
         additional_properties: struct
       )
     end
@@ -93,12 +94,12 @@ module Vapi
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
-      obj.provider.is_a?(String) != false || raise("Passed value for field obj.provider is not the expected type, validation failed.")
-      obj.region.is_a?(Vapi::UpdateAzureOpenAiCredentialDtoRegion) != false || raise("Passed value for field obj.region is not the expected type, validation failed.")
-      obj.models.is_a?(Array) != false || raise("Passed value for field obj.models is not the expected type, validation failed.")
-      obj.open_ai_key.is_a?(String) != false || raise("Passed value for field obj.open_ai_key is not the expected type, validation failed.")
-      obj.open_ai_endpoint.is_a?(String) != false || raise("Passed value for field obj.open_ai_endpoint is not the expected type, validation failed.")
+      obj.region&.is_a?(Vapi::UpdateAzureOpenAiCredentialDtoRegion) != false || raise("Passed value for field obj.region is not the expected type, validation failed.")
+      obj.models&.is_a?(Array) != false || raise("Passed value for field obj.models is not the expected type, validation failed.")
+      obj.open_ai_key&.is_a?(String) != false || raise("Passed value for field obj.open_ai_key is not the expected type, validation failed.")
+      obj.ocp_apim_subscription_key&.is_a?(String) != false || raise("Passed value for field obj.ocp_apim_subscription_key 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.open_ai_endpoint&.is_a?(String) != false || raise("Passed value for field obj.open_ai_endpoint is not the expected type, validation failed.")
     end
   end
 end

data/lib/vapi_server_sdk/types/update_azure_open_ai_credential_dto_region.rb

@@ -3,17 +3,19 @@
 module Vapi
   class UpdateAzureOpenAiCredentialDtoRegion
     AUSTRALIA = "australia"
-    CANADA = "canada"
+    CANADAEAST = "canadaeast"
+    CANADACENTRAL = "canadacentral"
     EASTUS_2 = "eastus2"
     EASTUS = "eastus"
     FRANCE = "france"
     INDIA = "india"
-    JAPAN = "japan"
+    JAPANEAST = "japaneast"
+    JAPANWEST = "japanwest"
     UAENORTH = "uaenorth"
     NORTHCENTRALUS = "northcentralus"
     NORWAY = "norway"
     SOUTHCENTRALUS = "southcentralus"
-    SWEDEN = "sweden"
+    SWEDENCENTRAL = "swedencentral"
     SWITZERLAND = "switzerland"
     UK = "uk"
     WESTUS = "westus"

data/lib/vapi_server_sdk/types/update_bash_tool_dto.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require_relative "update_bash_tool_dto_messages_item"
+require_relative "open_ai_function"
+require_relative "server"
+require "ostruct"
+require "json"
+
+module Vapi
+  class UpdateBashToolDto
+    # @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::UpdateBashToolDtoMessagesItem>] 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 sub type of tool.
+    attr_reader :sub_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
+    #  provide a custom function definition for advanced use cases.
+    #  An example of an advanced use case is if you want to customize the message
+    #  that's spoken for `endCall` tool. You can specify a function where it returns an
+    #  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.
+    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 [String] The name of the tool, fixed to 'bash'
+    attr_reader :name
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    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::UpdateBashToolDtoMessagesItem>] 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 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
+    #  provide a custom function definition for advanced use cases.
+    #  An example of an advanced use case is if you want to customize the message
+    #  that's spoken for `endCall` tool. You can specify a function where it returns an
+    #  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 name [String] The name of the tool, fixed to 'bash'
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::UpdateBashToolDto]
+    def initialize(async: OMIT, messages: OMIT, sub_type: OMIT, function: OMIT, server: OMIT, name: OMIT,
+                   additional_properties: nil)
+      @async = async if async != OMIT
+      @messages = messages if messages != OMIT
+      @sub_type = sub_type if sub_type != OMIT
+      @function = function if function != OMIT
+      @server = server if server != OMIT
+      @name = name if name != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "async": async,
+        "messages": messages,
+        "subType": sub_type,
+        "function": function,
+        "server": server,
+        "name": name
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of UpdateBashToolDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::UpdateBashToolDto]
+    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::UpdateBashToolDtoMessagesItem.from_json(json_object: item)
+      end
+      sub_type = parsed_json["subType"]
+      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
+      name = parsed_json["name"]
+      new(
+        async: async,
+        messages: messages,
+        sub_type: sub_type,
+        function: function,
+        server: server,
+        name: name,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of UpdateBashToolDto to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # 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.
+    #
+    # @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.function.nil? || Vapi::OpenAiFunction.validate_raw(obj: obj.function)
+      obj.server.nil? || Vapi::Server.validate_raw(obj: obj.server)
+      obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/update_bash_tool_dto_messages_item.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "tool_message_start"
+require_relative "tool_message_complete"
+require_relative "tool_message_failed"
+require_relative "tool_message_delayed"
+
+module Vapi
+  class UpdateBashToolDtoMessagesItem
+    # @return [Object]
+    attr_reader :member
+    # @return [String]
+    attr_reader :discriminant
+
+    private_class_method :new
+    alias kind_of? is_a?
+
+    # @param member [Object]
+    # @param discriminant [String]
+    # @return [Vapi::UpdateBashToolDtoMessagesItem]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of UpdateBashToolDtoMessagesItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::UpdateBashToolDtoMessagesItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.type
+               when "request-start"
+                 Vapi::ToolMessageStart.from_json(json_object: json_object)
+               when "request-complete"
+                 Vapi::ToolMessageComplete.from_json(json_object: json_object)
+               when "request-failed"
+                 Vapi::ToolMessageFailed.from_json(json_object: json_object)
+               when "request-response-delayed"
+                 Vapi::ToolMessageDelayed.from_json(json_object: json_object)
+               else
+                 Vapi::ToolMessageStart.from_json(json_object: json_object)
+               end
+      new(member: member, discriminant: struct.type)
+    end
+
+    # For Union Types, to_json functionality is delegated to the wrapped member.
+    #
+    # @return [String]
+    def to_json(*_args)
+      case @discriminant
+      when "request-start"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "request-complete"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "request-failed"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "request-response-delayed"
+        { **@member.to_json, type: @discriminant }.to_json
+      else
+        { "type": @discriminant, value: @member }.to_json
+      end
+      @member.to_json
+    end
+
+    # 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.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      case obj.type
+      when "request-start"
+        Vapi::ToolMessageStart.validate_raw(obj: obj)
+      when "request-complete"
+        Vapi::ToolMessageComplete.validate_raw(obj: obj)
+      when "request-failed"
+        Vapi::ToolMessageFailed.validate_raw(obj: obj)
+      when "request-response-delayed"
+        Vapi::ToolMessageDelayed.validate_raw(obj: obj)
+      else
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+    end
+
+    # For Union Types, is_a? functionality is delegated to the wrapped member.
+    #
+    # @param obj [Object]
+    # @return [Boolean]
+    def is_a?(obj)
+      @member.is_a?(obj)
+    end
+
+    # @param member [Vapi::ToolMessageStart]
+    # @return [Vapi::UpdateBashToolDtoMessagesItem]
+    def self.request_start(member:)
+      new(member: member, discriminant: "request-start")
+    end
+
+    # @param member [Vapi::ToolMessageComplete]
+    # @return [Vapi::UpdateBashToolDtoMessagesItem]
+    def self.request_complete(member:)
+      new(member: member, discriminant: "request-complete")
+    end
+
+    # @param member [Vapi::ToolMessageFailed]
+    # @return [Vapi::UpdateBashToolDtoMessagesItem]
+    def self.request_failed(member:)
+      new(member: member, discriminant: "request-failed")
+    end
+
+    # @param member [Vapi::ToolMessageDelayed]
+    # @return [Vapi::UpdateBashToolDtoMessagesItem]
+    def self.request_response_delayed(member:)
+      new(member: member, discriminant: "request-response-delayed")
+    end
+  end
+end