Class: Comet::B2TransactionTotals

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeB2TransactionTotals

Returns a new instance of B2TransactionTotals.



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

def initialize
  clear
end

Instance Attribute Details

#class_aObject

Returns the value of attribute class_a.



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

def class_a
  @class_a
end

#class_bObject

Returns the value of attribute class_b.



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

def class_b
  @class_b
end

#class_cObject

Returns the value of attribute class_c.



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

def class_c
  @class_c
end

#unknown_json_fieldsObject

Returns the value of attribute unknown_json_fields.



25
26
27
# File 'lib/comet/models/b2transaction_totals.rb', line 25

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clearObject



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

def clear
  @class_a = 0
  @class_b = 0
  @class_c = 0
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash)

    The complete object as a Ruby hash

Raises:

  • (TypeError)


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

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

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

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

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


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

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



82
83
84
# File 'lib/comet/models/b2transaction_totals.rb', line 82

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



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

def to_hash
  ret = {}
  ret['ClassA'] = @class_a
  ret['ClassB'] = @class_b
  ret['ClassC'] = @class_c
  @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



87
88
89
# File 'lib/comet/models/b2transaction_totals.rb', line 87

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