ultracart_api 4.1.15 → 4.1.17
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.
- checksums.yaml +4 -4
- data/README.md +25 -5
- data/docs/CustomDashboard.md +24 -0
- data/docs/CustomDashboardPage.md +22 -0
- data/docs/CustomDashboardPageReport.md +26 -0
- data/docs/CustomDashboardResponse.md +26 -0
- data/docs/CustomDashboardsResponse.md +26 -0
- data/docs/CustomReportExecutionResponse.md +32 -0
- data/docs/CustomReportsExecutionReportData.md +22 -0
- data/docs/CustomReportsExecutionRequest.md +20 -0
- data/docs/CustomReportsExecutionResponse.md +28 -0
- data/docs/CustomReportsResponse.md +26 -0
- data/docs/DatawarehouseApi.md +379 -4
- data/docs/EmailEditorValuesResponse.md +26 -0
- data/docs/OrderApi.md +32 -67
- data/docs/StorefrontApi.md +52 -0
- data/docs/WebhookApi.md +0 -8
- data/lib/ultracart_api/api/datawarehouse_api.rb +460 -3
- data/lib/ultracart_api/api/order_api.rb +2 -93
- data/lib/ultracart_api/api/storefront_api.rb +62 -0
- data/lib/ultracart_api/api/webhook_api.rb +0 -24
- data/lib/ultracart_api/models/custom_dashboard.rb +248 -0
- data/lib/ultracart_api/models/custom_dashboard_page.rb +239 -0
- data/lib/ultracart_api/models/custom_dashboard_page_report.rb +255 -0
- data/lib/ultracart_api/models/custom_dashboard_response.rb +256 -0
- data/lib/ultracart_api/models/custom_dashboards_response.rb +259 -0
- data/lib/ultracart_api/models/custom_report_execution_response.rb +285 -0
- data/lib/ultracart_api/models/custom_reports_execution_report_data.rb +237 -0
- data/lib/ultracart_api/models/custom_reports_execution_request.rb +232 -0
- data/lib/ultracart_api/models/custom_reports_execution_response.rb +269 -0
- data/lib/ultracart_api/models/custom_reports_response.rb +259 -0
- data/lib/ultracart_api/models/email_editor_values_response.rb +258 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +11 -0
- metadata +24 -2
data/docs/WebhookApi.md
CHANGED
@@ -310,14 +310,6 @@ end
|
|
310
310
|
| Name | Type | Description | Notes |
|
311
311
|
| ---- | ---- | ----------- | ----- |
|
312
312
|
| **webhook_oid** | **Integer** | The webhook oid to retrieve log summaries for. | |
|
313
|
-
| **request_id** | **String** | | [optional] |
|
314
|
-
| **begin_date** | **String** | | [optional] |
|
315
|
-
| **end_date** | **String** | | [optional] |
|
316
|
-
| **status** | **String** | | [optional] |
|
317
|
-
| **event** | **String** | | [optional] |
|
318
|
-
| **order_id** | **String** | | [optional] |
|
319
|
-
| **request** | **String** | | [optional] |
|
320
|
-
| **duration** | **Integer** | | [optional] |
|
321
313
|
| **_limit** | **Integer** | The maximum number of records to return on this one API call. | [optional][default to 100] |
|
322
314
|
| **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
|
323
315
|
| **_since** | **String** | Fetch log summaries that have been delivered since this date/time. | [optional] |
|
@@ -32,6 +32,70 @@ module UltracartClient
|
|
32
32
|
UltracartClient::DatawarehouseApi.new(api_client)
|
33
33
|
end
|
34
34
|
|
35
|
+
# Delete a custom dashboard
|
36
|
+
# Delete a custom dashboard on the UltraCart account.
|
37
|
+
# @param custom_dashboard_oid [Integer] The dashboard oid to delete.
|
38
|
+
# @param [Hash] opts the optional parameters
|
39
|
+
# @return [nil]
|
40
|
+
def delete_custom_dashboard(custom_dashboard_oid, opts = {})
|
41
|
+
delete_custom_dashboard_with_http_info(custom_dashboard_oid, opts)
|
42
|
+
nil
|
43
|
+
end
|
44
|
+
|
45
|
+
# Delete a custom dashboard
|
46
|
+
# Delete a custom dashboard on the UltraCart account.
|
47
|
+
# @param custom_dashboard_oid [Integer] The dashboard 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_dashboard_with_http_info(custom_dashboard_oid, opts = {})
|
51
|
+
if @api_client.config.debugging
|
52
|
+
@api_client.config.logger.debug 'Calling API: DatawarehouseApi.delete_custom_dashboard ...'
|
53
|
+
end
|
54
|
+
# verify the required parameter 'custom_dashboard_oid' is set
|
55
|
+
if @api_client.config.client_side_validation && custom_dashboard_oid.nil?
|
56
|
+
fail ArgumentError, "Missing the required parameter 'custom_dashboard_oid' when calling DatawarehouseApi.delete_custom_dashboard"
|
57
|
+
end
|
58
|
+
# resource path
|
59
|
+
local_var_path = '/datawarehouse/custom_dashboards/{custom_dashboard_oid}'.sub('{' + 'custom_dashboard_oid' + '}', CGI.escape(custom_dashboard_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_dashboard",
|
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_dashboard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
95
|
+
end
|
96
|
+
return data, status_code, headers
|
97
|
+
end
|
98
|
+
|
35
99
|
# Delete a custom report
|
36
100
|
# Delete a custom report on the UltraCart account.
|
37
101
|
# @param custom_report_oid [Integer] The report oid to delete.
|
@@ -234,7 +298,7 @@ module UltracartClient
|
|
234
298
|
# @param custom_report_oid [Integer] The report oid to execute.
|
235
299
|
# @param execution_request [CustomReportExecutionRequest] Request to execute custom report
|
236
300
|
# @param [Hash] opts the optional parameters
|
237
|
-
# @return [
|
301
|
+
# @return [CustomReportExecutionResponse]
|
238
302
|
def execute_custom_report(custom_report_oid, execution_request, opts = {})
|
239
303
|
data, _status_code, _headers = execute_custom_report_with_http_info(custom_report_oid, execution_request, opts)
|
240
304
|
data
|
@@ -245,7 +309,7 @@ module UltracartClient
|
|
245
309
|
# @param custom_report_oid [Integer] The report oid to execute.
|
246
310
|
# @param execution_request [CustomReportExecutionRequest] Request to execute custom report
|
247
311
|
# @param [Hash] opts the optional parameters
|
248
|
-
# @return [Array<(
|
312
|
+
# @return [Array<(CustomReportExecutionResponse, Integer, Hash)>] CustomReportExecutionResponse data, response status code and response headers
|
249
313
|
def execute_custom_report_with_http_info(custom_report_oid, execution_request, opts = {})
|
250
314
|
if @api_client.config.debugging
|
251
315
|
@api_client.config.logger.debug 'Calling API: DatawarehouseApi.execute_custom_report ...'
|
@@ -282,7 +346,7 @@ module UltracartClient
|
|
282
346
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(execution_request)
|
283
347
|
|
284
348
|
# return_type
|
285
|
-
return_type = opts[:debug_return_type] || '
|
349
|
+
return_type = opts[:debug_return_type] || 'CustomReportExecutionResponse'
|
286
350
|
|
287
351
|
# auth_names
|
288
352
|
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
@@ -304,6 +368,75 @@ module UltracartClient
|
|
304
368
|
return data, status_code, headers
|
305
369
|
end
|
306
370
|
|
371
|
+
# Execute a custom reports
|
372
|
+
# Execute a custom reports on the UltraCart account.
|
373
|
+
# @param execution_request [CustomReportsExecutionRequest] Request to execute custom reports
|
374
|
+
# @param [Hash] opts the optional parameters
|
375
|
+
# @return [CustomReportsExecutionResponse]
|
376
|
+
def execute_custom_reports(execution_request, opts = {})
|
377
|
+
data, _status_code, _headers = execute_custom_reports_with_http_info(execution_request, opts)
|
378
|
+
data
|
379
|
+
end
|
380
|
+
|
381
|
+
# Execute a custom reports
|
382
|
+
# Execute a custom reports on the UltraCart account.
|
383
|
+
# @param execution_request [CustomReportsExecutionRequest] Request to execute custom reports
|
384
|
+
# @param [Hash] opts the optional parameters
|
385
|
+
# @return [Array<(CustomReportsExecutionResponse, Integer, Hash)>] CustomReportsExecutionResponse data, response status code and response headers
|
386
|
+
def execute_custom_reports_with_http_info(execution_request, opts = {})
|
387
|
+
if @api_client.config.debugging
|
388
|
+
@api_client.config.logger.debug 'Calling API: DatawarehouseApi.execute_custom_reports ...'
|
389
|
+
end
|
390
|
+
# verify the required parameter 'execution_request' is set
|
391
|
+
if @api_client.config.client_side_validation && execution_request.nil?
|
392
|
+
fail ArgumentError, "Missing the required parameter 'execution_request' when calling DatawarehouseApi.execute_custom_reports"
|
393
|
+
end
|
394
|
+
# resource path
|
395
|
+
local_var_path = '/datawarehouse/custom_reports/execute'
|
396
|
+
|
397
|
+
# query parameters
|
398
|
+
query_params = opts[:query_params] || {}
|
399
|
+
|
400
|
+
# header parameters
|
401
|
+
header_params = opts[:header_params] || {}
|
402
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
403
|
+
# HTTP header 'Accept' (if needed)
|
404
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
405
|
+
# HTTP header 'Content-Type'
|
406
|
+
content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
407
|
+
if !content_type.nil?
|
408
|
+
header_params['Content-Type'] = content_type
|
409
|
+
end
|
410
|
+
|
411
|
+
# form parameters
|
412
|
+
form_params = opts[:form_params] || {}
|
413
|
+
|
414
|
+
# http body (model)
|
415
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(execution_request)
|
416
|
+
|
417
|
+
# return_type
|
418
|
+
return_type = opts[:debug_return_type] || 'CustomReportsExecutionResponse'
|
419
|
+
|
420
|
+
# auth_names
|
421
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
422
|
+
|
423
|
+
new_options = opts.merge(
|
424
|
+
:operation => :"DatawarehouseApi.execute_custom_reports",
|
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(:PUT, local_var_path, new_options)
|
434
|
+
if @api_client.config.debugging
|
435
|
+
@api_client.config.logger.debug "API called: DatawarehouseApi#execute_custom_reports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
436
|
+
end
|
437
|
+
return data, status_code, headers
|
438
|
+
end
|
439
|
+
|
307
440
|
# Execute the report queries
|
308
441
|
# Execute the report queries
|
309
442
|
# @param query_request [ReportExecuteQueriesRequest] Query request
|
@@ -373,6 +506,128 @@ module UltracartClient
|
|
373
506
|
return data, status_code, headers
|
374
507
|
end
|
375
508
|
|
509
|
+
# Get a custom dashboard
|
510
|
+
# Retrieve a custom dashboard
|
511
|
+
# @param custom_dashboard_oid [Integer]
|
512
|
+
# @param [Hash] opts the optional parameters
|
513
|
+
# @return [CustomDashboardResponse]
|
514
|
+
def get_custom_dashboard(custom_dashboard_oid, opts = {})
|
515
|
+
data, _status_code, _headers = get_custom_dashboard_with_http_info(custom_dashboard_oid, opts)
|
516
|
+
data
|
517
|
+
end
|
518
|
+
|
519
|
+
# Get a custom dashboard
|
520
|
+
# Retrieve a custom dashboard
|
521
|
+
# @param custom_dashboard_oid [Integer]
|
522
|
+
# @param [Hash] opts the optional parameters
|
523
|
+
# @return [Array<(CustomDashboardResponse, Integer, Hash)>] CustomDashboardResponse data, response status code and response headers
|
524
|
+
def get_custom_dashboard_with_http_info(custom_dashboard_oid, opts = {})
|
525
|
+
if @api_client.config.debugging
|
526
|
+
@api_client.config.logger.debug 'Calling API: DatawarehouseApi.get_custom_dashboard ...'
|
527
|
+
end
|
528
|
+
# verify the required parameter 'custom_dashboard_oid' is set
|
529
|
+
if @api_client.config.client_side_validation && custom_dashboard_oid.nil?
|
530
|
+
fail ArgumentError, "Missing the required parameter 'custom_dashboard_oid' when calling DatawarehouseApi.get_custom_dashboard"
|
531
|
+
end
|
532
|
+
# resource path
|
533
|
+
local_var_path = '/datawarehouse/custom_dashboards/{custom_dashboard_oid}'.sub('{' + 'custom_dashboard_oid' + '}', CGI.escape(custom_dashboard_oid.to_s))
|
534
|
+
|
535
|
+
# query parameters
|
536
|
+
query_params = opts[:query_params] || {}
|
537
|
+
|
538
|
+
# header parameters
|
539
|
+
header_params = opts[:header_params] || {}
|
540
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
541
|
+
# HTTP header 'Accept' (if needed)
|
542
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
543
|
+
|
544
|
+
# form parameters
|
545
|
+
form_params = opts[:form_params] || {}
|
546
|
+
|
547
|
+
# http body (model)
|
548
|
+
post_body = opts[:debug_body]
|
549
|
+
|
550
|
+
# return_type
|
551
|
+
return_type = opts[:debug_return_type] || 'CustomDashboardResponse'
|
552
|
+
|
553
|
+
# auth_names
|
554
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
555
|
+
|
556
|
+
new_options = opts.merge(
|
557
|
+
:operation => :"DatawarehouseApi.get_custom_dashboard",
|
558
|
+
:header_params => header_params,
|
559
|
+
:query_params => query_params,
|
560
|
+
:form_params => form_params,
|
561
|
+
:body => post_body,
|
562
|
+
:auth_names => auth_names,
|
563
|
+
:return_type => return_type
|
564
|
+
)
|
565
|
+
|
566
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
567
|
+
if @api_client.config.debugging
|
568
|
+
@api_client.config.logger.debug "API called: DatawarehouseApi#get_custom_dashboard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
569
|
+
end
|
570
|
+
return data, status_code, headers
|
571
|
+
end
|
572
|
+
|
573
|
+
# Get custom dashboards
|
574
|
+
# Retrieve a custom dashboards
|
575
|
+
# @param [Hash] opts the optional parameters
|
576
|
+
# @return [CustomDashboardsResponse]
|
577
|
+
def get_custom_dashboards(opts = {})
|
578
|
+
data, _status_code, _headers = get_custom_dashboards_with_http_info(opts)
|
579
|
+
data
|
580
|
+
end
|
581
|
+
|
582
|
+
# Get custom dashboards
|
583
|
+
# Retrieve a custom dashboards
|
584
|
+
# @param [Hash] opts the optional parameters
|
585
|
+
# @return [Array<(CustomDashboardsResponse, Integer, Hash)>] CustomDashboardsResponse data, response status code and response headers
|
586
|
+
def get_custom_dashboards_with_http_info(opts = {})
|
587
|
+
if @api_client.config.debugging
|
588
|
+
@api_client.config.logger.debug 'Calling API: DatawarehouseApi.get_custom_dashboards ...'
|
589
|
+
end
|
590
|
+
# resource path
|
591
|
+
local_var_path = '/datawarehouse/custom_dashboards'
|
592
|
+
|
593
|
+
# query parameters
|
594
|
+
query_params = opts[:query_params] || {}
|
595
|
+
|
596
|
+
# header parameters
|
597
|
+
header_params = opts[:header_params] || {}
|
598
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
599
|
+
# HTTP header 'Accept' (if needed)
|
600
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
601
|
+
|
602
|
+
# form parameters
|
603
|
+
form_params = opts[:form_params] || {}
|
604
|
+
|
605
|
+
# http body (model)
|
606
|
+
post_body = opts[:debug_body]
|
607
|
+
|
608
|
+
# return_type
|
609
|
+
return_type = opts[:debug_return_type] || 'CustomDashboardsResponse'
|
610
|
+
|
611
|
+
# auth_names
|
612
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
613
|
+
|
614
|
+
new_options = opts.merge(
|
615
|
+
:operation => :"DatawarehouseApi.get_custom_dashboards",
|
616
|
+
:header_params => header_params,
|
617
|
+
:query_params => query_params,
|
618
|
+
:form_params => form_params,
|
619
|
+
:body => post_body,
|
620
|
+
:auth_names => auth_names,
|
621
|
+
:return_type => return_type
|
622
|
+
)
|
623
|
+
|
624
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
625
|
+
if @api_client.config.debugging
|
626
|
+
@api_client.config.logger.debug "API called: DatawarehouseApi#get_custom_dashboards\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
627
|
+
end
|
628
|
+
return data, status_code, headers
|
629
|
+
end
|
630
|
+
|
376
631
|
# Get a custom report
|
377
632
|
# Retrieve a custom report
|
378
633
|
# @param custom_report_oid [Integer]
|
@@ -495,6 +750,64 @@ module UltracartClient
|
|
495
750
|
return data, status_code, headers
|
496
751
|
end
|
497
752
|
|
753
|
+
# Get custom reports
|
754
|
+
# Retrieve a custom reports
|
755
|
+
# @param [Hash] opts the optional parameters
|
756
|
+
# @return [CustomReportsResponse]
|
757
|
+
def get_custom_reports(opts = {})
|
758
|
+
data, _status_code, _headers = get_custom_reports_with_http_info(opts)
|
759
|
+
data
|
760
|
+
end
|
761
|
+
|
762
|
+
# Get custom reports
|
763
|
+
# Retrieve a custom reports
|
764
|
+
# @param [Hash] opts the optional parameters
|
765
|
+
# @return [Array<(CustomReportsResponse, Integer, Hash)>] CustomReportsResponse data, response status code and response headers
|
766
|
+
def get_custom_reports_with_http_info(opts = {})
|
767
|
+
if @api_client.config.debugging
|
768
|
+
@api_client.config.logger.debug 'Calling API: DatawarehouseApi.get_custom_reports ...'
|
769
|
+
end
|
770
|
+
# resource path
|
771
|
+
local_var_path = '/datawarehouse/custom_reports'
|
772
|
+
|
773
|
+
# query parameters
|
774
|
+
query_params = opts[:query_params] || {}
|
775
|
+
|
776
|
+
# header parameters
|
777
|
+
header_params = opts[:header_params] || {}
|
778
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
779
|
+
# HTTP header 'Accept' (if needed)
|
780
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
781
|
+
|
782
|
+
# form parameters
|
783
|
+
form_params = opts[:form_params] || {}
|
784
|
+
|
785
|
+
# http body (model)
|
786
|
+
post_body = opts[:debug_body]
|
787
|
+
|
788
|
+
# return_type
|
789
|
+
return_type = opts[:debug_return_type] || 'CustomReportsResponse'
|
790
|
+
|
791
|
+
# auth_names
|
792
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
793
|
+
|
794
|
+
new_options = opts.merge(
|
795
|
+
:operation => :"DatawarehouseApi.get_custom_reports",
|
796
|
+
:header_params => header_params,
|
797
|
+
:query_params => query_params,
|
798
|
+
:form_params => form_params,
|
799
|
+
:body => post_body,
|
800
|
+
:auth_names => auth_names,
|
801
|
+
:return_type => return_type
|
802
|
+
)
|
803
|
+
|
804
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
805
|
+
if @api_client.config.debugging
|
806
|
+
@api_client.config.logger.debug "API called: DatawarehouseApi#get_custom_reports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
807
|
+
end
|
808
|
+
return data, status_code, headers
|
809
|
+
end
|
810
|
+
|
498
811
|
# Get a report
|
499
812
|
# Retrieve a report
|
500
813
|
# @param report_oid [Integer]
|
@@ -809,6 +1122,75 @@ module UltracartClient
|
|
809
1122
|
return data, status_code, headers
|
810
1123
|
end
|
811
1124
|
|
1125
|
+
# Create a custom dashboard
|
1126
|
+
# Create a new custom dashboard on the UltraCart account.
|
1127
|
+
# @param dashboard [CustomDashboard] Dashboard to create
|
1128
|
+
# @param [Hash] opts the optional parameters
|
1129
|
+
# @return [CustomDashboardResponse]
|
1130
|
+
def insert_custom_dashboard(dashboard, opts = {})
|
1131
|
+
data, _status_code, _headers = insert_custom_dashboard_with_http_info(dashboard, opts)
|
1132
|
+
data
|
1133
|
+
end
|
1134
|
+
|
1135
|
+
# Create a custom dashboard
|
1136
|
+
# Create a new custom dashboard on the UltraCart account.
|
1137
|
+
# @param dashboard [CustomDashboard] Dashboard to create
|
1138
|
+
# @param [Hash] opts the optional parameters
|
1139
|
+
# @return [Array<(CustomDashboardResponse, Integer, Hash)>] CustomDashboardResponse data, response status code and response headers
|
1140
|
+
def insert_custom_dashboard_with_http_info(dashboard, opts = {})
|
1141
|
+
if @api_client.config.debugging
|
1142
|
+
@api_client.config.logger.debug 'Calling API: DatawarehouseApi.insert_custom_dashboard ...'
|
1143
|
+
end
|
1144
|
+
# verify the required parameter 'dashboard' is set
|
1145
|
+
if @api_client.config.client_side_validation && dashboard.nil?
|
1146
|
+
fail ArgumentError, "Missing the required parameter 'dashboard' when calling DatawarehouseApi.insert_custom_dashboard"
|
1147
|
+
end
|
1148
|
+
# resource path
|
1149
|
+
local_var_path = '/datawarehouse/custom_dashboards'
|
1150
|
+
|
1151
|
+
# query parameters
|
1152
|
+
query_params = opts[:query_params] || {}
|
1153
|
+
|
1154
|
+
# header parameters
|
1155
|
+
header_params = opts[:header_params] || {}
|
1156
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
1157
|
+
# HTTP header 'Accept' (if needed)
|
1158
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1159
|
+
# HTTP header 'Content-Type'
|
1160
|
+
content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
1161
|
+
if !content_type.nil?
|
1162
|
+
header_params['Content-Type'] = content_type
|
1163
|
+
end
|
1164
|
+
|
1165
|
+
# form parameters
|
1166
|
+
form_params = opts[:form_params] || {}
|
1167
|
+
|
1168
|
+
# http body (model)
|
1169
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(dashboard)
|
1170
|
+
|
1171
|
+
# return_type
|
1172
|
+
return_type = opts[:debug_return_type] || 'CustomDashboardResponse'
|
1173
|
+
|
1174
|
+
# auth_names
|
1175
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
1176
|
+
|
1177
|
+
new_options = opts.merge(
|
1178
|
+
:operation => :"DatawarehouseApi.insert_custom_dashboard",
|
1179
|
+
:header_params => header_params,
|
1180
|
+
:query_params => query_params,
|
1181
|
+
:form_params => form_params,
|
1182
|
+
:body => post_body,
|
1183
|
+
:auth_names => auth_names,
|
1184
|
+
:return_type => return_type
|
1185
|
+
)
|
1186
|
+
|
1187
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1188
|
+
if @api_client.config.debugging
|
1189
|
+
@api_client.config.logger.debug "API called: DatawarehouseApi#insert_custom_dashboard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1190
|
+
end
|
1191
|
+
return data, status_code, headers
|
1192
|
+
end
|
1193
|
+
|
812
1194
|
# Create a custom report
|
813
1195
|
# Create a new custom report on the UltraCart account.
|
814
1196
|
# @param report [CustomReport] Report to create
|
@@ -947,6 +1329,81 @@ module UltracartClient
|
|
947
1329
|
return data, status_code, headers
|
948
1330
|
end
|
949
1331
|
|
1332
|
+
# Update a custom dashboard
|
1333
|
+
# Update a custom dashboard on the UltraCart account.
|
1334
|
+
# @param custom_dashboard_oid [Integer] The dashboard oid to custom update.
|
1335
|
+
# @param dashboard [CustomDashboard] Dashboard to custom update
|
1336
|
+
# @param [Hash] opts the optional parameters
|
1337
|
+
# @return [CustomDashboardResponse]
|
1338
|
+
def update_custom_dashboard(custom_dashboard_oid, dashboard, opts = {})
|
1339
|
+
data, _status_code, _headers = update_custom_dashboard_with_http_info(custom_dashboard_oid, dashboard, opts)
|
1340
|
+
data
|
1341
|
+
end
|
1342
|
+
|
1343
|
+
# Update a custom dashboard
|
1344
|
+
# Update a custom dashboard on the UltraCart account.
|
1345
|
+
# @param custom_dashboard_oid [Integer] The dashboard oid to custom update.
|
1346
|
+
# @param dashboard [CustomDashboard] Dashboard to custom update
|
1347
|
+
# @param [Hash] opts the optional parameters
|
1348
|
+
# @return [Array<(CustomDashboardResponse, Integer, Hash)>] CustomDashboardResponse data, response status code and response headers
|
1349
|
+
def update_custom_dashboard_with_http_info(custom_dashboard_oid, dashboard, opts = {})
|
1350
|
+
if @api_client.config.debugging
|
1351
|
+
@api_client.config.logger.debug 'Calling API: DatawarehouseApi.update_custom_dashboard ...'
|
1352
|
+
end
|
1353
|
+
# verify the required parameter 'custom_dashboard_oid' is set
|
1354
|
+
if @api_client.config.client_side_validation && custom_dashboard_oid.nil?
|
1355
|
+
fail ArgumentError, "Missing the required parameter 'custom_dashboard_oid' when calling DatawarehouseApi.update_custom_dashboard"
|
1356
|
+
end
|
1357
|
+
# verify the required parameter 'dashboard' is set
|
1358
|
+
if @api_client.config.client_side_validation && dashboard.nil?
|
1359
|
+
fail ArgumentError, "Missing the required parameter 'dashboard' when calling DatawarehouseApi.update_custom_dashboard"
|
1360
|
+
end
|
1361
|
+
# resource path
|
1362
|
+
local_var_path = '/datawarehouse/custom_dashboards/{custom_dashboard_oid}'.sub('{' + 'custom_dashboard_oid' + '}', CGI.escape(custom_dashboard_oid.to_s))
|
1363
|
+
|
1364
|
+
# query parameters
|
1365
|
+
query_params = opts[:query_params] || {}
|
1366
|
+
|
1367
|
+
# header parameters
|
1368
|
+
header_params = opts[:header_params] || {}
|
1369
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
1370
|
+
# HTTP header 'Accept' (if needed)
|
1371
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1372
|
+
# HTTP header 'Content-Type'
|
1373
|
+
content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
1374
|
+
if !content_type.nil?
|
1375
|
+
header_params['Content-Type'] = content_type
|
1376
|
+
end
|
1377
|
+
|
1378
|
+
# form parameters
|
1379
|
+
form_params = opts[:form_params] || {}
|
1380
|
+
|
1381
|
+
# http body (model)
|
1382
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(dashboard)
|
1383
|
+
|
1384
|
+
# return_type
|
1385
|
+
return_type = opts[:debug_return_type] || 'CustomDashboardResponse'
|
1386
|
+
|
1387
|
+
# auth_names
|
1388
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
1389
|
+
|
1390
|
+
new_options = opts.merge(
|
1391
|
+
:operation => :"DatawarehouseApi.update_custom_dashboard",
|
1392
|
+
:header_params => header_params,
|
1393
|
+
:query_params => query_params,
|
1394
|
+
:form_params => form_params,
|
1395
|
+
:body => post_body,
|
1396
|
+
:auth_names => auth_names,
|
1397
|
+
:return_type => return_type
|
1398
|
+
)
|
1399
|
+
|
1400
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
1401
|
+
if @api_client.config.debugging
|
1402
|
+
@api_client.config.logger.debug "API called: DatawarehouseApi#update_custom_dashboard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1403
|
+
end
|
1404
|
+
return data, status_code, headers
|
1405
|
+
end
|
1406
|
+
|
950
1407
|
# Update a custom report
|
951
1408
|
# Update a custom report on the UltraCart account.
|
952
1409
|
# @param custom_report_oid [Integer] The report oid to custom update.
|
@@ -162,7 +162,7 @@ module UltracartClient
|
|
162
162
|
:return_type => return_type
|
163
163
|
)
|
164
164
|
|
165
|
-
data, status_code, headers = @api_client.call_api(:
|
165
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
166
166
|
if @api_client.config.debugging
|
167
167
|
@api_client.config.logger.debug "API called: OrderApi#block_refund_on_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
168
168
|
end
|
@@ -1646,97 +1646,6 @@ module UltracartClient
|
|
1646
1646
|
return data, status_code, headers
|
1647
1647
|
end
|
1648
1648
|
|
1649
|
-
# Refund an order completely
|
1650
|
-
# Perform a refund operation on an order and then update the order if successful.
|
1651
|
-
# @param order_id [String] The order id to refund.
|
1652
|
-
# @param [Hash] opts the optional parameters
|
1653
|
-
# @option opts [Boolean] :reject_after_refund Reject order after refund (default to false)
|
1654
|
-
# @option opts [Boolean] :skip_customer_notification Skip customer email notification (default to false)
|
1655
|
-
# @option opts [Boolean] :auto_order_cancel Cancel associated auto orders (default to false)
|
1656
|
-
# @option opts [Boolean] :manual_refund Consider a manual refund done externally (default to false)
|
1657
|
-
# @option opts [Boolean] :reverse_affiliate_transactions Reverse affiliate transactions (default to true)
|
1658
|
-
# @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)
|
1659
|
-
# @option opts [String] :auto_order_cancel_reason Reason for auto orders cancellation
|
1660
|
-
# @option opts [String] :refund_reason Reason for refund
|
1661
|
-
# @option opts [String] :reject_reason Reason for reject
|
1662
|
-
# @return [OrderResponse]
|
1663
|
-
def refund_order_completely(order_id, opts = {})
|
1664
|
-
data, _status_code, _headers = refund_order_completely_with_http_info(order_id, opts)
|
1665
|
-
data
|
1666
|
-
end
|
1667
|
-
|
1668
|
-
# Refund an order completely
|
1669
|
-
# Perform a refund operation on an order and then update the order if successful.
|
1670
|
-
# @param order_id [String] The order id to refund.
|
1671
|
-
# @param [Hash] opts the optional parameters
|
1672
|
-
# @option opts [Boolean] :reject_after_refund Reject order after refund (default to false)
|
1673
|
-
# @option opts [Boolean] :skip_customer_notification Skip customer email notification (default to false)
|
1674
|
-
# @option opts [Boolean] :auto_order_cancel Cancel associated auto orders (default to false)
|
1675
|
-
# @option opts [Boolean] :manual_refund Consider a manual refund done externally (default to false)
|
1676
|
-
# @option opts [Boolean] :reverse_affiliate_transactions Reverse affiliate transactions (default to true)
|
1677
|
-
# @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)
|
1678
|
-
# @option opts [String] :auto_order_cancel_reason Reason for auto orders cancellation
|
1679
|
-
# @option opts [String] :refund_reason Reason for refund
|
1680
|
-
# @option opts [String] :reject_reason Reason for reject
|
1681
|
-
# @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
|
1682
|
-
def refund_order_completely_with_http_info(order_id, opts = {})
|
1683
|
-
if @api_client.config.debugging
|
1684
|
-
@api_client.config.logger.debug 'Calling API: OrderApi.refund_order_completely ...'
|
1685
|
-
end
|
1686
|
-
# verify the required parameter 'order_id' is set
|
1687
|
-
if @api_client.config.client_side_validation && order_id.nil?
|
1688
|
-
fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.refund_order_completely"
|
1689
|
-
end
|
1690
|
-
# resource path
|
1691
|
-
local_var_path = '/order/orders/{order_id}/refund_completely'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
|
1692
|
-
|
1693
|
-
# query parameters
|
1694
|
-
query_params = opts[:query_params] || {}
|
1695
|
-
query_params[:'reject_after_refund'] = opts[:'reject_after_refund'] if !opts[:'reject_after_refund'].nil?
|
1696
|
-
query_params[:'skip_customer_notification'] = opts[:'skip_customer_notification'] if !opts[:'skip_customer_notification'].nil?
|
1697
|
-
query_params[:'auto_order_cancel'] = opts[:'auto_order_cancel'] if !opts[:'auto_order_cancel'].nil?
|
1698
|
-
query_params[:'manual_refund'] = opts[:'manual_refund'] if !opts[:'manual_refund'].nil?
|
1699
|
-
query_params[:'reverse_affiliate_transactions'] = opts[:'reverse_affiliate_transactions'] if !opts[:'reverse_affiliate_transactions'].nil?
|
1700
|
-
query_params[:'issue_store_credit'] = opts[:'issue_store_credit'] if !opts[:'issue_store_credit'].nil?
|
1701
|
-
query_params[:'auto_order_cancel_reason'] = opts[:'auto_order_cancel_reason'] if !opts[:'auto_order_cancel_reason'].nil?
|
1702
|
-
query_params[:'refund_reason'] = opts[:'refund_reason'] if !opts[:'refund_reason'].nil?
|
1703
|
-
query_params[:'reject_reason'] = opts[:'reject_reason'] if !opts[:'reject_reason'].nil?
|
1704
|
-
|
1705
|
-
# header parameters
|
1706
|
-
header_params = opts[:header_params] || {}
|
1707
|
-
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
1708
|
-
# HTTP header 'Accept' (if needed)
|
1709
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1710
|
-
|
1711
|
-
# form parameters
|
1712
|
-
form_params = opts[:form_params] || {}
|
1713
|
-
|
1714
|
-
# http body (model)
|
1715
|
-
post_body = opts[:debug_body]
|
1716
|
-
|
1717
|
-
# return_type
|
1718
|
-
return_type = opts[:debug_return_type] || 'OrderResponse'
|
1719
|
-
|
1720
|
-
# auth_names
|
1721
|
-
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
1722
|
-
|
1723
|
-
new_options = opts.merge(
|
1724
|
-
:operation => :"OrderApi.refund_order_completely",
|
1725
|
-
:header_params => header_params,
|
1726
|
-
:query_params => query_params,
|
1727
|
-
:form_params => form_params,
|
1728
|
-
:body => post_body,
|
1729
|
-
:auth_names => auth_names,
|
1730
|
-
:return_type => return_type
|
1731
|
-
)
|
1732
|
-
|
1733
|
-
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
1734
|
-
if @api_client.config.debugging
|
1735
|
-
@api_client.config.logger.debug "API called: OrderApi#refund_order_completely\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1736
|
-
end
|
1737
|
-
return data, status_code, headers
|
1738
|
-
end
|
1739
|
-
|
1740
1649
|
# Replacement order
|
1741
1650
|
# Create a replacement order based upon a previous order
|
1742
1651
|
# @param order_id [String] The order id to generate a replacement for.
|
@@ -1997,7 +1906,7 @@ module UltracartClient
|
|
1997
1906
|
:return_type => return_type
|
1998
1907
|
)
|
1999
1908
|
|
2000
|
-
data, status_code, headers = @api_client.call_api(:
|
1909
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2001
1910
|
if @api_client.config.debugging
|
2002
1911
|
@api_client.config.logger.debug "API called: OrderApi#unblock_refund_on_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2003
1912
|
end
|