Class: OpenapiClient::OrgMemberRead

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/models/org_member_read.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrgMemberRead

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
# File 'lib/openapi_client/models/org_member_read.rb', line 122

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'last_ip')
    self.last_ip = attributes[:'last_ip']
  else
    self.last_ip = '0.0.0.0'
  end

  if attributes.key?(:'logins_count')
    self.logins_count = attributes[:'logins_count']
  else
    self.logins_count = 0
  end

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

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

Instance Attribute Details

#created_atObject

Date and time when the account member was created (ISO_8601 format).



49
50
51
# File 'lib/openapi_client/models/org_member_read.rb', line 49

def created_at
  @created_at
end

#emailObject

Email of the user controlling this account



22
23
24
# File 'lib/openapi_client/models/org_member_read.rb', line 22

def email
  @email
end

#email_verifiedObject

Whether this email address is verified or not. For social providers like ‘Login with Google’ this is done automatically, otherwise we will send the user a verification link in email.



25
26
27
# File 'lib/openapi_client/models/org_member_read.rb', line 25

def email_verified
  @email_verified
end

#family_nameObject

Last name of the user



34
35
36
# File 'lib/openapi_client/models/org_member_read.rb', line 34

def family_name
  @family_name
end

#given_nameObject

First name of the user



31
32
33
# File 'lib/openapi_client/models/org_member_read.rb', line 31

def given_name
  @given_name
end

#idObject

Unique id of the account member



19
20
21
# File 'lib/openapi_client/models/org_member_read.rb', line 19

def id
  @id
end

#identitiesObject

Returns the value of attribute identities.



60
61
62
# File 'lib/openapi_client/models/org_member_read.rb', line 60

def identities
  @identities
end

#is_onboardingObject

Whether or not this user is currently onboarding, needs to be replaced by a user journey object



43
44
45
# File 'lib/openapi_client/models/org_member_read.rb', line 43

def is_onboarding
  @is_onboarding
end

#is_superuserObject

Whether or not this user has special access to permit.io organizations



40
41
42
# File 'lib/openapi_client/models/org_member_read.rb', line 40

def is_superuser
  @is_superuser
end

#last_ipObject

Last IP address from which this user logged in.



55
56
57
# File 'lib/openapi_client/models/org_member_read.rb', line 55

def last_ip
  @last_ip
end

#last_loginObject

Last date and time this user logged in (ISO_8601 format).



52
53
54
# File 'lib/openapi_client/models/org_member_read.rb', line 52

def 
  @last_login
end

#logins_countObject

Total number of logins this user has performed.



58
59
60
# File 'lib/openapi_client/models/org_member_read.rb', line 58

def logins_count
  @logins_count
end

#nameObject

Name of this user



28
29
30
# File 'lib/openapi_client/models/org_member_read.rb', line 28

def name
  @name
end

#onboarding_stepObject

the step the user is currently going through in onboarding



46
47
48
# File 'lib/openapi_client/models/org_member_read.rb', line 46

def onboarding_step
  @onboarding_step
end

#pictureObject

URL to picture, photo, or avatar of the user that controls this account.



37
38
39
# File 'lib/openapi_client/models/org_member_read.rb', line 37

def picture
  @picture
end

#settingsObject

Custom permit.io dashboard settings, such as preferred theme, etc.



63
64
65
# File 'lib/openapi_client/models/org_member_read.rb', line 63

def settings
  @settings
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



88
89
90
# File 'lib/openapi_client/models/org_member_read.rb', line 88

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# File 'lib/openapi_client/models/org_member_read.rb', line 66

def self.attribute_map
  {
    :'id' => :'id',
    :'email' => :'email',
    :'email_verified' => :'email_verified',
    :'name' => :'name',
    :'given_name' => :'given_name',
    :'family_name' => :'family_name',
    :'picture' => :'picture',
    :'is_superuser' => :'is_superuser',
    :'is_onboarding' => :'is_onboarding',
    :'onboarding_step' => :'onboarding_step',
    :'created_at' => :'created_at',
    :'last_login' => :'last_login',
    :'last_ip' => :'last_ip',
    :'logins_count' => :'logins_count',
    :'identities' => :'identities',
    :'settings' => :'settings'
  }
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



302
303
304
# File 'lib/openapi_client/models/org_member_read.rb', line 302

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

.openapi_nullableObject

List of attributes with nullable: true



115
116
117
118
# File 'lib/openapi_client/models/org_member_read.rb', line 115

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

.openapi_typesObject

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
# File 'lib/openapi_client/models/org_member_read.rb', line 93

def self.openapi_types
  {
    :'id' => :'String',
    :'email' => :'String',
    :'email_verified' => :'Boolean',
    :'name' => :'String',
    :'given_name' => :'String',
    :'family_name' => :'String',
    :'picture' => :'String',
    :'is_superuser' => :'Boolean',
    :'is_onboarding' => :'Boolean',
    :'onboarding_step' => :'OnboardingStep',
    :'created_at' => :'Time',
    :'last_login' => :'Time',
    :'last_ip' => :'String',
    :'logins_count' => :'Integer',
    :'identities' => :'Array<IdentityRead>',
    :'settings' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
# File 'lib/openapi_client/models/org_member_read.rb', line 266

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      email == o.email &&
      email_verified == o.email_verified &&
      name == o.name &&
      given_name == o.given_name &&
      family_name == o.family_name &&
      picture == o.picture &&
      is_superuser == o.is_superuser &&
      is_onboarding == o.is_onboarding &&
      onboarding_step == o.onboarding_step &&
      created_at == o.created_at &&
       == o. &&
      last_ip == o.last_ip &&
      logins_count == o.logins_count &&
      identities == o.identities &&
      settings == o.settings
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



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
# File 'lib/openapi_client/models/org_member_read.rb', line 333

def _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 = OpenapiClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



404
405
406
407
408
409
410
411
412
413
414
415
416
# File 'lib/openapi_client/models/org_member_read.rb', line 404

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



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
# File 'lib/openapi_client/models/org_member_read.rb', line 309

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


289
290
291
# File 'lib/openapi_client/models/org_member_read.rb', line 289

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



295
296
297
# File 'lib/openapi_client/models/org_member_read.rb', line 295

def hash
  [id, email, email_verified, name, given_name, family_name, picture, is_superuser, is_onboarding, onboarding_step, created_at, , last_ip, logins_count, identities, settings].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



208
209
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/openapi_client/models/org_member_read.rb', line 208

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

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

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

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

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

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

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

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



380
381
382
# File 'lib/openapi_client/models/org_member_read.rb', line 380

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



386
387
388
389
390
391
392
393
394
395
396
397
398
# File 'lib/openapi_client/models/org_member_read.rb', line 386

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



374
375
376
# File 'lib/openapi_client/models/org_member_read.rb', line 374

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



251
252
253
254
255
256
257
258
259
260
261
262
# File 'lib/openapi_client/models/org_member_read.rb', line 251

def valid?
  return false if @id.nil?
  return false if @email.nil?
  return false if @email_verified.nil?
  return false if @is_superuser.nil?
  return false if @is_onboarding.nil?
  return false if @onboarding_step.nil?
  return false if @created_at.nil?
  return false if @identities.nil?
  return false if @settings.nil?
  true
end