Class: ClerkHttpClient::CreateBulkInvitationsRequestInner

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateBulkInvitationsRequestInner

Initializes the object



76
77
78
79
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
 
# File 'lib/clerk-http-client/models/create_bulk_invitations_request_inner.rb', line 76

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

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

  if attributes.key?(:'notify')
    self.notify = attributes[:'notify']
  else
    self.notify = true
  end

  if attributes.key?(:'ignore_existing')
    self.ignore_existing = attributes[:'ignore_existing']
  else
    self.ignore_existing = false
  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 the invitation will be sent to



19
20
21
 
# File 'lib/clerk-http-client/models/create_bulk_invitations_request_inner.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 expires after 30 days.



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

def expires_in_days
  @expires_in_days
end

#ignore_existing ⇒ Object

Whether an invitation should be created if there is already an existing invitation for this email address, or it’s claimed by another user.



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

def ignore_existing
  @ignore_existing
end

#notify ⇒ Object

Optional flag which denotes whether an email invitation should be sent to the given email address. Defaults to true.



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

def notify
  @notify
end

#public_metadata ⇒ Object

Metadata that will be attached to the newly created invitation. The value of this property should be a well-formed JSON object. Once the user accepts the invitation and signs up, these metadata will end up in the user’s public metadata.



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

def public_metadata
  @public_metadata
end

#redirect_url ⇒ Object

The URL where the user is redirected upon visiting the invitation link, where they can accept the invitation. Required if you have implemented a [custom flow for handling application invitations](/docs/custom-flows/invitations).



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

def redirect_url
  @redirect_url
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/clerk-http-client/models/create_bulk_invitations_request_inner.rb', line 218

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



49
50
51
 
# File 'lib/clerk-http-client/models/create_bulk_invitations_request_inner.rb', line 49

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/clerk-http-client/models/create_bulk_invitations_request_inner.rb', line 37

def self.attribute_map
  {
    :'email_address' => :'email_address',
    :'public_metadata' => :'public_metadata',
    :'redirect_url' => :'redirect_url',
    :'notify' => :'notify',
    :'ignore_existing' => :'ignore_existing',
    :'expires_in_days' => :'expires_in_days'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/clerk-http-client/models/create_bulk_invitations_request_inner.rb', line 194

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



66
67
68
69
70
71
72
 
# File 'lib/clerk-http-client/models/create_bulk_invitations_request_inner.rb', line 66

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

.openapi_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
 
# File 'lib/clerk-http-client/models/create_bulk_invitations_request_inner.rb', line 54

def self.openapi_types
  {
    :'email_address' => :'String',
    :'public_metadata' => :'Hash<String, Object>',
    :'redirect_url' => :'String',
    :'notify' => :'Boolean',
    :'ignore_existing' => :'Boolean',
    :'expires_in_days' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



168
169
170
171
172
173
174
175
176
177
 
# File 'lib/clerk-http-client/models/create_bulk_invitations_request_inner.rb', line 168

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



289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/clerk-http-client/models/create_bulk_invitations_request_inner.rb', line 289

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

See Also:

  • `==` method


181
182
183
 
# File 'lib/clerk-http-client/models/create_bulk_invitations_request_inner.rb', line 181

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



187
188
189
 
# File 'lib/clerk-http-client/models/create_bulk_invitations_request_inner.rb', line 187

def hash
  [email_address, public_metadata, redirect_url, notify, ignore_existing, expires_in_days].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/clerk-http-client/models/create_bulk_invitations_request_inner.rb', line 124

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 !@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)



265
266
267
 
# File 'lib/clerk-http-client/models/create_bulk_invitations_request_inner.rb', line 265

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



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

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



259
260
261
 
# File 'lib/clerk-http-client/models/create_bulk_invitations_request_inner.rb', line 259

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



144
145
146
147
148
149
150
 
# File 'lib/clerk-http-client/models/create_bulk_invitations_request_inner.rb', line 144

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @email_address.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