vapi_server_sdk 0.0.0.pre.alpha7

data/lib/vapi_server_sdk/types/anyscale_model_tools_item.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "create_dtmf_tool_dto"
+require_relative "create_end_call_tool_dto"
+require_relative "create_voicemail_tool_dto"
+require_relative "create_function_tool_dto"
+require_relative "create_ghl_tool_dto"
+require_relative "create_make_tool_dto"
+require_relative "create_transfer_call_tool_dto"
+
+module Vapi
+  class AnyscaleModelToolsItem
+    # @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::AnyscaleModelToolsItem]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of AnyscaleModelToolsItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::AnyscaleModelToolsItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.type
+               when "dtmf"
+                 Vapi::CreateDtmfToolDto.from_json(json_object: json_object)
+               when "endCall"
+                 Vapi::CreateEndCallToolDto.from_json(json_object: json_object)
+               when "voicemail"
+                 Vapi::CreateVoicemailToolDto.from_json(json_object: json_object)
+               when "function"
+                 Vapi::CreateFunctionToolDto.from_json(json_object: json_object)
+               when "ghl"
+                 Vapi::CreateGhlToolDto.from_json(json_object: json_object)
+               when "make"
+                 Vapi::CreateMakeToolDto.from_json(json_object: json_object)
+               when "transferCall"
+                 Vapi::CreateTransferCallToolDto.from_json(json_object: json_object)
+               else
+                 Vapi::CreateDtmfToolDto.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 "voicemail"
+        { **@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
+      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::CreateDtmfToolDto.validate_raw(obj: obj)
+      when "endCall"
+        Vapi::CreateEndCallToolDto.validate_raw(obj: obj)
+      when "voicemail"
+        Vapi::CreateVoicemailToolDto.validate_raw(obj: obj)
+      when "function"
+        Vapi::CreateFunctionToolDto.validate_raw(obj: obj)
+      when "ghl"
+        Vapi::CreateGhlToolDto.validate_raw(obj: obj)
+      when "make"
+        Vapi::CreateMakeToolDto.validate_raw(obj: obj)
+      when "transferCall"
+        Vapi::CreateTransferCallToolDto.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::CreateDtmfToolDto]
+    # @return [Vapi::AnyscaleModelToolsItem]
+    def self.dtmf(member:)
+      new(member: member, discriminant: "dtmf")
+    end
+
+    # @param member [Vapi::CreateEndCallToolDto]
+    # @return [Vapi::AnyscaleModelToolsItem]
+    def self.end_call(member:)
+      new(member: member, discriminant: "endCall")
+    end
+
+    # @param member [Vapi::CreateVoicemailToolDto]
+    # @return [Vapi::AnyscaleModelToolsItem]
+    def self.voicemail(member:)
+      new(member: member, discriminant: "voicemail")
+    end
+
+    # @param member [Vapi::CreateFunctionToolDto]
+    # @return [Vapi::AnyscaleModelToolsItem]
+    def self.function(member:)
+      new(member: member, discriminant: "function")
+    end
+
+    # @param member [Vapi::CreateGhlToolDto]
+    # @return [Vapi::AnyscaleModelToolsItem]
+    def self.ghl(member:)
+      new(member: member, discriminant: "ghl")
+    end
+
+    # @param member [Vapi::CreateMakeToolDto]
+    # @return [Vapi::AnyscaleModelToolsItem]
+    def self.make(member:)
+      new(member: member, discriminant: "make")
+    end
+
+    # @param member [Vapi::CreateTransferCallToolDto]
+    # @return [Vapi::AnyscaleModelToolsItem]
+    def self.transfer_call(member:)
+      new(member: member, discriminant: "transferCall")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/artifact.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require_relative "artifact_messages_item"
+require_relative "open_ai_message"
+require "ostruct"
+require "json"
+
+module Vapi
+  class Artifact
+    # @return [Array<Vapi::ArtifactMessagesItem>] These are the messages that were spoken during the call.
+    attr_reader :messages
+    # @return [Array<Vapi::OpenAiMessage>] These are the messages that were spoken during the call, formatted for OpenAI.
+    attr_reader :messages_open_ai_formatted
+    # @return [String] This is the recording url for the call. To enable, set
+    #  `assistant.artifactPlan.recordingEnabled`.
+    attr_reader :recording_url
+    # @return [String] This is the stereo recording url for the call. To enable, set
+    #  `assistant.artifactPlan.recordingEnabled`.
+    attr_reader :stereo_recording_url
+    # @return [String] This is video recording url for the call. To enable, set
+    #  `assistant.artifactPlan.videoRecordingEnabled`.
+    attr_reader :video_recording_url
+    # @return [Float] This is video recording start delay in ms. To enable, set
+    #  `assistant.artifactPlan.videoRecordingEnabled`. This can be used to align the
+    #  playback of the recording with artifact.messages timestamps.
+    attr_reader :video_recording_start_delay_seconds
+    # @return [String] This is the transcript of the call. This is derived from `artifact.messages` but
+    #  provided for convenience.
+    attr_reader :transcript
+    # @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 messages [Array<Vapi::ArtifactMessagesItem>] These are the messages that were spoken during the call.
+    # @param messages_open_ai_formatted [Array<Vapi::OpenAiMessage>] These are the messages that were spoken during the call, formatted for OpenAI.
+    # @param recording_url [String] This is the recording url for the call. To enable, set
+    #  `assistant.artifactPlan.recordingEnabled`.
+    # @param stereo_recording_url [String] This is the stereo recording url for the call. To enable, set
+    #  `assistant.artifactPlan.recordingEnabled`.
+    # @param video_recording_url [String] This is video recording url for the call. To enable, set
+    #  `assistant.artifactPlan.videoRecordingEnabled`.
+    # @param video_recording_start_delay_seconds [Float] This is video recording start delay in ms. To enable, set
+    #  `assistant.artifactPlan.videoRecordingEnabled`. This can be used to align the
+    #  playback of the recording with artifact.messages timestamps.
+    # @param transcript [String] This is the transcript of the call. This is derived from `artifact.messages` but
+    #  provided for convenience.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::Artifact]
+    def initialize(messages: OMIT, messages_open_ai_formatted: OMIT, recording_url: OMIT, stereo_recording_url: OMIT,
+                   video_recording_url: OMIT, video_recording_start_delay_seconds: OMIT, transcript: OMIT, additional_properties: nil)
+      @messages = messages if messages != OMIT
+      @messages_open_ai_formatted = messages_open_ai_formatted if messages_open_ai_formatted != OMIT
+      @recording_url = recording_url if recording_url != OMIT
+      @stereo_recording_url = stereo_recording_url if stereo_recording_url != OMIT
+      @video_recording_url = video_recording_url if video_recording_url != OMIT
+      if video_recording_start_delay_seconds != OMIT
+        @video_recording_start_delay_seconds = video_recording_start_delay_seconds
+      end
+      @transcript = transcript if transcript != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "messages": messages,
+        "messagesOpenAIFormatted": messages_open_ai_formatted,
+        "recordingUrl": recording_url,
+        "stereoRecordingUrl": stereo_recording_url,
+        "videoRecordingUrl": video_recording_url,
+        "videoRecordingStartDelaySeconds": video_recording_start_delay_seconds,
+        "transcript": transcript
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of Artifact
+    #
+    # @param json_object [String]
+    # @return [Vapi::Artifact]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      messages = parsed_json["messages"]&.map do |item|
+        item = item.to_json
+        Vapi::ArtifactMessagesItem.from_json(json_object: item)
+      end
+      messages_open_ai_formatted = parsed_json["messagesOpenAIFormatted"]&.map do |item|
+        item = item.to_json
+        Vapi::OpenAiMessage.from_json(json_object: item)
+      end
+      recording_url = parsed_json["recordingUrl"]
+      stereo_recording_url = parsed_json["stereoRecordingUrl"]
+      video_recording_url = parsed_json["videoRecordingUrl"]
+      video_recording_start_delay_seconds = parsed_json["videoRecordingStartDelaySeconds"]
+      transcript = parsed_json["transcript"]
+      new(
+        messages: messages,
+        messages_open_ai_formatted: messages_open_ai_formatted,
+        recording_url: recording_url,
+        stereo_recording_url: stereo_recording_url,
+        video_recording_url: video_recording_url,
+        video_recording_start_delay_seconds: video_recording_start_delay_seconds,
+        transcript: transcript,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of Artifact 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.messages&.is_a?(Array) != false || raise("Passed value for field obj.messages is not the expected type, validation failed.")
+      obj.messages_open_ai_formatted&.is_a?(Array) != false || raise("Passed value for field obj.messages_open_ai_formatted is not the expected type, validation failed.")
+      obj.recording_url&.is_a?(String) != false || raise("Passed value for field obj.recording_url is not the expected type, validation failed.")
+      obj.stereo_recording_url&.is_a?(String) != false || raise("Passed value for field obj.stereo_recording_url is not the expected type, validation failed.")
+      obj.video_recording_url&.is_a?(String) != false || raise("Passed value for field obj.video_recording_url is not the expected type, validation failed.")
+      obj.video_recording_start_delay_seconds&.is_a?(Float) != false || raise("Passed value for field obj.video_recording_start_delay_seconds is not the expected type, validation failed.")
+      obj.transcript&.is_a?(String) != false || raise("Passed value for field obj.transcript is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/artifact_messages_item.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "user_message"
+require_relative "system_message"
+require_relative "bot_message"
+require_relative "tool_call_message"
+require_relative "tool_call_result_message"
+
+module Vapi
+  class ArtifactMessagesItem
+    # Deserialize a JSON object to an instance of ArtifactMessagesItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::ArtifactMessagesItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      begin
+        Vapi::UserMessage.validate_raw(obj: struct)
+        return Vapi::UserMessage.from_json(json_object: struct) unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vapi::SystemMessage.validate_raw(obj: struct)
+        return Vapi::SystemMessage.from_json(json_object: struct) unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vapi::BotMessage.validate_raw(obj: struct)
+        return Vapi::BotMessage.from_json(json_object: struct) unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vapi::ToolCallMessage.validate_raw(obj: struct)
+        return Vapi::ToolCallMessage.from_json(json_object: struct) unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vapi::ToolCallResultMessage.validate_raw(obj: struct)
+        return Vapi::ToolCallResultMessage.from_json(json_object: 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 Vapi::UserMessage.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vapi::SystemMessage.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vapi::BotMessage.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vapi::ToolCallMessage.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vapi::ToolCallResultMessage.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      raise("Passed value matched no type within the union, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/artifact_plan.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require_relative "transcript_plan"
+require "ostruct"
+require "json"
+
+module Vapi
+  class ArtifactPlan
+    # @return [Boolean] This determines whether assistant's calls are recorded. Defaults to true.
+    #  Usage:
+    #  - If you don't want to record the calls, set this to false.
+    #  - If you want to record the calls when `assistant.hipaaEnabled`, explicity set
+    #  this to true and make sure to provide S3 or GCP credentials on the Provider
+    #  Credentials page in the Dashboard.
+    #  You can find the recording at `call.artifact.recordingUrl` and
+    #  `call.artifact.stereoRecordingUrl` after the call is ended.
+    #  @default true
+    attr_reader :recording_enabled
+    # @return [Boolean] This determines whether the video is recorded during the call. Defaults to
+    #  false. Only relevant for `webCall` type.
+    #  You can find the video recording at `call.artifact.videoRecordingUrl` after the
+    #  call is ended.
+    #  @default false
+    attr_reader :video_recording_enabled
+    # @return [Vapi::TranscriptPlan] This is the plan for `call.artifact.transcript`. To disable, set
+    #  `transcriptPlan.enabled` to false.
+    attr_reader :transcript_plan
+    # @return [String] This is the path where the recording will be uploaded. This is only used if you
+    #  have provided S3 or GCP credentials on the Provider Credentials page in the
+    #  Dashboard.
+    #  If credential.s3PathPrefix or credential.bucketPlan.path is set, this will
+    #  append to it.
+    #  Usage:
+    #  - If you want to upload the recording to a specific path, set this to the path.
+    #  Example: `/my-assistant-recordings`.
+    #  - If you want to upload the recording to the root of the bucket, set this to
+    #  `/`.
+    #  @default '/'
+    attr_reader :recording_path
+    # @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 recording_enabled [Boolean] This determines whether assistant's calls are recorded. Defaults to true.
+    #  Usage:
+    #  - If you don't want to record the calls, set this to false.
+    #  - If you want to record the calls when `assistant.hipaaEnabled`, explicity set
+    #  this to true and make sure to provide S3 or GCP credentials on the Provider
+    #  Credentials page in the Dashboard.
+    #  You can find the recording at `call.artifact.recordingUrl` and
+    #  `call.artifact.stereoRecordingUrl` after the call is ended.
+    #  @default true
+    # @param video_recording_enabled [Boolean] This determines whether the video is recorded during the call. Defaults to
+    #  false. Only relevant for `webCall` type.
+    #  You can find the video recording at `call.artifact.videoRecordingUrl` after the
+    #  call is ended.
+    #  @default false
+    # @param transcript_plan [Vapi::TranscriptPlan] This is the plan for `call.artifact.transcript`. To disable, set
+    #  `transcriptPlan.enabled` to false.
+    # @param recording_path [String] This is the path where the recording will be uploaded. This is only used if you
+    #  have provided S3 or GCP credentials on the Provider Credentials page in the
+    #  Dashboard.
+    #  If credential.s3PathPrefix or credential.bucketPlan.path is set, this will
+    #  append to it.
+    #  Usage:
+    #  - If you want to upload the recording to a specific path, set this to the path.
+    #  Example: `/my-assistant-recordings`.
+    #  - If you want to upload the recording to the root of the bucket, set this to
+    #  `/`.
+    #  @default '/'
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ArtifactPlan]
+    def initialize(recording_enabled: OMIT, video_recording_enabled: OMIT, transcript_plan: OMIT, recording_path: OMIT,
+                   additional_properties: nil)
+      @recording_enabled = recording_enabled if recording_enabled != OMIT
+      @video_recording_enabled = video_recording_enabled if video_recording_enabled != OMIT
+      @transcript_plan = transcript_plan if transcript_plan != OMIT
+      @recording_path = recording_path if recording_path != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "recordingEnabled": recording_enabled,
+        "videoRecordingEnabled": video_recording_enabled,
+        "transcriptPlan": transcript_plan,
+        "recordingPath": recording_path
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of ArtifactPlan
+    #
+    # @param json_object [String]
+    # @return [Vapi::ArtifactPlan]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      recording_enabled = parsed_json["recordingEnabled"]
+      video_recording_enabled = parsed_json["videoRecordingEnabled"]
+      if parsed_json["transcriptPlan"].nil?
+        transcript_plan = nil
+      else
+        transcript_plan = parsed_json["transcriptPlan"].to_json
+        transcript_plan = Vapi::TranscriptPlan.from_json(json_object: transcript_plan)
+      end
+      recording_path = parsed_json["recordingPath"]
+      new(
+        recording_enabled: recording_enabled,
+        video_recording_enabled: video_recording_enabled,
+        transcript_plan: transcript_plan,
+        recording_path: recording_path,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of ArtifactPlan 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.recording_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.recording_enabled is not the expected type, validation failed.")
+      obj.video_recording_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.video_recording_enabled is not the expected type, validation failed.")
+      obj.transcript_plan.nil? || Vapi::TranscriptPlan.validate_raw(obj: obj.transcript_plan)
+      obj.recording_path&.is_a?(String) != false || raise("Passed value for field obj.recording_path is not the expected type, validation failed.")
+    end
+  end
+end