sunshine-conversations-client 9.1.1

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

@@ -0,0 +1,380 @@
+=begin
+#Sunshine Conversations API
+
+The version of the OpenAPI document: 9.1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+=end
+
+require 'date'
+
+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
+
+    # An array of objects representing the actions associated with the message. The array length is limited by the third party channel.
+    attr_accessor :actions
+
+    # 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.
+    attr_accessor :media_url
+
+    # The size of the media.
+    attr_accessor :media_size
+
+    # The media type of the file.
+    attr_accessor :media_type
+
+    # true if the message should block the chat input on Web Messenger. form message only.
+    attr_accessor :block_chat_input
+
+    # 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
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'text' => :'text',
+        :'actions' => :'actions',
+        :'items' => :'items',
+        :'display_settings' => :'displaySettings',
+        :'media_url' => :'mediaUrl',
+        :'media_size' => :'mediaSize',
+        :'media_type' => :'mediaType',
+        :'block_chat_input' => :'blockChatInput',
+        :'fields' => :'fields',
+        :'text_fallback' => :'textFallback',
+        :'coordinates' => :'coordinates',
+        :'location' => :'location'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'type' => :'String',
+        :'text' => :'String',
+        :'actions' => :'Array<ActionSubset>',
+        :'items' => :'Array<Item>',
+        :'display_settings' => :'CarouselMessageDisplaySettings',
+        :'media_url' => :'String',
+        :'media_size' => :'Float',
+        :'media_type' => :'String',
+        :'block_chat_input' => :'Boolean',
+        :'fields' => :'Array<Field>',
+        :'text_fallback' => :'String',
+        :'coordinates' => :'LocationMessageCoordinates',
+        :'location' => :'LocationMessageLocation'
+      }
+    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',
+      :'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 = 'location'
+      end
+
+      if attributes.key?(:'text')
+        self.text = attributes[:'text']
+      end
+
+      if attributes.key?(:'actions')
+      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?(:'block_chat_input')
+        self.block_chat_input = attributes[:'block_chat_input']
+      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
+    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 @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 @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
+
+      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 @items.nil?
+      return false if @media_url.nil?
+      return false if @fields.nil?
+      return false if @coordinates.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
+
+    # 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 &&
+          actions == o.actions &&
+          items == o.items &&
+          display_settings == o.display_settings &&
+          media_url == o.media_url &&
+          media_size == o.media_size &&
+          media_type == o.media_type &&
+          block_chat_input == o.block_chat_input &&
+          fields == o.fields &&
+          text_fallback == o.text_fallback &&
+          coordinates == o.coordinates &&
+          location == o.location
+    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, actions, items, display_settings, media_url, media_size, media_type, block_chat_input, fields, text_fallback, coordinates, location].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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,366 @@
+=begin
+#Sunshine Conversations API
+
+The version of the OpenAPI document: 9.1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+=end
+
+require 'date'
+
+module SunshineConversationsClient
+  class Conversation
+    # The unique ID of the conversation.
+    attr_accessor :id
+
+    attr_accessor :type
+
+    # The current switchboard integration that is in control of the conversation. This field is omitted if no `activeSwitchboardIntegration` exists for the conversation.
+    attr_accessor :active_switchboard_integration
+
+    # The switchboard integration that is awaiting control. This field is omitted if no switchboard integration has been previously offered control.
+    attr_accessor :pending_switchboard_integration
+
+    # Whether the conversation is the default conversation for the user. Will be true for the first personal conversation created for the user, and false in all other cases. 
+    attr_accessor :is_default
+
+    # A friendly name for the conversation, may be displayed to the business or the user. 
+    attr_accessor :display_name
+
+    # A short text describing the conversation.
+    attr_accessor :description
+
+    # A custom conversation icon url. The image must be in either JPG, PNG, or GIF format
+    attr_accessor :icon_url
+
+    # Flat object containing custom properties. Strings, numbers and booleans  are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. 
+    attr_accessor :metadata
+
+    # A datetime string with the format YYYY-MM-DDThh:mm:ss.SSSZ representing the moment the conversation was last marked as read with role business. 
+    attr_accessor :business_last_read
+
+    # A datetime string with the format YYYY-MM-DDThh:mm:ss.SSSZ representing the moment the last message was received in the conversation, or the creation time if no messages have been received yet. 
+    attr_accessor :last_updated_at
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'type' => :'type',
+        :'active_switchboard_integration' => :'activeSwitchboardIntegration',
+        :'pending_switchboard_integration' => :'pendingSwitchboardIntegration',
+        :'is_default' => :'isDefault',
+        :'display_name' => :'displayName',
+        :'description' => :'description',
+        :'icon_url' => :'iconUrl',
+        :'metadata' => :'metadata',
+        :'business_last_read' => :'businessLastRead',
+        :'last_updated_at' => :'lastUpdatedAt'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'type' => :'ConversationType',
+        :'active_switchboard_integration' => :'SwitchboardIntegrationWebhook',
+        :'pending_switchboard_integration' => :'SwitchboardIntegrationWebhook',
+        :'is_default' => :'Boolean',
+        :'display_name' => :'String',
+        :'description' => :'String',
+        :'icon_url' => :'String',
+        :'metadata' => :'Object',
+        :'business_last_read' => :'String',
+        :'last_updated_at' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'active_switchboard_integration',
+        :'pending_switchboard_integration',
+        :'description',
+        :'icon_url',
+        :'metadata',
+        :'business_last_read',
+        :'last_updated_at'
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'ConversationAllOf',
+      :'ConversationTruncated'
+      ]
+    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::Conversation` 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::Conversation`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'active_switchboard_integration')
+        self.active_switchboard_integration = attributes[:'active_switchboard_integration']
+      end
+
+      if attributes.key?(:'pending_switchboard_integration')
+        self.pending_switchboard_integration = attributes[:'pending_switchboard_integration']
+      end
+
+      if attributes.key?(:'is_default')
+        self.is_default = attributes[:'is_default']
+      end
+
+      if attributes.key?(:'display_name')
+        self.display_name = attributes[:'display_name']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'icon_url')
+        self.icon_url = attributes[:'icon_url']
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'business_last_read')
+        self.business_last_read = attributes[:'business_last_read']
+      end
+
+      if attributes.key?(:'last_updated_at')
+        self.last_updated_at = attributes[:'last_updated_at']
+      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 !@description.nil? && @description.to_s.length > 100
+        invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 100.')
+      end
+
+      if !@description.nil? && @description.to_s.length < 1
+        invalid_properties.push('invalid value for "description", the character length must be great than or equal to 1.')
+      end
+
+      if !@icon_url.nil? && @icon_url.to_s.length > 2048
+        invalid_properties.push('invalid value for "icon_url", the character length must be smaller than or equal to 2048.')
+      end
+
+      if !@icon_url.nil? && @icon_url.to_s.length < 1
+        invalid_properties.push('invalid value for "icon_url", the character length must be great than or equal to 1.')
+      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 !@description.nil? && @description.to_s.length > 100
+      return false if !@description.nil? && @description.to_s.length < 1
+      return false if !@icon_url.nil? && @icon_url.to_s.length > 2048
+      return false if !@icon_url.nil? && @icon_url.to_s.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if !description.nil? && description.to_s.length > 100
+        fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 100.'
+      end
+
+      if !description.nil? && description.to_s.length < 1
+        fail ArgumentError, 'invalid value for "description", the character length must be great than or equal to 1.'
+      end
+
+      @description = description
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] icon_url Value to be assigned
+    def icon_url=(icon_url)
+      if !icon_url.nil? && icon_url.to_s.length > 2048
+        fail ArgumentError, 'invalid value for "icon_url", the character length must be smaller than or equal to 2048.'
+      end
+
+      if !icon_url.nil? && icon_url.to_s.length < 1
+        fail ArgumentError, 'invalid value for "icon_url", the character length must be great than or equal to 1.'
+      end
+
+      @icon_url = icon_url
+    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 &&
+          id == o.id &&
+          type == o.type &&
+          active_switchboard_integration == o.active_switchboard_integration &&
+          pending_switchboard_integration == o.pending_switchboard_integration &&
+          is_default == o.is_default &&
+          display_name == o.display_name &&
+          description == o.description &&
+          icon_url == o.icon_url &&
+          metadata == o.metadata &&
+          business_last_read == o.business_last_read &&
+          last_updated_at == o.last_updated_at
+    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
+      [id, type, active_switchboard_integration, pending_switchboard_integration, is_default, display_name, description, icon_url, metadata, business_last_read, last_updated_at].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
+      end
+    end
+  end
+end