Class: Comet::AdminUserPermissions

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/admin_user_permissions.rb

Overview

AdminUserPermissions is a typed class wrapper around the underlying Comet Server API data structure.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ AdminUserPermissions

Returns a new instance of AdminUserPermissions.



42
43
44
 
# File 'lib/comet/models/admin_user_permissions.rb', line 42

def initialize
  clear
end

Instance Attribute Details

#allow_edit_branding ⇒ Object

Returns the value of attribute allow_edit_branding.



25
26
27
 
# File 'lib/comet/models/admin_user_permissions.rb', line 25

def allow_edit_branding
  @allow_edit_branding
end

#allow_edit_email_options ⇒ Object

Returns the value of attribute allow_edit_email_options.



28
29
30
 
# File 'lib/comet/models/admin_user_permissions.rb', line 28

def allow_edit_email_options
  @allow_edit_email_options
end

#allow_edit_remote_storage ⇒ Object

Returns the value of attribute allow_edit_remote_storage.



31
32
33
 
# File 'lib/comet/models/admin_user_permissions.rb', line 31

def allow_edit_remote_storage
  @allow_edit_remote_storage
end

#allow_edit_webhooks ⇒ Object

Returns the value of attribute allow_edit_webhooks.



34
35
36
 
# File 'lib/comet/models/admin_user_permissions.rb', line 34

def allow_edit_webhooks
  @allow_edit_webhooks
end

#deny_constellation_role ⇒ Object

Returns the value of attribute deny_constellation_role.



37
38
39
 
# File 'lib/comet/models/admin_user_permissions.rb', line 37

def deny_constellation_role
  @deny_constellation_role
end

#prevent_change_password ⇒ Object

Returns the value of attribute prevent_change_password.



22
23
24
 
# File 'lib/comet/models/admin_user_permissions.rb', line 22

def prevent_change_password
  @prevent_change_password
end

#prevent_edit_server_settings ⇒ Object

Returns the value of attribute prevent_edit_server_settings.



16
17
18
 
# File 'lib/comet/models/admin_user_permissions.rb', line 16

def prevent_edit_server_settings
  @prevent_edit_server_settings
end

#prevent_server_shutdown ⇒ Object

Returns the value of attribute prevent_server_shutdown.



19
20
21
 
# File 'lib/comet/models/admin_user_permissions.rb', line 19

def prevent_server_shutdown
  @prevent_server_shutdown
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



40
41
42
 
# File 'lib/comet/models/admin_user_permissions.rb', line 40

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



46
47
48
 
# File 'lib/comet/models/admin_user_permissions.rb', line 46

def clear
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/comet/models/admin_user_permissions.rb', line 58

def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash

  obj.each do |k, v|
    case k
    when 'PreventEditServerSettings'
      @prevent_edit_server_settings = v
    when 'PreventServerShutdown'
      @prevent_server_shutdown = v
    when 'PreventChangePassword'
      @prevent_change_password = v
    when 'AllowEditBranding'
      @allow_edit_branding = v
    when 'AllowEditEmailOptions'
      @allow_edit_email_options = v
    when 'AllowEditRemoteStorage'
      @allow_edit_remote_storage = v
    when 'AllowEditWebhooks'
      @allow_edit_webhooks = v
    when 'DenyConstellationRole'
      @deny_constellation_role = v
    else
      @unknown_json_fields[k] = v
    end
  end
end

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


51
52
53
54
55
 
# File 'lib/comet/models/admin_user_permissions.rb', line 51

def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String

  from_hash(JSON.parse(json_string))
end

#to_h ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



119
120
121
 
# File 'lib/comet/models/admin_user_permissions.rb', line 119

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



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
 
# File 'lib/comet/models/admin_user_permissions.rb', line 86

def to_hash
  ret = {}
  unless @prevent_edit_server_settings.nil?
    ret['PreventEditServerSettings'] = @prevent_edit_server_settings
  end
  unless @prevent_server_shutdown.nil?
    ret['PreventServerShutdown'] = @prevent_server_shutdown
  end
  unless @prevent_change_password.nil?
    ret['PreventChangePassword'] = @prevent_change_password
  end
  unless @allow_edit_branding.nil?
    ret['AllowEditBranding'] = @allow_edit_branding
  end
  unless @allow_edit_email_options.nil?
    ret['AllowEditEmailOptions'] = @allow_edit_email_options
  end
  unless @allow_edit_remote_storage.nil?
    ret['AllowEditRemoteStorage'] = @allow_edit_remote_storage
  end
  unless @allow_edit_webhooks.nil?
    ret['AllowEditWebhooks'] = @allow_edit_webhooks
  end
  unless @deny_constellation_role.nil?
    ret['DenyConstellationRole'] = @deny_constellation_role
  end
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



124
125
126
 
# File 'lib/comet/models/admin_user_permissions.rb', line 124

def to_json(options = {})
  to_hash.to_json(options)
end