wavix-ruby-sdk 1.0.0

data/lib/wavix/api_keys/client.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+module Wavix
+  module APIKeys
+    class Client
+      # @param client [Wavix::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Returns the API keys belonging to 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 [String, nil] :label
+      #
+      # @return [Array[Wavix::Types::APIKey]]
+      def list(request_options: {}, **params)
+        params = Wavix::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["label"] = params[:label] if params.key?(:label)
+
+        request = Wavix::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v1/api-keys",
+          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
+        return if code.between?(200, 299)
+
+        error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+        raise error_class.new(response.body, code: code)
+      end
+
+      # Creates an API key for the authenticated account. Restrict access by listing permitted IP addresses in
+      # `permitted_ips`.
+      #
+      # @param request_options [Hash]
+      # @param params [Wavix::APIKeys::Types::APIKeyCreateRequest]
+      # @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::APIKey]
+      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/api-keys",
+          body: Wavix::APIKeys::Types::APIKeyCreateRequest.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::APIKey.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 API key identified by `id`. Deletion is permanent and revokes the key immediately.
+      #
+      # @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/api-keys/#{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 an API key identified by `id`. Only the provided fields are changed.
+      #
+      # @param request_options [Hash]
+      # @param params [Wavix::APIKeys::Types::APIKeyUpdateRequest]
+      # @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::APIKey]
+      def update(request_options: {}, **params)
+        params = Wavix::Internal::Types::Utils.normalize_keys(params)
+        request_data = Wavix::APIKeys::Types::APIKeyUpdateRequest.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/api-keys/#{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::APIKey.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/api_keys/types/api_key_create_request.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Wavix
+  module APIKeys
+    module Types
+      class APIKeyCreateRequest < Internal::Types::Model
+        field :label, -> { String }, optional: false, nullable: false
+
+        field :active, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :restricted, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :permitted_ips, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
+        field :scopes_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :numbers, -> { Wavix::Types::APIKeyScopePermission }, optional: true, nullable: false
+
+        field :trunks, -> { Wavix::Types::APIKeyScopePermission }, optional: true, nullable: false
+
+        field :calls, -> { Wavix::Types::APIKeyCallsScopePermission }, optional: true, nullable: false
+
+        field :messages, -> { Wavix::Types::APIKeyScopePermission }, optional: true, nullable: false
+
+        field :recordings, -> { Wavix::Types::APIKeyScopePermission }, optional: true, nullable: false
+
+        field :campaigns, -> { Wavix::Types::APIKeyScopePermission }, optional: true, nullable: false
+
+        field :two_fa, -> { Wavix::Types::APIKeyScopePermission }, optional: true, nullable: false
+
+        field :validator, -> { Wavix::Types::APIKeyScopePermission }, optional: true, nullable: false
+
+        field :webhooks, -> { Wavix::Types::APIKeyScopePermission }, optional: true, nullable: false
+
+        field :embeddable, -> { Wavix::Types::APIKeyScopePermission }, optional: true, nullable: false
+
+        field :billing, -> { Wavix::Types::APIKeyScopePermission }, optional: true, nullable: false
+
+        field :account, -> { Wavix::Types::APIKeyScopePermission }, optional: true, nullable: false
+
+        field :subaccounts, -> { Wavix::Types::APIKeyScopePermission }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/api_keys/types/api_key_update_request.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Wavix
+  module APIKeys
+    module Types
+      class APIKeyUpdateRequest < Internal::Types::Model
+        field :id, -> { Integer }, optional: false, nullable: false
+
+        field :active, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :restricted, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :scopes_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :permitted_ips, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
+        field :label, -> { String }, optional: true, nullable: false
+
+        field :numbers, -> { Wavix::Types::APIKeyScopePermission }, optional: true, nullable: false
+
+        field :trunks, -> { Wavix::Types::APIKeyScopePermission }, optional: true, nullable: false
+
+        field :calls, -> { Wavix::Types::APIKeyCallsScopePermission }, optional: true, nullable: false
+
+        field :messages, -> { Wavix::Types::APIKeyScopePermission }, optional: true, nullable: false
+
+        field :recordings, -> { Wavix::Types::APIKeyScopePermission }, optional: true, nullable: false
+
+        field :campaigns, -> { Wavix::Types::APIKeyScopePermission }, optional: true, nullable: false
+
+        field :two_fa, -> { Wavix::Types::APIKeyScopePermission }, optional: true, nullable: false
+
+        field :validator, -> { Wavix::Types::APIKeyScopePermission }, optional: true, nullable: false
+
+        field :webhooks, -> { Wavix::Types::APIKeyScopePermission }, optional: true, nullable: false
+
+        field :embeddable, -> { Wavix::Types::APIKeyScopePermission }, optional: true, nullable: false
+
+        field :billing, -> { Wavix::Types::APIKeyScopePermission }, optional: true, nullable: false
+
+        field :account, -> { Wavix::Types::APIKeyScopePermission }, optional: true, nullable: false
+
+        field :subaccounts, -> { Wavix::Types::APIKeyScopePermission }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/wavix/api_keys/types/delete_api_keys_request.rb

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

data/lib/wavix/api_keys/types/list_api_keys_request.rb

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

data/lib/wavix/billing/client.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Billing
+    class Client
+      # @param client [Wavix::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # @return [Wavix::Transactions::Client]
+      def transactions
+        @transactions ||= Wavix::Billing::Transactions::Client.new(client: @client)
+      end
+
+      # @return [Wavix::Invoices::Client]
+      def invoices
+        @invoices ||= Wavix::Billing::Invoices::Client.new(client: @client)
+      end
+    end
+  end
+end

data/lib/wavix/billing/invoices/client.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Billing
+    module Invoices
+      class Client
+        # @param client [Wavix::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Returns the auto-generated financial statements for the authenticated account, paginated and ordered by
+        # billing period.
+        #
+        # @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] :page
+        # @option params [Integer, nil] :per_page
+        #
+        # @return [Wavix::Billing::Invoices::Types::ListInvoicesResponse]
+        def list(request_options: {}, **params)
+          params = Wavix::Internal::Types::Utils.normalize_keys(params)
+          query_params = {}
+          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/billing/invoices",
+            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::Billing::Invoices::Types::ListInvoicesResponse.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 financial statement identified by `id` as a PDF 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 [untyped]
+        def download(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/billing/invoices/#{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
+          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/billing/invoices/types/download_invoices_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Billing
+    module Invoices
+      module Types
+        class DownloadInvoicesRequest < Internal::Types::Model
+          field :id, -> { Integer }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/wavix/billing/invoices/types/list_invoices_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Billing
+    module Invoices
+      module Types
+        class ListInvoicesRequest < Internal::Types::Model
+          field :page, -> { Integer }, optional: true, nullable: false
+
+          field :per_page, -> { Integer }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/wavix/billing/invoices/types/list_invoices_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Billing
+    module Invoices
+      module Types
+        class ListInvoicesResponse < Internal::Types::Model
+          field :is_empty, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+          field :invoices, -> { Internal::Types::Array[Wavix::Types::Invoice] }, optional: false, nullable: false
+
+          field :pagination, -> { Wavix::Types::Pagination }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/wavix/billing/transactions/client.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Billing
+    module Transactions
+      class Client
+        # @param client [Wavix::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Returns a paginated list of billing transactions for the authenticated account within the requested date
+        # range.
+        #
+        # @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] :from_date
+        # @option params [String] :to_date
+        # @option params [Integer, nil] :type
+        # @option params [String, nil] :details_contains
+        # @option params [Boolean, nil] :payments
+        # @option params [Integer, nil] :page
+        # @option params [Integer, nil] :per_page
+        #
+        # @return [Wavix::Billing::Transactions::Types::ListTransactionsResponse]
+        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["type"] = params[:type] if params.key?(:type)
+          query_params["details_contains"] = params[:details_contains] if params.key?(:details_contains)
+          query_params["payments"] = params[:payments] if params.key?(:payments)
+          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/billing/transactions",
+            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::Billing::Transactions::Types::ListTransactionsResponse.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/billing/transactions/types/list_transactions_request.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Billing
+    module Transactions
+      module Types
+        class ListTransactionsRequest < Internal::Types::Model
+          field :from_date, -> { String }, optional: false, nullable: false
+
+          field :to_date, -> { String }, optional: false, nullable: false
+
+          field :type, -> { Integer }, optional: true, nullable: false
+
+          field :details_contains, -> { String }, optional: true, nullable: false
+
+          field :payments, -> { 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
+end

data/lib/wavix/billing/transactions/types/list_transactions_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Billing
+    module Transactions
+      module Types
+        class ListTransactionsResponse < Internal::Types::Model
+          field :is_empty, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+          field :transactions, -> { Internal::Types::Array[Wavix::Types::FinancialTransaction] }, optional: false, nullable: false
+
+          field :pagination, -> { Wavix::Types::Pagination }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/wavix/buy/cities/client.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Buy
+    module Cities
+      class Client
+        # @param client [Wavix::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Returns a list of cities for countries where
+        #  `has_provinces_or_states` is `false`.
+        #
+        # @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] :country_id
+        # @option params [Boolean, nil] :text_enabled_only
+        #
+        # @return [Wavix::Buy::Cities::Types::ListCitiesResponse]
+        def list(request_options: {}, **params)
+          params = Wavix::Internal::Types::Utils.normalize_keys(params)
+          query_params = {}
+          query_params["text_enabled_only"] = params[:text_enabled_only] if params.key?(:text_enabled_only)
+
+          request = Wavix::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "v1/buy/countries/#{URI.encode_uri_component(params[:country_id].to_s)}/cities",
+            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::Buy::Cities::Types::ListCitiesResponse.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/buy/cities/types/list_cities_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Buy
+    module Cities
+      module Types
+        class ListCitiesRequest < Internal::Types::Model
+          field :country_id, -> { Integer }, optional: false, nullable: false
+
+          field :text_enabled_only, -> { Internal::Types::Boolean }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/wavix/buy/cities/types/list_cities_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Buy
+    module Cities
+      module Types
+        class ListCitiesResponse < Internal::Types::Model
+          field :cities, -> { Internal::Types::Array[Wavix::Types::City] }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/wavix/buy/client.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Buy
+    class Client
+      # @param client [Wavix::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # @return [Wavix::Countries::Client]
+      def countries
+        @countries ||= Wavix::Buy::Countries::Client.new(client: @client)
+      end
+
+      # @return [Wavix::Regions::Client]
+      def regions
+        @regions ||= Wavix::Buy::Regions::Client.new(client: @client)
+      end
+
+      # @return [Wavix::Cities::Client]
+      def cities
+        @cities ||= Wavix::Buy::Cities::Client.new(client: @client)
+      end
+
+      # @return [Wavix::RegionCities::Client]
+      def region_cities
+        @region_cities ||= Wavix::Buy::RegionCities::Client.new(client: @client)
+      end
+
+      # @return [Wavix::Numbers::Client]
+      def numbers
+        @numbers ||= Wavix::Buy::Numbers::Client.new(client: @client)
+      end
+    end
+  end
+end