wavix-ruby-sdk 1.0.0

data/lib/wavix/sms_and_mms/messages/client.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SmsAndMms
+    module Messages
+      class Client
+        # @param client [Wavix::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Returns a paginated list of SMS and MMS messages for the authenticated account, filtered by direction, date,
+        # and other criteria.
+        #
+        # @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] :sent_after
+        # @option params [String, nil] :sent_before
+        # @option params [String] :type
+        # @option params [String, nil] :from
+        # @option params [String, nil] :to
+        # @option params [Wavix::Types::MessageDeliveryStatus, nil] :status
+        # @option params [String, nil] :tag
+        # @option params [Wavix::SmsAndMms::Messages::Types::ListMessagesRequestMessageType, nil] :message_type
+        # @option params [Integer, nil] :page
+        # @option params [Integer, nil] :per_page
+        #
+        # @return [Wavix::SmsAndMms::Messages::Types::ListMessagesResponse]
+        def list(request_options: {}, **params)
+          params = Wavix::Internal::Types::Utils.normalize_keys(params)
+          query_params = {}
+          query_params["sent_after"] = params[:sent_after] if params.key?(:sent_after)
+          query_params["sent_before"] = params[:sent_before] if params.key?(:sent_before)
+          query_params["type"] = params[:type] if params.key?(:type)
+          query_params["from"] = params[:from] if params.key?(:from)
+          query_params["to"] = params[:to] if params.key?(:to)
+          query_params["status"] = params[:status] if params.key?(:status)
+          query_params["tag"] = params[:tag] if params.key?(:tag)
+          query_params["message_type"] = params[:message_type] if params.key?(:message_type)
+          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: "v3/messages",
+            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::SmsAndMms::Messages::Types::ListMessagesResponse.load(response.body)
+          else
+            error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Sends an SMS or MMS message. MMS is supported for U.S. numbers only. Track delivery using the returned
+        # `message_id` and the message status callback.
+        # **Rate limit**: 20 messages per phone number in 24 hours.
+        #
+        # @param request_options [Hash]
+        # @param params [Wavix::SmsAndMms::Messages::Types::SendMessagesRequest]
+        # @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::SendMessagesResponse]
+        def send_(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: "v3/messages",
+            body: Wavix::SmsAndMms::Messages::Types::SendMessagesRequest.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::SendMessagesResponse.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 SMS or MMS message identified by `id`, including its delivery status and content.
+        #
+        # @param request_options [Hash]
+        # @param params [Hash]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String] :id
+        #
+        # @return [Wavix::SmsAndMms::Messages::Types::GetMessagesResponse]
+        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: "v3/messages/#{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::SmsAndMms::Messages::Types::GetMessagesResponse.load(response.body)
+          else
+            error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Streams matching SMS and MMS messages as newline-delimited JSON (NDJSON), one message per line, for bulk
+        # export.
+        #
+        # @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] :sent_after
+        # @option params [String, nil] :sent_before
+        # @option params [String] :type
+        # @option params [String, nil] :from
+        # @option params [String, nil] :to
+        # @option params [Wavix::Types::MessageDeliveryStatus, nil] :status
+        # @option params [String, nil] :tag
+        # @option params [Wavix::SmsAndMms::Messages::Types::ListAllMessagesRequestMessageType, nil] :message_type
+        #
+        # @return [String]
+        def list_all(request_options: {}, **params)
+          params = Wavix::Internal::Types::Utils.normalize_keys(params)
+          query_params = {}
+          query_params["sent_after"] = params[:sent_after] if params.key?(:sent_after)
+          query_params["sent_before"] = params[:sent_before] if params.key?(:sent_before)
+          query_params["type"] = params[:type] if params.key?(:type)
+          query_params["from"] = params[:from] if params.key?(:from)
+          query_params["to"] = params[:to] if params.key?(:to)
+          query_params["status"] = params[:status] if params.key?(:status)
+          query_params["tag"] = params[:tag] if params.key?(:tag)
+          query_params["message_type"] = params[:message_type] if params.key?(:message_type)
+
+          request = Wavix::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "v3/messages/all",
+            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/sms_and_mms/messages/types/get_messages_request.rb

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

data/lib/wavix/sms_and_mms/messages/types/get_messages_response.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SmsAndMms
+    module Messages
+      module Types
+        class GetMessagesResponse < Internal::Types::Model
+          field :message_id, -> { String }, optional: false, nullable: false
+
+          field :message_type, -> { String }, optional: false, nullable: false
+
+          field :from, -> { String }, optional: false, nullable: false
+
+          field :to, -> { String }, optional: false, nullable: false
+
+          field :direction, -> { String }, optional: false, nullable: false
+
+          field :mcc, -> { String }, optional: false, nullable: true
+
+          field :mnc, -> { String }, optional: false, nullable: true
+
+          field :message_body, -> { Wavix::Types::MessageBody }, optional: false, nullable: false
+
+          field :tag, -> { String }, optional: false, nullable: true
+
+          field :status, -> { Wavix::Types::MessageDeliveryStatus }, optional: false, nullable: false
+
+          field :segments, -> { Integer }, optional: false, nullable: false
+
+          field :charge, -> { String }, optional: false, nullable: false
+
+          field :submitted_at, -> { String }, optional: false, nullable: false
+
+          field :sent_at, -> { String }, optional: false, nullable: true
+
+          field :delivered_at, -> { String }, optional: false, nullable: true
+
+          field :error_message, -> { String }, optional: false, nullable: true
+
+          field :carrier_fees, -> { String }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/wavix/sms_and_mms/messages/types/list_all_messages_request.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SmsAndMms
+    module Messages
+      module Types
+        class ListAllMessagesRequest < Internal::Types::Model
+          field :sent_after, -> { String }, optional: true, nullable: false
+
+          field :sent_before, -> { String }, optional: true, nullable: false
+
+          field :type, -> { String }, optional: false, nullable: false
+
+          field :from, -> { String }, optional: true, nullable: false
+
+          field :to, -> { String }, optional: true, nullable: false
+
+          field :status, -> { Wavix::Types::MessageDeliveryStatus }, optional: true, nullable: false
+
+          field :tag, -> { String }, optional: true, nullable: false
+
+          field :message_type, -> { Wavix::SmsAndMms::Messages::Types::ListAllMessagesRequestMessageType }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/wavix/sms_and_mms/messages/types/list_all_messages_request_message_type.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SmsAndMms
+    module Messages
+      module Types
+        module ListAllMessagesRequestMessageType
+          extend Wavix::Internal::Types::Enum
+
+          SMS = "sms"
+          MMS = "mms"
+        end
+      end
+    end
+  end
+end

data/lib/wavix/sms_and_mms/messages/types/list_messages_request.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SmsAndMms
+    module Messages
+      module Types
+        class ListMessagesRequest < Internal::Types::Model
+          field :sent_after, -> { String }, optional: true, nullable: false
+
+          field :sent_before, -> { String }, optional: true, nullable: false
+
+          field :type, -> { String }, optional: false, nullable: false
+
+          field :from, -> { String }, optional: true, nullable: false
+
+          field :to, -> { String }, optional: true, nullable: false
+
+          field :status, -> { Wavix::Types::MessageDeliveryStatus }, optional: true, nullable: false
+
+          field :tag, -> { String }, optional: true, nullable: false
+
+          field :message_type, -> { Wavix::SmsAndMms::Messages::Types::ListMessagesRequestMessageType }, 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/sms_and_mms/messages/types/list_messages_request_message_type.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SmsAndMms
+    module Messages
+      module Types
+        module ListMessagesRequestMessageType
+          extend Wavix::Internal::Types::Enum
+
+          SMS = "sms"
+          MMS = "mms"
+        end
+      end
+    end
+  end
+end

data/lib/wavix/sms_and_mms/messages/types/list_messages_response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SmsAndMms
+    module Messages
+      module Types
+        class ListMessagesResponse < Internal::Types::Model
+          field :items, -> { Internal::Types::Array[Wavix::Types::Message] }, optional: false, nullable: false
+
+          field :pagination, -> { Wavix::Types::Pagination }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/wavix/sms_and_mms/messages/types/send_messages_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SmsAndMms
+    module Messages
+      module Types
+        class SendMessagesRequest < Internal::Types::Model
+          field :from, -> { String }, optional: false, nullable: false
+
+          field :to, -> { String }, optional: false, nullable: false
+
+          field :message_body, -> { Wavix::Types::MessageBody }, optional: false, nullable: false
+
+          field :callback_url, -> { String }, optional: true, nullable: false
+
+          field :validity, -> { Integer }, optional: true, nullable: false
+
+          field :tag, -> { String }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/wavix/sms_and_mms/opt_outs/client.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SmsAndMms
+    module OptOuts
+      class Client
+        # @param client [Wavix::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Returns a paginated list of phone numbers that have opted out of receiving messages from 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] :sender_id
+        # @option params [String, nil] :campaign_id
+        # @option params [String, nil] :created_after
+        # @option params [String, nil] :created_before
+        # @option params [Integer, nil] :page
+        # @option params [Integer, nil] :per_page
+        #
+        # @return [Wavix::Types::OptOutsListResponse]
+        def list(request_options: {}, **params)
+          params = Wavix::Internal::Types::Utils.normalize_keys(params)
+          query_params = {}
+          query_params["sender_id"] = params[:sender_id] if params.key?(:sender_id)
+          query_params["campaign_id"] = params[:campaign_id] if params.key?(:campaign_id)
+          query_params["created_after"] = params[:created_after] if params.key?(:created_after)
+          query_params["created_before"] = params[:created_before] if params.key?(:created_before)
+          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: "v3/messages/opt-outs",
+            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::OptOutsListResponse.load(response.body)
+          else
+            error_class = Wavix::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Opts a phone number out of receiving messages from a Sender ID, a 10DLC campaign, or all outbound messages.
+        #
+        # @param request_options [Hash]
+        # @param params [Wavix::SmsAndMms::OptOuts::Types::OptOutCreateRequest]
+        # @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::SmsAndMms::OptOuts::Types::CreateOptOutsResponse]
+        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: "v3/messages/opt-outs",
+            body: Wavix::SmsAndMms::OptOuts::Types::OptOutCreateRequest.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::SmsAndMms::OptOuts::Types::CreateOptOutsResponse.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/sms_and_mms/opt_outs/types/create_opt_outs_response.rb

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

data/lib/wavix/sms_and_mms/opt_outs/types/list_opt_outs_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SmsAndMms
+    module OptOuts
+      module Types
+        class ListOptOutsRequest < Internal::Types::Model
+          field :sender_id, -> { String }, optional: true, nullable: false
+
+          field :campaign_id, -> { String }, optional: true, nullable: false
+
+          field :created_after, -> { String }, optional: true, nullable: false
+
+          field :created_before, -> { String }, 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/sms_and_mms/opt_outs/types/opt_out_create_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module SmsAndMms
+    module OptOuts
+      module Types
+        class OptOutCreateRequest < Internal::Types::Model
+          field :opt_out, -> { Wavix::Types::OptOut }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end