Class: SunshineConversationsClient::UserMergeEventAllOfPayload

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

Overview

The payload of the event. The contents of this object depend on the type of event.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserMergeEventAllOfPayload

Initializes the object

Parameters:

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

    Model attributes in the form of hash



82
83
84
85
86
87
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
 
# File 'lib/sunshine-conversations-client/models/user_merge_event_all_of_payload.rb', line 82

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

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

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

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

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

Instance Attribute Details

#discarded_metadata ⇒ Object

A flat object with the set of metadata properties that were discarded when merging the two users. This should contain values only if the combined metadata fields exceed the 4KB limit.



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

def discarded_metadata
  @discarded_metadata
end

#merged_clients ⇒ Object

Returns the value of attribute merged_clients.



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

def merged_clients
  @merged_clients
end

#merged_conversations ⇒ Object

Returns the value of attribute merged_conversations.



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

def merged_conversations
  @merged_conversations
end

#merged_users ⇒ Object

Returns the value of attribute merged_users.



15
16
17
 
# File 'lib/sunshine-conversations-client/models/user_merge_event_all_of_payload.rb', line 15

def merged_users
  @merged_users
end

#reason ⇒ Object

The reason for which the users merged. * ‘api` - The users were merged using the API. * `channelLinking` - The users were merged as a result of initiating a channel link. * `sdkLogin` - The users were merged as a result of logging into an SDK device.



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

def reason
  @reason
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
 
# File 'lib/sunshine-conversations-client/models/user_merge_event_all_of_payload.rb', line 50

def self.attribute_map
  {
    :'merged_users' => :'mergedUsers',
    :'merged_conversations' => :'mergedConversations',
    :'merged_clients' => :'mergedClients',
    :'discarded_metadata' => :'discardedMetadata',
    :'reason' => :'reason'
  }
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



168
169
170
 
# File 'lib/sunshine-conversations-client/models/user_merge_event_all_of_payload.rb', line 168

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

def self.openapi_nullable
  Set.new([
    :'merged_conversations',
    :'merged_clients',
    :'discarded_metadata',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
 
# File 'lib/sunshine-conversations-client/models/user_merge_event_all_of_payload.rb', line 61

def self.openapi_types
  {
    :'merged_users' => :'UserMergeEventAllOfPayloadMergedUsers',
    :'merged_conversations' => :'UserMergeEventAllOfPayloadMergedConversations',
    :'merged_clients' => :'UserMergeEventAllOfPayloadMergedClients',
    :'discarded_metadata' => :'Object',
    :'reason' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



143
144
145
146
147
148
149
150
151
 
# File 'lib/sunshine-conversations-client/models/user_merge_event_all_of_payload.rb', line 143

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      merged_users == o.merged_users &&
      merged_conversations == o.merged_conversations &&
      merged_clients == o.merged_clients &&
      discarded_metadata == o.discarded_metadata &&
      reason == o.reason
end

#_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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/sunshine-conversations-client/models/user_merge_event_all_of_payload.rb', line 196

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



265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/sunshine-conversations-client/models/user_merge_event_all_of_payload.rb', line 265

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/sunshine-conversations-client/models/user_merge_event_all_of_payload.rb', line 175

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


155
156
157
 
# File 'lib/sunshine-conversations-client/models/user_merge_event_all_of_payload.rb', line 155

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



161
162
163
 
# File 'lib/sunshine-conversations-client/models/user_merge_event_all_of_payload.rb', line 161

def hash
  [merged_users, merged_conversations, merged_clients, discarded_metadata, reason].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



118
119
120
121
 
# File 'lib/sunshine-conversations-client/models/user_merge_event_all_of_payload.rb', line 118

def list_invalid_properties
  invalid_properties = Array.new
  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



241
242
243
 
# File 'lib/sunshine-conversations-client/models/user_merge_event_all_of_payload.rb', line 241

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



247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/sunshine-conversations-client/models/user_merge_event_all_of_payload.rb', line 247

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



235
236
237
 
# File 'lib/sunshine-conversations-client/models/user_merge_event_all_of_payload.rb', line 235

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



125
126
127
128
129
 
# File 'lib/sunshine-conversations-client/models/user_merge_event_all_of_payload.rb', line 125

def valid?
  reason_validator = EnumAttributeValidator.new('String', ["api", "channelLinking", "sdkLogin"])
  return false unless reason_validator.valid?(@reason)
  true
end