ultracart_api 4.1.13 → 4.1.15

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 (54) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +23 -2
  3. data/docs/AffiliateApi.md +123 -167
  4. data/docs/AutoOrderApi.md +1250 -903
  5. data/docs/CartUpsellAfter.md +6 -2
  6. data/docs/ChannelPartnerApi.md +1678 -1121
  7. data/docs/ChargebackApi.md +297 -405
  8. data/docs/CheckoutApi.md +1622 -1424
  9. data/docs/ConversationApi.md +4820 -6315
  10. data/docs/ConversationVirtualAgentCapabilities.md +4 -0
  11. data/docs/CouponApi.md +1522 -1443
  12. data/docs/CustomReport.md +36 -0
  13. data/docs/CustomReportAccountConfig.md +34 -0
  14. data/docs/CustomReportAccountConfigResponse.md +26 -0
  15. data/docs/CustomReportExecutionParameter.md +22 -0
  16. data/docs/CustomReportExecutionRequest.md +18 -0
  17. data/docs/CustomReportParameter.md +28 -0
  18. data/docs/CustomReportParameterOption.md +20 -0
  19. data/docs/CustomReportQuery.md +28 -0
  20. data/docs/CustomReportResponse.md +26 -0
  21. data/docs/CustomReportTooltip.md +20 -0
  22. data/docs/CustomerApi.md +2570 -1845
  23. data/docs/DatawarehouseApi.md +933 -723
  24. data/docs/FulfillmentApi.md +567 -441
  25. data/docs/GiftCertificateApi.md +617 -598
  26. data/docs/IntegrationLogApi.md +290 -385
  27. data/docs/Item.md +1 -1
  28. data/docs/ItemApi.md +2174 -1746
  29. data/docs/OauthApi.md +203 -163
  30. data/docs/OrderApi.md +2883 -2177
  31. data/docs/SsoApi.md +223 -288
  32. data/docs/StorefrontApi.md +9692 -12967
  33. data/docs/TaxApi.md +1541 -2017
  34. data/docs/UserApi.md +606 -790
  35. data/docs/WebhookApi.md +787 -628
  36. data/docs/WorkflowApi.md +666 -879
  37. data/lib/ultracart_api/api/datawarehouse_api.rb +474 -0
  38. data/lib/ultracart_api/api/order_api.rb +131 -0
  39. data/lib/ultracart_api/models/cart_upsell_after.rb +25 -5
  40. data/lib/ultracart_api/models/conversation_virtual_agent_capabilities.rb +55 -1
  41. data/lib/ultracart_api/models/custom_report.rb +306 -0
  42. data/lib/ultracart_api/models/custom_report_account_config.rb +296 -0
  43. data/lib/ultracart_api/models/custom_report_account_config_response.rb +256 -0
  44. data/lib/ultracart_api/models/custom_report_execution_parameter.rb +237 -0
  45. data/lib/ultracart_api/models/custom_report_execution_request.rb +221 -0
  46. data/lib/ultracart_api/models/custom_report_parameter.rb +266 -0
  47. data/lib/ultracart_api/models/custom_report_parameter_option.rb +228 -0
  48. data/lib/ultracart_api/models/custom_report_query.rb +266 -0
  49. data/lib/ultracart_api/models/custom_report_response.rb +256 -0
  50. data/lib/ultracart_api/models/custom_report_tooltip.rb +228 -0
  51. data/lib/ultracart_api/models/item.rb +1 -1
  52. data/lib/ultracart_api/version.rb +1 -1
  53. data/lib/ultracart_api.rb +10 -0
  54. metadata +22 -2
@@ -32,6 +32,70 @@ module UltracartClient
32
32
  UltracartClient::DatawarehouseApi.new(api_client)
33
33
  end
34
34
 
35
+ # Delete a custom report
36
+ # Delete a custom report on the UltraCart account.
37
+ # @param custom_report_oid [Integer] The report oid to delete.
38
+ # @param [Hash] opts the optional parameters
39
+ # @return [nil]
40
+ def delete_custom_report(custom_report_oid, opts = {})
41
+ delete_custom_report_with_http_info(custom_report_oid, opts)
42
+ nil
43
+ end
44
+
45
+ # Delete a custom report
46
+ # Delete a custom report on the UltraCart account.
47
+ # @param custom_report_oid [Integer] The report oid to delete.
48
+ # @param [Hash] opts the optional parameters
49
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
50
+ def delete_custom_report_with_http_info(custom_report_oid, opts = {})
51
+ if @api_client.config.debugging
52
+ @api_client.config.logger.debug 'Calling API: DatawarehouseApi.delete_custom_report ...'
53
+ end
54
+ # verify the required parameter 'custom_report_oid' is set
55
+ if @api_client.config.client_side_validation && custom_report_oid.nil?
56
+ fail ArgumentError, "Missing the required parameter 'custom_report_oid' when calling DatawarehouseApi.delete_custom_report"
57
+ end
58
+ # resource path
59
+ local_var_path = '/datawarehouse/custom_reports/{custom_report_oid}'.sub('{' + 'custom_report_oid' + '}', CGI.escape(custom_report_oid.to_s))
60
+
61
+ # query parameters
62
+ query_params = opts[:query_params] || {}
63
+
64
+ # header parameters
65
+ header_params = opts[:header_params] || {}
66
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
67
+ # HTTP header 'Accept' (if needed)
68
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
69
+
70
+ # form parameters
71
+ form_params = opts[:form_params] || {}
72
+
73
+ # http body (model)
74
+ post_body = opts[:debug_body]
75
+
76
+ # return_type
77
+ return_type = opts[:debug_return_type]
78
+
79
+ # auth_names
80
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
81
+
82
+ new_options = opts.merge(
83
+ :operation => :"DatawarehouseApi.delete_custom_report",
84
+ :header_params => header_params,
85
+ :query_params => query_params,
86
+ :form_params => form_params,
87
+ :body => post_body,
88
+ :auth_names => auth_names,
89
+ :return_type => return_type
90
+ )
91
+
92
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
93
+ if @api_client.config.debugging
94
+ @api_client.config.logger.debug "API called: DatawarehouseApi#delete_custom_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
95
+ end
96
+ return data, status_code, headers
97
+ end
98
+
35
99
  # Delete a report
36
100
  # Delete a report on the UltraCart account.
37
101
  # @param report_oid [Integer] The report oid to delete.
@@ -165,6 +229,81 @@ module UltracartClient
165
229
  return data, status_code, headers
166
230
  end
167
231
 
232
+ # Execute a custom report
233
+ # Execute a custom report on the UltraCart account.
234
+ # @param custom_report_oid [Integer] The report oid to execute.
235
+ # @param execution_request [CustomReportExecutionRequest] Request to execute custom report
236
+ # @param [Hash] opts the optional parameters
237
+ # @return [CustomReportResponse]
238
+ def execute_custom_report(custom_report_oid, execution_request, opts = {})
239
+ data, _status_code, _headers = execute_custom_report_with_http_info(custom_report_oid, execution_request, opts)
240
+ data
241
+ end
242
+
243
+ # Execute a custom report
244
+ # Execute a custom report on the UltraCart account.
245
+ # @param custom_report_oid [Integer] The report oid to execute.
246
+ # @param execution_request [CustomReportExecutionRequest] Request to execute custom report
247
+ # @param [Hash] opts the optional parameters
248
+ # @return [Array<(CustomReportResponse, Integer, Hash)>] CustomReportResponse data, response status code and response headers
249
+ def execute_custom_report_with_http_info(custom_report_oid, execution_request, opts = {})
250
+ if @api_client.config.debugging
251
+ @api_client.config.logger.debug 'Calling API: DatawarehouseApi.execute_custom_report ...'
252
+ end
253
+ # verify the required parameter 'custom_report_oid' is set
254
+ if @api_client.config.client_side_validation && custom_report_oid.nil?
255
+ fail ArgumentError, "Missing the required parameter 'custom_report_oid' when calling DatawarehouseApi.execute_custom_report"
256
+ end
257
+ # verify the required parameter 'execution_request' is set
258
+ if @api_client.config.client_side_validation && execution_request.nil?
259
+ fail ArgumentError, "Missing the required parameter 'execution_request' when calling DatawarehouseApi.execute_custom_report"
260
+ end
261
+ # resource path
262
+ local_var_path = '/datawarehouse/custom_reports/{custom_report_oid}/execute'.sub('{' + 'custom_report_oid' + '}', CGI.escape(custom_report_oid.to_s))
263
+
264
+ # query parameters
265
+ query_params = opts[:query_params] || {}
266
+
267
+ # header parameters
268
+ header_params = opts[:header_params] || {}
269
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
270
+ # HTTP header 'Accept' (if needed)
271
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
272
+ # HTTP header 'Content-Type'
273
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
274
+ if !content_type.nil?
275
+ header_params['Content-Type'] = content_type
276
+ end
277
+
278
+ # form parameters
279
+ form_params = opts[:form_params] || {}
280
+
281
+ # http body (model)
282
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(execution_request)
283
+
284
+ # return_type
285
+ return_type = opts[:debug_return_type] || 'CustomReportResponse'
286
+
287
+ # auth_names
288
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
289
+
290
+ new_options = opts.merge(
291
+ :operation => :"DatawarehouseApi.execute_custom_report",
292
+ :header_params => header_params,
293
+ :query_params => query_params,
294
+ :form_params => form_params,
295
+ :body => post_body,
296
+ :auth_names => auth_names,
297
+ :return_type => return_type
298
+ )
299
+
300
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
301
+ if @api_client.config.debugging
302
+ @api_client.config.logger.debug "API called: DatawarehouseApi#execute_custom_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
303
+ end
304
+ return data, status_code, headers
305
+ end
306
+
168
307
  # Execute the report queries
169
308
  # Execute the report queries
170
309
  # @param query_request [ReportExecuteQueriesRequest] Query request
@@ -234,6 +373,128 @@ module UltracartClient
234
373
  return data, status_code, headers
235
374
  end
236
375
 
376
+ # Get a custom report
377
+ # Retrieve a custom report
378
+ # @param custom_report_oid [Integer]
379
+ # @param [Hash] opts the optional parameters
380
+ # @return [CustomReportResponse]
381
+ def get_custom_report(custom_report_oid, opts = {})
382
+ data, _status_code, _headers = get_custom_report_with_http_info(custom_report_oid, opts)
383
+ data
384
+ end
385
+
386
+ # Get a custom report
387
+ # Retrieve a custom report
388
+ # @param custom_report_oid [Integer]
389
+ # @param [Hash] opts the optional parameters
390
+ # @return [Array<(CustomReportResponse, Integer, Hash)>] CustomReportResponse data, response status code and response headers
391
+ def get_custom_report_with_http_info(custom_report_oid, opts = {})
392
+ if @api_client.config.debugging
393
+ @api_client.config.logger.debug 'Calling API: DatawarehouseApi.get_custom_report ...'
394
+ end
395
+ # verify the required parameter 'custom_report_oid' is set
396
+ if @api_client.config.client_side_validation && custom_report_oid.nil?
397
+ fail ArgumentError, "Missing the required parameter 'custom_report_oid' when calling DatawarehouseApi.get_custom_report"
398
+ end
399
+ # resource path
400
+ local_var_path = '/datawarehouse/custom_reports/{custom_report_oid}'.sub('{' + 'custom_report_oid' + '}', CGI.escape(custom_report_oid.to_s))
401
+
402
+ # query parameters
403
+ query_params = opts[:query_params] || {}
404
+
405
+ # header parameters
406
+ header_params = opts[:header_params] || {}
407
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
408
+ # HTTP header 'Accept' (if needed)
409
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
410
+
411
+ # form parameters
412
+ form_params = opts[:form_params] || {}
413
+
414
+ # http body (model)
415
+ post_body = opts[:debug_body]
416
+
417
+ # return_type
418
+ return_type = opts[:debug_return_type] || 'CustomReportResponse'
419
+
420
+ # auth_names
421
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
422
+
423
+ new_options = opts.merge(
424
+ :operation => :"DatawarehouseApi.get_custom_report",
425
+ :header_params => header_params,
426
+ :query_params => query_params,
427
+ :form_params => form_params,
428
+ :body => post_body,
429
+ :auth_names => auth_names,
430
+ :return_type => return_type
431
+ )
432
+
433
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
434
+ if @api_client.config.debugging
435
+ @api_client.config.logger.debug "API called: DatawarehouseApi#get_custom_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
436
+ end
437
+ return data, status_code, headers
438
+ end
439
+
440
+ # Get custom report account configuration
441
+ # Retrieve a custom report account configuration
442
+ # @param [Hash] opts the optional parameters
443
+ # @return [CustomReportAccountConfigResponse]
444
+ def get_custom_report_account_config(opts = {})
445
+ data, _status_code, _headers = get_custom_report_account_config_with_http_info(opts)
446
+ data
447
+ end
448
+
449
+ # Get custom report account configuration
450
+ # Retrieve a custom report account configuration
451
+ # @param [Hash] opts the optional parameters
452
+ # @return [Array<(CustomReportAccountConfigResponse, Integer, Hash)>] CustomReportAccountConfigResponse data, response status code and response headers
453
+ def get_custom_report_account_config_with_http_info(opts = {})
454
+ if @api_client.config.debugging
455
+ @api_client.config.logger.debug 'Calling API: DatawarehouseApi.get_custom_report_account_config ...'
456
+ end
457
+ # resource path
458
+ local_var_path = '/datawarehouse/custom_reports/account_config'
459
+
460
+ # query parameters
461
+ query_params = opts[:query_params] || {}
462
+
463
+ # header parameters
464
+ header_params = opts[:header_params] || {}
465
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
466
+ # HTTP header 'Accept' (if needed)
467
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
468
+
469
+ # form parameters
470
+ form_params = opts[:form_params] || {}
471
+
472
+ # http body (model)
473
+ post_body = opts[:debug_body]
474
+
475
+ # return_type
476
+ return_type = opts[:debug_return_type] || 'CustomReportAccountConfigResponse'
477
+
478
+ # auth_names
479
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
480
+
481
+ new_options = opts.merge(
482
+ :operation => :"DatawarehouseApi.get_custom_report_account_config",
483
+ :header_params => header_params,
484
+ :query_params => query_params,
485
+ :form_params => form_params,
486
+ :body => post_body,
487
+ :auth_names => auth_names,
488
+ :return_type => return_type
489
+ )
490
+
491
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
492
+ if @api_client.config.debugging
493
+ @api_client.config.logger.debug "API called: DatawarehouseApi#get_custom_report_account_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
494
+ end
495
+ return data, status_code, headers
496
+ end
497
+
237
498
  # Get a report
238
499
  # Retrieve a report
239
500
  # @param report_oid [Integer]
@@ -548,6 +809,75 @@ module UltracartClient
548
809
  return data, status_code, headers
549
810
  end
550
811
 
812
+ # Create a custom report
813
+ # Create a new custom report on the UltraCart account.
814
+ # @param report [CustomReport] Report to create
815
+ # @param [Hash] opts the optional parameters
816
+ # @return [CustomReportResponse]
817
+ def insert_custom_report(report, opts = {})
818
+ data, _status_code, _headers = insert_custom_report_with_http_info(report, opts)
819
+ data
820
+ end
821
+
822
+ # Create a custom report
823
+ # Create a new custom report on the UltraCart account.
824
+ # @param report [CustomReport] Report to create
825
+ # @param [Hash] opts the optional parameters
826
+ # @return [Array<(CustomReportResponse, Integer, Hash)>] CustomReportResponse data, response status code and response headers
827
+ def insert_custom_report_with_http_info(report, opts = {})
828
+ if @api_client.config.debugging
829
+ @api_client.config.logger.debug 'Calling API: DatawarehouseApi.insert_custom_report ...'
830
+ end
831
+ # verify the required parameter 'report' is set
832
+ if @api_client.config.client_side_validation && report.nil?
833
+ fail ArgumentError, "Missing the required parameter 'report' when calling DatawarehouseApi.insert_custom_report"
834
+ end
835
+ # resource path
836
+ local_var_path = '/datawarehouse/custom_reports'
837
+
838
+ # query parameters
839
+ query_params = opts[:query_params] || {}
840
+
841
+ # header parameters
842
+ header_params = opts[:header_params] || {}
843
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
844
+ # HTTP header 'Accept' (if needed)
845
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
846
+ # HTTP header 'Content-Type'
847
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
848
+ if !content_type.nil?
849
+ header_params['Content-Type'] = content_type
850
+ end
851
+
852
+ # form parameters
853
+ form_params = opts[:form_params] || {}
854
+
855
+ # http body (model)
856
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(report)
857
+
858
+ # return_type
859
+ return_type = opts[:debug_return_type] || 'CustomReportResponse'
860
+
861
+ # auth_names
862
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
863
+
864
+ new_options = opts.merge(
865
+ :operation => :"DatawarehouseApi.insert_custom_report",
866
+ :header_params => header_params,
867
+ :query_params => query_params,
868
+ :form_params => form_params,
869
+ :body => post_body,
870
+ :auth_names => auth_names,
871
+ :return_type => return_type
872
+ )
873
+
874
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
875
+ if @api_client.config.debugging
876
+ @api_client.config.logger.debug "API called: DatawarehouseApi#insert_custom_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
877
+ end
878
+ return data, status_code, headers
879
+ end
880
+
551
881
  # Create a report
552
882
  # Create a new report on the UltraCart account.
553
883
  # @param report [Report] Report to create
@@ -617,6 +947,150 @@ module UltracartClient
617
947
  return data, status_code, headers
618
948
  end
619
949
 
950
+ # Update a custom report
951
+ # Update a custom report on the UltraCart account.
952
+ # @param custom_report_oid [Integer] The report oid to custom update.
953
+ # @param report [CustomReport] Report to custom update
954
+ # @param [Hash] opts the optional parameters
955
+ # @return [CustomReportResponse]
956
+ def update_custom_report(custom_report_oid, report, opts = {})
957
+ data, _status_code, _headers = update_custom_report_with_http_info(custom_report_oid, report, opts)
958
+ data
959
+ end
960
+
961
+ # Update a custom report
962
+ # Update a custom report on the UltraCart account.
963
+ # @param custom_report_oid [Integer] The report oid to custom update.
964
+ # @param report [CustomReport] Report to custom update
965
+ # @param [Hash] opts the optional parameters
966
+ # @return [Array<(CustomReportResponse, Integer, Hash)>] CustomReportResponse data, response status code and response headers
967
+ def update_custom_report_with_http_info(custom_report_oid, report, opts = {})
968
+ if @api_client.config.debugging
969
+ @api_client.config.logger.debug 'Calling API: DatawarehouseApi.update_custom_report ...'
970
+ end
971
+ # verify the required parameter 'custom_report_oid' is set
972
+ if @api_client.config.client_side_validation && custom_report_oid.nil?
973
+ fail ArgumentError, "Missing the required parameter 'custom_report_oid' when calling DatawarehouseApi.update_custom_report"
974
+ end
975
+ # verify the required parameter 'report' is set
976
+ if @api_client.config.client_side_validation && report.nil?
977
+ fail ArgumentError, "Missing the required parameter 'report' when calling DatawarehouseApi.update_custom_report"
978
+ end
979
+ # resource path
980
+ local_var_path = '/datawarehouse/custom_reports/{custom_report_oid}'.sub('{' + 'custom_report_oid' + '}', CGI.escape(custom_report_oid.to_s))
981
+
982
+ # query parameters
983
+ query_params = opts[:query_params] || {}
984
+
985
+ # header parameters
986
+ header_params = opts[:header_params] || {}
987
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
988
+ # HTTP header 'Accept' (if needed)
989
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
990
+ # HTTP header 'Content-Type'
991
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
992
+ if !content_type.nil?
993
+ header_params['Content-Type'] = content_type
994
+ end
995
+
996
+ # form parameters
997
+ form_params = opts[:form_params] || {}
998
+
999
+ # http body (model)
1000
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(report)
1001
+
1002
+ # return_type
1003
+ return_type = opts[:debug_return_type] || 'CustomReportResponse'
1004
+
1005
+ # auth_names
1006
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1007
+
1008
+ new_options = opts.merge(
1009
+ :operation => :"DatawarehouseApi.update_custom_report",
1010
+ :header_params => header_params,
1011
+ :query_params => query_params,
1012
+ :form_params => form_params,
1013
+ :body => post_body,
1014
+ :auth_names => auth_names,
1015
+ :return_type => return_type
1016
+ )
1017
+
1018
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1019
+ if @api_client.config.debugging
1020
+ @api_client.config.logger.debug "API called: DatawarehouseApi#update_custom_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1021
+ end
1022
+ return data, status_code, headers
1023
+ end
1024
+
1025
+ # Update custom report account config
1026
+ # Update custom report account config.
1027
+ # @param account_config [CustomReportAccountConfig] Account config to update
1028
+ # @param [Hash] opts the optional parameters
1029
+ # @return [CustomReportAccountConfigResponse]
1030
+ def update_custom_report_account_config(account_config, opts = {})
1031
+ data, _status_code, _headers = update_custom_report_account_config_with_http_info(account_config, opts)
1032
+ data
1033
+ end
1034
+
1035
+ # Update custom report account config
1036
+ # Update custom report account config.
1037
+ # @param account_config [CustomReportAccountConfig] Account config to update
1038
+ # @param [Hash] opts the optional parameters
1039
+ # @return [Array<(CustomReportAccountConfigResponse, Integer, Hash)>] CustomReportAccountConfigResponse data, response status code and response headers
1040
+ def update_custom_report_account_config_with_http_info(account_config, opts = {})
1041
+ if @api_client.config.debugging
1042
+ @api_client.config.logger.debug 'Calling API: DatawarehouseApi.update_custom_report_account_config ...'
1043
+ end
1044
+ # verify the required parameter 'account_config' is set
1045
+ if @api_client.config.client_side_validation && account_config.nil?
1046
+ fail ArgumentError, "Missing the required parameter 'account_config' when calling DatawarehouseApi.update_custom_report_account_config"
1047
+ end
1048
+ # resource path
1049
+ local_var_path = '/datawarehouse/custom_reports/account_config'
1050
+
1051
+ # query parameters
1052
+ query_params = opts[:query_params] || {}
1053
+
1054
+ # header parameters
1055
+ header_params = opts[:header_params] || {}
1056
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1057
+ # HTTP header 'Accept' (if needed)
1058
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1059
+ # HTTP header 'Content-Type'
1060
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1061
+ if !content_type.nil?
1062
+ header_params['Content-Type'] = content_type
1063
+ end
1064
+
1065
+ # form parameters
1066
+ form_params = opts[:form_params] || {}
1067
+
1068
+ # http body (model)
1069
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(account_config)
1070
+
1071
+ # return_type
1072
+ return_type = opts[:debug_return_type] || 'CustomReportAccountConfigResponse'
1073
+
1074
+ # auth_names
1075
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1076
+
1077
+ new_options = opts.merge(
1078
+ :operation => :"DatawarehouseApi.update_custom_report_account_config",
1079
+ :header_params => header_params,
1080
+ :query_params => query_params,
1081
+ :form_params => form_params,
1082
+ :body => post_body,
1083
+ :auth_names => auth_names,
1084
+ :return_type => return_type
1085
+ )
1086
+
1087
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1088
+ if @api_client.config.debugging
1089
+ @api_client.config.logger.debug "API called: DatawarehouseApi#update_custom_report_account_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1090
+ end
1091
+ return data, status_code, headers
1092
+ end
1093
+
620
1094
  # Update a report
621
1095
  # Update a report on the UltraCart account.
622
1096
  # @param report_oid [Integer] The report oid to update.
@@ -102,6 +102,73 @@ module UltracartClient
102
102
  return data, status_code, headers
103
103
  end
104
104
 
105
+ # Set a refund block on an order
106
+ # Sets a refund block on an order to prevent a user from performing a refund. Commonly used when a chargeback has been received.
107
+ # @param order_id [String] The order id to block a refund on.
108
+ # @param [Hash] opts the optional parameters
109
+ # @option opts [String] :block_reason Block reason code (optional)
110
+ # @return [nil]
111
+ def block_refund_on_order(order_id, opts = {})
112
+ block_refund_on_order_with_http_info(order_id, opts)
113
+ nil
114
+ end
115
+
116
+ # Set a refund block on an order
117
+ # Sets a refund block on an order to prevent a user from performing a refund. Commonly used when a chargeback has been received.
118
+ # @param order_id [String] The order id to block a refund on.
119
+ # @param [Hash] opts the optional parameters
120
+ # @option opts [String] :block_reason Block reason code (optional)
121
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
122
+ def block_refund_on_order_with_http_info(order_id, opts = {})
123
+ if @api_client.config.debugging
124
+ @api_client.config.logger.debug 'Calling API: OrderApi.block_refund_on_order ...'
125
+ end
126
+ # verify the required parameter 'order_id' is set
127
+ if @api_client.config.client_side_validation && order_id.nil?
128
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.block_refund_on_order"
129
+ end
130
+ # resource path
131
+ local_var_path = '/order/orders/{order_id}/refund_block'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
132
+
133
+ # query parameters
134
+ query_params = opts[:query_params] || {}
135
+ query_params[:'block_reason'] = opts[:'block_reason'] if !opts[:'block_reason'].nil?
136
+
137
+ # header parameters
138
+ header_params = opts[:header_params] || {}
139
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
140
+ # HTTP header 'Accept' (if needed)
141
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
142
+
143
+ # form parameters
144
+ form_params = opts[:form_params] || {}
145
+
146
+ # http body (model)
147
+ post_body = opts[:debug_body]
148
+
149
+ # return_type
150
+ return_type = opts[:debug_return_type]
151
+
152
+ # auth_names
153
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
154
+
155
+ new_options = opts.merge(
156
+ :operation => :"OrderApi.block_refund_on_order",
157
+ :header_params => header_params,
158
+ :query_params => query_params,
159
+ :form_params => form_params,
160
+ :body => post_body,
161
+ :auth_names => auth_names,
162
+ :return_type => return_type
163
+ )
164
+
165
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
166
+ if @api_client.config.debugging
167
+ @api_client.config.logger.debug "API called: OrderApi#block_refund_on_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
168
+ end
169
+ return data, status_code, headers
170
+ end
171
+
105
172
  # Cancel an order
106
173
  # Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.
107
174
  # @param order_id [String] The order id to cancel.
@@ -1873,6 +1940,70 @@ module UltracartClient
1873
1940
  return data, status_code, headers
1874
1941
  end
1875
1942
 
1943
+ # Remove a refund block on an order
1944
+ # Removes a refund block on an order to prevent a user from performing a refund.
1945
+ # @param order_id [String] The order id to unblock a refund on.
1946
+ # @param [Hash] opts the optional parameters
1947
+ # @return [nil]
1948
+ def unblock_refund_on_order(order_id, opts = {})
1949
+ unblock_refund_on_order_with_http_info(order_id, opts)
1950
+ nil
1951
+ end
1952
+
1953
+ # Remove a refund block on an order
1954
+ # Removes a refund block on an order to prevent a user from performing a refund.
1955
+ # @param order_id [String] The order id to unblock a refund on.
1956
+ # @param [Hash] opts the optional parameters
1957
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1958
+ def unblock_refund_on_order_with_http_info(order_id, opts = {})
1959
+ if @api_client.config.debugging
1960
+ @api_client.config.logger.debug 'Calling API: OrderApi.unblock_refund_on_order ...'
1961
+ end
1962
+ # verify the required parameter 'order_id' is set
1963
+ if @api_client.config.client_side_validation && order_id.nil?
1964
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.unblock_refund_on_order"
1965
+ end
1966
+ # resource path
1967
+ local_var_path = '/order/orders/{order_id}/refund_unblock'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
1968
+
1969
+ # query parameters
1970
+ query_params = opts[:query_params] || {}
1971
+
1972
+ # header parameters
1973
+ header_params = opts[:header_params] || {}
1974
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1975
+ # HTTP header 'Accept' (if needed)
1976
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1977
+
1978
+ # form parameters
1979
+ form_params = opts[:form_params] || {}
1980
+
1981
+ # http body (model)
1982
+ post_body = opts[:debug_body]
1983
+
1984
+ # return_type
1985
+ return_type = opts[:debug_return_type]
1986
+
1987
+ # auth_names
1988
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1989
+
1990
+ new_options = opts.merge(
1991
+ :operation => :"OrderApi.unblock_refund_on_order",
1992
+ :header_params => header_params,
1993
+ :query_params => query_params,
1994
+ :form_params => form_params,
1995
+ :body => post_body,
1996
+ :auth_names => auth_names,
1997
+ :return_type => return_type
1998
+ )
1999
+
2000
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2001
+ if @api_client.config.debugging
2002
+ @api_client.config.logger.debug "API called: OrderApi#unblock_refund_on_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2003
+ end
2004
+ return data, status_code, headers
2005
+ end
2006
+
1876
2007
  # Update A/R Retry Configuration
1877
2008
  # Update A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
1878
2009
  # @param retry_config [AccountsReceivableRetryConfig] AccountsReceivableRetryConfig object