Class: ClerkHttpClient::UpdateInstanceRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateInstanceRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/clerk-http-client/models/update_instance_request.rb', line 91

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#allowed_origins ⇒ Object

For browser-like stacks such as browser extensions, Electron, or Capacitor.js the instance allowed origins need to be updated with the request origin value. For Chrome extensions popup, background, or service worker pages the origin is chrome-extension://extension_uiid. For Electron apps the default origin is localhost:3000. For Capacitor, the origin is capacitor://localhost.



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

def allowed_origins
  @allowed_origins
end

#clerk_js_version ⇒ Object

Returns the value of attribute clerk_js_version.



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

def clerk_js_version
  @clerk_js_version
end

#cookieless_dev ⇒ Object

Whether the instance should operate in cookieless development mode (i.e. without third-party cookies). Deprecated: Please use ‘url_based_session_syncing` instead.



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

def cookieless_dev
  @cookieless_dev
end

#development_origin ⇒ Object

Returns the value of attribute development_origin.



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

def development_origin
  @development_origin
end

#enhanced_email_deliverability ⇒ Object

The "enhanced_email_deliverability" feature will send emails from "[email protected]" instead of your domain. This can be helpful if you do not have a high domain reputation.



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

def enhanced_email_deliverability
  @enhanced_email_deliverability
end

#hibp ⇒ Object

Whether the instance should be using the HIBP service to check passwords for breaches



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

def hibp
  @hibp
end

#support_email ⇒ Object

Returns the value of attribute support_email.



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

def support_email
  @support_email
end

#test_mode ⇒ Object

Toggles test mode for this instance, allowing the use of test email addresses and phone numbers. Defaults to true for development instances.



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

def test_mode
  @test_mode
end

#url_based_session_syncing ⇒ Object

Whether the instance should use URL-based session syncing in development mode (i.e. without third-party cookies).



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

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



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
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/clerk-http-client/models/update_instance_request.rb', line 213

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



58
59
60
 
# File 'lib/clerk-http-client/models/update_instance_request.rb', line 58

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/clerk-http-client/models/update_instance_request.rb', line 43

def self.attribute_map
  {
    :'test_mode' => :'test_mode',
    :'hibp' => :'hibp',
    :'enhanced_email_deliverability' => :'enhanced_email_deliverability',
    :'support_email' => :'support_email',
    :'clerk_js_version' => :'clerk_js_version',
    :'development_origin' => :'development_origin',
    :'allowed_origins' => :'allowed_origins',
    :'cookieless_dev' => :'cookieless_dev',
    :'url_based_session_syncing' => :'url_based_session_syncing'
  }
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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/clerk-http-client/models/update_instance_request.rb', line 189

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



78
79
80
81
82
83
84
85
86
87
 
# File 'lib/clerk-http-client/models/update_instance_request.rb', line 78

def self.openapi_nullable
  Set.new([
    :'test_mode',
    :'hibp',
    :'enhanced_email_deliverability',
    :'support_email',
    :'clerk_js_version',
    :'development_origin',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'test_mode' => :'Boolean',
    :'hibp' => :'Boolean',
    :'enhanced_email_deliverability' => :'Boolean',
    :'support_email' => :'String',
    :'clerk_js_version' => :'String',
    :'development_origin' => :'String',
    :'allowed_origins' => :'Array<String>',
    :'cookieless_dev' => :'Boolean',
    :'url_based_session_syncing' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/clerk-http-client/models/update_instance_request.rb', line 160

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      test_mode == o.test_mode &&
      hibp == o.hibp &&
      enhanced_email_deliverability == o.enhanced_email_deliverability &&
      support_email == o.support_email &&
      clerk_js_version == o.clerk_js_version &&
      development_origin == o.development_origin &&
      allowed_origins == o.allowed_origins &&
      cookieless_dev == o.cookieless_dev &&
      url_based_session_syncing == o.url_based_session_syncing
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



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

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


176
177
178
 
# File 'lib/clerk-http-client/models/update_instance_request.rb', line 176

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [test_mode, hibp, enhanced_email_deliverability, support_email, clerk_js_version, development_origin, allowed_origins, cookieless_dev, url_based_session_syncing].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



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

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



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

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



266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/clerk-http-client/models/update_instance_request.rb', line 266

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



254
255
256
 
# File 'lib/clerk-http-client/models/update_instance_request.rb', line 254

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



153
154
155
156
 
# File 'lib/clerk-http-client/models/update_instance_request.rb', line 153

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end