Class: Bfwd::User

Inherits:
Object
  • Object
show all
Defined in:
lib/bf_ruby2/models/user.rb

Overview

User

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



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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/bf_ruby2/models/user.rb', line 102

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'created')
    self.created = attributes[:'created']
  end

  if attributes.has_key?(:'changedBy')
    self.changed_by = attributes[:'changedBy']
  end

  if attributes.has_key?(:'updated')
    self.updated = attributes[:'updated']
  end

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'organizationID')
    self.organization_id = attributes[:'organizationID']
  end

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

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

  if attributes.has_key?(:'passwordResetValidTill')
    self.password_reset_valid_till = attributes[:'passwordResetValidTill']
  end

  if attributes.has_key?(:'bfAdmin')
    self.bf_admin = attributes[:'bfAdmin']
  else
    self.bf_admin = false
  end

  if attributes.has_key?(:'accountNonExpired')
    self. = attributes[:'accountNonExpired']
  else
    self. = false
  end

  if attributes.has_key?(:'accountNonLocked')
    self. = attributes[:'accountNonLocked']
  else
    self. = false
  end

  if attributes.has_key?(:'credentialsNonExpired')
    self.credentials_non_expired = attributes[:'credentialsNonExpired']
  else
    self.credentials_non_expired = false
  end

  if attributes.has_key?(:'enabled')
    self.enabled = attributes[:'enabled']
  else
    self.enabled = false
  end

  if attributes.has_key?(:'timezone')
    self.timezone = attributes[:'timezone']
  end

end

Instance Attribute Details

#account_non_expired ⇒ Object

{"description":"Whether the User has expired.“,”verbs“: }



45
46
47
 
# File 'lib/bf_ruby2/models/user.rb', line 45

def 
  @account_non_expired
end

#account_non_locked ⇒ Object

the User locked.“,”verbs“:



48
49
50
 
# File 'lib/bf_ruby2/models/user.rb', line 48

def 
  @account_non_locked
end

#bf_admin ⇒ Object

Returns the value of attribute bf_admin.



42
43
44
 
# File 'lib/bf_ruby2/models/user.rb', line 42

def bf_admin
  @bf_admin
end

#changed_by ⇒ Object

{ "description" : "ID of the user who last updated the entity.", "verbs":[] }



22
23
24
 
# File 'lib/bf_ruby2/models/user.rb', line 22

def changed_by
  @changed_by
end

#created ⇒ Object

{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }



19
20
21
 
# File 'lib/bf_ruby2/models/user.rb', line 19

def created
  @created
end

#credentials_non_expired ⇒ Object

the User credentials expired.“,”verbs“:



51
52
53
 
# File 'lib/bf_ruby2/models/user.rb', line 51

def credentials_non_expired
  @credentials_non_expired
end

#enabled ⇒ Object

the User enabled.“,”verbs“:



54
55
56
 
# File 'lib/bf_ruby2/models/user.rb', line 54

def enabled
  @enabled
end

#id ⇒ Object

of the user“,”verbs“:



28
29
30
 
# File 'lib/bf_ruby2/models/user.rb', line 28

def id
  @id
end

#organization_id ⇒ Object

of the Organization to which the User belongs.“,”verbs“:



31
32
33
 
# File 'lib/bf_ruby2/models/user.rb', line 31

def organization_id
  @organization_id
end

#password ⇒ Object

associated with the user. A user must have one currently active password to login.“,”verbs“:



34
35
36
 
# File 'lib/bf_ruby2/models/user.rb', line 34

def password
  @password
end

#password_reset_valid_till ⇒ Object

UTC DateTime when a password reset would no longer be valid with the current code.“,”verbs“:



40
41
42
 
# File 'lib/bf_ruby2/models/user.rb', line 40

def password_reset_valid_till
  @password_reset_valid_till
end

#timezone ⇒ Object

timezone used when displaying time series data to the user.“,”verbs“:



57
58
59
 
# File 'lib/bf_ruby2/models/user.rb', line 57

def timezone
  @timezone
end

#updated ⇒ Object

{ "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }



25
26
27
 
# File 'lib/bf_ruby2/models/user.rb', line 25

def updated
  @updated
end

#username ⇒ Object

associated with the user. A user may have more than one username currently active. Usernames are enforced to be formatted as e-mail addresses.“,”verbs“:



37
38
39
 
# File 'lib/bf_ruby2/models/user.rb', line 37

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/bf_ruby2/models/user.rb', line 61

def self.attribute_map
  {
    :'created' => :'created',
    :'changed_by' => :'changedBy',
    :'updated' => :'updated',
    :'id' => :'id',
    :'organization_id' => :'organizationID',
    :'password' => :'password',
    :'username' => :'username',
    :'password_reset_valid_till' => :'passwordResetValidTill',
    :'bf_admin' => :'bfAdmin',
    :'account_non_expired' => :'accountNonExpired',
    :'account_non_locked' => :'accountNonLocked',
    :'credentials_non_expired' => :'credentialsNonExpired',
    :'enabled' => :'enabled',
    :'timezone' => :'timezone'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/bf_ruby2/models/user.rb', line 81

def self.swagger_types
  {
    :'created' => :'DateTime',
    :'changed_by' => :'String',
    :'updated' => :'DateTime',
    :'id' => :'String',
    :'organization_id' => :'String',
    :'password' => :'Array<Password>',
    :'username' => :'Array<Username>',
    :'password_reset_valid_till' => :'DateTime',
    :'bf_admin' => :'BOOLEAN',
    :'account_non_expired' => :'BOOLEAN',
    :'account_non_locked' => :'BOOLEAN',
    :'credentials_non_expired' => :'BOOLEAN',
    :'enabled' => :'BOOLEAN',
    :'timezone' => :'TimeZone'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/bf_ruby2/models/user.rb', line 240

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created == o.created &&
      changed_by == o.changed_by &&
      updated == o.updated &&
      id == o.id &&
      organization_id == o.organization_id &&
      password == o.password &&
      username == o.username &&
      password_reset_valid_till == o.password_reset_valid_till &&
      bf_admin == o.bf_admin &&
       == o. &&
       == o. &&
      credentials_non_expired == o.credentials_non_expired &&
      enabled == o.enabled &&
      timezone == o.timezone
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



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/bf_ruby2/models/user.rb', line 295

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
    temp_model = Bfwd.const_get(type).new
    temp_model.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



361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/bf_ruby2/models/user.rb', line 361

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



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/bf_ruby2/models/user.rb', line 274

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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


261
262
263
 
# File 'lib/bf_ruby2/models/user.rb', line 261

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



267
268
269
 
# File 'lib/bf_ruby2/models/user.rb', line 267

def hash
  [created, changed_by, updated, id, organization_id, password, username, password_reset_valid_till, bf_admin, , , credentials_non_expired, enabled, timezone].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



182
183
184
185
186
187
188
189
190
191
192
193
194
195
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
 
# File 'lib/bf_ruby2/models/user.rb', line 182

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

  if @password.nil?
    invalid_properties.push("invalid value for 'password', password cannot be nil.")
  end

  if @username.nil?
    invalid_properties.push("invalid value for 'username', username cannot be nil.")
  end

  if @password_reset_valid_till.nil?
    invalid_properties.push("invalid value for 'password_reset_valid_till', password_reset_valid_till cannot be nil.")
  end

  if @account_non_expired.nil?
    invalid_properties.push("invalid value for 'account_non_expired', account_non_expired cannot be nil.")
  end

  if @account_non_locked.nil?
    invalid_properties.push("invalid value for 'account_non_locked', account_non_locked cannot be nil.")
  end

  if @credentials_non_expired.nil?
    invalid_properties.push("invalid value for 'credentials_non_expired', credentials_non_expired cannot be nil.")
  end

  if @enabled.nil?
    invalid_properties.push("invalid value for 'enabled', enabled cannot be nil.")
  end

  if @timezone.nil?
    invalid_properties.push("invalid value for 'timezone', timezone cannot be nil.")
  end

  return 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



341
342
343
 
# File 'lib/bf_ruby2/models/user.rb', line 341

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



347
348
349
350
351
352
353
354
355
 
# File 'lib/bf_ruby2/models/user.rb', line 347

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



335
336
337
 
# File 'lib/bf_ruby2/models/user.rb', line 335

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



225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/bf_ruby2/models/user.rb', line 225

def valid?
  return false if @organization_id.nil?
  return false if @password.nil?
  return false if @username.nil?
  return false if @password_reset_valid_till.nil?
  return false if @account_non_expired.nil?
  return false if @account_non_locked.nil?
  return false if @credentials_non_expired.nil?
  return false if @enabled.nil?
  return false if @timezone.nil?
  return true
end