Class: Authentik::Api::StaticDevice

Inherits:
ApiModelBase show all
Defined in:
lib/authentik/api/models/static_device.rb

Overview

Serializer for static authenticator devices

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ StaticDevice

Initializes the object

Parameters:

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

    Model attributes in the form of hash



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/authentik/api/models/static_device.rb', line 60

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Authentik::Api::StaticDevice` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Authentik::Api::StaticDevice`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  else
    self.name = nil
  end

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

  if attributes.key?(:'pk')
    self.pk = attributes[:'pk']
  else
    self.pk = nil
  end

  if attributes.key?(:'user')
    self.user = attributes[:'user']
  else
    self.user = nil
  end
end

Instance Attribute Details

#name ⇒ Object

The human-readable name of this device.



14
15
16
 
# File 'lib/authentik/api/models/static_device.rb', line 14

def name
  @name
end

#pk ⇒ Object

Returns the value of attribute pk.



18
19
20
 
# File 'lib/authentik/api/models/static_device.rb', line 18

def pk
  @pk
end

#token_set ⇒ Object

Returns the value of attribute token_set.



16
17
18
 
# File 'lib/authentik/api/models/static_device.rb', line 16

def token_set
  @token_set
end

#user ⇒ Object

Returns the value of attribute user.



20
21
22
 
# File 'lib/authentik/api/models/static_device.rb', line 20

def user
  @user
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



33
34
35
 
# File 'lib/authentik/api/models/static_device.rb', line 33

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



38
39
40
 
# File 'lib/authentik/api/models/static_device.rb', line 38

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



23
24
25
26
27
28
29
30
 
# File 'lib/authentik/api/models/static_device.rb', line 23

def self.attribute_map
  {
    :'name' => :'name',
    :'token_set' => :'token_set',
    :'pk' => :'pk',
    :'user' => :'user'
  }
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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/authentik/api/models/static_device.rb', line 211

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



53
54
55
56
 
# File 'lib/authentik/api/models/static_device.rb', line 53

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

.openapi_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
 
# File 'lib/authentik/api/models/static_device.rb', line 43

def self.openapi_types
  {
    :'name' => :'String',
    :'token_set' => :'Array<StaticDeviceToken>',
    :'pk' => :'Integer',
    :'user' => :'PartialUser'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



187
188
189
190
191
192
193
194
 
# File 'lib/authentik/api/models/static_device.rb', line 187

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      token_set == o.token_set &&
      pk == o.pk &&
      user == o.user
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


198
199
200
 
# File 'lib/authentik/api/models/static_device.rb', line 198

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



204
205
206
 
# File 'lib/authentik/api/models/static_device.rb', line 204

def hash
  [name, token_set, pk, user].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



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
 
# File 'lib/authentik/api/models/static_device.rb', line 103

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

  if @name.to_s.length > 64
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 64.')
  end

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

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

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/authentik/api/models/static_device.rb', line 233

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



131
132
133
134
135
136
137
138
139
 
# File 'lib/authentik/api/models/static_device.rb', line 131

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @name.to_s.length > 64
  return false if @token_set.nil?
  return false if @pk.nil?
  return false if @user.nil?
  true
end