Class: UltracartClient::Customer

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/customer.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Customer

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
# File 'lib/ultracart_api/models/customer.rb', line 314

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

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

  if attributes.has_key?(:'activity')
    self.activity = attributes[:'activity']
  end

  if attributes.has_key?(:'affiliate_oid')
    self.affiliate_oid = attributes[:'affiliate_oid']
  end

  if attributes.has_key?(:'allow_3rd_party_billing')
    self.allow_3rd_party_billing = attributes[:'allow_3rd_party_billing']
  end

  if attributes.has_key?(:'allow_cod')
    self.allow_cod = attributes[:'allow_cod']
  end

  if attributes.has_key?(:'allow_purchase_order')
    self.allow_purchase_order = attributes[:'allow_purchase_order']
  end

  if attributes.has_key?(:'allow_quote_request')
    self.allow_quote_request = attributes[:'allow_quote_request']
  end

  if attributes.has_key?(:'allow_selection_of_address_type')
    self.allow_selection_of_address_type = attributes[:'allow_selection_of_address_type']
  end

  if attributes.has_key?(:'attachments')
    if (value = attributes[:'attachments']).is_a?(Array)
      self.attachments = value
    end
  end

  if attributes.has_key?(:'auto_approve_cod')
    self.auto_approve_cod = attributes[:'auto_approve_cod']
  end

  if attributes.has_key?(:'auto_approve_purchase_order')
    self.auto_approve_purchase_order = attributes[:'auto_approve_purchase_order']
  end

  if attributes.has_key?(:'automatic_merchant_notes')
    self.automatic_merchant_notes = attributes[:'automatic_merchant_notes']
  end

  if attributes.has_key?(:'billing')
    if (value = attributes[:'billing']).is_a?(Array)
      self.billing = value
    end
  end

  if attributes.has_key?(:'business_notes')
    self.business_notes = attributes[:'business_notes']
  end

  if attributes.has_key?(:'cards')
    if (value = attributes[:'cards']).is_a?(Array)
      self.cards = value
    end
  end

  if attributes.has_key?(:'cc_emails')
    if (value = attributes[:'cc_emails']).is_a?(Array)
      self.cc_emails = value
    end
  end

  if attributes.has_key?(:'customer_profile_oid')
    self.customer_profile_oid = attributes[:'customer_profile_oid']
  end

  if attributes.has_key?(:'dhl_account_number')
    self. = attributes[:'dhl_account_number']
  end

  if attributes.has_key?(:'dhl_duty_account_number')
    self. = attributes[:'dhl_duty_account_number']
  end

  if attributes.has_key?(:'email')
    self.email = attributes[:'email']
  end

  if attributes.has_key?(:'exempt_shipping_handling_charge')
    self.exempt_shipping_handling_charge = attributes[:'exempt_shipping_handling_charge']
  end

  if attributes.has_key?(:'fedex_account_number')
    self. = attributes[:'fedex_account_number']
  end

  if attributes.has_key?(:'free_shipping')
    self.free_shipping = attributes[:'free_shipping']
  end

  if attributes.has_key?(:'free_shipping_minimum')
    self.free_shipping_minimum = attributes[:'free_shipping_minimum']
  end

  if attributes.has_key?(:'last_modified_by')
    self.last_modified_by = attributes[:'last_modified_by']
  end

  if attributes.has_key?(:'last_modified_dts')
    self.last_modified_dts = attributes[:'last_modified_dts']
  end

  if attributes.has_key?(:'loyalty')
    self.loyalty = attributes[:'loyalty']
  end

  if attributes.has_key?(:'maximum_item_count')
    self.maximum_item_count = attributes[:'maximum_item_count']
  end

  if attributes.has_key?(:'minimum_item_count')
    self.minimum_item_count = attributes[:'minimum_item_count']
  end

  if attributes.has_key?(:'minimum_subtotal')
    self.minimum_subtotal = attributes[:'minimum_subtotal']
  end

  if attributes.has_key?(:'no_coupons')
    self.no_coupons = attributes[:'no_coupons']
  end

  if attributes.has_key?(:'no_free_shipping')
    self.no_free_shipping = attributes[:'no_free_shipping']
  end

  if attributes.has_key?(:'no_realtime_charge')
    self.no_realtime_charge = attributes[:'no_realtime_charge']
  end

  if attributes.has_key?(:'orders')
    if (value = attributes[:'orders']).is_a?(Array)
      self.orders = value
    end
  end

  if attributes.has_key?(:'orders_summary')
    self.orders_summary = attributes[:'orders_summary']
  end

  if attributes.has_key?(:'password')
    self.password = attributes[:'password']
  end

  if attributes.has_key?(:'pricing_tiers')
    if (value = attributes[:'pricing_tiers']).is_a?(Array)
      self.pricing_tiers = value
    end
  end

  if attributes.has_key?(:'privacy')
    self.privacy = attributes[:'privacy']
  end

  if attributes.has_key?(:'qb_class')
    self.qb_class = attributes[:'qb_class']
  end

  if attributes.has_key?(:'qb_code')
    self.qb_code = attributes[:'qb_code']
  end

  if attributes.has_key?(:'quotes')
    if (value = attributes[:'quotes']).is_a?(Array)
      self.quotes = value
    end
  end

  if attributes.has_key?(:'quotes_summary')
    self.quotes_summary = attributes[:'quotes_summary']
  end

  if attributes.has_key?(:'referral_source')
    self.referral_source = attributes[:'referral_source']
  end

  if attributes.has_key?(:'reviewer')
    self.reviewer = attributes[:'reviewer']
  end

  if attributes.has_key?(:'sales_rep_code')
    self.sales_rep_code = attributes[:'sales_rep_code']
  end

  if attributes.has_key?(:'send_signup_notification')
    self. = attributes[:'send_signup_notification']
  end

  if attributes.has_key?(:'shipping')
    if (value = attributes[:'shipping']).is_a?(Array)
      self.shipping = value
    end
  end

  if attributes.has_key?(:'signup_dts')
    self. = attributes[:'signup_dts']
  end

  if attributes.has_key?(:'software_entitlements')
    if (value = attributes[:'software_entitlements']).is_a?(Array)
      self.software_entitlements = value
    end
  end

  if attributes.has_key?(:'suppress_buysafe')
    self.suppress_buysafe = attributes[:'suppress_buysafe']
  end

  if attributes.has_key?(:'tags')
    if (value = attributes[:'tags']).is_a?(Array)
      self.tags = value
    end
  end

  if attributes.has_key?(:'tax_codes')
    self.tax_codes = attributes[:'tax_codes']
  end

  if attributes.has_key?(:'tax_exempt')
    self.tax_exempt = attributes[:'tax_exempt']
  end

  if attributes.has_key?(:'tax_id')
    self.tax_id = attributes[:'tax_id']
  end

  if attributes.has_key?(:'terms')
    self.terms = attributes[:'terms']
  end

  if attributes.has_key?(:'track_separately')
    self.track_separately = attributes[:'track_separately']
  end

  if attributes.has_key?(:'unapproved')
    self.unapproved = attributes[:'unapproved']
  end

  if attributes.has_key?(:'ups_account_number')
    self. = attributes[:'ups_account_number']
  end

  if attributes.has_key?(:'website_url')
    self.website_url = attributes[:'website_url']
  end
end

Instance Attribute Details

#activityObject

Returns the value of attribute activity.



17
18
19
# File 'lib/ultracart_api/models/customer.rb', line 17

def activity
  @activity
end

#affiliate_oidObject

Affiliate oid



20
21
22
# File 'lib/ultracart_api/models/customer.rb', line 20

def affiliate_oid
  @affiliate_oid
end

#allow_3rd_party_billingObject

Allow 3rd party billing



23
24
25
# File 'lib/ultracart_api/models/customer.rb', line 23

def allow_3rd_party_billing
  @allow_3rd_party_billing
end

#allow_codObject

Allow COD



26
27
28
# File 'lib/ultracart_api/models/customer.rb', line 26

def allow_cod
  @allow_cod
end

#allow_purchase_orderObject

Allow purchase orders by this customer



29
30
31
# File 'lib/ultracart_api/models/customer.rb', line 29

def allow_purchase_order
  @allow_purchase_order
end

#allow_quote_requestObject

Allow quote request



32
33
34
# File 'lib/ultracart_api/models/customer.rb', line 32

def allow_quote_request
  @allow_quote_request
end

#allow_selection_of_address_typeObject

Allow selection of residential or business address type



35
36
37
# File 'lib/ultracart_api/models/customer.rb', line 35

def allow_selection_of_address_type
  @allow_selection_of_address_type
end

#attachmentsObject

Attachments



38
39
40
# File 'lib/ultracart_api/models/customer.rb', line 38

def attachments
  @attachments
end

#auto_approve_codObject

Auto approve COD



41
42
43
# File 'lib/ultracart_api/models/customer.rb', line 41

def auto_approve_cod
  @auto_approve_cod
end

#auto_approve_purchase_orderObject

Auto approve purchase orders by this customer



44
45
46
# File 'lib/ultracart_api/models/customer.rb', line 44

def auto_approve_purchase_order
  @auto_approve_purchase_order
end

#automatic_merchant_notesObject

Automatic merchant notes are added to every order placed



47
48
49
# File 'lib/ultracart_api/models/customer.rb', line 47

def automatic_merchant_notes
  @automatic_merchant_notes
end

#billingObject

Billing addresses for this customer



50
51
52
# File 'lib/ultracart_api/models/customer.rb', line 50

def billing
  @billing
end

#business_notesObject

Business notes (internally visible only)



53
54
55
# File 'lib/ultracart_api/models/customer.rb', line 53

def business_notes
  @business_notes
end

#cardsObject

Credit Cards for this customer



56
57
58
# File 'lib/ultracart_api/models/customer.rb', line 56

def cards
  @cards
end

#cc_emailsObject

Additional emails to CC notification



59
60
61
# File 'lib/ultracart_api/models/customer.rb', line 59

def cc_emails
  @cc_emails
end

#customer_profile_oidObject

Customer profile object identifier



62
63
64
# File 'lib/ultracart_api/models/customer.rb', line 62

def customer_profile_oid
  @customer_profile_oid
end

#dhl_account_numberObject

DHL account number



65
66
67
# File 'lib/ultracart_api/models/customer.rb', line 65

def 
  @dhl_account_number
end

#dhl_duty_account_numberObject

DHL duty account number



68
69
70
# File 'lib/ultracart_api/models/customer.rb', line 68

def 
  @dhl_duty_account_number
end

#emailObject

Email address of this customer profile



71
72
73
# File 'lib/ultracart_api/models/customer.rb', line 71

def email
  @email
end

#exempt_shipping_handling_chargeObject

Exempt shipping handling charge



74
75
76
# File 'lib/ultracart_api/models/customer.rb', line 74

def exempt_shipping_handling_charge
  @exempt_shipping_handling_charge
end

#fedex_account_numberObject

FedEx account number



77
78
79
# File 'lib/ultracart_api/models/customer.rb', line 77

def 
  @fedex_account_number
end

#free_shippingObject

This customer always receives free shipping



80
81
82
# File 'lib/ultracart_api/models/customer.rb', line 80

def free_shipping
  @free_shipping
end

#free_shipping_minimumObject

If free_shipping is true, this is the minimum subtotal required for free shipping



83
84
85
# File 'lib/ultracart_api/models/customer.rb', line 83

def free_shipping_minimum
  @free_shipping_minimum
end

#last_modified_byObject

Last modified by



86
87
88
# File 'lib/ultracart_api/models/customer.rb', line 86

def last_modified_by
  @last_modified_by
end

#last_modified_dtsObject

Last modified date



89
90
91
# File 'lib/ultracart_api/models/customer.rb', line 89

def last_modified_dts
  @last_modified_dts
end

#loyaltyObject

Returns the value of attribute loyalty.



91
92
93
# File 'lib/ultracart_api/models/customer.rb', line 91

def loyalty
  @loyalty
end

#maximum_item_countObject

Maximum item count



94
95
96
# File 'lib/ultracart_api/models/customer.rb', line 94

def maximum_item_count
  @maximum_item_count
end

#minimum_item_countObject

Minimum item count



97
98
99
# File 'lib/ultracart_api/models/customer.rb', line 97

def minimum_item_count
  @minimum_item_count
end

#minimum_subtotalObject

Minimum subtotal



100
101
102
# File 'lib/ultracart_api/models/customer.rb', line 100

def minimum_subtotal
  @minimum_subtotal
end

#no_couponsObject

No coupons



103
104
105
# File 'lib/ultracart_api/models/customer.rb', line 103

def no_coupons
  @no_coupons
end

#no_free_shippingObject

No free shipping regardless of coupons or item level settings



106
107
108
# File 'lib/ultracart_api/models/customer.rb', line 106

def no_free_shipping
  @no_free_shipping
end

#no_realtime_chargeObject

No realtime charge



109
110
111
# File 'lib/ultracart_api/models/customer.rb', line 109

def no_realtime_charge
  @no_realtime_charge
end

#ordersObject

Orders associated with this customer profile



112
113
114
# File 'lib/ultracart_api/models/customer.rb', line 112

def orders
  @orders
end

#orders_summaryObject

Returns the value of attribute orders_summary.



114
115
116
# File 'lib/ultracart_api/models/customer.rb', line 114

def orders_summary
  @orders_summary
end

#passwordObject

Password (may only be set, never read)



117
118
119
# File 'lib/ultracart_api/models/customer.rb', line 117

def password
  @password
end

#pricing_tiersObject

Pricing tiers for this customer



120
121
122
# File 'lib/ultracart_api/models/customer.rb', line 120

def pricing_tiers
  @pricing_tiers
end

#privacyObject

Returns the value of attribute privacy.



122
123
124
# File 'lib/ultracart_api/models/customer.rb', line 122

def privacy
  @privacy
end

#qb_classObject

QuickBooks class to import this customer as



125
126
127
# File 'lib/ultracart_api/models/customer.rb', line 125

def qb_class
  @qb_class
end

#qb_codeObject

QuickBooks name to import this customer as



128
129
130
# File 'lib/ultracart_api/models/customer.rb', line 128

def qb_code
  @qb_code
end

#quotesObject

Quotes associated with this customer profile



131
132
133
# File 'lib/ultracart_api/models/customer.rb', line 131

def quotes
  @quotes
end

#quotes_summaryObject

Returns the value of attribute quotes_summary.



133
134
135
# File 'lib/ultracart_api/models/customer.rb', line 133

def quotes_summary
  @quotes_summary
end

#referral_sourceObject

Referral Source



136
137
138
# File 'lib/ultracart_api/models/customer.rb', line 136

def referral_source
  @referral_source
end

#reviewerObject

Returns the value of attribute reviewer.



138
139
140
# File 'lib/ultracart_api/models/customer.rb', line 138

def reviewer
  @reviewer
end

#sales_rep_codeObject

Sales rep code



141
142
143
# File 'lib/ultracart_api/models/customer.rb', line 141

def sales_rep_code
  @sales_rep_code
end

#send_signup_notificationObject

Send signup notification, if true during customer creation, will send a notification.



144
145
146
# File 'lib/ultracart_api/models/customer.rb', line 144

def 
  @send_signup_notification
end

#shippingObject

Shipping addresses for this customer



147
148
149
# File 'lib/ultracart_api/models/customer.rb', line 147

def shipping
  @shipping
end

#signup_dtsObject

Signup date



150
151
152
# File 'lib/ultracart_api/models/customer.rb', line 150

def 
  @signup_dts
end

#software_entitlementsObject

Software entitlements owned by this customer



153
154
155
# File 'lib/ultracart_api/models/customer.rb', line 153

def software_entitlements
  @software_entitlements
end

#suppress_buysafeObject

Suppress buySAFE (deprecated)



156
157
158
# File 'lib/ultracart_api/models/customer.rb', line 156

def suppress_buysafe
  @suppress_buysafe
end

#tagsObject

Tags for this customer



159
160
161
# File 'lib/ultracart_api/models/customer.rb', line 159

def tags
  @tags
end

#tax_codesObject

Returns the value of attribute tax_codes.



161
162
163
# File 'lib/ultracart_api/models/customer.rb', line 161

def tax_codes
  @tax_codes
end

#tax_exemptObject

True if the customer is tax exempt



164
165
166
# File 'lib/ultracart_api/models/customer.rb', line 164

def tax_exempt
  @tax_exempt
end

#tax_idObject

Tax ID



167
168
169
# File 'lib/ultracart_api/models/customer.rb', line 167

def tax_id
  @tax_id
end

#termsObject

Terms for this customer



170
171
172
# File 'lib/ultracart_api/models/customer.rb', line 170

def terms
  @terms
end

#track_separatelyObject

True if the customer should be tracked separately in QuickBooks



173
174
175
# File 'lib/ultracart_api/models/customer.rb', line 173

def track_separately
  @track_separately
end

#unapprovedObject

Unapproved



176
177
178
# File 'lib/ultracart_api/models/customer.rb', line 176

def unapproved
  @unapproved
end

#ups_account_numberObject

UPS account number



179
180
181
# File 'lib/ultracart_api/models/customer.rb', line 179

def 
  @ups_account_number
end

#website_urlObject

Website url



182
183
184
# File 'lib/ultracart_api/models/customer.rb', line 182

def website_url
  @website_url
end

Class Method Details

.attribute_mapObject

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



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
# File 'lib/ultracart_api/models/customer.rb', line 185

def self.attribute_map
  {
    :'activity' => :'activity',
    :'affiliate_oid' => :'affiliate_oid',
    :'allow_3rd_party_billing' => :'allow_3rd_party_billing',
    :'allow_cod' => :'allow_cod',
    :'allow_purchase_order' => :'allow_purchase_order',
    :'allow_quote_request' => :'allow_quote_request',
    :'allow_selection_of_address_type' => :'allow_selection_of_address_type',
    :'attachments' => :'attachments',
    :'auto_approve_cod' => :'auto_approve_cod',
    :'auto_approve_purchase_order' => :'auto_approve_purchase_order',
    :'automatic_merchant_notes' => :'automatic_merchant_notes',
    :'billing' => :'billing',
    :'business_notes' => :'business_notes',
    :'cards' => :'cards',
    :'cc_emails' => :'cc_emails',
    :'customer_profile_oid' => :'customer_profile_oid',
    :'dhl_account_number' => :'dhl_account_number',
    :'dhl_duty_account_number' => :'dhl_duty_account_number',
    :'email' => :'email',
    :'exempt_shipping_handling_charge' => :'exempt_shipping_handling_charge',
    :'fedex_account_number' => :'fedex_account_number',
    :'free_shipping' => :'free_shipping',
    :'free_shipping_minimum' => :'free_shipping_minimum',
    :'last_modified_by' => :'last_modified_by',
    :'last_modified_dts' => :'last_modified_dts',
    :'loyalty' => :'loyalty',
    :'maximum_item_count' => :'maximum_item_count',
    :'minimum_item_count' => :'minimum_item_count',
    :'minimum_subtotal' => :'minimum_subtotal',
    :'no_coupons' => :'no_coupons',
    :'no_free_shipping' => :'no_free_shipping',
    :'no_realtime_charge' => :'no_realtime_charge',
    :'orders' => :'orders',
    :'orders_summary' => :'orders_summary',
    :'password' => :'password',
    :'pricing_tiers' => :'pricing_tiers',
    :'privacy' => :'privacy',
    :'qb_class' => :'qb_class',
    :'qb_code' => :'qb_code',
    :'quotes' => :'quotes',
    :'quotes_summary' => :'quotes_summary',
    :'referral_source' => :'referral_source',
    :'reviewer' => :'reviewer',
    :'sales_rep_code' => :'sales_rep_code',
    :'send_signup_notification' => :'send_signup_notification',
    :'shipping' => :'shipping',
    :'signup_dts' => :'signup_dts',
    :'software_entitlements' => :'software_entitlements',
    :'suppress_buysafe' => :'suppress_buysafe',
    :'tags' => :'tags',
    :'tax_codes' => :'tax_codes',
    :'tax_exempt' => :'tax_exempt',
    :'tax_id' => :'tax_id',
    :'terms' => :'terms',
    :'track_separately' => :'track_separately',
    :'unapproved' => :'unapproved',
    :'ups_account_number' => :'ups_account_number',
    :'website_url' => :'website_url'
  }
end

.swagger_typesObject

Attribute type mapping.



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
# File 'lib/ultracart_api/models/customer.rb', line 249

def self.swagger_types
  {
    :'activity' => :'CustomerActivity',
    :'affiliate_oid' => :'Integer',
    :'allow_3rd_party_billing' => :'BOOLEAN',
    :'allow_cod' => :'BOOLEAN',
    :'allow_purchase_order' => :'BOOLEAN',
    :'allow_quote_request' => :'BOOLEAN',
    :'allow_selection_of_address_type' => :'BOOLEAN',
    :'attachments' => :'Array<CustomerAttachment>',
    :'auto_approve_cod' => :'BOOLEAN',
    :'auto_approve_purchase_order' => :'BOOLEAN',
    :'automatic_merchant_notes' => :'String',
    :'billing' => :'Array<CustomerBilling>',
    :'business_notes' => :'String',
    :'cards' => :'Array<CustomerCard>',
    :'cc_emails' => :'Array<CustomerEmail>',
    :'customer_profile_oid' => :'Integer',
    :'dhl_account_number' => :'String',
    :'dhl_duty_account_number' => :'String',
    :'email' => :'String',
    :'exempt_shipping_handling_charge' => :'BOOLEAN',
    :'fedex_account_number' => :'String',
    :'free_shipping' => :'BOOLEAN',
    :'free_shipping_minimum' => :'Float',
    :'last_modified_by' => :'String',
    :'last_modified_dts' => :'String',
    :'loyalty' => :'CustomerLoyalty',
    :'maximum_item_count' => :'Integer',
    :'minimum_item_count' => :'Integer',
    :'minimum_subtotal' => :'Float',
    :'no_coupons' => :'BOOLEAN',
    :'no_free_shipping' => :'BOOLEAN',
    :'no_realtime_charge' => :'BOOLEAN',
    :'orders' => :'Array<Order>',
    :'orders_summary' => :'CustomerOrdersSummary',
    :'password' => :'String',
    :'pricing_tiers' => :'Array<CustomerPricingTier>',
    :'privacy' => :'CustomerPrivacy',
    :'qb_class' => :'String',
    :'qb_code' => :'String',
    :'quotes' => :'Array<Order>',
    :'quotes_summary' => :'CustomerQuotesSummary',
    :'referral_source' => :'String',
    :'reviewer' => :'CustomerReviewer',
    :'sales_rep_code' => :'String',
    :'send_signup_notification' => :'BOOLEAN',
    :'shipping' => :'Array<CustomerShipping>',
    :'signup_dts' => :'String',
    :'software_entitlements' => :'Array<CustomerSoftwareEntitlement>',
    :'suppress_buysafe' => :'BOOLEAN',
    :'tags' => :'Array<CustomerTag>',
    :'tax_codes' => :'CustomerTaxCodes',
    :'tax_exempt' => :'BOOLEAN',
    :'tax_id' => :'String',
    :'terms' => :'String',
    :'track_separately' => :'BOOLEAN',
    :'unapproved' => :'BOOLEAN',
    :'ups_account_number' => :'String',
    :'website_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'lib/ultracart_api/models/customer.rb', line 753

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      activity == o.activity &&
      affiliate_oid == o.affiliate_oid &&
      allow_3rd_party_billing == o.allow_3rd_party_billing &&
      allow_cod == o.allow_cod &&
      allow_purchase_order == o.allow_purchase_order &&
      allow_quote_request == o.allow_quote_request &&
      allow_selection_of_address_type == o.allow_selection_of_address_type &&
      attachments == o.attachments &&
      auto_approve_cod == o.auto_approve_cod &&
      auto_approve_purchase_order == o.auto_approve_purchase_order &&
      automatic_merchant_notes == o.automatic_merchant_notes &&
      billing == o.billing &&
      business_notes == o.business_notes &&
      cards == o.cards &&
      cc_emails == o.cc_emails &&
      customer_profile_oid == o.customer_profile_oid &&
       == o. &&
       == o. &&
      email == o.email &&
      exempt_shipping_handling_charge == o.exempt_shipping_handling_charge &&
       == o. &&
      free_shipping == o.free_shipping &&
      free_shipping_minimum == o.free_shipping_minimum &&
      last_modified_by == o.last_modified_by &&
      last_modified_dts == o.last_modified_dts &&
      loyalty == o.loyalty &&
      maximum_item_count == o.maximum_item_count &&
      minimum_item_count == o.minimum_item_count &&
      minimum_subtotal == o.minimum_subtotal &&
      no_coupons == o.no_coupons &&
      no_free_shipping == o.no_free_shipping &&
      no_realtime_charge == o.no_realtime_charge &&
      orders == o.orders &&
      orders_summary == o.orders_summary &&
      password == o.password &&
      pricing_tiers == o.pricing_tiers &&
      privacy == o.privacy &&
      qb_class == o.qb_class &&
      qb_code == o.qb_code &&
      quotes == o.quotes &&
      quotes_summary == o.quotes_summary &&
      referral_source == o.referral_source &&
      reviewer == o.reviewer &&
      sales_rep_code == o.sales_rep_code &&
       == o. &&
      shipping == o.shipping &&
       == o. &&
      software_entitlements == o.software_entitlements &&
      suppress_buysafe == o.suppress_buysafe &&
      tags == o.tags &&
      tax_codes == o.tax_codes &&
      tax_exempt == o.tax_exempt &&
      tax_id == o.tax_id &&
      terms == o.terms &&
      track_separately == o.track_separately &&
      unapproved == o.unapproved &&
       == o. &&
      website_url == o.website_url
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'lib/ultracart_api/models/customer.rb', line 852

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 =~ /\A(true|t|yes|y|1)\z/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
    temp_model = UltracartClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

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

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



918
919
920
921
922
923
924
925
926
927
928
929
930
# File 'lib/ultracart_api/models/customer.rb', line 918

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

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
# File 'lib/ultracart_api/models/customer.rb', line 831

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


818
819
820
# File 'lib/ultracart_api/models/customer.rb', line 818

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



824
825
826
# File 'lib/ultracart_api/models/customer.rb', line 824

def hash
  [activity, affiliate_oid, allow_3rd_party_billing, allow_cod, allow_purchase_order, allow_quote_request, allow_selection_of_address_type, attachments, auto_approve_cod, auto_approve_purchase_order, automatic_merchant_notes, billing, business_notes, cards, cc_emails, customer_profile_oid, , , email, exempt_shipping_handling_charge, , free_shipping, free_shipping_minimum, last_modified_by, last_modified_dts, loyalty, maximum_item_count, minimum_item_count, minimum_subtotal, no_coupons, no_free_shipping, no_realtime_charge, orders, orders_summary, password, pricing_tiers, privacy, qb_class, qb_code, quotes, quotes_summary, referral_source, reviewer, sales_rep_code, , shipping, , software_entitlements, suppress_buysafe, tags, tax_codes, tax_exempt, tax_id, terms, track_separately, unapproved, , website_url].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
# File 'lib/ultracart_api/models/customer.rb', line 575

def list_invalid_properties
  invalid_properties = Array.new
  if !@business_notes.nil? && @business_notes.to_s.length > 2000
    invalid_properties.push('invalid value for "business_notes", the character length must be smaller than or equal to 2000.')
  end

  if !@dhl_account_number.nil? && @dhl_account_number.to_s.length > 20
    invalid_properties.push('invalid value for "dhl_account_number", the character length must be smaller than or equal to 20.')
  end

  if !@dhl_duty_account_number.nil? && @dhl_duty_account_number.to_s.length > 20
    invalid_properties.push('invalid value for "dhl_duty_account_number", the character length must be smaller than or equal to 20.')
  end

  if !@fedex_account_number.nil? && @fedex_account_number.to_s.length > 20
    invalid_properties.push('invalid value for "fedex_account_number", the character length must be smaller than or equal to 20.')
  end

  if !@last_modified_by.nil? && @last_modified_by.to_s.length > 100
    invalid_properties.push('invalid value for "last_modified_by", the character length must be smaller than or equal to 100.')
  end

  if !@password.nil? && @password.to_s.length > 30
    invalid_properties.push('invalid value for "password", the character length must be smaller than or equal to 30.')
  end

  if !@referral_source.nil? && @referral_source.to_s.length > 50
    invalid_properties.push('invalid value for "referral_source", the character length must be smaller than or equal to 50.')
  end

  if !@sales_rep_code.nil? && @sales_rep_code.to_s.length > 10
    invalid_properties.push('invalid value for "sales_rep_code", the character length must be smaller than or equal to 10.')
  end

  if !@tax_id.nil? && @tax_id.to_s.length > 15
    invalid_properties.push('invalid value for "tax_id", the character length must be smaller than or equal to 15.')
  end

  if !@ups_account_number.nil? && @ups_account_number.to_s.length > 20
    invalid_properties.push('invalid value for "ups_account_number", the character length must be smaller than or equal to 20.')
  end

  if !@website_url.nil? && @website_url.to_s.length > 100
    invalid_properties.push('invalid value for "website_url", the character length must be smaller than or equal to 100.')
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



898
899
900
# File 'lib/ultracart_api/models/customer.rb', line 898

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



904
905
906
907
908
909
910
911
912
# File 'lib/ultracart_api/models/customer.rb', line 904

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



892
893
894
# File 'lib/ultracart_api/models/customer.rb', line 892

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



626
627
628
629
630
631
632
633
634
635
636
637
638
639
# File 'lib/ultracart_api/models/customer.rb', line 626

def valid?
  return false if !@business_notes.nil? && @business_notes.to_s.length > 2000
  return false if !@dhl_account_number.nil? && @dhl_account_number.to_s.length > 20
  return false if !@dhl_duty_account_number.nil? && @dhl_duty_account_number.to_s.length > 20
  return false if !@fedex_account_number.nil? && @fedex_account_number.to_s.length > 20
  return false if !@last_modified_by.nil? && @last_modified_by.to_s.length > 100
  return false if !@password.nil? && @password.to_s.length > 30
  return false if !@referral_source.nil? && @referral_source.to_s.length > 50
  return false if !@sales_rep_code.nil? && @sales_rep_code.to_s.length > 10
  return false if !@tax_id.nil? && @tax_id.to_s.length > 15
  return false if !@ups_account_number.nil? && @ups_account_number.to_s.length > 20
  return false if !@website_url.nil? && @website_url.to_s.length > 100
  true
end