Class: ClerkHttpClient::SAMLAccount

Inherits:
Object
  • Object
show all
Defined in:
lib/clerk-http-client/models/saml_account.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SAMLAccount

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/clerk-http-client/models/saml_account.rb', line 115

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

  if attributes.key?(:'object')
    self.object = attributes[:'object']
  else
    self.object = nil
  end

  if attributes.key?(:'provider')
    self.provider = attributes[:'provider']
  else
    self.provider = nil
  end

  if attributes.key?(:'active')
    self.active = attributes[:'active']
  else
    self.active = nil
  end

  if attributes.key?(:'email_address')
    self.email_address = attributes[:'email_address']
  else
    self.email_address = nil
  end

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

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

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

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

  if attributes.key?(:'verification')
    self.verification = attributes[:'verification']
  else
    self.verification = nil
  end

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

Instance Attribute Details

#active ⇒ Object

Returns the value of attribute active.



25
26
27
 
# File 'lib/clerk-http-client/models/saml_account.rb', line 25

def active
  @active
end

#email_address ⇒ Object

Returns the value of attribute email_address.



27
28
29
 
# File 'lib/clerk-http-client/models/saml_account.rb', line 27

def email_address
  @email_address
end

#first_name ⇒ Object

Returns the value of attribute first_name.



29
30
31
 
# File 'lib/clerk-http-client/models/saml_account.rb', line 29

def first_name
  @first_name
end

#id ⇒ Object

Returns the value of attribute id.



18
19
20
 
# File 'lib/clerk-http-client/models/saml_account.rb', line 18

def id
  @id
end

#last_name ⇒ Object

Returns the value of attribute last_name.



31
32
33
 
# File 'lib/clerk-http-client/models/saml_account.rb', line 31

def last_name
  @last_name
end

#object ⇒ Object

String representing the object’s type. Objects of the same type share the same value.



21
22
23
 
# File 'lib/clerk-http-client/models/saml_account.rb', line 21

def object
  @object
end

#provider ⇒ Object

Returns the value of attribute provider.



23
24
25
 
# File 'lib/clerk-http-client/models/saml_account.rb', line 23

def provider
  @provider
end

#provider_user_id ⇒ Object

Returns the value of attribute provider_user_id.



33
34
35
 
# File 'lib/clerk-http-client/models/saml_account.rb', line 33

def provider_user_id
  @provider_user_id
end

#public_metadata ⇒ Object

Returns the value of attribute public_metadata.



35
36
37
 
# File 'lib/clerk-http-client/models/saml_account.rb', line 35

def public_metadata
  @public_metadata
end

#saml_connection ⇒ Object

Returns the value of attribute saml_connection.



39
40
41
 
# File 'lib/clerk-http-client/models/saml_account.rb', line 39

def saml_connection
  @saml_connection
end

#verification ⇒ Object

Returns the value of attribute verification.



37
38
39
 
# File 'lib/clerk-http-client/models/saml_account.rb', line 37

def verification
  @verification
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



294
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/clerk-http-client/models/saml_account.rb', line 294

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 = ClerkHttpClient.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

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



81
82
83
 
# File 'lib/clerk-http-client/models/saml_account.rb', line 81

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/clerk-http-client/models/saml_account.rb', line 64

def self.attribute_map
  {
    :'id' => :'id',
    :'object' => :'object',
    :'provider' => :'provider',
    :'active' => :'active',
    :'email_address' => :'email_address',
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'provider_user_id' => :'provider_user_id',
    :'public_metadata' => :'public_metadata',
    :'verification' => :'verification',
    :'saml_connection' => :'saml_connection'
  }
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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/clerk-http-client/models/saml_account.rb', line 270

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

List of attributes with nullable: true



103
104
105
106
107
108
109
110
111
 
# File 'lib/clerk-http-client/models/saml_account.rb', line 103

def self.openapi_nullable
  Set.new([
    :'first_name',
    :'last_name',
    :'provider_user_id',
    :'verification',
    :'saml_connection'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/clerk-http-client/models/saml_account.rb', line 86

def self.openapi_types
  {
    :'id' => :'String',
    :'object' => :'String',
    :'provider' => :'String',
    :'active' => :'Boolean',
    :'email_address' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'provider_user_id' => :'String',
    :'public_metadata' => :'Object',
    :'verification' => :'SAMLAccountVerification',
    :'saml_connection' => :'SAMLAccountSamlConnection'
  }
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
 
# File 'lib/clerk-http-client/models/saml_account.rb', line 239

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      object == o.object &&
      provider == o.provider &&
      active == o.active &&
      email_address == o.email_address &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      provider_user_id == o.provider_user_id &&
      public_metadata == o.public_metadata &&
      verification == o.verification &&
      saml_connection == o.saml_connection
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



365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/clerk-http-client/models/saml_account.rb', line 365

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


257
258
259
 
# File 'lib/clerk-http-client/models/saml_account.rb', line 257

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



263
264
265
 
# File 'lib/clerk-http-client/models/saml_account.rb', line 263

def hash
  [id, object, provider, active, email_address, first_name, last_name, provider_user_id, public_metadata, verification, saml_connection].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



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
 
# File 'lib/clerk-http-client/models/saml_account.rb', line 187

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

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

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

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

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

  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/clerk-http-client/models/saml_account.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
356
357
358
359
 
# File 'lib/clerk-http-client/models/saml_account.rb', line 347

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



335
336
337
 
# File 'lib/clerk-http-client/models/saml_account.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



215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/clerk-http-client/models/saml_account.rb', line 215

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @object.nil?
  object_validator = EnumAttributeValidator.new('String', ["saml_account"])
  return false unless object_validator.valid?(@object)
  return false if @provider.nil?
  return false if @active.nil?
  return false if @email_address.nil?
  true
end