wavix-ruby-sdk 1.0.0

data/lib/wavix/call_control/client.rb

@@ -0,0 +1,275 @@
+# frozen_string_literal: true
+
+module Wavix
+  module CallControl
+    class Client
+      # @param client [Wavix::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Returns the calls currently in progress 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::CallListResponse]
+      def list(request_options: {}, **_params)
+        request = Wavix::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v1/calls",
+          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::CallListResponse.load(response.body)
+        else
+          error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Places an outbound call. Returns the call with its `uuid` for tracking and control.
+      #
+      # @param request_options [Hash]
+      # @param params [Wavix::CallControl::Types::CallRequest]
+      # @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::CallCreateResponse]
+      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: "v1/calls",
+          body: Wavix::CallControl::Types::CallRequest.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::CallCreateResponse.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 call identified by `id`, including its current event and timestamps.
+      #
+      # @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::CallResponse]
+      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/calls/#{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::CallResponse.load(response.body)
+        else
+          error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Ends the active call identified by `id` by hanging up.
+      #
+      # @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::SuccessResponse]
+      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: "v1/calls/#{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::SuccessResponse.load(response.body)
+        else
+          error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Updates the active call identified by `id`. Only the `tag` field can be changed.
+      #
+      # @param request_options [Hash]
+      # @param params [Wavix::CallControl::Types::UpdateCallRequest]
+      # @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::SuccessResponse]
+      def update(request_options: {}, **params)
+        params = Wavix::Internal::Types::Utils.normalize_keys(params)
+        request_data = Wavix::CallControl::Types::UpdateCallRequest.new(params).to_h
+        non_body_param_names = %w[id]
+        body = request_data.except(*non_body_param_names)
+
+        request = Wavix::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "PATCH",
+          path: "v1/calls/#{URI.encode_uri_component(params[: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
+
+      # Answers the inbound call identified by `id`. Optionally starts media streaming on answer.
+      #
+      # @param request_options [Hash]
+      # @param params [Wavix::CallControl::Types::CallAnswerRequest]
+      # @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::SuccessResponse]
+      def answer(request_options: {}, **params)
+        params = Wavix::Internal::Types::Utils.normalize_keys(params)
+        request_data = Wavix::CallControl::Types::CallAnswerRequest.new(params).to_h
+        non_body_param_names = %w[id]
+        body = request_data.except(*non_body_param_names)
+
+        request = Wavix::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "v1/calls/#{URI.encode_uri_component(params[:id].to_s)}/answer",
+          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
+
+      # Collects DTMF keypad input from the caller on the active call identified by `id`.
+      #
+      # @param request_options [Hash]
+      # @param params [Wavix::CallControl::Types::CallDtmfCollectRequest]
+      # @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::SuccessResponse]
+      def collect(request_options: {}, **params)
+        params = Wavix::Internal::Types::Utils.normalize_keys(params)
+        request_data = Wavix::CallControl::Types::CallDtmfCollectRequest.new(params).to_h
+        non_body_param_names = %w[id]
+        body = request_data.except(*non_body_param_names)
+
+        request = Wavix::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "v1/calls/#{URI.encode_uri_component(params[:id].to_s)}/collect",
+          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::Streams::Client]
+      def streams
+        @streams ||= Wavix::CallControl::Streams::Client.new(client: @client)
+      end
+
+      # @return [Wavix::Audio::Client]
+      def audio
+        @audio ||= Wavix::CallControl::Audio::Client.new(client: @client)
+      end
+    end
+  end
+end

data/lib/wavix/call_control/streams/client.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Wavix
+  module CallControl
+    module Streams
+      class Client
+        # @param client [Wavix::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Starts streaming the media of the call identified by `call_id` to the configured destination. Returns the
+        # `stream_id`.
+        #
+        # @param request_options [Hash]
+        # @param params [Wavix::CallControl::Streams::Types::CallStreamCreateRequest]
+        # @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] :call_id
+        #
+        # @return [Wavix::Types::CallStreamResponse]
+        def create(request_options: {}, **params)
+          params = Wavix::Internal::Types::Utils.normalize_keys(params)
+          request_data = Wavix::CallControl::Streams::Types::CallStreamCreateRequest.new(params).to_h
+          non_body_param_names = %w[call_id]
+          body = request_data.except(*non_body_param_names)
+
+          request = Wavix::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "POST",
+            path: "v1/calls/#{URI.encode_uri_component(params[:call_id].to_s)}/streams",
+            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::CallStreamResponse.load(response.body)
+          else
+            error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Stops the media stream identified by `id` on the call identified by `call_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] :call_id
+        # @option params [String] :id
+        #
+        # @return [Wavix::Types::SuccessResponse]
+        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: "v1/calls/#{URI.encode_uri_component(params[:call_id].to_s)}/streams/#{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::SuccessResponse.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/call_control/streams/types/call_stream_create_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Wavix
+  module CallControl
+    module Streams
+      module Types
+        class CallStreamCreateRequest < Internal::Types::Model
+          field :call_id, -> { String }, optional: false, nullable: false
+
+          field :stream_url, -> { String }, optional: false, nullable: false
+
+          field :stream_type, -> { Wavix::Types::CallStreamType }, optional: false, nullable: false
+
+          field :stream_channel, -> { Wavix::Types::CallStreamChannel }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/wavix/call_control/streams/types/delete_streams_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Wavix
+  module CallControl
+    module Streams
+      module Types
+        class DeleteStreamsRequest < Internal::Types::Model
+          field :call_id, -> { String }, optional: false, nullable: false
+
+          field :id, -> { String }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/wavix/call_control/types/call_answer_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Wavix
+  module CallControl
+    module Types
+      class CallAnswerRequest < Internal::Types::Model
+        field :id, -> { String }, optional: false, nullable: false
+
+        field :call_recording, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :call_transcription, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :stream_url, -> { String }, optional: true, nullable: false
+
+        field :stream_type, -> { Wavix::Types::CallStreamType }, optional: true, nullable: false
+
+        field :stream_channel, -> { Wavix::Types::CallStreamChannel }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/call_control/types/call_dtmf_collect_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Wavix
+  module CallControl
+    module Types
+      class CallDtmfCollectRequest < Internal::Types::Model
+        field :id, -> { String }, optional: false, nullable: false
+
+        field :max_digits, -> { Integer }, optional: true, nullable: false
+
+        field :timeout, -> { Integer }, optional: true, nullable: false
+
+        field :termination_character, -> { String }, optional: true, nullable: false
+
+        field :max_attempts, -> { Integer }, optional: true, nullable: false
+
+        field :prompt, -> { Wavix::CallControl::Types::CallDtmfCollectRequestPrompt }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/call_control/types/call_dtmf_collect_request_prompt.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Wavix
+  module CallControl
+    module Types
+      # Prompt to play before collecting digits.
+      #  Play a prerecorded audio file or use Wavix Text-To-Speech.
+      class CallDtmfCollectRequestPrompt < Internal::Types::Model
+        field :play, -> { String }, optional: true, nullable: false
+
+        field :say, -> { Wavix::CallControl::Types::CallDtmfCollectRequestPromptSay }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/call_control/types/call_dtmf_collect_request_prompt_say.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Wavix
+  module CallControl
+    module Types
+      # Text to speak and voice to use.
+      class CallDtmfCollectRequestPromptSay < Internal::Types::Model
+        field :text, -> { String }, optional: false, nullable: false
+
+        field :language, -> { Wavix::Types::TtsLanguage }, optional: true, nullable: false
+
+        field :voice, -> { Wavix::Types::TtsVoiceID }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/call_control/types/call_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Wavix
+  module CallControl
+    module Types
+      class CallRequest < Internal::Types::Model
+        field :from, -> { String }, optional: false, nullable: false
+
+        field :to, -> { String }, optional: false, nullable: false
+
+        field :callback_url, -> { String }, optional: false, nullable: false
+
+        field :recording, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :voicemail_detection, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :tag, -> { String }, optional: true, nullable: false
+
+        field :timeout, -> { Integer }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/call_control/types/delete_call_control_request.rb

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

data/lib/wavix/call_control/types/get_call_control_request.rb

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

data/lib/wavix/call_control/types/update_call_request.rb

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