ultracart_api 4.1.16 → 4.1.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba315b7e97b3e9067d6a15640d3cdb873006d13bd8f53f48cc2d0c40c4db11af
-  data.tar.gz: a159dbb08abcf2d9ff720194ddc58bd4206ee57978371297b0198308e45cc98e
+  metadata.gz: 608097960d36f44a87222e211204808a5e6e5d4cd424893aade7ca4b9df44a19
+  data.tar.gz: 647dcf56829dc2ad988d87819aa122dd806890ae8a4d9757cbbac8a1c28319d0
 SHA512:
-  metadata.gz: 7454402c148af2ee31f596640dce2191980bb65364017921129a8611ea360f7ee948461de64941c83be30d13dd04d5d43a3fe2577be6e4bfdfdbce7453080fa7
-  data.tar.gz: 2df955c52f353b0990ca11d1e6deb381bdf98033c45ff2ad60fc7326f2803f8540c553db78287a6b854d1241e432d361338e6dae419c65b40c064e0386d957ae
+  metadata.gz: e724414081b88762ef4e9c0b05417b5fb749df199a46f5a81d35a242ec7bfa056291acb51e253b08bf5619283a7bb5bf9fb66281b169cc6b7459b01cb0e71184
+  data.tar.gz: 35b55506a3f6c3217e0f6fd121aa376198ed22d86402479da4331ba71869396107eec2d87dfe897b053430a2f1d9b109b63f4b1a2c2a685cb08ad688f8a6cf37

data/README.md

@@ -7,7 +7,7 @@ Note: Every method has a sample for every language.  See https://github.com/Ultr
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.1.16
+- Package version: 4.1.18
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 - For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
 gemfile:
 
 ```shell
-gem 'ultracart_api', '4.1.16'
+gem 'ultracart_api', '4.1.18'
 ```
 
 install:
@@ -265,11 +265,15 @@ Class | Method | HTTP request | Description
 *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
 *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
 *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
+*UltracartClient::DatawarehouseApi* | [**delete_custom_dashboard**](docs/DatawarehouseApi.md#delete_custom_dashboard) | **DELETE** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Delete a custom dashboard
 *UltracartClient::DatawarehouseApi* | [**delete_custom_report**](docs/DatawarehouseApi.md#delete_custom_report) | **DELETE** /datawarehouse/custom_reports/{custom_report_oid} | Delete a custom report
 *UltracartClient::DatawarehouseApi* | [**delete_report**](docs/DatawarehouseApi.md#delete_report) | **DELETE** /datawarehouse/reports/{report_oid} | Delete a report
 *UltracartClient::DatawarehouseApi* | [**dry_run_report_queries**](docs/DatawarehouseApi.md#dry_run_report_queries) | **PUT** /datawarehouse/reports/dryrun | Dry run the report queries
 *UltracartClient::DatawarehouseApi* | [**execute_custom_report**](docs/DatawarehouseApi.md#execute_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid}/execute | Execute a custom report
+*UltracartClient::DatawarehouseApi* | [**execute_custom_reports**](docs/DatawarehouseApi.md#execute_custom_reports) | **PUT** /datawarehouse/custom_reports/execute | Execute a custom reports
 *UltracartClient::DatawarehouseApi* | [**execute_report_queries**](docs/DatawarehouseApi.md#execute_report_queries) | **PUT** /datawarehouse/reports/execute | Execute the report queries
+*UltracartClient::DatawarehouseApi* | [**get_custom_dashboard**](docs/DatawarehouseApi.md#get_custom_dashboard) | **GET** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Get a custom dashboard
+*UltracartClient::DatawarehouseApi* | [**get_custom_dashboards**](docs/DatawarehouseApi.md#get_custom_dashboards) | **GET** /datawarehouse/custom_dashboards | Get custom dashboards
 *UltracartClient::DatawarehouseApi* | [**get_custom_report**](docs/DatawarehouseApi.md#get_custom_report) | **GET** /datawarehouse/custom_reports/{custom_report_oid} | Get a custom report
 *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
 *UltracartClient::DatawarehouseApi* | [**get_custom_reports**](docs/DatawarehouseApi.md#get_custom_reports) | **GET** /datawarehouse/custom_reports | Get custom reports
@@ -278,8 +282,10 @@ Class | Method | HTTP request | Description
 *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
 *UltracartClient::DatawarehouseApi* | [**get_report_websocket_authorization**](docs/DatawarehouseApi.md#get_report_websocket_authorization) | **PUT** /datawarehouse/reports/auth | Get report websocket authorization
 *UltracartClient::DatawarehouseApi* | [**get_reports**](docs/DatawarehouseApi.md#get_reports) | **GET** /datawarehouse/reports | Get list of reports available
+*UltracartClient::DatawarehouseApi* | [**insert_custom_dashboard**](docs/DatawarehouseApi.md#insert_custom_dashboard) | **POST** /datawarehouse/custom_dashboards | Create a custom dashboard
 *UltracartClient::DatawarehouseApi* | [**insert_custom_report**](docs/DatawarehouseApi.md#insert_custom_report) | **POST** /datawarehouse/custom_reports | Create a custom report
 *UltracartClient::DatawarehouseApi* | [**insert_report**](docs/DatawarehouseApi.md#insert_report) | **POST** /datawarehouse/reports | Create a report
+*UltracartClient::DatawarehouseApi* | [**update_custom_dashboard**](docs/DatawarehouseApi.md#update_custom_dashboard) | **PUT** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Update a custom dashboard
 *UltracartClient::DatawarehouseApi* | [**update_custom_report**](docs/DatawarehouseApi.md#update_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid} | Update a custom report
 *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
 *UltracartClient::DatawarehouseApi* | [**update_report**](docs/DatawarehouseApi.md#update_report) | **PUT** /datawarehouse/reports/{report_oid} | Update a report
@@ -400,6 +406,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::StorefrontApi* | [**get_email_campaigns**](docs/StorefrontApi.md#get_email_campaigns) | **GET** /storefront/{storefront_oid}/email/campaigns | Get email campaigns
 *UltracartClient::StorefrontApi* | [**get_email_campaigns_with_stats**](docs/StorefrontApi.md#get_email_campaigns_with_stats) | **GET** /storefront/{storefront_oid}/email/campaignsWithStats/{stat_days} | Get email campaigns with stats
 *UltracartClient::StorefrontApi* | [**get_email_commseq**](docs/StorefrontApi.md#get_email_commseq) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid} | Get email commseq
+*UltracartClient::StorefrontApi* | [**get_email_commseq_editor_values**](docs/StorefrontApi.md#get_email_commseq_editor_values) | **GET** /storefront/{storefront_oid}/email/commseqs/editorValues | Get email merchant specific editor values
 *UltracartClient::StorefrontApi* | [**get_email_commseq_email_stats**](docs/StorefrontApi.md#get_email_commseq_email_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/emailStats | Get email communication sequence emails stats
 *UltracartClient::StorefrontApi* | [**get_email_commseq_postcard_stats**](docs/StorefrontApi.md#get_email_commseq_postcard_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/postcardStats | Get email communication sequence postcard stats
 *UltracartClient::StorefrontApi* | [**get_email_commseq_postcard_tracking**](docs/StorefrontApi.md#get_email_commseq_postcard_tracking) | **GET** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking | Get email communication postcard tracking
@@ -905,16 +912,25 @@ Class | Method | HTTP request | Description
  - [UltracartClient::CouponsRequest](docs/CouponsRequest.md)
  - [UltracartClient::CouponsResponse](docs/CouponsResponse.md)
  - [UltracartClient::Currency](docs/Currency.md)
+ - [UltracartClient::CustomDashboard](docs/CustomDashboard.md)
+ - [UltracartClient::CustomDashboardPage](docs/CustomDashboardPage.md)
+ - [UltracartClient::CustomDashboardPageReport](docs/CustomDashboardPageReport.md)
+ - [UltracartClient::CustomDashboardResponse](docs/CustomDashboardResponse.md)
+ - [UltracartClient::CustomDashboardsResponse](docs/CustomDashboardsResponse.md)
  - [UltracartClient::CustomReport](docs/CustomReport.md)
  - [UltracartClient::CustomReportAccountConfig](docs/CustomReportAccountConfig.md)
  - [UltracartClient::CustomReportAccountConfigResponse](docs/CustomReportAccountConfigResponse.md)
  - [UltracartClient::CustomReportExecutionParameter](docs/CustomReportExecutionParameter.md)
  - [UltracartClient::CustomReportExecutionRequest](docs/CustomReportExecutionRequest.md)
+ - [UltracartClient::CustomReportExecutionResponse](docs/CustomReportExecutionResponse.md)
  - [UltracartClient::CustomReportParameter](docs/CustomReportParameter.md)
  - [UltracartClient::CustomReportParameterOption](docs/CustomReportParameterOption.md)
  - [UltracartClient::CustomReportQuery](docs/CustomReportQuery.md)
  - [UltracartClient::CustomReportResponse](docs/CustomReportResponse.md)
  - [UltracartClient::CustomReportTooltip](docs/CustomReportTooltip.md)
+ - [UltracartClient::CustomReportsExecutionReportData](docs/CustomReportsExecutionReportData.md)
+ - [UltracartClient::CustomReportsExecutionRequest](docs/CustomReportsExecutionRequest.md)
+ - [UltracartClient::CustomReportsExecutionResponse](docs/CustomReportsExecutionResponse.md)
  - [UltracartClient::CustomReportsResponse](docs/CustomReportsResponse.md)
  - [UltracartClient::Customer](docs/Customer.md)
  - [UltracartClient::CustomerActivity](docs/CustomerActivity.md)
@@ -998,6 +1014,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::EmailDashboardStatsResponse](docs/EmailDashboardStatsResponse.md)
  - [UltracartClient::EmailDomain](docs/EmailDomain.md)
  - [UltracartClient::EmailEditorTokenResponse](docs/EmailEditorTokenResponse.md)
+ - [UltracartClient::EmailEditorValuesResponse](docs/EmailEditorValuesResponse.md)
  - [UltracartClient::EmailFlow](docs/EmailFlow.md)
  - [UltracartClient::EmailFlowBackPopulateRequest](docs/EmailFlowBackPopulateRequest.md)
  - [UltracartClient::EmailFlowBackPopulateResponse](docs/EmailFlowBackPopulateResponse.md)
@@ -1550,6 +1567,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.18 | 08/04/2025 | more internal development on loyalty step for storefront flows |
+| 4.1.17 | 08/04/2025 | small changes to internal flow app to support loyalty tier moves |
 | 4.1.16 | 07/28/2025 | updated doc samples |
 | 4.1.15 | 07/28/2025 | new order methods for blocking and unblocking refunds |
 | 4.1.14 | 07/10/2025 | automation test |

data/docs/CustomDashboard.md

@@ -0,0 +1,24 @@
+# UltracartClient::CustomDashboard
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data_warehouse_custom_dashboard_oid** | **Integer** |  | [optional] |
+| **merchant_id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **pages** | [**Array<CustomDashboardPage>**](CustomDashboardPage.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::CustomDashboard.new(
+  data_warehouse_custom_dashboard_oid: null,
+  merchant_id: null,
+  name: null,
+  pages: null
+)
+```
+

data/docs/CustomDashboardPage.md

@@ -0,0 +1,22 @@
+# UltracartClient::CustomDashboardPage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page_height_inches** | **Float** |  | [optional] |
+| **page_width_inches** | **Float** |  | [optional] |
+| **reports** | [**Array<CustomDashboardPageReport>**](CustomDashboardPageReport.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::CustomDashboardPage.new(
+  page_height_inches: null,
+  page_width_inches: null,
+  reports: null
+)
+```
+

data/docs/CustomDashboardPageReport.md

@@ -0,0 +1,26 @@
+# UltracartClient::CustomDashboardPageReport
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data_warehouse_report_config_oid** | **Integer** |  | [optional] |
+| **grid_height** | **Integer** |  | [optional] |
+| **grid_width** | **Integer** |  | [optional] |
+| **grid_x** | **Integer** |  | [optional] |
+| **grid_y** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::CustomDashboardPageReport.new(
+  data_warehouse_report_config_oid: null,
+  grid_height: null,
+  grid_width: null,
+  grid_x: null,
+  grid_y: null
+)
+```
+

data/docs/CustomDashboardResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::CustomDashboardResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dashboard** | [**CustomDashboard**](CustomDashboard.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::CustomDashboardResponse.new(
+  dashboard: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/CustomDashboardsResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::CustomDashboardsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dashboards** | [**Array<CustomDashboard>**](CustomDashboard.md) | reports | [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::CustomDashboardsResponse.new(
+  dashboards: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/CustomReportExecutionResponse.md

@@ -0,0 +1,32 @@
+# UltracartClient::CustomReportExecutionResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **parameters** | [**Array<CustomReportExecutionParameter>**](CustomReportExecutionParameter.md) |  | [optional] |
+| **report** | [**CustomReport**](CustomReport.md) |  | [optional] |
+| **result_schema_json** | **String** |  | [optional] |
+| **result_url** | **String** |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::CustomReportExecutionResponse.new(
+  error: null,
+  metadata: null,
+  parameters: null,
+  report: null,
+  result_schema_json: null,
+  result_url: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/CustomReportsExecutionReportData.md

@@ -0,0 +1,22 @@
+# UltracartClient::CustomReportsExecutionReportData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data_warehouse_report_config_oid** | **Integer** |  | [optional] |
+| **error_message** | **String** |  | [optional] |
+| **result_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::CustomReportsExecutionReportData.new(
+  data_warehouse_report_config_oid: null,
+  error_message: null,
+  result_url: null
+)
+```
+

data/docs/CustomReportsExecutionRequest.md

@@ -0,0 +1,20 @@
+# UltracartClient::CustomReportsExecutionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data_warehouse_report_config_oids** | **Array<Integer>** |  | [optional] |
+| **parameters** | [**Array<CustomReportExecutionParameter>**](CustomReportExecutionParameter.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::CustomReportsExecutionRequest.new(
+  data_warehouse_report_config_oids: null,
+  parameters: null
+)
+```
+

data/docs/CustomReportsExecutionResponse.md

@@ -0,0 +1,28 @@
+# UltracartClient::CustomReportsExecutionResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **parameters** | [**Array<CustomReportExecutionParameter>**](CustomReportExecutionParameter.md) |  | [optional] |
+| **reports** | [**Array<CustomReportsExecutionReportData>**](CustomReportsExecutionReportData.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::CustomReportsExecutionResponse.new(
+  error: null,
+  metadata: null,
+  parameters: null,
+  reports: null,
+  success: null,
+  warning: null
+)
+```
+