vapi_server_sdk 0.0.0.pre.alpha7

data/lib/vapi_server_sdk/tools/types/tools_update_response.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "../../types/dtmf_tool"
+require_relative "../../types/end_call_tool"
+require_relative "../../types/function_tool"
+require_relative "../../types/ghl_tool"
+require_relative "../../types/make_tool"
+require_relative "../../types/transfer_call_tool"
+require_relative "../../types/output_tool"
+
+module Vapi
+  class Tools
+    class ToolsUpdateResponse
+      # @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::Tools::ToolsUpdateResponse]
+      def initialize(member:, discriminant:)
+        @member = member
+        @discriminant = discriminant
+      end
+
+      # Deserialize a JSON object to an instance of ToolsUpdateResponse
+      #
+      # @param json_object [String]
+      # @return [Vapi::Tools::ToolsUpdateResponse]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        member = case struct.type
+                 when "dtmf"
+                   Vapi::DtmfTool.from_json(json_object: json_object)
+                 when "endCall"
+                   Vapi::EndCallTool.from_json(json_object: json_object)
+                 when "function"
+                   Vapi::FunctionTool.from_json(json_object: json_object)
+                 when "ghl"
+                   Vapi::GhlTool.from_json(json_object: json_object)
+                 when "make"
+                   Vapi::MakeTool.from_json(json_object: json_object)
+                 when "transferCall"
+                   Vapi::TransferCallTool.from_json(json_object: json_object)
+                 when "output"
+                   Vapi::OutputTool.from_json(json_object: json_object)
+                 else
+                   Vapi::DtmfTool.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 "dtmf"
+          { **@member.to_json, type: @discriminant }.to_json
+        when "endCall"
+          { **@member.to_json, type: @discriminant }.to_json
+        when "function"
+          { **@member.to_json, type: @discriminant }.to_json
+        when "ghl"
+          { **@member.to_json, type: @discriminant }.to_json
+        when "make"
+          { **@member.to_json, type: @discriminant }.to_json
+        when "transferCall"
+          { **@member.to_json, type: @discriminant }.to_json
+        when "output"
+          { **@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 "dtmf"
+          Vapi::DtmfTool.validate_raw(obj: obj)
+        when "endCall"
+          Vapi::EndCallTool.validate_raw(obj: obj)
+        when "function"
+          Vapi::FunctionTool.validate_raw(obj: obj)
+        when "ghl"
+          Vapi::GhlTool.validate_raw(obj: obj)
+        when "make"
+          Vapi::MakeTool.validate_raw(obj: obj)
+        when "transferCall"
+          Vapi::TransferCallTool.validate_raw(obj: obj)
+        when "output"
+          Vapi::OutputTool.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::DtmfTool]
+      # @return [Vapi::Tools::ToolsUpdateResponse]
+      def self.dtmf(member:)
+        new(member: member, discriminant: "dtmf")
+      end
+
+      # @param member [Vapi::EndCallTool]
+      # @return [Vapi::Tools::ToolsUpdateResponse]
+      def self.end_call(member:)
+        new(member: member, discriminant: "endCall")
+      end
+
+      # @param member [Vapi::FunctionTool]
+      # @return [Vapi::Tools::ToolsUpdateResponse]
+      def self.function(member:)
+        new(member: member, discriminant: "function")
+      end
+
+      # @param member [Vapi::GhlTool]
+      # @return [Vapi::Tools::ToolsUpdateResponse]
+      def self.ghl(member:)
+        new(member: member, discriminant: "ghl")
+      end
+
+      # @param member [Vapi::MakeTool]
+      # @return [Vapi::Tools::ToolsUpdateResponse]
+      def self.make(member:)
+        new(member: member, discriminant: "make")
+      end
+
+      # @param member [Vapi::TransferCallTool]
+      # @return [Vapi::Tools::ToolsUpdateResponse]
+      def self.transfer_call(member:)
+        new(member: member, discriminant: "transferCall")
+      end
+
+      # @param member [Vapi::OutputTool]
+      # @return [Vapi::Tools::ToolsUpdateResponse]
+      def self.output(member:)
+        new(member: member, discriminant: "output")
+      end
+    end
+  end
+end

data/lib/vapi_server_sdk/tools/types/update_tool_dto_messages_item.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "../../types/tool_message_start"
+require_relative "../../types/tool_message_complete"
+require_relative "../../types/tool_message_failed"
+require_relative "../../types/tool_message_delayed"
+
+module Vapi
+  class Tools
+    class UpdateToolDtoMessagesItem
+      # @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::Tools::UpdateToolDtoMessagesItem]
+      def initialize(member:, discriminant:)
+        @member = member
+        @discriminant = discriminant
+      end
+
+      # Deserialize a JSON object to an instance of UpdateToolDtoMessagesItem
+      #
+      # @param json_object [String]
+      # @return [Vapi::Tools::UpdateToolDtoMessagesItem]
+      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::Tools::UpdateToolDtoMessagesItem]
+      def self.request_start(member:)
+        new(member: member, discriminant: "request-start")
+      end
+
+      # @param member [Vapi::ToolMessageComplete]
+      # @return [Vapi::Tools::UpdateToolDtoMessagesItem]
+      def self.request_complete(member:)
+        new(member: member, discriminant: "request-complete")
+      end
+
+      # @param member [Vapi::ToolMessageFailed]
+      # @return [Vapi::Tools::UpdateToolDtoMessagesItem]
+      def self.request_failed(member:)
+        new(member: member, discriminant: "request-failed")
+      end
+
+      # @param member [Vapi::ToolMessageDelayed]
+      # @return [Vapi::Tools::UpdateToolDtoMessagesItem]
+      def self.request_response_delayed(member:)
+        new(member: member, discriminant: "request-response-delayed")
+      end
+    end
+  end
+end

data/lib/vapi_server_sdk/types/add_voice_to_provider_dto.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class AddVoiceToProviderDto
+    # @return [String] This is the owner_id of your shared voice which you want to add to your provider
+    #  Account from Provider Voice Library
+    attr_reader :owner_id
+    # @return [String] This is the voice_id of the shared voice which you want to add to your provider
+    #  Account from Provider Voice Library
+    attr_reader :voice_id
+    # @return [String] This is the new name of the voice which you want to have once you have added
+    #  voice to your provider Account from Provider Voice Library
+    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 owner_id [String] This is the owner_id of your shared voice which you want to add to your provider
+    #  Account from Provider Voice Library
+    # @param voice_id [String] This is the voice_id of the shared voice which you want to add to your provider
+    #  Account from Provider Voice Library
+    # @param name [String] This is the new name of the voice which you want to have once you have added
+    #  voice to your provider Account from Provider Voice Library
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::AddVoiceToProviderDto]
+    def initialize(owner_id:, voice_id:, name:, additional_properties: nil)
+      @owner_id = owner_id
+      @voice_id = voice_id
+      @name = name
+      @additional_properties = additional_properties
+      @_field_set = { "ownerId": owner_id, "voiceId": voice_id, "name": name }
+    end
+
+    # Deserialize a JSON object to an instance of AddVoiceToProviderDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::AddVoiceToProviderDto]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      owner_id = parsed_json["ownerId"]
+      voice_id = parsed_json["voiceId"]
+      name = parsed_json["name"]
+      new(
+        owner_id: owner_id,
+        voice_id: voice_id,
+        name: name,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of AddVoiceToProviderDto 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.owner_id.is_a?(String) != false || raise("Passed value for field obj.owner_id is not the expected type, validation failed.")
+      obj.voice_id.is_a?(String) != false || raise("Passed value for field obj.voice_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.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/analysis.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class Analysis
+    # @return [String] This is the summary of the call. Customize by setting
+    #  `assistant.analysisPlan.summaryPrompt`.
+    attr_reader :summary
+    # @return [Hash{String => Object}] This is the structured data extracted from the call. Customize by setting
+    #  `assistant.analysisPlan.structuredDataPrompt` and/or
+    #  `assistant.analysisPlan.structuredDataSchema`.
+    attr_reader :structured_data
+    # @return [String] This is the evaluation of the call. Customize by setting
+    #  `assistant.analysisPlan.successEvaluationPrompt` and/or
+    #  `assistant.analysisPlan.successEvaluationRubric`.
+    attr_reader :success_evaluation
+    # @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 summary [String] This is the summary of the call. Customize by setting
+    #  `assistant.analysisPlan.summaryPrompt`.
+    # @param structured_data [Hash{String => Object}] This is the structured data extracted from the call. Customize by setting
+    #  `assistant.analysisPlan.structuredDataPrompt` and/or
+    #  `assistant.analysisPlan.structuredDataSchema`.
+    # @param success_evaluation [String] This is the evaluation of the call. Customize by setting
+    #  `assistant.analysisPlan.successEvaluationPrompt` and/or
+    #  `assistant.analysisPlan.successEvaluationRubric`.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::Analysis]
+    def initialize(summary: OMIT, structured_data: OMIT, success_evaluation: OMIT, additional_properties: nil)
+      @summary = summary if summary != OMIT
+      @structured_data = structured_data if structured_data != OMIT
+      @success_evaluation = success_evaluation if success_evaluation != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "summary": summary,
+        "structuredData": structured_data,
+        "successEvaluation": success_evaluation
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of Analysis
+    #
+    # @param json_object [String]
+    # @return [Vapi::Analysis]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      summary = parsed_json["summary"]
+      structured_data = parsed_json["structuredData"]
+      success_evaluation = parsed_json["successEvaluation"]
+      new(
+        summary: summary,
+        structured_data: structured_data,
+        success_evaluation: success_evaluation,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of Analysis 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.summary&.is_a?(String) != false || raise("Passed value for field obj.summary is not the expected type, validation failed.")
+      obj.structured_data&.is_a?(Hash) != false || raise("Passed value for field obj.structured_data is not the expected type, validation failed.")
+      obj.success_evaluation&.is_a?(String) != false || raise("Passed value for field obj.success_evaluation is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/analysis_cost.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require_relative "analysis_cost_analysis_type"
+require "ostruct"
+require "json"
+
+module Vapi
+  class AnalysisCost
+    # @return [Vapi::AnalysisCostAnalysisType] This is the type of analysis performed.
+    attr_reader :analysis_type
+    # @return [Hash{String => Object}] This is the model that was used to perform the analysis.
+    attr_reader :model
+    # @return [Float] This is the number of prompt tokens used in the analysis.
+    attr_reader :prompt_tokens
+    # @return [Float] This is the number of completion tokens generated in the analysis.
+    attr_reader :completion_tokens
+    # @return [Float] This is the cost of the component in USD.
+    attr_reader :cost
+    # @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 analysis_type [Vapi::AnalysisCostAnalysisType] This is the type of analysis performed.
+    # @param model [Hash{String => Object}] This is the model that was used to perform the analysis.
+    # @param prompt_tokens [Float] This is the number of prompt tokens used in the analysis.
+    # @param completion_tokens [Float] This is the number of completion tokens generated in the analysis.
+    # @param cost [Float] This is the cost of the component in USD.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::AnalysisCost]
+    def initialize(analysis_type:, model:, prompt_tokens:, completion_tokens:, cost:, additional_properties: nil)
+      @analysis_type = analysis_type
+      @model = model
+      @prompt_tokens = prompt_tokens
+      @completion_tokens = completion_tokens
+      @cost = cost
+      @additional_properties = additional_properties
+      @_field_set = {
+        "analysisType": analysis_type,
+        "model": model,
+        "promptTokens": prompt_tokens,
+        "completionTokens": completion_tokens,
+        "cost": cost
+      }
+    end
+
+    # Deserialize a JSON object to an instance of AnalysisCost
+    #
+    # @param json_object [String]
+    # @return [Vapi::AnalysisCost]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      analysis_type = parsed_json["analysisType"]
+      model = parsed_json["model"]
+      prompt_tokens = parsed_json["promptTokens"]
+      completion_tokens = parsed_json["completionTokens"]
+      cost = parsed_json["cost"]
+      new(
+        analysis_type: analysis_type,
+        model: model,
+        prompt_tokens: prompt_tokens,
+        completion_tokens: completion_tokens,
+        cost: cost,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of AnalysisCost 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.analysis_type.is_a?(Vapi::AnalysisCostAnalysisType) != false || raise("Passed value for field obj.analysis_type is not the expected type, validation failed.")
+      obj.model.is_a?(Hash) != false || raise("Passed value for field obj.model is not the expected type, validation failed.")
+      obj.prompt_tokens.is_a?(Float) != false || raise("Passed value for field obj.prompt_tokens is not the expected type, validation failed.")
+      obj.completion_tokens.is_a?(Float) != false || raise("Passed value for field obj.completion_tokens is not the expected type, validation failed.")
+      obj.cost.is_a?(Float) != false || raise("Passed value for field obj.cost is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/analysis_cost_analysis_type.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the type of analysis performed.
+  class AnalysisCostAnalysisType
+    SUMMARY = "summary"
+    STRUCTURED_DATA = "structuredData"
+    SUCCESS_EVALUATION = "successEvaluation"
+  end
+end