rcs 2.0.5 → 2.0.8

data/lib/pinnacle/messages/blast/client.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Messages
+    module Blast
+      class Client
+        # @param client [Pinnacle::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Send an SMS message to all contacts in an audience. <br>
+        #
+        # Messages are distributed evenly across the provided sender phone numbers. <br>
+        #
+        # Use the optional `schedule` parameter in `options` to schedule the blast for future delivery. When scheduled,
+        # the response will contain a `scheduleId` instead of blast details.
+        #
+        # @param request_options [Hash]
+        # @param params [Pinnacle::Messages::Blast::Types::BlastSms]
+        # @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 [Pinnacle::Messages::Blast::Types::BlastSmsResponse]
+        def sms(request_options: {}, **params)
+          params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+          body_prop_names = %i[audience_id senders message options]
+          body_bag = params.slice(*body_prop_names)
+
+          request = Pinnacle::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "POST",
+            path: "messages/blast/sms",
+            body: Pinnacle::Messages::Blast::Types::BlastSms.new(body_bag).to_h,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Pinnacle::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            Pinnacle::Messages::Blast::Types::BlastSmsResponse.load(response.body)
+          else
+            error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Send an MMS message to all contacts in an audience. <br>
+        #
+        # Messages are distributed evenly across the provided sender phone numbers. <br>
+        #
+        # Use the optional `schedule` parameter in `options` to schedule the blast for future delivery. When scheduled,
+        # the response will contain a `scheduleId` instead of blast details.
+        #
+        # @param request_options [Hash]
+        # @param params [Pinnacle::Messages::Blast::Types::BlastMms]
+        # @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 [Pinnacle::Messages::Blast::Types::BlastMmsResponse]
+        def mms(request_options: {}, **params)
+          params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+          body_prop_names = %i[audience_id senders message options]
+          body_bag = params.slice(*body_prop_names)
+
+          request = Pinnacle::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "POST",
+            path: "messages/blast/mms",
+            body: Pinnacle::Messages::Blast::Types::BlastMms.new(body_bag).to_h,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Pinnacle::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            Pinnacle::Messages::Blast::Types::BlastMmsResponse.load(response.body)
+          else
+            error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Send an RCS message to all contacts in an audience. <br>
+        #
+        # Messages are distributed evenly across the provided RCS agents for load balancing. Requires active RCS agents
+        # and recipient devices that support RCS Business Messaging. <br>
+        #
+        # Use the optional `schedule` parameter in `options` to schedule the blast for future delivery. When scheduled,
+        # the response will contain a `scheduleId` instead of blast details.
+        #
+        # @param request_options [Hash]
+        # @param params [Pinnacle::Messages::Blast::Types::BlastRcs]
+        # @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 [Pinnacle::Messages::Blast::Types::BlastRcsResponse]
+        def rcs(request_options: {}, **params)
+          params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+          body_prop_names = %i[audience_id senders message options]
+          body_bag = params.slice(*body_prop_names)
+
+          request = Pinnacle::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "POST",
+            path: "messages/blast/rcs",
+            body: Pinnacle::Messages::Blast::Types::BlastRcs.new(body_bag).to_h,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Pinnacle::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            Pinnacle::Messages::Blast::Types::BlastRcsResponse.load(response.body)
+          else
+            error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/messages/blast/types/blast_mms.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Messages
+    module Blast
+      module Types
+        class BlastMms < Internal::Types::Model
+          field :audience_id, -> { String }, optional: false, nullable: false, api_name: "audienceId"
+          field :senders, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+          field :message, -> { Pinnacle::Types::MmsContent }, optional: false, nullable: false
+          field :options, -> { Pinnacle::Messages::Blast::Types::BlastMmsOptions }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/messages/blast/types/blast_mms_options.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Messages
+    module Blast
+      module Types
+        # Additional settings to customize MMS blast delivery.
+        class BlastMmsOptions < Internal::Types::Model
+          field :validate, -> { Internal::Types::Boolean }, optional: true, nullable: false
+          field :schedule, -> { Pinnacle::Types::MessageSchedule }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/messages/blast/types/blast_mms_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Messages
+    module Blast
+      module Types
+        class BlastMmsResponse < Internal::Types::Model
+          extend Pinnacle::Internal::Types::Union
+
+          member -> { Pinnacle::Types::BlastDetails }
+          member -> { Pinnacle::Types::ScheduledBlastDetails }
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/messages/blast/types/blast_rcs.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Messages
+    module Blast
+      module Types
+        class BlastRcs < Internal::Types::Model
+          field :audience_id, -> { String }, optional: false, nullable: false, api_name: "audienceId"
+          field :senders, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+          field :message, -> { Pinnacle::Types::RcsValidateContent }, optional: false, nullable: false
+          field :options, -> { Pinnacle::Messages::Blast::Types::BlastRcsOptions }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/messages/blast/types/blast_rcs_options.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Messages
+    module Blast
+      module Types
+        # Configure how your RCS blast is sent and tracked.
+        class BlastRcsOptions < Internal::Types::Model
+          field :transcode, -> { Internal::Types::Boolean }, optional: true, nullable: false
+          field :validate, -> { Internal::Types::Boolean }, optional: true, nullable: false
+          field :standalone_card, -> { Pinnacle::Messages::Blast::Types::BlastRcsRequestOptionsStandaloneCard }, optional: true, nullable: false
+          field :schedule, -> { Pinnacle::Types::MessageSchedule }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/messages/blast/types/blast_rcs_request_options_standalone_card.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Messages
+    module Blast
+      module Types
+        # Configure standalone card layout options for enhanced visual presentation.
+        #
+        # > **⚠️ Important Restriction**
+        # >
+        # > This option is **only valid for single card messages**. Using it with multiple cards will cause the request
+        # to fail with a validation error.
+        class BlastRcsRequestOptionsStandaloneCard < Internal::Types::Model
+          field :orientation, -> { Pinnacle::Messages::Blast::Types::BlastRcsRequestOptionsStandaloneCardOrientation }, optional: true, nullable: false
+          field :image_alignment, -> { Pinnacle::Messages::Blast::Types::BlastRcsRequestOptionsStandaloneCardImageAlignment }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/messages/blast/types/blast_rcs_request_options_standalone_card_image_alignment.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Messages
+    module Blast
+      module Types
+        module BlastRcsRequestOptionsStandaloneCardImageAlignment
+          extend Pinnacle::Internal::Types::Enum
+
+          LEFT = "LEFT"
+          RIGHT = "RIGHT"
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/messages/blast/types/blast_rcs_request_options_standalone_card_orientation.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Messages
+    module Blast
+      module Types
+        module BlastRcsRequestOptionsStandaloneCardOrientation
+          extend Pinnacle::Internal::Types::Enum
+
+          HORIZONTAL = "HORIZONTAL"
+          VERTICAL = "VERTICAL"
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/messages/blast/types/blast_rcs_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Messages
+    module Blast
+      module Types
+        class BlastRcsResponse < Internal::Types::Model
+          extend Pinnacle::Internal::Types::Union
+
+          member -> { Pinnacle::Types::BlastDetails }
+          member -> { Pinnacle::Types::ScheduledBlastDetails }
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/messages/blast/types/blast_sms.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Messages
+    module Blast
+      module Types
+        class BlastSms < Internal::Types::Model
+          field :audience_id, -> { String }, optional: false, nullable: false, api_name: "audienceId"
+          field :senders, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+          field :message, -> { Pinnacle::Types::SmsContent }, optional: false, nullable: false
+          field :options, -> { Pinnacle::Messages::Blast::Types::BlastSmsOptions }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/messages/blast/types/blast_sms_options.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Messages
+    module Blast
+      module Types
+        # Additional settings to customize SMS blast delivery.
+        class BlastSmsOptions < Internal::Types::Model
+          field :schedule, -> { Pinnacle::Types::MessageSchedule }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/messages/blast/types/blast_sms_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Messages
+    module Blast
+      module Types
+        class BlastSmsResponse < Internal::Types::Model
+          extend Pinnacle::Internal::Types::Union
+
+          member -> { Pinnacle::Types::BlastDetails }
+          member -> { Pinnacle::Types::ScheduledBlastDetails }
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/messages/client.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Messages
+    class Client
+      # @param client [Pinnacle::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Retrieve a previously sent message.
+      #
+      # @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 [Pinnacle::Types::Message]
+      def get(request_options: {}, **params)
+        params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+        request = Pinnacle::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "messages/#{params[:id]}",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Pinnacle::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Pinnacle::Types::Message.load(response.body)
+        else
+          error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Add or remove an emoji reaction to a previously sent message.
+      #
+      # @param request_options [Hash]
+      # @param params [Pinnacle::Messages::Types::ReactMessageParams]
+      # @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 [Pinnacle::Types::ReactionResult]
+      def react(request_options: {}, **params)
+        params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+        body_prop_names = %i[message_id options reaction]
+        body_bag = params.slice(*body_prop_names)
+
+        request = Pinnacle::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "messages/react",
+          body: Pinnacle::Messages::Types::ReactMessageParams.new(body_bag).to_h,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Pinnacle::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Pinnacle::Types::ReactionResult.load(response.body)
+        else
+          error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # @return [Pinnacle::Sms::Client]
+      def sms
+        @sms ||= Pinnacle::Messages::Sms::Client.new(client: @client)
+      end
+
+      # @return [Pinnacle::Mms::Client]
+      def mms
+        @mms ||= Pinnacle::Messages::Mms::Client.new(client: @client)
+      end
+
+      # @return [Pinnacle::Rcs::Client]
+      def rcs
+        @rcs ||= Pinnacle::Messages::Rcs::Client.new(client: @client)
+      end
+
+      # @return [Pinnacle::Blast::Client]
+      def blast
+        @blast ||= Pinnacle::Messages::Blast::Client.new(client: @client)
+      end
+
+      # @return [Pinnacle::Schedule::Client]
+      def schedule
+        @schedule ||= Pinnacle::Messages::Schedule::Client.new(client: @client)
+      end
+    end
+  end
+end

data/lib/pinnacle/messages/mms/client.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Messages
+    module Mms
+      class Client
+        # @param client [Pinnacle::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Send a MMS immediately or schedule it for future delivery.
+        #
+        # @param request_options [Hash]
+        # @param params [Pinnacle::Messages::Mms::Types::Mms]
+        # @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 [Pinnacle::Messages::Mms::Types::MmsSendResponse]
+        def send_(request_options: {}, **params)
+          params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+          body_prop_names = %i[from media_urls options text to]
+          body_bag = params.slice(*body_prop_names)
+
+          request = Pinnacle::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "POST",
+            path: "messages/send/mms",
+            body: Pinnacle::Messages::Mms::Types::Mms.new(body_bag).to_h,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Pinnacle::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            Pinnacle::Messages::Mms::Types::MmsSendResponse.load(response.body)
+          else
+            error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Validate MMS message content without sending it.
+        #
+        # @param request_options [Hash]
+        # @param params [Pinnacle::Types::MmsContent]
+        # @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 [Pinnacle::Types::MmsValidationResult]
+        def validate(request_options: {}, **params)
+          params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+          request = Pinnacle::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "POST",
+            path: "messages/validate/mms",
+            body: Pinnacle::Types::MmsContent.new(params).to_h,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Pinnacle::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            Pinnacle::Types::MmsValidationResult.load(response.body)
+          else
+            error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/messages/mms/types/mms.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Messages
+    module Mms
+      module Types
+        class Mms < Internal::Types::Model
+          field :from, -> { String }, optional: false, nullable: false
+          field :media_urls, -> { Internal::Types::Array[String] }, optional: false, nullable: false, api_name: "mediaUrls"
+          field :options, -> { Pinnacle::Messages::Mms::Types::SendMmsOptions }, optional: true, nullable: false
+          field :text, -> { String }, optional: false, nullable: false
+          field :to, -> { String }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/messages/mms/types/mms_send_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Messages
+    module Mms
+      module Types
+        class MmsSendResponse < Internal::Types::Model
+          extend Pinnacle::Internal::Types::Union
+
+          member -> { Pinnacle::Types::SentMmsDetails }
+          member -> { Pinnacle::Types::ScheduledMessage }
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/messages/mms/types/send_mms_options.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Messages
+    module Mms
+      module Types
+        # Control how your MMS is processed and delivered.
+        class SendMmsOptions < Internal::Types::Model
+          field :multiple_messages, -> { Internal::Types::Boolean }, optional: false, nullable: false
+          field :schedule, -> { Pinnacle::Types::MessageSchedule }, optional: true, nullable: false
+          field :tracking, -> { Pinnacle::Types::Tracking }, optional: true, nullable: false
+          field :validate, -> { Internal::Types::Boolean }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end