Class: ClerkHttpClient::CreateOrganizationInvitationRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateOrganizationInvitationRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/clerk-http-client/models/create_organization_invitation_request.rb', line 80

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

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

  if attributes.key?(:'role')
    self.role = attributes[:'role']
  else
    self.role = nil
  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?(:'redirect_url')
    self.redirect_url = attributes[:'redirect_url']
  end

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

Instance Attribute Details

#email_address ⇒ Object

The email address of the new member that is going to be invited to the organization



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

def email_address
  @email_address
end

#expires_in_days ⇒ Object

The number of days the invitation will be valid for. By default, the invitation has a 30 days expire.



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

def expires_in_days
  @expires_in_days
end

#inviter_user_id ⇒ Object

The ID of the user that invites the new member to the organization. Must be an administrator in the organization.



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

def inviter_user_id
  @inviter_user_id
end

#private_metadata ⇒ Object

Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API. When the organization invitation is accepted, the metadata will be transferred to the newly created organization membership.



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

def private_metadata
  @private_metadata
end

#public_metadata ⇒ Object

Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API. When the organization invitation is accepted, the metadata will be transferred to the newly created organization membership.



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

def public_metadata
  @public_metadata
end

#redirect_url ⇒ Object

Optional URL that the invitee will be redirected to once they accept the invitation by clicking the join link in the invitation email.



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

def redirect_url
  @redirect_url
end

#role ⇒ Object

The role of the new member in the organization



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

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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/clerk-http-client/models/create_organization_invitation_request.rb', line 232

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



53
54
55
 
# File 'lib/clerk-http-client/models/create_organization_invitation_request.rb', line 53

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/clerk-http-client/models/create_organization_invitation_request.rb', line 40

def self.attribute_map
  {
    :'email_address' => :'email_address',
    :'inviter_user_id' => :'inviter_user_id',
    :'role' => :'role',
    :'public_metadata' => :'public_metadata',
    :'private_metadata' => :'private_metadata',
    :'redirect_url' => :'redirect_url',
    :'expires_in_days' => :'expires_in_days'
  }
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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/clerk-http-client/models/create_organization_invitation_request.rb', line 208

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



71
72
73
74
75
76
 
# File 'lib/clerk-http-client/models/create_organization_invitation_request.rb', line 71

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

.openapi_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/clerk-http-client/models/create_organization_invitation_request.rb', line 58

def self.openapi_types
  {
    :'email_address' => :'String',
    :'inviter_user_id' => :'String',
    :'role' => :'String',
    :'public_metadata' => :'Hash<String, Object>',
    :'private_metadata' => :'Hash<String, Object>',
    :'redirect_url' => :'String',
    :'expires_in_days' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/clerk-http-client/models/create_organization_invitation_request.rb', line 181

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      email_address == o.email_address &&
      inviter_user_id == o.inviter_user_id &&
      role == o.role &&
      public_metadata == o.public_metadata &&
      private_metadata == o.private_metadata &&
      redirect_url == o.redirect_url &&
      expires_in_days == o.expires_in_days
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



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/clerk-http-client/models/create_organization_invitation_request.rb', line 303

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


195
196
197
 
# File 'lib/clerk-http-client/models/create_organization_invitation_request.rb', line 195

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



201
202
203
 
# File 'lib/clerk-http-client/models/create_organization_invitation_request.rb', line 201

def hash
  [email_address, inviter_user_id, role, public_metadata, private_metadata, redirect_url, expires_in_days].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



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/clerk-http-client/models/create_organization_invitation_request.rb', line 132

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

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

  if !@expires_in_days.nil? && @expires_in_days > 365
    invalid_properties.push('invalid value for "expires_in_days", must be smaller than or equal to 365.')
  end

  if !@expires_in_days.nil? && @expires_in_days < 1
    invalid_properties.push('invalid value for "expires_in_days", must be greater than or equal to 1.')
  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



279
280
281
 
# File 'lib/clerk-http-client/models/create_organization_invitation_request.rb', line 279

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



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/clerk-http-client/models/create_organization_invitation_request.rb', line 285

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



273
274
275
 
# File 'lib/clerk-http-client/models/create_organization_invitation_request.rb', line 273

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



156
157
158
159
160
161
162
163
 
# File 'lib/clerk-http-client/models/create_organization_invitation_request.rb', line 156

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @email_address.nil?
  return false if @role.nil?
  return false if !@expires_in_days.nil? && @expires_in_days > 365
  return false if !@expires_in_days.nil? && @expires_in_days < 1
  true
end