vapi_server_sdk 0.0.0.pre.alpha7

data/lib/vapi_server_sdk/types/create_perplexity_ai_credential_dto.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class CreatePerplexityAiCredentialDto
+    # @return [String]
+    attr_reader :provider
+    # @return [String] This is not returned in the API.
+    attr_reader :api_key
+    # @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 additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CreatePerplexityAiCredentialDto]
+    def initialize(provider:, api_key:, additional_properties: nil)
+      @provider = provider
+      @api_key = api_key
+      @additional_properties = additional_properties
+      @_field_set = { "provider": provider, "apiKey": api_key }
+    end
+
+    # Deserialize a JSON object to an instance of CreatePerplexityAiCredentialDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreatePerplexityAiCredentialDto]
+    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"]
+      new(
+        provider: provider,
+        api_key: api_key,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreatePerplexityAiCredentialDto 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.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/create_play_ht_credential_dto.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class CreatePlayHtCredentialDto
+    # @return [String]
+    attr_reader :provider
+    # @return [String] This is not returned in the API.
+    attr_reader :api_key
+    # @return [String]
+    attr_reader :user_id
+    # @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 user_id [String]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CreatePlayHtCredentialDto]
+    def initialize(provider:, api_key:, user_id:, additional_properties: nil)
+      @provider = provider
+      @api_key = api_key
+      @user_id = user_id
+      @additional_properties = additional_properties
+      @_field_set = { "provider": provider, "apiKey": api_key, "userId": user_id }
+    end
+
+    # Deserialize a JSON object to an instance of CreatePlayHtCredentialDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreatePlayHtCredentialDto]
+    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"]
+      user_id = parsed_json["userId"]
+      new(
+        provider: provider,
+        api_key: api_key,
+        user_id: user_id,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreatePlayHtCredentialDto 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.user_id.is_a?(String) != false || raise("Passed value for field obj.user_id is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/create_rime_ai_credential_dto.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class CreateRimeAiCredentialDto
+    # @return [String]
+    attr_reader :provider
+    # @return [String] This is not returned in the API.
+    attr_reader :api_key
+    # @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 additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CreateRimeAiCredentialDto]
+    def initialize(provider:, api_key:, additional_properties: nil)
+      @provider = provider
+      @api_key = api_key
+      @additional_properties = additional_properties
+      @_field_set = { "provider": provider, "apiKey": api_key }
+    end
+
+    # Deserialize a JSON object to an instance of CreateRimeAiCredentialDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateRimeAiCredentialDto]
+    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"]
+      new(
+        provider: provider,
+        api_key: api_key,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreateRimeAiCredentialDto 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.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/create_runpod_credential_dto.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class CreateRunpodCredentialDto
+    # @return [String]
+    attr_reader :provider
+    # @return [String] This is not returned in the API.
+    attr_reader :api_key
+    # @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 additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CreateRunpodCredentialDto]
+    def initialize(provider:, api_key:, additional_properties: nil)
+      @provider = provider
+      @api_key = api_key
+      @additional_properties = additional_properties
+      @_field_set = { "provider": provider, "apiKey": api_key }
+    end
+
+    # Deserialize a JSON object to an instance of CreateRunpodCredentialDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateRunpodCredentialDto]
+    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"]
+      new(
+        provider: provider,
+        api_key: api_key,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreateRunpodCredentialDto 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.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/create_s_3_credential_dto.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class CreateS3CredentialDto
+    # @return [String] Credential provider. Only allowed value is s3
+    attr_reader :provider
+    # @return [String] AWS access key ID.
+    attr_reader :aws_access_key_id
+    # @return [String] AWS access key secret. This is not returned in the API.
+    attr_reader :aws_secret_access_key
+    # @return [String] AWS region in which the S3 bucket is located.
+    attr_reader :region
+    # @return [String] AWS S3 bucket name.
+    attr_reader :s_3_bucket_name
+    # @return [String] The path prefix for the uploaded recording. Ex. "recordings/"
+    attr_reader :s_3_path_prefix
+    # @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] Credential provider. Only allowed value is s3
+    # @param aws_access_key_id [String] AWS access key ID.
+    # @param aws_secret_access_key [String] AWS access key secret. This is not returned in the API.
+    # @param region [String] AWS region in which the S3 bucket is located.
+    # @param s_3_bucket_name [String] AWS S3 bucket name.
+    # @param s_3_path_prefix [String] The path prefix for the uploaded recording. Ex. "recordings/"
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CreateS3CredentialDto]
+    def initialize(provider:, aws_access_key_id:, aws_secret_access_key:, region:, s_3_bucket_name:, s_3_path_prefix:,
+                   additional_properties: nil)
+      @provider = provider
+      @aws_access_key_id = aws_access_key_id
+      @aws_secret_access_key = aws_secret_access_key
+      @region = region
+      @s_3_bucket_name = s_3_bucket_name
+      @s_3_path_prefix = s_3_path_prefix
+      @additional_properties = additional_properties
+      @_field_set = {
+        "provider": provider,
+        "awsAccessKeyId": aws_access_key_id,
+        "awsSecretAccessKey": aws_secret_access_key,
+        "region": region,
+        "s3BucketName": s_3_bucket_name,
+        "s3PathPrefix": s_3_path_prefix
+      }
+    end
+
+    # Deserialize a JSON object to an instance of CreateS3CredentialDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateS3CredentialDto]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      provider = parsed_json["provider"]
+      aws_access_key_id = parsed_json["awsAccessKeyId"]
+      aws_secret_access_key = parsed_json["awsSecretAccessKey"]
+      region = parsed_json["region"]
+      s_3_bucket_name = parsed_json["s3BucketName"]
+      s_3_path_prefix = parsed_json["s3PathPrefix"]
+      new(
+        provider: provider,
+        aws_access_key_id: aws_access_key_id,
+        aws_secret_access_key: aws_secret_access_key,
+        region: region,
+        s_3_bucket_name: s_3_bucket_name,
+        s_3_path_prefix: s_3_path_prefix,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreateS3CredentialDto 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.aws_access_key_id.is_a?(String) != false || raise("Passed value for field obj.aws_access_key_id is not the expected type, validation failed.")
+      obj.aws_secret_access_key.is_a?(String) != false || raise("Passed value for field obj.aws_secret_access_key is not the expected type, validation failed.")
+      obj.region.is_a?(String) != false || raise("Passed value for field obj.region is not the expected type, validation failed.")
+      obj.s_3_bucket_name.is_a?(String) != false || raise("Passed value for field obj.s_3_bucket_name is not the expected type, validation failed.")
+      obj.s_3_path_prefix.is_a?(String) != false || raise("Passed value for field obj.s_3_path_prefix is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/create_squad_dto.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require_relative "squad_member_dto"
+require_relative "assistant_overrides"
+require "ostruct"
+require "json"
+
+module Vapi
+  class CreateSquadDto
+    # @return [String] This is the name of the squad.
+    attr_reader :name
+    # @return [Array<Vapi::SquadMemberDto>] This is the list of assistants that make up the squad.
+    #  The call will start with the first assistant in the list.
+    attr_reader :members
+    # @return [Vapi::AssistantOverrides] This can be used to override all the assistants' settings and provide values for
+    #  their template variables.
+    #  Both `membersOverrides` and `members[n].assistantOverrides` can be used
+    #  together. First, `members[n].assistantOverrides` is applied. Then,
+    #  `membersOverrides` is applied as a global override.
+    attr_reader :members_overrides
+    # @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 name [String] This is the name of the squad.
+    # @param members [Array<Vapi::SquadMemberDto>] This is the list of assistants that make up the squad.
+    #  The call will start with the first assistant in the list.
+    # @param members_overrides [Vapi::AssistantOverrides] This can be used to override all the assistants' settings and provide values for
+    #  their template variables.
+    #  Both `membersOverrides` and `members[n].assistantOverrides` can be used
+    #  together. First, `members[n].assistantOverrides` is applied. Then,
+    #  `membersOverrides` is applied as a global override.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CreateSquadDto]
+    def initialize(members:, name: OMIT, members_overrides: OMIT, additional_properties: nil)
+      @name = name if name != OMIT
+      @members = members
+      @members_overrides = members_overrides if members_overrides != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "name": name, "members": members, "membersOverrides": members_overrides }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of CreateSquadDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateSquadDto]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      name = parsed_json["name"]
+      members = parsed_json["members"]&.map do |item|
+        item = item.to_json
+        Vapi::SquadMemberDto.from_json(json_object: item)
+      end
+      if parsed_json["membersOverrides"].nil?
+        members_overrides = nil
+      else
+        members_overrides = parsed_json["membersOverrides"].to_json
+        members_overrides = Vapi::AssistantOverrides.from_json(json_object: members_overrides)
+      end
+      new(
+        name: name,
+        members: members,
+        members_overrides: members_overrides,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreateSquadDto 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.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.members.is_a?(Array) != false || raise("Passed value for field obj.members is not the expected type, validation failed.")
+      obj.members_overrides.nil? || Vapi::AssistantOverrides.validate_raw(obj: obj.members_overrides)
+    end
+  end
+end

data/lib/vapi_server_sdk/types/create_together_ai_credential_dto.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class CreateTogetherAiCredentialDto
+    # @return [String]
+    attr_reader :provider
+    # @return [String] This is not returned in the API.
+    attr_reader :api_key
+    # @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 additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CreateTogetherAiCredentialDto]
+    def initialize(provider:, api_key:, additional_properties: nil)
+      @provider = provider
+      @api_key = api_key
+      @additional_properties = additional_properties
+      @_field_set = { "provider": provider, "apiKey": api_key }
+    end
+
+    # Deserialize a JSON object to an instance of CreateTogetherAiCredentialDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateTogetherAiCredentialDto]
+    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"]
+      new(
+        provider: provider,
+        api_key: api_key,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreateTogetherAiCredentialDto 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.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/create_token_dto.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require_relative "create_token_dto_tag"
+require_relative "token_restrictions"
+require "ostruct"
+require "json"
+
+module Vapi
+  class CreateTokenDto
+    # @return [Vapi::CreateTokenDtoTag] This is the tag for the token. It represents its scope.
+    attr_reader :tag
+    # @return [String] This is the name of the token. This is just for your own reference.
+    attr_reader :name
+    # @return [Vapi::TokenRestrictions] This are the restrictions for the token.
+    attr_reader :restrictions
+    # @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 tag [Vapi::CreateTokenDtoTag] This is the tag for the token. It represents its scope.
+    # @param name [String] This is the name of the token. This is just for your own reference.
+    # @param restrictions [Vapi::TokenRestrictions] This are the restrictions for the token.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CreateTokenDto]
+    def initialize(tag: OMIT, name: OMIT, restrictions: OMIT, additional_properties: nil)
+      @tag = tag if tag != OMIT
+      @name = name if name != OMIT
+      @restrictions = restrictions if restrictions != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "tag": tag, "name": name, "restrictions": restrictions }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of CreateTokenDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateTokenDto]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      tag = parsed_json["tag"]
+      name = parsed_json["name"]
+      if parsed_json["restrictions"].nil?
+        restrictions = nil
+      else
+        restrictions = parsed_json["restrictions"].to_json
+        restrictions = Vapi::TokenRestrictions.from_json(json_object: restrictions)
+      end
+      new(
+        tag: tag,
+        name: name,
+        restrictions: restrictions,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreateTokenDto 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.tag&.is_a?(Vapi::CreateTokenDtoTag) != false || raise("Passed value for field obj.tag 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.restrictions.nil? || Vapi::TokenRestrictions.validate_raw(obj: obj.restrictions)
+    end
+  end
+end

data/lib/vapi_server_sdk/types/create_token_dto_tag.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the tag for the token. It represents its scope.
+  class CreateTokenDtoTag
+    PRIVATE = "private"
+    PUBLIC = "public"
+  end
+end