rcs 1.0.17 → 2.0.0.pre.rc.1

data/lib/rcs/types/rcs_cards_cards_item.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require_relative "rcs_button_content"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Individual card containing title, optional media, and action buttons.
+    class RcsCardsCardsItem
+      # @return [Array<Pinnacle::Types::RcsButtonContent>] Action buttons attached to the card.
+      attr_reader :buttons
+      # @return [String] Media file URLs to send.
+      attr_reader :media
+      # @return [String] Secondary text displayed below the title for additional context.
+      attr_reader :subtitle
+      # @return [String] Title displayed on the card.
+      attr_reader :title
+      # @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 buttons [Array<Pinnacle::Types::RcsButtonContent>] Action buttons attached to the card.
+      # @param media [String] Media file URLs to send.
+      # @param subtitle [String] Secondary text displayed below the title for additional context.
+      # @param title [String] Title displayed on the card.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::RcsCardsCardsItem]
+      def initialize(buttons:, title:, media: OMIT, subtitle: OMIT, additional_properties: nil)
+        @buttons = buttons
+        @media = media if media != OMIT
+        @subtitle = subtitle if subtitle != OMIT
+        @title = title
+        @additional_properties = additional_properties
+        @_field_set = { "buttons": buttons, "media": media, "subtitle": subtitle, "title": title }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of RcsCardsCardsItem
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::RcsCardsCardsItem]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        buttons = parsed_json["buttons"]&.map do |item|
+          item = item.to_json
+          Pinnacle::Types::RcsButtonContent.from_json(json_object: item)
+        end
+        media = parsed_json["media"]
+        subtitle = parsed_json["subtitle"]
+        title = parsed_json["title"]
+        new(
+          buttons: buttons,
+          media: media,
+          subtitle: subtitle,
+          title: title,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of RcsCardsCardsItem 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.buttons.is_a?(Array) != false || raise("Passed value for field obj.buttons is not the expected type, validation failed.")
+        obj.media&.is_a?(String) != false || raise("Passed value for field obj.media is not the expected type, validation failed.")
+        obj.subtitle&.is_a?(String) != false || raise("Passed value for field obj.subtitle is not the expected type, validation failed.")
+        obj.title.is_a?(String) != false || raise("Passed value for field obj.title is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/rcs_cards_content.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require_relative "rcs_cards_content_cards_item"
+require_relative "rcs_button_content"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Message containing cards, each with its own title, subtitle, and/or buttons.
+    #  Quick replies can also be added. <br>
+    #  See (supported file
+    #  types)[https://app.pinnacle.sh/supported-file-types?type=RCS-CARD].
+    class RcsCardsContent
+      # @return [Array<Pinnacle::Types::RcsCardsContentCardsItem>] Collection of cards attached to the message.
+      attr_reader :cards
+      # @return [Array<Pinnacle::Types::RcsButtonContent>] List of interactive quick reply buttons in the message.
+      attr_reader :quick_replies
+      # @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 cards [Array<Pinnacle::Types::RcsCardsContentCardsItem>] Collection of cards attached to the message.
+      # @param quick_replies [Array<Pinnacle::Types::RcsButtonContent>] List of interactive quick reply buttons in the message.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::RcsCardsContent]
+      def initialize(cards:, quick_replies:, additional_properties: nil)
+        @cards = cards
+        @quick_replies = quick_replies
+        @additional_properties = additional_properties
+        @_field_set = { "cards": cards, "quickReplies": quick_replies }
+      end
+
+      # Deserialize a JSON object to an instance of RcsCardsContent
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::RcsCardsContent]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        cards = parsed_json["cards"]&.map do |item|
+          item = item.to_json
+          Pinnacle::Types::RcsCardsContentCardsItem.from_json(json_object: item)
+        end
+        quick_replies = parsed_json["quickReplies"]&.map do |item|
+          item = item.to_json
+          Pinnacle::Types::RcsButtonContent.from_json(json_object: item)
+        end
+        new(
+          cards: cards,
+          quick_replies: quick_replies,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of RcsCardsContent 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.cards.is_a?(Array) != false || raise("Passed value for field obj.cards is not the expected type, validation failed.")
+        obj.quick_replies.is_a?(Array) != false || raise("Passed value for field obj.quick_replies is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/rcs_cards_content_cards_item.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require_relative "rcs_button_content"
+require_relative "rcs_media_details_content"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Individual card containing title, optional media, and action buttons.
+    class RcsCardsContentCardsItem
+      # @return [Array<Pinnacle::Types::RcsButtonContent>] Action buttons attached to the card.
+      attr_reader :buttons
+      # @return [Pinnacle::Types::RcsMediaDetailsContent]
+      attr_reader :media
+      # @return [String] Secondary text displayed below the title for additional context.
+      attr_reader :subtitle
+      # @return [String] Title displayed on the card.
+      attr_reader :title
+      # @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 buttons [Array<Pinnacle::Types::RcsButtonContent>] Action buttons attached to the card.
+      # @param media [Pinnacle::Types::RcsMediaDetailsContent]
+      # @param subtitle [String] Secondary text displayed below the title for additional context.
+      # @param title [String] Title displayed on the card.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::RcsCardsContentCardsItem]
+      def initialize(buttons:, title:, media: OMIT, subtitle: OMIT, additional_properties: nil)
+        @buttons = buttons
+        @media = media if media != OMIT
+        @subtitle = subtitle if subtitle != OMIT
+        @title = title
+        @additional_properties = additional_properties
+        @_field_set = { "buttons": buttons, "media": media, "subtitle": subtitle, "title": title }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of RcsCardsContentCardsItem
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::RcsCardsContentCardsItem]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        buttons = parsed_json["buttons"]&.map do |item|
+          item = item.to_json
+          Pinnacle::Types::RcsButtonContent.from_json(json_object: item)
+        end
+        if parsed_json["media"].nil?
+          media = nil
+        else
+          media = parsed_json["media"].to_json
+          media = Pinnacle::Types::RcsMediaDetailsContent.from_json(json_object: media)
+        end
+        subtitle = parsed_json["subtitle"]
+        title = parsed_json["title"]
+        new(
+          buttons: buttons,
+          media: media,
+          subtitle: subtitle,
+          title: title,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of RcsCardsContentCardsItem 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.buttons.is_a?(Array) != false || raise("Passed value for field obj.buttons is not the expected type, validation failed.")
+        obj.media.nil? || Pinnacle::Types::RcsMediaDetailsContent.validate_raw(obj: obj.media)
+        obj.subtitle&.is_a?(String) != false || raise("Passed value for field obj.subtitle is not the expected type, validation failed.")
+        obj.title.is_a?(String) != false || raise("Passed value for field obj.title is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/rcs_content.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "rcs_text_content"
+require_relative "rcs_media_content"
+require_relative "rcs_cards_content"
+
+module Pinnacle
+  module Types
+    # Message with richer content (longer text, media files, cards, and buttons) from
+    #  interacting with an RCS agent.
+    class RcsContent
+      # Deserialize a JSON object to an instance of RcsContent
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::RcsContent]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        begin
+          Pinnacle::Types::RcsTextContent.validate_raw(obj: struct)
+          return Pinnacle::Types::RcsTextContent.from_json(json_object: struct) unless struct.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        begin
+          Pinnacle::Types::RcsMediaContent.validate_raw(obj: struct)
+          return Pinnacle::Types::RcsMediaContent.from_json(json_object: struct) unless struct.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        begin
+          Pinnacle::Types::RcsCardsContent.validate_raw(obj: struct)
+          return Pinnacle::Types::RcsCardsContent.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::RcsTextContent.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return Pinnacle::Types::RcsMediaContent.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return Pinnacle::Types::RcsCardsContent.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/rcs_media.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require_relative "rcs_button_content"
+require_relative "rcs_base_options"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class RcsMedia
+      # @return [String] Media file URLs to send. <br>
+      #  See [supported media
+      #  types](https://app.pinnacle.sh/supported-file-types?type=RCS-MEDIA).
+      attr_reader :media
+      # @return [Array<Pinnacle::Types::RcsButtonContent>] List of interactive quick reply buttons in the message.
+      attr_reader :quick_replies
+      # @return [String] Your RCS agent ID which must be prefixed with 'agent_'.
+      attr_reader :from
+      # @return [Pinnacle::Types::RcsBaseOptions] Configure how your RCS message is sent and tracked.
+      attr_reader :options
+      # @return [String] Recipient's phone number in E.164 format.
+      attr_reader :to
+      # @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 media [String] Media file URLs to send. <br>
+      #  See [supported media
+      #  types](https://app.pinnacle.sh/supported-file-types?type=RCS-MEDIA).
+      # @param quick_replies [Array<Pinnacle::Types::RcsButtonContent>] List of interactive quick reply buttons in the message.
+      # @param from [String] Your RCS agent ID which must be prefixed with 'agent_'.
+      # @param options [Pinnacle::Types::RcsBaseOptions] Configure how your RCS message is sent and tracked.
+      # @param to [String] Recipient's phone number in E.164 format.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::RcsMedia]
+      def initialize(media:, quick_replies:, from:, to:, options: OMIT, additional_properties: nil)
+        @media = media
+        @quick_replies = quick_replies
+        @from = from
+        @options = options if options != OMIT
+        @to = to
+        @additional_properties = additional_properties
+        @_field_set = {
+          "media": media,
+          "quickReplies": quick_replies,
+          "from": from,
+          "options": options,
+          "to": to
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of RcsMedia
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::RcsMedia]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        media = parsed_json["media"]
+        quick_replies = parsed_json["quickReplies"]&.map do |item|
+          item = item.to_json
+          Pinnacle::Types::RcsButtonContent.from_json(json_object: item)
+        end
+        from = parsed_json["from"]
+        if parsed_json["options"].nil?
+          options = nil
+        else
+          options = parsed_json["options"].to_json
+          options = Pinnacle::Types::RcsBaseOptions.from_json(json_object: options)
+        end
+        to = parsed_json["to"]
+        new(
+          media: media,
+          quick_replies: quick_replies,
+          from: from,
+          options: options,
+          to: to,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of RcsMedia 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.media.is_a?(String) != false || raise("Passed value for field obj.media is not the expected type, validation failed.")
+        obj.quick_replies.is_a?(Array) != false || raise("Passed value for field obj.quick_replies is not the expected type, validation failed.")
+        obj.from.is_a?(String) != false || raise("Passed value for field obj.from is not the expected type, validation failed.")
+        obj.options.nil? || Pinnacle::Types::RcsBaseOptions.validate_raw(obj: obj.options)
+        obj.to.is_a?(String) != false || raise("Passed value for field obj.to is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/rcs_media_content.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require_relative "rcs_media_details_content"
+require_relative "rcs_button_content"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Message containing a media file and/or text with optional quick reply buttons.
+    #  <br>
+    #  See (supported file
+    #  types)[https://app.pinnacle.sh/supported-file-types?type=RCS-MEDIA].
+    class RcsMediaContent
+      # @return [Pinnacle::Types::RcsMediaDetailsContent]
+      attr_reader :media
+      # @return [Array<Pinnacle::Types::RcsButtonContent>] List of interactive quick reply buttons in the message.
+      attr_reader :quick_replies
+      # @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 media [Pinnacle::Types::RcsMediaDetailsContent]
+      # @param quick_replies [Array<Pinnacle::Types::RcsButtonContent>] List of interactive quick reply buttons in the message.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::RcsMediaContent]
+      def initialize(media:, quick_replies:, additional_properties: nil)
+        @media = media
+        @quick_replies = quick_replies
+        @additional_properties = additional_properties
+        @_field_set = { "media": media, "quickReplies": quick_replies }
+      end
+
+      # Deserialize a JSON object to an instance of RcsMediaContent
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::RcsMediaContent]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        if parsed_json["media"].nil?
+          media = nil
+        else
+          media = parsed_json["media"].to_json
+          media = Pinnacle::Types::RcsMediaDetailsContent.from_json(json_object: media)
+        end
+        quick_replies = parsed_json["quickReplies"]&.map do |item|
+          item = item.to_json
+          Pinnacle::Types::RcsButtonContent.from_json(json_object: item)
+        end
+        new(
+          media: media,
+          quick_replies: quick_replies,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of RcsMediaContent 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:)
+        Pinnacle::Types::RcsMediaDetailsContent.validate_raw(obj: obj.media)
+        obj.quick_replies.is_a?(Array) != false || raise("Passed value for field obj.quick_replies is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/rcs_media_details_content.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Metadata about the media file in the message.
+    class RcsMediaDetailsContent
+      # @return [String] Path to the file in Pinnacle's storage.
+      attr_reader :full_path
+      # @return [String] Detected MIME type of the media file.
+      attr_reader :mime_type
+      # @return [String] Direct URL to the media file.
+      attr_reader :url
+      # @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 full_path [String] Path to the file in Pinnacle's storage.
+      # @param mime_type [String] Detected MIME type of the media file.
+      # @param url [String] Direct URL to the media file.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::RcsMediaDetailsContent]
+      def initialize(mime_type:, url:, full_path: OMIT, additional_properties: nil)
+        @full_path = full_path if full_path != OMIT
+        @mime_type = mime_type
+        @url = url
+        @additional_properties = additional_properties
+        @_field_set = { "fullPath": full_path, "mimeType": mime_type, "url": url }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of RcsMediaDetailsContent
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::RcsMediaDetailsContent]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        full_path = parsed_json["fullPath"]
+        mime_type = parsed_json["mimeType"]
+        url = parsed_json["url"]
+        new(
+          full_path: full_path,
+          mime_type: mime_type,
+          url: url,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of RcsMediaDetailsContent 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.full_path&.is_a?(String) != false || raise("Passed value for field obj.full_path is not the expected type, validation failed.")
+        obj.mime_type.is_a?(String) != false || raise("Passed value for field obj.mime_type is not the expected type, validation failed.")
+        obj.url.is_a?(String) != false || raise("Passed value for field obj.url is not the expected type, validation failed.")
+      end
+    end
+  end
+end