Class: Akeyless::UpdateAccountSettings

Inherits:
Object
  • Object
show all
Defined in:
lib/akeyless/models/update_account_settings.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateAccountSettings

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
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
318
319
320
 
# File 'lib/akeyless/models/update_account_settings.rb', line 188

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

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

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

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

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

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

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

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

  if attributes.key?(:'invalid_characters')
    self.invalid_characters = attributes[:'invalid_characters']
  else
    self.invalid_characters = 'notReceivedInvalidCharacter'
  end

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

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

  if attributes.key?(:'json')
    self.json = attributes[:'json']
  else
    self.json = false
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address ⇒ Object

Address



19
20
21
 
# File 'lib/akeyless/models/update_account_settings.rb', line 19

def address
  @address
end

#city ⇒ Object

City



22
23
24
 
# File 'lib/akeyless/models/update_account_settings.rb', line 22

def city
  @city
end

#company_name ⇒ Object

Company name



25
26
27
 
# File 'lib/akeyless/models/update_account_settings.rb', line 25

def company_name
  @company_name
end

#country ⇒ Object

Country



28
29
30
 
# File 'lib/akeyless/models/update_account_settings.rb', line 28

def country
  @country
end

#default_key_name ⇒ Object

Set the account default key based on the DFC key name. Use "set-original-akeyless-default-key" to revert to using the original default key of the account.



31
32
33
 
# File 'lib/akeyless/models/update_account_settings.rb', line 31

def default_key_name
  @default_key_name
end

#default_share_link_ttl_minutes ⇒ Object

Set the default ttl in minutes for sharing item number between 60 and 43200



34
35
36
 
# File 'lib/akeyless/models/update_account_settings.rb', line 34

def default_share_link_ttl_minutes
  @default_share_link_ttl_minutes
end

#default_versioning ⇒ Object

If set to true, new item version will be created on each update [true/false]



37
38
39
 
# File 'lib/akeyless/models/update_account_settings.rb', line 37

def default_versioning
  @default_versioning
end

#dp_enable_classic_key_protection ⇒ Object

Set to update protection with classic keys state [true/false]



40
41
42
 
# File 'lib/akeyless/models/update_account_settings.rb', line 40

def dp_enable_classic_key_protection
  @dp_enable_classic_key_protection
end

#invalid_characters ⇒ Object

Characters that cannot be used for items/targets/roles/auths/event_forwarder names. Empty string will enforce nothing.



43
44
45
 
# File 'lib/akeyless/models/update_account_settings.rb', line 43

def invalid_characters
  @invalid_characters
end

#item_type ⇒ Object

VersionSettingsObjectType defines object types for account version settings



46
47
48
 
# File 'lib/akeyless/models/update_account_settings.rb', line 46

def item_type
  @item_type
end

#items_deletion_protection ⇒ Object

Set or unset the default behaviour of items deletion protection [true/false]



49
50
51
 
# File 'lib/akeyless/models/update_account_settings.rb', line 49

def items_deletion_protection
  @items_deletion_protection
end

#json ⇒ Object

Set output format to JSON



52
53
54
 
# File 'lib/akeyless/models/update_account_settings.rb', line 52

def json
  @json
end

#jwt_ttl_default ⇒ Object

Default ttl



55
56
57
 
# File 'lib/akeyless/models/update_account_settings.rb', line 55

def jwt_ttl_default
  @jwt_ttl_default
end

#jwt_ttl_max ⇒ Object

Maximum ttl



58
59
60
 
# File 'lib/akeyless/models/update_account_settings.rb', line 58

def jwt_ttl_max
  @jwt_ttl_max
end

#jwt_ttl_min ⇒ Object

Minimum ttl



61
62
63
 
# File 'lib/akeyless/models/update_account_settings.rb', line 61

def jwt_ttl_min
  @jwt_ttl_min
end

#lock_default_key ⇒ Object

Lock the account's default protection key, if set - users will not be able to use a different protection key, relevant only if default-key-name is configured [true/false]



64
65
66
 
# File 'lib/akeyless/models/update_account_settings.rb', line 64

def lock_default_key
  @lock_default_key
end

#max_versions ⇒ Object

Max versions



67
68
69
 
# File 'lib/akeyless/models/update_account_settings.rb', line 67

def max_versions
  @max_versions
end

#password_length ⇒ Object

Password length between 5 - to 50 characters



70
71
72
 
# File 'lib/akeyless/models/update_account_settings.rb', line 70

def password_length
  @password_length
end

#phone ⇒ Object

Phone number



73
74
75
 
# File 'lib/akeyless/models/update_account_settings.rb', line 73

def phone
  @phone
end

#postal_code ⇒ Object

Postal code



76
77
78
 
# File 'lib/akeyless/models/update_account_settings.rb', line 76

def postal_code
  @postal_code
end

#token ⇒ Object

Authentication token (see /auth and /configure)



79
80
81
 
# File 'lib/akeyless/models/update_account_settings.rb', line 79

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



82
83
84
 
# File 'lib/akeyless/models/update_account_settings.rb', line 82

def uid_token
  @uid_token
end

#usage_event_enable ⇒ Object

Enable event for objects that have not been used or changed [true/false]



85
86
87
 
# File 'lib/akeyless/models/update_account_settings.rb', line 85

def usage_event_enable
  @usage_event_enable
end

#usage_event_interval ⇒ Object

Interval by days for unused objects. Default and minimum interval is 90 days



88
89
90
 
# File 'lib/akeyless/models/update_account_settings.rb', line 88

def usage_event_interval
  @usage_event_interval
end

#usage_event_object_type ⇒ Object

Usage event is supported for auth method or secrets-and-keys [auth/item]



91
92
93
 
# File 'lib/akeyless/models/update_account_settings.rb', line 91

def usage_event_object_type
  @usage_event_object_type
end

#use_capital_letters ⇒ Object

Password must contain capital letters [true/false]



103
104
105
 
# File 'lib/akeyless/models/update_account_settings.rb', line 103

def use_capital_letters
  @use_capital_letters
end

#use_lower_letters ⇒ Object

Password must contain lower case letters [true/false]



94
95
96
 
# File 'lib/akeyless/models/update_account_settings.rb', line 94

def use_lower_letters
  @use_lower_letters
end

#use_numbers ⇒ Object

Password must contain numbers [true/false]



97
98
99
 
# File 'lib/akeyless/models/update_account_settings.rb', line 97

def use_numbers
  @use_numbers
end

#use_special_characters ⇒ Object

Password must contain special characters [true/false]



100
101
102
 
# File 'lib/akeyless/models/update_account_settings.rb', line 100

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



412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/akeyless/models/update_account_settings.rb', line 412

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 = Akeyless.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



141
142
143
 
# File 'lib/akeyless/models/update_account_settings.rb', line 141

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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
 
# File 'lib/akeyless/models/update_account_settings.rb', line 106

def self.attribute_map
  {
    :'address' => :'address',
    :'city' => :'city',
    :'company_name' => :'company-name',
    :'country' => :'country',
    :'default_key_name' => :'default-key-name',
    :'default_share_link_ttl_minutes' => :'default-share-link-ttl-minutes',
    :'default_versioning' => :'default-versioning',
    :'dp_enable_classic_key_protection' => :'dp-enable-classic-key-protection',
    :'invalid_characters' => :'invalid-characters',
    :'item_type' => :'item-type',
    :'items_deletion_protection' => :'items-deletion-protection',
    :'json' => :'json',
    :'jwt_ttl_default' => :'jwt-ttl-default',
    :'jwt_ttl_max' => :'jwt-ttl-max',
    :'jwt_ttl_min' => :'jwt-ttl-min',
    :'lock_default_key' => :'lock-default-key',
    :'max_versions' => :'max-versions',
    :'password_length' => :'password-length',
    :'phone' => :'phone',
    :'postal_code' => :'postal-code',
    :'token' => :'token',
    :'uid_token' => :'uid-token',
    :'usage_event_enable' => :'usage-event-enable',
    :'usage_event_interval' => :'usage-event-interval',
    :'usage_event_object_type' => :'usage-event-object-type',
    :'use_lower_letters' => :'use-lower-letters',
    :'use_numbers' => :'use-numbers',
    :'use_special_characters' => :'use-special-characters',
    :'use_capital_letters' => :'use_capital-letters'
  }
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



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/akeyless/models/update_account_settings.rb', line 388

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



181
182
183
184
 
# File 'lib/akeyless/models/update_account_settings.rb', line 181

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/akeyless/models/update_account_settings.rb', line 146

def self.openapi_types
  {
    :'address' => :'String',
    :'city' => :'String',
    :'company_name' => :'String',
    :'country' => :'String',
    :'default_key_name' => :'String',
    :'default_share_link_ttl_minutes' => :'String',
    :'default_versioning' => :'String',
    :'dp_enable_classic_key_protection' => :'String',
    :'invalid_characters' => :'String',
    :'item_type' => :'String',
    :'items_deletion_protection' => :'String',
    :'json' => :'Boolean',
    :'jwt_ttl_default' => :'Integer',
    :'jwt_ttl_max' => :'Integer',
    :'jwt_ttl_min' => :'Integer',
    :'lock_default_key' => :'String',
    :'max_versions' => :'String',
    :'password_length' => :'Integer',
    :'phone' => :'String',
    :'postal_code' => :'String',
    :'token' => :'String',
    :'uid_token' => :'String',
    :'usage_event_enable' => :'String',
    :'usage_event_interval' => :'Integer',
    :'usage_event_object_type' => :'String',
    :'use_lower_letters' => :'String',
    :'use_numbers' => :'String',
    :'use_special_characters' => :'String',
    :'use_capital_letters' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/akeyless/models/update_account_settings.rb', line 339

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address == o.address &&
      city == o.city &&
      company_name == o.company_name &&
      country == o.country &&
      default_key_name == o.default_key_name &&
      default_share_link_ttl_minutes == o.default_share_link_ttl_minutes &&
      default_versioning == o.default_versioning &&
      dp_enable_classic_key_protection == o.dp_enable_classic_key_protection &&
      invalid_characters == o.invalid_characters &&
      item_type == o.item_type &&
      items_deletion_protection == o.items_deletion_protection &&
      json == o.json &&
      jwt_ttl_default == o.jwt_ttl_default &&
      jwt_ttl_max == o.jwt_ttl_max &&
      jwt_ttl_min == o.jwt_ttl_min &&
      lock_default_key == o.lock_default_key &&
      max_versions == o.max_versions &&
      password_length == o.password_length &&
      phone == o.phone &&
      postal_code == o.postal_code &&
      token == o.token &&
      uid_token == o.uid_token &&
      usage_event_enable == o.usage_event_enable &&
      usage_event_interval == o.usage_event_interval &&
      usage_event_object_type == o.usage_event_object_type &&
      use_lower_letters == o.use_lower_letters &&
      use_numbers == o.use_numbers &&
      use_special_characters == o.use_special_characters &&
      use_capital_letters == o.use_capital_letters
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



483
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/akeyless/models/update_account_settings.rb', line 483

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


375
376
377
 
# File 'lib/akeyless/models/update_account_settings.rb', line 375

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



381
382
383
 
# File 'lib/akeyless/models/update_account_settings.rb', line 381

def hash
  [address, city, company_name, country, default_key_name, default_share_link_ttl_minutes, default_versioning, dp_enable_classic_key_protection, invalid_characters, item_type, items_deletion_protection, json, jwt_ttl_default, jwt_ttl_max, jwt_ttl_min, lock_default_key, max_versions, password_length, phone, postal_code, token, uid_token, usage_event_enable, usage_event_interval, usage_event_object_type, use_lower_letters, use_numbers, use_special_characters, use_capital_letters].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



324
325
326
327
328
 
# File 'lib/akeyless/models/update_account_settings.rb', line 324

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



459
460
461
 
# File 'lib/akeyless/models/update_account_settings.rb', line 459

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



465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/akeyless/models/update_account_settings.rb', line 465

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



453
454
455
 
# File 'lib/akeyless/models/update_account_settings.rb', line 453

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



332
333
334
335
 
# File 'lib/akeyless/models/update_account_settings.rb', line 332

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