rcs 2.0.0.pre.rc.4 → 2.0.0

data/lib/rcs/types/message_event_content.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "message_event_sms_content"
+require_relative "message_event_mms_content"
+require_relative "message_event_rcs_text_content"
+require_relative "message_event_rcs_media_content"
+require_relative "message_event_rcs_cards_content"
+require_relative "message_event_rcs_button_data"
+require_relative "message_event_rcs_location_data"
+
+module Pinnacle
+  module Types
+    # Content of an incoming or outgoing message. Discriminated by the `type` field.
+    class MessageEventContent
+      # Deserialize a JSON object to an instance of MessageEventContent
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::MessageEventContent]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        begin
+          Pinnacle::Types::MessageEventSmsContent.validate_raw(obj: struct)
+          return Pinnacle::Types::MessageEventSmsContent.from_json(json_object: struct) unless struct.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        begin
+          Pinnacle::Types::MessageEventMmsContent.validate_raw(obj: struct)
+          return Pinnacle::Types::MessageEventMmsContent.from_json(json_object: struct) unless struct.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        begin
+          Pinnacle::Types::MessageEventRcsTextContent.validate_raw(obj: struct)
+          return Pinnacle::Types::MessageEventRcsTextContent.from_json(json_object: struct) unless struct.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        begin
+          Pinnacle::Types::MessageEventRcsMediaContent.validate_raw(obj: struct)
+          return Pinnacle::Types::MessageEventRcsMediaContent.from_json(json_object: struct) unless struct.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        begin
+          Pinnacle::Types::MessageEventRcsCardsContent.validate_raw(obj: struct)
+          return Pinnacle::Types::MessageEventRcsCardsContent.from_json(json_object: struct) unless struct.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        begin
+          Pinnacle::Types::MessageEventRcsButtonData.validate_raw(obj: struct)
+          return Pinnacle::Types::MessageEventRcsButtonData.from_json(json_object: struct) unless struct.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        begin
+          Pinnacle::Types::MessageEventRcsLocationData.validate_raw(obj: struct)
+          return Pinnacle::Types::MessageEventRcsLocationData.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::MessageEventSmsContent.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return Pinnacle::Types::MessageEventMmsContent.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return Pinnacle::Types::MessageEventRcsTextContent.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return Pinnacle::Types::MessageEventRcsMediaContent.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return Pinnacle::Types::MessageEventRcsCardsContent.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return Pinnacle::Types::MessageEventRcsButtonData.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return Pinnacle::Types::MessageEventRcsLocationData.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/message_event_conversation.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Conversation metadata containing the conversation ID, sender, and recipient
+    #  information.
+    class MessageEventConversation
+      # @return [String] Unique identifier for the conversation. This identifier is a string that always
+      #  begins with the prefix `conv_`, for example: `conv_1234567890`. <br><br>
+      #  To get more conversation details, use the [POST
+      #  /conversations/get](/api-reference/conversations/get) endpoint.
+      attr_reader :id
+      # @return [String] Sender's phone number or agent ID.
+      attr_reader :from
+      # @return [String] Recipient's phone number.
+      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 id [String] Unique identifier for the conversation. This identifier is a string that always
+      #  begins with the prefix `conv_`, for example: `conv_1234567890`. <br><br>
+      #  To get more conversation details, use the [POST
+      #  /conversations/get](/api-reference/conversations/get) endpoint.
+      # @param from [String] Sender's phone number or agent ID.
+      # @param to [String] Recipient's phone number.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::MessageEventConversation]
+      def initialize(id:, from:, to:, additional_properties: nil)
+        @id = id
+        @from = from
+        @to = to
+        @additional_properties = additional_properties
+        @_field_set = { "id": id, "from": from, "to": to }
+      end
+
+      # Deserialize a JSON object to an instance of MessageEventConversation
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::MessageEventConversation]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        id = parsed_json["id"]
+        from = parsed_json["from"]
+        to = parsed_json["to"]
+        new(
+          id: id,
+          from: from,
+          to: to,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of MessageEventConversation 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.id.is_a?(String) != false || raise("Passed value for field obj.id 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.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/message_event_direction.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Direction of the message flow.
+    class MessageEventDirection
+      INBOUND = "INBOUND"
+      OUTBOUND = "OUTBOUND"
+    end
+  end
+end

data/lib/rcs/types/message_event_mms_content.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # MMS message with text and/or media files from a phone number.
+    class MessageEventMmsContent
+      # @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<String>] URLs of media files in this message. <br>
+      #  See [supported media
+      #  types](https://app.pinnacle.sh/supported-file-types?type=MMS).
+      attr_reader :media_urls
+      # @return [String] Text content that may accompany the media files.
+      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 media_urls [Array<String>] URLs of media files in this message. <br>
+      #  See [supported media
+      #  types](https://app.pinnacle.sh/supported-file-types?type=MMS).
+      # @param text [String] Text content that may accompany the media files.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::MessageEventMmsContent]
+      def initialize(type:, id:, media_urls:, text: OMIT, additional_properties: nil)
+        @type = type
+        @id = id
+        @media_urls = media_urls
+        @text = text if text != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "type": type, "id": id, "mediaUrls": media_urls, "text": text }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of MessageEventMmsContent
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::MessageEventMmsContent]
+      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_urls = parsed_json["mediaUrls"]
+        text = parsed_json["text"]
+        new(
+          type: type,
+          id: id,
+          media_urls: media_urls,
+          text: text,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of MessageEventMmsContent 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_urls.is_a?(Array) != false || raise("Passed value for field obj.media_urls 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_rcs_button_data.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require_relative "button_clicked_data_button"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Button click event data received when a user clicks on an RCS button or quick
+    #  reply (excluding `requestUserLocation` buttons).
+    #  This event contains information about which button was clicked, how many times
+    #  it's been clicked, and any payload or metadata attached to the button. Use this
+    #  data to handle user interactions with your RCS messages.
+    class MessageEventRcsButtonData
+      # @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::ButtonClickedDataButton] Information about the button that was clicked.
+      attr_reader :button
+      # @return [String] ID of the message this button was sent in, or null if not available. To get the
+      #  message details, use the [GET /messages/{id}](/api-reference/messages/get)
+      #  endpoint.
+      attr_reader :message_id
+      # @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 button [Pinnacle::Types::ButtonClickedDataButton] Information about the button that was clicked.
+      # @param message_id [String] ID of the message this button was sent in, or null if not available. To get the
+      #  message details, use the [GET /messages/{id}](/api-reference/messages/get)
+      #  endpoint.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::MessageEventRcsButtonData]
+      def initialize(type:, id:, button:, message_id: OMIT, additional_properties: nil)
+        @type = type
+        @id = id
+        @button = button
+        @message_id = message_id if message_id != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "type": type, "id": id, "button": button, "messageId": message_id }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of MessageEventRcsButtonData
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::MessageEventRcsButtonData]
+      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["button"].nil?
+          button = nil
+        else
+          button = parsed_json["button"].to_json
+          button = Pinnacle::Types::ButtonClickedDataButton.from_json(json_object: button)
+        end
+        message_id = parsed_json["messageId"]
+        new(
+          type: type,
+          id: id,
+          button: button,
+          message_id: message_id,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of MessageEventRcsButtonData 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::ButtonClickedDataButton.validate_raw(obj: obj.button)
+        obj.message_id&.is_a?(String) != false || raise("Passed value for field obj.message_id is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/message_event_rcs_cards_content.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require_relative "message_event_rcs_cards_content_cards_item"
+require_relative "rich_button"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # RCS 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 MessageEventRcsCardsContent
+      # @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::MessageEventRcsCardsContentCardsItem>] Collection of cards attached to the message.
+      attr_reader :cards
+      # @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 cards [Array<Pinnacle::Types::MessageEventRcsCardsContentCardsItem>] Collection of cards attached to the message.
+      # @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::MessageEventRcsCardsContent]
+      def initialize(type:, id:, cards:, quick_replies:, additional_properties: nil)
+        @type = type
+        @id = id
+        @cards = cards
+        @quick_replies = quick_replies
+        @additional_properties = additional_properties
+        @_field_set = { "type": type, "id": id, "cards": cards, "quickReplies": quick_replies }
+      end
+
+      # Deserialize a JSON object to an instance of MessageEventRcsCardsContent
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::MessageEventRcsCardsContent]
+      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"]
+        cards = parsed_json["cards"]&.map do |item|
+          item = item.to_json
+          Pinnacle::Types::MessageEventRcsCardsContentCardsItem.from_json(json_object: item)
+        end
+        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,
+          cards: cards,
+          quick_replies: quick_replies,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of MessageEventRcsCardsContent 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.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/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