Class: Authentik::Api::PlexSource

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

Overview

Plex Source 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 = {}) ⇒ PlexSource

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
321
322
323
324
325
326
 
# File 'lib/authentik/api/models/plex_source.rb', line 185

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#allow_friends ⇒ Object

Allow friends to authenticate, even if you don’t share a server.



74
75
76
 
# File 'lib/authentik/api/models/plex_source.rb', line 74

def allow_friends
  @allow_friends
end

#allowed_servers ⇒ Object

Which servers a user has to be a member of to be granted access. Empty list allows every server.



71
72
73
 
# File 'lib/authentik/api/models/plex_source.rb', line 71

def allowed_servers
  @allowed_servers
end

#authentication_flow ⇒ Object

Flow to use when authenticating existing users.



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

def authentication_flow
  @authentication_flow
end

#client_id ⇒ Object

Client identifier used to talk to Plex.



68
69
70
 
# File 'lib/authentik/api/models/plex_source.rb', line 68

def client_id
  @client_id
end

#component ⇒ Object

Get object component so that we know how to edit the object



37
38
39
 
# File 'lib/authentik/api/models/plex_source.rb', line 37

def component
  @component
end

#enabled ⇒ Object

Returns the value of attribute enabled.



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

def enabled
  @enabled
end

#enrollment_flow ⇒ Object

Flow to use when enrolling new users.



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

def enrollment_flow
  @enrollment_flow
end

#group_matching_mode ⇒ Object

How the source determines if an existing group should be used or a new group created.



65
66
67
 
# File 'lib/authentik/api/models/plex_source.rb', line 65

def group_matching_mode
  @group_matching_mode
end

#group_property_mappings ⇒ Object

Returns the value of attribute group_property_mappings.



34
35
36
 
# File 'lib/authentik/api/models/plex_source.rb', line 34

def group_property_mappings
  @group_property_mappings
end

#icon ⇒ Object

Returns the value of attribute icon.



58
59
60
 
# File 'lib/authentik/api/models/plex_source.rb', line 58

def icon
  @icon
end

#icon_themed_urls ⇒ Object

Returns the value of attribute icon_themed_urls.



62
63
64
 
# File 'lib/authentik/api/models/plex_source.rb', line 62

def icon_themed_urls
  @icon_themed_urls
end

#icon_url ⇒ Object

Returns the value of attribute icon_url.



60
61
62
 
# File 'lib/authentik/api/models/plex_source.rb', line 60

def icon_url
  @icon_url
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.



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

def managed
  @managed
end

#meta_model_name ⇒ Object

Return internal model name



46
47
48
 
# File 'lib/authentik/api/models/plex_source.rb', line 46

def meta_model_name
  @meta_model_name
end

#name ⇒ Object

Source’s display Name.



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

def name
  @name
end

#pk ⇒ Object

Returns the value of attribute pk.



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

def pk
  @pk
end

#plex_token ⇒ Object

Plex token used to check friends



77
78
79
 
# File 'lib/authentik/api/models/plex_source.rb', line 77

def plex_token
  @plex_token
end

#policy_engine_mode ⇒ Object

Returns the value of attribute policy_engine_mode.



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

def policy_engine_mode
  @policy_engine_mode
end

When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.



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

def promoted
  @promoted
end

#slug ⇒ Object

Internal source name, used in URLs.



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

def slug
  @slug
end

#user_matching_mode ⇒ Object

How the source determines if an existing user should be authenticated or a new user enrolled.



51
52
53
 
# File 'lib/authentik/api/models/plex_source.rb', line 51

def user_matching_mode
  @user_matching_mode
end

#user_path_template ⇒ Object

Returns the value of attribute user_path_template.



56
57
58
 
# File 'lib/authentik/api/models/plex_source.rb', line 56

def user_path_template
  @user_path_template
end

#user_property_mappings ⇒ Object

Returns the value of attribute user_property_mappings.



32
33
34
 
# File 'lib/authentik/api/models/plex_source.rb', line 32

def user_property_mappings
  @user_property_mappings
end

#verbose_name ⇒ Object

Return object’s verbose_name



40
41
42
 
# File 'lib/authentik/api/models/plex_source.rb', line 40

def verbose_name
  @verbose_name
end

#verbose_name_plural ⇒ Object

Return object’s plural verbose_name



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

def verbose_name_plural
  @verbose_name_plural
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



133
134
135
 
# File 'lib/authentik/api/models/plex_source.rb', line 133

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



138
139
140
 
# File 'lib/authentik/api/models/plex_source.rb', line 138

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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
129
130
 
# File 'lib/authentik/api/models/plex_source.rb', line 102

def self.attribute_map
  {
    :'pk' => :'pk',
    :'name' => :'name',
    :'slug' => :'slug',
    :'enabled' => :'enabled',
    :'promoted' => :'promoted',
    :'authentication_flow' => :'authentication_flow',
    :'enrollment_flow' => :'enrollment_flow',
    :'user_property_mappings' => :'user_property_mappings',
    :'group_property_mappings' => :'group_property_mappings',
    :'component' => :'component',
    :'verbose_name' => :'verbose_name',
    :'verbose_name_plural' => :'verbose_name_plural',
    :'meta_model_name' => :'meta_model_name',
    :'policy_engine_mode' => :'policy_engine_mode',
    :'user_matching_mode' => :'user_matching_mode',
    :'managed' => :'managed',
    :'user_path_template' => :'user_path_template',
    :'icon' => :'icon',
    :'icon_url' => :'icon_url',
    :'icon_themed_urls' => :'icon_themed_urls',
    :'group_matching_mode' => :'group_matching_mode',
    :'client_id' => :'client_id',
    :'allowed_servers' => :'allowed_servers',
    :'allow_friends' => :'allow_friends',
    :'plex_token' => :'plex_token'
  }
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



536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
 
# File 'lib/authentik/api/models/plex_source.rb', line 536

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



174
175
176
177
178
179
180
181
 
# File 'lib/authentik/api/models/plex_source.rb', line 174

def self.openapi_nullable
  Set.new([
    :'authentication_flow',
    :'enrollment_flow',
    :'managed',
    :'icon_themed_urls',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'pk' => :'String',
    :'name' => :'String',
    :'slug' => :'String',
    :'enabled' => :'Boolean',
    :'promoted' => :'Boolean',
    :'authentication_flow' => :'String',
    :'enrollment_flow' => :'String',
    :'user_property_mappings' => :'Array<String>',
    :'group_property_mappings' => :'Array<String>',
    :'component' => :'String',
    :'verbose_name' => :'String',
    :'verbose_name_plural' => :'String',
    :'meta_model_name' => :'String',
    :'policy_engine_mode' => :'PolicyEngineMode',
    :'user_matching_mode' => :'UserMatchingModeEnum',
    :'managed' => :'String',
    :'user_path_template' => :'String',
    :'icon' => :'String',
    :'icon_url' => :'String',
    :'icon_themed_urls' => :'ThemedUrls',
    :'group_matching_mode' => :'GroupMatchingModeEnum',
    :'client_id' => :'String',
    :'allowed_servers' => :'Array<String>',
    :'allow_friends' => :'Boolean',
    :'plex_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
 
# File 'lib/authentik/api/models/plex_source.rb', line 491

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      pk == o.pk &&
      name == o.name &&
      slug == o.slug &&
      enabled == o.enabled &&
      promoted == o.promoted &&
      authentication_flow == o.authentication_flow &&
      enrollment_flow == o.enrollment_flow &&
      user_property_mappings == o.user_property_mappings &&
      group_property_mappings == o.group_property_mappings &&
      component == o.component &&
      verbose_name == o.verbose_name &&
      verbose_name_plural == o.verbose_name_plural &&
      meta_model_name == o.meta_model_name &&
      policy_engine_mode == o.policy_engine_mode &&
      user_matching_mode == o.user_matching_mode &&
      managed == o.managed &&
      user_path_template == o.user_path_template &&
      icon == o.icon &&
      icon_url == o.icon_url &&
      icon_themed_urls == o.icon_themed_urls &&
      group_matching_mode == o.group_matching_mode &&
      client_id == o.client_id &&
      allowed_servers == o.allowed_servers &&
      allow_friends == o.allow_friends &&
      plex_token == o.plex_token
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


523
524
525
 
# File 'lib/authentik/api/models/plex_source.rb', line 523

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



529
530
531
 
# File 'lib/authentik/api/models/plex_source.rb', line 529

def hash
  [pk, name, slug, enabled, promoted, authentication_flow, enrollment_flow, user_property_mappings, group_property_mappings, component, verbose_name, verbose_name_plural, meta_model_name, policy_engine_mode, user_matching_mode, managed, user_path_template, icon, icon_url, icon_themed_urls, group_matching_mode, client_id, allowed_servers, allow_friends, plex_token].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



330
331
332
333
334
335
336
337
338
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
372
373
374
375
 
# File 'lib/authentik/api/models/plex_source.rb', line 330

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 @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

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

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

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

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

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

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

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

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



558
559
560
561
562
563
564
565
566
567
568
569
570
 
# File 'lib/authentik/api/models/plex_source.rb', line 558

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



379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/authentik/api/models/plex_source.rb', line 379

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @pk.nil?
  return false if @name.nil?
  return false if @slug.nil?
  return false if @slug !~ Regexp.new(/^[-a-zA-Z0-9_]+$/)
  return false if @component.nil?
  return false if @verbose_name.nil?
  return false if @verbose_name_plural.nil?
  return false if @meta_model_name.nil?
  return false if @icon_url.nil?
  return false if @plex_token.nil?
  true
end