rcs 2.0.0.pre.rc.5 → 2.0.0

data/lib/rcs/types/message_event_rcs_cards_content_cards_item.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require_relative "rich_button"
+require_relative "rcs_media_details_content"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Individual card containing title, optional media, and action buttons.
+    class MessageEventRcsCardsContentCardsItem
+      # @return [Array<Pinnacle::Types::RichButton>] 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::RichButton>] 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::MessageEventRcsCardsContentCardsItem]
+      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 MessageEventRcsCardsContentCardsItem
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::MessageEventRcsCardsContentCardsItem]
+      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::RichButton.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 MessageEventRcsCardsContentCardsItem 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/message_event_rcs_location_data.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require_relative "location_share_action_data"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Location sharing event data received when a user responds to a
+    #  `requestUserLocation` button and shares their current location.
+    #  This event contains the geographic coordinates (latitude/longitude) and
+    #  human-readable address of the location the user chose to share. Use this data to
+    #  process location-based requests or provide location-specific services.
+    class MessageEventRcsLocationData
+      # @return [String] Message type identifier.
+      attr_reader :type
+      # @return [String] Unique identifier of the message. This identifier is a string that always begins
+      #  with the prefix `msg_`, for example: `msg_1234567890`. <br><br>
+      #  To get the message details, use the [GET
+      #  /messages/{id}](/api-reference/messages/get) endpoint.
+      attr_reader :id
+      # @return [Pinnacle::Types::LocationShareActionData] Location data shared by the user.
+      attr_reader :data
+      # @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 type [String] Message type identifier.
+      # @param id [String] Unique identifier of the message. This identifier is a string that always begins
+      #  with the prefix `msg_`, for example: `msg_1234567890`. <br><br>
+      #  To get the message details, use the [GET
+      #  /messages/{id}](/api-reference/messages/get) endpoint.
+      # @param data [Pinnacle::Types::LocationShareActionData] Location data shared by the user.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::MessageEventRcsLocationData]
+      def initialize(type:, id:, data:, additional_properties: nil)
+        @type = type
+        @id = id
+        @data = data
+        @additional_properties = additional_properties
+        @_field_set = { "type": type, "id": id, "data": data }
+      end
+
+      # Deserialize a JSON object to an instance of MessageEventRcsLocationData
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::MessageEventRcsLocationData]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        type = parsed_json["type"]
+        id = parsed_json["id"]
+        if parsed_json["data"].nil?
+          data = nil
+        else
+          data = parsed_json["data"].to_json
+          data = Pinnacle::Types::LocationShareActionData.from_json(json_object: data)
+        end
+        new(
+          type: type,
+          id: id,
+          data: data,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of MessageEventRcsLocationData 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.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+        obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+        Pinnacle::Types::LocationShareActionData.validate_raw(obj: obj.data)
+      end
+    end
+  end
+end

data/lib/rcs/types/message_event_rcs_media_content.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require_relative "rich_button"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # RCS message containing a media file with optional quick reply buttons. <br>
+    #  See [supported file
+    #  types](https://app.pinnacle.sh/supported-file-types?type=RCS-MEDIA).
+    class MessageEventRcsMediaContent
+      # @return [String] Message type identifier.
+      attr_reader :type
+      # @return [String] Unique identifier of the message. This identifier is a string that always begins
+      #  with the prefix `msg_`, for example: `msg_1234567890`. <br><br>
+      #  To get the message details, use the [GET
+      #  /messages/{id}](/api-reference/messages/get) endpoint.
+      attr_reader :id
+      # @return [String] URL of the media file.
+      attr_reader :media
+      # @return [Array<Pinnacle::Types::RichButton>] 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 type [String] Message type identifier.
+      # @param id [String] Unique identifier of the message. This identifier is a string that always begins
+      #  with the prefix `msg_`, for example: `msg_1234567890`. <br><br>
+      #  To get the message details, use the [GET
+      #  /messages/{id}](/api-reference/messages/get) endpoint.
+      # @param media [String] URL of the media file.
+      # @param quick_replies [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::MessageEventRcsMediaContent]
+      def initialize(type:, id:, media:, quick_replies:, additional_properties: nil)
+        @type = type
+        @id = id
+        @media = media
+        @quick_replies = quick_replies
+        @additional_properties = additional_properties
+        @_field_set = { "type": type, "id": id, "media": media, "quickReplies": quick_replies }
+      end
+
+      # Deserialize a JSON object to an instance of MessageEventRcsMediaContent
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::MessageEventRcsMediaContent]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        type = parsed_json["type"]
+        id = parsed_json["id"]
+        media = parsed_json["media"]
+        quick_replies = parsed_json["quickReplies"]&.map do |item|
+          item = item.to_json
+          Pinnacle::Types::RichButton.from_json(json_object: item)
+        end
+        new(
+          type: type,
+          id: id,
+          media: media,
+          quick_replies: quick_replies,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of MessageEventRcsMediaContent 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.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+        obj.id.is_a?(String) != false || raise("Passed value for field obj.id 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.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/message_event_rcs_text_content.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require_relative "rich_button"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # RCS message containing longer text content with optional quick reply buttons.
+    class MessageEventRcsTextContent
+      # @return [String] Message type identifier.
+      attr_reader :type
+      # @return [String] Unique identifier of the message. This identifier is a string that always begins
+      #  with the prefix `msg_`, for example: `msg_1234567890`. <br><br>
+      #  To get the message details, use the [GET
+      #  /messages/{id}](/api-reference/messages/get) endpoint.
+      attr_reader :id
+      # @return [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message.
+      attr_reader :quick_replies
+      # @return [String] Text content of the RCS message.
+      attr_reader :text
+      # @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 type [String] Message type identifier.
+      # @param id [String] Unique identifier of the message. This identifier is a string that always begins
+      #  with the prefix `msg_`, for example: `msg_1234567890`. <br><br>
+      #  To get the message details, use the [GET
+      #  /messages/{id}](/api-reference/messages/get) endpoint.
+      # @param quick_replies [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message.
+      # @param text [String] Text content of the RCS message.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::MessageEventRcsTextContent]
+      def initialize(type:, id:, quick_replies:, text:, additional_properties: nil)
+        @type = type
+        @id = id
+        @quick_replies = quick_replies
+        @text = text
+        @additional_properties = additional_properties
+        @_field_set = { "type": type, "id": id, "quickReplies": quick_replies, "text": text }
+      end
+
+      # Deserialize a JSON object to an instance of MessageEventRcsTextContent
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::MessageEventRcsTextContent]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        type = parsed_json["type"]
+        id = parsed_json["id"]
+        quick_replies = parsed_json["quickReplies"]&.map do |item|
+          item = item.to_json
+          Pinnacle::Types::RichButton.from_json(json_object: item)
+        end
+        text = parsed_json["text"]
+        new(
+          type: type,
+          id: id,
+          quick_replies: quick_replies,
+          text: text,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of MessageEventRcsTextContent 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.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+        obj.id.is_a?(String) != false || raise("Passed value for field obj.id 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.text.is_a?(String) != false || raise("Passed value for field obj.text is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/message_event_sms_content.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # SMS message containing plain text only.
+    class MessageEventSmsContent
+      # @return [String] Message type identifier.
+      attr_reader :type
+      # @return [String] Unique identifier of the message. This identifier is a string that always begins
+      #  with the prefix `msg_`, for example: `msg_1234567890`. <br><br>
+      #  To get the message details, use the [GET
+      #  /messages/{id}](/api-reference/messages/get) endpoint.
+      attr_reader :id
+      # @return [String] Message content.
+      attr_reader :text
+      # @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 type [String] Message type identifier.
+      # @param id [String] Unique identifier of the message. This identifier is a string that always begins
+      #  with the prefix `msg_`, for example: `msg_1234567890`. <br><br>
+      #  To get the message details, use the [GET
+      #  /messages/{id}](/api-reference/messages/get) endpoint.
+      # @param text [String] Message content.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::MessageEventSmsContent]
+      def initialize(type:, id:, text:, additional_properties: nil)
+        @type = type
+        @id = id
+        @text = text
+        @additional_properties = additional_properties
+        @_field_set = { "type": type, "id": id, "text": text }
+      end
+
+      # Deserialize a JSON object to an instance of MessageEventSmsContent
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::MessageEventSmsContent]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        type = parsed_json["type"]
+        id = parsed_json["id"]
+        text = parsed_json["text"]
+        new(
+          type: type,
+          id: id,
+          text: text,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of MessageEventSmsContent 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.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+        obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+        obj.text.is_a?(String) != false || raise("Passed value for field obj.text is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/{retrieved_conversations.rb → message_list.rb}

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
 
-require_relative "conversation"
+require_relative "message_with_reaction"
 require "ostruct"
 require "json"
 
 module Pinnacle
   module Types
-    class RetrievedConversations
-      # @return [Integer] Total number of conversations matching the filter.
-      attr_reader :count
-      # @return [Array<Pinnacle::Types::Conversation>]
-      attr_reader :conversations
-      # @return [Boolean] Indicates if more conversations are available beyond the current page.
+    # Paginated list of messages in a conversation.
+    class MessageList
+      # @return [Array<Pinnacle::Types::MessageWithReaction>] Array of messages in the conversation.
+      attr_reader :messages
+      # @return [Boolean] Indicates if more messages are available beyond the current page.
       attr_reader :has_more
+      # @return [Integer] Total number of messages in the conversation.
+      attr_reader :count
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
       # @return [Object]
@@ -21,41 +22,41 @@ module Pinnacle
 
       OMIT = Object.new
 
-      # @param count [Integer] Total number of conversations matching the filter.
-      # @param conversations [Array<Pinnacle::Types::Conversation>]
-      # @param has_more [Boolean] Indicates if more conversations are available beyond the current page.
+      # @param messages [Array<Pinnacle::Types::MessageWithReaction>] Array of messages in the conversation.
+      # @param has_more [Boolean] Indicates if more messages are available beyond the current page.
+      # @param count [Integer] Total number of messages in the conversation.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::RetrievedConversations]
-      def initialize(count:, conversations:, has_more:, additional_properties: nil)
-        @count = count
-        @conversations = conversations
+      # @return [Pinnacle::Types::MessageList]
+      def initialize(messages:, has_more:, count:, additional_properties: nil)
+        @messages = messages
         @has_more = has_more
+        @count = count
         @additional_properties = additional_properties
-        @_field_set = { "count": count, "conversations": conversations, "hasMore": has_more }
+        @_field_set = { "messages": messages, "hasMore": has_more, "count": count }
       end
 
-      # Deserialize a JSON object to an instance of RetrievedConversations
+      # Deserialize a JSON object to an instance of MessageList
       #
       # @param json_object [String]
-      # @return [Pinnacle::Types::RetrievedConversations]
+      # @return [Pinnacle::Types::MessageList]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
-        count = parsed_json["count"]
-        conversations = parsed_json["conversations"]&.map do |item|
+        messages = parsed_json["messages"]&.map do |item|
           item = item.to_json
-          Pinnacle::Types::Conversation.from_json(json_object: item)
+          Pinnacle::Types::MessageWithReaction.from_json(json_object: item)
         end
         has_more = parsed_json["hasMore"]
+        count = parsed_json["count"]
         new(
-          count: count,
-          conversations: conversations,
+          messages: messages,
           has_more: has_more,
+          count: count,
           additional_properties: struct
         )
       end
 
-      # Serialize an instance of RetrievedConversations to a JSON object
+      # Serialize an instance of MessageList to a JSON object
       #
       # @return [String]
       def to_json(*_args)
@@ -69,9 +70,9 @@ module Pinnacle
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.count.is_a?(Integer) != false || raise("Passed value for field obj.count is not the expected type, validation failed.")
-        obj.conversations.is_a?(Array) != false || raise("Passed value for field obj.conversations is not the expected type, validation failed.")
+        obj.messages.is_a?(Array) != false || raise("Passed value for field obj.messages is not the expected type, validation failed.")
         obj.has_more.is_a?(Boolean) != false || raise("Passed value for field obj.has_more is not the expected type, validation failed.")
+        obj.count.is_a?(Integer) != false || raise("Passed value for field obj.count is not the expected type, validation failed.")
       end
     end
   end