Class: Comet::AdminAccountPropertiesResponse

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ AdminAccountPropertiesResponse

Returns a new instance of AdminAccountPropertiesResponse.



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

def initialize
  clear
end

Instance Attribute Details

#organization_id ⇒ Object

Returns the value of attribute organization_id.



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

def organization_id
  @organization_id
end

#permissions ⇒ Object

Returns the value of attribute permissions.



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

def permissions
  @permissions
end

#security ⇒ Object

This field is available in Comet 18.9.9 and later.



23
24
25
 
# File 'lib/comet/models/admin_account_properties_response.rb', line 23

def security
  @security
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



26
27
28
 
# File 'lib/comet/models/admin_account_properties_response.rb', line 26

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



32
33
34
35
36
37
 
# File 'lib/comet/models/admin_account_properties_response.rb', line 32

def clear
  @organization_id = ''
  @permissions = Comet::AdminUserPermissions.new
  @security = Comet::AdminSecurityOptions.new
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/comet/models/admin_account_properties_response.rb', line 47

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 'OrganizationID'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @organization_id = v
    when 'Permissions'
      @permissions = Comet::AdminUserPermissions.new
      @permissions.from_hash(v)
    when 'Security'
      @security = Comet::AdminSecurityOptions.new
      @security.from_hash(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) 


40
41
42
43
44
 
# File 'lib/comet/models/admin_account_properties_response.rb', line 40

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



81
82
83
 
# File 'lib/comet/models/admin_account_properties_response.rb', line 81

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



69
70
71
72
73
74
75
76
77
78
 
# File 'lib/comet/models/admin_account_properties_response.rb', line 69

def to_hash
  ret = {}
  ret['OrganizationID'] = @organization_id
  ret['Permissions'] = @permissions
  ret['Security'] = @security
  @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



86
87
88
 
# File 'lib/comet/models/admin_account_properties_response.rb', line 86

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