sunshine-conversations-client 16.0.1 → 17.0.0

data/lib/sunshine-conversations-client/models/content.rb

@@ -1,516 +1,66 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 16.0.1
+The version of the OpenAPI document: 17.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
+OpenAPI Generator version: 7.12.0
 =end
 
 require 'date'
+require 'time'
 
 module SunshineConversationsClient
-  class Content
-    # The type of message.
-    attr_accessor :type
-
-    # The fallback text message used when location messages are not supported by the channel.
-    attr_accessor :text
-
-    # HTML text content of the message. Can be provided in place of `text`. Cannot be used with `markdownText`. If no `text` is provided, will be converted to `text` upon reception to be displayed on channels that do not support rich text. See [rich text](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/structured-messages/#rich-text) documentation for more information.
-    attr_accessor :html_text
-
-    # When set to true, the chat input will be disabled on supported client implementations when the message is the most recent one in the history. Can be used for guided flows or to temporarily disable the user's ability to send messages in the conversation.
-    attr_accessor :block_chat_input
-
-    # Markdown text content of the message. Can be provided in place of `text`. Cannot be used with `htmlText`. Will be converted to `htmlText` upon reception. If converted `htmlText` exceeds 4096 characters, the message will be rejected. If no `text` is provided, will be converted to `text` upon reception to be displayed on channels that do not support rich text. See [rich text](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/structured-messages/#rich-text) documentation for more information.
-    attr_accessor :markdown_text
-
-    # An array of objects representing the actions associated with the message. The array length is limited by the third party channel.
-    attr_accessor :actions
-
-    # The payload of a [reply button](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/structured-messages/#reply-buttons) response message.
-    attr_accessor :payload
-
-    # An array of objects representing the items associated with the message. Only present in carousel and list type messages.
-    attr_accessor :items
-
-    attr_accessor :display_settings
-
-    # The URL for media, such as an image, attached to the message. <aside class=\"notice\"><strong>Note:</strong> An authorization header is required to access the mediaUrl when private attachments are enabled. See [configuring private attachments for messaging](https://developer.zendesk.com/documentation/zendesk-web-widget-sdks/messaging_private_attachments/) guide for more details.</aside> 
-    attr_accessor :media_url
-
-    # The size of the media in bytes.
-    attr_accessor :media_size
-
-    # The type of media.
-    attr_accessor :media_type
-
-    # An optional description of the image for accessibility purposes. The field will be saved by default with the file name as the value.
-    attr_accessor :alt_text
-
-    # An identifier used by Sunshine Conversations for internal purposes.
-    attr_accessor :attachment_id
-
-    # Flag which states whether the form is submitted.
-    attr_accessor :submitted
-
-    # Array of field objects that contain the submitted fields.
-    attr_accessor :fields
-
-    # A string containing the `label: value` of all fields, each separated by a newline character.
-    attr_accessor :text_fallback
-
-    attr_accessor :coordinates
-
-    attr_accessor :location
-
-    # The whatsapp template message to send. For more information, consult the [guide](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/message-overrides/#template-messages). `schema` must be set to `whatsapp`.
-    attr_accessor :template
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'type' => :'type',
-        :'text' => :'text',
-        :'html_text' => :'htmlText',
-        :'block_chat_input' => :'blockChatInput',
-        :'markdown_text' => :'markdownText',
-        :'actions' => :'actions',
-        :'payload' => :'payload',
-        :'items' => :'items',
-        :'display_settings' => :'displaySettings',
-        :'media_url' => :'mediaUrl',
-        :'media_size' => :'mediaSize',
-        :'media_type' => :'mediaType',
-        :'alt_text' => :'altText',
-        :'attachment_id' => :'attachmentId',
-        :'submitted' => :'submitted',
-        :'fields' => :'fields',
-        :'text_fallback' => :'textFallback',
-        :'coordinates' => :'coordinates',
-        :'location' => :'location',
-        :'template' => :'template'
-      }
-    end
-
-    # Attribute type mapping.
-    def self.openapi_types
-      {
-        :'type' => :'String',
-        :'text' => :'String',
-        :'html_text' => :'String',
-        :'block_chat_input' => :'Boolean',
-        :'markdown_text' => :'String',
-        :'actions' => :'Array<ActionSubset>',
-        :'payload' => :'String',
-        :'items' => :'Array<Item>',
-        :'display_settings' => :'CarouselMessageDisplaySettings',
-        :'media_url' => :'String',
-        :'media_size' => :'Float',
-        :'media_type' => :'String',
-        :'alt_text' => :'String',
-        :'attachment_id' => :'String',
-        :'submitted' => :'Boolean',
-        :'fields' => :'Array<FormResponseMessageField>',
-        :'text_fallback' => :'String',
-        :'coordinates' => :'LocationMessageCoordinates',
-        :'location' => :'LocationMessageLocation',
-        :'template' => :'Object'
-      }
-    end
-
-    # List of attributes with nullable: true
-    def self.openapi_nullable
-      Set.new([
-      ])
-    end
-
-    # List of class defined in oneOf (OpenAPI v3)
-    def self.openapi_one_of
-      [
-      :'CarouselMessage',
-      :'FileMessage',
-      :'FormMessage',
-      :'FormResponseMessage',
-      :'ImageMessage',
-      :'ListMessage',
-      :'LocationMessage',
-      :'TemplateMessage',
-      :'TextMessage'
-      ]
-    end
-
-    # discriminator's property name in OpenAPI v3
-    def self.openapi_discriminator_name
-      :'type'
-    end
-
-    # Initializes the object
-    # @param [Hash] attributes Model attributes in the form of hash
-    def initialize(attributes = {})
-      if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `SunshineConversationsClient::Content` initialize method"
-      end
-
-      # check to see if the attribute exists and convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h|
-        if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `SunshineConversationsClient::Content`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
-        end
-        h[k.to_sym] = v
-      }
-
-      if attributes.key?(:'type')
-        self.type = attributes[:'type']
-      else
-        self.type = 'template'
-      end
-
-      if attributes.key?(:'text')
-        self.text = attributes[:'text']
-      end
-
-      if attributes.key?(:'html_text')
-        self.html_text = attributes[:'html_text']
-      end
-
-      if attributes.key?(:'block_chat_input')
-        self.block_chat_input = attributes[:'block_chat_input']
-      end
-
-      if attributes.key?(:'markdown_text')
-        self.markdown_text = attributes[:'markdown_text']
-      end
-
-      if attributes.key?(:'actions')
-      end
-
-      if attributes.key?(:'payload')
-        self.payload = attributes[:'payload']
-      end
-
-      if attributes.key?(:'items')
-      end
-
-      if attributes.key?(:'display_settings')
-        self.display_settings = attributes[:'display_settings']
-      end
-
-      if attributes.key?(:'media_url')
-        self.media_url = attributes[:'media_url']
-      end
-
-      if attributes.key?(:'media_size')
-        self.media_size = attributes[:'media_size']
-      end
-
-      if attributes.key?(:'media_type')
-        self.media_type = attributes[:'media_type']
-      end
-
-      if attributes.key?(:'alt_text')
-        self.alt_text = attributes[:'alt_text']
-      end
-
-      if attributes.key?(:'attachment_id')
-        self.attachment_id = attributes[:'attachment_id']
-      end
-
-      if attributes.key?(:'submitted')
-        self.submitted = attributes[:'submitted']
-      end
-
-      if attributes.key?(:'fields')
-      end
-
-      if attributes.key?(:'text_fallback')
-        self.text_fallback = attributes[:'text_fallback']
-      end
-
-      if attributes.key?(:'coordinates')
-        self.coordinates = attributes[:'coordinates']
-      end
-
-      if attributes.key?(:'location')
-        self.location = attributes[:'location']
-      end
-
-      if attributes.key?(:'template')
-        self.template = attributes[:'template']
-      end
-    end
-
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    def list_invalid_properties
-      invalid_properties = Array.new
-      if @type.nil?
-        invalid_properties.push('invalid value for "type", type cannot be nil.')
-      end
-
-      if !@html_text.nil? && @html_text.to_s.length > 4096
-        invalid_properties.push('invalid value for "html_text", the character length must be smaller than or equal to 4096.')
-      end
-
-      if !@markdown_text.nil? && @markdown_text.to_s.length > 4096
-        invalid_properties.push('invalid value for "markdown_text", the character length must be smaller than or equal to 4096.')
-      end
-
-      if @items.nil?
-        invalid_properties.push('invalid value for "items", items cannot be nil.')
-      end
-
-      if @media_url.nil?
-        invalid_properties.push('invalid value for "media_url", media_url cannot be nil.')
-      end
-
-      if !@media_type.nil? && @media_type.to_s.length > 128
-        invalid_properties.push('invalid value for "media_type", the character length must be smaller than or equal to 128.')
-      end
-
-      if !@alt_text.nil? && @alt_text.to_s.length > 128
-        invalid_properties.push('invalid value for "alt_text", the character length must be smaller than or equal to 128.')
-      end
-
-      if @fields.nil?
-        invalid_properties.push('invalid value for "fields", fields cannot be nil.')
-      end
-
-      if @coordinates.nil?
-        invalid_properties.push('invalid value for "coordinates", coordinates cannot be nil.')
-      end
-
-      if @template.nil?
-        invalid_properties.push('invalid value for "template", template cannot be nil.')
-      end
-
-      invalid_properties
-    end
-
-    # Check to see if the all the properties in the model are valid
-    # @return true if the model is valid
-    def valid?
-      return false if @type.nil?
-      return false if !@html_text.nil? && @html_text.to_s.length > 4096
-      return false if !@markdown_text.nil? && @markdown_text.to_s.length > 4096
-      return false if @items.nil?
-      return false if @media_url.nil?
-      return false if !@media_type.nil? && @media_type.to_s.length > 128
-      return false if !@alt_text.nil? && @alt_text.to_s.length > 128
-      return false if @fields.nil?
-      return false if @coordinates.nil?
-      return false if @template.nil?
-      _one_of_found = false
-      self.class.openapi_one_of.each do |_class|
-        _one_of = SunshineConversationsClient.const_get(_class).build_from_hash(self.to_hash)
-        if _one_of.valid?
-          if _one_of_found
-            return false
-          else
-            _one_of_found = true
-          end
-        end
-      end
-
-      if !_one_of_found
-        return false
-      end
-
-      true
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] html_text Value to be assigned
-    def html_text=(html_text)
-      if !html_text.nil? && html_text.to_s.length > 4096
-        fail ArgumentError, 'invalid value for "html_text", the character length must be smaller than or equal to 4096.'
-      end
-
-      @html_text = html_text
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] markdown_text Value to be assigned
-    def markdown_text=(markdown_text)
-      if !markdown_text.nil? && markdown_text.to_s.length > 4096
-        fail ArgumentError, 'invalid value for "markdown_text", the character length must be smaller than or equal to 4096.'
-      end
-
-      @markdown_text = markdown_text
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] media_type Value to be assigned
-    def media_type=(media_type)
-      if !media_type.nil? && media_type.to_s.length > 128
-        fail ArgumentError, 'invalid value for "media_type", the character length must be smaller than or equal to 128.'
-      end
-
-      @media_type = media_type
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] alt_text Value to be assigned
-    def alt_text=(alt_text)
-      if !alt_text.nil? && alt_text.to_s.length > 128
-        fail ArgumentError, 'invalid value for "alt_text", the character length must be smaller than or equal to 128.'
-      end
-
-      @alt_text = alt_text
-    end
-
-    # Checks equality by comparing each attribute.
-    # @param [Object] Object to be compared
-    def ==(o)
-      return true if self.equal?(o)
-      self.class == o.class &&
-          type == o.type &&
-          text == o.text &&
-          html_text == o.html_text &&
-          block_chat_input == o.block_chat_input &&
-          markdown_text == o.markdown_text &&
-          actions == o.actions &&
-          payload == o.payload &&
-          items == o.items &&
-          display_settings == o.display_settings &&
-          media_url == o.media_url &&
-          media_size == o.media_size &&
-          media_type == o.media_type &&
-          alt_text == o.alt_text &&
-          attachment_id == o.attachment_id &&
-          submitted == o.submitted &&
-          fields == o.fields &&
-          text_fallback == o.text_fallback &&
-          coordinates == o.coordinates &&
-          location == o.location &&
-          template == o.template
-    end
-
-    # @see the `==` method
-    # @param [Object] Object to be compared
-    def eql?(o)
-      self == o
-    end
-
-    # Calculates hash code according to all attributes.
-    # @return [Integer] Hash code
-    def hash
-      [type, text, html_text, block_chat_input, markdown_text, actions, payload, items, display_settings, media_url, media_size, media_type, alt_text, attachment_id, submitted, fields, text_fallback, coordinates, location, template].hash
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def self.build_from_hash(attributes)
-      new.build_from_hash(attributes)
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def build_from_hash(attributes)
-      return nil unless attributes.is_a?(Hash)
-      self.class.openapi_types.each_pair do |key, type|
-        if type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the attribute
-          # is documented as an array but the input is not
-          if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
-          end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        end # or else data not found in attributes(hash), not an issue as the data can be optional
-      end
-
-      self
-    end
-
-    # Deserializes the data based on type
-    # @param string type Data type
-    # @param string value Value to be deserialized
-    # @return [Object] Deserialized data
-    def _deserialize(type, value)
-      case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
-      when :Date
-        Date.parse(value)
-      when :String
-        value.to_s
-      when :Integer
-        value.to_i
-      when :Float
-        value.to_f
-      when :Boolean
-        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
-          true
-        else
-          false
-        end
-      when :Object
-        # generic object (usually a Hash), return directly
-        value
-      when /\AArray<(?<inner_type>.+)>\z/
-        inner_type = Regexp.last_match[:inner_type]
-        value.map { |v| _deserialize(inner_type, v) }
-      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
-        k_type = Regexp.last_match[:k_type]
-        v_type = Regexp.last_match[:v_type]
-        {}.tap do |hash|
-          value.each do |k, v|
-            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
-          end
-        end
-      else # model
-        SunshineConversationsClient.const_get(type).build_from_hash(value)
-      end
-    end
-
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    def to_s
-      to_hash.to_s
-    end
-
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    def to_body
-      to_hash
-    end
-
-    # Returns the object in the form of hash
-    # @return [Hash] Returns the object in the form of hash
-    def to_hash
-      hash = {}
-      self.class.attribute_map.each_pair do |attr, param|
-        value = self.send(attr)
-        if value.nil?
-          is_nullable = self.class.openapi_nullable.include?(attr)
-          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
-        end
-        
-        hash[param] = _to_hash(value)
-      end
-      hash
-    end
-
-    # Outputs non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    # @param [Object] value Any valid value
-    # @return [Hash] Returns the value in the form of hash
-    def _to_hash(value)
-      if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
-      elsif value.is_a?(Hash)
-        {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
-        end
-      elsif value.respond_to? :to_hash
-        value.to_hash
-      else
-        value
+  module Content
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'CarouselMessage',
+          :'FileMessage',
+          :'FormMessage',
+          :'FormResponseMessage',
+          :'ImageMessage',
+          :'ListMessage',
+          :'LocationMessage',
+          :'TemplateMessage',
+          :'TextMessage'
+        ]
+      end
+
+      # Discriminator's property name (OpenAPI v3)
+      def openapi_discriminator_name
+        :'type'
+      end
+
+      # Discriminator's mapping (OpenAPI v3)
+      def openapi_discriminator_mapping
+        {
+          :'carousel' => :'CarouselMessage',
+          :'file' => :'FileMessage',
+          :'form' => :'FormMessage',
+          :'formResponse' => :'FormResponseMessage',
+          :'image' => :'ImageMessage',
+          :'list' => :'ListMessage',
+          :'location' => :'LocationMessage',
+          :'template' => :'TemplateMessage',
+          :'text' => :'TextMessage'
+        }
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        discriminator_value = data[openapi_discriminator_name]
+        return nil if discriminator_value.nil?
+
+        klass = openapi_discriminator_mapping[discriminator_value.to_s.to_sym]
+        return nil unless klass
+
+        SunshineConversationsClient.const_get(klass).build_from_hash(data)
       end
     end
   end
+
 end