vapi_server_sdk 0.0.0.pre.alpha7

data/lib/vapi_server_sdk/types/json_schema.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require_relative "json_schema_type"
+require "ostruct"
+require "json"
+
+module Vapi
+  class JsonSchema
+    # @return [Vapi::JsonSchemaType] This is the type of output you'd like.
+    #  `string`, `number`, `integer`, `boolean` are the primitive types and should be
+    #  obvious.
+    #  `array` and `object` are more interesting and quite powerful. They allow you to
+    #  define nested structures.
+    #  For `array`, you can define the schema of the items in the array using the
+    #  `items` property.
+    #  For `object`, you can define the properties of the object using the `properties`
+    #  property.
+    attr_reader :type
+    # @return [Hash{String => Object}] This is required if the type is "array". This is the schema of the items in the
+    #  array.
+    #  This is of type JsonSchema. However, Swagger doesn't support circular
+    #  references.
+    attr_reader :items
+    # @return [Hash{String => Object}] This is required if the type is "object". This specifies the properties of the
+    #  object.
+    #  This is a map of string to JsonSchema. However, Swagger doesn't support circular
+    #  references.
+    attr_reader :properties
+    # @return [String] This is the description to help the model understand what it needs to output.
+    attr_reader :description
+    # @return [Array<String>] This is a list of properties that are required.
+    #  This only makes sense if the type is "object".
+    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 [Vapi::JsonSchemaType] This is the type of output you'd like.
+    #  `string`, `number`, `integer`, `boolean` are the primitive types and should be
+    #  obvious.
+    #  `array` and `object` are more interesting and quite powerful. They allow you to
+    #  define nested structures.
+    #  For `array`, you can define the schema of the items in the array using the
+    #  `items` property.
+    #  For `object`, you can define the properties of the object using the `properties`
+    #  property.
+    # @param items [Hash{String => Object}] This is required if the type is "array". This is the schema of the items in the
+    #  array.
+    #  This is of type JsonSchema. However, Swagger doesn't support circular
+    #  references.
+    # @param properties [Hash{String => Object}] This is required if the type is "object". This specifies the properties of the
+    #  object.
+    #  This is a map of string to JsonSchema. However, Swagger doesn't support circular
+    #  references.
+    # @param description [String] This is the description to help the model understand what it needs to output.
+    # @param required [Array<String>] This is a list of properties that are required.
+    #  This only makes sense if the type is "object".
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::JsonSchema]
+    def initialize(type:, items: OMIT, properties: OMIT, description: OMIT, required: OMIT, additional_properties: nil)
+      @type = type
+      @items = items if items != OMIT
+      @properties = properties if properties != OMIT
+      @description = description if description != OMIT
+      @required = required if required != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "type": type,
+        "items": items,
+        "properties": properties,
+        "description": description,
+        "required": required
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of JsonSchema
+    #
+    # @param json_object [String]
+    # @return [Vapi::JsonSchema]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      type = parsed_json["type"]
+      items = parsed_json["items"]
+      properties = parsed_json["properties"]
+      description = parsed_json["description"]
+      required = parsed_json["required"]
+      new(
+        type: type,
+        items: items,
+        properties: properties,
+        description: description,
+        required: required,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of JsonSchema 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?(Vapi::JsonSchemaType) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      obj.items&.is_a?(Hash) != false || raise("Passed value for field obj.items 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.description&.is_a?(String) != false || raise("Passed value for field obj.description 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/json_schema_type.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the type of output you'd like.
+  #  `string`, `number`, `integer`, `boolean` are the primitive types and should be
+  #  obvious.
+  #  `array` and `object` are more interesting and quite powerful. They allow you to
+  #  define nested structures.
+  #  For `array`, you can define the schema of the items in the array using the
+  #  `items` property.
+  #  For `object`, you can define the properties of the object using the `properties`
+  #  property.
+  class JsonSchemaType
+    STRING = "string"
+    NUMBER = "number"
+    INTEGER = "integer"
+    BOOLEAN = "boolean"
+    ARRAY = "array"
+    OBJECT = "object"
+  end
+end

data/lib/vapi_server_sdk/types/knowledge_base.rb

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

data/lib/vapi_server_sdk/types/lmnt_credential.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require "date"
+require "ostruct"
+require "json"
+
+module Vapi
+  class LmntCredential
+    # @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::LmntCredential]
+    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 LmntCredential
+    #
+    # @param json_object [String]
+    # @return [Vapi::LmntCredential]
+    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 LmntCredential 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/lmnt_voice.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require_relative "lmnt_voice_id"
+require_relative "chunk_plan"
+require "ostruct"
+require "json"
+
+module Vapi
+  class LmntVoice
+    # @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::LmntVoiceId] This is the provider-specific ID that will be used.
+    attr_reader :voice_id
+    # @return [Float] This is the speed multiplier that will be used.
+    attr_reader :speed
+    # @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::LmntVoiceId] This is the provider-specific ID that will be used.
+    # @param speed [Float] This is the speed multiplier 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::LmntVoice]
+    def initialize(voice_id:, filler_injection_enabled: OMIT, speed: OMIT, chunk_plan: OMIT, additional_properties: nil)
+      @filler_injection_enabled = filler_injection_enabled if filler_injection_enabled != OMIT
+      @voice_id = voice_id
+      @speed = speed if speed != OMIT
+      @chunk_plan = chunk_plan if chunk_plan != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "fillerInjectionEnabled": filler_injection_enabled,
+        "voiceId": voice_id,
+        "speed": speed,
+        "chunkPlan": chunk_plan
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of LmntVoice
+    #
+    # @param json_object [String]
+    # @return [Vapi::LmntVoice]
+    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::LmntVoiceId.from_json(json_object: voice_id)
+      end
+      speed = parsed_json["speed"]
+      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,
+        speed: speed,
+        chunk_plan: chunk_plan,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of LmntVoice 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::LmntVoiceId.validate_raw(obj: obj.voice_id)
+      obj.speed&.is_a?(Float) != false || raise("Passed value for field obj.speed is not the expected type, validation failed.")
+      obj.chunk_plan.nil? || Vapi::ChunkPlan.validate_raw(obj: obj.chunk_plan)
+    end
+  end
+end

data/lib/vapi_server_sdk/types/lmnt_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 LmntVoiceId
+    # Deserialize a JSON object to an instance of LmntVoiceId
+    #
+    # @param json_object [String]
+    # @return [Vapi::LmntVoiceId]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      begin
+        struct.is_a?(Vapi::LmntVoiceIdEnum) != 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::LmntVoiceIdEnum) != 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/lmnt_voice_id_enum.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Vapi
+  class LmntVoiceIdEnum
+    LILY = "lily"
+    DANIEL = "daniel"
+  end
+end