Class: UltracartClient::ChannelPartnerOrder

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ChannelPartnerOrder

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
572
573
574
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
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
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
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 452

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?(:'advertisingSource')
    self.advertising_source = attributes[:'advertisingSource']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#advertising_source ⇒ Object

advertising_source



18
19
20
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 18

def advertising_source
  @advertising_source
end

#affiliate_id ⇒ Object

Affiliate Id



21
22
23
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 21

def affiliate_id
  @affiliate_id
end

#affiliate_sub_id ⇒ Object

Affiliate Sub Id



24
25
26
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 24

def affiliate_sub_id
  @affiliate_sub_id
end

#arbitrary_shipping_handling_total ⇒ Object

Arbitrary shipping handling total



27
28
29
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 27

def arbitrary_shipping_handling_total
  @arbitrary_shipping_handling_total
end

#arbitrary_tax ⇒ Object

Arbitrary tax for overriding calculated taxes



30
31
32
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 30

def arbitrary_tax
  @arbitrary_tax
end

#arbitrary_tax_rate ⇒ Object

Arbitrary tax rate



33
34
35
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 33

def arbitrary_tax_rate
  @arbitrary_tax_rate
end

#arbitrary_taxable_subtotal ⇒ Object

Arbitrary taxable subtotal



36
37
38
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 36

def arbitrary_taxable_subtotal
  @arbitrary_taxable_subtotal
end

#associate_with_customer_profile_if_present ⇒ Object

If true any matching customer profile based on email is associated with this order



39
40
41
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 39

def associate_with_customer_profile_if_present
  @associate_with_customer_profile_if_present
end

#auto_approve_purchase_order ⇒ Object

If true any purchase orders are automatically approved



42
43
44
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 42

def auto_approve_purchase_order
  @auto_approve_purchase_order
end

#billto_address1 ⇒ Object

Billing Address line 1



45
46
47
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 45

def billto_address1
  @billto_address1
end

#billto_address2 ⇒ Object

Billing Address line 2



48
49
50
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 48

def billto_address2
  @billto_address2
end

#billto_city ⇒ Object

Billing City



51
52
53
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 51

def billto_city
  @billto_city
end

#billto_company ⇒ Object

Billing Company



54
55
56
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 54

def billto_company
  @billto_company
end

#billto_country_code ⇒ Object

Billing ISO-3166 two letter country code



57
58
59
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 57

def billto_country_code
  @billto_country_code
end

#billto_day_phone ⇒ Object

Billing Day phone



60
61
62
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 60

def billto_day_phone
  @billto_day_phone
end

#billto_evening_phone ⇒ Object

Billing Evening phone



63
64
65
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 63

def billto_evening_phone
  @billto_evening_phone
end

#billto_first_name ⇒ Object

Billing First name



66
67
68
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 66

def billto_first_name
  @billto_first_name
end

#billto_last_name ⇒ Object

Billing Last name



69
70
71
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 69

def billto_last_name
  @billto_last_name
end

#billto_postal_code ⇒ Object

Billing Postal code



72
73
74
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 72

def billto_postal_code
  @billto_postal_code
end

#billto_state_region ⇒ Object

Billing State for United States otherwise region or province for other countries



75
76
77
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 75

def billto_state_region
  @billto_state_region
end

#billto_title ⇒ Object

Billing Title



78
79
80
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 78

def billto_title
  @billto_title
end

#cc_email ⇒ Object

CC email.



81
82
83
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 81

def cc_email
  @cc_email
end

#channel_partner_order_id ⇒ Object

The id for this order within the channel partner system.



84
85
86
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 84

def channel_partner_order_id
  @channel_partner_order_id
end

#consider_recurring ⇒ Object

If true this order is marked as an auto order (recurring)



87
88
89
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 87

def consider_recurring
  @consider_recurring
end

#coupons ⇒ Object

Array of coupon codes



90
91
92
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 90

def coupons
  @coupons
end

#credit_card_authorization_amount ⇒ Object

The amount authorized externally



93
94
95
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 93

def credit_card_authorization_amount
  @credit_card_authorization_amount
end

#credit_card_authorization_dts ⇒ Object

Date/Time of credit card authorization in ISO8601 format



96
97
98
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 96

def credit_card_authorization_dts
  @credit_card_authorization_dts
end

#credit_card_authorization_number ⇒ Object

The reference number provided by an externally processed transaction



99
100
101
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 99

def credit_card_authorization_number
  @credit_card_authorization_number
end

#credit_card_expiration_month ⇒ Object

Credit card expiration month



102
103
104
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 102

def credit_card_expiration_month
  @credit_card_expiration_month
end

#credit_card_expiration_year ⇒ Object

Credit card expiration year



105
106
107
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 105

def credit_card_expiration_year
  @credit_card_expiration_year
end

#credit_card_type ⇒ Object

Credit card type



108
109
110
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 108

def credit_card_type
  @credit_card_type
end

#custom_field1 ⇒ Object

Custom field 1



111
112
113
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 111

def custom_field1
  @custom_field1
end

#custom_field2 ⇒ Object

Custom field 2



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

def custom_field2
  @custom_field2
end

#custom_field3 ⇒ Object

Custom field 3



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

def custom_field3
  @custom_field3
end

#custom_field4 ⇒ Object

Custom field 4



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

def custom_field4
  @custom_field4
end

#custom_field5 ⇒ Object

Custom field 5



123
124
125
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 123

def custom_field5
  @custom_field5
end

#custom_field6 ⇒ Object

Custom field 6



126
127
128
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 126

def custom_field6
  @custom_field6
end

#custom_field7 ⇒ Object

Custom field 7



129
130
131
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 129

def custom_field7
  @custom_field7
end

#delivery_date ⇒ Object

Date the customer is requesting delivery on. Typically used for perishable product delivery.



132
133
134
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 132

def delivery_date
  @delivery_date
end

#email ⇒ Object

Email



135
136
137
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 135

def email
  @email
end

#gift ⇒ Object

True if this order is a gift



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

def gift
  @gift
end

#gift_email ⇒ Object

Email address of the gift recipient



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

def gift_email
  @gift_email
end

#gift_message ⇒ Object

Message to the gift recipient



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

def gift_message
  @gift_message
end

#hosted_fields_card_token ⇒ Object

The token provided by UltraCart hosted fields when a credit card number is uploaded into the system. This is the only way to provide a credit card number.



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

def hosted_fields_card_token
  @hosted_fields_card_token
end

#hosted_fields_cvv_token ⇒ Object

The token provided by UltraCart hosted fields when a credit card cvv is uploaded into the system. This is the only way to provide a cvv number.



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

def hosted_fields_cvv_token
  @hosted_fields_cvv_token
end

#insurance_application_id ⇒ Object

Insurance application id



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

def insurance_application_id
  @insurance_application_id
end

#insurance_claim_id ⇒ Object

Insurance claim id



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

def insurance_claim_id
  @insurance_claim_id
end

#ip_address ⇒ Object

IP Address of the customer



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

def ip_address
  @ip_address
end

#items ⇒ Object

Items



162
163
164
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 162

def items
  @items
end

#least_cost_route ⇒ Object

If true the least expensive shipping method is automatically chosen during the order import



165
166
167
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 165

def least_cost_route
  @least_cost_route
end

#least_cost_route_shipping_methods ⇒ Object

An optional array of shipping methods to restict choices if least_cost_route is true



168
169
170
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 168

def least_cost_route_shipping_methods
  @least_cost_route_shipping_methods
end

#mailing_list_opt_in ⇒ Object

If true the customer is subscribed to any configured mailing lists



171
172
173
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 171

def mailing_list_opt_in
  @mailing_list_opt_in
end

#no_realtime_payment_processing ⇒ Object

If true no payment processing is done and the order is placed into Accounts Receivable



174
175
176
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 174

def no_realtime_payment_processing
  @no_realtime_payment_processing
end

#payment_method ⇒ Object

Payment method



177
178
179
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 177

def payment_method
  @payment_method
end

#purchase_order_number ⇒ Object

Purchase order number



180
181
182
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 180

def purchase_order_number
  @purchase_order_number
end

#rotating_transaction_gateway_code ⇒ Object

The rotating transaction gateway code for the gateway used to charge this order



183
184
185
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 183

def rotating_transaction_gateway_code
  @rotating_transaction_gateway_code
end

#screen_branding_theme_code ⇒ Object

Screen branding theme code



186
187
188
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 186

def screen_branding_theme_code
  @screen_branding_theme_code
end

#ship_on_date ⇒ Object

Date the customer is requesting that the order ship on. Typically used for perishable product delivery.



189
190
191
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 189

def ship_on_date
  @ship_on_date
end

#ship_to_residential ⇒ Object

True if the shipping adress is residential. Effects the methods that are available to the customer as well as the price of the shipping method.



192
193
194
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 192

def ship_to_residential
  @ship_to_residential
end

#shipping_method ⇒ Object

Shipping method



195
196
197
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 195

def shipping_method
  @shipping_method
end

#shipto_address1 ⇒ Object

Shipping Address line 1



198
199
200
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 198

def shipto_address1
  @shipto_address1
end

#shipto_address2 ⇒ Object

Shipping Address line 2



201
202
203
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 201

def shipto_address2
  @shipto_address2
end

#shipto_city ⇒ Object

Shipping City



204
205
206
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 204

def shipto_city
  @shipto_city
end

#shipto_company ⇒ Object

Shipping Company



207
208
209
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 207

def shipto_company
  @shipto_company
end

#shipto_country_code ⇒ Object

Shipping ISO-3166 two letter country code



210
211
212
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 210

def shipto_country_code
  @shipto_country_code
end

#shipto_day_phone ⇒ Object

Shipping Day phone



213
214
215
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 213

def shipto_day_phone
  @shipto_day_phone
end

#shipto_evening_phone ⇒ Object

Shipping Evening phone



216
217
218
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 216

def shipto_evening_phone
  @shipto_evening_phone
end

#shipto_first_name ⇒ Object

Shipping First name



219
220
221
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 219

def shipto_first_name
  @shipto_first_name
end

#shipto_last_name ⇒ Object

Shipping Last name



222
223
224
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 222

def shipto_last_name
  @shipto_last_name
end

#shipto_postal_code ⇒ Object

Shipping Postal code



225
226
227
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 225

def shipto_postal_code
  @shipto_postal_code
end

#shipto_state_region ⇒ Object

Shipping State for United States otherwise region or province for other countries



228
229
230
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 228

def shipto_state_region
  @shipto_state_region
end

#shipto_title ⇒ Object

Shipping Title



231
232
233
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 231

def shipto_title
  @shipto_title
end

#skip_payment_processing ⇒ Object

If true the order is placed directly into the shipping department



234
235
236
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 234

def skip_payment_processing
  @skip_payment_processing
end

#special_instructions ⇒ Object

Special instructions from the customer regarding shipping



237
238
239
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 237

def special_instructions
  @special_instructions
end

#store_completed ⇒ Object

If true the order bypasses shipping and is marked completed



240
241
242
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 240

def store_completed
  @store_completed
end

#store_if_payment_declines ⇒ Object

If true any failed payments are placed into Accounts Receivable. If false any failed payments result in a rejected order resulting in errors thrown during the insert routine



243
244
245
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 243

def store_if_payment_declines
  @store_if_payment_declines
end

#tax_county ⇒ Object

The optional shipping county used to determine exact taxes



246
247
248
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 246

def tax_county
  @tax_county
end

#tax_exempt ⇒ Object

If true this order is marked as being tax exempt



249
250
251
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 249

def tax_exempt
  @tax_exempt
end

#transaction ⇒ Object

Returns the value of attribute transaction.



251
252
253
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 251

def transaction
  @transaction
end

#treat_warnings_as_errors ⇒ Object

If true all warnings are considered errors, this is true by default



254
255
256
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 254

def treat_warnings_as_errors
  @treat_warnings_as_errors
end

Class Method Details

.attribute_map ⇒ Object

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



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
311
312
313
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
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 279

def self.attribute_map
  {
    :'advertising_source' => :'advertisingSource',
    :'affiliate_id' => :'affiliate_id',
    :'affiliate_sub_id' => :'affiliate_sub_id',
    :'arbitrary_shipping_handling_total' => :'arbitrary_shipping_handling_total',
    :'arbitrary_tax' => :'arbitrary_tax',
    :'arbitrary_tax_rate' => :'arbitrary_tax_rate',
    :'arbitrary_taxable_subtotal' => :'arbitrary_taxable_subtotal',
    :'associate_with_customer_profile_if_present' => :'associate_with_customer_profile_if_present',
    :'auto_approve_purchase_order' => :'auto_approve_purchase_order',
    :'billto_address1' => :'billto_address1',
    :'billto_address2' => :'billto_address2',
    :'billto_city' => :'billto_city',
    :'billto_company' => :'billto_company',
    :'billto_country_code' => :'billto_country_code',
    :'billto_day_phone' => :'billto_day_phone',
    :'billto_evening_phone' => :'billto_evening_phone',
    :'billto_first_name' => :'billto_first_name',
    :'billto_last_name' => :'billto_last_name',
    :'billto_postal_code' => :'billto_postal_code',
    :'billto_state_region' => :'billto_state_region',
    :'billto_title' => :'billto_title',
    :'cc_email' => :'cc_email',
    :'channel_partner_order_id' => :'channel_partner_order_id',
    :'consider_recurring' => :'consider_recurring',
    :'coupons' => :'coupons',
    :'credit_card_authorization_amount' => :'credit_card_authorization_amount',
    :'credit_card_authorization_dts' => :'credit_card_authorization_dts',
    :'credit_card_authorization_number' => :'credit_card_authorization_number',
    :'credit_card_expiration_month' => :'credit_card_expiration_month',
    :'credit_card_expiration_year' => :'credit_card_expiration_year',
    :'credit_card_type' => :'credit_card_type',
    :'custom_field1' => :'custom_field1',
    :'custom_field2' => :'custom_field2',
    :'custom_field3' => :'custom_field3',
    :'custom_field4' => :'custom_field4',
    :'custom_field5' => :'custom_field5',
    :'custom_field6' => :'custom_field6',
    :'custom_field7' => :'custom_field7',
    :'delivery_date' => :'delivery_date',
    :'email' => :'email',
    :'gift' => :'gift',
    :'gift_email' => :'gift_email',
    :'gift_message' => :'gift_message',
    :'hosted_fields_card_token' => :'hosted_fields_card_token',
    :'hosted_fields_cvv_token' => :'hosted_fields_cvv_token',
    :'insurance_application_id' => :'insurance_application_id',
    :'insurance_claim_id' => :'insurance_claim_id',
    :'ip_address' => :'ip_address',
    :'items' => :'items',
    :'least_cost_route' => :'least_cost_route',
    :'least_cost_route_shipping_methods' => :'least_cost_route_shipping_methods',
    :'mailing_list_opt_in' => :'mailing_list_opt_in',
    :'no_realtime_payment_processing' => :'no_realtime_payment_processing',
    :'payment_method' => :'payment_method',
    :'purchase_order_number' => :'purchase_order_number',
    :'rotating_transaction_gateway_code' => :'rotating_transaction_gateway_code',
    :'screen_branding_theme_code' => :'screen_branding_theme_code',
    :'ship_on_date' => :'ship_on_date',
    :'ship_to_residential' => :'ship_to_residential',
    :'shipping_method' => :'shipping_method',
    :'shipto_address1' => :'shipto_address1',
    :'shipto_address2' => :'shipto_address2',
    :'shipto_city' => :'shipto_city',
    :'shipto_company' => :'shipto_company',
    :'shipto_country_code' => :'shipto_country_code',
    :'shipto_day_phone' => :'shipto_day_phone',
    :'shipto_evening_phone' => :'shipto_evening_phone',
    :'shipto_first_name' => :'shipto_first_name',
    :'shipto_last_name' => :'shipto_last_name',
    :'shipto_postal_code' => :'shipto_postal_code',
    :'shipto_state_region' => :'shipto_state_region',
    :'shipto_title' => :'shipto_title',
    :'skip_payment_processing' => :'skip_payment_processing',
    :'special_instructions' => :'special_instructions',
    :'store_completed' => :'store_completed',
    :'store_if_payment_declines' => :'store_if_payment_declines',
    :'tax_county' => :'tax_county',
    :'tax_exempt' => :'tax_exempt',
    :'transaction' => :'transaction',
    :'treat_warnings_as_errors' => :'treat_warnings_as_errors'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 365

def self.swagger_types
  {
    :'advertising_source' => :'String',
    :'affiliate_id' => :'String',
    :'affiliate_sub_id' => :'String',
    :'arbitrary_shipping_handling_total' => :'Float',
    :'arbitrary_tax' => :'Float',
    :'arbitrary_tax_rate' => :'Float',
    :'arbitrary_taxable_subtotal' => :'Float',
    :'associate_with_customer_profile_if_present' => :'BOOLEAN',
    :'auto_approve_purchase_order' => :'BOOLEAN',
    :'billto_address1' => :'String',
    :'billto_address2' => :'String',
    :'billto_city' => :'String',
    :'billto_company' => :'String',
    :'billto_country_code' => :'String',
    :'billto_day_phone' => :'String',
    :'billto_evening_phone' => :'String',
    :'billto_first_name' => :'String',
    :'billto_last_name' => :'String',
    :'billto_postal_code' => :'String',
    :'billto_state_region' => :'String',
    :'billto_title' => :'String',
    :'cc_email' => :'String',
    :'channel_partner_order_id' => :'String',
    :'consider_recurring' => :'BOOLEAN',
    :'coupons' => :'Array<String>',
    :'credit_card_authorization_amount' => :'Float',
    :'credit_card_authorization_dts' => :'String',
    :'credit_card_authorization_number' => :'String',
    :'credit_card_expiration_month' => :'Integer',
    :'credit_card_expiration_year' => :'Integer',
    :'credit_card_type' => :'String',
    :'custom_field1' => :'String',
    :'custom_field2' => :'String',
    :'custom_field3' => :'String',
    :'custom_field4' => :'String',
    :'custom_field5' => :'String',
    :'custom_field6' => :'String',
    :'custom_field7' => :'String',
    :'delivery_date' => :'String',
    :'email' => :'String',
    :'gift' => :'BOOLEAN',
    :'gift_email' => :'String',
    :'gift_message' => :'String',
    :'hosted_fields_card_token' => :'String',
    :'hosted_fields_cvv_token' => :'String',
    :'insurance_application_id' => :'String',
    :'insurance_claim_id' => :'String',
    :'ip_address' => :'String',
    :'items' => :'Array<ChannelPartnerOrderItem>',
    :'least_cost_route' => :'BOOLEAN',
    :'least_cost_route_shipping_methods' => :'Array<String>',
    :'mailing_list_opt_in' => :'BOOLEAN',
    :'no_realtime_payment_processing' => :'BOOLEAN',
    :'payment_method' => :'String',
    :'purchase_order_number' => :'String',
    :'rotating_transaction_gateway_code' => :'String',
    :'screen_branding_theme_code' => :'String',
    :'ship_on_date' => :'String',
    :'ship_to_residential' => :'BOOLEAN',
    :'shipping_method' => :'String',
    :'shipto_address1' => :'String',
    :'shipto_address2' => :'String',
    :'shipto_city' => :'String',
    :'shipto_company' => :'String',
    :'shipto_country_code' => :'String',
    :'shipto_day_phone' => :'String',
    :'shipto_evening_phone' => :'String',
    :'shipto_first_name' => :'String',
    :'shipto_last_name' => :'String',
    :'shipto_postal_code' => :'String',
    :'shipto_state_region' => :'String',
    :'shipto_title' => :'String',
    :'skip_payment_processing' => :'BOOLEAN',
    :'special_instructions' => :'String',
    :'store_completed' => :'BOOLEAN',
    :'store_if_payment_declines' => :'BOOLEAN',
    :'tax_county' => :'String',
    :'tax_exempt' => :'BOOLEAN',
    :'transaction' => :'ChannelPartnerOrderTransaction',
    :'treat_warnings_as_errors' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 1367

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      advertising_source == o.advertising_source &&
      affiliate_id == o.affiliate_id &&
      affiliate_sub_id == o.affiliate_sub_id &&
      arbitrary_shipping_handling_total == o.arbitrary_shipping_handling_total &&
      arbitrary_tax == o.arbitrary_tax &&
      arbitrary_tax_rate == o.arbitrary_tax_rate &&
      arbitrary_taxable_subtotal == o.arbitrary_taxable_subtotal &&
      associate_with_customer_profile_if_present == o.associate_with_customer_profile_if_present &&
      auto_approve_purchase_order == o.auto_approve_purchase_order &&
      billto_address1 == o.billto_address1 &&
      billto_address2 == o.billto_address2 &&
      billto_city == o.billto_city &&
      billto_company == o.billto_company &&
      billto_country_code == o.billto_country_code &&
      billto_day_phone == o.billto_day_phone &&
      billto_evening_phone == o.billto_evening_phone &&
      billto_first_name == o.billto_first_name &&
      billto_last_name == o.billto_last_name &&
      billto_postal_code == o.billto_postal_code &&
      billto_state_region == o.billto_state_region &&
      billto_title == o.billto_title &&
      cc_email == o.cc_email &&
      channel_partner_order_id == o.channel_partner_order_id &&
      consider_recurring == o.consider_recurring &&
      coupons == o.coupons &&
      credit_card_authorization_amount == o.credit_card_authorization_amount &&
      credit_card_authorization_dts == o.credit_card_authorization_dts &&
      credit_card_authorization_number == o.credit_card_authorization_number &&
      credit_card_expiration_month == o.credit_card_expiration_month &&
      credit_card_expiration_year == o.credit_card_expiration_year &&
      credit_card_type == o.credit_card_type &&
      custom_field1 == o.custom_field1 &&
      custom_field2 == o.custom_field2 &&
      custom_field3 == o.custom_field3 &&
      custom_field4 == o.custom_field4 &&
      custom_field5 == o.custom_field5 &&
      custom_field6 == o.custom_field6 &&
      custom_field7 == o.custom_field7 &&
      delivery_date == o.delivery_date &&
      email == o.email &&
      gift == o.gift &&
      gift_email == o.gift_email &&
      gift_message == o.gift_message &&
      hosted_fields_card_token == o.hosted_fields_card_token &&
      hosted_fields_cvv_token == o.hosted_fields_cvv_token &&
      insurance_application_id == o.insurance_application_id &&
      insurance_claim_id == o.insurance_claim_id &&
      ip_address == o.ip_address &&
      items == o.items &&
      least_cost_route == o.least_cost_route &&
      least_cost_route_shipping_methods == o.least_cost_route_shipping_methods &&
      mailing_list_opt_in == o.mailing_list_opt_in &&
      no_realtime_payment_processing == o.no_realtime_payment_processing &&
      payment_method == o.payment_method &&
      purchase_order_number == o.purchase_order_number &&
      rotating_transaction_gateway_code == o.rotating_transaction_gateway_code &&
      screen_branding_theme_code == o.screen_branding_theme_code &&
      ship_on_date == o.ship_on_date &&
      ship_to_residential == o.ship_to_residential &&
      shipping_method == o.shipping_method &&
      shipto_address1 == o.shipto_address1 &&
      shipto_address2 == o.shipto_address2 &&
      shipto_city == o.shipto_city &&
      shipto_company == o.shipto_company &&
      shipto_country_code == o.shipto_country_code &&
      shipto_day_phone == o.shipto_day_phone &&
      shipto_evening_phone == o.shipto_evening_phone &&
      shipto_first_name == o.shipto_first_name &&
      shipto_last_name == o.shipto_last_name &&
      shipto_postal_code == o.shipto_postal_code &&
      shipto_state_region == o.shipto_state_region &&
      shipto_title == o.shipto_title &&
      skip_payment_processing == o.skip_payment_processing &&
      special_instructions == o.special_instructions &&
      store_completed == o.store_completed &&
      store_if_payment_declines == o.store_if_payment_declines &&
      tax_county == o.tax_county &&
      tax_exempt == o.tax_exempt &&
      transaction == o.transaction &&
      treat_warnings_as_errors == o.treat_warnings_as_errors
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



1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 1488

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



1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 1554

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



1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 1467

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


1454
1455
1456
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 1454

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



1460
1461
1462
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 1460

def hash
  [advertising_source, affiliate_id, affiliate_sub_id, arbitrary_shipping_handling_total, arbitrary_tax, arbitrary_tax_rate, arbitrary_taxable_subtotal, associate_with_customer_profile_if_present, auto_approve_purchase_order, billto_address1, billto_address2, billto_city, billto_company, billto_country_code, billto_day_phone, billto_evening_phone, billto_first_name, billto_last_name, billto_postal_code, billto_state_region, billto_title, cc_email, channel_partner_order_id, consider_recurring, coupons, credit_card_authorization_amount, credit_card_authorization_dts, credit_card_authorization_number, credit_card_expiration_month, credit_card_expiration_year, credit_card_type, custom_field1, custom_field2, custom_field3, custom_field4, custom_field5, custom_field6, custom_field7, delivery_date, email, gift, gift_email, gift_message, hosted_fields_card_token, hosted_fields_cvv_token, insurance_application_id, insurance_claim_id, ip_address, items, least_cost_route, least_cost_route_shipping_methods, mailing_list_opt_in, no_realtime_payment_processing, payment_method, purchase_order_number, rotating_transaction_gateway_code, screen_branding_theme_code, ship_on_date, ship_to_residential, shipping_method, shipto_address1, shipto_address2, shipto_city, shipto_company, shipto_country_code, shipto_day_phone, shipto_evening_phone, shipto_first_name, shipto_last_name, shipto_postal_code, shipto_state_region, shipto_title, skip_payment_processing, special_instructions, store_completed, store_if_payment_declines, tax_county, tax_exempt, transaction, treat_warnings_as_errors].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



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
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
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
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 787

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



1534
1535
1536
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 1534

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



1540
1541
1542
1543
1544
1545
1546
1547
1548
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 1540

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



1528
1529
1530
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 1528

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



942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 942

def valid?
  return false if !@billto_address1.nil? && @billto_address1.to_s.length > 50
  return false if !@billto_address2.nil? && @billto_address2.to_s.length > 50
  return false if !@billto_city.nil? && @billto_city.to_s.length > 32
  return false if !@billto_company.nil? && @billto_company.to_s.length > 50
  return false if !@billto_country_code.nil? && @billto_country_code.to_s.length > 2
  return false if !@billto_day_phone.nil? && @billto_day_phone.to_s.length > 25
  return false if !@billto_evening_phone.nil? && @billto_evening_phone.to_s.length > 25
  return false if !@billto_first_name.nil? && @billto_first_name.to_s.length > 30
  return false if !@billto_last_name.nil? && @billto_last_name.to_s.length > 30
  return false if !@billto_postal_code.nil? && @billto_postal_code.to_s.length > 20
  return false if !@billto_state_region.nil? && @billto_state_region.to_s.length > 32
  return false if !@billto_title.nil? && @billto_title.to_s.length > 50
  return false if !@cc_email.nil? && @cc_email.to_s.length > 100
  return false if !@custom_field1.nil? && @custom_field1.to_s.length > 50
  return false if !@custom_field2.nil? && @custom_field2.to_s.length > 50
  return false if !@custom_field3.nil? && @custom_field3.to_s.length > 50
  return false if !@custom_field4.nil? && @custom_field4.to_s.length > 50
  return false if !@custom_field5.nil? && @custom_field5.to_s.length > 75
  return false if !@custom_field6.nil? && @custom_field6.to_s.length > 50
  return false if !@custom_field7.nil? && @custom_field7.to_s.length > 50
  return false if !@email.nil? && @email.to_s.length > 100
  return false if !@gift_email.nil? && @gift_email.to_s.length > 100
  return false if !@gift_message.nil? && @gift_message.to_s.length > 10000
  payment_method_validator = EnumAttributeValidator.new('String', ['Affirm', 'Amazon', 'Check', 'COD', 'Credit Card', 'LoanHero', 'Money Order', 'PayPal', 'Purchase Order', 'Quote Request', 'Wire Transfer'])
  return false unless payment_method_validator.valid?(@payment_method)
  return false if !@screen_branding_theme_code.nil? && @screen_branding_theme_code.to_s.length > 10
  return false if !@shipto_address1.nil? && @shipto_address1.to_s.length > 50
  return false if !@shipto_address2.nil? && @shipto_address2.to_s.length > 50
  return false if !@shipto_city.nil? && @shipto_city.to_s.length > 32
  return false if !@shipto_company.nil? && @shipto_company.to_s.length > 50
  return false if !@shipto_country_code.nil? && @shipto_country_code.to_s.length > 2
  return false if !@shipto_day_phone.nil? && @shipto_day_phone.to_s.length > 25
  return false if !@shipto_evening_phone.nil? && @shipto_evening_phone.to_s.length > 25
  return false if !@shipto_first_name.nil? && @shipto_first_name.to_s.length > 30
  return false if !@shipto_last_name.nil? && @shipto_last_name.to_s.length > 30
  return false if !@shipto_postal_code.nil? && @shipto_postal_code.to_s.length > 20
  return false if !@shipto_state_region.nil? && @shipto_state_region.to_s.length > 32
  return false if !@shipto_title.nil? && @shipto_title.to_s.length > 50
  return false if !@special_instructions.nil? && @special_instructions.to_s.length > 10000
  true
end