Class: ClerkHttpClient::OrganizationInvitation

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

Overview

An organization invitation

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrganizationInvitation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

Unix timestamp of creation.



44
45
46
 
# File 'lib/clerk-http-client/models/organization_invitation.rb', line 44

def created_at
  @created_at
end

#email_address ⇒ Object

Returns the value of attribute email_address.



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

def email_address
  @email_address
end

#expires_at ⇒ Object

Unix timestamp of expiration.



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

def expires_at
  @expires_at
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#object ⇒ Object

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



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

def object
  @object
end

#organization_id ⇒ Object

Returns the value of attribute organization_id.



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

def organization_id
  @organization_id
end

#private_metadata ⇒ Object

Returns the value of attribute private_metadata.



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

def private_metadata
  @private_metadata
end

#public_metadata ⇒ Object

Returns the value of attribute public_metadata.



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

def public_metadata
  @public_metadata
end

#role ⇒ Object

Returns the value of attribute role.



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

def role
  @role
end

#role_name ⇒ Object

Returns the value of attribute role_name.



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

def role_name
  @role_name
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#updated_at ⇒ Object

Unix timestamp of last update.



47
48
49
 
# File 'lib/clerk-http-client/models/organization_invitation.rb', line 47

def updated_at
  @updated_at
end

#url ⇒ Object

Returns the value of attribute url.



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

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



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/clerk-http-client/models/organization_invitation.rb', line 280

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



91
92
93
 
# File 'lib/clerk-http-client/models/organization_invitation.rb', line 91

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/clerk-http-client/models/organization_invitation.rb', line 72

def self.attribute_map
  {
    :'id' => :'id',
    :'object' => :'object',
    :'email_address' => :'email_address',
    :'role' => :'role',
    :'role_name' => :'role_name',
    :'organization_id' => :'organization_id',
    :'status' => :'status',
    :'public_metadata' => :'public_metadata',
    :'private_metadata' => :'private_metadata',
    :'url' => :'url',
    :'expires_at' => :'expires_at',
    :'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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/clerk-http-client/models/organization_invitation.rb', line 256

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



115
116
117
118
119
120
 
# File 'lib/clerk-http-client/models/organization_invitation.rb', line 115

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

.openapi_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/clerk-http-client/models/organization_invitation.rb', line 96

def self.openapi_types
  {
    :'id' => :'String',
    :'object' => :'String',
    :'email_address' => :'String',
    :'role' => :'String',
    :'role_name' => :'String',
    :'organization_id' => :'String',
    :'status' => :'String',
    :'public_metadata' => :'Hash<String, Object>',
    :'private_metadata' => :'Hash<String, Object>',
    :'url' => :'String',
    :'expires_at' => :'Integer',
    :'created_at' => :'Integer',
    :'updated_at' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/clerk-http-client/models/organization_invitation.rb', line 223

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      object == o.object &&
      email_address == o.email_address &&
      role == o.role &&
      role_name == o.role_name &&
      organization_id == o.organization_id &&
      status == o.status &&
      public_metadata == o.public_metadata &&
      private_metadata == o.private_metadata &&
      url == o.url &&
      expires_at == o.expires_at &&
      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



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/clerk-http-client/models/organization_invitation.rb', line 351

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


243
244
245
 
# File 'lib/clerk-http-client/models/organization_invitation.rb', line 243

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



249
250
251
 
# File 'lib/clerk-http-client/models/organization_invitation.rb', line 249

def hash
  [id, object, email_address, role, role_name, organization_id, status, public_metadata, private_metadata, url, expires_at, 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



196
197
198
199
200
 
# File 'lib/clerk-http-client/models/organization_invitation.rb', line 196

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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



327
328
329
 
# File 'lib/clerk-http-client/models/organization_invitation.rb', line 327

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



333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/clerk-http-client/models/organization_invitation.rb', line 333

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



321
322
323
 
# File 'lib/clerk-http-client/models/organization_invitation.rb', line 321

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



204
205
206
207
208
209
 
# File 'lib/clerk-http-client/models/organization_invitation.rb', line 204

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  object_validator = EnumAttributeValidator.new('String', ["organization_invitation"])
  return false unless object_validator.valid?(@object)
  true
end