Class: Authentik::Api::Token

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

Overview

Token Serializer

Defined Under Namespace

Classes: EnumAttributeValidator

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 = {}) ⇒ Token

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/authentik/api/models/token.rb', line 104

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#description ⇒ Object

Returns the value of attribute description.



26
27
28
 
# File 'lib/authentik/api/models/token.rb', line 26

def description
  @description
end

#expires ⇒ Object

Returns the value of attribute expires.



28
29
30
 
# File 'lib/authentik/api/models/token.rb', line 28

def expires
  @expires
end

#expiring ⇒ Object

Returns the value of attribute expiring.



30
31
32
 
# File 'lib/authentik/api/models/token.rb', line 30

def expiring
  @expiring
end

#identifier ⇒ Object

Returns the value of attribute identifier.



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

def identifier
  @identifier
end

#intent ⇒ Object

Returns the value of attribute intent.



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

def intent
  @intent
end

#managed ⇒ Object

Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.



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

def managed
  @managed
end

#pk ⇒ Object

Returns the value of attribute pk.



13
14
15
 
# File 'lib/authentik/api/models/token.rb', line 13

def pk
  @pk
end

#user ⇒ Object

Returns the value of attribute user.



22
23
24
 
# File 'lib/authentik/api/models/token.rb', line 22

def user
  @user
end

#user_obj ⇒ Object

Returns the value of attribute user_obj.



24
25
26
 
# File 'lib/authentik/api/models/token.rb', line 24

def user_obj
  @user_obj
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



70
71
72
 
# File 'lib/authentik/api/models/token.rb', line 70

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/authentik/api/models/token.rb', line 75

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/authentik/api/models/token.rb', line 55

def self.attribute_map
  {
    :'pk' => :'pk',
    :'managed' => :'managed',
    :'identifier' => :'identifier',
    :'intent' => :'intent',
    :'user' => :'user',
    :'user_obj' => :'user_obj',
    :'description' => :'description',
    :'expires' => :'expires',
    :'expiring' => :'expiring'
  }
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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/authentik/api/models/token.rb', line 272

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



95
96
97
98
99
100
 
# File 'lib/authentik/api/models/token.rb', line 95

def self.openapi_nullable
  Set.new([
    :'managed',
    :'expires',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/authentik/api/models/token.rb', line 80

def self.openapi_types
  {
    :'pk' => :'String',
    :'managed' => :'String',
    :'identifier' => :'String',
    :'intent' => :'IntentEnum',
    :'user' => :'Integer',
    :'user_obj' => :'User',
    :'description' => :'String',
    :'expires' => :'Time',
    :'expiring' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/authentik/api/models/token.rb', line 243

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      pk == o.pk &&
      managed == o.managed &&
      identifier == o.identifier &&
      intent == o.intent &&
      user == o.user &&
      user_obj == o.user_obj &&
      description == o.description &&
      expires == o.expires &&
      expiring == o.expiring
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


259
260
261
 
# File 'lib/authentik/api/models/token.rb', line 259

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



265
266
267
 
# File 'lib/authentik/api/models/token.rb', line 265

def hash
  [pk, managed, identifier, intent, user, user_obj, description, expires, expiring].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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/authentik/api/models/token.rb', line 163

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

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

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

  pattern = Regexp.new(/^[-a-zA-Z0-9_]+$/)
  if @identifier !~ pattern
    invalid_properties.push("invalid value for \"identifier\", must conform to the pattern #{pattern}.")
  end

  if @user_obj.nil?
    invalid_properties.push('invalid value for "user_obj", user_obj 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



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/authentik/api/models/token.rb', line 294

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



192
193
194
195
196
197
198
199
200
 
# File 'lib/authentik/api/models/token.rb', line 192

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @pk.nil?
  return false if @identifier.nil?
  return false if @identifier.to_s.length > 255
  return false if @identifier !~ Regexp.new(/^[-a-zA-Z0-9_]+$/)
  return false if @user_obj.nil?
  true
end