Class: PureCloud::Quote

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Quote

Returns a new instance of Quote.



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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/purecloud/models/quote.rb', line 123

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[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'purchaseOrder']
    self.purchase_order = attributes[:'purchaseOrder']
  end
  
  if attributes[:'type']
    self.type = attributes[:'type']
  end
  
  if attributes[:'status']
    self.status = attributes[:'status']
  end
  
  if attributes[:'currency']
    self.currency = attributes[:'currency']
  end
  
  if attributes[:'createdDate']
    self.created_date = attributes[:'createdDate']
  end
  
  if attributes[:'lastUpdatedDate']
    self.last_updated_date = attributes[:'lastUpdatedDate']
  end
  
  if attributes[:'billingContactEmail']
    self.billing_contact_email = attributes[:'billingContactEmail']
  end
  
  if attributes[:'billingContactFirstName']
    self.billing_contact_first_name = attributes[:'billingContactFirstName']
  end
  
  if attributes[:'billingContactLastName']
    self.billing_contact_last_name = attributes[:'billingContactLastName']
  end
  
  if attributes[:'billingContactPhone']
    self.billing_contact_phone = attributes[:'billingContactPhone']
  end
  
  if attributes[:'includeVoiceCharges']
    self.include_voice_charges = attributes[:'includeVoiceCharges']
  else
    self.include_voice_charges = false
  end
  
  if attributes[:'charges']
    if (value = attributes[:'charges']).is_a?(Array)
      self.charges = value
    end
  end
  
  if attributes[:'edgeControlModel']
    self.edge_control_model = attributes[:'edgeControlModel']
  end
  
  if attributes[:'referralCodes']
    if (value = attributes[:'referralCodes']).is_a?(Array)
      self.referral_codes = value
    end
  end
  
  if attributes[:'discountCodes']
    if (value = attributes[:'discountCodes']).is_a?(Array)
      self.discount_codes = value
    end
  end
  
  if attributes[:'salesPartnerCode']
    self.sales_partner_code = attributes[:'salesPartnerCode']
  end
  
  if attributes[:'isAnnualPrepay']
    self.is_annual_prepay = attributes[:'isAnnualPrepay']
  else
    self.is_annual_prepay = false
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#billing_contact_email ⇒ Object

Returns the value of attribute billing_contact_email.



24
25
26
 
# File 'lib/purecloud/models/quote.rb', line 24

def billing_contact_email
  @billing_contact_email
end

#billing_contact_first_name ⇒ Object

Returns the value of attribute billing_contact_first_name.



26
27
28
 
# File 'lib/purecloud/models/quote.rb', line 26

def billing_contact_first_name
  @billing_contact_first_name
end

#billing_contact_last_name ⇒ Object

Returns the value of attribute billing_contact_last_name.



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

def billing_contact_last_name
  @billing_contact_last_name
end

#billing_contact_phone ⇒ Object

Returns the value of attribute billing_contact_phone.



30
31
32
 
# File 'lib/purecloud/models/quote.rb', line 30

def billing_contact_phone
  @billing_contact_phone
end

#charges ⇒ Object

Returns the value of attribute charges.



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

def charges
  @charges
end

#created_date ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



19
20
21
 
# File 'lib/purecloud/models/quote.rb', line 19

def created_date
  @created_date
end

#currency ⇒ Object

Returns the value of attribute currency.



16
17
18
 
# File 'lib/purecloud/models/quote.rb', line 16

def currency
  @currency
end

#discount_codes ⇒ Object

Returns the value of attribute discount_codes.



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

def discount_codes
  @discount_codes
end

#edge_control_model ⇒ Object

Returns the value of attribute edge_control_model.



36
37
38
 
# File 'lib/purecloud/models/quote.rb', line 36

def edge_control_model
  @edge_control_model
end

#id ⇒ Object

The globally unique identifier for the object.



6
7
8
 
# File 'lib/purecloud/models/quote.rb', line 6

def id
  @id
end

#include_voice_charges ⇒ Object

Returns the value of attribute include_voice_charges.



32
33
34
 
# File 'lib/purecloud/models/quote.rb', line 32

def include_voice_charges
  @include_voice_charges
end

#is_annual_prepay ⇒ Object

Returns the value of attribute is_annual_prepay.



44
45
46
 
# File 'lib/purecloud/models/quote.rb', line 44

def is_annual_prepay
  @is_annual_prepay
end

#last_updated_date ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def last_updated_date
  @last_updated_date
end

#name ⇒ Object

Returns the value of attribute name.



8
9
10
 
# File 'lib/purecloud/models/quote.rb', line 8

def name
  @name
end

#purchase_order ⇒ Object

Returns the value of attribute purchase_order.



10
11
12
 
# File 'lib/purecloud/models/quote.rb', line 10

def purchase_order
  @purchase_order
end

#referral_codes ⇒ Object

Returns the value of attribute referral_codes.



38
39
40
 
# File 'lib/purecloud/models/quote.rb', line 38

def referral_codes
  @referral_codes
end

#sales_partner_code ⇒ Object

Returns the value of attribute sales_partner_code.



42
43
44
 
# File 'lib/purecloud/models/quote.rb', line 42

def sales_partner_code
  @sales_partner_code
end

#self_uri ⇒ Object

The URI for this object



47
48
49
 
# File 'lib/purecloud/models/quote.rb', line 47

def self_uri
  @self_uri
end

#status ⇒ Object

Returns the value of attribute status.



14
15
16
 
# File 'lib/purecloud/models/quote.rb', line 14

def status
  @status
end

#type ⇒ Object

Returns the value of attribute type.



12
13
14
 
# File 'lib/purecloud/models/quote.rb', line 12

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/purecloud/models/quote.rb', line 50

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'purchase_order' => :'purchaseOrder',
    
    :'type' => :'type',
    
    :'status' => :'status',
    
    :'currency' => :'currency',
    
    :'created_date' => :'createdDate',
    
    :'last_updated_date' => :'lastUpdatedDate',
    
    :'billing_contact_email' => :'billingContactEmail',
    
    :'billing_contact_first_name' => :'billingContactFirstName',
    
    :'billing_contact_last_name' => :'billingContactLastName',
    
    :'billing_contact_phone' => :'billingContactPhone',
    
    :'include_voice_charges' => :'includeVoiceCharges',
    
    :'charges' => :'charges',
    
    :'edge_control_model' => :'edgeControlModel',
    
    :'referral_codes' => :'referralCodes',
    
    :'discount_codes' => :'discountCodes',
    
    :'sales_partner_code' => :'salesPartnerCode',
    
    :'is_annual_prepay' => :'isAnnualPrepay',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/purecloud/models/quote.rb', line 97

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'purchase_order' => :'String',
    :'type' => :'String',
    :'status' => :'String',
    :'currency' => :'String',
    :'created_date' => :'DateTime',
    :'last_updated_date' => :'DateTime',
    :'billing_contact_email' => :'String',
    :'billing_contact_first_name' => :'String',
    :'billing_contact_last_name' => :'String',
    :'billing_contact_phone' => :'String',
    :'include_voice_charges' => :'BOOLEAN',
    :'charges' => :'Array<QuoteCharge>',
    :'edge_control_model' => :'String',
    :'referral_codes' => :'Array<String>',
    :'discount_codes' => :'Array<String>',
    :'sales_partner_code' => :'String',
    :'is_annual_prepay' => :'BOOLEAN',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/purecloud/models/quote.rb', line 241

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      purchase_order == o.purchase_order &&
      type == o.type &&
      status == o.status &&
      currency == o.currency &&
      created_date == o.created_date &&
      last_updated_date == o.last_updated_date &&
      billing_contact_email == o.billing_contact_email &&
      billing_contact_first_name == o.billing_contact_first_name &&
      billing_contact_last_name == o.billing_contact_last_name &&
      billing_contact_phone == o.billing_contact_phone &&
      include_voice_charges == o.include_voice_charges &&
      charges == o.charges &&
      edge_control_model == o.edge_control_model &&
      referral_codes == o.referral_codes &&
      discount_codes == o.discount_codes &&
      sales_partner_code == o.sales_partner_code &&
      is_annual_prepay == o.is_annual_prepay &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/purecloud/models/quote.rb', line 296

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



353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/purecloud/models/quote.rb', line 353

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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/purecloud/models/quote.rb', line 277

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


267
268
269
 
# File 'lib/purecloud/models/quote.rb', line 267

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



272
273
274
 
# File 'lib/purecloud/models/quote.rb', line 272

def hash
  [id, name, purchase_order, type, status, currency, created_date, last_updated_date, billing_contact_email, billing_contact_first_name, billing_contact_last_name, billing_contact_phone, include_voice_charges, charges, edge_control_model, referral_codes, discount_codes, sales_partner_code, is_annual_prepay, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



336
337
338
 
# File 'lib/purecloud/models/quote.rb', line 336

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



341
342
343
344
345
346
347
348
349
 
# File 'lib/purecloud/models/quote.rb', line 341

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 



331
332
333
 
# File 'lib/purecloud/models/quote.rb', line 331

def to_s
  to_hash.to_s
end