wavix-ruby-sdk 1.0.0

data/lib/wavix/number_validator/client.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Wavix
+  module NumberValidator
+    class Client
+      # @param client [Wavix::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Validates a single phone number and returns line type, carrier, portability, and reachability details.
+      #
+      # @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] :phone_number
+      # @option params [Wavix::Types::PhoneNumberValidationType] :type
+      #
+      # @return [Wavix::NumberValidator::Types::GetNumberValidatorResponse]
+      def get(request_options: {}, **params)
+        params = Wavix::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["phone_number"] = params[:phone_number] if params.key?(:phone_number)
+        query_params["type"] = params[:type] if params.key?(:type)
+
+        request = Wavix::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v1/validation",
+          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::NumberValidator::Types::GetNumberValidatorResponse.load(response.body)
+        else
+          error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Validates a batch of phone numbers. When `async` is `true`, returns a `request_id` to poll for results instead
+      # of the validation details.
+      #
+      # @param request_options [Hash]
+      # @param params [Wavix::NumberValidator::Types::PhoneValidationRequest]
+      # @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::NumberValidatorCreateBulkResponse]
+      def create_bulk(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/validation",
+          body: Wavix::NumberValidator::Types::PhoneValidationRequest.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::NumberValidatorCreateBulkResponse.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::Results::Client]
+      def results
+        @results ||= Wavix::NumberValidator::Results::Client.new(client: @client)
+      end
+    end
+  end
+end

data/lib/wavix/number_validator/results/client.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Wavix
+  module NumberValidator
+    module Results
+      class Client
+        # @param client [Wavix::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Returns the results of an asynchronous batch validation 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 [Wavix::Types::PhoneValidationBatchResultResponse]
+        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/validation/#{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::Types::PhoneValidationBatchResultResponse.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/number_validator/results/types/get_results_request.rb

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

data/lib/wavix/number_validator/types/get_number_validator_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module NumberValidator
+    module Types
+      class GetNumberValidatorRequest < Internal::Types::Model
+        field :phone_number, -> { String }, optional: false, nullable: false
+
+        field :type, -> { Wavix::Types::PhoneNumberValidationType }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/number_validator/types/get_number_validator_response.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Wavix
+  module NumberValidator
+    module Types
+      class GetNumberValidatorResponse < Internal::Types::Model
+        field :phone_number, -> { String }, optional: false, nullable: false
+
+        field :valid, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :country_code, -> { String }, optional: false, nullable: true
+
+        field :e164format, -> { String }, optional: false, nullable: false, api_name: "e164_format"
+
+        field :national_format, -> { String }, optional: false, nullable: false
+
+        field :ported, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :mcc, -> { String }, optional: true, nullable: false
+
+        field :mnc, -> { String }, optional: true, nullable: false
+
+        field :number_type, -> { String }, optional: true, nullable: false
+
+        field :carrier_name, -> { String }, optional: true, nullable: false
+
+        field :risky_destination, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :unallocated_range, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :reachable, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :roaming, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :timezone, -> { String }, optional: true, nullable: false
+
+        field :charge, -> { String }, optional: false, nullable: false
+
+        field :error_code, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/number_validator/types/phone_validation_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Wavix
+  module NumberValidator
+    module Types
+      class PhoneValidationRequest < Internal::Types::Model
+        field :phone_numbers, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+
+        field :type, -> { Wavix::Types::PhoneNumberValidationType }, optional: false, nullable: false
+
+        field :async, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :force, -> { Internal::Types::Boolean }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/numbers/client.rb

@@ -0,0 +1,216 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Numbers
+    class Client
+      # @param client [Wavix::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Returns a paginated list of the phone numbers owned by 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
+      # @option params [Integer, nil] :city_id
+      # @option params [String, nil] :search
+      # @option params [String, nil] :label
+      # @option params [Boolean, nil] :label_present
+      # @option params [Integer, nil] :page
+      # @option params [Integer, nil] :per_page
+      #
+      # @return [Wavix::Types::NumberListResponse]
+      def list(request_options: {}, **params)
+        params = Wavix::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["city_id"] = params[:city_id] if params.key?(:city_id)
+        query_params["search"] = params[:search] if params.key?(:search)
+        query_params["label"] = params[:label] if params.key?(:label)
+        query_params["label_present"] = params[:label_present] if params.key?(:label_present)
+        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/numbers",
+          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::NumberListResponse.load(response.body)
+        else
+          error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Releases the listed phone numbers back to stock. Selection accepts either `ids` (record IDs) or `dids` (phone
+      # numbers), but not both.
+      #
+      # @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, nil] :ids
+      # @option params [String, nil] :dids
+      #
+      # @return [Wavix::Numbers::Types::DeleteNumbersResponse]
+      def delete(request_options: {}, **params)
+        params = Wavix::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["ids"] = params[:ids] if params.key?(:ids)
+        query_params["dids"] = params[:dids] if params.key?(:dids)
+
+        request = Wavix::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "DELETE",
+          path: "v1/numbers",
+          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::Numbers::Types::DeleteNumbersResponse.load(response.body)
+        else
+          error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Applies the same changes to every listed phone number. Only the provided fields are changed. Destination and SMS
+      # callback changes are applied asynchronously and may not be reflected in the response immediately.
+      #
+      # @param request_options [Hash]
+      # @param params [Wavix::Numbers::Types::NumberBulkUpdateRequest]
+      # @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::Numbers::Types::BulkUpdateNumbersResponse]
+      def bulk_update(request_options: {}, **params)
+        params = Wavix::Internal::Types::Utils.normalize_keys(params)
+        request = Wavix::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "PATCH",
+          path: "v1/numbers",
+          body: Wavix::Numbers::Types::NumberBulkUpdateRequest.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::Numbers::Types::BulkUpdateNumbersResponse.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 phone number identified by `id`, including its destinations, documents, and feature settings.
+      #
+      # @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::Number]
+      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/numbers/#{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::Number.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 phone number identified by `id`. Only the provided fields are changed.
+      #
+      # @param request_options [Hash]
+      # @param params [Wavix::Numbers::Types::NumberUpdateRequest]
+      # @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::Number]
+      def update(request_options: {}, **params)
+        params = Wavix::Internal::Types::Utils.normalize_keys(params)
+        request_data = Wavix::Numbers::Types::NumberUpdateRequest.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/numbers/#{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::Number.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::Papers::Client]
+      def papers
+        @papers ||= Wavix::Numbers::Papers::Client.new(client: @client)
+      end
+    end
+  end
+end

data/lib/wavix/numbers/papers/client.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Numbers
+    module Papers
+      class Client
+        # @param client [Wavix::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Uploads a verification document for one or more phone numbers.
+        # Uploaded files must meet the following requirements:
+        # - Allowed formats: PNG, JPG, JPEG, TIFF, BMP, or PDF
+        # - Maximum file size: 10 MB
+        # - Files can't be password protected
+        # - PDF files must not contain digital signatures
+        #
+        # @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 [Array[Wavix::Types::NumberDocument]]
+        def upload(request_options: {}, **params)
+          params = Wavix::Internal::Types::Utils.normalize_keys(params)
+          body = Internal::Multipart::FormData.new
+
+          if params[:did_ids]
+            body.add(
+              name: "did_ids",
+              value: params[:did_ids]
+            )
+          end
+          body.add_part(params[:doc_attachment].to_form_data_part(name: "doc_attachment")) if params[:doc_attachment]
+          if params[:doc_id]
+            body.add(
+              name: "doc_id",
+              value: params[:doc_id]
+            )
+          end
+
+          request = Wavix::Internal::Multipart::Request.new(
+            base_url: request_options[:base_url],
+            method: "POST",
+            path: "v1/numbers/papers",
+            body: body,
+            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/numbers/papers/types/upload_papers_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Numbers
+    module Papers
+      module Types
+        class UploadPapersRequest < Internal::Types::Model; end
+      end
+    end
+  end
+end

data/lib/wavix/numbers/types/bulk_update_numbers_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Numbers
+    module Types
+      class BulkUpdateNumbersResponse < Internal::Types::Model
+        field :items, -> { Internal::Types::Array[Wavix::Types::Number] }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/numbers/types/delete_numbers_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Numbers
+    module Types
+      class DeleteNumbersRequest < Internal::Types::Model
+        field :ids, -> { Integer }, optional: true, nullable: false
+
+        field :dids, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/numbers/types/delete_numbers_response.rb

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

data/lib/wavix/numbers/types/get_numbers_request.rb

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

data/lib/wavix/numbers/types/list_numbers_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Numbers
+    module Types
+      class ListNumbersRequest < Internal::Types::Model
+        field :city_id, -> { Integer }, optional: true, nullable: false
+
+        field :search, -> { String }, optional: true, nullable: false
+
+        field :label, -> { String }, optional: true, nullable: false
+
+        field :label_present, -> { Internal::Types::Boolean }, 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/numbers/types/number_bulk_update_request.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Numbers
+    module Types
+      class NumberBulkUpdateRequest < Internal::Types::Model
+        field :ids, -> { Internal::Types::Array[Integer] }, optional: false, nullable: false
+
+        field :sms_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :destinations, -> { Internal::Types::Array[Wavix::Types::NumberDestination] }, optional: true, nullable: false
+
+        field :sms_relay_url, -> { String }, optional: true, nullable: false
+
+        field :call_recording_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :transcription_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :transcription_threshold, -> { Integer }, optional: true, nullable: false
+
+        field :call_status_url, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/numbers/types/number_update_request.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Numbers
+    module Types
+      class NumberUpdateRequest < Internal::Types::Model
+        field :id, -> { Integer }, optional: false, nullable: false
+
+        field :sms_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :destinations, -> { Internal::Types::Array[Wavix::Types::NumberDestination] }, optional: true, nullable: false
+
+        field :sms_relay_url, -> { String }, optional: true, nullable: false
+
+        field :call_recording_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :transcription_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :transcription_threshold, -> { Integer }, optional: true, nullable: false
+
+        field :call_status_url, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end