Class: SubskribeDevClient::UserJson

Inherits:
Object
  • Object
show all
Defined in:
lib/subskribe_dev/models/user_json.rb,
lib/subskribe_dev2/models/user_json.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserJson

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
179
180
181
182
183
184
185
186
 
# File 'lib/subskribe_dev/models/user_json.rb', line 113

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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#approval_segments ⇒ Object

Returns the value of attribute approval_segments.



39
40
41
 
# File 'lib/subskribe_dev/models/user_json.rb', line 39

def approval_segments
  @approval_segments
end

#available_entities ⇒ Object

Returns the value of attribute available_entities.



43
44
45
 
# File 'lib/subskribe_dev/models/user_json.rb', line 43

def available_entities
  @available_entities
end

#cognito_user_status ⇒ Object

Returns the value of attribute cognito_user_status.



35
36
37
 
# File 'lib/subskribe_dev/models/user_json.rb', line 35

def cognito_user_status
  @cognito_user_status
end

#display_name ⇒ Object

Returns the value of attribute display_name.



19
20
21
 
# File 'lib/subskribe_dev/models/user_json.rb', line 19

def display_name
  @display_name
end

#email ⇒ Object

Returns the value of attribute email.



23
24
25
 
# File 'lib/subskribe_dev/models/user_json.rb', line 23

def email
  @email
end

#entity_ids ⇒ Object

Returns the value of attribute entity_ids.



45
46
47
 
# File 'lib/subskribe_dev/models/user_json.rb', line 45

def entity_ids
  @entity_ids
end

#has_all_entities_access ⇒ Object

Returns the value of attribute has_all_entities_access.



41
42
43
 
# File 'lib/subskribe_dev/models/user_json.rb', line 41

def has_all_entities_access
  @has_all_entities_access
end

#id ⇒ Object

Returns the value of attribute id.



17
18
19
 
# File 'lib/subskribe_dev/models/user_json.rb', line 17

def id
  @id
end

#phone_number ⇒ Object

Returns the value of attribute phone_number.



25
26
27
 
# File 'lib/subskribe_dev/models/user_json.rb', line 25

def phone_number
  @phone_number
end

#role ⇒ Object

Returns the value of attribute role.



29
30
31
 
# File 'lib/subskribe_dev/models/user_json.rb', line 29

def role
  @role
end

#sso_only ⇒ Object

Returns the value of attribute sso_only.



31
32
33
 
# File 'lib/subskribe_dev/models/user_json.rb', line 31

def sso_only
  @sso_only
end

#state ⇒ Object

Returns the value of attribute state.



27
28
29
 
# File 'lib/subskribe_dev/models/user_json.rb', line 27

def state
  @state
end

#tenant_name ⇒ Object

Returns the value of attribute tenant_name.



33
34
35
 
# File 'lib/subskribe_dev/models/user_json.rb', line 33

def tenant_name
  @tenant_name
end

#title ⇒ Object

Returns the value of attribute title.



21
22
23
 
# File 'lib/subskribe_dev/models/user_json.rb', line 21

def title
  @title
end

#user_groups ⇒ Object

Returns the value of attribute user_groups.



37
38
39
 
# File 'lib/subskribe_dev/models/user_json.rb', line 37

def user_groups
  @user_groups
end

Class Method Details

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/subskribe_dev/models/user_json.rb', line 70

def self.attribute_map
  {
    :'id' => :'id',
    :'display_name' => :'displayName',
    :'title' => :'title',
    :'email' => :'email',
    :'phone_number' => :'phoneNumber',
    :'state' => :'state',
    :'role' => :'role',
    :'sso_only' => :'ssoOnly',
    :'tenant_name' => :'tenantName',
    :'cognito_user_status' => :'cognitoUserStatus',
    :'user_groups' => :'userGroups',
    :'approval_segments' => :'approvalSegments',
    :'has_all_entities_access' => :'hasAllEntitiesAccess',
    :'available_entities' => :'availableEntities',
    :'entity_ids' => :'entityIds'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/subskribe_dev/models/user_json.rb', line 91

def self.swagger_types
  {
    :'id' => :'String',
    :'display_name' => :'String',
    :'title' => :'String',
    :'email' => :'String',
    :'phone_number' => :'String',
    :'state' => :'String',
    :'role' => :'String',
    :'sso_only' => :'BOOLEAN',
    :'tenant_name' => :'String',
    :'cognito_user_status' => :'String',
    :'user_groups' => :'Array<UserGroupJson>',
    :'approval_segments' => :'Array<ApprovalSegmentJson>',
    :'has_all_entities_access' => :'BOOLEAN',
    :'available_entities' => :'Array<EntityRef>',
    :'entity_ids' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      display_name == o.display_name &&
      title == o.title &&
      email == o.email &&
      phone_number == o.phone_number &&
      state == o.state &&
      role == o.role &&
      sso_only == o.sso_only &&
      tenant_name == o.tenant_name &&
      cognito_user_status == o.cognito_user_status &&
      user_groups == o.user_groups &&
      approval_segments == o.approval_segments &&
      has_all_entities_access == o.has_all_entities_access &&
      available_entities == o.available_entities &&
      entity_ids == o.entity_ids
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/subskribe_dev/models/user_json.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 = SubskribeDevClient.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/subskribe_dev/models/user_json.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/subskribe_dev/models/user_json.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 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/subskribe_dev/models/user_json.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/subskribe_dev/models/user_json.rb', line 267

def hash
  [id, display_name, title, email, phone_number, state, role, sso_only, tenant_name, cognito_user_status, user_groups, approval_segments, has_all_entities_access, available_entities, entity_ids].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



190
191
192
193
 
# File 'lib/subskribe_dev/models/user_json.rb', line 190

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



341
342
343
 
# File 'lib/subskribe_dev/models/user_json.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/subskribe_dev/models/user_json.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/subskribe_dev/models/user_json.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



197
198
199
200
201
202
203
204
205
 
# File 'lib/subskribe_dev/models/user_json.rb', line 197

def valid?
  state_validator = EnumAttributeValidator.new('String', ['ACTIVE', 'DISABLED', 'EXPIRED'])
  return false unless state_validator.valid?(@state)
  role_validator = EnumAttributeValidator.new('String', ['ADMIN', 'FINANCE', 'SALES', 'SALES_MANAGER', 'ACCOUNTANT', 'BILLING_CLERK', 'REVENUE_CLERK', 'READ_ONLY', 'EXECUTIVE', 'CRM', 'IMPORT', 'BILLY_ADMIN', 'BILLY_ENGINEER', 'BILLY_JOB'])
  return false unless role_validator.valid?(@role)
  cognito_user_status_validator = EnumAttributeValidator.new('String', ['UNCONFIRMED', 'CONFIRMED', 'ARCHIVED', 'COMPROMISED', 'UNKNOWN', 'RESET_REQUIRED', 'FORCE_CHANGE_PASSWORD', 'EXTERNAL_PROVIDER', 'UNKNOWN_TO_SDK_VERSION'])
  return false unless cognito_user_status_validator.valid?(@cognito_user_status)
  true
end