Class: Comet::UpdateCampaignDeviceStatus

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeUpdateCampaignDeviceStatus

Returns a new instance of UpdateCampaignDeviceStatus.



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

def initialize
  clear
end

Instance Attribute Details

#statusObject

One of the UPDATESTATUS_ constants



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

def status
  @status
end

#unknown_json_fieldsObject

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clearObject



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

def clear
  @status = 0
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash)

    The complete object as a Ruby hash

Raises:

  • (TypeError)


39
40
41
42
43
44
45
46
47
48
49
50
51
52
# File 'lib/comet/models/update_campaign_device_status.rb', line 39

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


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

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_hHash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash)

    The complete object as a Ruby hash



65
66
67
# File 'lib/comet/models/update_campaign_device_status.rb', line 65

def to_h
  to_hash
end

#to_hashHash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash)

    The complete object as a Ruby hash



55
56
57
58
59
60
61
62
# File 'lib/comet/models/update_campaign_device_status.rb', line 55

def to_hash
  ret = {}
  ret['Status'] = @status
  @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



70
71
72
# File 'lib/comet/models/update_campaign_device_status.rb', line 70

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