vapi_server_sdk 0.2.0 → 0.4.0

data/lib/vapi_server_sdk/assistants/client.rb

@@ -13,6 +13,7 @@ require_relative "types/update_assistant_dto_client_messages_item"
 require_relative "types/update_assistant_dto_server_messages_item"
 require_relative "types/update_assistant_dto_background_sound"
 require_relative "../types/transport_configuration_twilio"
+require_relative "types/update_assistant_dto_credentials_item"
 require_relative "../types/twilio_voicemail_detection"
 require_relative "../types/analysis_plan"
 require_relative "../types/artifact_plan"
@@ -49,13 +50,6 @@ module Vapi
     #  specified value.
     # @param request_options [Vapi::RequestOptions]
     # @return [Array<Vapi::Assistant>]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.assistants.list
     def list(limit: nil, created_at_gt: nil, created_at_lt: nil, created_at_ge: nil, created_at_le: nil,
              updated_at_gt: nil, updated_at_lt: nil, updated_at_ge: nil, updated_at_le: nil, request_options: nil)
       response = @request_client.conn.get do |req|
@@ -105,6 +99,7 @@ module Vapi
     #   * :background_denoising_enabled (Boolean)
     #   * :model_output_in_messages_enabled (Boolean)
     #   * :transport_configurations (Array<Vapi::TransportConfigurationTwilio>)
+    #   * :credentials (Array<Vapi::CreateAssistantDtoCredentialsItem>)
     #   * :name (String)
     #   * :voicemail_detection (Hash)
     #     * :provider (String)
@@ -132,6 +127,7 @@ module Vapi
     #         * :properties (Hash{String => Object})
     #         * :description (String)
     #         * :required (Array<String>)
+    #         * :enum (Array<String>)
     #       * :timeout_seconds (Float)
     #     * :success_evaluation_plan (Hash)
     #       * :rubric (Vapi::SuccessEvaluationPlanRubric)
@@ -173,13 +169,6 @@ module Vapi
     #     * :headers (Hash{String => Object})
     # @param request_options [Vapi::RequestOptions]
     # @return [Vapi::Assistant]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.assistants.create(request: {  })
     def create(request:, request_options: nil)
       response = @request_client.conn.post do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -201,13 +190,6 @@ module Vapi
     # @param id [String]
     # @param request_options [Vapi::RequestOptions]
     # @return [Vapi::Assistant]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.assistants.get(id: "id")
     def get(id:, request_options: nil)
       response = @request_client.conn.get do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -231,13 +213,6 @@ module Vapi
     # @param id [String]
     # @param request_options [Vapi::RequestOptions]
     # @return [Vapi::Assistant]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.assistants.delete(id: "id")
     def delete(id:, request_options: nil)
       response = @request_client.conn.delete do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -307,6 +282,10 @@ module Vapi
     #   * :timeout (Float)
     #   * :record (Boolean)
     #   * :recording_channels (Vapi::TransportConfigurationTwilioRecordingChannels)
+    # @param credentials [Array<Hash>] 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.Request of type Array<Vapi::Assistants::UpdateAssistantDtoCredentialsItem>, as a Hash
     # @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 [Hash] These are the settings to configure or disable voicemail detection.
@@ -345,6 +324,7 @@ module Vapi
     #       * :properties (Hash{String => Object})
     #       * :description (String)
     #       * :required (Array<String>)
+    #       * :enum (Array<String>)
     #     * :timeout_seconds (Float)
     #   * :success_evaluation_plan (Hash)
     #     * :rubric (Vapi::SuccessEvaluationPlanRubric)
@@ -422,15 +402,8 @@ module Vapi
     #   * :headers (Hash{String => Object})
     # @param request_options [Vapi::RequestOptions]
     # @return [Vapi::Assistant]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.assistants.update(id: "id")
     def update(id:, transcriber: nil, model: nil, voice: nil, first_message: nil, first_message_mode: nil,
-               hipaa_enabled: nil, client_messages: nil, server_messages: nil, silence_timeout_seconds: nil, max_duration_seconds: nil, background_sound: nil, background_denoising_enabled: nil, model_output_in_messages_enabled: nil, transport_configurations: nil, name: nil, voicemail_detection: nil, voicemail_message: nil, end_call_message: nil, end_call_phrases: nil, metadata: nil, analysis_plan: nil, artifact_plan: nil, message_plan: nil, start_speaking_plan: nil, stop_speaking_plan: nil, monitor_plan: nil, credential_ids: nil, server: nil, request_options: nil)
+               hipaa_enabled: nil, client_messages: nil, server_messages: nil, silence_timeout_seconds: nil, max_duration_seconds: nil, background_sound: nil, background_denoising_enabled: nil, model_output_in_messages_enabled: nil, transport_configurations: nil, credentials: nil, name: nil, voicemail_detection: nil, voicemail_message: nil, end_call_message: nil, end_call_phrases: nil, metadata: nil, analysis_plan: nil, artifact_plan: nil, message_plan: nil, start_speaking_plan: nil, stop_speaking_plan: nil, monitor_plan: nil, credential_ids: nil, server: nil, request_options: nil)
       response = @request_client.conn.patch do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
@@ -458,6 +431,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,
@@ -504,13 +478,6 @@ module Vapi
     #  specified value.
     # @param request_options [Vapi::RequestOptions]
     # @return [Array<Vapi::Assistant>]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.assistants.list
     def list(limit: nil, created_at_gt: nil, created_at_lt: nil, created_at_ge: nil, created_at_le: nil,
              updated_at_gt: nil, updated_at_lt: nil, updated_at_ge: nil, updated_at_le: nil, request_options: nil)
       Async do
@@ -562,6 +529,7 @@ module Vapi
     #   * :background_denoising_enabled (Boolean)
     #   * :model_output_in_messages_enabled (Boolean)
     #   * :transport_configurations (Array<Vapi::TransportConfigurationTwilio>)
+    #   * :credentials (Array<Vapi::CreateAssistantDtoCredentialsItem>)
     #   * :name (String)
     #   * :voicemail_detection (Hash)
     #     * :provider (String)
@@ -589,6 +557,7 @@ module Vapi
     #         * :properties (Hash{String => Object})
     #         * :description (String)
     #         * :required (Array<String>)
+    #         * :enum (Array<String>)
     #       * :timeout_seconds (Float)
     #     * :success_evaluation_plan (Hash)
     #       * :rubric (Vapi::SuccessEvaluationPlanRubric)
@@ -630,13 +599,6 @@ module Vapi
     #     * :headers (Hash{String => Object})
     # @param request_options [Vapi::RequestOptions]
     # @return [Vapi::Assistant]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.assistants.create(request: {  })
     def create(request:, request_options: nil)
       Async do
         response = @request_client.conn.post do |req|
@@ -660,13 +622,6 @@ module Vapi
     # @param id [String]
     # @param request_options [Vapi::RequestOptions]
     # @return [Vapi::Assistant]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.assistants.get(id: "id")
     def get(id:, request_options: nil)
       Async do
         response = @request_client.conn.get do |req|
@@ -692,13 +647,6 @@ module Vapi
     # @param id [String]
     # @param request_options [Vapi::RequestOptions]
     # @return [Vapi::Assistant]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.assistants.delete(id: "id")
     def delete(id:, request_options: nil)
       Async do
         response = @request_client.conn.delete do |req|
@@ -770,6 +718,10 @@ module Vapi
     #   * :timeout (Float)
     #   * :record (Boolean)
     #   * :recording_channels (Vapi::TransportConfigurationTwilioRecordingChannels)
+    # @param credentials [Array<Hash>] 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.Request of type Array<Vapi::Assistants::UpdateAssistantDtoCredentialsItem>, as a Hash
     # @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 [Hash] These are the settings to configure or disable voicemail detection.
@@ -808,6 +760,7 @@ module Vapi
     #       * :properties (Hash{String => Object})
     #       * :description (String)
     #       * :required (Array<String>)
+    #       * :enum (Array<String>)
     #     * :timeout_seconds (Float)
     #   * :success_evaluation_plan (Hash)
     #     * :rubric (Vapi::SuccessEvaluationPlanRubric)
@@ -885,15 +838,8 @@ module Vapi
     #   * :headers (Hash{String => Object})
     # @param request_options [Vapi::RequestOptions]
     # @return [Vapi::Assistant]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.assistants.update(id: "id")
     def update(id:, transcriber: nil, model: nil, voice: nil, first_message: nil, first_message_mode: nil,
-               hipaa_enabled: nil, client_messages: nil, server_messages: nil, silence_timeout_seconds: nil, max_duration_seconds: nil, background_sound: nil, background_denoising_enabled: nil, model_output_in_messages_enabled: nil, transport_configurations: nil, name: nil, voicemail_detection: nil, voicemail_message: nil, end_call_message: nil, end_call_phrases: nil, metadata: nil, analysis_plan: nil, artifact_plan: nil, message_plan: nil, start_speaking_plan: nil, stop_speaking_plan: nil, monitor_plan: nil, credential_ids: nil, server: nil, request_options: nil)
+               hipaa_enabled: nil, client_messages: nil, server_messages: nil, silence_timeout_seconds: nil, max_duration_seconds: nil, background_sound: nil, background_denoising_enabled: nil, model_output_in_messages_enabled: nil, transport_configurations: nil, credentials: nil, name: nil, voicemail_detection: nil, voicemail_message: nil, end_call_message: nil, end_call_phrases: nil, metadata: nil, analysis_plan: nil, artifact_plan: nil, message_plan: nil, start_speaking_plan: nil, stop_speaking_plan: nil, monitor_plan: nil, credential_ids: nil, server: nil, request_options: nil)
       Async do
         response = @request_client.conn.patch do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -922,6 +868,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,