ultracart_api 4.1.19 → 4.1.21

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.
Files changed (36) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +18 -10
  3. data/docs/CustomDashboardSchedule.md +26 -0
  4. data/docs/{ChargebackDisputesResponse.md → CustomDashboardScheduleResponse.md} +4 -4
  5. data/docs/CustomDashboardSchedulesResponse.md +26 -0
  6. data/docs/CustomReport.md +2 -0
  7. data/docs/CustomReportAccountConfig.md +2 -0
  8. data/docs/CustomReportAnalysisRequest.md +20 -0
  9. data/docs/{ChargebackDisputeResponse.md → CustomReportAnalysisResponse.md} +4 -4
  10. data/docs/CustomReportChartPngUploadResponse.md +28 -0
  11. data/docs/DatawarehouseApi.md +329 -0
  12. data/docs/EmailCampaign.md +4 -0
  13. data/docs/ItemTag.md +1 -1
  14. data/docs/OrderApi.md +56 -0
  15. data/docs/ReplaceOrderItemIdRequest.md +24 -0
  16. data/lib/ultracart_api/api/datawarehouse_api.rb +429 -0
  17. data/lib/ultracart_api/api/order_api.rb +78 -0
  18. data/lib/ultracart_api/models/custom_dashboard_schedule.rb +258 -0
  19. data/lib/ultracart_api/models/{chargeback_disputes_response.rb → custom_dashboard_schedule_response.rb} +13 -15
  20. data/lib/ultracart_api/models/custom_dashboard_schedules_response.rb +259 -0
  21. data/lib/ultracart_api/models/custom_report.rb +10 -1
  22. data/lib/ultracart_api/models/custom_report_account_config.rb +10 -1
  23. data/lib/ultracart_api/models/custom_report_analysis_request.rb +228 -0
  24. data/lib/ultracart_api/models/{chargeback_dispute_response.rb → custom_report_analysis_response.rb} +13 -13
  25. data/lib/ultracart_api/models/custom_report_chart_png_upload_response.rb +265 -0
  26. data/lib/ultracart_api/models/email_campaign.rb +21 -1
  27. data/lib/ultracart_api/models/item_tag.rb +1 -1
  28. data/lib/ultracart_api/models/order_payment.rb +2 -2
  29. data/lib/ultracart_api/models/replace_order_item_id_request.rb +280 -0
  30. data/lib/ultracart_api/version.rb +1 -1
  31. data/lib/ultracart_api.rb +7 -4
  32. metadata +16 -10
  33. data/docs/ChargebackApi.md +0 -297
  34. data/docs/ChargebackDispute.md +0 -62
  35. data/lib/ultracart_api/api/chargeback_api.rb +0 -410
  36. data/lib/ultracart_api/models/chargeback_dispute.rb +0 -649
@@ -32,6 +32,81 @@ module UltracartClient
32
32
  UltracartClient::DatawarehouseApi.new(api_client)
33
33
  end
34
34
 
35
+ # Analyze a custom report
36
+ # Analyze a custom report on the UltraCart account.
37
+ # @param custom_report_oid [Integer] The report oid to analyze.
38
+ # @param analyze_request [CustomReportAnalysisRequest] Request to analyze custom report
39
+ # @param [Hash] opts the optional parameters
40
+ # @return [CustomReportAnalysisResponse]
41
+ def analyze_custom_report(custom_report_oid, analyze_request, opts = {})
42
+ data, _status_code, _headers = analyze_custom_report_with_http_info(custom_report_oid, analyze_request, opts)
43
+ data
44
+ end
45
+
46
+ # Analyze a custom report
47
+ # Analyze a custom report on the UltraCart account.
48
+ # @param custom_report_oid [Integer] The report oid to analyze.
49
+ # @param analyze_request [CustomReportAnalysisRequest] Request to analyze custom report
50
+ # @param [Hash] opts the optional parameters
51
+ # @return [Array<(CustomReportAnalysisResponse, Integer, Hash)>] CustomReportAnalysisResponse data, response status code and response headers
52
+ def analyze_custom_report_with_http_info(custom_report_oid, analyze_request, opts = {})
53
+ if @api_client.config.debugging
54
+ @api_client.config.logger.debug 'Calling API: DatawarehouseApi.analyze_custom_report ...'
55
+ end
56
+ # verify the required parameter 'custom_report_oid' is set
57
+ if @api_client.config.client_side_validation && custom_report_oid.nil?
58
+ fail ArgumentError, "Missing the required parameter 'custom_report_oid' when calling DatawarehouseApi.analyze_custom_report"
59
+ end
60
+ # verify the required parameter 'analyze_request' is set
61
+ if @api_client.config.client_side_validation && analyze_request.nil?
62
+ fail ArgumentError, "Missing the required parameter 'analyze_request' when calling DatawarehouseApi.analyze_custom_report"
63
+ end
64
+ # resource path
65
+ local_var_path = '/datawarehouse/custom_reports/{custom_report_oid}/analysis'.sub('{' + 'custom_report_oid' + '}', CGI.escape(custom_report_oid.to_s))
66
+
67
+ # query parameters
68
+ query_params = opts[:query_params] || {}
69
+
70
+ # header parameters
71
+ header_params = opts[:header_params] || {}
72
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
73
+ # HTTP header 'Accept' (if needed)
74
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
75
+ # HTTP header 'Content-Type'
76
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
77
+ if !content_type.nil?
78
+ header_params['Content-Type'] = content_type
79
+ end
80
+
81
+ # form parameters
82
+ form_params = opts[:form_params] || {}
83
+
84
+ # http body (model)
85
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(analyze_request)
86
+
87
+ # return_type
88
+ return_type = opts[:debug_return_type] || 'CustomReportAnalysisResponse'
89
+
90
+ # auth_names
91
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
92
+
93
+ new_options = opts.merge(
94
+ :operation => :"DatawarehouseApi.analyze_custom_report",
95
+ :header_params => header_params,
96
+ :query_params => query_params,
97
+ :form_params => form_params,
98
+ :body => post_body,
99
+ :auth_names => auth_names,
100
+ :return_type => return_type
101
+ )
102
+
103
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
104
+ if @api_client.config.debugging
105
+ @api_client.config.logger.debug "API called: DatawarehouseApi#analyze_custom_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
106
+ end
107
+ return data, status_code, headers
108
+ end
109
+
35
110
  # Delete a custom dashboard
36
111
  # Delete a custom dashboard on the UltraCart account.
37
112
  # @param custom_dashboard_oid [Integer] The dashboard oid to delete.
@@ -96,6 +171,76 @@ module UltracartClient
96
171
  return data, status_code, headers
97
172
  end
98
173
 
174
+ # Delete a custom dashboard schedule
175
+ # delete a custom dashboard schedule on the UltraCart account.
176
+ # @param custom_dashboard_schedule_oid [Integer] The dashboard schedule oid to delete.
177
+ # @param custom_dashboard_oid [Integer] The dashboard oid that owns the schedule.
178
+ # @param [Hash] opts the optional parameters
179
+ # @return [nil]
180
+ def delete_custom_dashboard_schedule(custom_dashboard_schedule_oid, custom_dashboard_oid, opts = {})
181
+ delete_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid, opts)
182
+ nil
183
+ end
184
+
185
+ # Delete a custom dashboard schedule
186
+ # delete a custom dashboard schedule on the UltraCart account.
187
+ # @param custom_dashboard_schedule_oid [Integer] The dashboard schedule oid to delete.
188
+ # @param custom_dashboard_oid [Integer] The dashboard oid that owns the schedule.
189
+ # @param [Hash] opts the optional parameters
190
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
191
+ def delete_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid, opts = {})
192
+ if @api_client.config.debugging
193
+ @api_client.config.logger.debug 'Calling API: DatawarehouseApi.delete_custom_dashboard_schedule ...'
194
+ end
195
+ # verify the required parameter 'custom_dashboard_schedule_oid' is set
196
+ if @api_client.config.client_side_validation && custom_dashboard_schedule_oid.nil?
197
+ fail ArgumentError, "Missing the required parameter 'custom_dashboard_schedule_oid' when calling DatawarehouseApi.delete_custom_dashboard_schedule"
198
+ end
199
+ # verify the required parameter 'custom_dashboard_oid' is set
200
+ if @api_client.config.client_side_validation && custom_dashboard_oid.nil?
201
+ fail ArgumentError, "Missing the required parameter 'custom_dashboard_oid' when calling DatawarehouseApi.delete_custom_dashboard_schedule"
202
+ end
203
+ # resource path
204
+ local_var_path = '/datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules/{custom_dashboard_schedule_oid}'.sub('{' + 'custom_dashboard_schedule_oid' + '}', CGI.escape(custom_dashboard_schedule_oid.to_s)).sub('{' + 'custom_dashboard_oid' + '}', CGI.escape(custom_dashboard_oid.to_s))
205
+
206
+ # query parameters
207
+ query_params = opts[:query_params] || {}
208
+
209
+ # header parameters
210
+ header_params = opts[:header_params] || {}
211
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
212
+ # HTTP header 'Accept' (if needed)
213
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
214
+
215
+ # form parameters
216
+ form_params = opts[:form_params] || {}
217
+
218
+ # http body (model)
219
+ post_body = opts[:debug_body]
220
+
221
+ # return_type
222
+ return_type = opts[:debug_return_type]
223
+
224
+ # auth_names
225
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
226
+
227
+ new_options = opts.merge(
228
+ :operation => :"DatawarehouseApi.delete_custom_dashboard_schedule",
229
+ :header_params => header_params,
230
+ :query_params => query_params,
231
+ :form_params => form_params,
232
+ :body => post_body,
233
+ :auth_names => auth_names,
234
+ :return_type => return_type
235
+ )
236
+
237
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
238
+ if @api_client.config.debugging
239
+ @api_client.config.logger.debug "API called: DatawarehouseApi#delete_custom_dashboard_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
240
+ end
241
+ return data, status_code, headers
242
+ end
243
+
99
244
  # Delete a custom report
100
245
  # Delete a custom report on the UltraCart account.
101
246
  # @param custom_report_oid [Integer] The report oid to delete.
@@ -570,6 +715,70 @@ module UltracartClient
570
715
  return data, status_code, headers
571
716
  end
572
717
 
718
+ # Get custom dashboards
719
+ # Retrieve a custom dashboards
720
+ # @param custom_dashboard_oid [Integer]
721
+ # @param [Hash] opts the optional parameters
722
+ # @return [CustomDashboardSchedulesResponse]
723
+ def get_custom_dashboard_schedules(custom_dashboard_oid, opts = {})
724
+ data, _status_code, _headers = get_custom_dashboard_schedules_with_http_info(custom_dashboard_oid, opts)
725
+ data
726
+ end
727
+
728
+ # Get custom dashboards
729
+ # Retrieve a custom dashboards
730
+ # @param custom_dashboard_oid [Integer]
731
+ # @param [Hash] opts the optional parameters
732
+ # @return [Array<(CustomDashboardSchedulesResponse, Integer, Hash)>] CustomDashboardSchedulesResponse data, response status code and response headers
733
+ def get_custom_dashboard_schedules_with_http_info(custom_dashboard_oid, opts = {})
734
+ if @api_client.config.debugging
735
+ @api_client.config.logger.debug 'Calling API: DatawarehouseApi.get_custom_dashboard_schedules ...'
736
+ end
737
+ # verify the required parameter 'custom_dashboard_oid' is set
738
+ if @api_client.config.client_side_validation && custom_dashboard_oid.nil?
739
+ fail ArgumentError, "Missing the required parameter 'custom_dashboard_oid' when calling DatawarehouseApi.get_custom_dashboard_schedules"
740
+ end
741
+ # resource path
742
+ local_var_path = '/datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules'.sub('{' + 'custom_dashboard_oid' + '}', CGI.escape(custom_dashboard_oid.to_s))
743
+
744
+ # query parameters
745
+ query_params = opts[:query_params] || {}
746
+
747
+ # header parameters
748
+ header_params = opts[:header_params] || {}
749
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
750
+ # HTTP header 'Accept' (if needed)
751
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
752
+
753
+ # form parameters
754
+ form_params = opts[:form_params] || {}
755
+
756
+ # http body (model)
757
+ post_body = opts[:debug_body]
758
+
759
+ # return_type
760
+ return_type = opts[:debug_return_type] || 'CustomDashboardSchedulesResponse'
761
+
762
+ # auth_names
763
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
764
+
765
+ new_options = opts.merge(
766
+ :operation => :"DatawarehouseApi.get_custom_dashboard_schedules",
767
+ :header_params => header_params,
768
+ :query_params => query_params,
769
+ :form_params => form_params,
770
+ :body => post_body,
771
+ :auth_names => auth_names,
772
+ :return_type => return_type
773
+ )
774
+
775
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
776
+ if @api_client.config.debugging
777
+ @api_client.config.logger.debug "API called: DatawarehouseApi#get_custom_dashboard_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
778
+ end
779
+ return data, status_code, headers
780
+ end
781
+
573
782
  # Get custom dashboards
574
783
  # Retrieve a custom dashboards
575
784
  # @param [Hash] opts the optional parameters
@@ -750,6 +959,70 @@ module UltracartClient
750
959
  return data, status_code, headers
751
960
  end
752
961
 
962
+ # Upload a PNG of a custom report chart
963
+ # Upload a PNG of a custom report chart
964
+ # @param custom_report_oid [Integer] The report oid to upload a chart PNG for.
965
+ # @param [Hash] opts the optional parameters
966
+ # @return [CustomReportChartPngUploadResponse]
967
+ def get_custom_report_chart_png_upload_url(custom_report_oid, opts = {})
968
+ data, _status_code, _headers = get_custom_report_chart_png_upload_url_with_http_info(custom_report_oid, opts)
969
+ data
970
+ end
971
+
972
+ # Upload a PNG of a custom report chart
973
+ # Upload a PNG of a custom report chart
974
+ # @param custom_report_oid [Integer] The report oid to upload a chart PNG for.
975
+ # @param [Hash] opts the optional parameters
976
+ # @return [Array<(CustomReportChartPngUploadResponse, Integer, Hash)>] CustomReportChartPngUploadResponse data, response status code and response headers
977
+ def get_custom_report_chart_png_upload_url_with_http_info(custom_report_oid, opts = {})
978
+ if @api_client.config.debugging
979
+ @api_client.config.logger.debug 'Calling API: DatawarehouseApi.get_custom_report_chart_png_upload_url ...'
980
+ end
981
+ # verify the required parameter 'custom_report_oid' is set
982
+ if @api_client.config.client_side_validation && custom_report_oid.nil?
983
+ fail ArgumentError, "Missing the required parameter 'custom_report_oid' when calling DatawarehouseApi.get_custom_report_chart_png_upload_url"
984
+ end
985
+ # resource path
986
+ local_var_path = '/datawarehouse/custom_reports/{custom_report_oid}/chart_png'.sub('{' + 'custom_report_oid' + '}', CGI.escape(custom_report_oid.to_s))
987
+
988
+ # query parameters
989
+ query_params = opts[:query_params] || {}
990
+
991
+ # header parameters
992
+ header_params = opts[:header_params] || {}
993
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
994
+ # HTTP header 'Accept' (if needed)
995
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
996
+
997
+ # form parameters
998
+ form_params = opts[:form_params] || {}
999
+
1000
+ # http body (model)
1001
+ post_body = opts[:debug_body]
1002
+
1003
+ # return_type
1004
+ return_type = opts[:debug_return_type] || 'CustomReportChartPngUploadResponse'
1005
+
1006
+ # auth_names
1007
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1008
+
1009
+ new_options = opts.merge(
1010
+ :operation => :"DatawarehouseApi.get_custom_report_chart_png_upload_url",
1011
+ :header_params => header_params,
1012
+ :query_params => query_params,
1013
+ :form_params => form_params,
1014
+ :body => post_body,
1015
+ :auth_names => auth_names,
1016
+ :return_type => return_type
1017
+ )
1018
+
1019
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1020
+ if @api_client.config.debugging
1021
+ @api_client.config.logger.debug "API called: DatawarehouseApi#get_custom_report_chart_png_upload_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1022
+ end
1023
+ return data, status_code, headers
1024
+ end
1025
+
753
1026
  # Get custom reports
754
1027
  # Retrieve a custom reports
755
1028
  # @param [Hash] opts the optional parameters
@@ -1191,6 +1464,81 @@ module UltracartClient
1191
1464
  return data, status_code, headers
1192
1465
  end
1193
1466
 
1467
+ # Create a custom dashboard schedule
1468
+ # Create a new custom dashboard schedule on the UltraCart account.
1469
+ # @param custom_dashboard_oid [Integer]
1470
+ # @param dashboard_schedule [CustomDashboardSchedule] Dashboard schedule to create
1471
+ # @param [Hash] opts the optional parameters
1472
+ # @return [CustomDashboardScheduleResponse]
1473
+ def insert_custom_dashboard_schedule(custom_dashboard_oid, dashboard_schedule, opts = {})
1474
+ data, _status_code, _headers = insert_custom_dashboard_schedule_with_http_info(custom_dashboard_oid, dashboard_schedule, opts)
1475
+ data
1476
+ end
1477
+
1478
+ # Create a custom dashboard schedule
1479
+ # Create a new custom dashboard schedule on the UltraCart account.
1480
+ # @param custom_dashboard_oid [Integer]
1481
+ # @param dashboard_schedule [CustomDashboardSchedule] Dashboard schedule to create
1482
+ # @param [Hash] opts the optional parameters
1483
+ # @return [Array<(CustomDashboardScheduleResponse, Integer, Hash)>] CustomDashboardScheduleResponse data, response status code and response headers
1484
+ def insert_custom_dashboard_schedule_with_http_info(custom_dashboard_oid, dashboard_schedule, opts = {})
1485
+ if @api_client.config.debugging
1486
+ @api_client.config.logger.debug 'Calling API: DatawarehouseApi.insert_custom_dashboard_schedule ...'
1487
+ end
1488
+ # verify the required parameter 'custom_dashboard_oid' is set
1489
+ if @api_client.config.client_side_validation && custom_dashboard_oid.nil?
1490
+ fail ArgumentError, "Missing the required parameter 'custom_dashboard_oid' when calling DatawarehouseApi.insert_custom_dashboard_schedule"
1491
+ end
1492
+ # verify the required parameter 'dashboard_schedule' is set
1493
+ if @api_client.config.client_side_validation && dashboard_schedule.nil?
1494
+ fail ArgumentError, "Missing the required parameter 'dashboard_schedule' when calling DatawarehouseApi.insert_custom_dashboard_schedule"
1495
+ end
1496
+ # resource path
1497
+ local_var_path = '/datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules'.sub('{' + 'custom_dashboard_oid' + '}', CGI.escape(custom_dashboard_oid.to_s))
1498
+
1499
+ # query parameters
1500
+ query_params = opts[:query_params] || {}
1501
+
1502
+ # header parameters
1503
+ header_params = opts[:header_params] || {}
1504
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1505
+ # HTTP header 'Accept' (if needed)
1506
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1507
+ # HTTP header 'Content-Type'
1508
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1509
+ if !content_type.nil?
1510
+ header_params['Content-Type'] = content_type
1511
+ end
1512
+
1513
+ # form parameters
1514
+ form_params = opts[:form_params] || {}
1515
+
1516
+ # http body (model)
1517
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(dashboard_schedule)
1518
+
1519
+ # return_type
1520
+ return_type = opts[:debug_return_type] || 'CustomDashboardScheduleResponse'
1521
+
1522
+ # auth_names
1523
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1524
+
1525
+ new_options = opts.merge(
1526
+ :operation => :"DatawarehouseApi.insert_custom_dashboard_schedule",
1527
+ :header_params => header_params,
1528
+ :query_params => query_params,
1529
+ :form_params => form_params,
1530
+ :body => post_body,
1531
+ :auth_names => auth_names,
1532
+ :return_type => return_type
1533
+ )
1534
+
1535
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1536
+ if @api_client.config.debugging
1537
+ @api_client.config.logger.debug "API called: DatawarehouseApi#insert_custom_dashboard_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1538
+ end
1539
+ return data, status_code, headers
1540
+ end
1541
+
1194
1542
  # Create a custom report
1195
1543
  # Create a new custom report on the UltraCart account.
1196
1544
  # @param report [CustomReport] Report to create
@@ -1404,6 +1752,87 @@ module UltracartClient
1404
1752
  return data, status_code, headers
1405
1753
  end
1406
1754
 
1755
+ # Update a custom dashboard schedule
1756
+ # Update a custom dashboard schedule on the UltraCart account.
1757
+ # @param custom_dashboard_schedule_oid [Integer] The dashboard schedule oid to update.
1758
+ # @param custom_dashboard_oid [Integer] The dashboard oid to update.
1759
+ # @param dashboard_schedule [CustomDashboardSchedule] Dashboard schedule to update
1760
+ # @param [Hash] opts the optional parameters
1761
+ # @return [CustomDashboardResponse]
1762
+ def update_custom_dashboard_schedule(custom_dashboard_schedule_oid, custom_dashboard_oid, dashboard_schedule, opts = {})
1763
+ data, _status_code, _headers = update_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid, dashboard_schedule, opts)
1764
+ data
1765
+ end
1766
+
1767
+ # Update a custom dashboard schedule
1768
+ # Update a custom dashboard schedule on the UltraCart account.
1769
+ # @param custom_dashboard_schedule_oid [Integer] The dashboard schedule oid to update.
1770
+ # @param custom_dashboard_oid [Integer] The dashboard oid to update.
1771
+ # @param dashboard_schedule [CustomDashboardSchedule] Dashboard schedule to update
1772
+ # @param [Hash] opts the optional parameters
1773
+ # @return [Array<(CustomDashboardResponse, Integer, Hash)>] CustomDashboardResponse data, response status code and response headers
1774
+ def update_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid, dashboard_schedule, opts = {})
1775
+ if @api_client.config.debugging
1776
+ @api_client.config.logger.debug 'Calling API: DatawarehouseApi.update_custom_dashboard_schedule ...'
1777
+ end
1778
+ # verify the required parameter 'custom_dashboard_schedule_oid' is set
1779
+ if @api_client.config.client_side_validation && custom_dashboard_schedule_oid.nil?
1780
+ fail ArgumentError, "Missing the required parameter 'custom_dashboard_schedule_oid' when calling DatawarehouseApi.update_custom_dashboard_schedule"
1781
+ end
1782
+ # verify the required parameter 'custom_dashboard_oid' is set
1783
+ if @api_client.config.client_side_validation && custom_dashboard_oid.nil?
1784
+ fail ArgumentError, "Missing the required parameter 'custom_dashboard_oid' when calling DatawarehouseApi.update_custom_dashboard_schedule"
1785
+ end
1786
+ # verify the required parameter 'dashboard_schedule' is set
1787
+ if @api_client.config.client_side_validation && dashboard_schedule.nil?
1788
+ fail ArgumentError, "Missing the required parameter 'dashboard_schedule' when calling DatawarehouseApi.update_custom_dashboard_schedule"
1789
+ end
1790
+ # resource path
1791
+ local_var_path = '/datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules/{custom_dashboard_schedule_oid}'.sub('{' + 'custom_dashboard_schedule_oid' + '}', CGI.escape(custom_dashboard_schedule_oid.to_s)).sub('{' + 'custom_dashboard_oid' + '}', CGI.escape(custom_dashboard_oid.to_s))
1792
+
1793
+ # query parameters
1794
+ query_params = opts[:query_params] || {}
1795
+
1796
+ # header parameters
1797
+ header_params = opts[:header_params] || {}
1798
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1799
+ # HTTP header 'Accept' (if needed)
1800
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1801
+ # HTTP header 'Content-Type'
1802
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1803
+ if !content_type.nil?
1804
+ header_params['Content-Type'] = content_type
1805
+ end
1806
+
1807
+ # form parameters
1808
+ form_params = opts[:form_params] || {}
1809
+
1810
+ # http body (model)
1811
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(dashboard_schedule)
1812
+
1813
+ # return_type
1814
+ return_type = opts[:debug_return_type] || 'CustomDashboardResponse'
1815
+
1816
+ # auth_names
1817
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1818
+
1819
+ new_options = opts.merge(
1820
+ :operation => :"DatawarehouseApi.update_custom_dashboard_schedule",
1821
+ :header_params => header_params,
1822
+ :query_params => query_params,
1823
+ :form_params => form_params,
1824
+ :body => post_body,
1825
+ :auth_names => auth_names,
1826
+ :return_type => return_type
1827
+ )
1828
+
1829
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1830
+ if @api_client.config.debugging
1831
+ @api_client.config.logger.debug "API called: DatawarehouseApi#update_custom_dashboard_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1832
+ end
1833
+ return data, status_code, headers
1834
+ end
1835
+
1407
1836
  # Update a custom report
1408
1837
  # Update a custom report on the UltraCart account.
1409
1838
  # @param custom_report_oid [Integer] The report oid to custom update.
@@ -1646,6 +1646,84 @@ module UltracartClient
1646
1646
  return data, status_code, headers
1647
1647
  end
1648
1648
 
1649
+ # Replaces an order item id
1650
+ # Replaces a single order item id with another merchant_item_id, leaving all other attributes and properties unchanged. A custom method requested by a merchant to allow for item id updates due to shipping errors. It is doubtful you will ever need this method. The expansion variable affects the returned order object.
1651
+ # @param order_id [String] The order id to update.
1652
+ # @param replace_order_item_id_request [ReplaceOrderItemIdRequest] Replacement Request
1653
+ # @param [Hash] opts the optional parameters
1654
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1655
+ # @return [OrderResponse]
1656
+ def replace_order_item_merchant_item_id(order_id, replace_order_item_id_request, opts = {})
1657
+ data, _status_code, _headers = replace_order_item_merchant_item_id_with_http_info(order_id, replace_order_item_id_request, opts)
1658
+ data
1659
+ end
1660
+
1661
+ # Replaces an order item id
1662
+ # Replaces a single order item id with another merchant_item_id, leaving all other attributes and properties unchanged. A custom method requested by a merchant to allow for item id updates due to shipping errors. It is doubtful you will ever need this method. The expansion variable affects the returned order object.
1663
+ # @param order_id [String] The order id to update.
1664
+ # @param replace_order_item_id_request [ReplaceOrderItemIdRequest] Replacement Request
1665
+ # @param [Hash] opts the optional parameters
1666
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1667
+ # @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
1668
+ def replace_order_item_merchant_item_id_with_http_info(order_id, replace_order_item_id_request, opts = {})
1669
+ if @api_client.config.debugging
1670
+ @api_client.config.logger.debug 'Calling API: OrderApi.replace_order_item_merchant_item_id ...'
1671
+ end
1672
+ # verify the required parameter 'order_id' is set
1673
+ if @api_client.config.client_side_validation && order_id.nil?
1674
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.replace_order_item_merchant_item_id"
1675
+ end
1676
+ # verify the required parameter 'replace_order_item_id_request' is set
1677
+ if @api_client.config.client_side_validation && replace_order_item_id_request.nil?
1678
+ fail ArgumentError, "Missing the required parameter 'replace_order_item_id_request' when calling OrderApi.replace_order_item_merchant_item_id"
1679
+ end
1680
+ # resource path
1681
+ local_var_path = '/order/orders/{order_id}/replace_item_id'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
1682
+
1683
+ # query parameters
1684
+ query_params = opts[:query_params] || {}
1685
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1686
+
1687
+ # header parameters
1688
+ header_params = opts[:header_params] || {}
1689
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1690
+ # HTTP header 'Accept' (if needed)
1691
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1692
+ # HTTP header 'Content-Type'
1693
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1694
+ if !content_type.nil?
1695
+ header_params['Content-Type'] = content_type
1696
+ end
1697
+
1698
+ # form parameters
1699
+ form_params = opts[:form_params] || {}
1700
+
1701
+ # http body (model)
1702
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(replace_order_item_id_request)
1703
+
1704
+ # return_type
1705
+ return_type = opts[:debug_return_type] || 'OrderResponse'
1706
+
1707
+ # auth_names
1708
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1709
+
1710
+ new_options = opts.merge(
1711
+ :operation => :"OrderApi.replace_order_item_merchant_item_id",
1712
+ :header_params => header_params,
1713
+ :query_params => query_params,
1714
+ :form_params => form_params,
1715
+ :body => post_body,
1716
+ :auth_names => auth_names,
1717
+ :return_type => return_type
1718
+ )
1719
+
1720
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1721
+ if @api_client.config.debugging
1722
+ @api_client.config.logger.debug "API called: OrderApi#replace_order_item_merchant_item_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1723
+ end
1724
+ return data, status_code, headers
1725
+ end
1726
+
1649
1727
  # Replacement order
1650
1728
  # Create a replacement order based upon a previous order
1651
1729
  # @param order_id [String] The order id to generate a replacement for.