ultracart_api 3.10.123 → 3.10.125

data/docs/ReportDataSetQuery.md

@@ -0,0 +1,19 @@
+# UltracartClient::ReportDataSetQuery
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+**data_set_query_uuid** | **String** | A unique identifier assigned to the data set query that is returned. | [optional] 
+**data_source** | [**ReportDataSource**](ReportDataSource.md) |  | [optional] 
+**dimensions** | [**Array<ReportPageVisualizationDimension>**](ReportPageVisualizationDimension.md) |  | [optional] 
+**filter** | [**ReportFilter**](ReportFilter.md) |  | [optional] 
+**for_object_id** | **String** | An identifier that can be used to help match up the returned data set | [optional] 
+**for_object_type** | **String** | The type of object this data set is for | [optional] 
+**metrics** | [**Array<ReportPageVisualizationMetric>**](ReportPageVisualizationMetric.md) |  | [optional] 
+**page_size** | **Integer** | Result set page size.  The default value is 200 records.  Max is 10000. | [optional] 
+**selected_filters** | [**Array<ReportFilter>**](ReportFilter.md) |  | [optional] 
+**skip_cache** | **BOOLEAN** | True if the 15 minute cache should be skipped. | [optional] 
+**user_data** | **String** | Any other data that needs to be returned with the response to help the UI | [optional] 
+
+

data/docs/ReportDataSetResponse.md

@@ -0,0 +1,12 @@
+# UltracartClient::ReportDataSetResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data_set** | [**ReportDataSet**](ReportDataSet.md) |  | [optional] 
+**error** | [**Error**](Error.md) |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

data/docs/ReportDataSetRow.md

@@ -0,0 +1,8 @@
+# UltracartClient::ReportDataSetRow
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**columns** | [**Array<ReportDataSetColumn>**](ReportDataSetColumn.md) |  | [optional] 
+
+

data/docs/ReportDataSetSchema.md

@@ -0,0 +1,9 @@
+# UltracartClient::ReportDataSetSchema
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**type** | **String** | Type of the column. | [optional] 
+
+

data/docs/ReportDataSource.md

@@ -0,0 +1,13 @@
+# UltracartClient::ReportDataSource
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**partition_date_column** | **String** |  | [optional] 
+**partition_date_safety_days** | **Integer** |  | [optional] 
+**partition_date_strategy** | **String** | The partition date strategy, defaults to weekly sunday | [optional] 
+**schema** | [**Array<ReportDataSourceSchema>**](ReportDataSourceSchema.md) |  | [optional] 
+**sql** | **String** |  | [optional] 
+
+

data/docs/ReportDataSourceSchema.md

@@ -0,0 +1,10 @@
+# UltracartClient::ReportDataSourceSchema
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dimension** | **BOOLEAN** | Whether or not this column can be used as a dimension within a visualization | [optional] 
+**name** | **String** |  | [optional] 
+**type** | **String** | Type of the column.  Only supporting the allowed values.  Any other types will be ignored. | [optional] 
+
+

data/docs/ReportExecuteQueriesRequest.md

@@ -0,0 +1,14 @@
+# UltracartClient::ReportExecuteQueriesRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_uuid** | **String** | Unique UUID assigned to this client during the auth.  This will be used to locate the websocket connect id. | [optional] 
+**connection_id** | **String** | The websocket connection id that should receive back notices of query completion. | [optional] 
+**default_dataset_id** | **String** |  | [optional] 
+**default_project_id** | **String** |  | [optional] 
+**merchant_id** | **String** |  | [optional] 
+**queries** | [**Array<ReportDataSetQuery>**](ReportDataSetQuery.md) | An array of queries that we want the lambda function to execute. | [optional] 
+**security_level** | **String** | Security level to execute report under | [optional] 
+
+

data/docs/ReportFilter.md

@@ -0,0 +1,13 @@
+# UltracartClient::ReportFilter
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**connections** | [**Array<ReportFilterConnection>**](ReportFilterConnection.md) | How this filter connects to the data sources and columns | [optional] 
+**name** | **String** |  | [optional] 
+**timezone** | **String** | The timezone that the date range is querying on. | [optional] 
+**type** | **String** | Type of filter | [optional] 
+**uuid** | **String** | Unique UUID assigned to the filter.  Assists when returning values that the filter can use. | [optional] 
+**values** | **Array<String>** | The selected values for the filter.  When used, some type conversion will need to occur. | [optional] 
+
+

data/docs/ReportFilterConnection.md

@@ -0,0 +1,9 @@
+# UltracartClient::ReportFilterConnection
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**column** | **String** |  | [optional] 
+**data_source_name** | **String** |  | [optional] 
+
+

data/docs/ReportPage.md

@@ -0,0 +1,11 @@
+# UltracartClient::ReportPage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**height** | **Float** | Height of the report page in inches | [optional] 
+**title** | **String** |  | [optional] 
+**visualizations** | [**Array<ReportPageVisualization>**](ReportPageVisualization.md) | Visualizations on the report page. | [optional] 
+**width** | **Float** | Width of the report page in inches | [optional] 
+
+

data/docs/ReportPageVisualization.md

@@ -0,0 +1,16 @@
+# UltracartClient::ReportPageVisualization
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**config** | **String** | A JSON representation of the configuration for this visualization | [optional] 
+**data_source_name** | **String** |  | [optional] 
+**dimensions** | [**Array<ReportPageVisualizationDimension>**](ReportPageVisualizationDimension.md) |  | [optional] 
+**metrics** | [**Array<ReportPageVisualizationMetric>**](ReportPageVisualizationMetric.md) |  | [optional] 
+**name** | **String** |  | [optional] 
+**show_comparison** | **BOOLEAN** | True if the visualization should show a comparison based upon the date range | [optional] 
+**styles** | **String** | A JSON representation of the style configuration for this visualization | [optional] 
+**type** | **String** | Type of visualization | [optional] 
+**visualization_uuid** | **String** | A UUID for the visualization | [optional] 
+
+

data/docs/ReportPageVisualizationDimension.md

@@ -0,0 +1,14 @@
+# UltracartClient::ReportPageVisualizationDimension
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**as** | **String** | Return the column as a different name | [optional] 
+**cast** | **String** | Cast the column to a different data type such as DATETIME -> DATE | [optional] 
+**column** | **String** |  | [optional] 
+**datetime_timezone** | **String** | The timezone to shift the date to | [optional] 
+**datetime_trunc** | **String** | The type of truncation to perform on the date, DAY, WEEK(MONDAY), etc. | [optional] 
+**extract** | **String** | Part of a datetime to extract | [optional] 
+**function** | **String** | The function to perform around the column such as DATE_TRUNC(@column, day) | [optional] 
+
+

data/docs/ReportPageVisualizationMetric.md

@@ -0,0 +1,11 @@
+# UltracartClient::ReportPageVisualizationMetric
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**aggregation** | **String** | Aggregation to perform | [optional] 
+**as** | **String** | Return the column as a different name | [optional] 
+**column** | **String** |  | [optional] 
+**round** | **Integer** | Number of places after the decimal point to round the number to. | [optional] 
+
+

data/docs/ReportResponse.md

@@ -0,0 +1,12 @@
+# UltracartClient::ReportResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**Error**](Error.md) |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**report** | [**Report**](Report.md) |  | [optional] 
+**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

data/docs/ReportsResponse.md

@@ -0,0 +1,12 @@
+# UltracartClient::ReportsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**Error**](Error.md) |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**reports** | [**Array<Report>**](Report.md) |  | [optional] 
+**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+