ultracart_api 3.11.13 → 3.11.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.
- checksums.yaml +4 -4
- data/README.md +25 -4
- data/docs/CartUpsellAfter.md +3 -1
- data/docs/ConversationVirtualAgentCapabilities.md +2 -0
- data/docs/CustomReport.md +17 -0
- data/docs/CustomReportAccountConfig.md +16 -0
- data/docs/CustomReportAccountConfigResponse.md +12 -0
- data/docs/CustomReportExecutionParameter.md +10 -0
- data/docs/CustomReportExecutionRequest.md +8 -0
- data/docs/CustomReportParameter.md +13 -0
- data/docs/CustomReportParameterOption.md +9 -0
- data/docs/CustomReportQuery.md +13 -0
- data/docs/CustomReportResponse.md +12 -0
- data/docs/CustomReportTooltip.md +9 -0
- data/docs/DatawarehouseApi.md +357 -0
- data/docs/Item.md +1 -1
- data/docs/OrderApi.md +104 -0
- data/lib/ultracart_api/api/datawarehouse_api.rb +390 -0
- data/lib/ultracart_api/api/order_api.rb +111 -0
- data/lib/ultracart_api/models/cart_upsell_after.rb +25 -5
- data/lib/ultracart_api/models/conversation_virtual_agent_capabilities.rb +55 -1
- data/lib/ultracart_api/models/custom_report.rb +271 -0
- data/lib/ultracart_api/models/custom_report_account_config.rb +261 -0
- data/lib/ultracart_api/models/custom_report_account_config_response.rb +221 -0
- data/lib/ultracart_api/models/custom_report_execution_parameter.rb +202 -0
- data/lib/ultracart_api/models/custom_report_execution_request.rb +186 -0
- data/lib/ultracart_api/models/custom_report_parameter.rb +231 -0
- data/lib/ultracart_api/models/custom_report_parameter_option.rb +193 -0
- data/lib/ultracart_api/models/custom_report_query.rb +231 -0
- data/lib/ultracart_api/models/custom_report_response.rb +221 -0
- data/lib/ultracart_api/models/custom_report_tooltip.rb +193 -0
- data/lib/ultracart_api/models/item.rb +1 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +10 -0
- metadata +22 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c11973761bbac8a13f74e1fa3c173c522d6206eeca1ce874dc9b7f6597837259
|
4
|
+
data.tar.gz: c10c527d7d26aa56e0c3ac042df6f63d0bded1b18fa543a9992dcf0e864634af
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0f07e187b37d7bdbfe01903b9553ffca0ea899add9ee68fdfd64ba813a99ff3386efb2faed3849e62fe0447a9b964225e9bba5d7369e866417f32222b08a50f2
|
7
|
+
data.tar.gz: c8efb6154748531c8bf073e3f72e3e28a33fb5a394d39050f7dbb911859fc7f7a42c1e96908886aa274bb30f89c4d96ce9a6e25a8c7b4505f679f9eb230f75fa
|
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.
|
10
|
+
- Package version: 3.11.15
|
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.
|
27
|
+
gem install ./ultracart_api-3.11.15.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.11.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.11.15.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.
|
35
|
+
gem 'ultracart_api', '~> 3.11.15'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -269,15 +269,22 @@ 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_report**](docs/DatawarehouseApi.md#delete_custom_report) | **DELETE** /datawarehouse/custom_reports/{custom_report_oid} | Delete a custom report
|
272
273
|
*UltracartClient::DatawarehouseApi* | [**delete_report**](docs/DatawarehouseApi.md#delete_report) | **DELETE** /datawarehouse/reports/{report_oid} | Delete a report
|
273
274
|
*UltracartClient::DatawarehouseApi* | [**dry_run_report_queries**](docs/DatawarehouseApi.md#dry_run_report_queries) | **PUT** /datawarehouse/reports/dryrun | Dry run the report queries
|
275
|
+
*UltracartClient::DatawarehouseApi* | [**execute_custom_report**](docs/DatawarehouseApi.md#execute_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid}/execute | Execute a custom report
|
274
276
|
*UltracartClient::DatawarehouseApi* | [**execute_report_queries**](docs/DatawarehouseApi.md#execute_report_queries) | **PUT** /datawarehouse/reports/execute | Execute the report queries
|
277
|
+
*UltracartClient::DatawarehouseApi* | [**get_custom_report**](docs/DatawarehouseApi.md#get_custom_report) | **GET** /datawarehouse/custom_reports/{custom_report_oid} | Get a custom report
|
278
|
+
*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
|
275
279
|
*UltracartClient::DatawarehouseApi* | [**get_report**](docs/DatawarehouseApi.md#get_report) | **GET** /datawarehouse/reports/{report_oid} | Get a report
|
276
280
|
*UltracartClient::DatawarehouseApi* | [**get_report_data_set**](docs/DatawarehouseApi.md#get_report_data_set) | **GET** /datawarehouse/reports/dataset/{dataset_uuid} | Get a report data set
|
277
281
|
*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
|
278
282
|
*UltracartClient::DatawarehouseApi* | [**get_report_websocket_authorization**](docs/DatawarehouseApi.md#get_report_websocket_authorization) | **PUT** /datawarehouse/reports/auth | Get report websocket authorization
|
279
283
|
*UltracartClient::DatawarehouseApi* | [**get_reports**](docs/DatawarehouseApi.md#get_reports) | **GET** /datawarehouse/reports | Get list of reports available
|
284
|
+
*UltracartClient::DatawarehouseApi* | [**insert_custom_report**](docs/DatawarehouseApi.md#insert_custom_report) | **POST** /datawarehouse/custom_reports | Create a custom report
|
280
285
|
*UltracartClient::DatawarehouseApi* | [**insert_report**](docs/DatawarehouseApi.md#insert_report) | **POST** /datawarehouse/reports | Create a report
|
286
|
+
*UltracartClient::DatawarehouseApi* | [**update_custom_report**](docs/DatawarehouseApi.md#update_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid} | Update a custom report
|
287
|
+
*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
|
281
288
|
*UltracartClient::DatawarehouseApi* | [**update_report**](docs/DatawarehouseApi.md#update_report) | **PUT** /datawarehouse/reports/{report_oid} | Update a report
|
282
289
|
*UltracartClient::FulfillmentApi* | [**acknowledge_orders**](docs/FulfillmentApi.md#acknowledge_orders) | **PUT** /fulfillment/distribution_centers/{distribution_center_code}/acknowledgements | Acknowledge receipt of orders.
|
283
290
|
*UltracartClient::FulfillmentApi* | [**generate_packing_slip**](docs/FulfillmentApi.md#generate_packing_slip) | **GET** /fulfillment/distribution_centers/{distribution_center_code}/orders/{order_id} | Generate a packing slip for this order for the given distribution center.
|
@@ -324,6 +331,7 @@ Class | Method | HTTP request | Description
|
|
324
331
|
*UltracartClient::OauthApi* | [**oauth_access_token**](docs/OauthApi.md#oauth_access_token) | **POST** /oauth/token | Exchange authorization code for access token.
|
325
332
|
*UltracartClient::OauthApi* | [**oauth_revoke**](docs/OauthApi.md#oauth_revoke) | **POST** /oauth/revoke | Revoke this OAuth application.
|
326
333
|
*UltracartClient::OrderApi* | [**adjust_order_total**](docs/OrderApi.md#adjust_order_total) | **POST** /order/orders/{order_id}/adjust_order_total/{desired_total} | Adjusts an order total
|
334
|
+
*UltracartClient::OrderApi* | [**block_refund_on_order**](docs/OrderApi.md#block_refund_on_order) | **POST** /order/orders/{order_id}/refund_block | Set a refund block on an order
|
327
335
|
*UltracartClient::OrderApi* | [**cancel_order**](docs/OrderApi.md#cancel_order) | **POST** /order/orders/{order_id}/cancel | Cancel an order
|
328
336
|
*UltracartClient::OrderApi* | [**delete_order**](docs/OrderApi.md#delete_order) | **DELETE** /order/orders/{order_id} | Delete an order
|
329
337
|
*UltracartClient::OrderApi* | [**duplicate_order**](docs/OrderApi.md#duplicate_order) | **POST** /order/orders/{order_id}/duplicate | Duplicate an order
|
@@ -348,6 +356,7 @@ Class | Method | HTTP request | Description
|
|
348
356
|
*UltracartClient::OrderApi* | [**replacement**](docs/OrderApi.md#replacement) | **POST** /order/orders/{order_id}/replacement | Replacement order
|
349
357
|
*UltracartClient::OrderApi* | [**resend_receipt**](docs/OrderApi.md#resend_receipt) | **POST** /order/orders/{order_id}/resend_receipt | Resend receipt
|
350
358
|
*UltracartClient::OrderApi* | [**resend_shipment_confirmation**](docs/OrderApi.md#resend_shipment_confirmation) | **POST** /order/orders/{order_id}/resend_shipment_confirmation | Resend shipment confirmation
|
359
|
+
*UltracartClient::OrderApi* | [**unblock_refund_on_order**](docs/OrderApi.md#unblock_refund_on_order) | **POST** /order/orders/{order_id}/refund_unblock | Remove a refund block on an order
|
351
360
|
*UltracartClient::OrderApi* | [**update_accounts_receivable_retry_config**](docs/OrderApi.md#update_accounts_receivable_retry_config) | **POST** /order/accountsReceivableRetryConfig | Update A/R Retry Configuration
|
352
361
|
*UltracartClient::OrderApi* | [**update_order**](docs/OrderApi.md#update_order) | **PUT** /order/orders/{order_id} | Update an order
|
353
362
|
*UltracartClient::OrderApi* | [**validate_order**](docs/OrderApi.md#validate_order) | **POST** /order/validate | Validate
|
@@ -901,6 +910,16 @@ Class | Method | HTTP request | Description
|
|
901
910
|
- [UltracartClient::CouponsRequest](docs/CouponsRequest.md)
|
902
911
|
- [UltracartClient::CouponsResponse](docs/CouponsResponse.md)
|
903
912
|
- [UltracartClient::Currency](docs/Currency.md)
|
913
|
+
- [UltracartClient::CustomReport](docs/CustomReport.md)
|
914
|
+
- [UltracartClient::CustomReportAccountConfig](docs/CustomReportAccountConfig.md)
|
915
|
+
- [UltracartClient::CustomReportAccountConfigResponse](docs/CustomReportAccountConfigResponse.md)
|
916
|
+
- [UltracartClient::CustomReportExecutionParameter](docs/CustomReportExecutionParameter.md)
|
917
|
+
- [UltracartClient::CustomReportExecutionRequest](docs/CustomReportExecutionRequest.md)
|
918
|
+
- [UltracartClient::CustomReportParameter](docs/CustomReportParameter.md)
|
919
|
+
- [UltracartClient::CustomReportParameterOption](docs/CustomReportParameterOption.md)
|
920
|
+
- [UltracartClient::CustomReportQuery](docs/CustomReportQuery.md)
|
921
|
+
- [UltracartClient::CustomReportResponse](docs/CustomReportResponse.md)
|
922
|
+
- [UltracartClient::CustomReportTooltip](docs/CustomReportTooltip.md)
|
904
923
|
- [UltracartClient::Customer](docs/Customer.md)
|
905
924
|
- [UltracartClient::CustomerActivity](docs/CustomerActivity.md)
|
906
925
|
- [UltracartClient::CustomerAffiliate](docs/CustomerAffiliate.md)
|
@@ -1532,6 +1551,8 @@ Not every change is committed to every SDK.
|
|
1532
1551
|
|
1533
1552
|
| Version | Date | Comments |
|
1534
1553
|
| --: | :-: | --- |
|
1554
|
+
| 3.11.15 | 07/28/2025 | new order methods for blocking and unblocking refunds |
|
1555
|
+
| 3.11.14 | 07/10/2025 | automation test |
|
1535
1556
|
| 3.11.13 | 05/20/2025 | conversation - virtual agent flag and virtual agent cost |
|
1536
1557
|
| 3.11.12 | 05/19/2025 | conversations - AI agent capabilities method |
|
1537
1558
|
| 3.11.11 | 05/19/2025 | conversations - virtual AI budgets |
|
data/docs/CartUpsellAfter.md
CHANGED
@@ -5,6 +5,8 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**finalize_after_dts** | **String** | The date/time after which the cart will finalize into an order. | [optional]
|
7
7
|
**finalize_after_minutes** | **Integer** | The amount of inactivity in minutes after which the cart should be finalized into an order. This will calculate the finalize_after_dts field. | [optional]
|
8
|
-
**upsell_path_code** | **String** | Upsell path code | [optional]
|
8
|
+
**upsell_path_code** | **String** | Upsell path code (this is for legacy upsells only) | [optional]
|
9
|
+
**upsell_path_name** | **String** | Upsell path name to start on (StoreFront Upsells). Will only be respected on a handoff API call. | [optional]
|
10
|
+
**upsell_path_variation** | **String** | Upsell path variation to start on (StoreFront Upsells). Will only be respected on a handoff API call. | [optional]
|
9
11
|
|
10
12
|
|
@@ -8,6 +8,8 @@ Name | Type | Description | Notes
|
|
8
8
|
**lookup_order_information** | **BOOLEAN** | | [optional]
|
9
9
|
**lookup_subscription_information** | **BOOLEAN** | | [optional]
|
10
10
|
**open_support_ticket** | **BOOLEAN** | | [optional]
|
11
|
+
**open_support_ticket_channel** | **String** | Channel to use to open the support ticket | [optional]
|
12
|
+
**open_support_ticket_channel_email** | **String** | Email to send support ticket to | [optional]
|
11
13
|
**pause_subscription** | **BOOLEAN** | | [optional]
|
12
14
|
**resume_subscription** | **BOOLEAN** | | [optional]
|
13
15
|
**transfer_chat_to_live_agent** | **BOOLEAN** | | [optional]
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# UltracartClient::CustomReport
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**chart_javascript** | **String** | | [optional]
|
7
|
+
**chart_javascript_url** | **String** | | [optional]
|
8
|
+
**data_warehouse_report_config_oid** | **Integer** | | [optional]
|
9
|
+
**dataset_security_level** | **String** | | [optional]
|
10
|
+
**group_name** | **String** | | [optional]
|
11
|
+
**merchant_id** | **String** | | [optional]
|
12
|
+
**name** | **String** | | [optional]
|
13
|
+
**parameters** | [**Array<CustomReportParameter>**](CustomReportParameter.md) | | [optional]
|
14
|
+
**queries** | [**Array<CustomReportQuery>**](CustomReportQuery.md) | | [optional]
|
15
|
+
**tooltips** | [**Array<CustomReportTooltip>**](CustomReportTooltip.md) | | [optional]
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# UltracartClient::CustomReportAccountConfig
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**ai_budget** | **Float** | | [optional]
|
7
|
+
**ai_usage** | **Float** | Current AI usage creating reports | [optional]
|
8
|
+
**merchant_id** | **String** | Current BigQuery SQL usage running reports | [optional]
|
9
|
+
**novice_sql_comments** | **BOOLEAN** | | [optional]
|
10
|
+
**opt_in** | **BOOLEAN** | True if they have opted into custom reports | [optional]
|
11
|
+
**opt_in_by_user** | **String** | User that opted into custom reporting | [optional]
|
12
|
+
**opt_in_date** | **String** | Date/time that custom reporting was opted in to | [optional]
|
13
|
+
**sql_budget** | **Float** | | [optional]
|
14
|
+
**sql_usage** | **Float** | | [optional]
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::CustomReportAccountConfigResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**account_config** | [**CustomReportAccountConfig**](CustomReportAccountConfig.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,10 @@
|
|
1
|
+
# UltracartClient::CustomReportExecutionParameter
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | | [optional]
|
7
|
+
**type** | **String** | | [optional]
|
8
|
+
**value** | **String** | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# UltracartClient::CustomReportExecutionRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**parameters** | [**Array<CustomReportExecutionParameter>**](CustomReportExecutionParameter.md) | | [optional]
|
7
|
+
|
8
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# UltracartClient::CustomReportParameter
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**display_name** | **String** | | [optional]
|
7
|
+
**meta** | **String** | | [optional]
|
8
|
+
**name** | **String** | | [optional]
|
9
|
+
**options** | [**Array<CustomReportParameterOption>**](CustomReportParameterOption.md) | | [optional]
|
10
|
+
**required** | **BOOLEAN** | | [optional]
|
11
|
+
**type** | **String** | | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# UltracartClient::CustomReportQuery
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**conditional_formatting_start_column** | **Integer** | | [optional]
|
7
|
+
**freeze_columns** | **Integer** | | [optional]
|
8
|
+
**pii_columns** | **Array<String>** | | [optional]
|
9
|
+
**query** | **String** | | [optional]
|
10
|
+
**sheet_name** | **String** | | [optional]
|
11
|
+
**title** | **String** | | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::CustomReportResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
8
|
+
**report** | [**CustomReport**](CustomReport.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
data/docs/DatawarehouseApi.md
CHANGED
@@ -4,18 +4,74 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
+
[**delete_custom_report**](DatawarehouseApi.md#delete_custom_report) | **DELETE** /datawarehouse/custom_reports/{custom_report_oid} | Delete a custom report
|
7
8
|
[**delete_report**](DatawarehouseApi.md#delete_report) | **DELETE** /datawarehouse/reports/{report_oid} | Delete a report
|
8
9
|
[**dry_run_report_queries**](DatawarehouseApi.md#dry_run_report_queries) | **PUT** /datawarehouse/reports/dryrun | Dry run the report queries
|
10
|
+
[**execute_custom_report**](DatawarehouseApi.md#execute_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid}/execute | Execute a custom report
|
9
11
|
[**execute_report_queries**](DatawarehouseApi.md#execute_report_queries) | **PUT** /datawarehouse/reports/execute | Execute the report queries
|
12
|
+
[**get_custom_report**](DatawarehouseApi.md#get_custom_report) | **GET** /datawarehouse/custom_reports/{custom_report_oid} | Get a custom report
|
13
|
+
[**get_custom_report_account_config**](DatawarehouseApi.md#get_custom_report_account_config) | **GET** /datawarehouse/custom_reports/account_config | Get custom report account configuration
|
10
14
|
[**get_report**](DatawarehouseApi.md#get_report) | **GET** /datawarehouse/reports/{report_oid} | Get a report
|
11
15
|
[**get_report_data_set**](DatawarehouseApi.md#get_report_data_set) | **GET** /datawarehouse/reports/dataset/{dataset_uuid} | Get a report data set
|
12
16
|
[**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
|
13
17
|
[**get_report_websocket_authorization**](DatawarehouseApi.md#get_report_websocket_authorization) | **PUT** /datawarehouse/reports/auth | Get report websocket authorization
|
14
18
|
[**get_reports**](DatawarehouseApi.md#get_reports) | **GET** /datawarehouse/reports | Get list of reports available
|
19
|
+
[**insert_custom_report**](DatawarehouseApi.md#insert_custom_report) | **POST** /datawarehouse/custom_reports | Create a custom report
|
15
20
|
[**insert_report**](DatawarehouseApi.md#insert_report) | **POST** /datawarehouse/reports | Create a report
|
21
|
+
[**update_custom_report**](DatawarehouseApi.md#update_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid} | Update a custom report
|
22
|
+
[**update_custom_report_account_config**](DatawarehouseApi.md#update_custom_report_account_config) | **PUT** /datawarehouse/custom_reports/account_config | Update custom report account config
|
16
23
|
[**update_report**](DatawarehouseApi.md#update_report) | **PUT** /datawarehouse/reports/{report_oid} | Update a report
|
17
24
|
|
18
25
|
|
26
|
+
# **delete_custom_report**
|
27
|
+
> delete_custom_report(custom_report_oid)
|
28
|
+
|
29
|
+
Delete a custom report
|
30
|
+
|
31
|
+
Delete a custom report on the UltraCart account.
|
32
|
+
|
33
|
+
### Example
|
34
|
+
```ruby
|
35
|
+
# load the gem
|
36
|
+
require 'ultracart_api'
|
37
|
+
|
38
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
39
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
40
|
+
api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
|
41
|
+
|
42
|
+
|
43
|
+
custom_report_oid = 56 # Integer | The report oid to delete.
|
44
|
+
|
45
|
+
|
46
|
+
begin
|
47
|
+
#Delete a custom report
|
48
|
+
api_instance.delete_custom_report(custom_report_oid)
|
49
|
+
rescue UltracartClient::ApiError => e
|
50
|
+
puts "Exception when calling DatawarehouseApi->delete_custom_report: #{e}"
|
51
|
+
end
|
52
|
+
```
|
53
|
+
|
54
|
+
### Parameters
|
55
|
+
|
56
|
+
Name | Type | Description | Notes
|
57
|
+
------------- | ------------- | ------------- | -------------
|
58
|
+
**custom_report_oid** | **Integer**| The report oid to delete. |
|
59
|
+
|
60
|
+
### Return type
|
61
|
+
|
62
|
+
nil (empty response body)
|
63
|
+
|
64
|
+
### Authorization
|
65
|
+
|
66
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
67
|
+
|
68
|
+
### HTTP request headers
|
69
|
+
|
70
|
+
- **Content-Type**: application/json
|
71
|
+
- **Accept**: application/json
|
72
|
+
|
73
|
+
|
74
|
+
|
19
75
|
# **delete_report**
|
20
76
|
> delete_report(report_oid)
|
21
77
|
|
@@ -115,6 +171,59 @@ Name | Type | Description | Notes
|
|
115
171
|
|
116
172
|
|
117
173
|
|
174
|
+
# **execute_custom_report**
|
175
|
+
> CustomReportResponse execute_custom_report(execution_request, custom_report_oid)
|
176
|
+
|
177
|
+
Execute a custom report
|
178
|
+
|
179
|
+
Execute a custom report on the UltraCart account.
|
180
|
+
|
181
|
+
### Example
|
182
|
+
```ruby
|
183
|
+
# load the gem
|
184
|
+
require 'ultracart_api'
|
185
|
+
|
186
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
187
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
188
|
+
api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
|
189
|
+
|
190
|
+
|
191
|
+
execution_request = UltracartClient::CustomReportExecutionRequest.new # CustomReportExecutionRequest | Request to execute custom report
|
192
|
+
|
193
|
+
custom_report_oid = 56 # Integer | The report oid to execute.
|
194
|
+
|
195
|
+
|
196
|
+
begin
|
197
|
+
#Execute a custom report
|
198
|
+
result = api_instance.execute_custom_report(execution_request, custom_report_oid)
|
199
|
+
p result
|
200
|
+
rescue UltracartClient::ApiError => e
|
201
|
+
puts "Exception when calling DatawarehouseApi->execute_custom_report: #{e}"
|
202
|
+
end
|
203
|
+
```
|
204
|
+
|
205
|
+
### Parameters
|
206
|
+
|
207
|
+
Name | Type | Description | Notes
|
208
|
+
------------- | ------------- | ------------- | -------------
|
209
|
+
**execution_request** | [**CustomReportExecutionRequest**](CustomReportExecutionRequest.md)| Request to execute custom report |
|
210
|
+
**custom_report_oid** | **Integer**| The report oid to execute. |
|
211
|
+
|
212
|
+
### Return type
|
213
|
+
|
214
|
+
[**CustomReportResponse**](CustomReportResponse.md)
|
215
|
+
|
216
|
+
### Authorization
|
217
|
+
|
218
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
219
|
+
|
220
|
+
### HTTP request headers
|
221
|
+
|
222
|
+
- **Content-Type**: application/json; charset=UTF-8
|
223
|
+
- **Accept**: application/json
|
224
|
+
|
225
|
+
|
226
|
+
|
118
227
|
# **execute_report_queries**
|
119
228
|
> execute_report_queries(query_request)
|
120
229
|
|
@@ -164,6 +273,101 @@ nil (empty response body)
|
|
164
273
|
|
165
274
|
|
166
275
|
|
276
|
+
# **get_custom_report**
|
277
|
+
> CustomReportResponse get_custom_report(custom_report_oid)
|
278
|
+
|
279
|
+
Get a custom report
|
280
|
+
|
281
|
+
Retrieve a custom report
|
282
|
+
|
283
|
+
### Example
|
284
|
+
```ruby
|
285
|
+
# load the gem
|
286
|
+
require 'ultracart_api'
|
287
|
+
|
288
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
289
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
290
|
+
api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
|
291
|
+
|
292
|
+
|
293
|
+
custom_report_oid = 56 # Integer |
|
294
|
+
|
295
|
+
|
296
|
+
begin
|
297
|
+
#Get a custom report
|
298
|
+
result = api_instance.get_custom_report(custom_report_oid)
|
299
|
+
p result
|
300
|
+
rescue UltracartClient::ApiError => e
|
301
|
+
puts "Exception when calling DatawarehouseApi->get_custom_report: #{e}"
|
302
|
+
end
|
303
|
+
```
|
304
|
+
|
305
|
+
### Parameters
|
306
|
+
|
307
|
+
Name | Type | Description | Notes
|
308
|
+
------------- | ------------- | ------------- | -------------
|
309
|
+
**custom_report_oid** | **Integer**| |
|
310
|
+
|
311
|
+
### Return type
|
312
|
+
|
313
|
+
[**CustomReportResponse**](CustomReportResponse.md)
|
314
|
+
|
315
|
+
### Authorization
|
316
|
+
|
317
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
318
|
+
|
319
|
+
### HTTP request headers
|
320
|
+
|
321
|
+
- **Content-Type**: application/json
|
322
|
+
- **Accept**: application/json
|
323
|
+
|
324
|
+
|
325
|
+
|
326
|
+
# **get_custom_report_account_config**
|
327
|
+
> CustomReportAccountConfigResponse get_custom_report_account_config
|
328
|
+
|
329
|
+
Get custom report account configuration
|
330
|
+
|
331
|
+
Retrieve a custom report account configuration
|
332
|
+
|
333
|
+
### Example
|
334
|
+
```ruby
|
335
|
+
# load the gem
|
336
|
+
require 'ultracart_api'
|
337
|
+
|
338
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
339
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
340
|
+
api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
|
341
|
+
|
342
|
+
|
343
|
+
|
344
|
+
begin
|
345
|
+
#Get custom report account configuration
|
346
|
+
result = api_instance.get_custom_report_account_config
|
347
|
+
p result
|
348
|
+
rescue UltracartClient::ApiError => e
|
349
|
+
puts "Exception when calling DatawarehouseApi->get_custom_report_account_config: #{e}"
|
350
|
+
end
|
351
|
+
```
|
352
|
+
|
353
|
+
### Parameters
|
354
|
+
This endpoint does not need any parameter.
|
355
|
+
|
356
|
+
### Return type
|
357
|
+
|
358
|
+
[**CustomReportAccountConfigResponse**](CustomReportAccountConfigResponse.md)
|
359
|
+
|
360
|
+
### Authorization
|
361
|
+
|
362
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
363
|
+
|
364
|
+
### HTTP request headers
|
365
|
+
|
366
|
+
- **Content-Type**: application/json
|
367
|
+
- **Accept**: application/json
|
368
|
+
|
369
|
+
|
370
|
+
|
167
371
|
# **get_report**
|
168
372
|
> ReportResponse get_report(report_oid)
|
169
373
|
|
@@ -407,6 +611,56 @@ This endpoint does not need any parameter.
|
|
407
611
|
|
408
612
|
|
409
613
|
|
614
|
+
# **insert_custom_report**
|
615
|
+
> CustomReportResponse insert_custom_report(report)
|
616
|
+
|
617
|
+
Create a custom report
|
618
|
+
|
619
|
+
Create a new custom report on the UltraCart account.
|
620
|
+
|
621
|
+
### Example
|
622
|
+
```ruby
|
623
|
+
# load the gem
|
624
|
+
require 'ultracart_api'
|
625
|
+
|
626
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
627
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
628
|
+
api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
|
629
|
+
|
630
|
+
|
631
|
+
report = UltracartClient::CustomReport.new # CustomReport | Report to create
|
632
|
+
|
633
|
+
|
634
|
+
begin
|
635
|
+
#Create a custom report
|
636
|
+
result = api_instance.insert_custom_report(report)
|
637
|
+
p result
|
638
|
+
rescue UltracartClient::ApiError => e
|
639
|
+
puts "Exception when calling DatawarehouseApi->insert_custom_report: #{e}"
|
640
|
+
end
|
641
|
+
```
|
642
|
+
|
643
|
+
### Parameters
|
644
|
+
|
645
|
+
Name | Type | Description | Notes
|
646
|
+
------------- | ------------- | ------------- | -------------
|
647
|
+
**report** | [**CustomReport**](CustomReport.md)| Report to create |
|
648
|
+
|
649
|
+
### Return type
|
650
|
+
|
651
|
+
[**CustomReportResponse**](CustomReportResponse.md)
|
652
|
+
|
653
|
+
### Authorization
|
654
|
+
|
655
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
656
|
+
|
657
|
+
### HTTP request headers
|
658
|
+
|
659
|
+
- **Content-Type**: application/json; charset=UTF-8
|
660
|
+
- **Accept**: application/json
|
661
|
+
|
662
|
+
|
663
|
+
|
410
664
|
# **insert_report**
|
411
665
|
> ReportResponse insert_report(report)
|
412
666
|
|
@@ -457,6 +711,109 @@ Name | Type | Description | Notes
|
|
457
711
|
|
458
712
|
|
459
713
|
|
714
|
+
# **update_custom_report**
|
715
|
+
> CustomReportResponse update_custom_report(report, custom_report_oid)
|
716
|
+
|
717
|
+
Update a custom report
|
718
|
+
|
719
|
+
Update a custom report on the UltraCart account.
|
720
|
+
|
721
|
+
### Example
|
722
|
+
```ruby
|
723
|
+
# load the gem
|
724
|
+
require 'ultracart_api'
|
725
|
+
|
726
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
727
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
728
|
+
api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
|
729
|
+
|
730
|
+
|
731
|
+
report = UltracartClient::CustomReport.new # CustomReport | Report to custom update
|
732
|
+
|
733
|
+
custom_report_oid = 56 # Integer | The report oid to custom update.
|
734
|
+
|
735
|
+
|
736
|
+
begin
|
737
|
+
#Update a custom report
|
738
|
+
result = api_instance.update_custom_report(report, custom_report_oid)
|
739
|
+
p result
|
740
|
+
rescue UltracartClient::ApiError => e
|
741
|
+
puts "Exception when calling DatawarehouseApi->update_custom_report: #{e}"
|
742
|
+
end
|
743
|
+
```
|
744
|
+
|
745
|
+
### Parameters
|
746
|
+
|
747
|
+
Name | Type | Description | Notes
|
748
|
+
------------- | ------------- | ------------- | -------------
|
749
|
+
**report** | [**CustomReport**](CustomReport.md)| Report to custom update |
|
750
|
+
**custom_report_oid** | **Integer**| The report oid to custom update. |
|
751
|
+
|
752
|
+
### Return type
|
753
|
+
|
754
|
+
[**CustomReportResponse**](CustomReportResponse.md)
|
755
|
+
|
756
|
+
### Authorization
|
757
|
+
|
758
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
759
|
+
|
760
|
+
### HTTP request headers
|
761
|
+
|
762
|
+
- **Content-Type**: application/json; charset=UTF-8
|
763
|
+
- **Accept**: application/json
|
764
|
+
|
765
|
+
|
766
|
+
|
767
|
+
# **update_custom_report_account_config**
|
768
|
+
> CustomReportAccountConfigResponse update_custom_report_account_config(account_config)
|
769
|
+
|
770
|
+
Update custom report account config
|
771
|
+
|
772
|
+
Update custom report account config.
|
773
|
+
|
774
|
+
### Example
|
775
|
+
```ruby
|
776
|
+
# load the gem
|
777
|
+
require 'ultracart_api'
|
778
|
+
|
779
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
780
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
781
|
+
api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
|
782
|
+
|
783
|
+
|
784
|
+
account_config = UltracartClient::CustomReportAccountConfig.new # CustomReportAccountConfig | Account config to update
|
785
|
+
|
786
|
+
|
787
|
+
begin
|
788
|
+
#Update custom report account config
|
789
|
+
result = api_instance.update_custom_report_account_config(account_config)
|
790
|
+
p result
|
791
|
+
rescue UltracartClient::ApiError => e
|
792
|
+
puts "Exception when calling DatawarehouseApi->update_custom_report_account_config: #{e}"
|
793
|
+
end
|
794
|
+
```
|
795
|
+
|
796
|
+
### Parameters
|
797
|
+
|
798
|
+
Name | Type | Description | Notes
|
799
|
+
------------- | ------------- | ------------- | -------------
|
800
|
+
**account_config** | [**CustomReportAccountConfig**](CustomReportAccountConfig.md)| Account config to update |
|
801
|
+
|
802
|
+
### Return type
|
803
|
+
|
804
|
+
[**CustomReportAccountConfigResponse**](CustomReportAccountConfigResponse.md)
|
805
|
+
|
806
|
+
### Authorization
|
807
|
+
|
808
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
809
|
+
|
810
|
+
### HTTP request headers
|
811
|
+
|
812
|
+
- **Content-Type**: application/json; charset=UTF-8
|
813
|
+
- **Accept**: application/json
|
814
|
+
|
815
|
+
|
816
|
+
|
460
817
|
# **update_report**
|
461
818
|
> ReportResponse update_report(report, report_oid)
|
462
819
|
|