class SunshineConversationsClient::Conversation

Attributes

active_switchboard_integration[RW]

The current switchboard integration that is in control of the conversation. This field is omitted if no `activeSwitchboardIntegration` exists for the conversation.

business_last_read[RW]

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.

description[RW]

A short text describing the conversation.

display_name[RW]

A friendly name for the conversation, may be displayed to the business or the user.

icon_url[RW]

A custom conversation icon url. The image must be in either JPG, PNG, or GIF format

id[RW]

The unique ID of the conversation.

is_default[RW]

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.

last_updated_at[RW]

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.

metadata[RW]

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.

pending_switchboard_integration[RW]

The switchboard integration that is awaiting control. This field is omitted if no switchboard integration has been previously offered control.

type[RW]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/sunshine-conversations-client/models/conversation.rb, line 47
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
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/sunshine-conversations-client/models/conversation.rb, line 255
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/sunshine-conversations-client/models/conversation.rb, line 103
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
openapi_all_of() click to toggle source

List of class defined in allOf (OpenAPI v3)

# File lib/sunshine-conversations-client/models/conversation.rb, line 94
def self.openapi_all_of
  [
  :'ConversationAllOf',
  :'ConversationTruncated'
  ]
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/sunshine-conversations-client/models/conversation.rb, line 81
def self.openapi_nullable
  Set.new([
    :'active_switchboard_integration',
    :'pending_switchboard_integration',
    :'description',
    :'icon_url',
    :'metadata',
    :'business_last_read',
    :'last_updated_at'
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/sunshine-conversations-client/models/conversation.rb, line 64
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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/sunshine-conversations-client/models/conversation.rb, line 224
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
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/sunshine-conversations-client/models/conversation.rb, line 283
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
_to_hash(value) click to toggle source

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

# File lib/sunshine-conversations-client/models/conversation.rb, line 352
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
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/sunshine-conversations-client/models/conversation.rb, line 262
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
description=(description) click to toggle source

Custom attribute writer method with validation @param [Object] description Value to be assigned

# File lib/sunshine-conversations-client/models/conversation.rb, line 196
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
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/sunshine-conversations-client/models/conversation.rb, line 242
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/sunshine-conversations-client/models/conversation.rb, line 248
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
icon_url=(icon_url) click to toggle source

Custom attribute writer method with validation @param [Object] icon_url Value to be assigned

# File lib/sunshine-conversations-client/models/conversation.rb, line 210
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
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/sunshine-conversations-client/models/conversation.rb, line 163
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
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/sunshine-conversations-client/models/conversation.rb, line 328
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/sunshine-conversations-client/models/conversation.rb, line 334
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/sunshine-conversations-client/models/conversation.rb, line 322
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/sunshine-conversations-client/models/conversation.rb, line 186
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