rcs 2.0.3 → 2.0.5.pre.rc.1

data/lib/rcs/types/rcs_cards_content_cards_item.rb

@@ -1,96 +0,0 @@
-# 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 RcsCardsContentCardsItem
-      # @return [Array<Pinnacle::Types::RichButton>] While buttons resemble quick replies, they remain on screen after being clicked
-      #  and are card-specific.
-      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>] While buttons resemble quick replies, they remain on screen after being clicked
-      #  and are card-specific.
-      # @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::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 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

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-require_relative "rich_text"
-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::RichText.validate_raw(obj: struct)
-          return Pinnacle::Types::RichText.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::RichText.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_link_result.rb

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Types
-    # Response containing the generated RCS service id and/or url. You can always
-    #  create a link with the service id that is returned.
-    #  To create a link follow the format:
-    #  sms://{PHONE_NUMBER}?service_id={SERVICE_ID}&body={URL_ENCODED_BODY}
-    class RcsLinkResult
-      # @return [String] The generated RCS link URL. If no phone number is provided, no url will be
-      #  generated.
-      attr_reader :url
-      # @return [String] The service ID used for the link
-      attr_reader :service_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 url [String] The generated RCS link URL. If no phone number is provided, no url will be
-      #  generated.
-      # @param service_id [String] The service ID used for the link
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::RcsLinkResult]
-      def initialize(service_id:, url: OMIT, additional_properties: nil)
-        @url = url if url != OMIT
-        @service_id = service_id
-        @additional_properties = additional_properties
-        @_field_set = { "url": url, "serviceId": service_id }.reject do |_k, v|
-          v == OMIT
-        end
-      end
-
-      # Deserialize a JSON object to an instance of RcsLinkResult
-      #
-      # @param json_object [String]
-      # @return [Pinnacle::Types::RcsLinkResult]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        url = parsed_json["url"]
-        service_id = parsed_json["serviceId"]
-        new(
-          url: url,
-          service_id: service_id,
-          additional_properties: struct
-        )
-      end
-
-      # Serialize an instance of RcsLinkResult 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.url&.is_a?(String) != false || raise("Passed value for field obj.url is not the expected type, validation failed.")
-        obj.service_id.is_a?(String) != false || raise("Passed value for field obj.service_id is not the expected type, validation failed.")
-      end
-    end
-  end
-end

data/lib/rcs/types/rcs_media_content.rb

@@ -1,81 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "rcs_media_details_content"
-require_relative "rich_button"
-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::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 media [Pinnacle::Types::RcsMediaDetailsContent]
-      # @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::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::RichButton.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

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

data/lib/rcs/types/rcs_messaging_type_enum.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Pinnacle
-  module Types
-    # Type of message the agent sends.<br>
-    #  `OTP`: One time passwords or verification codes. <br>
-    #  `TRANSACTIONAL`: Account updates, alerts, or notifications.<br>
-    #  `PROMOTIONAL`: Marketing, sales, or offers.<br>
-    #  `MULTI_USE`: Mixed message types.<br>
-    class RcsMessagingTypeEnum
-      OTP = "OTP"
-      TRANSACTIONAL = "TRANSACTIONAL"
-      PROMOTIONAL = "PROMOTIONAL"
-      MULTI_USE = "MULTI_USE"
-    end
-  end
-end

data/lib/rcs/types/rcs_validate_content.rb

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-require_relative "rich_text"
-require_relative "rcs_validate_content_media"
-require_relative "rich_cards"
-
-module Pinnacle
-  module Types
-    class RcsValidateContent
-      # Deserialize a JSON object to an instance of RcsValidateContent
-      #
-      # @param json_object [String]
-      # @return [Pinnacle::Types::RcsValidateContent]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        begin
-          Pinnacle::Types::RichText.validate_raw(obj: struct)
-          return Pinnacle::Types::RichText.from_json(json_object: struct) unless struct.nil?
-
-          return nil
-        rescue StandardError
-          # noop
-        end
-        begin
-          Pinnacle::Types::RcsValidateContentMedia.validate_raw(obj: struct)
-          return Pinnacle::Types::RcsValidateContentMedia.from_json(json_object: struct) unless struct.nil?
-
-          return nil
-        rescue StandardError
-          # noop
-        end
-        begin
-          Pinnacle::Types::RichCards.validate_raw(obj: struct)
-          return Pinnacle::Types::RichCards.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::RichText.validate_raw(obj: obj)
-        rescue StandardError
-          # noop
-        end
-        begin
-          return Pinnacle::Types::RcsValidateContentMedia.validate_raw(obj: obj)
-        rescue StandardError
-          # noop
-        end
-        begin
-          return Pinnacle::Types::RichCards.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_validate_content_media.rb

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "rich_button"
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Types
-    # Message containing a media file and/or text with optional quick reply
-    #  buttons.<br>
-    #  See [supported media
-    #  types](https://app.pinnacle.sh/supported-file-types?type=RCS-MEDIA).
-    class RcsValidateContentMedia
-      # @return [String] Media file URLs to send.
-      attr_reader :media
-      # @return [Array<Pinnacle::Types::RichButton>]
-      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 [String] Media file URLs to send.
-      # @param quick_replies [Array<Pinnacle::Types::RichButton>]
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::RcsValidateContentMedia]
-      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 RcsValidateContentMedia
-      #
-      # @param json_object [String]
-      # @return [Pinnacle::Types::RcsValidateContentMedia]
-      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::RichButton.from_json(json_object: item)
-        end
-        new(
-          media: media,
-          quick_replies: quick_replies,
-          additional_properties: struct
-        )
-      end
-
-      # Serialize an instance of RcsValidateContentMedia 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.")
-      end
-    end
-  end
-end

data/lib/rcs/types/rcs_validation_result.rb

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Types
-    class RcsValidationResult
-      # @return [Float] Total price of this message. Calculated by multiplying the number of messages by
-      #  the unit cost.
-      attr_reader :total
-      # @return [Float] Cost per message.
-      attr_reader :unit
-      # @return [Integer] Total number of segments used across the message.
-      attr_reader :segments
-      # @return [Array<String>] List of unsupported media file names or URLs.
-      attr_reader :unsupported_files
-      # @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 total [Float] Total price of this message. Calculated by multiplying the number of messages by
-      #  the unit cost.
-      # @param unit [Float] Cost per message.
-      # @param segments [Integer] Total number of segments used across the message.
-      # @param unsupported_files [Array<String>] List of unsupported media file names or URLs.
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::RcsValidationResult]
-      def initialize(total:, unit:, segments:, unsupported_files:, additional_properties: nil)
-        @total = total
-        @unit = unit
-        @segments = segments
-        @unsupported_files = unsupported_files
-        @additional_properties = additional_properties
-        @_field_set = { "total": total, "unit": unit, "segments": segments, "unsupportedFiles": unsupported_files }
-      end
-
-      # Deserialize a JSON object to an instance of RcsValidationResult
-      #
-      # @param json_object [String]
-      # @return [Pinnacle::Types::RcsValidationResult]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        total = parsed_json["total"]
-        unit = parsed_json["unit"]
-        segments = parsed_json["segments"]
-        unsupported_files = parsed_json["unsupportedFiles"]
-        new(
-          total: total,
-          unit: unit,
-          segments: segments,
-          unsupported_files: unsupported_files,
-          additional_properties: struct
-        )
-      end
-
-      # Serialize an instance of RcsValidationResult 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.total.is_a?(Float) != false || raise("Passed value for field obj.total is not the expected type, validation failed.")
-        obj.unit.is_a?(Float) != false || raise("Passed value for field obj.unit is not the expected type, validation failed.")
-        obj.segments.is_a?(Integer) != false || raise("Passed value for field obj.segments is not the expected type, validation failed.")
-        obj.unsupported_files.is_a?(Array) != false || raise("Passed value for field obj.unsupported_files is not the expected type, validation failed.")
-      end
-    end
-  end
-end