ultracart_api 4.0.140 → 4.0.142

data/docs/ReportAuth.md

@@ -0,0 +1,24 @@
+# UltracartClient::ReportAuth
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_uuid** | **String** | Unique UUID assigned to this client | [optional] |
+| **jwt** | **String** |  | [optional] |
+| **merchant_id** | **String** |  | [optional] |
+| **websocket_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ReportAuth.new(
+  client_uuid: null,
+  jwt: null,
+  merchant_id: null,
+  websocket_url: null
+)
+```
+

data/docs/ReportAuthResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ReportAuthResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **report_auth** | [**ReportAuth**](ReportAuth.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ReportAuthResponse.new(
+  error: null,
+  metadata: null,
+  report_auth: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ReportDataSet.md

@@ -0,0 +1,46 @@
+# UltracartClient::ReportDataSet
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data_set_query_uuid** | **String** | A unique identifier assigned to the data set query that is returned. | [optional] |
+| **data_set_uuid** | **String** | A unique identifier assigned to the data set that is returned. | [optional] |
+| **destination_table_id** | **String** | The BigQuery destination table id that contains the result. | [optional] |
+| **error_message** | **String** | Error message if the query failed. | [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] |
+| **initial_pages** | [**Array<ReportDataSetPage>**](ReportDataSetPage.md) | Initial pages returned in the dataset | [optional] |
+| **max_results** | **Integer** | The total number of results | [optional] |
+| **merchant_id** | **String** | Merchant that owns this data set | [optional] |
+| **page_count** | **Integer** | The size of the pages | [optional] |
+| **page_size** | **Integer** | The size of the pages | [optional] |
+| **schema** | [**Array<ReportDataSetSchema>**](ReportDataSetSchema.md) | The schema associated with the data set. | [optional] |
+| **security_level** | **String** | Security level this dataset was read from. | [optional] |
+| **timezone** | **String** |  | [optional] |
+| **user_data** | **String** | Any other data that needs to be returned with the response to help the UI | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ReportDataSet.new(
+  data_set_query_uuid: null,
+  data_set_uuid: null,
+  destination_table_id: null,
+  error_message: null,
+  for_object_id: null,
+  for_object_type: null,
+  initial_pages: null,
+  max_results: null,
+  merchant_id: null,
+  page_count: null,
+  page_size: null,
+  schema: null,
+  security_level: null,
+  timezone: null,
+  user_data: null
+)
+```
+

data/docs/ReportDataSetColumn.md

@@ -0,0 +1,18 @@
+# UltracartClient::ReportDataSetColumn
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ReportDataSetColumn.new(
+  name: null
+)
+```
+

data/docs/ReportDataSetPage.md

@@ -0,0 +1,36 @@
+# UltracartClient::ReportDataSetPage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data_set_uuid** | **String** | A unique identifier assigned to the data set that is returned. | [optional] |
+| **merchant_id** | **String** | Merchant that owns this data set | [optional] |
+| **next_page_token** | **String** |  | [optional] |
+| **next_start_index** | **Integer** |  | [optional] |
+| **page_number** | **Integer** |  | [optional] |
+| **row_count** | **Integer** |  | [optional] |
+| **rows** | [**Array<ReportDataSetRow>**](ReportDataSetRow.md) | Rows returned for the data set | [optional] |
+| **rows_s3_url** | **String** | Signed S3 URL where the page rows can be downloaded from | [optional] |
+| **start_index** | **Integer** | Zero based index of the starting row | [optional] |
+| **table_id** | **String** | The BigQuery destination table id that contains the result. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ReportDataSetPage.new(
+  data_set_uuid: null,
+  merchant_id: null,
+  next_page_token: null,
+  next_start_index: null,
+  page_number: null,
+  row_count: null,
+  rows: null,
+  rows_s3_url: null,
+  start_index: null,
+  table_id: null
+)
+```
+

data/docs/ReportDataSetPageResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ReportDataSetPageResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **page** | [**ReportDataSetPage**](ReportDataSetPage.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ReportDataSetPageResponse.new(
+  error: null,
+  metadata: null,
+  page: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ReportDataSetQuery.md

@@ -0,0 +1,40 @@
+# 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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ReportDataSetQuery.new(
+  comparison_results: null,
+  data_set_query_uuid: null,
+  data_source: null,
+  dimensions: null,
+  filter: null,
+  for_object_id: null,
+  for_object_type: null,
+  metrics: null,
+  page_size: null,
+  selected_filters: null,
+  skip_cache: null,
+  user_data: null
+)
+```
+

data/docs/ReportDataSetResponse.md

@@ -0,0 +1,26 @@
+# 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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ReportDataSetResponse.new(
+  data_set: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ReportDataSetRow.md

@@ -0,0 +1,18 @@
+# UltracartClient::ReportDataSetRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **columns** | [**Array<ReportDataSetColumn>**](ReportDataSetColumn.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ReportDataSetRow.new(
+  columns: null
+)
+```
+

data/docs/ReportDataSetSchema.md

@@ -0,0 +1,20 @@
+# UltracartClient::ReportDataSetSchema
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **type** | **String** | Type of the column. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ReportDataSetSchema.new(
+  name: null,
+  type: null
+)
+```
+

data/docs/ReportDataSource.md

@@ -0,0 +1,28 @@
+# 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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ReportDataSource.new(
+  name: null,
+  partition_date_column: null,
+  partition_date_safety_days: null,
+  partition_date_strategy: null,
+  schema: null,
+  sql: null
+)
+```
+

data/docs/ReportDataSourceSchema.md

@@ -0,0 +1,22 @@
+# 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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ReportDataSourceSchema.new(
+  dimension: null,
+  name: null,
+  type: null
+)
+```
+

data/docs/ReportExecuteQueriesRequest.md

@@ -0,0 +1,30 @@
+# 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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ReportExecuteQueriesRequest.new(
+  client_uuid: null,
+  connection_id: null,
+  default_dataset_id: null,
+  default_project_id: null,
+  merchant_id: null,
+  queries: null,
+  security_level: null
+)
+```
+

data/docs/ReportFilter.md

@@ -0,0 +1,28 @@
+# 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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ReportFilter.new(
+  connections: null,
+  name: null,
+  timezone: null,
+  type: null,
+  uuid: null,
+  values: null
+)
+```
+

data/docs/ReportFilterConnection.md

@@ -0,0 +1,20 @@
+# UltracartClient::ReportFilterConnection
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **column** | **String** |  | [optional] |
+| **data_source_name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ReportFilterConnection.new(
+  column: null,
+  data_source_name: null
+)
+```
+

data/docs/ReportPage.md

@@ -0,0 +1,24 @@
+# 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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ReportPage.new(
+  height: null,
+  title: null,
+  visualizations: null,
+  width: null
+)
+```
+

data/docs/ReportPageVisualization.md

@@ -0,0 +1,34 @@
+# 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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ReportPageVisualization.new(
+  config: null,
+  data_source_name: null,
+  dimensions: null,
+  metrics: null,
+  name: null,
+  show_comparison: null,
+  styles: null,
+  type: null,
+  visualization_uuid: null
+)
+```
+

data/docs/ReportPageVisualizationDimension.md

@@ -0,0 +1,30 @@
+# 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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ReportPageVisualizationDimension.new(
+  as: null,
+  cast: null,
+  column: null,
+  datetime_timezone: null,
+  datetime_trunc: null,
+  extract: null,
+  function: null
+)
+```
+

data/docs/ReportPageVisualizationMetric.md

@@ -0,0 +1,24 @@
+# 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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ReportPageVisualizationMetric.new(
+  aggregation: null,
+  as: null,
+  column: null,
+  round: null
+)
+```
+

data/docs/ReportResponse.md

@@ -0,0 +1,26 @@
+# 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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ReportResponse.new(
+  error: null,
+  metadata: null,
+  report: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ReportsResponse.md

@@ -0,0 +1,26 @@
+# 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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ReportsResponse.new(
+  error: null,
+  metadata: null,
+  reports: null,
+  success: null,
+  warning: null
+)
+```
+