rcs 2.0.4 → 2.0.5.pre.rc.1

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

@@ -1,118 +0,0 @@
-# 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

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

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "blast_rcs_request_options_standalone_card_orientation"
-require_relative "blast_rcs_request_options_standalone_card_image_alignment"
-require "ostruct"
-require "json"
-
-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
-          # @return [Pinnacle::Messages::Blast::Types::BlastRcsRequestOptionsStandaloneCardOrientation] The orientation of the standalone card.
-          attr_reader :orientation
-          # @return [Pinnacle::Messages::Blast::Types::BlastRcsRequestOptionsStandaloneCardImageAlignment] The alignment of the image in the standalone card. This field is ignored if
-          #  orientation is VERTICAL.
-          attr_reader :image_alignment
-          # @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 orientation [Pinnacle::Messages::Blast::Types::BlastRcsRequestOptionsStandaloneCardOrientation] The orientation of the standalone card.
-          # @param image_alignment [Pinnacle::Messages::Blast::Types::BlastRcsRequestOptionsStandaloneCardImageAlignment] The alignment of the image in the standalone card. This field is ignored if
-          #  orientation is VERTICAL.
-          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-          # @return [Pinnacle::Messages::Blast::Types::BlastRcsRequestOptionsStandaloneCard]
-          def initialize(orientation: OMIT, image_alignment: OMIT, additional_properties: nil)
-            @orientation = orientation if orientation != OMIT
-            @image_alignment = image_alignment if image_alignment != OMIT
-            @additional_properties = additional_properties
-            @_field_set = { "orientation": orientation, "image_alignment": image_alignment }.reject do |_k, v|
-              v == OMIT
-            end
-          end
-
-          # Deserialize a JSON object to an instance of BlastRcsRequestOptionsStandaloneCard
-          #
-          # @param json_object [String]
-          # @return [Pinnacle::Messages::Blast::Types::BlastRcsRequestOptionsStandaloneCard]
-          def self.from_json(json_object:)
-            struct = JSON.parse(json_object, object_class: OpenStruct)
-            parsed_json = JSON.parse(json_object)
-            orientation = parsed_json["orientation"]
-            image_alignment = parsed_json["image_alignment"]
-            new(
-              orientation: orientation,
-              image_alignment: image_alignment,
-              additional_properties: struct
-            )
-          end
-
-          # Serialize an instance of BlastRcsRequestOptionsStandaloneCard 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.orientation&.is_a?(Pinnacle::Messages::Blast::Types::BlastRcsRequestOptionsStandaloneCardOrientation) != false || raise("Passed value for field obj.orientation is not the expected type, validation failed.")
-            obj.image_alignment&.is_a?(Pinnacle::Messages::Blast::Types::BlastRcsRequestOptionsStandaloneCardImageAlignment) != false || raise("Passed value for field obj.image_alignment is not the expected type, validation failed.")
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Pinnacle
-  module Messages
-    module Blast
-      module Types
-        # The alignment of the image in the standalone card. This field is ignored if
-        #  orientation is VERTICAL.
-        class BlastRcsRequestOptionsStandaloneCardImageAlignment
-          LEFT = "LEFT"
-          RIGHT = "RIGHT"
-        end
-      end
-    end
-  end
-end

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

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Pinnacle
-  module Messages
-    module Blast
-      module Types
-        # The orientation of the standalone card.
-        class BlastRcsRequestOptionsStandaloneCardOrientation
-          HORIZONTAL = "HORIZONTAL"
-          VERTICAL = "VERTICAL"
-        end
-      end
-    end
-  end
-end

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

@@ -1,60 +0,0 @@
-# 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 BlastRcsResponse
-          # Deserialize a JSON object to an instance of BlastRcsResponse
-          #
-          # @param json_object [String]
-          # @return [Pinnacle::Messages::Blast::Types::BlastRcsResponse]
-          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_sms_options.rb

@@ -1,70 +0,0 @@
-# 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 SMS blast delivery.
-        class BlastSmsOptions
-          # @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 schedule [Pinnacle::Types::MessageSchedule]
-          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-          # @return [Pinnacle::Messages::Blast::Types::BlastSmsOptions]
-          def initialize(schedule: OMIT, additional_properties: nil)
-            @schedule = schedule if schedule != OMIT
-            @additional_properties = additional_properties
-            @_field_set = { "schedule": schedule }.reject do |_k, v|
-              v == OMIT
-            end
-          end
-
-          # Deserialize a JSON object to an instance of BlastSmsOptions
-          #
-          # @param json_object [String]
-          # @return [Pinnacle::Messages::Blast::Types::BlastSmsOptions]
-          def self.from_json(json_object:)
-            struct = JSON.parse(json_object, object_class: OpenStruct)
-            parsed_json = JSON.parse(json_object)
-            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(schedule: schedule, additional_properties: struct)
-          end
-
-          # Serialize an instance of BlastSmsOptions 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.schedule.nil? || Pinnacle::Types::MessageSchedule.validate_raw(obj: obj.schedule)
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,60 +0,0 @@
-# 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 BlastSmsResponse
-          # Deserialize a JSON object to an instance of BlastSmsResponse
-          #
-          # @param json_object [String]
-          # @return [Pinnacle::Messages::Blast::Types::BlastSmsResponse]
-          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/client.rb

@@ -1,189 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../requests"
-require_relative "../types/message"
-require_relative "types/react_message_options"
-require_relative "../types/reaction_result"
-require "async"
-
-module Pinnacle
-  class MessagesClient
-    # @return [Pinnacle::RequestClient]
-    attr_reader :request_client
-
-    # @param request_client [Pinnacle::RequestClient]
-    # @return [Pinnacle::MessagesClient]
-    def initialize(request_client:)
-      @request_client = request_client
-    end
-
-    # Retrieve a previously sent message.
-    #
-    # @param id [String] Unique identifier of the message. This identifier is a string that always begins
-    #  with the prefix `msg_`, for example: `msg_1234567890`.
-    # @param request_options [Pinnacle::RequestOptions]
-    # @return [Pinnacle::Types::Message]
-    # @example
-    #  api = Pinnacle::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Pinnacle::Environment::DEFAULT,
-    #    api_key: "YOUR_API_KEY"
-    #  )
-    #  api.messages.get(id: "msg_1234567890")
-    def get(id:, request_options: nil)
-      response = @request_client.conn.get 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
-        unless request_options.nil? || request_options&.additional_body_parameters.nil?
-          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
-        end
-        req.url "#{@request_client.get_url(request_options: request_options)}/messages/#{id}"
-      end
-      Pinnacle::Types::Message.from_json(json_object: response.body)
-    end
-
-    # Add or remove an emoji reaction to a previously sent message.
-    #
-    # @param message_id [String] Unique identifier of the message. This identifier is a string that always begins
-    #  with the prefix `msg_`, for example: `msg_1234567890`.
-    # @param options [Hash] Request of type Pinnacle::Messages::Types::ReactMessageOptions, as a Hash
-    #   * :force (Boolean)
-    # @param reaction [String] Unicode emoji to add. <br>
-    #  Use `null` to remove existing reaction.
-    # @param request_options [Pinnacle::RequestOptions]
-    # @return [Pinnacle::Types::ReactionResult]
-    # @example
-    #  api = Pinnacle::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Pinnacle::Environment::DEFAULT,
-    #    api_key: "YOUR_API_KEY"
-    #  )
-    #  api.messages.react(
-    #    message_id: "msg_1234567890",
-    #    options: { force: true },
-    #    reaction: "👍"
-    #  )
-    def react(message_id:, options: nil, reaction: 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 || {}),
-          messageId: message_id,
-          options: options,
-          reaction: reaction
-        }.compact
-        req.url "#{@request_client.get_url(request_options: request_options)}/messages/react"
-      end
-      Pinnacle::Types::ReactionResult.from_json(json_object: response.body)
-    end
-  end
-
-  class AsyncMessagesClient
-    # @return [Pinnacle::AsyncRequestClient]
-    attr_reader :request_client
-
-    # @param request_client [Pinnacle::AsyncRequestClient]
-    # @return [Pinnacle::AsyncMessagesClient]
-    def initialize(request_client:)
-      @request_client = request_client
-    end
-
-    # Retrieve a previously sent message.
-    #
-    # @param id [String] Unique identifier of the message. This identifier is a string that always begins
-    #  with the prefix `msg_`, for example: `msg_1234567890`.
-    # @param request_options [Pinnacle::RequestOptions]
-    # @return [Pinnacle::Types::Message]
-    # @example
-    #  api = Pinnacle::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Pinnacle::Environment::DEFAULT,
-    #    api_key: "YOUR_API_KEY"
-    #  )
-    #  api.messages.get(id: "msg_1234567890")
-    def get(id:, request_options: nil)
-      Async do
-        response = @request_client.conn.get 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
-          unless request_options.nil? || request_options&.additional_body_parameters.nil?
-            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
-          end
-          req.url "#{@request_client.get_url(request_options: request_options)}/messages/#{id}"
-        end
-        Pinnacle::Types::Message.from_json(json_object: response.body)
-      end
-    end
-
-    # Add or remove an emoji reaction to a previously sent message.
-    #
-    # @param message_id [String] Unique identifier of the message. This identifier is a string that always begins
-    #  with the prefix `msg_`, for example: `msg_1234567890`.
-    # @param options [Hash] Request of type Pinnacle::Messages::Types::ReactMessageOptions, as a Hash
-    #   * :force (Boolean)
-    # @param reaction [String] Unicode emoji to add. <br>
-    #  Use `null` to remove existing reaction.
-    # @param request_options [Pinnacle::RequestOptions]
-    # @return [Pinnacle::Types::ReactionResult]
-    # @example
-    #  api = Pinnacle::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Pinnacle::Environment::DEFAULT,
-    #    api_key: "YOUR_API_KEY"
-    #  )
-    #  api.messages.react(
-    #    message_id: "msg_1234567890",
-    #    options: { force: true },
-    #    reaction: "👍"
-    #  )
-    def react(message_id:, options: nil, reaction: 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 || {}),
-            messageId: message_id,
-            options: options,
-            reaction: reaction
-          }.compact
-          req.url "#{@request_client.get_url(request_options: request_options)}/messages/react"
-        end
-        Pinnacle::Types::ReactionResult.from_json(json_object: response.body)
-      end
-    end
-  end
-end