wavix-ruby-sdk 1.0.0

data/lib/wavix/call_recording/client.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+module Wavix
+  module CallRecording
+    class Client
+      # @param client [Wavix::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Returns a paginated list of call recordings for the authenticated account, filtered by date range, number, call,
+      # or SIP trunk.
+      #
+      # @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, nil] :from_date
+      # @option params [String, nil] :to_date
+      # @option params [String, nil] :from
+      # @option params [String, nil] :to
+      # @option params [String, nil] :call_uuid
+      # @option params [String, nil] :sip_trunks
+      # @option params [Integer, nil] :page
+      # @option params [Integer, nil] :per_page
+      #
+      # @return [Wavix::Types::CallRecordingListResponse]
+      def list(request_options: {}, **params)
+        params = Wavix::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["from_date"] = params[:from_date] if params.key?(:from_date)
+        query_params["to_date"] = params[:to_date] if params.key?(:to_date)
+        query_params["from"] = params[:from] if params.key?(:from)
+        query_params["to"] = params[:to] if params.key?(:to)
+        query_params["call_uuid"] = params[:call_uuid] if params.key?(:call_uuid)
+        query_params["sip_trunks"] = params[:sip_trunks] if params.key?(:sip_trunks)
+        query_params["page"] = params[:page] if params.key?(:page)
+        query_params["per_page"] = params[:per_page] if params.key?(:per_page)
+
+        request = Wavix::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v1/recordings",
+          query: query_params,
+          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::CallRecordingListResponse.load(response.body)
+        else
+          error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Redirects to the recording file for the call identified by `call_id`. The download URL is returned in the
+      # `Location` header.
+      #
+      # @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
+      #
+      # @return [untyped]
+      def get_by_call(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/recordings/#{URI.encode_uri_component(params[:call_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
+        return if code.between?(200, 299)
+
+        error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+        raise error_class.new(response.body, code: code)
+      end
+
+      # Returns the call recording identified by `id`, including its metadata and download URL.
+      #
+      # @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 [Integer] :id
+      #
+      # @return [Wavix::Types::Recording]
+      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/recordings/#{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::Recording.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 call recording identified by `id`. Deletion is permanent and removes the recording file.
+      #
+      # @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 [Integer] :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/recordings/#{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

data/lib/wavix/call_recording/types/delete_call_recording_request.rb

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

data/lib/wavix/call_recording/types/get_by_call_call_recording_request.rb

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

data/lib/wavix/call_recording/types/get_call_recording_request.rb

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

data/lib/wavix/call_recording/types/list_call_recording_request.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Wavix
+  module CallRecording
+    module Types
+      class ListCallRecordingRequest < Internal::Types::Model
+        field :from_date, -> { String }, optional: true, nullable: false
+
+        field :to_date, -> { String }, optional: true, nullable: false
+
+        field :from, -> { String }, optional: true, nullable: false
+
+        field :to, -> { String }, optional: true, nullable: false
+
+        field :call_uuid, -> { String }, optional: true, nullable: false
+
+        field :sip_trunks, -> { String }, optional: true, nullable: false
+
+        field :page, -> { Integer }, optional: true, nullable: false
+
+        field :per_page, -> { Integer }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/call_webhooks/client.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module Wavix
+  module CallWebhooks
+    class Client
+      # @param client [Wavix::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Returns the configured call webhooks for the authenticated account. Wavix sends POST callbacks for `on-call` and
+      # `post-call` events.
+      #
+      # @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 [Array[Wavix::Types::CallWebhookListResponseItem]]
+      def list(request_options: {}, **_params)
+        request = Wavix::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v1/calls/webhooks",
+          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::CallWebhookListResponse.load(response.body)
+        else
+          error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Registers a callback URL for the `on-call` or `post-call` event. Wavix sends a POST callback to the URL when the
+      # event occurs.
+      #
+      # @param request_options [Hash]
+      # @param params [Wavix::CallWebhooks::Types::CallWebhooksCreateRequest]
+      # @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::CallWebhook]
+      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/webhooks",
+          body: Wavix::CallWebhooks::Types::CallWebhooksCreateRequest.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::CallWebhook.load(response.body)
+        else
+          error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Removes the call webhook for the given event type. Wavix stops sending callbacks for that event.
+      #
+      # @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 [Wavix::CallWebhooks::Types::DeleteCallWebhooksRequestEventType] :event_type
+      #
+      # @return [Wavix::Types::SuccessResponse]
+      def delete(request_options: {}, **params)
+        params = Wavix::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["event_type"] = params[:event_type] if params.key?(:event_type)
+
+        request = Wavix::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "DELETE",
+          path: "v1/calls/webhooks",
+          query: query_params,
+          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

data/lib/wavix/call_webhooks/types/call_webhooks_create_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module CallWebhooks
+    module Types
+      class CallWebhooksCreateRequest < Internal::Types::Model
+        field :url, -> { String }, optional: false, nullable: false
+
+        field :event_type, -> { Wavix::CallWebhooks::Types::CallWebhooksCreateRequestEventType }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/call_webhooks/types/call_webhooks_create_request_event_type.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Wavix
+  module CallWebhooks
+    module Types
+      module CallWebhooksCreateRequestEventType
+        extend Wavix::Internal::Types::Enum
+
+        POST_CALL = "post-call"
+        ON_CALL = "on-call"
+      end
+    end
+  end
+end

data/lib/wavix/call_webhooks/types/delete_call_webhooks_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Wavix
+  module CallWebhooks
+    module Types
+      class DeleteCallWebhooksRequest < Internal::Types::Model
+        field :event_type, -> { Wavix::CallWebhooks::Types::DeleteCallWebhooksRequestEventType }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/call_webhooks/types/delete_call_webhooks_request_event_type.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Wavix
+  module CallWebhooks
+    module Types
+      module DeleteCallWebhooksRequestEventType
+        extend Wavix::Internal::Types::Enum
+
+        POST_CALL = "post-call"
+        ON_CALL = "on-call"
+      end
+    end
+  end
+end

data/lib/wavix/cart/client.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Cart
+    class Client
+      # @param client [Wavix::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Returns the current purchase cart, including the phone numbers it contains and the documents each requires.
+      #
+      # @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::Cart::Types::GetCartResponse]
+      def get(request_options: {}, **_params)
+        request = Wavix::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v1/buy/cart",
+          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::Cart::Types::GetCartResponse.load(response.body)
+        else
+          error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Adds the listed phone numbers to the purchase cart.
+      #
+      # @param request_options [Hash]
+      # @param params [Wavix::Cart::Types::AddCartRequest]
+      # @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 [Array[Object]]
+      def add(request_options: {}, **params)
+        params = Wavix::Internal::Types::Utils.normalize_keys(params)
+        request = Wavix::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "PUT",
+          path: "v1/buy/cart",
+          body: Wavix::Cart::Types::AddCartRequest.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
+        return if code.between?(200, 299)
+
+        error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+        raise error_class.new(response.body, code: code)
+      end
+
+      # Removes the listed phone numbers from the purchase cart.
+      #
+      # @param request_options [Hash]
+      # @param params [Wavix::Cart::Types::RemoveCartRequest]
+      # @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::Cart::Types::RemoveCartResponse]
+      def remove(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/buy/cart",
+          body: Wavix::Cart::Types::RemoveCartRequest.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::Cart::Types::RemoveCartResponse.load(response.body)
+        else
+          error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Purchases the listed phone numbers from the cart. Activation and monthly fees are deducted from the account
+      # balance.
+      #
+      # @param request_options [Hash]
+      # @param params [Wavix::Cart::Types::CheckoutCartRequest]
+      # @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::Cart::Types::CheckoutCartResponse]
+      def checkout(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/buy/cart/checkout",
+          body: Wavix::Cart::Types::CheckoutCartRequest.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::Cart::Types::CheckoutCartResponse.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

data/lib/wavix/cart/types/add_cart_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Cart
+    module Types
+      class AddCartRequest < Internal::Types::Model
+        field :ids, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/cart/types/checkout_cart_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Cart
+    module Types
+      class CheckoutCartRequest < Internal::Types::Model
+        field :ids, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/cart/types/checkout_cart_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Cart
+    module Types
+      class CheckoutCartResponse < Internal::Types::Model
+        field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/cart/types/get_cart_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Cart
+    module Types
+      class GetCartResponse < Internal::Types::Model
+        field :dids, -> { Internal::Types::Array[Wavix::Types::AvailableNumber] }, optional: false, nullable: false
+
+        field :doc_types, -> { Internal::Types::Array[Wavix::Types::DocumentType] }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/cart/types/remove_cart_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Cart
+    module Types
+      class RemoveCartRequest < Internal::Types::Model
+        field :ids, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/cart/types/remove_cart_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Cart
+    module Types
+      class RemoveCartResponse < Internal::Types::Model
+        field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
+      end
+    end
+  end
+end