Class: Comet::SessionKeyRegeneratedResponse

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ SessionKeyRegeneratedResponse

Returns a new instance of SessionKeyRegeneratedResponse.



33
34
35
 
# File 'lib/comet/models/session_key_regenerated_response.rb', line 33

def initialize
  clear
end

Instance Attribute Details

#message ⇒ Object

Returns the value of attribute message.



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

def message
  @message
end

#session_key ⇒ Object

Returns the value of attribute session_key.



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

def session_key
  @session_key
end

#session_type ⇒ Object

e.g. “admin” or “user” This field is available in Comet 18.12.3 and later.



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

def session_type
  @session_type
end

#status ⇒ Object

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



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

def status
  @status
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



37
38
39
40
41
42
43
 
# File 'lib/comet/models/session_key_regenerated_response.rb', line 37

def clear
  @status = 0
  @message = ''
  @session_key = ''
  @session_type = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/comet/models/session_key_regenerated_response.rb', line 53

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

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

      @session_type = 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) 


46
47
48
49
50
 
# File 'lib/comet/models/session_key_regenerated_response.rb', line 46

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



94
95
96
 
# File 'lib/comet/models/session_key_regenerated_response.rb', line 94

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



81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/comet/models/session_key_regenerated_response.rb', line 81

def to_hash
  ret = {}
  ret['Status'] = @status
  ret['Message'] = @message
  ret['SessionKey'] = @session_key
  ret['SessionType'] = @session_type
  @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



99
100
101
 
# File 'lib/comet/models/session_key_regenerated_response.rb', line 99

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