Class: ClerkHttpClient::Organization

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Organization

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
187
188
189
190
191
192
193
194
 
# File 'lib/clerk-http-client/models/organization.rb', line 116

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#admin_delete_enabled ⇒ Object

Returns the value of attribute admin_delete_enabled.



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

def admin_delete_enabled
  @admin_delete_enabled
end

#created_at ⇒ Object

Unix timestamp of creation.



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

def created_at
  @created_at
end

#created_by ⇒ Object

Returns the value of attribute created_by.



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

def created_by
  @created_by
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#max_allowed_memberships ⇒ Object

Returns the value of attribute max_allowed_memberships.



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

def max_allowed_memberships
  @max_allowed_memberships
end

#members_count ⇒ Object

Returns the value of attribute members_count.



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

def members_count
  @members_count
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#object ⇒ Object

Returns the value of attribute object.



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

def object
  @object
end

#private_metadata ⇒ Object

Returns the value of attribute private_metadata.



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

def private_metadata
  @private_metadata
end

#public_metadata ⇒ Object

Returns the value of attribute public_metadata.



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

def public_metadata
  @public_metadata
end

#slug ⇒ Object

Returns the value of attribute slug.



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

def slug
  @slug
end

#updated_at ⇒ Object

Unix timestamp of last update.



42
43
44
 
# File 'lib/clerk-http-client/models/organization.rb', line 42

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



326
327
328
329
330
331
332
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
 
# File 'lib/clerk-http-client/models/organization.rb', line 326

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



85
86
87
 
# File 'lib/clerk-http-client/models/organization.rb', line 85

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/clerk-http-client/models/organization.rb', line 67

def self.attribute_map
  {
    :'object' => :'object',
    :'id' => :'id',
    :'name' => :'name',
    :'slug' => :'slug',
    :'members_count' => :'members_count',
    :'max_allowed_memberships' => :'max_allowed_memberships',
    :'admin_delete_enabled' => :'admin_delete_enabled',
    :'public_metadata' => :'public_metadata',
    :'private_metadata' => :'private_metadata',
    :'created_by' => :'created_by',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at'
  }
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
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/clerk-http-client/models/organization.rb', line 302

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



108
109
110
111
112
 
# File 'lib/clerk-http-client/models/organization.rb', line 108

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

.openapi_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/clerk-http-client/models/organization.rb', line 90

def self.openapi_types
  {
    :'object' => :'String',
    :'id' => :'String',
    :'name' => :'String',
    :'slug' => :'String',
    :'members_count' => :'Integer',
    :'max_allowed_memberships' => :'Integer',
    :'admin_delete_enabled' => :'Boolean',
    :'public_metadata' => :'Object',
    :'private_metadata' => :'Object',
    :'created_by' => :'String',
    :'created_at' => :'Integer',
    :'updated_at' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      object == o.object &&
      id == o.id &&
      name == o.name &&
      slug == o.slug &&
      members_count == o.members_count &&
      max_allowed_memberships == o.max_allowed_memberships &&
      admin_delete_enabled == o.admin_delete_enabled &&
      public_metadata == o.public_metadata &&
      private_metadata == o.private_metadata &&
      created_by == o.created_by &&
      created_at == o.created_at &&
      updated_at == o.updated_at
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



397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/clerk-http-client/models/organization.rb', line 397

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


289
290
291
 
# File 'lib/clerk-http-client/models/organization.rb', line 289

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



295
296
297
 
# File 'lib/clerk-http-client/models/organization.rb', line 295

def hash
  [object, id, name, slug, members_count, max_allowed_memberships, admin_delete_enabled, public_metadata, private_metadata, created_by, created_at, updated_at].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



198
199
200
201
202
203
204
205
206
207
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
 
# File 'lib/clerk-http-client/models/organization.rb', line 198

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

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

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

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

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

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

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

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

  if @updated_at.nil?
    invalid_properties.push('invalid value for "updated_at", updated_at 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



373
374
375
 
# File 'lib/clerk-http-client/models/organization.rb', line 373

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



379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/clerk-http-client/models/organization.rb', line 379

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



367
368
369
 
# File 'lib/clerk-http-client/models/organization.rb', line 367

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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/clerk-http-client/models/organization.rb', line 242

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @object.nil?
  object_validator = EnumAttributeValidator.new('String', ["organization"])
  return false unless object_validator.valid?(@object)
  return false if @id.nil?
  return false if @name.nil?
  return false if @slug.nil?
  return false if @max_allowed_memberships.nil?
  return false if @public_metadata.nil?
  return false if @private_metadata.nil?
  return false if @created_at.nil?
  return false if @updated_at.nil?
  true
end