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



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::ChannelPartnerOrder` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::ChannelPartnerOrder`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'advertising_source')
    self.advertising_source = attributes[:'advertising_source']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'echeck_bank_aba_code')
    self.echeck_bank_aba_code = attributes[:'echeck_bank_aba_code']
  end

  if attributes.key?(:'echeck_bank_account_name')
    self. = attributes[:'echeck_bank_account_name']
  end

  if attributes.key?(:'echeck_bank_account_number')
    self. = attributes[:'echeck_bank_account_number']
  end

  if attributes.key?(:'echeck_bank_account_type')
    self. = attributes[:'echeck_bank_account_type']
  end

  if attributes.key?(:'echeck_bank_name')
    self.echeck_bank_name = attributes[:'echeck_bank_name']
  end

  if attributes.key?(:'echeck_bank_owner_type')
    self.echeck_bank_owner_type = attributes[:'echeck_bank_owner_type']
  end

  if attributes.key?(:'echeck_customer_tax_id')
    self.echeck_customer_tax_id = attributes[:'echeck_customer_tax_id']
  end

  if attributes.key?(:'echeck_drivers_license_dob')
    self.echeck_drivers_license_dob = attributes[:'echeck_drivers_license_dob']
  end

  if attributes.key?(:'echeck_drivers_license_number')
    self.echeck_drivers_license_number = attributes[:'echeck_drivers_license_number']
  end

  if attributes.key?(:'echeck_drivers_license_state')
    self.echeck_drivers_license_state = attributes[:'echeck_drivers_license_state']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'storefront_host_name')
    self.storefront_host_name = attributes[:'storefront_host_name']
  end

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

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

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

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

  if attributes.key?(:'use_prior_payment_information_from_order_id')
    self.use_prior_payment_information_from_order_id = attributes[:'use_prior_payment_information_from_order_id']
  end
end

Instance Attribute Details

#advertising_source ⇒ Object

advertising_source



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

def advertising_source
  @advertising_source
end

#affiliate_id ⇒ Object

Affiliate Id



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

def affiliate_id
  @affiliate_id
end

#affiliate_sub_id ⇒ Object

Affiliate Sub Id



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

def affiliate_sub_id
  @affiliate_sub_id
end

#arbitrary_shipping_handling_total ⇒ Object

Arbitrary shipping handling total



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

def arbitrary_shipping_handling_total
  @arbitrary_shipping_handling_total
end

#arbitrary_tax ⇒ Object

Arbitrary tax for overriding calculated taxes



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

def arbitrary_tax
  @arbitrary_tax
end

#arbitrary_tax_rate ⇒ Object

Arbitrary tax rate



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

def arbitrary_tax_rate
  @arbitrary_tax_rate
end

#arbitrary_taxable_subtotal ⇒ Object

Arbitrary taxable subtotal



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

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



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

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



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

def auto_approve_purchase_order
  @auto_approve_purchase_order
end

#billto_address1 ⇒ Object

Billing Address line 1



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

def billto_address1
  @billto_address1
end

#billto_address2 ⇒ Object

Billing Address line 2



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

def billto_address2
  @billto_address2
end

#billto_city ⇒ Object

Billing City



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

def billto_city
  @billto_city
end

#billto_company ⇒ Object

Billing Company



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

def billto_company
  @billto_company
end

#billto_country_code ⇒ Object

Billing ISO-3166 two letter country code



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

def billto_country_code
  @billto_country_code
end

#billto_day_phone ⇒ Object

Billing Day phone



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

def billto_day_phone
  @billto_day_phone
end

#billto_evening_phone ⇒ Object

Billing Evening phone



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

def billto_evening_phone
  @billto_evening_phone
end

#billto_first_name ⇒ Object

Billing First name



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

def billto_first_name
  @billto_first_name
end

#billto_last_name ⇒ Object

Billing Last name



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

def billto_last_name
  @billto_last_name
end

#billto_postal_code ⇒ Object

Billing Postal code



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

def billto_postal_code
  @billto_postal_code
end

#billto_state_region ⇒ Object

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



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

def billto_state_region
  @billto_state_region
end

#billto_title ⇒ Object

Billing Title



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

def billto_title
  @billto_title
end

#cc_email ⇒ Object

CC email.



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

def cc_email
  @cc_email
end

#channel_partner_order_id ⇒ Object

The id for this order within the channel partner system.



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

def channel_partner_order_id
  @channel_partner_order_id
end

#consider_recurring ⇒ Object

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



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

def consider_recurring
  @consider_recurring
end

#coupons ⇒ Object

Array of coupon codes



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

def coupons
  @coupons
end

#credit_card_authorization_amount ⇒ Object

The amount authorized externally



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

def credit_card_authorization_amount
  @credit_card_authorization_amount
end

#credit_card_authorization_dts ⇒ Object

Date/Time of credit card authorization in ISO8601 format



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

def credit_card_authorization_dts
  @credit_card_authorization_dts
end

#credit_card_authorization_number ⇒ Object

The reference number provided by an externally processed transaction



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

def credit_card_authorization_number
  @credit_card_authorization_number
end

#credit_card_expiration_month ⇒ Object

Credit card expiration month



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

def credit_card_expiration_month
  @credit_card_expiration_month
end

#credit_card_expiration_year ⇒ Object

Credit card expiration year



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

def credit_card_expiration_year
  @credit_card_expiration_year
end

#credit_card_type ⇒ Object

Credit card type



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

def credit_card_type
  @credit_card_type
end

#custom_field1 ⇒ Object

Custom field 1



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

def custom_field1
  @custom_field1
end

#custom_field2 ⇒ Object

Custom field 2



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

def custom_field2
  @custom_field2
end

#custom_field3 ⇒ Object

Custom field 3



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

def custom_field3
  @custom_field3
end

#custom_field4 ⇒ Object

Custom field 4



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

def custom_field4
  @custom_field4
end

#custom_field5 ⇒ Object

Custom field 5



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

def custom_field5
  @custom_field5
end

#custom_field6 ⇒ Object

Custom field 6



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

def custom_field6
  @custom_field6
end

#custom_field7 ⇒ Object

Custom field 7



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

def custom_field7
  @custom_field7
end

#delivery_date ⇒ Object

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



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

def delivery_date
  @delivery_date
end

#echeck_bank_aba_code ⇒ Object

eCheck bank ABA code



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

def echeck_bank_aba_code
  @echeck_bank_aba_code
end

#echeck_bank_account_name ⇒ Object

eCheck bank account name



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

def 
  @echeck_bank_account_name
end

#echeck_bank_account_number ⇒ Object

eCheck bank account number



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

def 
  @echeck_bank_account_number
end

#echeck_bank_account_type ⇒ Object

eCheck bank account type



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

def 
  @echeck_bank_account_type
end

#echeck_bank_name ⇒ Object

eCheck bank name



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

def echeck_bank_name
  @echeck_bank_name
end

#echeck_bank_owner_type ⇒ Object

eCheck bank owner type



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

def echeck_bank_owner_type
  @echeck_bank_owner_type
end

#echeck_customer_tax_id ⇒ Object

eCheck customer tax id



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

def echeck_customer_tax_id
  @echeck_customer_tax_id
end

#echeck_drivers_license_dob ⇒ Object

eCheck drivers license dob



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

def echeck_drivers_license_dob
  @echeck_drivers_license_dob
end

#echeck_drivers_license_number ⇒ Object

eCheck drivers license number



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

def echeck_drivers_license_number
  @echeck_drivers_license_number
end

#echeck_drivers_license_state ⇒ Object

eCheck drivers license state



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

def echeck_drivers_license_state
  @echeck_drivers_license_state
end

#email ⇒ Object

Email



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

def email
  @email
end

#gift ⇒ Object

True if this order is a gift



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

def gift
  @gift
end

#gift_email ⇒ Object

Email address of the gift recipient



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

def gift_email
  @gift_email
end

#gift_message ⇒ Object

Message to the gift recipient



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

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.



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

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.



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

def hosted_fields_cvv_token
  @hosted_fields_cvv_token
end

#insurance_application_id ⇒ Object

Insurance application id



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

def insurance_application_id
  @insurance_application_id
end

#insurance_claim_id ⇒ Object

Insurance claim id



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

def insurance_claim_id
  @insurance_claim_id
end

#ip_address ⇒ Object

IP Address of the customer



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

def ip_address
  @ip_address
end

#items ⇒ Object

Items



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

def items
  @items
end

#least_cost_route ⇒ Object

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



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

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



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

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



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

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



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

def no_realtime_payment_processing
  @no_realtime_payment_processing
end

#payment_method ⇒ Object

Payment method



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

def payment_method
  @payment_method
end

#purchase_order_number ⇒ Object

Purchase order number



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

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



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

def rotating_transaction_gateway_code
  @rotating_transaction_gateway_code
end

#sales_rep_code ⇒ Object

Sales rep code



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

def sales_rep_code
  @sales_rep_code
end

#screen_branding_theme_code ⇒ Object

Screen branding theme code



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

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.



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

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.



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

def ship_to_residential
  @ship_to_residential
end

#shipping_method ⇒ Object

Shipping method



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

def shipping_method
  @shipping_method
end

#shipto_address1 ⇒ Object

Shipping Address line 1



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

def shipto_address1
  @shipto_address1
end

#shipto_address2 ⇒ Object

Shipping Address line 2



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

def shipto_address2
  @shipto_address2
end

#shipto_city ⇒ Object

Shipping City



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

def shipto_city
  @shipto_city
end

#shipto_company ⇒ Object

Shipping Company



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

def shipto_company
  @shipto_company
end

#shipto_country_code ⇒ Object

Shipping ISO-3166 two letter country code



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

def shipto_country_code
  @shipto_country_code
end

#shipto_day_phone ⇒ Object

Shipping Day phone



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

def shipto_day_phone
  @shipto_day_phone
end

#shipto_evening_phone ⇒ Object

Shipping Evening phone



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

def shipto_evening_phone
  @shipto_evening_phone
end

#shipto_first_name ⇒ Object

Shipping First name



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

def shipto_first_name
  @shipto_first_name
end

#shipto_last_name ⇒ Object

Shipping Last name



256
257
258
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 256

def shipto_last_name
  @shipto_last_name
end

#shipto_postal_code ⇒ Object

Shipping Postal code



259
260
261
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 259

def shipto_postal_code
  @shipto_postal_code
end

#shipto_state_region ⇒ Object

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



262
263
264
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 262

def shipto_state_region
  @shipto_state_region
end

#shipto_title ⇒ Object

Shipping Title



265
266
267
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 265

def shipto_title
  @shipto_title
end

#skip_payment_processing ⇒ Object

If true the order is placed directly into the shipping department



268
269
270
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 268

def skip_payment_processing
  @skip_payment_processing
end

#special_instructions ⇒ Object

Special instructions from the customer regarding shipping



271
272
273
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 271

def special_instructions
  @special_instructions
end

#store_completed ⇒ Object

If true the order bypasses shipping and is marked completed



274
275
276
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 274

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



277
278
279
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 277

def store_if_payment_declines
  @store_if_payment_declines
end

#storefront_host_name ⇒ Object

StoreFront host name associated with the order



280
281
282
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 280

def storefront_host_name
  @storefront_host_name
end

#tax_county ⇒ Object

The optional shipping county used to determine exact taxes



283
284
285
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 283

def tax_county
  @tax_county
end

#tax_exempt ⇒ Object

If true this order is marked as being tax exempt



286
287
288
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 286

def tax_exempt
  @tax_exempt
end

#transaction ⇒ Object

Returns the value of attribute transaction.



288
289
290
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 288

def transaction
  @transaction
end

#treat_warnings_as_errors ⇒ Object

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



291
292
293
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 291

def treat_warnings_as_errors
  @treat_warnings_as_errors
end

#use_prior_payment_information_from_order_id ⇒ Object

An Order Id from a prior purchase of this customer which is used to retrieve vaulted payment information in order to pay for this current order.



294
295
296
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 294

def use_prior_payment_information_from_order_id
  @use_prior_payment_information_from_order_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



418
419
420
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 418

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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',
    :'echeck_bank_aba_code' => :'echeck_bank_aba_code',
    :'echeck_bank_account_name' => :'echeck_bank_account_name',
    :'echeck_bank_account_number' => :'echeck_bank_account_number',
    :'echeck_bank_account_type' => :'echeck_bank_account_type',
    :'echeck_bank_name' => :'echeck_bank_name',
    :'echeck_bank_owner_type' => :'echeck_bank_owner_type',
    :'echeck_customer_tax_id' => :'echeck_customer_tax_id',
    :'echeck_drivers_license_dob' => :'echeck_drivers_license_dob',
    :'echeck_drivers_license_number' => :'echeck_drivers_license_number',
    :'echeck_drivers_license_state' => :'echeck_drivers_license_state',
    :'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',
    :'sales_rep_code' => :'sales_rep_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',
    :'storefront_host_name' => :'storefront_host_name',
    :'tax_county' => :'tax_county',
    :'tax_exempt' => :'tax_exempt',
    :'transaction' => :'transaction',
    :'treat_warnings_as_errors' => :'treat_warnings_as_errors',
    :'use_prior_payment_information_from_order_id' => :'use_prior_payment_information_from_order_id'
  }
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



1640
1641
1642
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 1640

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



522
523
524
525
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 522

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_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',
    :'echeck_bank_aba_code' => :'String',
    :'echeck_bank_account_name' => :'String',
    :'echeck_bank_account_number' => :'String',
    :'echeck_bank_account_type' => :'String',
    :'echeck_bank_name' => :'String',
    :'echeck_bank_owner_type' => :'String',
    :'echeck_customer_tax_id' => :'String',
    :'echeck_drivers_license_dob' => :'String',
    :'echeck_drivers_license_number' => :'String',
    :'echeck_drivers_license_state' => :'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',
    :'sales_rep_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',
    :'storefront_host_name' => :'String',
    :'tax_county' => :'String',
    :'tax_exempt' => :'Boolean',
    :'transaction' => :'ChannelPartnerOrderTransaction',
    :'treat_warnings_as_errors' => :'Boolean',
    :'use_prior_payment_information_from_order_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 1527

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 &&
      echeck_bank_aba_code == o.echeck_bank_aba_code &&
       == o. &&
       == o. &&
       == o. &&
      echeck_bank_name == o.echeck_bank_name &&
      echeck_bank_owner_type == o.echeck_bank_owner_type &&
      echeck_customer_tax_id == o.echeck_customer_tax_id &&
      echeck_drivers_license_dob == o.echeck_drivers_license_dob &&
      echeck_drivers_license_number == o.echeck_drivers_license_number &&
      echeck_drivers_license_state == o.echeck_drivers_license_state &&
      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 &&
      sales_rep_code == o.sales_rep_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 &&
      storefront_host_name == o.storefront_host_name &&
      tax_county == o.tax_county &&
      tax_exempt == o.tax_exempt &&
      transaction == o.transaction &&
      treat_warnings_as_errors == o.treat_warnings_as_errors &&
      use_prior_payment_information_from_order_id == o.use_prior_payment_information_from_order_id
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



1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 1671

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = UltracartClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 1742

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



1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 1647

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


1627
1628
1629
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 1627

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



1633
1634
1635
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 1633

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, echeck_bank_aba_code, , , , echeck_bank_name, echeck_bank_owner_type, echeck_customer_tax_id, echeck_drivers_license_dob, echeck_drivers_license_number, echeck_drivers_license_state, 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, sales_rep_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, storefront_host_name, tax_county, tax_exempt, transaction, treat_warnings_as_errors, use_prior_payment_information_from_order_id].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



923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
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
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 923

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



1718
1719
1720
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 1718

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



1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 1724

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



1712
1713
1714
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 1712

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



1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
 
# File 'lib/ultracart_api/models/channel_partner_order.rb', line 1078

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
   = EnumAttributeValidator.new('String', ["Checking", "Savings"])
  return false unless .valid?(@echeck_bank_account_type)
  echeck_bank_owner_type_validator = EnumAttributeValidator.new('String', ["Business", "Personal"])
  return false unless echeck_bank_owner_type_validator.valid?(@echeck_bank_owner_type)
  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", "eCheck", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Wire Transfer", "PayPal Fastlane"])
  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