vapi_server_sdk 0.0.0.pre.alpha7

data/lib/vapi_server_sdk/types/neets_voice.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require_relative "neets_voice_id"
+require_relative "chunk_plan"
+require "ostruct"
+require "json"
+
+module Vapi
+  class NeetsVoice
+    # @return [Boolean] This determines whether fillers are injected into the model output before
+    #  inputting it into the voice provider.
+    #  Default `false` because you can achieve better results with prompting the model.
+    attr_reader :filler_injection_enabled
+    # @return [Vapi::NeetsVoiceId] This is the provider-specific ID that will be used.
+    attr_reader :voice_id
+    # @return [Vapi::ChunkPlan] This is the plan for chunking the model output before it is sent to the voice
+    #  provider.
+    attr_reader :chunk_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 filler_injection_enabled [Boolean] This determines whether fillers are injected into the model output before
+    #  inputting it into the voice provider.
+    #  Default `false` because you can achieve better results with prompting the model.
+    # @param voice_id [Vapi::NeetsVoiceId] This is the provider-specific ID that will be used.
+    # @param chunk_plan [Vapi::ChunkPlan] This is the plan for chunking the model output before it is sent to the voice
+    #  provider.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::NeetsVoice]
+    def initialize(voice_id:, filler_injection_enabled: OMIT, chunk_plan: OMIT, additional_properties: nil)
+      @filler_injection_enabled = filler_injection_enabled if filler_injection_enabled != OMIT
+      @voice_id = voice_id
+      @chunk_plan = chunk_plan if chunk_plan != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "fillerInjectionEnabled": filler_injection_enabled,
+        "voiceId": voice_id,
+        "chunkPlan": chunk_plan
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of NeetsVoice
+    #
+    # @param json_object [String]
+    # @return [Vapi::NeetsVoice]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      filler_injection_enabled = parsed_json["fillerInjectionEnabled"]
+      if parsed_json["voiceId"].nil?
+        voice_id = nil
+      else
+        voice_id = parsed_json["voiceId"].to_json
+        voice_id = Vapi::NeetsVoiceId.from_json(json_object: voice_id)
+      end
+      if parsed_json["chunkPlan"].nil?
+        chunk_plan = nil
+      else
+        chunk_plan = parsed_json["chunkPlan"].to_json
+        chunk_plan = Vapi::ChunkPlan.from_json(json_object: chunk_plan)
+      end
+      new(
+        filler_injection_enabled: filler_injection_enabled,
+        voice_id: voice_id,
+        chunk_plan: chunk_plan,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of NeetsVoice 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.filler_injection_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.filler_injection_enabled is not the expected type, validation failed.")
+      Vapi::NeetsVoiceId.validate_raw(obj: obj.voice_id)
+      obj.chunk_plan.nil? || Vapi::ChunkPlan.validate_raw(obj: obj.chunk_plan)
+    end
+  end
+end

data/lib/vapi_server_sdk/types/neets_voice_id.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Vapi
+  # This is the provider-specific ID that will be used.
+  class NeetsVoiceId
+    # Deserialize a JSON object to an instance of NeetsVoiceId
+    #
+    # @param json_object [String]
+    # @return [Vapi::NeetsVoiceId]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      begin
+        struct.is_a?(Vapi::NeetsVoiceIdEnum) != false || raise("Passed value for field struct is not the expected type, validation failed.")
+        return struct unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      begin
+        struct.is_a?(String) != false || raise("Passed value for field struct is not the expected type, validation failed.")
+        return struct unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      struct
+    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:)
+      begin
+        return obj.is_a?(Vapi::NeetsVoiceIdEnum) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+      rescue StandardError
+        # noop
+      end
+      begin
+        return obj.is_a?(String) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+      rescue StandardError
+        # noop
+      end
+      raise("Passed value matched no type within the union, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/neets_voice_id_enum.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Vapi
+  class NeetsVoiceIdEnum
+    VITS = "vits"
+  end
+end

data/lib/vapi_server_sdk/types/open_ai_credential.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require "date"
+require "ostruct"
+require "json"
+
+module Vapi
+  class OpenAiCredential
+    # @return [String]
+    attr_reader :provider
+    # @return [String] This is not returned in the API.
+    attr_reader :api_key
+    # @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 [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 api_key [String] This is not returned in the API.
+    # @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 additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::OpenAiCredential]
+    def initialize(provider:, api_key:, id:, org_id:, created_at:, updated_at:, additional_properties: nil)
+      @provider = provider
+      @api_key = api_key
+      @id = id
+      @org_id = org_id
+      @created_at = created_at
+      @updated_at = updated_at
+      @additional_properties = additional_properties
+      @_field_set = {
+        "provider": provider,
+        "apiKey": api_key,
+        "id": id,
+        "orgId": org_id,
+        "createdAt": created_at,
+        "updatedAt": updated_at
+      }
+    end
+
+    # Deserialize a JSON object to an instance of OpenAiCredential
+    #
+    # @param json_object [String]
+    # @return [Vapi::OpenAiCredential]
+    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"]
+      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?)
+      new(
+        provider: provider,
+        api_key: api_key,
+        id: id,
+        org_id: org_id,
+        created_at: created_at,
+        updated_at: updated_at,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of OpenAiCredential 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.api_key.is_a?(String) != false || raise("Passed value for field obj.api_key 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.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/open_ai_function.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require_relative "open_ai_function_parameters"
+require "ostruct"
+require "json"
+
+module Vapi
+  class OpenAiFunction
+    # @return [String] This is the the name of the function to be called.
+    #  Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length
+    #  of 64.
+    attr_reader :name
+    # @return [String]
+    attr_reader :description
+    # @return [Vapi::OpenAiFunctionParameters] These are the parameters the functions accepts, described as a JSON Schema
+    #  object.
+    #  See the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling)
+    #  for examples, and the [JSON Schema
+    #  reference](https://json-schema.org/understanding-json-schema) for documentation
+    #  about the format.
+    #  Omitting parameters defines a function with an empty parameter list.
+    attr_reader :parameters
+    # @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 name [String] This is the the name of the function to be called.
+    #  Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length
+    #  of 64.
+    # @param description [String]
+    # @param parameters [Vapi::OpenAiFunctionParameters] These are the parameters the functions accepts, described as a JSON Schema
+    #  object.
+    #  See the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling)
+    #  for examples, and the [JSON Schema
+    #  reference](https://json-schema.org/understanding-json-schema) for documentation
+    #  about the format.
+    #  Omitting parameters defines a function with an empty parameter list.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::OpenAiFunction]
+    def initialize(name:, description: OMIT, parameters: OMIT, additional_properties: nil)
+      @name = name
+      @description = description if description != OMIT
+      @parameters = parameters if parameters != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "name": name, "description": description, "parameters": parameters }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of OpenAiFunction
+    #
+    # @param json_object [String]
+    # @return [Vapi::OpenAiFunction]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      name = parsed_json["name"]
+      description = parsed_json["description"]
+      if parsed_json["parameters"].nil?
+        parameters = nil
+      else
+        parameters = parsed_json["parameters"].to_json
+        parameters = Vapi::OpenAiFunctionParameters.from_json(json_object: parameters)
+      end
+      new(
+        name: name,
+        description: description,
+        parameters: parameters,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of OpenAiFunction 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.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
+      obj.parameters.nil? || Vapi::OpenAiFunctionParameters.validate_raw(obj: obj.parameters)
+    end
+  end
+end

data/lib/vapi_server_sdk/types/open_ai_function_parameters.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class OpenAiFunctionParameters
+    # @return [String] This must be set to 'object'. It instructs the model to return a JSON object
+    #  containing the function call properties.
+    attr_reader :type
+    # @return [Hash{String => Vapi::JsonSchema}] This provides a description of the properties required by the function.
+    #  JSON Schema can be used to specify expectations for each property.
+    #  Refer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a
+    #  comprehensive guide on JSON Schema.
+    attr_reader :properties
+    # @return [Array<String>] This specifies the properties that are required by the function.
+    attr_reader :required
+    # @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 must be set to 'object'. It instructs the model to return a JSON object
+    #  containing the function call properties.
+    # @param properties [Hash{String => Vapi::JsonSchema}] This provides a description of the properties required by the function.
+    #  JSON Schema can be used to specify expectations for each property.
+    #  Refer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a
+    #  comprehensive guide on JSON Schema.
+    # @param required [Array<String>] This specifies the properties that are required by the function.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::OpenAiFunctionParameters]
+    def initialize(type:, properties:, required: OMIT, additional_properties: nil)
+      @type = type
+      @properties = properties
+      @required = required if required != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "type": type, "properties": properties, "required": required }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of OpenAiFunctionParameters
+    #
+    # @param json_object [String]
+    # @return [Vapi::OpenAiFunctionParameters]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      type = parsed_json["type"]
+      properties = parsed_json["properties"]&.transform_values do |value|
+        value = value.to_json
+        Vapi::JsonSchema.from_json(json_object: value)
+      end
+      required = parsed_json["required"]
+      new(
+        type: type,
+        properties: properties,
+        required: required,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of OpenAiFunctionParameters 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.properties.is_a?(Hash) != false || raise("Passed value for field obj.properties is not the expected type, validation failed.")
+      obj.required&.is_a?(Array) != false || raise("Passed value for field obj.required is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/open_ai_message.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require_relative "open_ai_message_role"
+require "ostruct"
+require "json"
+
+module Vapi
+  class OpenAiMessage
+    # @return [String]
+    attr_reader :content
+    # @return [Vapi::OpenAiMessageRole]
+    attr_reader :role
+    # @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 content [String]
+    # @param role [Vapi::OpenAiMessageRole]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::OpenAiMessage]
+    def initialize(role:, content: OMIT, additional_properties: nil)
+      @content = content if content != OMIT
+      @role = role
+      @additional_properties = additional_properties
+      @_field_set = { "content": content, "role": role }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of OpenAiMessage
+    #
+    # @param json_object [String]
+    # @return [Vapi::OpenAiMessage]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      content = parsed_json["content"]
+      role = parsed_json["role"]
+      new(
+        content: content,
+        role: role,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of OpenAiMessage 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.content&.is_a?(String) != false || raise("Passed value for field obj.content is not the expected type, validation failed.")
+      obj.role.is_a?(Vapi::OpenAiMessageRole) != false || raise("Passed value for field obj.role is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/open_ai_message_role.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Vapi
+  class OpenAiMessageRole
+    ASSISTANT = "assistant"
+    FUNCTION = "function"
+    USER = "user"
+    SYSTEM = "system"
+    TOOL = "tool"
+  end
+end