Class: PureCloud::Charge

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/charge.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Charge

Returns a new instance of Charge.



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
79
80
81
82
83
84
85
86
87
88
89
# File 'lib/purecloud/models/charge.rb', line 54

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'licenseCount']
    self.license_count = attributes[:'licenseCount']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'description']
    self.description = attributes[:'description']
  end
  
  if attributes[:'price']
    self.price = attributes[:'price']
  end
  
  if attributes[:'unitOfMeasure']
    self.unit_of_measure = attributes[:'unitOfMeasure']
  end
  
  if attributes[:'billingPeriod']
    self.billing_period = attributes[:'billingPeriod']
  end
  
  if attributes[:'quantity']
    self.quantity = attributes[:'quantity']
  end
  
end

Instance Attribute Details

#billing_periodObject

Returns the value of attribute billing_period.



15
16
17
# File 'lib/purecloud/models/charge.rb', line 15

def billing_period
  @billing_period
end

#descriptionObject

Returns the value of attribute description.



9
10
11
# File 'lib/purecloud/models/charge.rb', line 9

def description
  @description
end

#license_countObject

Returns the value of attribute license_count.



5
6
7
# File 'lib/purecloud/models/charge.rb', line 5

def license_count
  @license_count
end

#nameObject

Returns the value of attribute name.



7
8
9
# File 'lib/purecloud/models/charge.rb', line 7

def name
  @name
end

#priceObject

Returns the value of attribute price.



11
12
13
# File 'lib/purecloud/models/charge.rb', line 11

def price
  @price
end

#quantityObject

Returns the value of attribute quantity.



17
18
19
# File 'lib/purecloud/models/charge.rb', line 17

def quantity
  @quantity
end

#unit_of_measureObject

Returns the value of attribute unit_of_measure.



13
14
15
# File 'lib/purecloud/models/charge.rb', line 13

def unit_of_measure
  @unit_of_measure
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# File 'lib/purecloud/models/charge.rb', line 20

def self.attribute_map
  {
    
    :'license_count' => :'licenseCount',
    
    :'name' => :'name',
    
    :'description' => :'description',
    
    :'price' => :'price',
    
    :'unit_of_measure' => :'unitOfMeasure',
    
    :'billing_period' => :'billingPeriod',
    
    :'quantity' => :'quantity'
    
  }
end

.swagger_typesObject

Attribute type mapping.



41
42
43
44
45
46
47
48
49
50
51
52
# File 'lib/purecloud/models/charge.rb', line 41

def self.swagger_types
  {
    :'license_count' => :'Integer',
    :'name' => :'String',
    :'description' => :'String',
    :'price' => :'Float',
    :'unit_of_measure' => :'String',
    :'billing_period' => :'String',
    :'quantity' => :'Integer'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



92
93
94
95
96
97
98
99
100
101
102
# File 'lib/purecloud/models/charge.rb', line 92

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      license_count == o.license_count &&
      name == o.name &&
      description == o.description &&
      price == o.price &&
      unit_of_measure == o.unit_of_measure &&
      billing_period == o.billing_period &&
      quantity == o.quantity
end

#_deserialize(type, value) ⇒ Object



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
# File 'lib/purecloud/models/charge.rb', line 134

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'lib/purecloud/models/charge.rb', line 191

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

build the object from hash



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
# File 'lib/purecloud/models/charge.rb', line 115

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Returns:

  • (Boolean)

See Also:

  • `==` method


105
106
107
# File 'lib/purecloud/models/charge.rb', line 105

def eql?(o)
  self == o
end

#hashObject

Calculate hash code according to all attributes.



110
111
112
# File 'lib/purecloud/models/charge.rb', line 110

def hash
  [license_count, name, description, price, unit_of_measure, billing_period, quantity].hash
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



174
175
176
# File 'lib/purecloud/models/charge.rb', line 174

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



179
180
181
182
183
184
185
186
187
# File 'lib/purecloud/models/charge.rb', line 179

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_sObject



169
170
171
# File 'lib/purecloud/models/charge.rb', line 169

def to_s
  to_hash.to_s
end