rcs 2.0.2 → 2.0.3

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

@@ -0,0 +1,419 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require_relative "../../types/sms_content"
+require_relative "types/blast_sms_options"
+require_relative "types/blast_sms_response"
+require_relative "../../types/mms_content"
+require_relative "types/blast_mms_options"
+require_relative "types/blast_mms_response"
+require_relative "../../types/rcs_validate_content"
+require_relative "types/blast_rcs_options"
+require_relative "types/blast_rcs_response"
+require "async"
+
+module Pinnacle
+  module Messages
+    class BlastClient
+      # @return [Pinnacle::RequestClient]
+      attr_reader :request_client
+
+      # @param request_client [Pinnacle::RequestClient]
+      # @return [Pinnacle::Messages::BlastClient]
+      def initialize(request_client:)
+        @request_client = request_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 audience_id [String] The audience ID to send the blast to. This identifier is a string that always
+      #  begins with the prefix `aud_`, for example: `aud_abc123`. <br>
+      #  You can create an audience via [the
+      #  dashboard](https://app.pinnacle.sh/dashboard/audiences) or
+      #  [API](/api-reference/audiences/create).
+      # @param senders [Array<String>] Array of phone numbers to send from in E.164 format. <br>
+      #  Messages will be distributed evenly across these senders.
+      #  > **Note:** Sandbox numbers cannot be used for blasts.
+      # @param message [Hash] Request of type Pinnacle::Types::SmsContent, as a Hash
+      #   * :text (String)
+      # @param options [Hash] Additional settings to customize SMS blast delivery.Request of type Pinnacle::Messages::Blast::Types::BlastSmsOptions, as a Hash
+      #   * :schedule (Hash)
+      #     * :send_at (String)
+      #     * :recurrence (String)
+      #     * :timezone (String)
+      #     * :end_date (String)
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::BlastDetails, Pinnacle::Types::ScheduledBlastDetails]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.messages.blast.sms(
+      #    audience_id: "aud_abc123",
+      #    senders: ["+14155164736", "+14155164737"],
+      #    message: { text: "Hello from Pinnacle!" }
+      #  )
+      def sms(audience_id:, senders:, message:, options: nil, request_options: nil)
+        response = @request_client.conn.post do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          req.body = {
+            **(request_options&.additional_body_parameters || {}),
+            audienceId: audience_id,
+            senders: senders,
+            message: message,
+            options: options
+          }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/messages/blast/sms"
+        end
+        Pinnacle::Messages::Blast::Types::BlastSmsResponse.from_json(json_object: response.body)
+      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 audience_id [String] The audience ID to send the blast to. This identifier is a string that always
+      #  begins with the prefix `aud_`, for example: `aud_abc123`. <br>
+      #  You can create an audience via [the
+      #  dashboard](https://app.pinnacle.sh/dashboard/audiences) or
+      #  [API](/api-reference/audiences/create).
+      # @param senders [Array<String>] Array of phone numbers to send from in E.164 format. <br>
+      #  Messages will be distributed evenly across these senders.
+      #  > **Note:** Sandbox numbers cannot be used for blasts.
+      # @param message [Hash] Request of type Pinnacle::Types::MmsContent, as a Hash
+      #   * :media_urls (Array<String>)
+      #   * :text (String)
+      # @param options [Hash] Additional settings to customize MMS blast delivery.Request of type Pinnacle::Messages::Blast::Types::BlastMmsOptions, as a Hash
+      #   * :validate (Boolean)
+      #   * :schedule (Hash)
+      #     * :send_at (String)
+      #     * :recurrence (String)
+      #     * :timezone (String)
+      #     * :end_date (String)
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::BlastDetails, Pinnacle::Types::ScheduledBlastDetails]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.messages.blast.mms(
+      #    audience_id: "aud_abc123",
+      #    senders: ["+14155164736", "+14155164737"],
+      #    message: { media_urls: ["https://fastly.picsum.photos/id/941/300/300.jpg"], text: "Check out this image!" },
+      #    options: { validate: true }
+      #  )
+      def mms(audience_id:, senders:, message:, options: nil, request_options: nil)
+        response = @request_client.conn.post do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          req.body = {
+            **(request_options&.additional_body_parameters || {}),
+            audienceId: audience_id,
+            senders: senders,
+            message: message,
+            options: options
+          }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/messages/blast/mms"
+        end
+        Pinnacle::Messages::Blast::Types::BlastMmsResponse.from_json(json_object: response.body)
+      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 audience_id [String] The audience ID to send the blast to. This identifier is a string that always
+      #  begins with the prefix `aud_`, for example: `aud_abc123`. <br>
+      #  You can create an audience via [the
+      #  dashboard](https://app.pinnacle.sh/dashboard/audiences) or
+      #  [API](/api-reference/audiences/create).
+      # @param senders [Array<String>] Array of RCS agent IDs to send from. Each must be prefixed with `agent_`. <br>
+      #  Messages will be evenly distributed across these agents.
+      #  > **Note:** Test agents cannot be used for blasts.
+      # @param message [Pinnacle::Types::RichText, Pinnacle::Types::RcsValidateContentMedia, Pinnacle::Types::RichCards]
+      # @param options [Hash] Configure how your RCS blast is sent and tracked.Request of type Pinnacle::Messages::Blast::Types::BlastRcsOptions, as a Hash
+      #   * :transcode (Boolean)
+      #   * :validate (Boolean)
+      #   * :standalone_card (Hash)
+      #     * :orientation (Pinnacle::Messages::Blast::Types::BlastRcsRequestOptionsStandaloneCardOrientation)
+      #     * :image_alignment (Pinnacle::Messages::Blast::Types::BlastRcsRequestOptionsStandaloneCardImageAlignment)
+      #   * :schedule (Hash)
+      #     * :send_at (String)
+      #     * :recurrence (String)
+      #     * :timezone (String)
+      #     * :end_date (String)
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::BlastDetails, Pinnacle::Types::ScheduledBlastDetails]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.messages.blast.rcs(
+      #    audience_id: "aud_abc123",
+      #    senders: ["agent_pinnacle", "agent_pinnacle2"],
+      #    message: { quick_replies: , text: "Hello from Pinnacle RCS!" },
+      #    options: { transcode: true, validate: true }
+      #  )
+      def rcs(audience_id:, senders:, message:, options: nil, request_options: nil)
+        response = @request_client.conn.post do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          req.body = {
+            **(request_options&.additional_body_parameters || {}),
+            audienceId: audience_id,
+            senders: senders,
+            message: message,
+            options: options
+          }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/messages/blast/rcs"
+        end
+        Pinnacle::Messages::Blast::Types::BlastRcsResponse.from_json(json_object: response.body)
+      end
+    end
+
+    class AsyncBlastClient
+      # @return [Pinnacle::AsyncRequestClient]
+      attr_reader :request_client
+
+      # @param request_client [Pinnacle::AsyncRequestClient]
+      # @return [Pinnacle::Messages::AsyncBlastClient]
+      def initialize(request_client:)
+        @request_client = request_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 audience_id [String] The audience ID to send the blast to. This identifier is a string that always
+      #  begins with the prefix `aud_`, for example: `aud_abc123`. <br>
+      #  You can create an audience via [the
+      #  dashboard](https://app.pinnacle.sh/dashboard/audiences) or
+      #  [API](/api-reference/audiences/create).
+      # @param senders [Array<String>] Array of phone numbers to send from in E.164 format. <br>
+      #  Messages will be distributed evenly across these senders.
+      #  > **Note:** Sandbox numbers cannot be used for blasts.
+      # @param message [Hash] Request of type Pinnacle::Types::SmsContent, as a Hash
+      #   * :text (String)
+      # @param options [Hash] Additional settings to customize SMS blast delivery.Request of type Pinnacle::Messages::Blast::Types::BlastSmsOptions, as a Hash
+      #   * :schedule (Hash)
+      #     * :send_at (String)
+      #     * :recurrence (String)
+      #     * :timezone (String)
+      #     * :end_date (String)
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::BlastDetails, Pinnacle::Types::ScheduledBlastDetails]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.messages.blast.sms(
+      #    audience_id: "aud_abc123",
+      #    senders: ["+14155164736", "+14155164737"],
+      #    message: { text: "Hello from Pinnacle!" }
+      #  )
+      def sms(audience_id:, senders:, message:, options: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.post do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            unless request_options.nil? || request_options&.additional_query_parameters.nil?
+              req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+            end
+            req.body = {
+              **(request_options&.additional_body_parameters || {}),
+              audienceId: audience_id,
+              senders: senders,
+              message: message,
+              options: options
+            }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/messages/blast/sms"
+          end
+          Pinnacle::Messages::Blast::Types::BlastSmsResponse.from_json(json_object: response.body)
+        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 audience_id [String] The audience ID to send the blast to. This identifier is a string that always
+      #  begins with the prefix `aud_`, for example: `aud_abc123`. <br>
+      #  You can create an audience via [the
+      #  dashboard](https://app.pinnacle.sh/dashboard/audiences) or
+      #  [API](/api-reference/audiences/create).
+      # @param senders [Array<String>] Array of phone numbers to send from in E.164 format. <br>
+      #  Messages will be distributed evenly across these senders.
+      #  > **Note:** Sandbox numbers cannot be used for blasts.
+      # @param message [Hash] Request of type Pinnacle::Types::MmsContent, as a Hash
+      #   * :media_urls (Array<String>)
+      #   * :text (String)
+      # @param options [Hash] Additional settings to customize MMS blast delivery.Request of type Pinnacle::Messages::Blast::Types::BlastMmsOptions, as a Hash
+      #   * :validate (Boolean)
+      #   * :schedule (Hash)
+      #     * :send_at (String)
+      #     * :recurrence (String)
+      #     * :timezone (String)
+      #     * :end_date (String)
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::BlastDetails, Pinnacle::Types::ScheduledBlastDetails]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.messages.blast.mms(
+      #    audience_id: "aud_abc123",
+      #    senders: ["+14155164736", "+14155164737"],
+      #    message: { media_urls: ["https://fastly.picsum.photos/id/941/300/300.jpg"], text: "Check out this image!" },
+      #    options: { validate: true }
+      #  )
+      def mms(audience_id:, senders:, message:, options: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.post do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            unless request_options.nil? || request_options&.additional_query_parameters.nil?
+              req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+            end
+            req.body = {
+              **(request_options&.additional_body_parameters || {}),
+              audienceId: audience_id,
+              senders: senders,
+              message: message,
+              options: options
+            }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/messages/blast/mms"
+          end
+          Pinnacle::Messages::Blast::Types::BlastMmsResponse.from_json(json_object: response.body)
+        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 audience_id [String] The audience ID to send the blast to. This identifier is a string that always
+      #  begins with the prefix `aud_`, for example: `aud_abc123`. <br>
+      #  You can create an audience via [the
+      #  dashboard](https://app.pinnacle.sh/dashboard/audiences) or
+      #  [API](/api-reference/audiences/create).
+      # @param senders [Array<String>] Array of RCS agent IDs to send from. Each must be prefixed with `agent_`. <br>
+      #  Messages will be evenly distributed across these agents.
+      #  > **Note:** Test agents cannot be used for blasts.
+      # @param message [Pinnacle::Types::RichText, Pinnacle::Types::RcsValidateContentMedia, Pinnacle::Types::RichCards]
+      # @param options [Hash] Configure how your RCS blast is sent and tracked.Request of type Pinnacle::Messages::Blast::Types::BlastRcsOptions, as a Hash
+      #   * :transcode (Boolean)
+      #   * :validate (Boolean)
+      #   * :standalone_card (Hash)
+      #     * :orientation (Pinnacle::Messages::Blast::Types::BlastRcsRequestOptionsStandaloneCardOrientation)
+      #     * :image_alignment (Pinnacle::Messages::Blast::Types::BlastRcsRequestOptionsStandaloneCardImageAlignment)
+      #   * :schedule (Hash)
+      #     * :send_at (String)
+      #     * :recurrence (String)
+      #     * :timezone (String)
+      #     * :end_date (String)
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::BlastDetails, Pinnacle::Types::ScheduledBlastDetails]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.messages.blast.rcs(
+      #    audience_id: "aud_abc123",
+      #    senders: ["agent_pinnacle", "agent_pinnacle2"],
+      #    message: { quick_replies: , text: "Hello from Pinnacle RCS!" },
+      #    options: { transcode: true, validate: true }
+      #  )
+      def rcs(audience_id:, senders:, message:, options: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.post do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            unless request_options.nil? || request_options&.additional_query_parameters.nil?
+              req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+            end
+            req.body = {
+              **(request_options&.additional_body_parameters || {}),
+              audienceId: audience_id,
+              senders: senders,
+              message: message,
+              options: options
+            }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/messages/blast/rcs"
+          end
+          Pinnacle::Messages::Blast::Types::BlastRcsResponse.from_json(json_object: response.body)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require_relative "../../../types/message_schedule"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Messages
+    module Blast
+      module Types
+        # Additional settings to customize MMS blast delivery.
+        class BlastMmsOptions
+          # @return [Boolean] Set to true to validate the message before sending. <br>
+          #  If validation fails, the blast is not sent.
+          attr_reader :validate
+          # @return [Pinnacle::Types::MessageSchedule]
+          attr_reader :schedule
+          # @return [OpenStruct] Additional properties unmapped to the current class definition
+          attr_reader :additional_properties
+          # @return [Object]
+          attr_reader :_field_set
+          protected :_field_set
+
+          OMIT = Object.new
+
+          # @param validate [Boolean] Set to true to validate the message before sending. <br>
+          #  If validation fails, the blast is not sent.
+          # @param schedule [Pinnacle::Types::MessageSchedule]
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [Pinnacle::Messages::Blast::Types::BlastMmsOptions]
+          def initialize(validate: OMIT, schedule: OMIT, additional_properties: nil)
+            @validate = validate if validate != OMIT
+            @schedule = schedule if schedule != OMIT
+            @additional_properties = additional_properties
+            @_field_set = { "validate": validate, "schedule": schedule }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of BlastMmsOptions
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Messages::Blast::Types::BlastMmsOptions]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            validate = parsed_json["validate"]
+            if parsed_json["schedule"].nil?
+              schedule = nil
+            else
+              schedule = parsed_json["schedule"].to_json
+              schedule = Pinnacle::Types::MessageSchedule.from_json(json_object: schedule)
+            end
+            new(
+              validate: validate,
+              schedule: schedule,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of BlastMmsOptions to a JSON object
+          #
+          # @return [String]
+          def to_json(*_args)
+            @_field_set&.to_json
+          end
+
+          # Leveraged for Union-type generation, validate_raw attempts to parse the given
+          #  hash and check each fields type against the current object's property
+          #  definitions.
+          #
+          # @param obj [Object]
+          # @return [Void]
+          def self.validate_raw(obj:)
+            obj.validate&.is_a?(Boolean) != false || raise("Passed value for field obj.validate is not the expected type, validation failed.")
+            obj.schedule.nil? || Pinnacle::Types::MessageSchedule.validate_raw(obj: obj.schedule)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "../../../types/blast_details"
+require_relative "../../../types/scheduled_blast_details"
+
+module Pinnacle
+  module Messages
+    module Blast
+      module Types
+        class BlastMmsResponse
+          # Deserialize a JSON object to an instance of BlastMmsResponse
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Messages::Blast::Types::BlastMmsResponse]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            begin
+              Pinnacle::Types::BlastDetails.validate_raw(obj: struct)
+              return Pinnacle::Types::BlastDetails.from_json(json_object: struct) unless struct.nil?
+
+              return nil
+            rescue StandardError
+              # noop
+            end
+            begin
+              Pinnacle::Types::ScheduledBlastDetails.validate_raw(obj: struct)
+              return Pinnacle::Types::ScheduledBlastDetails.from_json(json_object: struct) unless struct.nil?
+
+              return nil
+            rescue StandardError
+              # noop
+            end
+            struct
+          end
+
+          # Leveraged for Union-type generation, validate_raw attempts to parse the given
+          #  hash and check each fields type against the current object's property
+          #  definitions.
+          #
+          # @param obj [Object]
+          # @return [Void]
+          def self.validate_raw(obj:)
+            begin
+              return Pinnacle::Types::BlastDetails.validate_raw(obj: obj)
+            rescue StandardError
+              # noop
+            end
+            begin
+              return Pinnacle::Types::ScheduledBlastDetails.validate_raw(obj: obj)
+            rescue StandardError
+              # noop
+            end
+            raise("Passed value matched no type within the union, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require_relative "blast_rcs_request_options_standalone_card"
+require_relative "../../../types/message_schedule"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Messages
+    module Blast
+      module Types
+        # Configure how your RCS blast is sent and tracked.
+        class BlastRcsOptions
+          # @return [Boolean] Media files and card media will be transcoded to a supported RCS format. This
+          #  adds a small delay to sending the message. Ignored for rich text messages.
+          attr_reader :transcode
+          # @return [Boolean] Validate your message for any unsupported files. <br>
+          #  If failed, errors will be thrown and the blast will not be sent.
+          attr_reader :validate
+          # @return [Pinnacle::Messages::Blast::Types::BlastRcsRequestOptionsStandaloneCard] 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.
+          attr_reader :standalone_card
+          # @return [Pinnacle::Types::MessageSchedule]
+          attr_reader :schedule
+          # @return [OpenStruct] Additional properties unmapped to the current class definition
+          attr_reader :additional_properties
+          # @return [Object]
+          attr_reader :_field_set
+          protected :_field_set
+
+          OMIT = Object.new
+
+          # @param transcode [Boolean] Media files and card media will be transcoded to a supported RCS format. This
+          #  adds a small delay to sending the message. Ignored for rich text messages.
+          # @param validate [Boolean] Validate your message for any unsupported files. <br>
+          #  If failed, errors will be thrown and the blast will not be sent.
+          # @param standalone_card [Pinnacle::Messages::Blast::Types::BlastRcsRequestOptionsStandaloneCard] 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.
+          # @param schedule [Pinnacle::Types::MessageSchedule]
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [Pinnacle::Messages::Blast::Types::BlastRcsOptions]
+          def initialize(transcode: OMIT, validate: OMIT, standalone_card: OMIT, schedule: OMIT,
+                         additional_properties: nil)
+            @transcode = transcode if transcode != OMIT
+            @validate = validate if validate != OMIT
+            @standalone_card = standalone_card if standalone_card != OMIT
+            @schedule = schedule if schedule != OMIT
+            @additional_properties = additional_properties
+            @_field_set = {
+              "transcode": transcode,
+              "validate": validate,
+              "standalone_card": standalone_card,
+              "schedule": schedule
+            }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of BlastRcsOptions
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Messages::Blast::Types::BlastRcsOptions]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            transcode = parsed_json["transcode"]
+            validate = parsed_json["validate"]
+            if parsed_json["standalone_card"].nil?
+              standalone_card = nil
+            else
+              standalone_card = parsed_json["standalone_card"].to_json
+              standalone_card = Pinnacle::Messages::Blast::Types::BlastRcsRequestOptionsStandaloneCard.from_json(json_object: standalone_card)
+            end
+            if parsed_json["schedule"].nil?
+              schedule = nil
+            else
+              schedule = parsed_json["schedule"].to_json
+              schedule = Pinnacle::Types::MessageSchedule.from_json(json_object: schedule)
+            end
+            new(
+              transcode: transcode,
+              validate: validate,
+              standalone_card: standalone_card,
+              schedule: schedule,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of BlastRcsOptions to a JSON object
+          #
+          # @return [String]
+          def to_json(*_args)
+            @_field_set&.to_json
+          end
+
+          # Leveraged for Union-type generation, validate_raw attempts to parse the given
+          #  hash and check each fields type against the current object's property
+          #  definitions.
+          #
+          # @param obj [Object]
+          # @return [Void]
+          def self.validate_raw(obj:)
+            obj.transcode&.is_a?(Boolean) != false || raise("Passed value for field obj.transcode is not the expected type, validation failed.")
+            obj.validate&.is_a?(Boolean) != false || raise("Passed value for field obj.validate is not the expected type, validation failed.")
+            obj.standalone_card.nil? || Pinnacle::Messages::Blast::Types::BlastRcsRequestOptionsStandaloneCard.validate_raw(obj: obj.standalone_card)
+            obj.schedule.nil? || Pinnacle::Types::MessageSchedule.validate_raw(obj: obj.schedule)
+          end
+        end
+      end
+    end
+  end
+end