Class: SunshineConversationsClient::User

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ User

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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/sunshine-conversations-client/models/user.rb', line 88

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

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

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

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

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

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

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

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

Instance Attribute Details

#authenticated ⇒ Object

Whether or not the user has authenticated, either via JWT or via the Help Center



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

def authenticated
  @authenticated
end

#external_id ⇒ Object

An optional ID that can also be used to retrieve the user.



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

def external_id
  @external_id
end

#id ⇒ Object

The unique ID of the user.



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

def id
  @id
end

#identities ⇒ Object

The user’s connected identities.



39
40
41
 
# File 'lib/sunshine-conversations-client/models/user.rb', line 39

def identities
  @identities
end

#metadata ⇒ Object

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.



36
37
38
 
# File 'lib/sunshine-conversations-client/models/user.rb', line 36

def metadata
  @metadata
end

#profile ⇒ Object

Returns the value of attribute profile.



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

def profile
  @profile
end

#signed_up_at ⇒ Object

The date at which the user signed up. Must be ISO 8601 time format ‘YYYY-MM-DDThh:mm:ss.sssZ`.



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

def signed_up_at
  @signed_up_at
end

#to_be_retained ⇒ Object

Flag indicating whether a user should be retained after they have passed their inactive expiry. See [creating deletion schedules for bot-only conversations](support.zendesk.com/hc/en-us/articles/8499219792154) for more information.



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

def to_be_retained
  @to_be_retained
end

#zendesk_id ⇒ Object

The ID that links a messaging user to its core Zendesk user counterpart. This ID can be used to fetch the core user record via the Zendesk Support API.



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

def zendesk_id
  @zendesk_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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/sunshine-conversations-client/models/user.rb', line 210

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.



42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/sunshine-conversations-client/models/user.rb', line 42

def self.attribute_map
  {
    :'id' => :'id',
    :'authenticated' => :'authenticated',
    :'external_id' => :'externalId',
    :'zendesk_id' => :'zendeskId',
    :'signed_up_at' => :'signedUpAt',
    :'to_be_retained' => :'toBeRetained',
    :'profile' => :'profile',
    :'metadata' => :'metadata',
    :'identities' => :'identities'
  }
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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/sunshine-conversations-client/models/user.rb', line 186

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

List of class defined in allOf (OpenAPI v3)



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

def self.openapi_all_of
  [
  :'UserTruncated'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

def self.openapi_nullable
  Set.new([
    :'external_id',
    :'zendesk_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'String',
    :'authenticated' => :'Boolean',
    :'external_id' => :'String',
    :'zendesk_id' => :'String',
    :'signed_up_at' => :'String',
    :'to_be_retained' => :'Boolean',
    :'profile' => :'Profile',
    :'metadata' => :'Hash<String, Object>',
    :'identities' => :'Array<Identity>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/sunshine-conversations-client/models/user.rb', line 157

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      authenticated == o.authenticated &&
      external_id == o.external_id &&
      zendesk_id == o.zendesk_id &&
      signed_up_at == o.signed_up_at &&
      to_be_retained == o.to_be_retained &&
      profile == o.profile &&
      metadata == o.metadata &&
      identities == o.identities
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



281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/sunshine-conversations-client/models/user.rb', line 281

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


173
174
175
 
# File 'lib/sunshine-conversations-client/models/user.rb', line 173

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



179
180
181
 
# File 'lib/sunshine-conversations-client/models/user.rb', line 179

def hash
  [idauthenticatedexternal_idzendesk_idsigned_up_atto_be_retainedprofilemetadataidentities].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



144
145
146
147
 
# File 'lib/sunshine-conversations-client/models/user.rb', line 144

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



257
258
259
 
# File 'lib/sunshine-conversations-client/models/user.rb', line 257

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



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

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



251
252
253
 
# File 'lib/sunshine-conversations-client/models/user.rb', line 251

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



151
152
153
 
# File 'lib/sunshine-conversations-client/models/user.rb', line 151

def valid?
  true
end