vapi_server_sdk 0.0.0.pre.alpha7

data/lib/vapi_server_sdk/types/function_tool_with_tool_call.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+require_relative "function_tool_with_tool_call_messages_item"
+require_relative "tool_call"
+require_relative "open_ai_function"
+require_relative "server"
+require "ostruct"
+require "json"
+
+module Vapi
+  class FunctionToolWithToolCall
+    # @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::FunctionToolWithToolCallMessagesItem>] 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::ToolCall]
+    attr_reader :tool_call
+    # @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 [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::FunctionToolWithToolCallMessagesItem>] 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 tool_call [Vapi::ToolCall]
+    # @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 additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::FunctionToolWithToolCall]
+    def initialize(tool_call:, async: OMIT, messages: OMIT, function: OMIT, server: OMIT, additional_properties: nil)
+      @async = async if async != OMIT
+      @messages = messages if messages != OMIT
+      @tool_call = tool_call
+      @function = function if function != OMIT
+      @server = server if server != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "async": async,
+        "messages": messages,
+        "toolCall": tool_call,
+        "function": function,
+        "server": server
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of FunctionToolWithToolCall
+    #
+    # @param json_object [String]
+    # @return [Vapi::FunctionToolWithToolCall]
+    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::FunctionToolWithToolCallMessagesItem.from_json(json_object: item)
+      end
+      if parsed_json["toolCall"].nil?
+        tool_call = nil
+      else
+        tool_call = parsed_json["toolCall"].to_json
+        tool_call = Vapi::ToolCall.from_json(json_object: tool_call)
+      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
+      new(
+        async: async,
+        messages: messages,
+        tool_call: tool_call,
+        function: function,
+        server: server,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of FunctionToolWithToolCall 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.")
+      Vapi::ToolCall.validate_raw(obj: obj.tool_call)
+      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/function_tool_with_tool_call_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 FunctionToolWithToolCallMessagesItem
+    # @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::FunctionToolWithToolCallMessagesItem]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of FunctionToolWithToolCallMessagesItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::FunctionToolWithToolCallMessagesItem]
+    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::FunctionToolWithToolCallMessagesItem]
+    def self.request_start(member:)
+      new(member: member, discriminant: "request-start")
+    end
+
+    # @param member [Vapi::ToolMessageComplete]
+    # @return [Vapi::FunctionToolWithToolCallMessagesItem]
+    def self.request_complete(member:)
+      new(member: member, discriminant: "request-complete")
+    end
+
+    # @param member [Vapi::ToolMessageFailed]
+    # @return [Vapi::FunctionToolWithToolCallMessagesItem]
+    def self.request_failed(member:)
+      new(member: member, discriminant: "request-failed")
+    end
+
+    # @param member [Vapi::ToolMessageDelayed]
+    # @return [Vapi::FunctionToolWithToolCallMessagesItem]
+    def self.request_response_delayed(member:)
+      new(member: member, discriminant: "request-response-delayed")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/gcp_credential.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require "date"
+require_relative "gcp_key"
+require_relative "bucket_plan"
+require "ostruct"
+require "json"
+
+module Vapi
+  class GcpCredential
+    # @return [String]
+    attr_reader :provider
+    # @return [String] This is the unique identifier for the credential.
+    attr_reader :id
+    # @return [String] This is the unique identifier for the org that this credential belongs to.
+    attr_reader :org_id
+    # @return [DateTime] This is the ISO 8601 date-time string of when the credential was created.
+    attr_reader :created_at
+    # @return [DateTime] This is the ISO 8601 date-time string of when the assistant was last updated.
+    attr_reader :updated_at
+    # @return [String] This is the name of the GCP credential. This is just for your reference.
+    attr_reader :name
+    # @return [Vapi::GcpKey] This is the GCP key. This is the JSON that can be generated in the Google Cloud
+    #  Console at
+    #  le.cloud.google.com/iam-admin/serviceaccounts/details/<service-account-id>/keys.
+    #  The schema is identical to the JSON that GCP outputs.
+    attr_reader :gcp_key
+    # @return [Vapi::BucketPlan] This is the bucket plan that can be provided to store call artifacts in GCP.
+    attr_reader :bucket_plan
+    # @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 provider [String]
+    # @param id [String] This is the unique identifier for the credential.
+    # @param org_id [String] This is the unique identifier for the org that this credential belongs to.
+    # @param created_at [DateTime] This is the ISO 8601 date-time string of when the credential was created.
+    # @param updated_at [DateTime] This is the ISO 8601 date-time string of when the assistant was last updated.
+    # @param name [String] This is the name of the GCP credential. This is just for your reference.
+    # @param gcp_key [Vapi::GcpKey] This is the GCP key. This is the JSON that can be generated in the Google Cloud
+    #  Console at
+    #  le.cloud.google.com/iam-admin/serviceaccounts/details/<service-account-id>/keys.
+    #  The schema is identical to the JSON that GCP outputs.
+    # @param bucket_plan [Vapi::BucketPlan] This is the bucket plan that can be provided to store call artifacts in GCP.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::GcpCredential]
+    def initialize(provider:, id:, org_id:, created_at:, updated_at:, gcp_key:, name: OMIT, bucket_plan: OMIT,
+                   additional_properties: nil)
+      @provider = provider
+      @id = id
+      @org_id = org_id
+      @created_at = created_at
+      @updated_at = updated_at
+      @name = name if name != OMIT
+      @gcp_key = gcp_key
+      @bucket_plan = bucket_plan if bucket_plan != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "provider": provider,
+        "id": id,
+        "orgId": org_id,
+        "createdAt": created_at,
+        "updatedAt": updated_at,
+        "name": name,
+        "gcpKey": gcp_key,
+        "bucketPlan": bucket_plan
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of GcpCredential
+    #
+    # @param json_object [String]
+    # @return [Vapi::GcpCredential]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      provider = parsed_json["provider"]
+      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?)
+      name = parsed_json["name"]
+      if parsed_json["gcpKey"].nil?
+        gcp_key = nil
+      else
+        gcp_key = parsed_json["gcpKey"].to_json
+        gcp_key = Vapi::GcpKey.from_json(json_object: gcp_key)
+      end
+      if parsed_json["bucketPlan"].nil?
+        bucket_plan = nil
+      else
+        bucket_plan = parsed_json["bucketPlan"].to_json
+        bucket_plan = Vapi::BucketPlan.from_json(json_object: bucket_plan)
+      end
+      new(
+        provider: provider,
+        id: id,
+        org_id: org_id,
+        created_at: created_at,
+        updated_at: updated_at,
+        name: name,
+        gcp_key: gcp_key,
+        bucket_plan: bucket_plan,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of GcpCredential 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.provider.is_a?(String) != false || raise("Passed value for field obj.provider 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.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      Vapi::GcpKey.validate_raw(obj: obj.gcp_key)
+      obj.bucket_plan.nil? || Vapi::BucketPlan.validate_raw(obj: obj.bucket_plan)
+    end
+  end
+end

data/lib/vapi_server_sdk/types/gcp_key.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class GcpKey
+    # @return [String] This is the type of the key. Most likely, this is "service_account".
+    attr_reader :type
+    # @return [String] This is the ID of the Google Cloud project associated with this key.
+    attr_reader :project_id
+    # @return [String] This is the unique identifier for the private key.
+    attr_reader :private_key_id
+    # @return [String] This is the private key in PEM format.
+    #  Note: This is not returned in the API.
+    attr_reader :private_key
+    # @return [String] This is the email address associated with the service account.
+    attr_reader :client_email
+    # @return [String] This is the unique identifier for the client.
+    attr_reader :client_id
+    # @return [String] This is the URI for the auth provider's authorization endpoint.
+    attr_reader :auth_uri
+    # @return [String] This is the URI for the auth provider's token endpoint.
+    attr_reader :token_uri
+    # @return [String] This is the URL of the public x509 certificate for the auth provider.
+    attr_reader :auth_provider_x_509_cert_url
+    # @return [String] This is the URL of the public x509 certificate for the client.
+    attr_reader :client_x_509_cert_url
+    # @return [String] This is the domain associated with the universe this service account belongs to.
+    attr_reader :universe_domain
+    # @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 type [String] This is the type of the key. Most likely, this is "service_account".
+    # @param project_id [String] This is the ID of the Google Cloud project associated with this key.
+    # @param private_key_id [String] This is the unique identifier for the private key.
+    # @param private_key [String] This is the private key in PEM format.
+    #  Note: This is not returned in the API.
+    # @param client_email [String] This is the email address associated with the service account.
+    # @param client_id [String] This is the unique identifier for the client.
+    # @param auth_uri [String] This is the URI for the auth provider's authorization endpoint.
+    # @param token_uri [String] This is the URI for the auth provider's token endpoint.
+    # @param auth_provider_x_509_cert_url [String] This is the URL of the public x509 certificate for the auth provider.
+    # @param client_x_509_cert_url [String] This is the URL of the public x509 certificate for the client.
+    # @param universe_domain [String] This is the domain associated with the universe this service account belongs to.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::GcpKey]
+    def initialize(type:, project_id:, private_key_id:, private_key:, client_email:, client_id:, auth_uri:, token_uri:,
+                   auth_provider_x_509_cert_url:, client_x_509_cert_url:, universe_domain:, additional_properties: nil)
+      @type = type
+      @project_id = project_id
+      @private_key_id = private_key_id
+      @private_key = private_key
+      @client_email = client_email
+      @client_id = client_id
+      @auth_uri = auth_uri
+      @token_uri = token_uri
+      @auth_provider_x_509_cert_url = auth_provider_x_509_cert_url
+      @client_x_509_cert_url = client_x_509_cert_url
+      @universe_domain = universe_domain
+      @additional_properties = additional_properties
+      @_field_set = {
+        "type": type,
+        "projectId": project_id,
+        "privateKeyId": private_key_id,
+        "privateKey": private_key,
+        "clientEmail": client_email,
+        "clientId": client_id,
+        "authUri": auth_uri,
+        "tokenUri": token_uri,
+        "authProviderX509CertUrl": auth_provider_x_509_cert_url,
+        "clientX509CertUrl": client_x_509_cert_url,
+        "universeDomain": universe_domain
+      }
+    end
+
+    # Deserialize a JSON object to an instance of GcpKey
+    #
+    # @param json_object [String]
+    # @return [Vapi::GcpKey]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      type = parsed_json["type"]
+      project_id = parsed_json["projectId"]
+      private_key_id = parsed_json["privateKeyId"]
+      private_key = parsed_json["privateKey"]
+      client_email = parsed_json["clientEmail"]
+      client_id = parsed_json["clientId"]
+      auth_uri = parsed_json["authUri"]
+      token_uri = parsed_json["tokenUri"]
+      auth_provider_x_509_cert_url = parsed_json["authProviderX509CertUrl"]
+      client_x_509_cert_url = parsed_json["clientX509CertUrl"]
+      universe_domain = parsed_json["universeDomain"]
+      new(
+        type: type,
+        project_id: project_id,
+        private_key_id: private_key_id,
+        private_key: private_key,
+        client_email: client_email,
+        client_id: client_id,
+        auth_uri: auth_uri,
+        token_uri: token_uri,
+        auth_provider_x_509_cert_url: auth_provider_x_509_cert_url,
+        client_x_509_cert_url: client_x_509_cert_url,
+        universe_domain: universe_domain,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of GcpKey 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.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      obj.project_id.is_a?(String) != false || raise("Passed value for field obj.project_id is not the expected type, validation failed.")
+      obj.private_key_id.is_a?(String) != false || raise("Passed value for field obj.private_key_id is not the expected type, validation failed.")
+      obj.private_key.is_a?(String) != false || raise("Passed value for field obj.private_key is not the expected type, validation failed.")
+      obj.client_email.is_a?(String) != false || raise("Passed value for field obj.client_email is not the expected type, validation failed.")
+      obj.client_id.is_a?(String) != false || raise("Passed value for field obj.client_id is not the expected type, validation failed.")
+      obj.auth_uri.is_a?(String) != false || raise("Passed value for field obj.auth_uri is not the expected type, validation failed.")
+      obj.token_uri.is_a?(String) != false || raise("Passed value for field obj.token_uri is not the expected type, validation failed.")
+      obj.auth_provider_x_509_cert_url.is_a?(String) != false || raise("Passed value for field obj.auth_provider_x_509_cert_url is not the expected type, validation failed.")
+      obj.client_x_509_cert_url.is_a?(String) != false || raise("Passed value for field obj.client_x_509_cert_url is not the expected type, validation failed.")
+      obj.universe_domain.is_a?(String) != false || raise("Passed value for field obj.universe_domain is not the expected type, validation failed.")
+    end
+  end
+end