vapi_server_sdk 0.1.0 → 0.3.0

data/lib/vapi_server_sdk/types/update_make_tool_dto.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require_relative "update_make_tool_dto_messages_item"
+require_relative "open_ai_function"
+require_relative "server"
+require_relative "make_tool_metadata"
+require "ostruct"
+require "json"
+
+module Vapi
+  class UpdateMakeToolDto
+    # @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::UpdateMakeToolDtoMessagesItem>] 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 [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 [Vapi::MakeToolMetadata]
+    attr_reader :metadata
+    # @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::UpdateMakeToolDtoMessagesItem>] 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 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 metadata [Vapi::MakeToolMetadata]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::UpdateMakeToolDto]
+    def initialize(async: OMIT, messages: OMIT, function: OMIT, server: OMIT, metadata: OMIT,
+                   additional_properties: nil)
+      @async = async if async != OMIT
+      @messages = messages if messages != OMIT
+      @function = function if function != OMIT
+      @server = server if server != OMIT
+      @metadata = metadata if metadata != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "async": async,
+        "messages": messages,
+        "function": function,
+        "server": server,
+        "metadata": metadata
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of UpdateMakeToolDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::UpdateMakeToolDto]
+    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::UpdateMakeToolDtoMessagesItem.from_json(json_object: item)
+      end
+      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
+      if parsed_json["metadata"].nil?
+        metadata = nil
+      else
+        metadata = parsed_json["metadata"].to_json
+        metadata = Vapi::MakeToolMetadata.from_json(json_object: metadata)
+      end
+      new(
+        async: async,
+        messages: messages,
+        function: function,
+        server: server,
+        metadata: metadata,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of UpdateMakeToolDto 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.function.nil? || Vapi::OpenAiFunction.validate_raw(obj: obj.function)
+      obj.server.nil? || Vapi::Server.validate_raw(obj: obj.server)
+      obj.metadata.nil? || Vapi::MakeToolMetadata.validate_raw(obj: obj.metadata)
+    end
+  end
+end

data/lib/vapi_server_sdk/types/update_make_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 UpdateMakeToolDtoMessagesItem
+    # @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::UpdateMakeToolDtoMessagesItem]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of UpdateMakeToolDtoMessagesItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::UpdateMakeToolDtoMessagesItem]
+    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::UpdateMakeToolDtoMessagesItem]
+    def self.request_start(member:)
+      new(member: member, discriminant: "request-start")
+    end
+
+    # @param member [Vapi::ToolMessageComplete]
+    # @return [Vapi::UpdateMakeToolDtoMessagesItem]
+    def self.request_complete(member:)
+      new(member: member, discriminant: "request-complete")
+    end
+
+    # @param member [Vapi::ToolMessageFailed]
+    # @return [Vapi::UpdateMakeToolDtoMessagesItem]
+    def self.request_failed(member:)
+      new(member: member, discriminant: "request-failed")
+    end
+
+    # @param member [Vapi::ToolMessageDelayed]
+    # @return [Vapi::UpdateMakeToolDtoMessagesItem]
+    def self.request_response_delayed(member:)
+      new(member: member, discriminant: "request-response-delayed")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/update_open_ai_credential_dto.rb

@@ -5,10 +5,10 @@ require "json"
 
 module Vapi
   class UpdateOpenAiCredentialDto
-    # @return [String]
-    attr_reader :provider
     # @return [String] This is not returned in the API.
     attr_reader :api_key
+    # @return [String] This is the name of credential. This is just for your reference.
+    attr_reader :name
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -17,15 +17,17 @@ module Vapi
 
     OMIT = Object.new
 
-    # @param provider [String]
     # @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 additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::UpdateOpenAiCredentialDto]
-    def initialize(provider:, api_key:, additional_properties: nil)
-      @provider = provider
-      @api_key = api_key
+    def initialize(api_key: OMIT, name: OMIT, additional_properties: nil)
+      @api_key = api_key if api_key != OMIT
+      @name = name if name != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "provider": provider, "apiKey": api_key }
+      @_field_set = { "apiKey": api_key, "name": name }.reject do |_k, v|
+        v == OMIT
+      end
     end
 
     # Deserialize a JSON object to an instance of UpdateOpenAiCredentialDto
@@ -35,11 +37,11 @@ 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"]
       api_key = parsed_json["apiKey"]
+      name = parsed_json["name"]
       new(
-        provider: provider,
         api_key: api_key,
+        name: name,
         additional_properties: struct
       )
     end
@@ -58,8 +60,8 @@ 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.api_key.is_a?(String) != false || raise("Passed value for field obj.api_key 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.")
     end
   end
 end

data/lib/vapi_server_sdk/types/update_open_router_credential_dto.rb

@@ -5,10 +5,10 @@ require "json"
 
 module Vapi
   class UpdateOpenRouterCredentialDto
-    # @return [String]
-    attr_reader :provider
     # @return [String] This is not returned in the API.
     attr_reader :api_key
+    # @return [String] This is the name of credential. This is just for your reference.
+    attr_reader :name
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -17,15 +17,17 @@ module Vapi
 
     OMIT = Object.new
 
-    # @param provider [String]
     # @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 additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::UpdateOpenRouterCredentialDto]
-    def initialize(provider:, api_key:, additional_properties: nil)
-      @provider = provider
-      @api_key = api_key
+    def initialize(api_key: OMIT, name: OMIT, additional_properties: nil)
+      @api_key = api_key if api_key != OMIT
+      @name = name if name != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "provider": provider, "apiKey": api_key }
+      @_field_set = { "apiKey": api_key, "name": name }.reject do |_k, v|
+        v == OMIT
+      end
     end
 
     # Deserialize a JSON object to an instance of UpdateOpenRouterCredentialDto
@@ -35,11 +37,11 @@ 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"]
       api_key = parsed_json["apiKey"]
+      name = parsed_json["name"]
       new(
-        provider: provider,
         api_key: api_key,
+        name: name,
         additional_properties: struct
       )
     end
@@ -58,8 +60,8 @@ 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.api_key.is_a?(String) != false || raise("Passed value for field obj.api_key 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.")
     end
   end
 end

data/lib/vapi_server_sdk/types/update_org_dto.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "update_org_dto_channel"
+require_relative "server"
 require "ostruct"
 require "json"
 
@@ -13,19 +15,23 @@ module Vapi
     #  This is due to the compliance requirements of HIPAA. Other providers may not
     #  meet these requirements.
     attr_reader :hipaa_enabled
+    # @return [String] This is the ID of the subscription the org belongs to.
+    attr_reader :subscription_id
     # @return [String] This is the name of the org. This is just for your own reference.
     attr_reader :name
+    # @return [Vapi::UpdateOrgDtoChannel] This is the channel of the org. There is the cluster the API traffic for the org
+    #  will be directed.
+    attr_reader :channel
     # @return [Float] This is the monthly billing limit for the org. To go beyond $1000/mo, please
     #  contact us at support@vapi.ai.
     attr_reader :billing_limit
-    # @return [String] This is the URL Vapi will communicate with via HTTP GET and POST Requests. This
-    #  is used for retrieving context, function calling, and end-of-call reports.
-    #  All requests will be sent with the call object among other things relevant to
-    #  that message. You can find more details in the Server URL documentation.
-    attr_reader :server_url
-    # @return [String] This is the secret you can set that Vapi will send with every request to your
-    #  server. Will be sent as a header called x-vapi-secret.
-    attr_reader :server_url_secret
+    # @return [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:
+    #  1. assistant.server
+    #  2. phoneNumber.server
+    #  3. org.server
+    attr_reader :server
     # @return [Float] This is the concurrency limit for the org. This is the maximum number of calls
     #  that can be active at any given time. To go beyond 10, please contact us at
     #  support@vapi.ai.
@@ -45,35 +51,40 @@ module Vapi
     #  available for LLM and Voice respectively.
     #  This is due to the compliance requirements of HIPAA. Other providers may not
     #  meet these requirements.
+    # @param subscription_id [String] This is the ID of the subscription the org belongs to.
     # @param name [String] This is the name of the org. This is just for your own reference.
+    # @param channel [Vapi::UpdateOrgDtoChannel] This is the channel of the org. There is the cluster the API traffic for the org
+    #  will be directed.
     # @param billing_limit [Float] This is the monthly billing limit for the org. To go beyond $1000/mo, please
     #  contact us at support@vapi.ai.
-    # @param server_url [String] This is the URL Vapi will communicate with via HTTP GET and POST Requests. This
-    #  is used for retrieving context, function calling, and end-of-call reports.
-    #  All requests will be sent with the call object among other things relevant to
-    #  that message. You can find more details in the Server URL documentation.
-    # @param server_url_secret [String] This is the secret you can set that Vapi will send with every request to your
-    #  server. Will be sent as a header called x-vapi-secret.
+    # @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:
+    #  1. assistant.server
+    #  2. phoneNumber.server
+    #  3. org.server
     # @param concurrency_limit [Float] This is the concurrency limit for the org. This is the maximum number of calls
     #  that can be active at any given time. To go beyond 10, please contact us at
     #  support@vapi.ai.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::UpdateOrgDto]
-    def initialize(hipaa_enabled: OMIT, name: OMIT, billing_limit: OMIT, server_url: OMIT, server_url_secret: OMIT,
-                   concurrency_limit: OMIT, additional_properties: nil)
+    def initialize(hipaa_enabled: OMIT, subscription_id: OMIT, name: OMIT, channel: OMIT, billing_limit: OMIT,
+                   server: OMIT, concurrency_limit: OMIT, additional_properties: nil)
       @hipaa_enabled = hipaa_enabled if hipaa_enabled != OMIT
+      @subscription_id = subscription_id if subscription_id != OMIT
       @name = name if name != OMIT
+      @channel = channel if channel != OMIT
       @billing_limit = billing_limit if billing_limit != OMIT
-      @server_url = server_url if server_url != OMIT
-      @server_url_secret = server_url_secret if server_url_secret != OMIT
+      @server = server if server != OMIT
       @concurrency_limit = concurrency_limit if concurrency_limit != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "hipaaEnabled": hipaa_enabled,
+        "subscriptionId": subscription_id,
         "name": name,
+        "channel": channel,
         "billingLimit": billing_limit,
-        "serverUrl": server_url,
-        "serverUrlSecret": server_url_secret,
+        "server": server,
         "concurrencyLimit": concurrency_limit
       }.reject do |_k, v|
         v == OMIT
@@ -88,17 +99,24 @@ module Vapi
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
       hipaa_enabled = parsed_json["hipaaEnabled"]
+      subscription_id = parsed_json["subscriptionId"]
       name = parsed_json["name"]
+      channel = parsed_json["channel"]
       billing_limit = parsed_json["billingLimit"]
-      server_url = parsed_json["serverUrl"]
-      server_url_secret = parsed_json["serverUrlSecret"]
+      if parsed_json["server"].nil?
+        server = nil
+      else
+        server = parsed_json["server"].to_json
+        server = Vapi::Server.from_json(json_object: server)
+      end
       concurrency_limit = parsed_json["concurrencyLimit"]
       new(
         hipaa_enabled: hipaa_enabled,
+        subscription_id: subscription_id,
         name: name,
+        channel: channel,
         billing_limit: billing_limit,
-        server_url: server_url,
-        server_url_secret: server_url_secret,
+        server: server,
         concurrency_limit: concurrency_limit,
         additional_properties: struct
       )
@@ -119,10 +137,11 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       obj.hipaa_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.hipaa_enabled is not the expected type, validation failed.")
+      obj.subscription_id&.is_a?(String) != false || raise("Passed value for field obj.subscription_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.channel&.is_a?(Vapi::UpdateOrgDtoChannel) != false || raise("Passed value for field obj.channel is not the expected type, validation failed.")
       obj.billing_limit&.is_a?(Float) != false || raise("Passed value for field obj.billing_limit is not the expected type, validation failed.")
-      obj.server_url&.is_a?(String) != false || raise("Passed value for field obj.server_url is not the expected type, validation failed.")
-      obj.server_url_secret&.is_a?(String) != false || raise("Passed value for field obj.server_url_secret is not the expected type, validation failed.")
+      obj.server.nil? || Vapi::Server.validate_raw(obj: obj.server)
       obj.concurrency_limit&.is_a?(Float) != false || raise("Passed value for field obj.concurrency_limit is not the expected type, validation failed.")
     end
   end

data/lib/vapi_server_sdk/types/update_org_dto_channel.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the channel of the org. There is the cluster the API traffic for the org
+  #  will be directed.
+  class UpdateOrgDtoChannel
+    DEFAULT = "default"
+    WEEKLY = "weekly"
+  end
+end