ultracart_api 3.10.123 → 3.10.125
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +37 -4
- data/docs/DatawarehouseApi.md +461 -0
- data/docs/OrderRefundableResponse.md +1 -0
- data/docs/Report.md +17 -0
- data/docs/ReportAuth.md +11 -0
- data/docs/ReportAuthResponse.md +12 -0
- data/docs/ReportDataSet.md +22 -0
- data/docs/ReportDataSetColumn.md +8 -0
- data/docs/ReportDataSetPage.md +17 -0
- data/docs/ReportDataSetPageResponse.md +12 -0
- data/docs/ReportDataSetQuery.md +19 -0
- data/docs/ReportDataSetResponse.md +12 -0
- data/docs/ReportDataSetRow.md +8 -0
- data/docs/ReportDataSetSchema.md +9 -0
- data/docs/ReportDataSource.md +13 -0
- data/docs/ReportDataSourceSchema.md +10 -0
- data/docs/ReportExecuteQueriesRequest.md +14 -0
- data/docs/ReportFilter.md +13 -0
- data/docs/ReportFilterConnection.md +9 -0
- data/docs/ReportPage.md +11 -0
- data/docs/ReportPageVisualization.md +16 -0
- data/docs/ReportPageVisualizationDimension.md +14 -0
- data/docs/ReportPageVisualizationMetric.md +11 -0
- data/docs/ReportResponse.md +12 -0
- data/docs/ReportsResponse.md +12 -0
- data/lib/ultracart_api/api/datawarehouse_api.rb +529 -0
- data/lib/ultracart_api/models/order_refundable_response.rb +11 -1
- data/lib/ultracart_api/models/report.rb +307 -0
- data/lib/ultracart_api/models/report_auth.rb +212 -0
- data/lib/ultracart_api/models/report_auth_response.rb +221 -0
- data/lib/ultracart_api/models/report_data_set.rb +362 -0
- data/lib/ultracart_api/models/report_data_set_column.rb +184 -0
- data/lib/ultracart_api/models/report_data_set_page.rb +273 -0
- data/lib/ultracart_api/models/report_data_set_page_response.rb +221 -0
- data/lib/ultracart_api/models/report_data_set_query.rb +330 -0
- data/lib/ultracart_api/models/report_data_set_response.rb +221 -0
- data/lib/ultracart_api/models/report_data_set_row.rb +186 -0
- data/lib/ultracart_api/models/report_data_set_schema.rb +228 -0
- data/lib/ultracart_api/models/report_data_source.rb +232 -0
- data/lib/ultracart_api/models/report_data_source_schema.rb +238 -0
- data/lib/ultracart_api/models/report_execute_queries_request.rb +278 -0
- data/lib/ultracart_api/models/report_filter.rb +272 -0
- data/lib/ultracart_api/models/report_filter_connection.rb +193 -0
- data/lib/ultracart_api/models/report_page.rb +216 -0
- data/lib/ultracart_api/models/report_page_visualization.rb +299 -0
- data/lib/ultracart_api/models/report_page_visualization_dimension.rb +244 -0
- data/lib/ultracart_api/models/report_page_visualization_metric.rb +248 -0
- data/lib/ultracart_api/models/report_response.rb +221 -0
- data/lib/ultracart_api/models/reports_response.rb +223 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +23 -0
- metadata +48 -2
@@ -0,0 +1,19 @@
|
|
1
|
+
# UltracartClient::ReportDataSetQuery
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**comparison_results** | **BOOLEAN** | True if a date range filter is provided with comparison date ranges and two results should be returned for the query. | [optional]
|
7
|
+
**data_set_query_uuid** | **String** | A unique identifier assigned to the data set query that is returned. | [optional]
|
8
|
+
**data_source** | [**ReportDataSource**](ReportDataSource.md) | | [optional]
|
9
|
+
**dimensions** | [**Array<ReportPageVisualizationDimension>**](ReportPageVisualizationDimension.md) | | [optional]
|
10
|
+
**filter** | [**ReportFilter**](ReportFilter.md) | | [optional]
|
11
|
+
**for_object_id** | **String** | An identifier that can be used to help match up the returned data set | [optional]
|
12
|
+
**for_object_type** | **String** | The type of object this data set is for | [optional]
|
13
|
+
**metrics** | [**Array<ReportPageVisualizationMetric>**](ReportPageVisualizationMetric.md) | | [optional]
|
14
|
+
**page_size** | **Integer** | Result set page size. The default value is 200 records. Max is 10000. | [optional]
|
15
|
+
**selected_filters** | [**Array<ReportFilter>**](ReportFilter.md) | | [optional]
|
16
|
+
**skip_cache** | **BOOLEAN** | True if the 15 minute cache should be skipped. | [optional]
|
17
|
+
**user_data** | **String** | Any other data that needs to be returned with the response to help the UI | [optional]
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ReportDataSetResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**data_set** | [**ReportDataSet**](ReportDataSet.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,13 @@
|
|
1
|
+
# UltracartClient::ReportDataSource
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | | [optional]
|
7
|
+
**partition_date_column** | **String** | | [optional]
|
8
|
+
**partition_date_safety_days** | **Integer** | | [optional]
|
9
|
+
**partition_date_strategy** | **String** | The partition date strategy, defaults to weekly sunday | [optional]
|
10
|
+
**schema** | [**Array<ReportDataSourceSchema>**](ReportDataSourceSchema.md) | | [optional]
|
11
|
+
**sql** | **String** | | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# UltracartClient::ReportDataSourceSchema
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**dimension** | **BOOLEAN** | Whether or not this column can be used as a dimension within a visualization | [optional]
|
7
|
+
**name** | **String** | | [optional]
|
8
|
+
**type** | **String** | Type of the column. Only supporting the allowed values. Any other types will be ignored. | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# UltracartClient::ReportExecuteQueriesRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**client_uuid** | **String** | Unique UUID assigned to this client during the auth. This will be used to locate the websocket connect id. | [optional]
|
7
|
+
**connection_id** | **String** | The websocket connection id that should receive back notices of query completion. | [optional]
|
8
|
+
**default_dataset_id** | **String** | | [optional]
|
9
|
+
**default_project_id** | **String** | | [optional]
|
10
|
+
**merchant_id** | **String** | | [optional]
|
11
|
+
**queries** | [**Array<ReportDataSetQuery>**](ReportDataSetQuery.md) | An array of queries that we want the lambda function to execute. | [optional]
|
12
|
+
**security_level** | **String** | Security level to execute report under | [optional]
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# UltracartClient::ReportFilter
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**connections** | [**Array<ReportFilterConnection>**](ReportFilterConnection.md) | How this filter connects to the data sources and columns | [optional]
|
7
|
+
**name** | **String** | | [optional]
|
8
|
+
**timezone** | **String** | The timezone that the date range is querying on. | [optional]
|
9
|
+
**type** | **String** | Type of filter | [optional]
|
10
|
+
**uuid** | **String** | Unique UUID assigned to the filter. Assists when returning values that the filter can use. | [optional]
|
11
|
+
**values** | **Array<String>** | The selected values for the filter. When used, some type conversion will need to occur. | [optional]
|
12
|
+
|
13
|
+
|
data/docs/ReportPage.md
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
# UltracartClient::ReportPage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**height** | **Float** | Height of the report page in inches | [optional]
|
7
|
+
**title** | **String** | | [optional]
|
8
|
+
**visualizations** | [**Array<ReportPageVisualization>**](ReportPageVisualization.md) | Visualizations on the report page. | [optional]
|
9
|
+
**width** | **Float** | Width of the report page in inches | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# UltracartClient::ReportPageVisualization
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**config** | **String** | A JSON representation of the configuration for this visualization | [optional]
|
7
|
+
**data_source_name** | **String** | | [optional]
|
8
|
+
**dimensions** | [**Array<ReportPageVisualizationDimension>**](ReportPageVisualizationDimension.md) | | [optional]
|
9
|
+
**metrics** | [**Array<ReportPageVisualizationMetric>**](ReportPageVisualizationMetric.md) | | [optional]
|
10
|
+
**name** | **String** | | [optional]
|
11
|
+
**show_comparison** | **BOOLEAN** | True if the visualization should show a comparison based upon the date range | [optional]
|
12
|
+
**styles** | **String** | A JSON representation of the style configuration for this visualization | [optional]
|
13
|
+
**type** | **String** | Type of visualization | [optional]
|
14
|
+
**visualization_uuid** | **String** | A UUID for the visualization | [optional]
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# UltracartClient::ReportPageVisualizationDimension
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**as** | **String** | Return the column as a different name | [optional]
|
7
|
+
**cast** | **String** | Cast the column to a different data type such as DATETIME -> DATE | [optional]
|
8
|
+
**column** | **String** | | [optional]
|
9
|
+
**datetime_timezone** | **String** | The timezone to shift the date to | [optional]
|
10
|
+
**datetime_trunc** | **String** | The type of truncation to perform on the date, DAY, WEEK(MONDAY), etc. | [optional]
|
11
|
+
**extract** | **String** | Part of a datetime to extract | [optional]
|
12
|
+
**function** | **String** | The function to perform around the column such as DATE_TRUNC(@column, day) | [optional]
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# UltracartClient::ReportPageVisualizationMetric
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**aggregation** | **String** | Aggregation to perform | [optional]
|
7
|
+
**as** | **String** | Return the column as a different name | [optional]
|
8
|
+
**column** | **String** | | [optional]
|
9
|
+
**round** | **Integer** | Number of places after the decimal point to round the number to. | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ReportResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
8
|
+
**report** | [**Report**](Report.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::ReportsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
8
|
+
**reports** | [**Array<Report>**](Report.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|