rcs 1.0.17 → 2.0.0.pre.rc.1

data/lib/rcs/types/rcs_text.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require_relative "rcs_base_options"
+require_relative "rcs_button_content"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class RcsText
+      # @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 [Array<Pinnacle::Types::RcsButtonContent>] 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 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 quick_replies [Array<Pinnacle::Types::RcsButtonContent>] 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::RcsText]
+      def initialize(from:, to:, quick_replies:, text:, options: OMIT, additional_properties: nil)
+        @from = from
+        @options = options if options != OMIT
+        @to = to
+        @quick_replies = quick_replies
+        @text = text
+        @additional_properties = additional_properties
+        @_field_set = {
+          "from": from,
+          "options": options,
+          "to": to,
+          "quickReplies": quick_replies,
+          "text": text
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of RcsText
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::RcsText]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        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"]
+        quick_replies = parsed_json["quickReplies"]&.map do |item|
+          item = item.to_json
+          Pinnacle::Types::RcsButtonContent.from_json(json_object: item)
+        end
+        text = parsed_json["text"]
+        new(
+          from: from,
+          options: options,
+          to: to,
+          quick_replies: quick_replies,
+          text: text,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of RcsText 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.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.")
+        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/rcs_text_content.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative "rcs_button_content"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Message containing longer text content with optional quick reply buttons.
+    class RcsTextContent
+      # @return [Array<Pinnacle::Types::RcsButtonContent>] 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 quick_replies [Array<Pinnacle::Types::RcsButtonContent>] 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::RcsTextContent]
+      def initialize(quick_replies:, text:, additional_properties: nil)
+        @quick_replies = quick_replies
+        @text = text
+        @additional_properties = additional_properties
+        @_field_set = { "quickReplies": quick_replies, "text": text }
+      end
+
+      # Deserialize a JSON object to an instance of RcsTextContent
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::RcsTextContent]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        quick_replies = parsed_json["quickReplies"]&.map do |item|
+          item = item.to_json
+          Pinnacle::Types::RcsButtonContent.from_json(json_object: item)
+        end
+        text = parsed_json["text"]
+        new(
+          quick_replies: quick_replies,
+          text: text,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of RcsTextContent 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.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/rcs_validate_content.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "rcs_text_content"
+require_relative "rcs_validate_content_media"
+require_relative "rcs_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::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::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::RcsCards.validate_raw(obj: struct)
+          return Pinnacle::Types::RcsCards.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::RcsValidateContentMedia.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return Pinnacle::Types::RcsCards.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/{company/types/company_register_response.rb → types/rcs_validate_content_media.rb}

@@ -1,14 +1,17 @@
 # frozen_string_literal: true
 
-require_relative "company_register_response_brand"
 require "ostruct"
 require "json"
 
 module Pinnacle
-  class Company
-    class CompanyRegisterResponse
-      # @return [Pinnacle::Company::CompanyRegisterResponseBrand]
-      attr_reader :brand
+  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 [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
       # @return [Object]
@@ -17,32 +20,27 @@ module Pinnacle
 
       OMIT = Object.new
 
-      # @param brand [Pinnacle::Company::CompanyRegisterResponseBrand]
+      # @param media [String] Media file URLs to send.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Company::CompanyRegisterResponse]
-      def initialize(brand:, additional_properties: nil)
-        @brand = brand
+      # @return [Pinnacle::Types::RcsValidateContentMedia]
+      def initialize(media:, additional_properties: nil)
+        @media = media
         @additional_properties = additional_properties
-        @_field_set = { "brand": brand }
+        @_field_set = { "media": media }
       end
 
-      # Deserialize a JSON object to an instance of CompanyRegisterResponse
+      # Deserialize a JSON object to an instance of RcsValidateContentMedia
       #
       # @param json_object [String]
-      # @return [Pinnacle::Company::CompanyRegisterResponse]
+      # @return [Pinnacle::Types::RcsValidateContentMedia]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
-        if parsed_json["brand"].nil?
-          brand = nil
-        else
-          brand = parsed_json["brand"].to_json
-          brand = Pinnacle::Company::CompanyRegisterResponseBrand.from_json(json_object: brand)
-        end
-        new(brand: brand, additional_properties: struct)
+        media = parsed_json["media"]
+        new(media: media, additional_properties: struct)
       end
 
-      # Serialize an instance of CompanyRegisterResponse to a JSON object
+      # Serialize an instance of RcsValidateContentMedia to a JSON object
       #
       # @return [String]
       def to_json(*_args)
@@ -56,7 +54,7 @@ module Pinnacle
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        Pinnacle::Company::CompanyRegisterResponseBrand.validate_raw(obj: obj.brand)
+        obj.media.is_a?(String) != false || raise("Passed value for field obj.media is not the expected type, validation failed.")
       end
     end
   end

data/lib/rcs/types/rcs_validation_result.rb

@@ -0,0 +1,76 @@
+# 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 [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 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:, unsupported_files:, additional_properties: nil)
+        @total = total
+        @unit = unit
+        @unsupported_files = unsupported_files
+        @additional_properties = additional_properties
+        @_field_set = { "total": total, "unit": unit, "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"]
+        unsupported_files = parsed_json["unsupportedFiles"]
+        new(
+          total: total,
+          unit: unit,
+          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.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

data/lib/rcs/types/reaction_result.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class ReactionResult
+      # @return [Integer] ID of the message.
+      attr_reader :message_id
+      # @return [Integer] Unique identifier for the reaction.
+      attr_reader :reaction_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 message_id [Integer] ID of the message.
+      # @param reaction_message_id [Integer] Unique identifier for the reaction.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::ReactionResult]
+      def initialize(message_id:, reaction_message_id:, additional_properties: nil)
+        @message_id = message_id
+        @reaction_message_id = reaction_message_id
+        @additional_properties = additional_properties
+        @_field_set = { "messageId": message_id, "reactionMessageId": reaction_message_id }
+      end
+
+      # Deserialize a JSON object to an instance of ReactionResult
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::ReactionResult]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        message_id = parsed_json["messageId"]
+        reaction_message_id = parsed_json["reactionMessageId"]
+        new(
+          message_id: message_id,
+          reaction_message_id: reaction_message_id,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of ReactionResult 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.message_id.is_a?(Integer) != false || raise("Passed value for field obj.message_id is not the expected type, validation failed.")
+        obj.reaction_message_id.is_a?(Integer) != false || raise("Passed value for field obj.reaction_message_id is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/scheduled_messaage.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative "scheduled_send_response_config"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class ScheduledMessaage
+      # @return [Integer] Unique identifier for the scheduled send.
+      attr_reader :schedule_id
+      # @return [Pinnacle::Types::ScheduledSendResponseConfig] Configuration for the scheduled message.
+      attr_reader :config
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param schedule_id [Integer] Unique identifier for the scheduled send.
+      # @param config [Pinnacle::Types::ScheduledSendResponseConfig] Configuration for the scheduled message.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::ScheduledMessaage]
+      def initialize(schedule_id:, config:, additional_properties: nil)
+        @schedule_id = schedule_id
+        @config = config
+        @additional_properties = additional_properties
+        @_field_set = { "scheduleId": schedule_id, "config": config }
+      end
+
+      # Deserialize a JSON object to an instance of ScheduledMessaage
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::ScheduledMessaage]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        schedule_id = parsed_json["scheduleId"]
+        if parsed_json["config"].nil?
+          config = nil
+        else
+          config = parsed_json["config"].to_json
+          config = Pinnacle::Types::ScheduledSendResponseConfig.from_json(json_object: config)
+        end
+        new(
+          schedule_id: schedule_id,
+          config: config,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of ScheduledMessaage to a JSON object
+      #
+      # @return [String]
+      def to_json(*_args)
+        @_field_set&.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.schedule_id.is_a?(Integer) != false || raise("Passed value for field obj.schedule_id is not the expected type, validation failed.")
+        Pinnacle::Types::ScheduledSendResponseConfig.validate_raw(obj: obj.config)
+      end
+    end
+  end
+end

data/lib/rcs/types/scheduled_send_response_config.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Configuration for the scheduled message.
+    class ScheduledSendResponseConfig
+      # @return [String] When the message will be sent in ISO 8601 format.
+      attr_reader :send_at
+      # @return [String] AWS cron expression used for recurring messages.
+      attr_reader :recurrence
+      # @return [String] IANA timezone identifier.
+      attr_reader :timezone
+      # @return [String] When the recurring messages stops in ISO 8601 format.
+      attr_reader :end_date
+      # @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 send_at [String] When the message will be sent in ISO 8601 format.
+      # @param recurrence [String] AWS cron expression used for recurring messages.
+      # @param timezone [String] IANA timezone identifier.
+      # @param end_date [String] When the recurring messages stops in ISO 8601 format.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::ScheduledSendResponseConfig]
+      def initialize(send_at:, timezone:, recurrence: OMIT, end_date: OMIT, additional_properties: nil)
+        @send_at = send_at
+        @recurrence = recurrence if recurrence != OMIT
+        @timezone = timezone
+        @end_date = end_date if end_date != OMIT
+        @additional_properties = additional_properties
+        @_field_set = {
+          "sendAt": send_at,
+          "recurrence": recurrence,
+          "timezone": timezone,
+          "endDate": end_date
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of ScheduledSendResponseConfig
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::ScheduledSendResponseConfig]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        send_at = parsed_json["sendAt"]
+        recurrence = parsed_json["recurrence"]
+        timezone = parsed_json["timezone"]
+        end_date = parsed_json["endDate"]
+        new(
+          send_at: send_at,
+          recurrence: recurrence,
+          timezone: timezone,
+          end_date: end_date,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of ScheduledSendResponseConfig 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.send_at.is_a?(String) != false || raise("Passed value for field obj.send_at is not the expected type, validation failed.")
+        obj.recurrence&.is_a?(String) != false || raise("Passed value for field obj.recurrence is not the expected type, validation failed.")
+        obj.timezone.is_a?(String) != false || raise("Passed value for field obj.timezone is not the expected type, validation failed.")
+        obj.end_date&.is_a?(String) != false || raise("Passed value for field obj.end_date is not the expected type, validation failed.")
+      end
+    end
+  end
+end