ultracart_api 4.0.238 → 4.0.241

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -368,6 +368,140 @@ module UltracartClient
368
368
  return data, status_code, headers
369
369
  end
370
370
 
371
+ # Retrieve a channel partner order
372
+ # Retrieves a single order using the specified order id. Only orders belonging to this channel partner may be retrieved.
373
+ # @param order_id [String] The order id to retrieve.
374
+ # @param [Hash] opts the optional parameters
375
+ # @option opts [String] :_expand The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
376
+ # @return [OrderResponse]
377
+ def get_channel_partner_order(order_id, opts = {})
378
+ data, _status_code, _headers = get_channel_partner_order_with_http_info(order_id, opts)
379
+ data
380
+ end
381
+
382
+ # Retrieve a channel partner order
383
+ # Retrieves a single order using the specified order id. Only orders belonging to this channel partner may be retrieved.
384
+ # @param order_id [String] The order id to retrieve.
385
+ # @param [Hash] opts the optional parameters
386
+ # @option opts [String] :_expand The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
387
+ # @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
388
+ def get_channel_partner_order_with_http_info(order_id, opts = {})
389
+ if @api_client.config.debugging
390
+ @api_client.config.logger.debug 'Calling API: ChannelPartnerApi.get_channel_partner_order ...'
391
+ end
392
+ # verify the required parameter 'order_id' is set
393
+ if @api_client.config.client_side_validation && order_id.nil?
394
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling ChannelPartnerApi.get_channel_partner_order"
395
+ end
396
+ # resource path
397
+ local_var_path = '/channel_partner/orders/{order_id}'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
398
+
399
+ # query parameters
400
+ query_params = opts[:query_params] || {}
401
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
402
+
403
+ # header parameters
404
+ header_params = opts[:header_params] || {}
405
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
406
+ # HTTP header 'Accept' (if needed)
407
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
408
+
409
+ # form parameters
410
+ form_params = opts[:form_params] || {}
411
+
412
+ # http body (model)
413
+ post_body = opts[:debug_body]
414
+
415
+ # return_type
416
+ return_type = opts[:debug_return_type] || 'OrderResponse'
417
+
418
+ # auth_names
419
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
420
+
421
+ new_options = opts.merge(
422
+ :operation => :"ChannelPartnerApi.get_channel_partner_order",
423
+ :header_params => header_params,
424
+ :query_params => query_params,
425
+ :form_params => form_params,
426
+ :body => post_body,
427
+ :auth_names => auth_names,
428
+ :return_type => return_type
429
+ )
430
+
431
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
432
+ if @api_client.config.debugging
433
+ @api_client.config.logger.debug "API called: ChannelPartnerApi#get_channel_partner_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
434
+ end
435
+ return data, status_code, headers
436
+ end
437
+
438
+ # Retrieve a channel partner order by the channel partner order id
439
+ # Retrieves a single order using the channel partner order id, not the ultracart order id. Only orders belonging to this channel partner may be retrieved.
440
+ # @param order_id [String] The channel partner order id to retrieve.
441
+ # @param [Hash] opts the optional parameters
442
+ # @option opts [String] :_expand The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
443
+ # @return [OrderResponse]
444
+ def get_channel_partner_order_by_channel_partner_order_id(order_id, opts = {})
445
+ data, _status_code, _headers = get_channel_partner_order_by_channel_partner_order_id_with_http_info(order_id, opts)
446
+ data
447
+ end
448
+
449
+ # Retrieve a channel partner order by the channel partner order id
450
+ # Retrieves a single order using the channel partner order id, not the ultracart order id. Only orders belonging to this channel partner may be retrieved.
451
+ # @param order_id [String] The channel partner order id to retrieve.
452
+ # @param [Hash] opts the optional parameters
453
+ # @option opts [String] :_expand The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
454
+ # @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
455
+ def get_channel_partner_order_by_channel_partner_order_id_with_http_info(order_id, opts = {})
456
+ if @api_client.config.debugging
457
+ @api_client.config.logger.debug 'Calling API: ChannelPartnerApi.get_channel_partner_order_by_channel_partner_order_id ...'
458
+ end
459
+ # verify the required parameter 'order_id' is set
460
+ if @api_client.config.client_side_validation && order_id.nil?
461
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling ChannelPartnerApi.get_channel_partner_order_by_channel_partner_order_id"
462
+ end
463
+ # resource path
464
+ local_var_path = '/channel_partner/orders/by_channel_partner_order_id/{order_id}'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
465
+
466
+ # query parameters
467
+ query_params = opts[:query_params] || {}
468
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
469
+
470
+ # header parameters
471
+ header_params = opts[:header_params] || {}
472
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
473
+ # HTTP header 'Accept' (if needed)
474
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
475
+
476
+ # form parameters
477
+ form_params = opts[:form_params] || {}
478
+
479
+ # http body (model)
480
+ post_body = opts[:debug_body]
481
+
482
+ # return_type
483
+ return_type = opts[:debug_return_type] || 'OrderResponse'
484
+
485
+ # auth_names
486
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
487
+
488
+ new_options = opts.merge(
489
+ :operation => :"ChannelPartnerApi.get_channel_partner_order_by_channel_partner_order_id",
490
+ :header_params => header_params,
491
+ :query_params => query_params,
492
+ :form_params => form_params,
493
+ :body => post_body,
494
+ :auth_names => auth_names,
495
+ :return_type => return_type
496
+ )
497
+
498
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
499
+ if @api_client.config.debugging
500
+ @api_client.config.logger.debug "API called: ChannelPartnerApi#get_channel_partner_order_by_channel_partner_order_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
501
+ end
502
+ return data, status_code, headers
503
+ end
504
+
371
505
  # Retrieve the ship to preference associated with the channel partner and the specific id.
372
506
  # Retrieve the ship to preference associated with the channel partner and the specific id.
373
507
  # @param channel_partner_oid [Integer]
@@ -704,6 +838,105 @@ module UltracartClient
704
838
  return data, status_code, headers
705
839
  end
706
840
 
841
+ # Refund a channel partner order
842
+ # Perform a refund operation on a channel partner order and then update the order if successful. All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded. UltraCart will calculate the actual amount to refund based upon the prior refunds.
843
+ # @param order_id [String] The order id to refund.
844
+ # @param order [Order] Order to refund
845
+ # @param [Hash] opts the optional parameters
846
+ # @option opts [Boolean] :reject_after_refund Reject order after refund (default to false)
847
+ # @option opts [Boolean] :skip_customer_notification Skip customer email notification (default to false)
848
+ # @option opts [Boolean] :auto_order_cancel Cancel associated auto orders (default to false)
849
+ # @option opts [Boolean] :manual_refund Consider a manual refund done externally (default to false)
850
+ # @option opts [Boolean] :reverse_affiliate_transactions Reverse affiliate transactions (default to true)
851
+ # @option opts [Boolean] :issue_store_credit Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account (default to false)
852
+ # @option opts [String] :auto_order_cancel_reason Reason for auto orders cancellation
853
+ # @option opts [String] :_expand The object expansion to perform on the result. See OrderApi.refundOrder documentation for examples
854
+ # @return [OrderResponse]
855
+ def refund_channel_partner_order(order_id, order, opts = {})
856
+ data, _status_code, _headers = refund_channel_partner_order_with_http_info(order_id, order, opts)
857
+ data
858
+ end
859
+
860
+ # Refund a channel partner order
861
+ # Perform a refund operation on a channel partner order and then update the order if successful. All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded. UltraCart will calculate the actual amount to refund based upon the prior refunds.
862
+ # @param order_id [String] The order id to refund.
863
+ # @param order [Order] Order to refund
864
+ # @param [Hash] opts the optional parameters
865
+ # @option opts [Boolean] :reject_after_refund Reject order after refund (default to false)
866
+ # @option opts [Boolean] :skip_customer_notification Skip customer email notification (default to false)
867
+ # @option opts [Boolean] :auto_order_cancel Cancel associated auto orders (default to false)
868
+ # @option opts [Boolean] :manual_refund Consider a manual refund done externally (default to false)
869
+ # @option opts [Boolean] :reverse_affiliate_transactions Reverse affiliate transactions (default to true)
870
+ # @option opts [Boolean] :issue_store_credit Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account (default to false)
871
+ # @option opts [String] :auto_order_cancel_reason Reason for auto orders cancellation
872
+ # @option opts [String] :_expand The object expansion to perform on the result. See OrderApi.refundOrder documentation for examples
873
+ # @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
874
+ def refund_channel_partner_order_with_http_info(order_id, order, opts = {})
875
+ if @api_client.config.debugging
876
+ @api_client.config.logger.debug 'Calling API: ChannelPartnerApi.refund_channel_partner_order ...'
877
+ end
878
+ # verify the required parameter 'order_id' is set
879
+ if @api_client.config.client_side_validation && order_id.nil?
880
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling ChannelPartnerApi.refund_channel_partner_order"
881
+ end
882
+ # verify the required parameter 'order' is set
883
+ if @api_client.config.client_side_validation && order.nil?
884
+ fail ArgumentError, "Missing the required parameter 'order' when calling ChannelPartnerApi.refund_channel_partner_order"
885
+ end
886
+ # resource path
887
+ local_var_path = '/channel_partner/orders/{order_id}/refund'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
888
+
889
+ # query parameters
890
+ query_params = opts[:query_params] || {}
891
+ query_params[:'reject_after_refund'] = opts[:'reject_after_refund'] if !opts[:'reject_after_refund'].nil?
892
+ query_params[:'skip_customer_notification'] = opts[:'skip_customer_notification'] if !opts[:'skip_customer_notification'].nil?
893
+ query_params[:'auto_order_cancel'] = opts[:'auto_order_cancel'] if !opts[:'auto_order_cancel'].nil?
894
+ query_params[:'manual_refund'] = opts[:'manual_refund'] if !opts[:'manual_refund'].nil?
895
+ query_params[:'reverse_affiliate_transactions'] = opts[:'reverse_affiliate_transactions'] if !opts[:'reverse_affiliate_transactions'].nil?
896
+ query_params[:'issue_store_credit'] = opts[:'issue_store_credit'] if !opts[:'issue_store_credit'].nil?
897
+ query_params[:'auto_order_cancel_reason'] = opts[:'auto_order_cancel_reason'] if !opts[:'auto_order_cancel_reason'].nil?
898
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
899
+
900
+ # header parameters
901
+ header_params = opts[:header_params] || {}
902
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
903
+ # HTTP header 'Accept' (if needed)
904
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
905
+ # HTTP header 'Content-Type'
906
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
907
+ if !content_type.nil?
908
+ header_params['Content-Type'] = content_type
909
+ end
910
+
911
+ # form parameters
912
+ form_params = opts[:form_params] || {}
913
+
914
+ # http body (model)
915
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(order)
916
+
917
+ # return_type
918
+ return_type = opts[:debug_return_type] || 'OrderResponse'
919
+
920
+ # auth_names
921
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
922
+
923
+ new_options = opts.merge(
924
+ :operation => :"ChannelPartnerApi.refund_channel_partner_order",
925
+ :header_params => header_params,
926
+ :query_params => query_params,
927
+ :form_params => form_params,
928
+ :body => post_body,
929
+ :auth_names => auth_names,
930
+ :return_type => return_type
931
+ )
932
+
933
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
934
+ if @api_client.config.debugging
935
+ @api_client.config.logger.debug "API called: ChannelPartnerApi#refund_channel_partner_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
936
+ end
937
+ return data, status_code, headers
938
+ end
939
+
707
940
  # Update a ship to preference record for the channel partner.
708
941
  # Update a ship to preference record for the channel partner.
709
942
  # @param channel_partner_oid [Integer]
@@ -276,6 +276,9 @@ module UltracartClient
276
276
  # 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
277
  attr_accessor :store_if_payment_declines
278
278
 
279
+ # StoreFront host name associated with the order
280
+ attr_accessor :storefront_host_name
281
+
279
282
  # The optional shipping county used to determine exact taxes
280
283
  attr_accessor :tax_county
281
284
 
@@ -399,6 +402,7 @@ module UltracartClient
399
402
  :'special_instructions' => :'special_instructions',
400
403
  :'store_completed' => :'store_completed',
401
404
  :'store_if_payment_declines' => :'store_if_payment_declines',
405
+ :'storefront_host_name' => :'storefront_host_name',
402
406
  :'tax_county' => :'tax_county',
403
407
  :'tax_exempt' => :'tax_exempt',
404
408
  :'transaction' => :'transaction',
@@ -501,6 +505,7 @@ module UltracartClient
501
505
  :'special_instructions' => :'String',
502
506
  :'store_completed' => :'Boolean',
503
507
  :'store_if_payment_declines' => :'Boolean',
508
+ :'storefront_host_name' => :'String',
504
509
  :'tax_county' => :'String',
505
510
  :'tax_exempt' => :'Boolean',
506
511
  :'transaction' => :'ChannelPartnerOrderTransaction',
@@ -883,6 +888,10 @@ module UltracartClient
883
888
  self.store_if_payment_declines = attributes[:'store_if_payment_declines']
884
889
  end
885
890
 
891
+ if attributes.key?(:'storefront_host_name')
892
+ self.storefront_host_name = attributes[:'storefront_host_name']
893
+ end
894
+
886
895
  if attributes.key?(:'tax_county')
887
896
  self.tax_county = attributes[:'tax_county']
888
897
  end
@@ -1596,6 +1605,7 @@ module UltracartClient
1596
1605
  special_instructions == o.special_instructions &&
1597
1606
  store_completed == o.store_completed &&
1598
1607
  store_if_payment_declines == o.store_if_payment_declines &&
1608
+ storefront_host_name == o.storefront_host_name &&
1599
1609
  tax_county == o.tax_county &&
1600
1610
  tax_exempt == o.tax_exempt &&
1601
1611
  transaction == o.transaction &&
@@ -1611,7 +1621,7 @@ module UltracartClient
1611
1621
  # Calculates hash code according to all attributes.
1612
1622
  # @return [Integer] Hash code
1613
1623
  def hash
1614
- [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_account_name, echeck_bank_account_number, echeck_bank_account_type, 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, tax_county, tax_exempt, transaction, treat_warnings_as_errors].hash
1624
+ [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_account_name, echeck_bank_account_number, echeck_bank_account_type, 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].hash
1615
1625
  end
1616
1626
 
1617
1627
  # Builds the object from hash
@@ -24,7 +24,7 @@ module UltracartClient
24
24
  # File name
25
25
  attr_accessor :file_name
26
26
 
27
- # Mime typoe
27
+ # Mime type
28
28
  attr_accessor :mime_type
29
29
 
30
30
  # Upload date/time
@@ -51,6 +51,9 @@ module UltracartClient
51
51
  # Email address of this customer profile
52
52
  attr_accessor :email
53
53
 
54
+ # Emails allows for searching on multiple email addresses and work with our without the single email variable. You may specify a single email address here or use the email property.
55
+ attr_accessor :emails
56
+
54
57
  # Last modified date end
55
58
  attr_accessor :last_modified_dts_end
56
59
 
@@ -117,6 +120,7 @@ module UltracartClient
117
120
  :'billing_postal_code' => :'billing_postal_code',
118
121
  :'billing_state' => :'billing_state',
119
122
  :'email' => :'email',
123
+ :'emails' => :'emails',
120
124
  :'last_modified_dts_end' => :'last_modified_dts_end',
121
125
  :'last_modified_dts_start' => :'last_modified_dts_start',
122
126
  :'pricing_tier_name' => :'pricing_tier_name',
@@ -157,6 +161,7 @@ module UltracartClient
157
161
  :'billing_postal_code' => :'String',
158
162
  :'billing_state' => :'String',
159
163
  :'email' => :'String',
164
+ :'emails' => :'Array<String>',
160
165
  :'last_modified_dts_end' => :'String',
161
166
  :'last_modified_dts_start' => :'String',
162
167
  :'pricing_tier_name' => :'String',
@@ -250,6 +255,12 @@ module UltracartClient
250
255
  self.email = attributes[:'email']
251
256
  end
252
257
 
258
+ if attributes.key?(:'emails')
259
+ if (value = attributes[:'emails']).is_a?(Array)
260
+ self.emails = value
261
+ end
262
+ end
263
+
253
264
  if attributes.key?(:'last_modified_dts_end')
254
265
  self.last_modified_dts_end = attributes[:'last_modified_dts_end']
255
266
  end
@@ -634,6 +645,7 @@ module UltracartClient
634
645
  billing_postal_code == o.billing_postal_code &&
635
646
  billing_state == o.billing_state &&
636
647
  email == o.email &&
648
+ emails == o.emails &&
637
649
  last_modified_dts_end == o.last_modified_dts_end &&
638
650
  last_modified_dts_start == o.last_modified_dts_start &&
639
651
  pricing_tier_name == o.pricing_tier_name &&
@@ -662,7 +674,7 @@ module UltracartClient
662
674
  # Calculates hash code according to all attributes.
663
675
  # @return [Integer] Hash code
664
676
  def hash
665
- [all_tags, any_tags, billing_city, billing_company, billing_country_code, billing_day_phone, billing_evening_phone, billing_first_name, billing_last_name, billing_postal_code, billing_state, email, last_modified_dts_end, last_modified_dts_start, pricing_tier_name, pricing_tier_oid, qb_class, quickbooks_code, shipping_city, shipping_company, shipping_country_code, shipping_day_phone, shipping_evening_phone, shipping_first_name, shipping_last_name, shipping_postal_code, shipping_state, signup_dts_end, signup_dts_start].hash
677
+ [all_tags, any_tags, billing_city, billing_company, billing_country_code, billing_day_phone, billing_evening_phone, billing_first_name, billing_last_name, billing_postal_code, billing_state, email, emails, last_modified_dts_end, last_modified_dts_start, pricing_tier_name, pricing_tier_oid, qb_class, quickbooks_code, shipping_city, shipping_company, shipping_country_code, shipping_day_phone, shipping_evening_phone, shipping_first_name, shipping_last_name, shipping_postal_code, shipping_state, signup_dts_end, signup_dts_start].hash
666
678
  end
667
679
 
668
680
  # Builds the object from hash
@@ -24,6 +24,9 @@ module UltracartClient
24
24
 
25
25
  attr_accessor :helpful_yes_votes
26
26
 
27
+ # Merchant Reply (set to an empty string to remove)
28
+ attr_accessor :merchant_reply
29
+
27
30
  attr_accessor :order_id
28
31
 
29
32
  attr_accessor :overall
@@ -137,6 +140,7 @@ module UltracartClient
137
140
  :'featured' => :'featured',
138
141
  :'helperful_no_votes' => :'helperful_no_votes',
139
142
  :'helpful_yes_votes' => :'helpful_yes_votes',
143
+ :'merchant_reply' => :'merchant_reply',
140
144
  :'order_id' => :'order_id',
141
145
  :'overall' => :'overall',
142
146
  :'rating_name1' => :'rating_name1',
@@ -185,6 +189,7 @@ module UltracartClient
185
189
  :'featured' => :'Boolean',
186
190
  :'helperful_no_votes' => :'Integer',
187
191
  :'helpful_yes_votes' => :'Integer',
192
+ :'merchant_reply' => :'String',
188
193
  :'order_id' => :'String',
189
194
  :'overall' => :'Float',
190
195
  :'rating_name1' => :'String',
@@ -258,6 +263,10 @@ module UltracartClient
258
263
  self.helpful_yes_votes = attributes[:'helpful_yes_votes']
259
264
  end
260
265
 
266
+ if attributes.key?(:'merchant_reply')
267
+ self.merchant_reply = attributes[:'merchant_reply']
268
+ end
269
+
261
270
  if attributes.key?(:'order_id')
262
271
  self.order_id = attributes[:'order_id']
263
272
  end
@@ -395,6 +404,10 @@ module UltracartClient
395
404
  # @return Array for valid properties with the reasons
396
405
  def list_invalid_properties
397
406
  invalid_properties = Array.new
407
+ if !@merchant_reply.nil? && @merchant_reply.to_s.length > 10000
408
+ invalid_properties.push('invalid value for "merchant_reply", the character length must be smaller than or equal to 10000.')
409
+ end
410
+
398
411
  if !@rating_name1.nil? && @rating_name1.to_s.length > 100
399
412
  invalid_properties.push('invalid value for "rating_name1", the character length must be smaller than or equal to 100.')
400
413
  end
@@ -465,6 +478,7 @@ module UltracartClient
465
478
  # Check to see if the all the properties in the model are valid
466
479
  # @return true if the model is valid
467
480
  def valid?
481
+ return false if !@merchant_reply.nil? && @merchant_reply.to_s.length > 10000
468
482
  return false if !@rating_name1.nil? && @rating_name1.to_s.length > 100
469
483
  return false if !@rating_name10.nil? && @rating_name10.to_s.length > 100
470
484
  return false if !@rating_name2.nil? && @rating_name2.to_s.length > 100
@@ -486,6 +500,16 @@ module UltracartClient
486
500
  true
487
501
  end
488
502
 
503
+ # Custom attribute writer method with validation
504
+ # @param [Object] merchant_reply Value to be assigned
505
+ def merchant_reply=(merchant_reply)
506
+ if !merchant_reply.nil? && merchant_reply.to_s.length > 10000
507
+ fail ArgumentError, 'invalid value for "merchant_reply", the character length must be smaller than or equal to 10000.'
508
+ end
509
+
510
+ @merchant_reply = merchant_reply
511
+ end
512
+
489
513
  # Custom attribute writer method with validation
490
514
  # @param [Object] rating_name1 Value to be assigned
491
515
  def rating_name1=(rating_name1)
@@ -665,6 +689,7 @@ module UltracartClient
665
689
  featured == o.featured &&
666
690
  helperful_no_votes == o.helperful_no_votes &&
667
691
  helpful_yes_votes == o.helpful_yes_votes &&
692
+ merchant_reply == o.merchant_reply &&
668
693
  order_id == o.order_id &&
669
694
  overall == o.overall &&
670
695
  rating_name1 == o.rating_name1 &&
@@ -709,7 +734,7 @@ module UltracartClient
709
734
  # Calculates hash code according to all attributes.
710
735
  # @return [Integer] Hash code
711
736
  def hash
712
- [customer_profile_oid, featured, helperful_no_votes, helpful_yes_votes, order_id, overall, rating_name1, rating_name10, rating_name2, rating_name3, rating_name4, rating_name5, rating_name6, rating_name7, rating_name8, rating_name9, rating_score1, rating_score10, rating_score2, rating_score3, rating_score4, rating_score5, rating_score6, rating_score7, rating_score8, rating_score9, recommend_store_to_friend, recommend_to_friend, review, review_oid, reviewed_nickname, reviewer_email, reviewer_location, status, store_feedback, submitted_dts, title].hash
737
+ [customer_profile_oid, featured, helperful_no_votes, helpful_yes_votes, merchant_reply, order_id, overall, rating_name1, rating_name10, rating_name2, rating_name3, rating_name4, rating_name5, rating_name6, rating_name7, rating_name8, rating_name9, rating_score1, rating_score10, rating_score2, rating_score3, rating_score4, rating_score5, rating_score6, rating_score7, rating_score8, rating_score9, recommend_store_to_friend, recommend_to_friend, review, review_oid, reviewed_nickname, reviewer_email, reviewer_location, status, store_feedback, submitted_dts, title].hash
713
738
  end
714
739
 
715
740
  # Builds the object from hash
@@ -40,6 +40,9 @@ module UltracartClient
40
40
  # Current stage that the order is in.
41
41
  attr_accessor :current_stage
42
42
 
43
+ # History of the changes to the current_stage field
44
+ attr_accessor :current_stage_histories
45
+
43
46
  attr_accessor :customer_profile
44
47
 
45
48
  attr_accessor :digital_order
@@ -143,6 +146,7 @@ module UltracartClient
143
146
  :'creation_dts' => :'creation_dts',
144
147
  :'currency_code' => :'currency_code',
145
148
  :'current_stage' => :'current_stage',
149
+ :'current_stage_histories' => :'current_stage_histories',
146
150
  :'customer_profile' => :'customer_profile',
147
151
  :'digital_order' => :'digital_order',
148
152
  :'edi' => :'edi',
@@ -192,6 +196,7 @@ module UltracartClient
192
196
  :'creation_dts' => :'String',
193
197
  :'currency_code' => :'String',
194
198
  :'current_stage' => :'String',
199
+ :'current_stage_histories' => :'Array<OrderCurrentStageHistory>',
195
200
  :'customer_profile' => :'Customer',
196
201
  :'digital_order' => :'OrderDigitalOrder',
197
202
  :'edi' => :'OrderEdi',
@@ -288,6 +293,12 @@ module UltracartClient
288
293
  self.current_stage = attributes[:'current_stage']
289
294
  end
290
295
 
296
+ if attributes.key?(:'current_stage_histories')
297
+ if (value = attributes[:'current_stage_histories']).is_a?(Array)
298
+ self.current_stage_histories = value
299
+ end
300
+ end
301
+
291
302
  if attributes.key?(:'customer_profile')
292
303
  self.customer_profile = attributes[:'customer_profile']
293
304
  end
@@ -479,6 +490,7 @@ module UltracartClient
479
490
  creation_dts == o.creation_dts &&
480
491
  currency_code == o.currency_code &&
481
492
  current_stage == o.current_stage &&
493
+ current_stage_histories == o.current_stage_histories &&
482
494
  customer_profile == o.customer_profile &&
483
495
  digital_order == o.digital_order &&
484
496
  edi == o.edi &&
@@ -518,7 +530,7 @@ module UltracartClient
518
530
  # Calculates hash code according to all attributes.
519
531
  # @return [Integer] Hash code
520
532
  def hash
521
- [affiliates, auto_order, billing, buysafe, channel_partner, checkout, coupons, creation_dts, currency_code, current_stage, customer_profile, digital_order, edi, exchange_rate, fraud_score, gift, gift_certificate, internal, items, language_iso_code, linked_shipment, marketing, merchant_id, order_id, payment, point_of_sale, properties, quote, refund_dts, refund_reason, reject_dts, reject_reason, salesforce, shipping, summary, tags, taxes, utms].hash
533
+ [affiliates, auto_order, billing, buysafe, channel_partner, checkout, coupons, creation_dts, currency_code, current_stage, current_stage_histories, customer_profile, digital_order, edi, exchange_rate, fraud_score, gift, gift_certificate, internal, items, language_iso_code, linked_shipment, marketing, merchant_id, order_id, payment, point_of_sale, properties, quote, refund_dts, refund_reason, reject_dts, reject_reason, salesforce, shipping, summary, tags, taxes, utms].hash
522
534
  end
523
535
 
524
536
  # Builds the object from hash