Class: Authentik::Api::Permission

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

Overview

Global permission

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

Instance Attribute Details

#app_label ⇒ Object

Returns the value of attribute app_label.



21
22
23
 
# File 'lib/authentik/api/models/permission.rb', line 21

def app_label
  @app_label
end

#app_label_verbose ⇒ Object

Human-readable app label



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

def app_label_verbose
  @app_label_verbose
end

#codename ⇒ Object

Returns the value of attribute codename.



17
18
19
 
# File 'lib/authentik/api/models/permission.rb', line 17

def codename
  @codename
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#model ⇒ Object

Returns the value of attribute model.



19
20
21
 
# File 'lib/authentik/api/models/permission.rb', line 19

def model
  @model
end

#model_verbose ⇒ Object

Human-readable model name



27
28
29
 
# File 'lib/authentik/api/models/permission.rb', line 27

def model_verbose
  @model_verbose
end

#name ⇒ Object

Returns the value of attribute name.



15
16
17
 
# File 'lib/authentik/api/models/permission.rb', line 15

def name
  @name
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



43
44
45
 
# File 'lib/authentik/api/models/permission.rb', line 43

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



48
49
50
 
# File 'lib/authentik/api/models/permission.rb', line 48

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/authentik/api/models/permission.rb', line 30

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'codename' => :'codename',
    :'model' => :'model',
    :'app_label' => :'app_label',
    :'app_label_verbose' => :'app_label_verbose',
    :'model_verbose' => :'model_verbose'
  }
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



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/authentik/api/models/permission.rb', line 297

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



66
67
68
69
 
# File 'lib/authentik/api/models/permission.rb', line 66

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

.openapi_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/authentik/api/models/permission.rb', line 53

def self.openapi_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'codename' => :'String',
    :'model' => :'String',
    :'app_label' => :'String',
    :'app_label_verbose' => :'String',
    :'model_verbose' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/authentik/api/models/permission.rb', line 270

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      codename == o.codename &&
      model == o.model &&
      app_label == o.app_label &&
      app_label_verbose == o.app_label_verbose &&
      model_verbose == o.model_verbose
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


284
285
286
 
# File 'lib/authentik/api/models/permission.rb', line 284

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



290
291
292
 
# File 'lib/authentik/api/models/permission.rb', line 290

def hash
  [id, name, codename, model, app_label, app_label_verbose, model_verbose].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



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

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

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

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

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

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

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

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

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

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



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/authentik/api/models/permission.rb', line 319

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



176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/authentik/api/models/permission.rb', line 176

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @name.nil?
  return false if @name.to_s.length > 255
  return false if @codename.nil?
  return false if @codename.to_s.length > 100
  return false if @model.nil?
  return false if @app_label.nil?
  return false if @app_label_verbose.nil?
  return false if @model_verbose.nil?
  true
end