Class: PureCloud::QuoteCharge

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ QuoteCharge

Returns a new instance of QuoteCharge.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
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
168
169
170
171
172
173
174
 
# File 'lib/purecloud/models/quote_charge.rb', line 113

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[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'sku']
    self.sku = attributes[:'sku']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'chargeType']
    self.charge_type = attributes[:'chargeType']
  end
  
  if attributes[:'quantity']
    self.quantity = attributes[:'quantity']
  end
  
  if attributes[:'listTotal']
    self.list_total = attributes[:'listTotal']
  end
  
  if attributes[:'total']
    self.total = attributes[:'total']
  end
  
  if attributes[:'listPriceDisplay']
    self.list_price_display = attributes[:'listPriceDisplay']
  end
  
  if attributes[:'discount']
    self.discount = attributes[:'discount']
  end
  
  if attributes[:'effectivePrice']
    self.effective_price = attributes[:'effectivePrice']
  end
  
  if attributes[:'productShippable']
    self.product_shippable = attributes[:'productShippable']
  else
    self.product_shippable = false
  end
  
  if attributes[:'shippingAddress']
    self.shipping_address = attributes[:'shippingAddress']
  end
  
  if attributes[:'forRelatedPart']
    self.for_related_part = attributes[:'forRelatedPart']
  end
  
end

Instance Attribute Details

#charge_type ⇒ Object

The quote charge type.



31
32
33
 
# File 'lib/purecloud/models/quote_charge.rb', line 31

def charge_type
  @charge_type
end

#discount ⇒ Object

The quote charge discount percent.



46
47
48
 
# File 'lib/purecloud/models/quote_charge.rb', line 46

def discount
  @discount
end

#effective_price ⇒ Object

The quote charge list price after discounts.



49
50
51
 
# File 'lib/purecloud/models/quote_charge.rb', line 49

def effective_price
  @effective_price
end

#for_related_part ⇒ Object

The part number of a part related to the quote charge.



58
59
60
 
# File 'lib/purecloud/models/quote_charge.rb', line 58

def for_related_part
  @for_related_part
end

#id ⇒ Object

The quote charge Id.



22
23
24
 
# File 'lib/purecloud/models/quote_charge.rb', line 22

def id
  @id
end

#list_price_display ⇒ Object

The quote charge list price before discounts.



43
44
45
 
# File 'lib/purecloud/models/quote_charge.rb', line 43

def list_price_display
  @list_price_display
end

#list_total ⇒ Object

The quote charge total price before discounts.



37
38
39
 
# File 'lib/purecloud/models/quote_charge.rb', line 37

def list_total
  @list_total
end

#name ⇒ Object

The quote charge name.



28
29
30
 
# File 'lib/purecloud/models/quote_charge.rb', line 28

def name
  @name
end

#product_shippable ⇒ Object

Indicates whether the product can be shipped.



52
53
54
 
# File 'lib/purecloud/models/quote_charge.rb', line 52

def product_shippable
  @product_shippable
end

#quantity ⇒ Object

The quote charge quantity.



34
35
36
 
# File 'lib/purecloud/models/quote_charge.rb', line 34

def quantity
  @quantity
end

#shipping_address ⇒ Object

The quote shipping address.



55
56
57
 
# File 'lib/purecloud/models/quote_charge.rb', line 55

def shipping_address
  @shipping_address
end

#sku ⇒ Object

The quote charge SKU.



25
26
27
 
# File 'lib/purecloud/models/quote_charge.rb', line 25

def sku
  @sku
end

#total ⇒ Object

The quote charge total price after discounts.



40
41
42
 
# File 'lib/purecloud/models/quote_charge.rb', line 40

def total
  @total
end

Class Method Details

.attribute_map ⇒ Object

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



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
90
91
 
# File 'lib/purecloud/models/quote_charge.rb', line 61

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'sku' => :'sku',
    
    :'name' => :'name',
    
    :'charge_type' => :'chargeType',
    
    :'quantity' => :'quantity',
    
    :'list_total' => :'listTotal',
    
    :'total' => :'total',
    
    :'list_price_display' => :'listPriceDisplay',
    
    :'discount' => :'discount',
    
    :'effective_price' => :'effectivePrice',
    
    :'product_shippable' => :'productShippable',
    
    :'shipping_address' => :'shippingAddress',
    
    :'for_related_part' => :'forRelatedPart'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/purecloud/models/quote_charge.rb', line 94

def self.swagger_types
  {
    :'id' => :'String',
    :'sku' => :'String',
    :'name' => :'String',
    :'charge_type' => :'String',
    :'quantity' => :'Integer',
    :'list_total' => :'String',
    :'total' => :'String',
    :'list_price_display' => :'String',
    :'discount' => :'String',
    :'effective_price' => :'String',
    :'product_shippable' => :'BOOLEAN',
    :'shipping_address' => :'BillingAddress',
    :'for_related_part' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/purecloud/models/quote_charge.rb', line 177

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      sku == o.sku &&
      name == o.name &&
      charge_type == o.charge_type &&
      quantity == o.quantity &&
      list_total == o.list_total &&
      total == o.total &&
      list_price_display == o.list_price_display &&
      discount == o.discount &&
      effective_price == o.effective_price &&
      product_shippable == o.product_shippable &&
      shipping_address == o.shipping_address &&
      for_related_part == o.for_related_part
end

#_deserialize(type, value) ⇒ Object 



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/purecloud/models/quote_charge.rb', line 225

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.to_s =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  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



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/purecloud/models/quote_charge.rb', line 285

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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/purecloud/models/quote_charge.rb', line 206

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


196
197
198
 
# File 'lib/purecloud/models/quote_charge.rb', line 196

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



201
202
203
 
# File 'lib/purecloud/models/quote_charge.rb', line 201

def hash
  [id, sku, name, charge_type, quantity, list_total, total, list_price_display, discount, effective_price, product_shippable, shipping_address, for_related_part].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



268
269
270
 
# File 'lib/purecloud/models/quote_charge.rb', line 268

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



273
274
275
276
277
278
279
280
281
 
# File 'lib/purecloud/models/quote_charge.rb', line 273

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_s ⇒ Object 



263
264
265
 
# File 'lib/purecloud/models/quote_charge.rb', line 263

def to_s
  to_hash.to_s
end