vapi_server_sdk 0.2.0 → 0.3.0

data/lib/vapi_server_sdk/types/cloudflare_credential.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require "date"
+require_relative "cloudflare_r_2_bucket_plan"
+require "ostruct"
+require "json"
+
+module Vapi
+  class CloudflareCredential
+    # @return [String] Credential provider. Only allowed value is cloudflare
+    attr_reader :provider
+    # @return [String] Cloudflare Account Id.
+    attr_reader :account_id
+    # @return [String] Cloudflare API Key / Token.
+    attr_reader :api_key
+    # @return [String] Cloudflare Account Email.
+    attr_reader :account_email
+    # @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 [Vapi::CloudflareR2BucketPlan] This is the bucket plan that can be provided to store call artifacts in R2
+    attr_reader :bucket_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 provider [String] Credential provider. Only allowed value is cloudflare
+    # @param account_id [String] Cloudflare Account Id.
+    # @param api_key [String] Cloudflare API Key / Token.
+    # @param account_email [String] Cloudflare Account Email.
+    # @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 bucket_plan [Vapi::CloudflareR2BucketPlan] This is the bucket plan that can be provided to store call artifacts in R2
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CloudflareCredential]
+    def initialize(provider:, id:, org_id:, created_at:, updated_at:, account_id: OMIT, api_key: OMIT,
+                   account_email: OMIT, name: OMIT, bucket_plan: OMIT, additional_properties: nil)
+      @provider = provider
+      @account_id = account_id if account_id != OMIT
+      @api_key = api_key if api_key != OMIT
+      @account_email = account_email if account_email != OMIT
+      @id = id
+      @org_id = org_id
+      @created_at = created_at
+      @updated_at = updated_at
+      @name = name if name != OMIT
+      @bucket_plan = bucket_plan if bucket_plan != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "provider": provider,
+        "accountId": account_id,
+        "apiKey": api_key,
+        "accountEmail": account_email,
+        "id": id,
+        "orgId": org_id,
+        "createdAt": created_at,
+        "updatedAt": updated_at,
+        "name": name,
+        "bucketPlan": bucket_plan
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of CloudflareCredential
+    #
+    # @param json_object [String]
+    # @return [Vapi::CloudflareCredential]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      provider = parsed_json["provider"]
+      account_id = parsed_json["accountId"]
+      api_key = parsed_json["apiKey"]
+      account_email = parsed_json["accountEmail"]
+      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"]
+      if parsed_json["bucketPlan"].nil?
+        bucket_plan = nil
+      else
+        bucket_plan = parsed_json["bucketPlan"].to_json
+        bucket_plan = Vapi::CloudflareR2BucketPlan.from_json(json_object: bucket_plan)
+      end
+      new(
+        provider: provider,
+        account_id: account_id,
+        api_key: api_key,
+        account_email: account_email,
+        id: id,
+        org_id: org_id,
+        created_at: created_at,
+        updated_at: updated_at,
+        name: name,
+        bucket_plan: bucket_plan,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CloudflareCredential 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.account_id&.is_a?(String) != false || raise("Passed value for field obj.account_id 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.account_email&.is_a?(String) != false || raise("Passed value for field obj.account_email 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.")
+      obj.bucket_plan.nil? || Vapi::CloudflareR2BucketPlan.validate_raw(obj: obj.bucket_plan)
+    end
+  end
+end

data/lib/vapi_server_sdk/types/cloudflare_r_2_bucket_plan.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class CloudflareR2BucketPlan
+    # @return [String] Cloudflare R2 Access key ID.
+    attr_reader :access_key_id
+    # @return [String] Cloudflare R2 access key secret. This is not returned in the API.
+    attr_reader :secret_access_key
+    # @return [String] Cloudflare R2 base url.
+    attr_reader :url
+    # @return [String] This is the name of the bucket.
+    attr_reader :name
+    # @return [String] This is the path where call artifacts will be stored.
+    #  Usage:
+    #  - To store call artifacts in a specific folder, set this to the full path. Eg.
+    #  "/folder-name1/folder-name2".
+    #  - To store call artifacts in the root of the bucket, leave this blank.
+    #  @default "/"
+    attr_reader :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 access_key_id [String] Cloudflare R2 Access key ID.
+    # @param secret_access_key [String] Cloudflare R2 access key secret. This is not returned in the API.
+    # @param url [String] Cloudflare R2 base url.
+    # @param name [String] This is the name of the bucket.
+    # @param path [String] This is the path where call artifacts will be stored.
+    #  Usage:
+    #  - To store call artifacts in a specific folder, set this to the full path. Eg.
+    #  "/folder-name1/folder-name2".
+    #  - To store call artifacts in the root of the bucket, leave this blank.
+    #  @default "/"
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CloudflareR2BucketPlan]
+    def initialize(name:, access_key_id: OMIT, secret_access_key: OMIT, url: OMIT, path: OMIT,
+                   additional_properties: nil)
+      @access_key_id = access_key_id if access_key_id != OMIT
+      @secret_access_key = secret_access_key if secret_access_key != OMIT
+      @url = url if url != OMIT
+      @name = name
+      @path = path if path != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "accessKeyId": access_key_id,
+        "secretAccessKey": secret_access_key,
+        "url": url,
+        "name": name,
+        "path": path
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of CloudflareR2BucketPlan
+    #
+    # @param json_object [String]
+    # @return [Vapi::CloudflareR2BucketPlan]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      access_key_id = parsed_json["accessKeyId"]
+      secret_access_key = parsed_json["secretAccessKey"]
+      url = parsed_json["url"]
+      name = parsed_json["name"]
+      path = parsed_json["path"]
+      new(
+        access_key_id: access_key_id,
+        secret_access_key: secret_access_key,
+        url: url,
+        name: name,
+        path: path,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CloudflareR2BucketPlan 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.access_key_id&.is_a?(String) != false || raise("Passed value for field obj.access_key_id is not the expected type, validation failed.")
+      obj.secret_access_key&.is_a?(String) != false || raise("Passed value for field obj.secret_access_key is not the expected type, validation failed.")
+      obj.url&.is_a?(String) != false || raise("Passed value for field obj.url 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.path&.is_a?(String) != false || raise("Passed value for field obj.path is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/create_anthropic_credential_dto.rb

@@ -5,8 +5,6 @@ require "json"
 
 module Vapi
   class CreateAnthropicCredentialDto
-    # @return [String]
-    attr_reader :provider
     # @return [String] This is not returned in the API.
     attr_reader :api_key
     # @return [String] This is the name of credential. This is just for your reference.
@@ -19,17 +17,15 @@ module Vapi
 
     OMIT = Object.new
 
-    # @param provider [String]
     # @param api_key [String] This is not returned in the API.
     # @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::CreateAnthropicCredentialDto]
-    def initialize(provider:, api_key:, name: OMIT, additional_properties: nil)
-      @provider = provider
+    def initialize(api_key:, name: OMIT, additional_properties: nil)
       @api_key = api_key
       @name = name if name != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "provider": provider, "apiKey": api_key, "name": name }.reject do |_k, v|
+      @_field_set = { "apiKey": api_key, "name": name }.reject do |_k, v|
         v == OMIT
       end
     end
@@ -41,11 +37,9 @@ module Vapi
     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"]
       name = parsed_json["name"]
       new(
-        provider: provider,
         api_key: api_key,
         name: name,
         additional_properties: struct
@@ -66,7 +60,6 @@ module Vapi
     # @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.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
     end

data/lib/vapi_server_sdk/types/create_anyscale_credential_dto.rb

@@ -5,8 +5,6 @@ require "json"
 
 module Vapi
   class CreateAnyscaleCredentialDto
-    # @return [String]
-    attr_reader :provider
     # @return [String] This is not returned in the API.
     attr_reader :api_key
     # @return [String] This is the name of credential. This is just for your reference.
@@ -19,17 +17,15 @@ module Vapi
 
     OMIT = Object.new
 
-    # @param provider [String]
     # @param api_key [String] This is not returned in the API.
     # @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::CreateAnyscaleCredentialDto]
-    def initialize(provider:, api_key:, name: OMIT, additional_properties: nil)
-      @provider = provider
+    def initialize(api_key:, name: OMIT, additional_properties: nil)
       @api_key = api_key
       @name = name if name != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "provider": provider, "apiKey": api_key, "name": name }.reject do |_k, v|
+      @_field_set = { "apiKey": api_key, "name": name }.reject do |_k, v|
         v == OMIT
       end
     end
@@ -41,11 +37,9 @@ module Vapi
     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"]
       name = parsed_json["name"]
       new(
-        provider: provider,
         api_key: api_key,
         name: name,
         additional_properties: struct
@@ -66,7 +60,6 @@ module Vapi
     # @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.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
     end

data/lib/vapi_server_sdk/types/create_assembly_ai_credential_dto.rb

@@ -5,8 +5,6 @@ require "json"
 
 module Vapi
   class CreateAssemblyAiCredentialDto
-    # @return [String]
-    attr_reader :provider
     # @return [String] This is not returned in the API.
     attr_reader :api_key
     # @return [String] This is the name of credential. This is just for your reference.
@@ -19,17 +17,15 @@ module Vapi
 
     OMIT = Object.new
 
-    # @param provider [String]
     # @param api_key [String] This is not returned in the API.
     # @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::CreateAssemblyAiCredentialDto]
-    def initialize(provider:, api_key:, name: OMIT, additional_properties: nil)
-      @provider = provider
+    def initialize(api_key:, name: OMIT, additional_properties: nil)
       @api_key = api_key
       @name = name if name != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "provider": provider, "apiKey": api_key, "name": name }.reject do |_k, v|
+      @_field_set = { "apiKey": api_key, "name": name }.reject do |_k, v|
         v == OMIT
       end
     end
@@ -41,11 +37,9 @@ module Vapi
     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"]
       name = parsed_json["name"]
       new(
-        provider: provider,
         api_key: api_key,
         name: name,
         additional_properties: struct
@@ -66,7 +60,6 @@ module Vapi
     # @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.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
     end

data/lib/vapi_server_sdk/types/create_assistant_dto.rb

@@ -8,6 +8,7 @@ require_relative "create_assistant_dto_client_messages_item"
 require_relative "create_assistant_dto_server_messages_item"
 require_relative "create_assistant_dto_background_sound"
 require_relative "transport_configuration_twilio"
+require_relative "create_assistant_dto_credentials_item"
 require_relative "twilio_voicemail_detection"
 require_relative "analysis_plan"
 require_relative "artifact_plan"
@@ -79,6 +80,11 @@ module Vapi
     #  different transport providers. For a call, only the configuration matching the
     #  call transport provider is used.
     attr_reader :transport_configurations
+    # @return [Array<Vapi::CreateAssistantDtoCredentialsItem>] These are dynamic credentials that will be used for the assistant calls. By
+    #  default, all the credentials are available for use in the call but you can
+    #  supplement an additional credentials using this. Dynamic credentials override
+    #  existing credentials.
+    attr_reader :credentials
     # @return [String] This is the name of the assistant.
     #  This is required when you want to transfer between assistants in a call.
     attr_reader :name
@@ -206,6 +212,10 @@ module Vapi
     #  assistant's calls, like Twilio. You can store multiple configurations for
     #  different transport providers. For a call, only the configuration matching the
     #  call transport provider is used.
+    # @param credentials [Array<Vapi::CreateAssistantDtoCredentialsItem>] These are dynamic credentials that will be used for the assistant calls. By
+    #  default, all the credentials are available for use in the call but you can
+    #  supplement an additional credentials using this. Dynamic credentials override
+    #  existing credentials.
     # @param name [String] This is the name of the assistant.
     #  This is required when you want to transfer between assistants in a call.
     # @param voicemail_detection [Vapi::TwilioVoicemailDetection] These are the settings to configure or disable voicemail detection.
@@ -270,7 +280,7 @@ module Vapi
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::CreateAssistantDto]
     def initialize(transcriber: OMIT, model: OMIT, voice: OMIT, first_message: OMIT, first_message_mode: OMIT,
-                   hipaa_enabled: OMIT, client_messages: OMIT, server_messages: OMIT, silence_timeout_seconds: OMIT, max_duration_seconds: OMIT, background_sound: OMIT, background_denoising_enabled: OMIT, model_output_in_messages_enabled: OMIT, transport_configurations: OMIT, name: OMIT, voicemail_detection: OMIT, voicemail_message: OMIT, end_call_message: OMIT, end_call_phrases: OMIT, metadata: OMIT, analysis_plan: OMIT, artifact_plan: OMIT, message_plan: OMIT, start_speaking_plan: OMIT, stop_speaking_plan: OMIT, monitor_plan: OMIT, credential_ids: OMIT, server: OMIT, additional_properties: nil)
+                   hipaa_enabled: OMIT, client_messages: OMIT, server_messages: OMIT, silence_timeout_seconds: OMIT, max_duration_seconds: OMIT, background_sound: OMIT, background_denoising_enabled: OMIT, model_output_in_messages_enabled: OMIT, transport_configurations: OMIT, credentials: OMIT, name: OMIT, voicemail_detection: OMIT, voicemail_message: OMIT, end_call_message: OMIT, end_call_phrases: OMIT, metadata: OMIT, analysis_plan: OMIT, artifact_plan: OMIT, message_plan: OMIT, start_speaking_plan: OMIT, stop_speaking_plan: OMIT, monitor_plan: OMIT, credential_ids: OMIT, server: OMIT, additional_properties: nil)
       @transcriber = transcriber if transcriber != OMIT
       @model = model if model != OMIT
       @voice = voice if voice != OMIT
@@ -285,6 +295,7 @@ module Vapi
       @background_denoising_enabled = background_denoising_enabled if background_denoising_enabled != OMIT
       @model_output_in_messages_enabled = model_output_in_messages_enabled if model_output_in_messages_enabled != OMIT
       @transport_configurations = transport_configurations if transport_configurations != OMIT
+      @credentials = credentials if credentials != OMIT
       @name = name if name != OMIT
       @voicemail_detection = voicemail_detection if voicemail_detection != OMIT
       @voicemail_message = voicemail_message if voicemail_message != OMIT
@@ -315,6 +326,7 @@ module Vapi
         "backgroundDenoisingEnabled": background_denoising_enabled,
         "modelOutputInMessagesEnabled": model_output_in_messages_enabled,
         "transportConfigurations": transport_configurations,
+        "credentials": credentials,
         "name": name,
         "voicemailDetection": voicemail_detection,
         "voicemailMessage": voicemail_message,
@@ -373,6 +385,10 @@ module Vapi
         item = item.to_json
         Vapi::TransportConfigurationTwilio.from_json(json_object: item)
       end
+      credentials = parsed_json["credentials"]&.map do |item|
+        item = item.to_json
+        Vapi::CreateAssistantDtoCredentialsItem.from_json(json_object: item)
+      end
       name = parsed_json["name"]
       if parsed_json["voicemailDetection"].nil?
         voicemail_detection = nil
@@ -442,6 +458,7 @@ module Vapi
         background_denoising_enabled: background_denoising_enabled,
         model_output_in_messages_enabled: model_output_in_messages_enabled,
         transport_configurations: transport_configurations,
+        credentials: credentials,
         name: name,
         voicemail_detection: voicemail_detection,
         voicemail_message: voicemail_message,
@@ -488,6 +505,7 @@ module Vapi
       obj.background_denoising_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.background_denoising_enabled is not the expected type, validation failed.")
       obj.model_output_in_messages_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.model_output_in_messages_enabled is not the expected type, validation failed.")
       obj.transport_configurations&.is_a?(Array) != false || raise("Passed value for field obj.transport_configurations is not the expected type, validation failed.")
+      obj.credentials&.is_a?(Array) != false || raise("Passed value for field obj.credentials 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.voicemail_detection.nil? || Vapi::TwilioVoicemailDetection.validate_raw(obj: obj.voicemail_detection)
       obj.voicemail_message&.is_a?(String) != false || raise("Passed value for field obj.voicemail_message is not the expected type, validation failed.")