Class: Comet::AdminWebAuthnRegistration

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ AdminWebAuthnRegistration

Returns a new instance of AdminWebAuthnRegistration.



39
40
41
 
# File 'lib/comet/models/admin_web_authn_registration.rb', line 39

def initialize
  clear
end

Instance Attribute Details

#credential ⇒ Object

Returns the value of attribute credential.



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

def credential
  @credential
end

#description ⇒ Object

Returns the value of attribute description.



17
18
19
 
# File 'lib/comet/models/admin_web_authn_registration.rb', line 17

def description
  @description
end

#id ⇒ Object

When this field is expressed as a AdminWebAuthnRegistration class instance, this field may contain binary data. When this field is expressed as JSON, the field is expressed as base64. The marshalling methods on this class will automatically perform base64 conversion as necessary.



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

def id
  @id
end

#is_legacy_u2f ⇒ Object

Returns the value of attribute is_legacy_u2f.



27
28
29
 
# File 'lib/comet/models/admin_web_authn_registration.rb', line 27

def is_legacy_u2f
  @is_legacy_u2f
end

#register_time ⇒ Object

Unix timestamp, in seconds.



21
22
23
 
# File 'lib/comet/models/admin_web_authn_registration.rb', line 21

def register_time
  @register_time
end

#type ⇒ Object

Returns the value of attribute type.



24
25
26
 
# File 'lib/comet/models/admin_web_authn_registration.rb', line 24

def type
  @type
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



43
44
45
46
47
48
49
50
 
# File 'lib/comet/models/admin_web_authn_registration.rb', line 43

def clear
  @description = ''
  @register_time = 0
  @type = 0
  @id = []
  @credential = Comet::WebAuthnCredential.new
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/comet/models/admin_web_authn_registration.rb', line 60

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

      @description = v
    when 'RegisterTime'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @register_time = v
    when 'Type'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @type = v
    when 'IsLegacyU2F'
      @is_legacy_u2f = v
    when 'ID'
      @id = Base64.decode64(v)
    when 'Credential'
      @credential = Comet::WebAuthnCredential.new
      @credential.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) 


53
54
55
56
57
 
# File 'lib/comet/models/admin_web_authn_registration.rb', line 53

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



112
113
114
 
# File 'lib/comet/models/admin_web_authn_registration.rb', line 112

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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/comet/models/admin_web_authn_registration.rb', line 91

def to_hash
  ret = {}
  ret['Description'] = @description
  ret['RegisterTime'] = @register_time
  ret['Type'] = @type
  unless @is_legacy_u2f.nil?
    ret['IsLegacyU2F'] = @is_legacy_u2f
  end
  unless @id.nil?
    ret['ID'] = @id
  end
  unless @credential.nil?
    ret['Credential'] = @credential
  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



117
118
119
 
# File 'lib/comet/models/admin_web_authn_registration.rb', line 117

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