vapi_server_sdk 0.9.1 → 1.0.0

data/lib/vapi_server_sdk/types/hangup_node.rb

@@ -1,81 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module Vapi
-  class HangupNode
-    # @return [String]
-    attr_reader :type
-    # @return [String]
-    attr_reader :name
-    # @return [Boolean] This is whether or not the node is the start of the workflow.
-    attr_reader :is_start
-    # @return [Hash{String => Object}] This is for metadata you want to store on the task.
-    attr_reader :metadata
-    # @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]
-    # @param name [String]
-    # @param is_start [Boolean] This is whether or not the node is the start of the workflow.
-    # @param metadata [Hash{String => Object}] This is for metadata you want to store on the task.
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [Vapi::HangupNode]
-    def initialize(type:, name:, is_start: OMIT, metadata: OMIT, additional_properties: nil)
-      @type = type
-      @name = name
-      @is_start = is_start if is_start != OMIT
-      @metadata = metadata if metadata != OMIT
-      @additional_properties = additional_properties
-      @_field_set = { "type": type, "name": name, "isStart": is_start, "metadata": metadata }.reject do |_k, v|
-        v == OMIT
-      end
-    end
-
-    # Deserialize a JSON object to an instance of HangupNode
-    #
-    # @param json_object [String]
-    # @return [Vapi::HangupNode]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      type = parsed_json["type"]
-      name = parsed_json["name"]
-      is_start = parsed_json["isStart"]
-      metadata = parsed_json["metadata"]
-      new(
-        type: type,
-        name: name,
-        is_start: is_start,
-        metadata: metadata,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of HangupNode 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.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
-      obj.is_start&.is_a?(Boolean) != false || raise("Passed value for field obj.is_start is not the expected type, validation failed.")
-      obj.metadata&.is_a?(Hash) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
-    end
-  end
-end

data/lib/vapi_server_sdk/types/hmac_authentication_plan.rb

@@ -1,151 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "hmac_authentication_plan_algorithm"
-require_relative "hmac_authentication_plan_signature_encoding"
-require "ostruct"
-require "json"
-
-module Vapi
-  class HmacAuthenticationPlan
-    # @return [String] This is the HMAC secret key used to sign requests.
-    attr_reader :secret_key
-    # @return [Vapi::HmacAuthenticationPlanAlgorithm] This is the HMAC algorithm to use for signing.
-    attr_reader :algorithm
-    # @return [String] This is the header name where the signature will be sent. Defaults to
-    #  'x-signature'.
-    attr_reader :signature_header
-    # @return [String] This is the header name where the timestamp will be sent. Defaults to
-    #  'x-timestamp'.
-    attr_reader :timestamp_header
-    # @return [String] This is the prefix for the signature. For example, 'sha256=' for GitHub-style
-    #  signatures.
-    attr_reader :signature_prefix
-    # @return [Boolean] Whether to include a timestamp in the signature payload. Defaults to true.
-    attr_reader :include_timestamp
-    # @return [String] Custom payload format. Use {body} for request body, {timestamp} for timestamp,
-    #  {method} for HTTP method, {url} for URL, {svix-id} for unique message ID.
-    #  Defaults to '{timestamp}.{body}'.
-    attr_reader :payload_format
-    # @return [String] This is the header name where the unique message ID will be sent. Used for
-    #  Svix-style webhooks.
-    attr_reader :message_id_header
-    # @return [Vapi::HmacAuthenticationPlanSignatureEncoding] The encoding format for the signature. Defaults to 'hex'.
-    attr_reader :signature_encoding
-    # @return [Boolean] Whether the secret key is base64-encoded and should be decoded before use.
-    #  Defaults to false.
-    attr_reader :secret_is_base_64
-    # @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 secret_key [String] This is the HMAC secret key used to sign requests.
-    # @param algorithm [Vapi::HmacAuthenticationPlanAlgorithm] This is the HMAC algorithm to use for signing.
-    # @param signature_header [String] This is the header name where the signature will be sent. Defaults to
-    #  'x-signature'.
-    # @param timestamp_header [String] This is the header name where the timestamp will be sent. Defaults to
-    #  'x-timestamp'.
-    # @param signature_prefix [String] This is the prefix for the signature. For example, 'sha256=' for GitHub-style
-    #  signatures.
-    # @param include_timestamp [Boolean] Whether to include a timestamp in the signature payload. Defaults to true.
-    # @param payload_format [String] Custom payload format. Use {body} for request body, {timestamp} for timestamp,
-    #  {method} for HTTP method, {url} for URL, {svix-id} for unique message ID.
-    #  Defaults to '{timestamp}.{body}'.
-    # @param message_id_header [String] This is the header name where the unique message ID will be sent. Used for
-    #  Svix-style webhooks.
-    # @param signature_encoding [Vapi::HmacAuthenticationPlanSignatureEncoding] The encoding format for the signature. Defaults to 'hex'.
-    # @param secret_is_base_64 [Boolean] Whether the secret key is base64-encoded and should be decoded before use.
-    #  Defaults to false.
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [Vapi::HmacAuthenticationPlan]
-    def initialize(secret_key:, algorithm:, signature_header: OMIT, timestamp_header: OMIT, signature_prefix: OMIT,
-                   include_timestamp: OMIT, payload_format: OMIT, message_id_header: OMIT, signature_encoding: OMIT, secret_is_base_64: OMIT, additional_properties: nil)
-      @secret_key = secret_key
-      @algorithm = algorithm
-      @signature_header = signature_header if signature_header != OMIT
-      @timestamp_header = timestamp_header if timestamp_header != OMIT
-      @signature_prefix = signature_prefix if signature_prefix != OMIT
-      @include_timestamp = include_timestamp if include_timestamp != OMIT
-      @payload_format = payload_format if payload_format != OMIT
-      @message_id_header = message_id_header if message_id_header != OMIT
-      @signature_encoding = signature_encoding if signature_encoding != OMIT
-      @secret_is_base_64 = secret_is_base_64 if secret_is_base_64 != OMIT
-      @additional_properties = additional_properties
-      @_field_set = {
-        "secretKey": secret_key,
-        "algorithm": algorithm,
-        "signatureHeader": signature_header,
-        "timestampHeader": timestamp_header,
-        "signaturePrefix": signature_prefix,
-        "includeTimestamp": include_timestamp,
-        "payloadFormat": payload_format,
-        "messageIdHeader": message_id_header,
-        "signatureEncoding": signature_encoding,
-        "secretIsBase64": secret_is_base_64
-      }.reject do |_k, v|
-        v == OMIT
-      end
-    end
-
-    # Deserialize a JSON object to an instance of HmacAuthenticationPlan
-    #
-    # @param json_object [String]
-    # @return [Vapi::HmacAuthenticationPlan]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      secret_key = parsed_json["secretKey"]
-      algorithm = parsed_json["algorithm"]
-      signature_header = parsed_json["signatureHeader"]
-      timestamp_header = parsed_json["timestampHeader"]
-      signature_prefix = parsed_json["signaturePrefix"]
-      include_timestamp = parsed_json["includeTimestamp"]
-      payload_format = parsed_json["payloadFormat"]
-      message_id_header = parsed_json["messageIdHeader"]
-      signature_encoding = parsed_json["signatureEncoding"]
-      secret_is_base_64 = parsed_json["secretIsBase64"]
-      new(
-        secret_key: secret_key,
-        algorithm: algorithm,
-        signature_header: signature_header,
-        timestamp_header: timestamp_header,
-        signature_prefix: signature_prefix,
-        include_timestamp: include_timestamp,
-        payload_format: payload_format,
-        message_id_header: message_id_header,
-        signature_encoding: signature_encoding,
-        secret_is_base_64: secret_is_base_64,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of HmacAuthenticationPlan 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.secret_key.is_a?(String) != false || raise("Passed value for field obj.secret_key is not the expected type, validation failed.")
-      obj.algorithm.is_a?(Vapi::HmacAuthenticationPlanAlgorithm) != false || raise("Passed value for field obj.algorithm is not the expected type, validation failed.")
-      obj.signature_header&.is_a?(String) != false || raise("Passed value for field obj.signature_header is not the expected type, validation failed.")
-      obj.timestamp_header&.is_a?(String) != false || raise("Passed value for field obj.timestamp_header is not the expected type, validation failed.")
-      obj.signature_prefix&.is_a?(String) != false || raise("Passed value for field obj.signature_prefix is not the expected type, validation failed.")
-      obj.include_timestamp&.is_a?(Boolean) != false || raise("Passed value for field obj.include_timestamp is not the expected type, validation failed.")
-      obj.payload_format&.is_a?(String) != false || raise("Passed value for field obj.payload_format is not the expected type, validation failed.")
-      obj.message_id_header&.is_a?(String) != false || raise("Passed value for field obj.message_id_header is not the expected type, validation failed.")
-      obj.signature_encoding&.is_a?(Vapi::HmacAuthenticationPlanSignatureEncoding) != false || raise("Passed value for field obj.signature_encoding is not the expected type, validation failed.")
-      obj.secret_is_base_64&.is_a?(Boolean) != false || raise("Passed value for field obj.secret_is_base_64 is not the expected type, validation failed.")
-    end
-  end
-end

data/lib/vapi_server_sdk/types/hmac_authentication_plan_algorithm.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module Vapi
-  # This is the HMAC algorithm to use for signing.
-  class HmacAuthenticationPlanAlgorithm
-    SHA_256 = "sha256"
-    SHA_512 = "sha512"
-    SHA_1 = "sha1"
-  end
-end

data/lib/vapi_server_sdk/types/hmac_authentication_plan_signature_encoding.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Vapi
-  # The encoding format for the signature. Defaults to 'hex'.
-  class HmacAuthenticationPlanSignatureEncoding
-    HEX = "hex"
-    BASE_64 = "base64"
-  end
-end

data/lib/vapi_server_sdk/types/hume_credential.rb

@@ -1,111 +0,0 @@
-# frozen_string_literal: true
-
-require "date"
-require "ostruct"
-require "json"
-
-module Vapi
-  class HumeCredential
-    # @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 [String] This is the name of credential. This is just for your reference.
-    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 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 name [String] This is the name of credential. This is just for your reference.
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [Vapi::HumeCredential]
-    def initialize(provider:, api_key:, id:, org_id:, created_at:, updated_at:, name: OMIT, additional_properties: nil)
-      @provider = provider
-      @api_key = api_key
-      @id = id
-      @org_id = org_id
-      @created_at = created_at
-      @updated_at = updated_at
-      @name = name if name != OMIT
-      @additional_properties = additional_properties
-      @_field_set = {
-        "provider": provider,
-        "apiKey": api_key,
-        "id": id,
-        "orgId": org_id,
-        "createdAt": created_at,
-        "updatedAt": updated_at,
-        "name": name
-      }.reject do |_k, v|
-        v == OMIT
-      end
-    end
-
-    # Deserialize a JSON object to an instance of HumeCredential
-    #
-    # @param json_object [String]
-    # @return [Vapi::HumeCredential]
-    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?)
-      name = parsed_json["name"]
-      new(
-        provider: provider,
-        api_key: api_key,
-        id: id,
-        org_id: org_id,
-        created_at: created_at,
-        updated_at: updated_at,
-        name: name,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of HumeCredential 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.")
-      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/hume_voice.rb

@@ -1,137 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "chunk_plan"
-require_relative "fallback_plan"
-require "ostruct"
-require "json"
-
-module Vapi
-  class HumeVoice
-    # @return [Boolean] This is the flag to toggle voice caching for the assistant.
-    attr_reader :caching_enabled
-    # @return [String] This is the model that will be used.
-    attr_reader :model
-    # @return [String] The ID of the particular voice you want to use.
-    attr_reader :voice_id
-    # @return [Boolean] Indicates whether the chosen voice is a preset Hume AI voice or a custom voice.
-    attr_reader :is_custom_hume_voice
-    # @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 [String] Natural language instructions describing how the synthesized speech should
-    #  sound, including but not limited to tone, intonation, pacing, and accent (e.g.,
-    #  'a soft, gentle voice with a strong British accent').
-    #  If a Voice is specified in the request, this description serves as acting
-    #  instructions.
-    #  If no Voice is specified, a new voice is generated based on this description.
-    attr_reader :description
-    # @return [Vapi::FallbackPlan] This is the plan for voice provider fallbacks in the event that the primary
-    #  voice provider fails.
-    attr_reader :fallback_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 caching_enabled [Boolean] This is the flag to toggle voice caching for the assistant.
-    # @param model [String] This is the model that will be used.
-    # @param voice_id [String] The ID of the particular voice you want to use.
-    # @param is_custom_hume_voice [Boolean] Indicates whether the chosen voice is a preset Hume AI voice or a custom voice.
-    # @param chunk_plan [Vapi::ChunkPlan] This is the plan for chunking the model output before it is sent to the voice
-    #  provider.
-    # @param description [String] Natural language instructions describing how the synthesized speech should
-    #  sound, including but not limited to tone, intonation, pacing, and accent (e.g.,
-    #  'a soft, gentle voice with a strong British accent').
-    #  If a Voice is specified in the request, this description serves as acting
-    #  instructions.
-    #  If no Voice is specified, a new voice is generated based on this description.
-    # @param fallback_plan [Vapi::FallbackPlan] This is the plan for voice provider fallbacks in the event that the primary
-    #  voice provider fails.
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [Vapi::HumeVoice]
-    def initialize(voice_id:, caching_enabled: OMIT, model: OMIT, is_custom_hume_voice: OMIT, chunk_plan: OMIT,
-                   description: OMIT, fallback_plan: OMIT, additional_properties: nil)
-      @caching_enabled = caching_enabled if caching_enabled != OMIT
-      @model = model if model != OMIT
-      @voice_id = voice_id
-      @is_custom_hume_voice = is_custom_hume_voice if is_custom_hume_voice != OMIT
-      @chunk_plan = chunk_plan if chunk_plan != OMIT
-      @description = description if description != OMIT
-      @fallback_plan = fallback_plan if fallback_plan != OMIT
-      @additional_properties = additional_properties
-      @_field_set = {
-        "cachingEnabled": caching_enabled,
-        "model": model,
-        "voiceId": voice_id,
-        "isCustomHumeVoice": is_custom_hume_voice,
-        "chunkPlan": chunk_plan,
-        "description": description,
-        "fallbackPlan": fallback_plan
-      }.reject do |_k, v|
-        v == OMIT
-      end
-    end
-
-    # Deserialize a JSON object to an instance of HumeVoice
-    #
-    # @param json_object [String]
-    # @return [Vapi::HumeVoice]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      caching_enabled = parsed_json["cachingEnabled"]
-      model = parsed_json["model"]
-      voice_id = parsed_json["voiceId"]
-      is_custom_hume_voice = parsed_json["isCustomHumeVoice"]
-      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
-      description = parsed_json["description"]
-      if parsed_json["fallbackPlan"].nil?
-        fallback_plan = nil
-      else
-        fallback_plan = parsed_json["fallbackPlan"].to_json
-        fallback_plan = Vapi::FallbackPlan.from_json(json_object: fallback_plan)
-      end
-      new(
-        caching_enabled: caching_enabled,
-        model: model,
-        voice_id: voice_id,
-        is_custom_hume_voice: is_custom_hume_voice,
-        chunk_plan: chunk_plan,
-        description: description,
-        fallback_plan: fallback_plan,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of HumeVoice 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.caching_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.caching_enabled is not the expected type, validation failed.")
-      obj.model&.is_a?(String) != false || raise("Passed value for field obj.model 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.is_custom_hume_voice&.is_a?(Boolean) != false || raise("Passed value for field obj.is_custom_hume_voice is not the expected type, validation failed.")
-      obj.chunk_plan.nil? || Vapi::ChunkPlan.validate_raw(obj: obj.chunk_plan)
-      obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
-      obj.fallback_plan.nil? || Vapi::FallbackPlan.validate_raw(obj: obj.fallback_plan)
-    end
-  end
-end