vapi_server_sdk 0.0.0.pre.alpha7

data/lib/vapi_server_sdk/types/summary_plan.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class SummaryPlan
+    # @return [Array<Hash{String => Object}>] These are the messages used to generate the summary.
+    #  @default: ` [ { "role": "system", "content": "You are an expert note-taker. You
+    #  will be given a transcript of a call. Summarize the call in 2-3 sentences. DO
+    #  NOT return anything except the summary." }, { "role": "user", "content": "Here
+    #  is the transcript:\n\n{{transcript}}\n\n" } ]`
+    #  You can customize by providing any messages you want.
+    #  Here are the template variables available:
+    #  - {{transcript}}: The transcript of the call from `call.artifact.transcript`-
+    #  {{systemPrompt}}: The system prompt of the call from
+    #  `assistant.model.messages[type=system].content`
+    attr_reader :messages
+    # @return [Boolean] This determines whether a summary is generated and stored in
+    #  `call.analysis.summary`. Defaults to true.
+    #  Usage:
+    #  - If you want to disable the summary, set this to false.
+    #  @default true
+    attr_reader :enabled
+    # @return [Float] This is how long the request is tried before giving up. When request times out,
+    #  `call.analysis.summary` will be empty.
+    #  Usage:
+    #  - To guarantee the summary is generated, set this value high. Note, this will
+    #  delay the end of call report in cases where model is slow to respond.
+    #  @default 5 seconds
+    attr_reader :timeout_seconds
+    # @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<Hash{String => Object}>] These are the messages used to generate the summary.
+    #  @default: ` [ { "role": "system", "content": "You are an expert note-taker. You
+    #  will be given a transcript of a call. Summarize the call in 2-3 sentences. DO
+    #  NOT return anything except the summary." }, { "role": "user", "content": "Here
+    #  is the transcript:\n\n{{transcript}}\n\n" } ]`
+    #  You can customize by providing any messages you want.
+    #  Here are the template variables available:
+    #  - {{transcript}}: The transcript of the call from `call.artifact.transcript`-
+    #  {{systemPrompt}}: The system prompt of the call from
+    #  `assistant.model.messages[type=system].content`
+    # @param enabled [Boolean] This determines whether a summary is generated and stored in
+    #  `call.analysis.summary`. Defaults to true.
+    #  Usage:
+    #  - If you want to disable the summary, set this to false.
+    #  @default true
+    # @param timeout_seconds [Float] This is how long the request is tried before giving up. When request times out,
+    #  `call.analysis.summary` will be empty.
+    #  Usage:
+    #  - To guarantee the summary is generated, set this value high. Note, this will
+    #  delay the end of call report in cases where model is slow to respond.
+    #  @default 5 seconds
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::SummaryPlan]
+    def initialize(messages: OMIT, enabled: OMIT, timeout_seconds: OMIT, additional_properties: nil)
+      @messages = messages if messages != OMIT
+      @enabled = enabled if enabled != OMIT
+      @timeout_seconds = timeout_seconds if timeout_seconds != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "messages": messages, "enabled": enabled, "timeoutSeconds": timeout_seconds }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of SummaryPlan
+    #
+    # @param json_object [String]
+    # @return [Vapi::SummaryPlan]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      messages = parsed_json["messages"]
+      enabled = parsed_json["enabled"]
+      timeout_seconds = parsed_json["timeoutSeconds"]
+      new(
+        messages: messages,
+        enabled: enabled,
+        timeout_seconds: timeout_seconds,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of SummaryPlan 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.enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.enabled is not the expected type, validation failed.")
+      obj.timeout_seconds&.is_a?(Float) != false || raise("Passed value for field obj.timeout_seconds is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/sync_voice_library_dto.rb

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

data/lib/vapi_server_sdk/types/sync_voice_library_dto_providers_item.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Vapi
+  class SyncVoiceLibraryDtoProvidersItem
+    ELEVEN_LABS = "11labs"
+    AZURE = "azure"
+    CARTESIA = "cartesia"
+    CUSTOM_VOICE = "custom-voice"
+    DEEPGRAM = "deepgram"
+    LMNT = "lmnt"
+    NEETS = "neets"
+    OPENAI = "openai"
+    PLAYHT = "playht"
+    RIME_AI = "rime-ai"
+  end
+end

data/lib/vapi_server_sdk/types/system_message.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class SystemMessage
+    # @return [String] The role of the system in the conversation.
+    attr_reader :role
+    # @return [String] The message content from the system.
+    attr_reader :message
+    # @return [Float] The timestamp when the message was sent.
+    attr_reader :time
+    # @return [Float] The number of seconds from the start of the conversation.
+    attr_reader :seconds_from_start
+    # @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 role [String] The role of the system in the conversation.
+    # @param message [String] The message content from the system.
+    # @param time [Float] The timestamp when the message was sent.
+    # @param seconds_from_start [Float] The number of seconds from the start of the conversation.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::SystemMessage]
+    def initialize(role:, message:, time:, seconds_from_start:, additional_properties: nil)
+      @role = role
+      @message = message
+      @time = time
+      @seconds_from_start = seconds_from_start
+      @additional_properties = additional_properties
+      @_field_set = { "role": role, "message": message, "time": time, "secondsFromStart": seconds_from_start }
+    end
+
+    # Deserialize a JSON object to an instance of SystemMessage
+    #
+    # @param json_object [String]
+    # @return [Vapi::SystemMessage]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      role = parsed_json["role"]
+      message = parsed_json["message"]
+      time = parsed_json["time"]
+      seconds_from_start = parsed_json["secondsFromStart"]
+      new(
+        role: role,
+        message: message,
+        time: time,
+        seconds_from_start: seconds_from_start,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of SystemMessage 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.role.is_a?(String) != false || raise("Passed value for field obj.role is not the expected type, validation failed.")
+      obj.message.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
+      obj.time.is_a?(Float) != false || raise("Passed value for field obj.time is not the expected type, validation failed.")
+      obj.seconds_from_start.is_a?(Float) != false || raise("Passed value for field obj.seconds_from_start is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/talkscriber_transcriber.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative "talkscriber_transcriber_language"
+require "ostruct"
+require "json"
+
+module Vapi
+  class TalkscriberTranscriber
+    # @return [String] This is the model that will be used for the transcription.
+    attr_reader :model
+    # @return [Vapi::TalkscriberTranscriberLanguage] This is the language that will be set for the transcription. The list of
+    #  languages Whisper supports can be found here:
+    #  https://github.com/openai/whisper/blob/main/whisper/tokenizer.py
+    attr_reader :language
+    # @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 model [String] This is the model that will be used for the transcription.
+    # @param language [Vapi::TalkscriberTranscriberLanguage] This is the language that will be set for the transcription. The list of
+    #  languages Whisper supports can be found here:
+    #  https://github.com/openai/whisper/blob/main/whisper/tokenizer.py
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::TalkscriberTranscriber]
+    def initialize(model: OMIT, language: OMIT, additional_properties: nil)
+      @model = model if model != OMIT
+      @language = language if language != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "model": model, "language": language }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of TalkscriberTranscriber
+    #
+    # @param json_object [String]
+    # @return [Vapi::TalkscriberTranscriber]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      model = parsed_json["model"]
+      language = parsed_json["language"]
+      new(
+        model: model,
+        language: language,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of TalkscriberTranscriber 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.model&.is_a?(String) != false || raise("Passed value for field obj.model is not the expected type, validation failed.")
+      obj.language&.is_a?(Vapi::TalkscriberTranscriberLanguage) != false || raise("Passed value for field obj.language is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/talkscriber_transcriber_language.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the language that will be set for the transcription. The list of
+  #  languages Whisper supports can be found here:
+  #  https://github.com/openai/whisper/blob/main/whisper/tokenizer.py
+  class TalkscriberTranscriberLanguage
+    EN = "en"
+    ZH = "zh"
+    DE = "de"
+    ES = "es"
+    RU = "ru"
+    KO = "ko"
+    FR = "fr"
+    JA = "ja"
+    PT = "pt"
+    TR = "tr"
+    PL = "pl"
+    CA = "ca"
+    NL = "nl"
+    AR = "ar"
+    SV = "sv"
+    IT = "it"
+    ID = "id"
+    HI = "hi"
+    FI = "fi"
+    VI = "vi"
+    HE = "he"
+    UK = "uk"
+    EL = "el"
+    MS = "ms"
+    CS = "cs"
+    RO = "ro"
+    DA = "da"
+    HU = "hu"
+    TA = "ta"
+    NO = "no"
+    TH = "th"
+    UR = "ur"
+    HR = "hr"
+    BG = "bg"
+    LT = "lt"
+    LA = "la"
+    MI = "mi"
+    ML = "ml"
+    CY = "cy"
+    SK = "sk"
+    TE = "te"
+    FA = "fa"
+    LV = "lv"
+    BN = "bn"
+    SR = "sr"
+    AZ = "az"
+    SL = "sl"
+    KN = "kn"
+    ET = "et"
+    MK = "mk"
+    BR = "br"
+    EU = "eu"
+    IS = "is"
+    HY = "hy"
+    NE = "ne"
+    MN = "mn"
+    BS = "bs"
+    KK = "kk"
+    SQ = "sq"
+    SW = "sw"
+    GL = "gl"
+    MR = "mr"
+    PA = "pa"
+    SI = "si"
+    KM = "km"
+    SN = "sn"
+    YO = "yo"
+    SO = "so"
+    AF = "af"
+    OC = "oc"
+    KA = "ka"
+    BE = "be"
+    TG = "tg"
+    SD = "sd"
+    GU = "gu"
+    AM = "am"
+    YI = "yi"
+    LO = "lo"
+    UZ = "uz"
+    FO = "fo"
+    HT = "ht"
+    PS = "ps"
+    TK = "tk"
+    NN = "nn"
+    MT = "mt"
+    SA = "sa"
+    LB = "lb"
+    MY = "my"
+    BO = "bo"
+    TL = "tl"
+    MG = "mg"
+    AS = "as"
+    TT = "tt"
+    HAW = "haw"
+    LN = "ln"
+    HA = "ha"
+    BA = "ba"
+    JW = "jw"
+    SU = "su"
+    YUE = "yue"
+  end
+end

data/lib/vapi_server_sdk/types/template.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+require_relative "template_details"
+require_relative "template_provider_details"
+require_relative "tool_template_metadata"
+require_relative "template_visibility"
+require_relative "template_provider"
+require "date"
+require "ostruct"
+require "json"
+
+module Vapi
+  class Template
+    # @return [Vapi::TemplateDetails]
+    attr_reader :details
+    # @return [Vapi::TemplateProviderDetails]
+    attr_reader :provider_details
+    # @return [Vapi::ToolTemplateMetadata]
+    attr_reader :metadata
+    # @return [Vapi::TemplateVisibility]
+    attr_reader :visibility
+    # @return [String]
+    attr_reader :type
+    # @return [String] The name of the template. This is just for your own reference.
+    attr_reader :name
+    # @return [Vapi::TemplateProvider]
+    attr_reader :provider
+    # @return [String] The unique identifier for the template.
+    attr_reader :id
+    # @return [String] The unique identifier for the organization that this template belongs to.
+    attr_reader :org_id
+    # @return [DateTime] The ISO 8601 date-time string of when the template was created.
+    attr_reader :created_at
+    # @return [DateTime] The ISO 8601 date-time string of when the template 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 details [Vapi::TemplateDetails]
+    # @param provider_details [Vapi::TemplateProviderDetails]
+    # @param metadata [Vapi::ToolTemplateMetadata]
+    # @param visibility [Vapi::TemplateVisibility]
+    # @param type [String]
+    # @param name [String] The name of the template. This is just for your own reference.
+    # @param provider [Vapi::TemplateProvider]
+    # @param id [String] The unique identifier for the template.
+    # @param org_id [String] The unique identifier for the organization that this template belongs to.
+    # @param created_at [DateTime] The ISO 8601 date-time string of when the template was created.
+    # @param updated_at [DateTime] The ISO 8601 date-time string of when the template was last updated.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::Template]
+    def initialize(type:, id:, org_id:, created_at:, updated_at:, details: OMIT, provider_details: OMIT, metadata: OMIT, visibility: OMIT, name: OMIT,
+                   provider: OMIT, additional_properties: nil)
+      @details = details if details != OMIT
+      @provider_details = provider_details if provider_details != OMIT
+      @metadata = metadata if metadata != OMIT
+      @visibility = visibility if visibility != OMIT
+      @type = type
+      @name = name if name != OMIT
+      @provider = provider if provider != OMIT
+      @id = id
+      @org_id = org_id
+      @created_at = created_at
+      @updated_at = updated_at
+      @additional_properties = additional_properties
+      @_field_set = {
+        "details": details,
+        "providerDetails": provider_details,
+        "metadata": metadata,
+        "visibility": visibility,
+        "type": type,
+        "name": name,
+        "provider": provider,
+        "id": id,
+        "orgId": org_id,
+        "createdAt": created_at,
+        "updatedAt": updated_at
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of Template
+    #
+    # @param json_object [String]
+    # @return [Vapi::Template]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      if parsed_json["details"].nil?
+        details = nil
+      else
+        details = parsed_json["details"].to_json
+        details = Vapi::TemplateDetails.from_json(json_object: details)
+      end
+      if parsed_json["providerDetails"].nil?
+        provider_details = nil
+      else
+        provider_details = parsed_json["providerDetails"].to_json
+        provider_details = Vapi::TemplateProviderDetails.from_json(json_object: provider_details)
+      end
+      if parsed_json["metadata"].nil?
+        metadata = nil
+      else
+        metadata = parsed_json["metadata"].to_json
+        metadata = Vapi::ToolTemplateMetadata.from_json(json_object: metadata)
+      end
+      visibility = parsed_json["visibility"]
+      type = parsed_json["type"]
+      name = parsed_json["name"]
+      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?)
+      new(
+        details: details,
+        provider_details: provider_details,
+        metadata: metadata,
+        visibility: visibility,
+        type: type,
+        name: name,
+        provider: provider,
+        id: id,
+        org_id: org_id,
+        created_at: created_at,
+        updated_at: updated_at,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of Template 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.details.nil? || Vapi::TemplateDetails.validate_raw(obj: obj.details)
+      obj.provider_details.nil? || Vapi::TemplateProviderDetails.validate_raw(obj: obj.provider_details)
+      obj.metadata.nil? || Vapi::ToolTemplateMetadata.validate_raw(obj: obj.metadata)
+      obj.visibility&.is_a?(Vapi::TemplateVisibility) != false || raise("Passed value for field obj.visibility is not the expected type, validation failed.")
+      obj.type.is_a?(String) != false || raise("Passed value for field obj.type 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.")
+      obj.provider&.is_a?(Vapi::TemplateProvider) != 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.")
+    end
+  end
+end