Class: SunshineConversationsClient::Author

Inherits:
Object
  • Object
show all
Defined in:
lib/sunshine-conversations-client/models/author.rb

Overview

The author of the message.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Author

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/sunshine-conversations-client/models/author.rb', line 88

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SunshineConversationsClient::Author` 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::Author`. 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']
  end

  if attributes.key?(:'subtypes')
    if (value = attributes[:'subtypes']).is_a?(Array)
      self.subtypes = value
    end
  end

  if attributes.key?(:'user_id')
    self.user_id = attributes[:'user_id']
  end

  if attributes.key?(:'user_external_id')
    self.user_external_id = attributes[:'user_external_id']
  end

  if attributes.key?(:'display_name')
    self.display_name = attributes[:'display_name']
  end

  if attributes.key?(:'avatar_url')
    self.avatar_url = attributes[:'avatar_url']
  end
end

Instance Attribute Details

#avatar_url ⇒ Object

A custom message icon URL. The image must be JPG, PNG, or GIF format.



32
33
34
 
# File 'lib/sunshine-conversations-client/models/author.rb', line 32

def avatar_url
  @avatar_url
end

#display_name ⇒ Object

The display name of the message author.



29
30
31
 
# File 'lib/sunshine-conversations-client/models/author.rb', line 29

def display_name
  @display_name
end

#subtypes ⇒ Object

A string array that indicates the author’s subtypes. Messages from "business" type with an "AI" subtype are generated by AI and a disclaimer is appended to the text of the message sent to the customer. For third-party channels, the disclaimer is applied for image, file, and text message types. Message with an "activity" subtype are generated by system activities.



20
21
22
 
# File 'lib/sunshine-conversations-client/models/author.rb', line 20

def subtypes
  @subtypes
end

#type ⇒ Object

The author type. Either "user" (representing the end user) or "business" (sent on behalf of the business).



17
18
19
 
# File 'lib/sunshine-conversations-client/models/author.rb', line 17

def type
  @type
end

#user_external_id ⇒ Object

The externalId of the user. Only supported when ‘type` is user.



26
27
28
 
# File 'lib/sunshine-conversations-client/models/author.rb', line 26

def user_external_id
  @user_external_id
end

#user_id ⇒ Object

The id of the user. Only supported when ‘type` is user.



23
24
25
 
# File 'lib/sunshine-conversations-client/models/author.rb', line 23

def user_id
  @user_id
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/sunshine-conversations-client/models/author.rb', line 234

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = SunshineConversationsClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
 
# File 'lib/sunshine-conversations-client/models/author.rb', line 57

def self.attribute_map
  {
    :'type' => :'type',
    :'subtypes' => :'subtypes',
    :'user_id' => :'userId',
    :'user_external_id' => :'userExternalId',
    :'display_name' => :'displayName',
    :'avatar_url' => :'avatarUrl'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/sunshine-conversations-client/models/author.rb', line 210

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



81
82
83
84
 
# File 'lib/sunshine-conversations-client/models/author.rb', line 81

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
 
# File 'lib/sunshine-conversations-client/models/author.rb', line 69

def self.openapi_types
  {
    :'type' => :'String',
    :'subtypes' => :'Array<String>',
    :'user_id' => :'String',
    :'user_external_id' => :'String',
    :'display_name' => :'String',
    :'avatar_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



184
185
186
187
188
189
190
191
192
193
 
# File 'lib/sunshine-conversations-client/models/author.rb', line 184

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      subtypes == o.subtypes &&
      user_id == o.user_id &&
      user_external_id == o.user_external_id &&
      display_name == o.display_name &&
      avatar_url == o.avatar_url
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/sunshine-conversations-client/models/author.rb', line 305

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


197
198
199
 
# File 'lib/sunshine-conversations-client/models/author.rb', line 197

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



203
204
205
 
# File 'lib/sunshine-conversations-client/models/author.rb', line 203

def hash
  [typesubtypesuser_iduser_external_iddisplay_nameavatar_url].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/sunshine-conversations-client/models/author.rb', line 130

def list_invalid_properties
  invalid_properties = Array.new
  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  if !@avatar_url.nil? && @avatar_url.to_s.length > 2048
    invalid_properties.push('invalid value for "avatar_url", the character length must be smaller than or equal to 2048.')
  end

  if !@avatar_url.nil? && @avatar_url.to_s.length < 1
    invalid_properties.push('invalid value for "avatar_url", the character length must be great than or equal to 1.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



281
282
283
 
# File 'lib/sunshine-conversations-client/models/author.rb', line 281

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/sunshine-conversations-client/models/author.rb', line 287

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



275
276
277
 
# File 'lib/sunshine-conversations-client/models/author.rb', line 275

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



149
150
151
152
153
154
155
156
 
# File 'lib/sunshine-conversations-client/models/author.rb', line 149

def valid?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["business", "user"])
  return false unless type_validator.valid?(@type)
  return false if !@avatar_url.nil? && @avatar_url.to_s.length > 2048
  return false if !@avatar_url.nil? && @avatar_url.to_s.length < 1
  true
end