Class: ClerkHttpClient::OrganizationSettings
- Inherits:
-
Object
- Object
- ClerkHttpClient::OrganizationSettings
- Defined in:
- lib/clerk-http-client/models/organization_settings.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#admin_delete_enabled ⇒ Object
The default for whether an admin can delete an organization with the Frontend API.
-
#creator_role ⇒ Object
The role key that a user will be assigned after creating an organization.
-
#domains_default_role ⇒ Object
The role key that it will be used in order to create an organization invitation or suggestion.
-
#domains_enabled ⇒ Object
Returns the value of attribute domains_enabled.
-
#domains_enrollment_modes ⇒ Object
Returns the value of attribute domains_enrollment_modes.
-
#enabled ⇒ Object
Returns the value of attribute enabled.
-
#max_allowed_memberships ⇒ Object
Returns the value of attribute max_allowed_memberships.
-
#max_allowed_permissions ⇒ Object
Returns the value of attribute max_allowed_permissions.
-
#max_allowed_roles ⇒ Object
Returns the value of attribute max_allowed_roles.
-
#object ⇒ Object
String representing the object’s type.
Class Method Summary collapse
-
._deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ OrganizationSettings
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ OrganizationSettings
Initializes the object
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 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 |
# File 'lib/clerk-http-client/models/organization_settings.rb', line 109 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `ClerkHttpClient::OrganizationSettings` 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::OrganizationSettings`. 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?(:'enabled') self.enabled = attributes[:'enabled'] else self.enabled = nil 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?(:'max_allowed_roles') self.max_allowed_roles = attributes[:'max_allowed_roles'] end if attributes.key?(:'max_allowed_permissions') self. = attributes[:'max_allowed_permissions'] end if attributes.key?(:'creator_role') self.creator_role = attributes[:'creator_role'] else self.creator_role = nil end if attributes.key?(:'admin_delete_enabled') self.admin_delete_enabled = attributes[:'admin_delete_enabled'] else self.admin_delete_enabled = nil end if attributes.key?(:'domains_enabled') self.domains_enabled = attributes[:'domains_enabled'] else self.domains_enabled = nil end if attributes.key?(:'domains_enrollment_modes') if (value = attributes[:'domains_enrollment_modes']).is_a?(Array) self.domains_enrollment_modes = value end else self.domains_enrollment_modes = nil end if attributes.key?(:'domains_default_role') self.domains_default_role = attributes[:'domains_default_role'] else self.domains_default_role = nil end end |
Instance Attribute Details
#admin_delete_enabled ⇒ Object
The default for whether an admin can delete an organization with the Frontend API.
33 34 35 |
# File 'lib/clerk-http-client/models/organization_settings.rb', line 33 def admin_delete_enabled @admin_delete_enabled end |
#creator_role ⇒ Object
The role key that a user will be assigned after creating an organization.
30 31 32 |
# File 'lib/clerk-http-client/models/organization_settings.rb', line 30 def creator_role @creator_role end |
#domains_default_role ⇒ Object
The role key that it will be used in order to create an organization invitation or suggestion.
40 41 42 |
# File 'lib/clerk-http-client/models/organization_settings.rb', line 40 def domains_default_role @domains_default_role end |
#domains_enabled ⇒ Object
Returns the value of attribute domains_enabled.
35 36 37 |
# File 'lib/clerk-http-client/models/organization_settings.rb', line 35 def domains_enabled @domains_enabled end |
#domains_enrollment_modes ⇒ Object
Returns the value of attribute domains_enrollment_modes.
37 38 39 |
# File 'lib/clerk-http-client/models/organization_settings.rb', line 37 def domains_enrollment_modes @domains_enrollment_modes end |
#enabled ⇒ Object
Returns the value of attribute enabled.
21 22 23 |
# File 'lib/clerk-http-client/models/organization_settings.rb', line 21 def enabled @enabled end |
#max_allowed_memberships ⇒ Object
Returns the value of attribute max_allowed_memberships.
23 24 25 |
# File 'lib/clerk-http-client/models/organization_settings.rb', line 23 def max_allowed_memberships @max_allowed_memberships end |
#max_allowed_permissions ⇒ Object
Returns the value of attribute max_allowed_permissions.
27 28 29 |
# File 'lib/clerk-http-client/models/organization_settings.rb', line 27 def end |
#max_allowed_roles ⇒ Object
Returns the value of attribute max_allowed_roles.
25 26 27 |
# File 'lib/clerk-http-client/models/organization_settings.rb', line 25 def max_allowed_roles @max_allowed_roles end |
#object ⇒ Object
String representing the object’s type. Objects of the same type share the same value.
19 20 21 |
# File 'lib/clerk-http-client/models/organization_settings.rb', line 19 def object @object end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 |
# File 'lib/clerk-http-client/models/organization_settings.rb', line 304 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
81 82 83 |
# File 'lib/clerk-http-client/models/organization_settings.rb', line 81 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/clerk-http-client/models/organization_settings.rb', line 65 def self.attribute_map { :'object' => :'object', :'enabled' => :'enabled', :'max_allowed_memberships' => :'max_allowed_memberships', :'max_allowed_roles' => :'max_allowed_roles', :'max_allowed_permissions' => :'max_allowed_permissions', :'creator_role' => :'creator_role', :'admin_delete_enabled' => :'admin_delete_enabled', :'domains_enabled' => :'domains_enabled', :'domains_enrollment_modes' => :'domains_enrollment_modes', :'domains_default_role' => :'domains_default_role' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 |
# File 'lib/clerk-http-client/models/organization_settings.rb', line 280 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
102 103 104 105 |
# File 'lib/clerk-http-client/models/organization_settings.rb', line 102 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
86 87 88 89 90 91 92 93 94 95 96 97 98 99 |
# File 'lib/clerk-http-client/models/organization_settings.rb', line 86 def self.openapi_types { :'object' => :'String', :'enabled' => :'Boolean', :'max_allowed_memberships' => :'Integer', :'max_allowed_roles' => :'Integer', :'max_allowed_permissions' => :'Integer', :'creator_role' => :'String', :'admin_delete_enabled' => :'Boolean', :'domains_enabled' => :'Boolean', :'domains_enrollment_modes' => :'Array<String>', :'domains_default_role' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
250 251 252 253 254 255 256 257 258 259 260 261 262 263 |
# File 'lib/clerk-http-client/models/organization_settings.rb', line 250 def ==(o) return true if self.equal?(o) self.class == o.class && object == o.object && enabled == o.enabled && max_allowed_memberships == o.max_allowed_memberships && max_allowed_roles == o.max_allowed_roles && == o. && creator_role == o.creator_role && admin_delete_enabled == o.admin_delete_enabled && domains_enabled == o.domains_enabled && domains_enrollment_modes == o.domains_enrollment_modes && domains_default_role == o.domains_default_role end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
375 376 377 378 379 380 381 382 383 384 385 386 387 |
# File 'lib/clerk-http-client/models/organization_settings.rb', line 375 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
267 268 269 |
# File 'lib/clerk-http-client/models/organization_settings.rb', line 267 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
273 274 275 |
# File 'lib/clerk-http-client/models/organization_settings.rb', line 273 def hash [object, enabled, max_allowed_memberships, max_allowed_roles, , creator_role, admin_delete_enabled, domains_enabled, domains_enrollment_modes, domains_default_role].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 |
# File 'lib/clerk-http-client/models/organization_settings.rb', line 183 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 @enabled.nil? invalid_properties.push('invalid value for "enabled", enabled 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 @creator_role.nil? invalid_properties.push('invalid value for "creator_role", creator_role cannot be nil.') end if @admin_delete_enabled.nil? invalid_properties.push('invalid value for "admin_delete_enabled", admin_delete_enabled cannot be nil.') end if @domains_enabled.nil? invalid_properties.push('invalid value for "domains_enabled", domains_enabled cannot be nil.') end if @domains_enrollment_modes.nil? invalid_properties.push('invalid value for "domains_enrollment_modes", domains_enrollment_modes cannot be nil.') end if @domains_default_role.nil? invalid_properties.push('invalid value for "domains_default_role", domains_default_role cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
351 352 353 |
# File 'lib/clerk-http-client/models/organization_settings.rb', line 351 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
357 358 359 360 361 362 363 364 365 366 367 368 369 |
# File 'lib/clerk-http-client/models/organization_settings.rb', line 357 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
345 346 347 |
# File 'lib/clerk-http-client/models/organization_settings.rb', line 345 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
223 224 225 226 227 228 229 230 231 232 233 234 235 236 |
# File 'lib/clerk-http-client/models/organization_settings.rb', line 223 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' return false if @object.nil? object_validator = EnumAttributeValidator.new('String', ["organization_settings"]) return false unless object_validator.valid?(@object) return false if @enabled.nil? return false if @max_allowed_memberships.nil? return false if @creator_role.nil? return false if @admin_delete_enabled.nil? return false if @domains_enabled.nil? return false if @domains_enrollment_modes.nil? return false if @domains_default_role.nil? true end |