ultracart_api 3.11.15 → 3.11.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c11973761bbac8a13f74e1fa3c173c522d6206eeca1ce874dc9b7f6597837259
-  data.tar.gz: c10c527d7d26aa56e0c3ac042df6f63d0bded1b18fa543a9992dcf0e864634af
+  metadata.gz: 712d427ceb28f13951dfa3516c9ddf5c01cc6e286cfdda0f24d722bd88cb73fb
+  data.tar.gz: 661b1f0275b0e88511cadede357f2b11e7a681c4973f3df2e739548788c06d11
 SHA512:
-  metadata.gz: 0f07e187b37d7bdbfe01903b9553ffca0ea899add9ee68fdfd64ba813a99ff3386efb2faed3849e62fe0447a9b964225e9bba5d7369e866417f32222b08a50f2
-  data.tar.gz: c8efb6154748531c8bf073e3f72e3e28a33fb5a394d39050f7dbb911859fc7f7a42c1e96908886aa274bb30f89c4d96ce9a6e25a8c7b4505f679f9eb230f75fa
+  metadata.gz: 627d4a5393e372b9f016a4e1daff5dc529eff80ca01b9d12763ad5aaaa6c32135e375f3bccb19979bc93c769372600efd28336d5290f3613eebd14a7b40a7bd3
+  data.tar.gz: f591bff493dda67c33560b2fa09fbd5c36358518ec4cb05800aad23b22d79c6627886e2af5c68bf7721fb659ee41d7d757b7f8d37b6977ad69b62557cdb44f39

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.11.15
+- Package version: 3.11.17
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.11.15.gem
+gem install ./ultracart_api-3.11.17.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.11.15.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.11.17.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ultracart_api', '~> 3.11.15'
+    gem 'ultracart_api', '~> 3.11.17'
 
 ### Install from Git
 
@@ -269,20 +269,27 @@ 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
 *UltracartClient::DatawarehouseApi* | [**get_report**](docs/DatawarehouseApi.md#get_report) | **GET** /datawarehouse/reports/{report_oid} | Get a report
 *UltracartClient::DatawarehouseApi* | [**get_report_data_set**](docs/DatawarehouseApi.md#get_report_data_set) | **GET** /datawarehouse/reports/dataset/{dataset_uuid} | Get a report data set
 *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
@@ -331,7 +338,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::OauthApi* | [**oauth_access_token**](docs/OauthApi.md#oauth_access_token) | **POST** /oauth/token | Exchange authorization code for access token.
 *UltracartClient::OauthApi* | [**oauth_revoke**](docs/OauthApi.md#oauth_revoke) | **POST** /oauth/revoke | Revoke this OAuth application.
 *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
-*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
+*UltracartClient::OrderApi* | [**block_refund_on_order**](docs/OrderApi.md#block_refund_on_order) | **GET** /order/orders/{order_id}/refund_block | Set a refund block on an order
 *UltracartClient::OrderApi* | [**cancel_order**](docs/OrderApi.md#cancel_order) | **POST** /order/orders/{order_id}/cancel | Cancel an order
 *UltracartClient::OrderApi* | [**delete_order**](docs/OrderApi.md#delete_order) | **DELETE** /order/orders/{order_id} | Delete an order
 *UltracartClient::OrderApi* | [**duplicate_order**](docs/OrderApi.md#duplicate_order) | **POST** /order/orders/{order_id}/duplicate | Duplicate an order
@@ -352,11 +359,10 @@ Class | Method | HTTP request | Description
 *UltracartClient::OrderApi* | [**is_refundable_order**](docs/OrderApi.md#is_refundable_order) | **GET** /order/orders/{order_id}/refundable | Determine if an order can be refunded
 *UltracartClient::OrderApi* | [**process_payment**](docs/OrderApi.md#process_payment) | **POST** /order/orders/{order_id}/process_payment | Process payment
 *UltracartClient::OrderApi* | [**refund_order**](docs/OrderApi.md#refund_order) | **PUT** /order/orders/{order_id}/refund | Refund an order
-*UltracartClient::OrderApi* | [**refund_order_completely**](docs/OrderApi.md#refund_order_completely) | **PUT** /order/orders/{order_id}/refund_completely | Refund an order completely
 *UltracartClient::OrderApi* | [**replacement**](docs/OrderApi.md#replacement) | **POST** /order/orders/{order_id}/replacement | Replacement order
 *UltracartClient::OrderApi* | [**resend_receipt**](docs/OrderApi.md#resend_receipt) | **POST** /order/orders/{order_id}/resend_receipt | Resend receipt
 *UltracartClient::OrderApi* | [**resend_shipment_confirmation**](docs/OrderApi.md#resend_shipment_confirmation) | **POST** /order/orders/{order_id}/resend_shipment_confirmation | Resend shipment confirmation
-*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
+*UltracartClient::OrderApi* | [**unblock_refund_on_order**](docs/OrderApi.md#unblock_refund_on_order) | **GET** /order/orders/{order_id}/refund_unblock | Remove a refund block on an order
 *UltracartClient::OrderApi* | [**update_accounts_receivable_retry_config**](docs/OrderApi.md#update_accounts_receivable_retry_config) | **POST** /order/accountsReceivableRetryConfig | Update A/R Retry Configuration
 *UltracartClient::OrderApi* | [**update_order**](docs/OrderApi.md#update_order) | **PUT** /order/orders/{order_id} | Update an order
 *UltracartClient::OrderApi* | [**validate_order**](docs/OrderApi.md#validate_order) | **POST** /order/validate | Validate
@@ -910,16 +916,26 @@ 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)
  - [UltracartClient::CustomerAffiliate](docs/CustomerAffiliate.md)
@@ -1551,6 +1567,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.11.17 | 08/04/2025 | small changes to internal flow app to support loyalty tier moves |
+| 3.11.16 | 07/28/2025 | updated doc samples |
 | 3.11.15 | 07/28/2025 | new order methods for blocking and unblocking refunds |
 | 3.11.14 | 07/10/2025 | automation test |
 | 3.11.13 | 05/20/2025 | conversation - virtual agent flag and virtual agent cost |

data/docs/CustomDashboard.md

@@ -0,0 +1,11 @@
+# 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] 
+
+

data/docs/CustomDashboardPage.md

@@ -0,0 +1,10 @@
+# UltracartClient::CustomDashboardPage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page_height_inches** | **Float** |  | [optional] 
+**page_width_inches** | **Float** |  | [optional] 
+**reports** | [**Array<CustomDashboardPageReport>**](CustomDashboardPageReport.md) |  | [optional] 
+
+

data/docs/CustomDashboardPageReport.md

@@ -0,0 +1,12 @@
+# 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] 
+
+

data/docs/CustomDashboardResponse.md

@@ -0,0 +1,12 @@
+# 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] 
+
+

data/docs/CustomDashboardsResponse.md

@@ -0,0 +1,12 @@
+# 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] 
+
+

data/docs/CustomReportExecutionResponse.md

@@ -0,0 +1,15 @@
+# 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] 
+
+

data/docs/CustomReportsExecutionReportData.md

@@ -0,0 +1,10 @@
+# UltracartClient::CustomReportsExecutionReportData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data_warehouse_report_config_oid** | **Integer** |  | [optional] 
+**error_message** | **String** |  | [optional] 
+**result_url** | **String** |  | [optional] 
+
+

data/docs/CustomReportsExecutionRequest.md

@@ -0,0 +1,9 @@
+# UltracartClient::CustomReportsExecutionRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data_warehouse_report_config_oids** | **Array<Integer>** |  | [optional] 
+**parameters** | [**Array<CustomReportExecutionParameter>**](CustomReportExecutionParameter.md) |  | [optional] 
+
+

data/docs/CustomReportsExecutionResponse.md

@@ -0,0 +1,13 @@
+# 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] 
+
+

data/docs/CustomReportsResponse.md

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