wavix-ruby-sdk 1.0.0

data/lib/wavix/ten_dlc/subscriptions/types/delete_subscriptions_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module TenDlc
+    module Subscriptions
+      module Types
+        class DeleteSubscriptionsRequest < Internal::Types::Model
+          field :subscription_category, -> { String }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/wavix/ten_dlc/subscriptions/types/delete_subscriptions_response.rb

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

data/lib/wavix/two_fa/client.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Wavix
+  module TwoFa
+    class Client
+      # @param client [Wavix::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # @return [Wavix::Verification::Client]
+      def verification
+        @verification ||= Wavix::TwoFa::Verification::Client.new(client: @client)
+      end
+
+      # @return [Wavix::Sessions::Client]
+      def sessions
+        @sessions ||= Wavix::TwoFa::Sessions::Client.new(client: @client)
+      end
+
+      # @return [Wavix::Events::Client]
+      def events
+        @events ||= Wavix::TwoFa::Events::Client.new(client: @client)
+      end
+    end
+  end
+end

data/lib/wavix/two_fa/events/client.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Wavix
+  module TwoFa
+    module Events
+      class Client
+        # @param client [Wavix::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Returns the lifecycle events of the 2FA verification identified by `session_id`, such as number lookup and
+        # code delivery.
+        #
+        # @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] :session_id
+        #
+        # @return [Array[Wavix::Types::TwoFactorVerificationEvent]]
+        def list(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/two-fa/session/#{URI.encode_uri_component(params[:session_id].to_s)}/events",
+            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/two_fa/events/types/list_events_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module TwoFa
+    module Events
+      module Types
+        class ListEventsRequest < Internal::Types::Model
+          field :session_id, -> { String }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/wavix/two_fa/sessions/client.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Wavix
+  module TwoFa
+    module Sessions
+      class Client
+        # @param client [Wavix::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Returns the 2FA verifications for the service identified by `service_id`, 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] :service_id
+        # @option params [String] :from
+        # @option params [String] :to
+        #
+        # @return [Array[Wavix::Types::ListSessionsResponseItem]]
+        def list(request_options: {}, **params)
+          params = Wavix::Internal::Types::Utils.normalize_keys(params)
+          query_params = {}
+          query_params["from"] = params[:from] if params.key?(:from)
+          query_params["to"] = params[:to] if params.key?(:to)
+
+          request = Wavix::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "v1/two-fa/service/#{URI.encode_uri_component(params[:service_id].to_s)}/sessions",
+            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
+      end
+    end
+  end
+end

data/lib/wavix/two_fa/sessions/types/list_sessions_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Wavix
+  module TwoFa
+    module Sessions
+      module Types
+        class ListSessionsRequest < Internal::Types::Model
+          field :service_id, -> { String }, optional: false, nullable: false
+
+          field :from, -> { String }, optional: false, nullable: false
+
+          field :to, -> { String }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/wavix/two_fa/verification/client.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+module Wavix
+  module TwoFa
+    module Verification
+      class Client
+        # @param client [Wavix::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Creates a 2FA verification and sends a one-time password (OTP) to the destination phone number over the
+        # selected channel. Requires a 2FA service configured in the Wavix portal; the service is reused to generate and
+        # validate OTPs.
+        #
+        # The verification proceeds through three steps:
+        # 1. Create a verification to generate and send an OTP.
+        # 2. Resend the OTP on the same verification if needed.
+        # 3. Validate the OTP through the check endpoint.
+        #
+        # @param request_options [Hash]
+        # @param params [Wavix::TwoFa::Verification::Types::TwoFactorVerificationCreateRequest]
+        # @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::TwoFa::Verification::Types::CreateVerificationResponse]
+        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/two-fa/verification",
+            body: Wavix::TwoFa::Verification::Types::TwoFactorVerificationCreateRequest.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::TwoFa::Verification::Types::CreateVerificationResponse.load(response.body)
+          else
+            error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Resends the OTP for the verification identified by `session_id` over the specified channel. Previously sent
+        # codes are invalidated.
+        #
+        # @param request_options [Hash]
+        # @param params [Wavix::TwoFa::Verification::Types::TwoFactorVerificationResendRequest]
+        # @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] :session_id
+        #
+        # @return [Wavix::TwoFa::Verification::Types::ResendVerificationResponse]
+        def resend(request_options: {}, **params)
+          params = Wavix::Internal::Types::Utils.normalize_keys(params)
+          request_data = Wavix::TwoFa::Verification::Types::TwoFactorVerificationResendRequest.new(params).to_h
+          non_body_param_names = %w[session_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/two-fa/verification/#{URI.encode_uri_component(params[:session_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::TwoFa::Verification::Types::ResendVerificationResponse.load(response.body)
+          else
+            error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Validates the OTP submitted by the end user against the verification identified by `session_id`.
+        #
+        # @param request_options [Hash]
+        # @param params [Wavix::TwoFa::Verification::Types::TwoFactorVerificationCheckRequest]
+        # @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] :session_id
+        #
+        # @return [Wavix::TwoFa::Verification::Types::CheckVerificationResponse]
+        def check(request_options: {}, **params)
+          params = Wavix::Internal::Types::Utils.normalize_keys(params)
+          request_data = Wavix::TwoFa::Verification::Types::TwoFactorVerificationCheckRequest.new(params).to_h
+          non_body_param_names = %w[session_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/two-fa/verification/#{URI.encode_uri_component(params[:session_id].to_s)}/check",
+            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::TwoFa::Verification::Types::CheckVerificationResponse.load(response.body)
+          else
+            error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Cancels the 2FA verification identified by `session_id`. No further codes are sent, and previously sent codes
+        # can no longer be validated. A new verification is required to send another code.
+        #
+        # @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] :session_id
+        #
+        # @return [Wavix::Types::SuccessResponse]
+        def cancel(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/two-fa/verification/#{URI.encode_uri_component(params[:session_id].to_s)}/cancel",
+            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/two_fa/verification/types/cancel_verification_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module TwoFa
+    module Verification
+      module Types
+        class CancelVerificationRequest < Internal::Types::Model
+          field :session_id, -> { String }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/wavix/two_fa/verification/types/check_verification_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module TwoFa
+    module Verification
+      module Types
+        class CheckVerificationResponse < Internal::Types::Model
+          field :is_valid, -> { Internal::Types::Boolean }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/wavix/two_fa/verification/types/create_verification_response.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Wavix
+  module TwoFa
+    module Verification
+      module Types
+        class CreateVerificationResponse < Internal::Types::Model
+          field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+          field :service_id, -> { String }, optional: false, nullable: false
+
+          field :session_url, -> { String }, optional: false, nullable: false
+
+          field :session_id, -> { String }, optional: false, nullable: false
+
+          field :destination, -> { String }, optional: false, nullable: false
+
+          field :created_at, -> { String }, optional: false, nullable: false
+
+          field :number_lookup, -> { Wavix::Types::PhoneLookupDetails }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/wavix/two_fa/verification/types/resend_verification_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Wavix
+  module TwoFa
+    module Verification
+      module Types
+        class ResendVerificationResponse < Internal::Types::Model
+          field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+          field :channel, -> { String }, optional: false, nullable: false
+
+          field :destination, -> { String }, optional: false, nullable: false
+
+          field :created_at, -> { String }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/wavix/two_fa/verification/types/two_factor_verification_check_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Wavix
+  module TwoFa
+    module Verification
+      module Types
+        class TwoFactorVerificationCheckRequest < Internal::Types::Model
+          field :session_id, -> { String }, optional: false, nullable: false
+
+          field :code, -> { String }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/wavix/two_fa/verification/types/two_factor_verification_create_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Wavix
+  module TwoFa
+    module Verification
+      module Types
+        class TwoFactorVerificationCreateRequest < Internal::Types::Model
+          field :service_id, -> { String }, optional: false, nullable: false
+
+          field :to, -> { String }, optional: false, nullable: false
+
+          field :channel, -> { String }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/wavix/two_fa/verification/types/two_factor_verification_resend_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Wavix
+  module TwoFa
+    module Verification
+      module Types
+        class TwoFactorVerificationResendRequest < Internal::Types::Model
+          field :session_id, -> { String }, optional: false, nullable: false
+
+          field :channel, -> { Wavix::TwoFa::Verification::Types::TwoFactorVerificationResendRequestChannel }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/wavix/two_fa/verification/types/two_factor_verification_resend_request_channel.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Wavix
+  module TwoFa
+    module Verification
+      module Types
+        module TwoFactorVerificationResendRequestChannel
+          extend Wavix::Internal::Types::Enum
+
+          SMS = "sms"
+          VOICE = "voice"
+        end
+      end
+    end
+  end
+end

data/lib/wavix/types/account_error_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # The feature is disabled for the account.
+    class AccountErrorResponse < Internal::Types::Model
+      field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :message, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/account_limits.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    class AccountLimits < Internal::Types::Model
+      field :max_call_duration, -> { Integer }, optional: false, nullable: false
+
+      field :max_sip_channels, -> { Integer }, optional: false, nullable: false
+
+      field :max_call_rate, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/allowed_i_ps.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module AllowedIPs
+      # AllowedIPs is an alias for Array
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/wavix/types/allowed_i_ps_item.rb

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

data/lib/wavix/types/api_key.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # API key details including IP restrictions and scope permissions.
+    class APIKey < Internal::Types::Model
+      field :id, -> { Integer }, optional: false, nullable: false
+
+      field :label, -> { String }, optional: false, nullable: false
+
+      field :value, -> { String }, optional: false, nullable: false
+
+      field :active, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :restricted, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :permitted_ips, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+
+      field :scopes_enabled, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :last_used_at, -> { String }, optional: false, nullable: true
+
+      field :numbers, -> { Wavix::Types::APIKeyScopePermission }, optional: false, nullable: true
+
+      field :trunks, -> { Wavix::Types::APIKeyScopePermission }, optional: false, nullable: true
+
+      field :calls, -> { Wavix::Types::APIKeyCallsScopePermission }, optional: false, nullable: true
+
+      field :messages, -> { Wavix::Types::APIKeyScopePermission }, optional: false, nullable: true
+
+      field :recordings, -> { Wavix::Types::APIKeyScopePermission }, optional: false, nullable: true
+
+      field :campaigns, -> { Wavix::Types::APIKeyScopePermission }, optional: false, nullable: true
+
+      field :two_fa, -> { Wavix::Types::APIKeyScopePermission }, optional: false, nullable: true
+
+      field :validator, -> { Wavix::Types::APIKeyScopePermission }, optional: false, nullable: true
+
+      field :webhooks, -> { Wavix::Types::APIKeyScopePermission }, optional: false, nullable: true
+
+      field :embeddable, -> { Wavix::Types::APIKeyScopePermission }, optional: false, nullable: true
+
+      field :billing, -> { Wavix::Types::APIKeyScopePermission }, optional: false, nullable: true
+
+      field :account, -> { Wavix::Types::APIKeyScopePermission }, optional: false, nullable: true
+
+      field :subaccounts, -> { Wavix::Types::APIKeyScopePermission }, optional: false, nullable: true
+
+      field :created_at, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/api_key_calls_scope_permission.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Permission level for the `calls` scope group.
+    class APIKeyCallsScopePermission < Internal::Types::Model
+      field :allow, -> { Wavix::Types::APIKeyCallsScopePermissionAllow }, optional: true, nullable: false
+    end
+  end
+end

data/lib/wavix/types/api_key_calls_scope_permission_allow.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module APIKeyCallsScopePermissionAllow
+      extend Wavix::Internal::Types::Enum
+
+      NONE = "none"
+      READ = "read"
+      WRITE = "write"
+    end
+  end
+end

data/lib/wavix/types/api_key_scope_permission.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Permission level for an API key scope group.
+    class APIKeyScopePermission < Internal::Types::Model
+      field :allow, -> { Wavix::Types::APIKeyScopePermissionAllow }, optional: true, nullable: false
+    end
+  end
+end