ultracart_api 3.11.16 → 3.11.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5193e746267b3197311ac8f0a9c849c2385e078ff3c58b7aa3d598e32a357ebf
4
- data.tar.gz: fea6ee29a16616b6b3061392d707ddac908bf54e8913db5d45a2cc6b7389f560
3
+ metadata.gz: 712d427ceb28f13951dfa3516c9ddf5c01cc6e286cfdda0f24d722bd88cb73fb
4
+ data.tar.gz: 661b1f0275b0e88511cadede357f2b11e7a681c4973f3df2e739548788c06d11
5
5
  SHA512:
6
- metadata.gz: bea4d273179b62709428014f6a031bd2a25ae94214a3318a478f0045ddedce66763f319222bfc65f8c78adb35f5fb5771b11d39aca7188cb735e5cc4322b3569
7
- data.tar.gz: 1512b5a8a1124216f36815e8cdc8876b1fa02e9a9a11e1bf40f585bdad3f5db450a7bcdd50eb1d750fe456b0fe1dd2a39b8236d2bd5a95b1cc246a55051264bf
6
+ metadata.gz: 627d4a5393e372b9f016a4e1daff5dc529eff80ca01b9d12763ad5aaaa6c32135e375f3bccb19979bc93c769372600efd28336d5290f3613eebd14a7b40a7bd3
7
+ data.tar.gz: f591bff493dda67c33560b2fa09fbd5c36358518ec4cb05800aad23b22d79c6627886e2af5c68bf7721fb659ee41d7d757b7f8d37b6977ad69b62557cdb44f39
data/README.md CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
7
7
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
8
 
9
9
  - API version: 2.0.0
10
- - Package version: 3.11.16
10
+ - Package version: 3.11.17
11
11
  - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
13
13
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./ultracart_api-3.11.16.gem
27
+ gem install ./ultracart_api-3.11.17.gem
28
28
  ```
29
- (for development, run `gem install --dev ./ultracart_api-3.11.16.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./ultracart_api-3.11.17.gem` to install the development dependencies)
30
30
 
31
31
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
32
32
 
33
33
  Finally add this to the Gemfile:
34
34
 
35
- gem 'ultracart_api', '~> 3.11.16'
35
+ gem 'ultracart_api', '~> 3.11.17'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -269,11 +269,15 @@ Class | Method | HTTP request | Description
269
269
  *UltracartClient::CustomerApi* | [**update_customer_email_lists**](docs/CustomerApi.md#update_customer_email_lists) | **POST** /customer/customers/{customer_profile_oid}/email_lists | Update email list subscriptions for a customer
270
270
  *UltracartClient::CustomerApi* | [**update_wish_list_item**](docs/CustomerApi.md#update_wish_list_item) | **PUT** /customer/customers/{customer_profile_oid}/wishlist/{customer_wishlist_item_oid} | Update a customer wishlist item
271
271
  *UltracartClient::CustomerApi* | [**validate_email_verification_token**](docs/CustomerApi.md#validate_email_verification_token) | **POST** /customer/customers/email_verify/validate_token | Validate a token that can be used to verify a customer email address
272
+ *UltracartClient::DatawarehouseApi* | [**delete_custom_dashboard**](docs/DatawarehouseApi.md#delete_custom_dashboard) | **DELETE** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Delete a custom dashboard
272
273
  *UltracartClient::DatawarehouseApi* | [**delete_custom_report**](docs/DatawarehouseApi.md#delete_custom_report) | **DELETE** /datawarehouse/custom_reports/{custom_report_oid} | Delete a custom report
273
274
  *UltracartClient::DatawarehouseApi* | [**delete_report**](docs/DatawarehouseApi.md#delete_report) | **DELETE** /datawarehouse/reports/{report_oid} | Delete a report
274
275
  *UltracartClient::DatawarehouseApi* | [**dry_run_report_queries**](docs/DatawarehouseApi.md#dry_run_report_queries) | **PUT** /datawarehouse/reports/dryrun | Dry run the report queries
275
276
  *UltracartClient::DatawarehouseApi* | [**execute_custom_report**](docs/DatawarehouseApi.md#execute_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid}/execute | Execute a custom report
277
+ *UltracartClient::DatawarehouseApi* | [**execute_custom_reports**](docs/DatawarehouseApi.md#execute_custom_reports) | **PUT** /datawarehouse/custom_reports/execute | Execute a custom reports
276
278
  *UltracartClient::DatawarehouseApi* | [**execute_report_queries**](docs/DatawarehouseApi.md#execute_report_queries) | **PUT** /datawarehouse/reports/execute | Execute the report queries
279
+ *UltracartClient::DatawarehouseApi* | [**get_custom_dashboard**](docs/DatawarehouseApi.md#get_custom_dashboard) | **GET** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Get a custom dashboard
280
+ *UltracartClient::DatawarehouseApi* | [**get_custom_dashboards**](docs/DatawarehouseApi.md#get_custom_dashboards) | **GET** /datawarehouse/custom_dashboards | Get custom dashboards
277
281
  *UltracartClient::DatawarehouseApi* | [**get_custom_report**](docs/DatawarehouseApi.md#get_custom_report) | **GET** /datawarehouse/custom_reports/{custom_report_oid} | Get a custom report
278
282
  *UltracartClient::DatawarehouseApi* | [**get_custom_report_account_config**](docs/DatawarehouseApi.md#get_custom_report_account_config) | **GET** /datawarehouse/custom_reports/account_config | Get custom report account configuration
279
283
  *UltracartClient::DatawarehouseApi* | [**get_custom_reports**](docs/DatawarehouseApi.md#get_custom_reports) | **GET** /datawarehouse/custom_reports | Get custom reports
@@ -282,8 +286,10 @@ Class | Method | HTTP request | Description
282
286
  *UltracartClient::DatawarehouseApi* | [**get_report_data_set_page**](docs/DatawarehouseApi.md#get_report_data_set_page) | **GET** /datawarehouse/reports/dataset/{dataset_uuid}/pages/{page_number} | Get a report data set page
283
287
  *UltracartClient::DatawarehouseApi* | [**get_report_websocket_authorization**](docs/DatawarehouseApi.md#get_report_websocket_authorization) | **PUT** /datawarehouse/reports/auth | Get report websocket authorization
284
288
  *UltracartClient::DatawarehouseApi* | [**get_reports**](docs/DatawarehouseApi.md#get_reports) | **GET** /datawarehouse/reports | Get list of reports available
289
+ *UltracartClient::DatawarehouseApi* | [**insert_custom_dashboard**](docs/DatawarehouseApi.md#insert_custom_dashboard) | **POST** /datawarehouse/custom_dashboards | Create a custom dashboard
285
290
  *UltracartClient::DatawarehouseApi* | [**insert_custom_report**](docs/DatawarehouseApi.md#insert_custom_report) | **POST** /datawarehouse/custom_reports | Create a custom report
286
291
  *UltracartClient::DatawarehouseApi* | [**insert_report**](docs/DatawarehouseApi.md#insert_report) | **POST** /datawarehouse/reports | Create a report
292
+ *UltracartClient::DatawarehouseApi* | [**update_custom_dashboard**](docs/DatawarehouseApi.md#update_custom_dashboard) | **PUT** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Update a custom dashboard
287
293
  *UltracartClient::DatawarehouseApi* | [**update_custom_report**](docs/DatawarehouseApi.md#update_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid} | Update a custom report
288
294
  *UltracartClient::DatawarehouseApi* | [**update_custom_report_account_config**](docs/DatawarehouseApi.md#update_custom_report_account_config) | **PUT** /datawarehouse/custom_reports/account_config | Update custom report account config
289
295
  *UltracartClient::DatawarehouseApi* | [**update_report**](docs/DatawarehouseApi.md#update_report) | **PUT** /datawarehouse/reports/{report_oid} | Update a report
@@ -910,16 +916,25 @@ Class | Method | HTTP request | Description
910
916
  - [UltracartClient::CouponsRequest](docs/CouponsRequest.md)
911
917
  - [UltracartClient::CouponsResponse](docs/CouponsResponse.md)
912
918
  - [UltracartClient::Currency](docs/Currency.md)
919
+ - [UltracartClient::CustomDashboard](docs/CustomDashboard.md)
920
+ - [UltracartClient::CustomDashboardPage](docs/CustomDashboardPage.md)
921
+ - [UltracartClient::CustomDashboardPageReport](docs/CustomDashboardPageReport.md)
922
+ - [UltracartClient::CustomDashboardResponse](docs/CustomDashboardResponse.md)
923
+ - [UltracartClient::CustomDashboardsResponse](docs/CustomDashboardsResponse.md)
913
924
  - [UltracartClient::CustomReport](docs/CustomReport.md)
914
925
  - [UltracartClient::CustomReportAccountConfig](docs/CustomReportAccountConfig.md)
915
926
  - [UltracartClient::CustomReportAccountConfigResponse](docs/CustomReportAccountConfigResponse.md)
916
927
  - [UltracartClient::CustomReportExecutionParameter](docs/CustomReportExecutionParameter.md)
917
928
  - [UltracartClient::CustomReportExecutionRequest](docs/CustomReportExecutionRequest.md)
929
+ - [UltracartClient::CustomReportExecutionResponse](docs/CustomReportExecutionResponse.md)
918
930
  - [UltracartClient::CustomReportParameter](docs/CustomReportParameter.md)
919
931
  - [UltracartClient::CustomReportParameterOption](docs/CustomReportParameterOption.md)
920
932
  - [UltracartClient::CustomReportQuery](docs/CustomReportQuery.md)
921
933
  - [UltracartClient::CustomReportResponse](docs/CustomReportResponse.md)
922
934
  - [UltracartClient::CustomReportTooltip](docs/CustomReportTooltip.md)
935
+ - [UltracartClient::CustomReportsExecutionReportData](docs/CustomReportsExecutionReportData.md)
936
+ - [UltracartClient::CustomReportsExecutionRequest](docs/CustomReportsExecutionRequest.md)
937
+ - [UltracartClient::CustomReportsExecutionResponse](docs/CustomReportsExecutionResponse.md)
923
938
  - [UltracartClient::CustomReportsResponse](docs/CustomReportsResponse.md)
924
939
  - [UltracartClient::Customer](docs/Customer.md)
925
940
  - [UltracartClient::CustomerActivity](docs/CustomerActivity.md)
@@ -1552,6 +1567,7 @@ Not every change is committed to every SDK.
1552
1567
 
1553
1568
  | Version | Date | Comments |
1554
1569
  | --: | :-: | --- |
1570
+ | 3.11.17 | 08/04/2025 | small changes to internal flow app to support loyalty tier moves |
1555
1571
  | 3.11.16 | 07/28/2025 | updated doc samples |
1556
1572
  | 3.11.15 | 07/28/2025 | new order methods for blocking and unblocking refunds |
1557
1573
  | 3.11.14 | 07/10/2025 | automation test |
@@ -0,0 +1,11 @@
1
+ # UltracartClient::CustomDashboard
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data_warehouse_custom_dashboard_oid** | **Integer** | | [optional]
7
+ **merchant_id** | **String** | | [optional]
8
+ **name** | **String** | | [optional]
9
+ **pages** | [**Array<CustomDashboardPage>**](CustomDashboardPage.md) | | [optional]
10
+
11
+
@@ -0,0 +1,10 @@
1
+ # UltracartClient::CustomDashboardPage
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **page_height_inches** | **Float** | | [optional]
7
+ **page_width_inches** | **Float** | | [optional]
8
+ **reports** | [**Array<CustomDashboardPageReport>**](CustomDashboardPageReport.md) | | [optional]
9
+
10
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::CustomDashboardPageReport
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data_warehouse_report_config_oid** | **Integer** | | [optional]
7
+ **grid_height** | **Integer** | | [optional]
8
+ **grid_width** | **Integer** | | [optional]
9
+ **grid_x** | **Integer** | | [optional]
10
+ **grid_y** | **Integer** | | [optional]
11
+
12
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::CustomDashboardResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **dashboard** | [**CustomDashboard**](CustomDashboard.md) | | [optional]
7
+ **error** | [**Error**](Error.md) | | [optional]
8
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::CustomDashboardsResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **dashboards** | [**Array<CustomDashboard>**](CustomDashboard.md) | reports | [optional]
7
+ **error** | [**Error**](Error.md) | | [optional]
8
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -0,0 +1,15 @@
1
+ # UltracartClient::CustomReportExecutionResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
8
+ **parameters** | [**Array<CustomReportExecutionParameter>**](CustomReportExecutionParameter.md) | | [optional]
9
+ **report** | [**CustomReport**](CustomReport.md) | | [optional]
10
+ **result_schema_json** | **String** | | [optional]
11
+ **result_url** | **String** | | [optional]
12
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
13
+ **warning** | [**Warning**](Warning.md) | | [optional]
14
+
15
+
@@ -0,0 +1,10 @@
1
+ # UltracartClient::CustomReportsExecutionReportData
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data_warehouse_report_config_oid** | **Integer** | | [optional]
7
+ **error_message** | **String** | | [optional]
8
+ **result_url** | **String** | | [optional]
9
+
10
+
@@ -0,0 +1,9 @@
1
+ # UltracartClient::CustomReportsExecutionRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data_warehouse_report_config_oids** | **Array<Integer>** | | [optional]
7
+ **parameters** | [**Array<CustomReportExecutionParameter>**](CustomReportExecutionParameter.md) | | [optional]
8
+
9
+
@@ -0,0 +1,13 @@
1
+ # UltracartClient::CustomReportsExecutionResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
8
+ **parameters** | [**Array<CustomReportExecutionParameter>**](CustomReportExecutionParameter.md) | | [optional]
9
+ **reports** | [**Array<CustomReportsExecutionReportData>**](CustomReportsExecutionReportData.md) | | [optional]
10
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
11
+ **warning** | [**Warning**](Warning.md) | | [optional]
12
+
13
+
@@ -4,11 +4,15 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
+ [**delete_custom_dashboard**](DatawarehouseApi.md#delete_custom_dashboard) | **DELETE** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Delete a custom dashboard
7
8
  [**delete_custom_report**](DatawarehouseApi.md#delete_custom_report) | **DELETE** /datawarehouse/custom_reports/{custom_report_oid} | Delete a custom report
8
9
  [**delete_report**](DatawarehouseApi.md#delete_report) | **DELETE** /datawarehouse/reports/{report_oid} | Delete a report
9
10
  [**dry_run_report_queries**](DatawarehouseApi.md#dry_run_report_queries) | **PUT** /datawarehouse/reports/dryrun | Dry run the report queries
10
11
  [**execute_custom_report**](DatawarehouseApi.md#execute_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid}/execute | Execute a custom report
12
+ [**execute_custom_reports**](DatawarehouseApi.md#execute_custom_reports) | **PUT** /datawarehouse/custom_reports/execute | Execute a custom reports
11
13
  [**execute_report_queries**](DatawarehouseApi.md#execute_report_queries) | **PUT** /datawarehouse/reports/execute | Execute the report queries
14
+ [**get_custom_dashboard**](DatawarehouseApi.md#get_custom_dashboard) | **GET** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Get a custom dashboard
15
+ [**get_custom_dashboards**](DatawarehouseApi.md#get_custom_dashboards) | **GET** /datawarehouse/custom_dashboards | Get custom dashboards
12
16
  [**get_custom_report**](DatawarehouseApi.md#get_custom_report) | **GET** /datawarehouse/custom_reports/{custom_report_oid} | Get a custom report
13
17
  [**get_custom_report_account_config**](DatawarehouseApi.md#get_custom_report_account_config) | **GET** /datawarehouse/custom_reports/account_config | Get custom report account configuration
14
18
  [**get_custom_reports**](DatawarehouseApi.md#get_custom_reports) | **GET** /datawarehouse/custom_reports | Get custom reports
@@ -17,13 +21,64 @@ Method | HTTP request | Description
17
21
  [**get_report_data_set_page**](DatawarehouseApi.md#get_report_data_set_page) | **GET** /datawarehouse/reports/dataset/{dataset_uuid}/pages/{page_number} | Get a report data set page
18
22
  [**get_report_websocket_authorization**](DatawarehouseApi.md#get_report_websocket_authorization) | **PUT** /datawarehouse/reports/auth | Get report websocket authorization
19
23
  [**get_reports**](DatawarehouseApi.md#get_reports) | **GET** /datawarehouse/reports | Get list of reports available
24
+ [**insert_custom_dashboard**](DatawarehouseApi.md#insert_custom_dashboard) | **POST** /datawarehouse/custom_dashboards | Create a custom dashboard
20
25
  [**insert_custom_report**](DatawarehouseApi.md#insert_custom_report) | **POST** /datawarehouse/custom_reports | Create a custom report
21
26
  [**insert_report**](DatawarehouseApi.md#insert_report) | **POST** /datawarehouse/reports | Create a report
27
+ [**update_custom_dashboard**](DatawarehouseApi.md#update_custom_dashboard) | **PUT** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Update a custom dashboard
22
28
  [**update_custom_report**](DatawarehouseApi.md#update_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid} | Update a custom report
23
29
  [**update_custom_report_account_config**](DatawarehouseApi.md#update_custom_report_account_config) | **PUT** /datawarehouse/custom_reports/account_config | Update custom report account config
24
30
  [**update_report**](DatawarehouseApi.md#update_report) | **PUT** /datawarehouse/reports/{report_oid} | Update a report
25
31
 
26
32
 
33
+ # **delete_custom_dashboard**
34
+ > delete_custom_dashboard(custom_dashboard_oid)
35
+
36
+ Delete a custom dashboard
37
+
38
+ Delete a custom dashboard on the UltraCart account.
39
+
40
+ ### Example
41
+ ```ruby
42
+ # load the gem
43
+ require 'ultracart_api'
44
+
45
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
46
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
47
+ api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
48
+
49
+
50
+ custom_dashboard_oid = 56 # Integer | The dashboard oid to delete.
51
+
52
+
53
+ begin
54
+ #Delete a custom dashboard
55
+ api_instance.delete_custom_dashboard(custom_dashboard_oid)
56
+ rescue UltracartClient::ApiError => e
57
+ puts "Exception when calling DatawarehouseApi->delete_custom_dashboard: #{e}"
58
+ end
59
+ ```
60
+
61
+ ### Parameters
62
+
63
+ Name | Type | Description | Notes
64
+ ------------- | ------------- | ------------- | -------------
65
+ **custom_dashboard_oid** | **Integer**| The dashboard oid to delete. |
66
+
67
+ ### Return type
68
+
69
+ nil (empty response body)
70
+
71
+ ### Authorization
72
+
73
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
74
+
75
+ ### HTTP request headers
76
+
77
+ - **Content-Type**: application/json
78
+ - **Accept**: application/json
79
+
80
+
81
+
27
82
  # **delete_custom_report**
28
83
  > delete_custom_report(custom_report_oid)
29
84
 
@@ -173,7 +228,7 @@ Name | Type | Description | Notes
173
228
 
174
229
 
175
230
  # **execute_custom_report**
176
- > CustomReportResponse execute_custom_report(execution_request, custom_report_oid)
231
+ > CustomReportExecutionResponse execute_custom_report(execution_request, custom_report_oid)
177
232
 
178
233
  Execute a custom report
179
234
 
@@ -212,7 +267,57 @@ Name | Type | Description | Notes
212
267
 
213
268
  ### Return type
214
269
 
215
- [**CustomReportResponse**](CustomReportResponse.md)
270
+ [**CustomReportExecutionResponse**](CustomReportExecutionResponse.md)
271
+
272
+ ### Authorization
273
+
274
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
275
+
276
+ ### HTTP request headers
277
+
278
+ - **Content-Type**: application/json; charset=UTF-8
279
+ - **Accept**: application/json
280
+
281
+
282
+
283
+ # **execute_custom_reports**
284
+ > CustomReportsExecutionResponse execute_custom_reports(execution_request)
285
+
286
+ Execute a custom reports
287
+
288
+ Execute a custom reports on the UltraCart account.
289
+
290
+ ### Example
291
+ ```ruby
292
+ # load the gem
293
+ require 'ultracart_api'
294
+
295
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
296
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
297
+ api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
298
+
299
+
300
+ execution_request = UltracartClient::CustomReportsExecutionRequest.new # CustomReportsExecutionRequest | Request to execute custom reports
301
+
302
+
303
+ begin
304
+ #Execute a custom reports
305
+ result = api_instance.execute_custom_reports(execution_request)
306
+ p result
307
+ rescue UltracartClient::ApiError => e
308
+ puts "Exception when calling DatawarehouseApi->execute_custom_reports: #{e}"
309
+ end
310
+ ```
311
+
312
+ ### Parameters
313
+
314
+ Name | Type | Description | Notes
315
+ ------------- | ------------- | ------------- | -------------
316
+ **execution_request** | [**CustomReportsExecutionRequest**](CustomReportsExecutionRequest.md)| Request to execute custom reports |
317
+
318
+ ### Return type
319
+
320
+ [**CustomReportsExecutionResponse**](CustomReportsExecutionResponse.md)
216
321
 
217
322
  ### Authorization
218
323
 
@@ -274,6 +379,101 @@ nil (empty response body)
274
379
 
275
380
 
276
381
 
382
+ # **get_custom_dashboard**
383
+ > CustomDashboardResponse get_custom_dashboard(custom_dashboard_oid)
384
+
385
+ Get a custom dashboard
386
+
387
+ Retrieve a custom dashboard
388
+
389
+ ### Example
390
+ ```ruby
391
+ # load the gem
392
+ require 'ultracart_api'
393
+
394
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
395
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
396
+ api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
397
+
398
+
399
+ custom_dashboard_oid = 56 # Integer |
400
+
401
+
402
+ begin
403
+ #Get a custom dashboard
404
+ result = api_instance.get_custom_dashboard(custom_dashboard_oid)
405
+ p result
406
+ rescue UltracartClient::ApiError => e
407
+ puts "Exception when calling DatawarehouseApi->get_custom_dashboard: #{e}"
408
+ end
409
+ ```
410
+
411
+ ### Parameters
412
+
413
+ Name | Type | Description | Notes
414
+ ------------- | ------------- | ------------- | -------------
415
+ **custom_dashboard_oid** | **Integer**| |
416
+
417
+ ### Return type
418
+
419
+ [**CustomDashboardResponse**](CustomDashboardResponse.md)
420
+
421
+ ### Authorization
422
+
423
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
424
+
425
+ ### HTTP request headers
426
+
427
+ - **Content-Type**: application/json
428
+ - **Accept**: application/json
429
+
430
+
431
+
432
+ # **get_custom_dashboards**
433
+ > CustomDashboardsResponse get_custom_dashboards
434
+
435
+ Get custom dashboards
436
+
437
+ Retrieve a custom dashboards
438
+
439
+ ### Example
440
+ ```ruby
441
+ # load the gem
442
+ require 'ultracart_api'
443
+
444
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
445
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
446
+ api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
447
+
448
+
449
+
450
+ begin
451
+ #Get custom dashboards
452
+ result = api_instance.get_custom_dashboards
453
+ p result
454
+ rescue UltracartClient::ApiError => e
455
+ puts "Exception when calling DatawarehouseApi->get_custom_dashboards: #{e}"
456
+ end
457
+ ```
458
+
459
+ ### Parameters
460
+ This endpoint does not need any parameter.
461
+
462
+ ### Return type
463
+
464
+ [**CustomDashboardsResponse**](CustomDashboardsResponse.md)
465
+
466
+ ### Authorization
467
+
468
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
469
+
470
+ ### HTTP request headers
471
+
472
+ - **Content-Type**: application/json
473
+ - **Accept**: application/json
474
+
475
+
476
+
277
477
  # **get_custom_report**
278
478
  > CustomReportResponse get_custom_report(custom_report_oid)
279
479
 
@@ -657,6 +857,56 @@ This endpoint does not need any parameter.
657
857
 
658
858
 
659
859
 
860
+ # **insert_custom_dashboard**
861
+ > CustomDashboardResponse insert_custom_dashboard(dashboard)
862
+
863
+ Create a custom dashboard
864
+
865
+ Create a new custom dashboard on the UltraCart account.
866
+
867
+ ### Example
868
+ ```ruby
869
+ # load the gem
870
+ require 'ultracart_api'
871
+
872
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
873
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
874
+ api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
875
+
876
+
877
+ dashboard = UltracartClient::CustomDashboard.new # CustomDashboard | Dashboard to create
878
+
879
+
880
+ begin
881
+ #Create a custom dashboard
882
+ result = api_instance.insert_custom_dashboard(dashboard)
883
+ p result
884
+ rescue UltracartClient::ApiError => e
885
+ puts "Exception when calling DatawarehouseApi->insert_custom_dashboard: #{e}"
886
+ end
887
+ ```
888
+
889
+ ### Parameters
890
+
891
+ Name | Type | Description | Notes
892
+ ------------- | ------------- | ------------- | -------------
893
+ **dashboard** | [**CustomDashboard**](CustomDashboard.md)| Dashboard to create |
894
+
895
+ ### Return type
896
+
897
+ [**CustomDashboardResponse**](CustomDashboardResponse.md)
898
+
899
+ ### Authorization
900
+
901
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
902
+
903
+ ### HTTP request headers
904
+
905
+ - **Content-Type**: application/json; charset=UTF-8
906
+ - **Accept**: application/json
907
+
908
+
909
+
660
910
  # **insert_custom_report**
661
911
  > CustomReportResponse insert_custom_report(report)
662
912
 
@@ -757,6 +1007,59 @@ Name | Type | Description | Notes
757
1007
 
758
1008
 
759
1009
 
1010
+ # **update_custom_dashboard**
1011
+ > CustomDashboardResponse update_custom_dashboard(dashboard, custom_dashboard_oid)
1012
+
1013
+ Update a custom dashboard
1014
+
1015
+ Update a custom dashboard on the UltraCart account.
1016
+
1017
+ ### Example
1018
+ ```ruby
1019
+ # load the gem
1020
+ require 'ultracart_api'
1021
+
1022
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1023
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1024
+ api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
1025
+
1026
+
1027
+ dashboard = UltracartClient::CustomDashboard.new # CustomDashboard | Dashboard to custom update
1028
+
1029
+ custom_dashboard_oid = 56 # Integer | The dashboard oid to custom update.
1030
+
1031
+
1032
+ begin
1033
+ #Update a custom dashboard
1034
+ result = api_instance.update_custom_dashboard(dashboard, custom_dashboard_oid)
1035
+ p result
1036
+ rescue UltracartClient::ApiError => e
1037
+ puts "Exception when calling DatawarehouseApi->update_custom_dashboard: #{e}"
1038
+ end
1039
+ ```
1040
+
1041
+ ### Parameters
1042
+
1043
+ Name | Type | Description | Notes
1044
+ ------------- | ------------- | ------------- | -------------
1045
+ **dashboard** | [**CustomDashboard**](CustomDashboard.md)| Dashboard to custom update |
1046
+ **custom_dashboard_oid** | **Integer**| The dashboard oid to custom update. |
1047
+
1048
+ ### Return type
1049
+
1050
+ [**CustomDashboardResponse**](CustomDashboardResponse.md)
1051
+
1052
+ ### Authorization
1053
+
1054
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1055
+
1056
+ ### HTTP request headers
1057
+
1058
+ - **Content-Type**: application/json; charset=UTF-8
1059
+ - **Accept**: application/json
1060
+
1061
+
1062
+
760
1063
  # **update_custom_report**
761
1064
  > CustomReportResponse update_custom_report(report, custom_report_oid)
762
1065
 
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
6
6
  **available_expansions** | **Array<String>** | | [optional]
7
7
  **available_tokens** | **Array<String>** | | [optional]
8
8
  **error** | [**Error**](Error.md) | | [optional]
9
+ **loyalty_tiers** | **Array<String>** | | [optional]
9
10
  **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
10
11
  **rest_object_type** | **String** | | [optional]
11
12
  **success** | **BOOLEAN** | Indicates if API call was successful | [optional]