wavix-ruby-sdk 1.0.0

data/lib/wavix/sms_and_mms/sender_ids/client.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SmsAndMms
+    module SenderIDs
+      class Client
+        # @param client [Wavix::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Returns the Sender IDs registered for the authenticated account.
+        #
+        # @param request_options [Hash]
+        # @param _params [Hash]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        #
+        # @return [Wavix::Types::SenderIDListResponse]
+        def list(request_options: {}, **_params)
+          request = Wavix::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "v3/messages/sender-ids",
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Wavix::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            Wavix::Types::SenderIDListResponse.load(response.body)
+          else
+            error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Creates a Sender ID. Use the 10DLC API to create Sender IDs in the US.
+        #
+        # @param request_options [Hash]
+        # @param params [Wavix::SmsAndMms::SenderIDs::Types::SenderIDCreateRequest]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        #
+        # @return [Wavix::Types::SenderIDDetails]
+        def create(request_options: {}, **params)
+          params = Wavix::Internal::Types::Utils.normalize_keys(params)
+          request = Wavix::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "POST",
+            path: "v3/messages/sender-ids",
+            body: Wavix::SmsAndMms::SenderIDs::Types::SenderIDCreateRequest.new(params).to_h,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Wavix::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            Wavix::Types::SenderIDDetails.load(response.body)
+          else
+            error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Returns the Sender ID identified by `id`.
+        #
+        # @param request_options [Hash]
+        # @param params [Hash]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String] :id
+        #
+        # @return [Wavix::Types::SenderIDResponse]
+        def get(request_options: {}, **params)
+          params = Wavix::Internal::Types::Utils.normalize_keys(params)
+          request = Wavix::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "v3/messages/sender-ids/#{URI.encode_uri_component(params[:id].to_s)}",
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Wavix::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            Wavix::Types::SenderIDResponse.load(response.body)
+          else
+            error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Deletes the Sender ID identified by `id`. Deletion is permanent.
+        #
+        # @param request_options [Hash]
+        # @param params [Hash]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String] :id
+        #
+        # @return [Wavix::SmsAndMms::SenderIDs::Types::DeleteSenderIDsResponse]
+        def delete(request_options: {}, **params)
+          params = Wavix::Internal::Types::Utils.normalize_keys(params)
+          request = Wavix::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "DELETE",
+            path: "v3/messages/sender-ids/#{URI.encode_uri_component(params[:id].to_s)}",
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Wavix::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            Wavix::SmsAndMms::SenderIDs::Types::DeleteSenderIDsResponse.load(response.body)
+          else
+            error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wavix/sms_and_mms/sender_ids/types/delete_sender_ids_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SmsAndMms
+    module SenderIDs
+      module Types
+        class DeleteSenderIDsRequest < Internal::Types::Model
+          field :id, -> { String }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/wavix/sms_and_mms/sender_ids/types/delete_sender_ids_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SmsAndMms
+    module SenderIDs
+      module Types
+        class DeleteSenderIDsResponse < Internal::Types::Model
+          field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/wavix/sms_and_mms/sender_ids/types/get_sender_ids_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SmsAndMms
+    module SenderIDs
+      module Types
+        class GetSenderIDsRequest < Internal::Types::Model
+          field :id, -> { String }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/wavix/sms_and_mms/sender_ids/types/sender_id_create_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SmsAndMms
+    module SenderIDs
+      module Types
+        class SenderIDCreateRequest < Internal::Types::Model
+          field :sender_id, -> { String }, optional: false, nullable: false
+
+          field :type, -> { Wavix::Types::SenderIDType }, optional: false, nullable: false
+
+          field :countries, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+
+          field :usecase, -> { Wavix::SmsAndMms::SenderIDs::Types::SenderIDCreateRequestUsecase }, optional: false, nullable: false
+
+          field :monthly_volume, -> { Wavix::SmsAndMms::SenderIDs::Types::SenderIDCreateRequestMonthlyVolume }, optional: true, nullable: false
+
+          field :samples, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/wavix/sms_and_mms/sender_ids/types/sender_id_create_request_monthly_volume.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SmsAndMms
+    module SenderIDs
+      module Types
+        module SenderIDCreateRequestMonthlyVolume
+          extend Wavix::Internal::Types::Enum
+
+          ONE1000 = "1-1000"
+          ONE_THOUSAND_ONE20000 = "1001-20000"
+          UNDEFINED50000 = "20001-50000"
+          UNDEFINED100000 = "50001-100000"
+          MORE_THAN100000 = "More than 100000"
+        end
+      end
+    end
+  end
+end

data/lib/wavix/sms_and_mms/sender_ids/types/sender_id_create_request_usecase.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SmsAndMms
+    module SenderIDs
+      module Types
+        module SenderIDCreateRequestUsecase
+          extend Wavix::Internal::Types::Enum
+
+          TRANSACTIONAL = "transactional"
+          PROMO = "promo"
+          AUTHENTICATION = "authentication"
+        end
+      end
+    end
+  end
+end

data/lib/wavix/speech_analytics/client.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SpeechAnalytics
+    class Client
+      # @param client [Wavix::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Uploads an audio file for transcription. Transcription is asynchronous; Wavix sends a POST callback to
+      # `callback_url` when it completes, including the `request_id` returned by this request.
+      #
+      # Callback body:
+      # ```json
+      #    {
+      #         "request_id": "e865ea07-25af-4fdd-876e-04b0d41d5ebd",
+      #         "status": "completed",
+      #         "error": null
+      #    }
+      # ```
+      #
+      # - `request_id`: ID of the transcription request.
+      # - `status`: One of `completed` (transcription succeeded) or `failed` (transcription encountered an error).
+      # - `error`: Error description, or `null` when the transcription succeeded.
+      #
+      # @param request_options [Hash]
+      # @param params [void]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      #
+      # @return [Wavix::SpeechAnalytics::Types::CreateSpeechAnalyticsResponse]
+      def create(request_options: {}, **params)
+        params = Wavix::Internal::Types::Utils.normalize_keys(params)
+        body = Internal::Multipart::FormData.new
+
+        body.add_part(params[:file].to_form_data_part(name: "file")) if params[:file]
+        if params[:callback_url]
+          body.add(
+            name: "callback_url",
+            value: params[:callback_url]
+          )
+        end
+        if params[:insights]
+          body.add(
+            name: "insights",
+            value: params[:insights]
+          )
+        end
+
+        request = Wavix::Internal::Multipart::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "v1/speech-analytics",
+          body: body,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Wavix::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Wavix::SpeechAnalytics::Types::CreateSpeechAnalyticsResponse.load(response.body)
+        else
+          error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Returns the transcription for the request identified by `request_id`, including transcript, speaker turns, and
+      # insights when available.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :request_id
+      #
+      # @return [Wavix::SpeechAnalytics::Types::GetSpeechAnalyticsResponse]
+      def get(request_options: {}, **params)
+        params = Wavix::Internal::Types::Utils.normalize_keys(params)
+        request = Wavix::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v1/speech-analytics/#{URI.encode_uri_component(params[:request_id].to_s)}",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Wavix::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Wavix::SpeechAnalytics::Types::GetSpeechAnalyticsResponse.load(response.body)
+        else
+          error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Re-runs transcription on the file identified by `request_id`, replacing the existing transcript.
+      #
+      # @param request_options [Hash]
+      # @param params [Wavix::SpeechAnalytics::Types::SpeechAnalyticsRetranscribeRequest]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :request_id
+      #
+      # @return [Wavix::Types::SuccessResponse]
+      def retranscribe(request_options: {}, **params)
+        params = Wavix::Internal::Types::Utils.normalize_keys(params)
+        request_data = Wavix::SpeechAnalytics::Types::SpeechAnalyticsRetranscribeRequest.new(params).to_h
+        non_body_param_names = %w[request_id]
+        body = request_data.except(*non_body_param_names)
+
+        request = Wavix::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "PUT",
+          path: "v1/speech-analytics/#{URI.encode_uri_component(params[:request_id].to_s)}",
+          body: body,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Wavix::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Wavix::Types::SuccessResponse.load(response.body)
+        else
+          error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # @return [Wavix::File::Client]
+      def file
+        @file ||= Wavix::SpeechAnalytics::File::Client.new(client: @client)
+      end
+    end
+  end
+end

data/lib/wavix/speech_analytics/file/client.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SpeechAnalytics
+    module File
+      class Client
+        # @param client [Wavix::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Returns the original audio file submitted for the transcription identified by `request_id`.
+        #
+        # @param request_options [Hash]
+        # @param params [Hash]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String] :request_id
+        #
+        # @return [untyped]
+        def get(request_options: {}, **params)
+          params = Wavix::Internal::Types::Utils.normalize_keys(params)
+          request = Wavix::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "v1/speech-analytics/#{URI.encode_uri_component(params[:request_id].to_s)}/file",
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Wavix::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          return if code.between?(200, 299)
+
+          error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+    end
+  end
+end

data/lib/wavix/speech_analytics/file/types/get_file_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SpeechAnalytics
+    module File
+      module Types
+        class GetFileRequest < Internal::Types::Model
+          field :request_id, -> { String }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/wavix/speech_analytics/types/create_speech_analytics_request.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SpeechAnalytics
+    module Types
+      class CreateSpeechAnalyticsRequest < Internal::Types::Model; end
+    end
+  end
+end

data/lib/wavix/speech_analytics/types/create_speech_analytics_response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SpeechAnalytics
+    module Types
+      class CreateSpeechAnalyticsResponse < Internal::Types::Model
+        field :file, -> { String }, optional: false, nullable: false
+
+        field :request_id, -> { String }, optional: false, nullable: false
+
+        field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/speech_analytics/types/get_speech_analytics_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SpeechAnalytics
+    module Types
+      class GetSpeechAnalyticsRequest < Internal::Types::Model
+        field :request_id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/speech_analytics/types/get_speech_analytics_response.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SpeechAnalytics
+    module Types
+      class GetSpeechAnalyticsResponse < Internal::Types::Model
+        field :transcript, -> { Wavix::Types::FileTranscriptResponse }, optional: false, nullable: true
+
+        field :turns, -> { Internal::Types::Array[Wavix::Types::FileTranscriptTurn] }, optional: false, nullable: true
+
+        field :request_id, -> { String }, optional: false, nullable: false
+
+        field :language, -> { Wavix::SpeechAnalytics::Types::GetSpeechAnalyticsResponseLanguage }, optional: false, nullable: true
+
+        field :duration, -> { Integer }, optional: false, nullable: true
+
+        field :charge, -> { String }, optional: false, nullable: false
+
+        field :status, -> { Wavix::SpeechAnalytics::Types::GetSpeechAnalyticsResponseStatus }, optional: false, nullable: false
+
+        field :transcription_date, -> { String }, optional: false, nullable: false
+
+        field :transcription_score, -> { String }, optional: false, nullable: true
+
+        field :transcription_summary, -> { String }, optional: false, nullable: true
+
+        field :original_file, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/speech_analytics/types/get_speech_analytics_response_language.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SpeechAnalytics
+    module Types
+      module GetSpeechAnalyticsResponseLanguage
+        extend Wavix::Internal::Types::Enum
+
+        EN = "en"
+        DE = "de"
+        ES = "es"
+        FR = "fr"
+        IT = "it"
+      end
+    end
+  end
+end

data/lib/wavix/speech_analytics/types/get_speech_analytics_response_status.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SpeechAnalytics
+    module Types
+      module GetSpeechAnalyticsResponseStatus
+        extend Wavix::Internal::Types::Enum
+
+        COMPLETED = "completed"
+        FAILED = "failed"
+      end
+    end
+  end
+end

data/lib/wavix/speech_analytics/types/speech_analytics_retranscribe_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SpeechAnalytics
+    module Types
+      class SpeechAnalyticsRetranscribeRequest < Internal::Types::Model
+        field :request_id, -> { String }, optional: false, nullable: false
+
+        field :callback_url, -> { String }, optional: false, nullable: false
+
+        field :insights, -> { Internal::Types::Boolean }, optional: true, nullable: false
+      end
+    end
+  end
+end