Class: Comet::TotpRegeneratedResponse

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ TotpRegeneratedResponse

Returns a new instance of TotpRegeneratedResponse.



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

def initialize
  clear
end

Instance Attribute Details

#image ⇒ Object

A data URI of an image of a TOTP code (e.g. “data:image/png;base64,AAA…”)



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

def image
  @image
end

#message ⇒ Object

Returns the value of attribute message.



20
21
22
 
# File 'lib/comet/models/totp_regenerated_response.rb', line 20

def message
  @message
end

#profile_hash ⇒ Object

This field is available in Comet 20.3.2 and later.



32
33
34
 
# File 'lib/comet/models/totp_regenerated_response.rb', line 32

def profile_hash
  @profile_hash
end

#status ⇒ Object

If the operation was successful, the status will be in the 200-299 range.



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

def status
  @status
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



35
36
37
 
# File 'lib/comet/models/totp_regenerated_response.rb', line 35

def unknown_json_fields
  @unknown_json_fields
end

#url ⇒ Object

This field is available in Comet 18.9.9 and later.



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

def url
  @url
end

Instance Method Details

#clear ⇒ Object 



41
42
43
44
45
46
47
48
 
# File 'lib/comet/models/totp_regenerated_response.rb', line 41

def clear
  @status = 0
  @message = ''
  @image = ''
  @url = ''
  @profile_hash = ''
  @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
84
85
86
87
 
# File 'lib/comet/models/totp_regenerated_response.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 'Status'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @status = v
    when 'Message'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @message = v
    when 'Image'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @image = v
    when 'URL'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @url = v
    when 'ProfileHash'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @profile_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) 


51
52
53
54
55
 
# File 'lib/comet/models/totp_regenerated_response.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



104
105
106
 
# File 'lib/comet/models/totp_regenerated_response.rb', line 104

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



90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/comet/models/totp_regenerated_response.rb', line 90

def to_hash
  ret = {}
  ret['Status'] = @status
  ret['Message'] = @message
  ret['Image'] = @image
  ret['URL'] = @url
  ret['ProfileHash'] = @profile_hash
  @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



109
110
111
 
# File 'lib/comet/models/totp_regenerated_response.rb', line 109

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