ultra_cart_rest_api_v2 3.11.14 → 3.11.16

package/README.md

@@ -5,7 +5,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.14
+- Package version: 3.11.16
 - Build package: io.swagger.codegen.languages.JavascriptClientCodegen
 For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -309,15 +309,23 @@ Class | Method | HTTP request | Description
 *UltraCartRestApiV2.CustomerApi* | [**updateCustomerEmailLists**](docs/CustomerApi.md#updateCustomerEmailLists) | **POST** /customer/customers/{customer_profile_oid}/email_lists | Update email list subscriptions for a customer
 *UltraCartRestApiV2.CustomerApi* | [**updateWishListItem**](docs/CustomerApi.md#updateWishListItem) | **PUT** /customer/customers/{customer_profile_oid}/wishlist/{customer_wishlist_item_oid} | Update a customer wishlist item
 *UltraCartRestApiV2.CustomerApi* | [**validateEmailVerificationToken**](docs/CustomerApi.md#validateEmailVerificationToken) | **POST** /customer/customers/email_verify/validate_token | Validate a token that can be used to verify a customer email address
+*UltraCartRestApiV2.DatawarehouseApi* | [**deleteCustomReport**](docs/DatawarehouseApi.md#deleteCustomReport) | **DELETE** /datawarehouse/custom_reports/{custom_report_oid} | Delete a custom report
 *UltraCartRestApiV2.DatawarehouseApi* | [**deleteReport**](docs/DatawarehouseApi.md#deleteReport) | **DELETE** /datawarehouse/reports/{report_oid} | Delete a report
 *UltraCartRestApiV2.DatawarehouseApi* | [**dryRunReportQueries**](docs/DatawarehouseApi.md#dryRunReportQueries) | **PUT** /datawarehouse/reports/dryrun | Dry run the report queries
+*UltraCartRestApiV2.DatawarehouseApi* | [**executeCustomReport**](docs/DatawarehouseApi.md#executeCustomReport) | **PUT** /datawarehouse/custom_reports/{custom_report_oid}/execute | Execute a custom report
 *UltraCartRestApiV2.DatawarehouseApi* | [**executeReportQueries**](docs/DatawarehouseApi.md#executeReportQueries) | **PUT** /datawarehouse/reports/execute | Execute the report queries
+*UltraCartRestApiV2.DatawarehouseApi* | [**getCustomReport**](docs/DatawarehouseApi.md#getCustomReport) | **GET** /datawarehouse/custom_reports/{custom_report_oid} | Get a custom report
+*UltraCartRestApiV2.DatawarehouseApi* | [**getCustomReportAccountConfig**](docs/DatawarehouseApi.md#getCustomReportAccountConfig) | **GET** /datawarehouse/custom_reports/account_config | Get custom report account configuration
+*UltraCartRestApiV2.DatawarehouseApi* | [**getCustomReports**](docs/DatawarehouseApi.md#getCustomReports) | **GET** /datawarehouse/custom_reports | Get custom reports
 *UltraCartRestApiV2.DatawarehouseApi* | [**getReport**](docs/DatawarehouseApi.md#getReport) | **GET** /datawarehouse/reports/{report_oid} | Get a report
 *UltraCartRestApiV2.DatawarehouseApi* | [**getReportDataSet**](docs/DatawarehouseApi.md#getReportDataSet) | **GET** /datawarehouse/reports/dataset/{dataset_uuid} | Get a report data set
 *UltraCartRestApiV2.DatawarehouseApi* | [**getReportDataSetPage**](docs/DatawarehouseApi.md#getReportDataSetPage) | **GET** /datawarehouse/reports/dataset/{dataset_uuid}/pages/{page_number} | Get a report data set page
 *UltraCartRestApiV2.DatawarehouseApi* | [**getReportWebsocketAuthorization**](docs/DatawarehouseApi.md#getReportWebsocketAuthorization) | **PUT** /datawarehouse/reports/auth | Get report websocket authorization
 *UltraCartRestApiV2.DatawarehouseApi* | [**getReports**](docs/DatawarehouseApi.md#getReports) | **GET** /datawarehouse/reports | Get list of reports available
+*UltraCartRestApiV2.DatawarehouseApi* | [**insertCustomReport**](docs/DatawarehouseApi.md#insertCustomReport) | **POST** /datawarehouse/custom_reports | Create a custom report
 *UltraCartRestApiV2.DatawarehouseApi* | [**insertReport**](docs/DatawarehouseApi.md#insertReport) | **POST** /datawarehouse/reports | Create a report
+*UltraCartRestApiV2.DatawarehouseApi* | [**updateCustomReport**](docs/DatawarehouseApi.md#updateCustomReport) | **PUT** /datawarehouse/custom_reports/{custom_report_oid} | Update a custom report
+*UltraCartRestApiV2.DatawarehouseApi* | [**updateCustomReportAccountConfig**](docs/DatawarehouseApi.md#updateCustomReportAccountConfig) | **PUT** /datawarehouse/custom_reports/account_config | Update custom report account config
 *UltraCartRestApiV2.DatawarehouseApi* | [**updateReport**](docs/DatawarehouseApi.md#updateReport) | **PUT** /datawarehouse/reports/{report_oid} | Update a report
 *UltraCartRestApiV2.FulfillmentApi* | [**acknowledgeOrders**](docs/FulfillmentApi.md#acknowledgeOrders) | **PUT** /fulfillment/distribution_centers/{distribution_center_code}/acknowledgements | Acknowledge receipt of orders.
 *UltraCartRestApiV2.FulfillmentApi* | [**generatePackingSlip**](docs/FulfillmentApi.md#generatePackingSlip) | **GET** /fulfillment/distribution_centers/{distribution_center_code}/orders/{order_id} | Generate a packing slip for this order for the given distribution center.
@@ -364,6 +372,7 @@ Class | Method | HTTP request | Description
 *UltraCartRestApiV2.OauthApi* | [**oauthAccessToken**](docs/OauthApi.md#oauthAccessToken) | **POST** /oauth/token | Exchange authorization code for access token.
 *UltraCartRestApiV2.OauthApi* | [**oauthRevoke**](docs/OauthApi.md#oauthRevoke) | **POST** /oauth/revoke | Revoke this OAuth application.
 *UltraCartRestApiV2.OrderApi* | [**adjustOrderTotal**](docs/OrderApi.md#adjustOrderTotal) | **POST** /order/orders/{order_id}/adjust_order_total/{desired_total} | Adjusts an order total
+*UltraCartRestApiV2.OrderApi* | [**blockRefundOnOrder**](docs/OrderApi.md#blockRefundOnOrder) | **GET** /order/orders/{order_id}/refund_block | Set a refund block on an order
 *UltraCartRestApiV2.OrderApi* | [**cancelOrder**](docs/OrderApi.md#cancelOrder) | **POST** /order/orders/{order_id}/cancel | Cancel an order
 *UltraCartRestApiV2.OrderApi* | [**deleteOrder**](docs/OrderApi.md#deleteOrder) | **DELETE** /order/orders/{order_id} | Delete an order
 *UltraCartRestApiV2.OrderApi* | [**duplicateOrder**](docs/OrderApi.md#duplicateOrder) | **POST** /order/orders/{order_id}/duplicate | Duplicate an order
@@ -384,10 +393,10 @@ Class | Method | HTTP request | Description
 *UltraCartRestApiV2.OrderApi* | [**isRefundableOrder**](docs/OrderApi.md#isRefundableOrder) | **GET** /order/orders/{order_id}/refundable | Determine if an order can be refunded
 *UltraCartRestApiV2.OrderApi* | [**processPayment**](docs/OrderApi.md#processPayment) | **POST** /order/orders/{order_id}/process_payment | Process payment
 *UltraCartRestApiV2.OrderApi* | [**refundOrder**](docs/OrderApi.md#refundOrder) | **PUT** /order/orders/{order_id}/refund | Refund an order
-*UltraCartRestApiV2.OrderApi* | [**refundOrderCompletely**](docs/OrderApi.md#refundOrderCompletely) | **PUT** /order/orders/{order_id}/refund_completely | Refund an order completely
 *UltraCartRestApiV2.OrderApi* | [**replacement**](docs/OrderApi.md#replacement) | **POST** /order/orders/{order_id}/replacement | Replacement order
 *UltraCartRestApiV2.OrderApi* | [**resendReceipt**](docs/OrderApi.md#resendReceipt) | **POST** /order/orders/{order_id}/resend_receipt | Resend receipt
 *UltraCartRestApiV2.OrderApi* | [**resendShipmentConfirmation**](docs/OrderApi.md#resendShipmentConfirmation) | **POST** /order/orders/{order_id}/resend_shipment_confirmation | Resend shipment confirmation
+*UltraCartRestApiV2.OrderApi* | [**unblockRefundOnOrder**](docs/OrderApi.md#unblockRefundOnOrder) | **GET** /order/orders/{order_id}/refund_unblock | Remove a refund block on an order
 *UltraCartRestApiV2.OrderApi* | [**updateAccountsReceivableRetryConfig**](docs/OrderApi.md#updateAccountsReceivableRetryConfig) | **POST** /order/accountsReceivableRetryConfig | Update A/R Retry Configuration
 *UltraCartRestApiV2.OrderApi* | [**updateOrder**](docs/OrderApi.md#updateOrder) | **PUT** /order/orders/{order_id} | Update an order
 *UltraCartRestApiV2.OrderApi* | [**validateOrder**](docs/OrderApi.md#validateOrder) | **POST** /order/validate | Validate
@@ -941,6 +950,17 @@ Class | Method | HTTP request | Description
  - [UltraCartRestApiV2.CouponsRequest](docs/CouponsRequest.md)
  - [UltraCartRestApiV2.CouponsResponse](docs/CouponsResponse.md)
  - [UltraCartRestApiV2.Currency](docs/Currency.md)
+ - [UltraCartRestApiV2.CustomReport](docs/CustomReport.md)
+ - [UltraCartRestApiV2.CustomReportAccountConfig](docs/CustomReportAccountConfig.md)
+ - [UltraCartRestApiV2.CustomReportAccountConfigResponse](docs/CustomReportAccountConfigResponse.md)
+ - [UltraCartRestApiV2.CustomReportExecutionParameter](docs/CustomReportExecutionParameter.md)
+ - [UltraCartRestApiV2.CustomReportExecutionRequest](docs/CustomReportExecutionRequest.md)
+ - [UltraCartRestApiV2.CustomReportParameter](docs/CustomReportParameter.md)
+ - [UltraCartRestApiV2.CustomReportParameterOption](docs/CustomReportParameterOption.md)
+ - [UltraCartRestApiV2.CustomReportQuery](docs/CustomReportQuery.md)
+ - [UltraCartRestApiV2.CustomReportResponse](docs/CustomReportResponse.md)
+ - [UltraCartRestApiV2.CustomReportTooltip](docs/CustomReportTooltip.md)
+ - [UltraCartRestApiV2.CustomReportsResponse](docs/CustomReportsResponse.md)
  - [UltraCartRestApiV2.Customer](docs/Customer.md)
  - [UltraCartRestApiV2.CustomerActivity](docs/CustomerActivity.md)
  - [UltraCartRestApiV2.CustomerAffiliate](docs/CustomerAffiliate.md)
@@ -1572,6 +1592,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 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 |
 | 3.11.12 | 05/19/2025 | conversations - AI agent capabilities method |

package/docs/CartUpsellAfter.md

@@ -5,6 +5,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **finalize_after_dts** | **String** | The date/time after which the cart will finalize into an order. | [optional] 
 **finalize_after_minutes** | **Number** | The amount of inactivity in minutes after which the cart should be finalized into an order.  This will calculate the finalize_after_dts field. | [optional] 
-**upsell_path_code** | **String** | Upsell path code | [optional] 
+**upsell_path_code** | **String** | Upsell path code (this is for legacy upsells only) | [optional] 
+**upsell_path_name** | **String** | Upsell path name to start on (StoreFront Upsells).  Will only be respected on a handoff API call. | [optional] 
+**upsell_path_variation** | **String** | Upsell path variation to start on (StoreFront Upsells).   Will only be respected on a handoff API call. | [optional] 
 
 

package/docs/ConversationVirtualAgentCapabilities.md

@@ -8,9 +8,26 @@ Name | Type | Description | Notes
 **lookup_order_information** | **Boolean** |  | [optional] 
 **lookup_subscription_information** | **Boolean** |  | [optional] 
 **open_support_ticket** | **Boolean** |  | [optional] 
+**open_support_ticket_channel** | **String** | Channel to use to open the support ticket | [optional] 
+**open_support_ticket_channel_email** | **String** | Email to send support ticket to | [optional] 
 **pause_subscription** | **Boolean** |  | [optional] 
 **resume_subscription** | **Boolean** |  | [optional] 
 **transfer_chat_to_live_agent** | **Boolean** |  | [optional] 
 **update_subscription_credit_card** | **Boolean** |  | [optional] 
 
 
+<a name="OpenSupportTicketChannelEnum"></a>
+## Enum: OpenSupportTicketChannelEnum
+
+
+* `none` (value: `"none"`)
+
+* `email` (value: `"email"`)
+
+* `UltraCart_Task` (value: `"UltraCart Task"`)
+
+* `Zoho_Desk_Ticket` (value: `"Zoho Desk Ticket"`)
+
+
+
+

package/docs/CustomReport.md

@@ -0,0 +1,17 @@
+# UltraCartRestApiV2.CustomReport
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**chart_javascript** | **String** |  | [optional] 
+**chart_javascript_url** | **String** |  | [optional] 
+**data_warehouse_report_config_oid** | **Number** |  | [optional] 
+**dataset_security_level** | **String** |  | [optional] 
+**group_name** | **String** |  | [optional] 
+**merchant_id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**parameters** | [**[CustomReportParameter]**](CustomReportParameter.md) |  | [optional] 
+**queries** | [**[CustomReportQuery]**](CustomReportQuery.md) |  | [optional] 
+**tooltips** | [**[CustomReportTooltip]**](CustomReportTooltip.md) |  | [optional] 
+
+

package/docs/CustomReportAccountConfig.md

@@ -0,0 +1,16 @@
+# UltraCartRestApiV2.CustomReportAccountConfig
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ai_budget** | **Number** |  | [optional] 
+**ai_usage** | **Number** | Current AI usage creating reports | [optional] 
+**merchant_id** | **String** | Current BigQuery SQL usage running reports | [optional] 
+**novice_sql_comments** | **Boolean** |  | [optional] 
+**opt_in** | **Boolean** | True if they have opted into custom reports | [optional] 
+**opt_in_by_user** | **String** | User that opted into custom reporting | [optional] 
+**opt_in_date** | **String** | Date/time that custom reporting was opted in to | [optional] 
+**sql_budget** | **Number** |  | [optional] 
+**sql_usage** | **Number** |  | [optional] 
+
+

package/docs/CustomReportAccountConfigResponse.md

@@ -0,0 +1,12 @@
+# UltraCartRestApiV2.CustomReportAccountConfigResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_config** | [**CustomReportAccountConfig**](CustomReportAccountConfig.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] 
+
+

package/docs/CustomReportExecutionParameter.md

@@ -0,0 +1,10 @@
+# UltraCartRestApiV2.CustomReportExecutionParameter
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**type** | **String** |  | [optional] 
+**value** | **String** |  | [optional] 
+
+

package/docs/CustomReportExecutionRequest.md

@@ -0,0 +1,8 @@
+# UltraCartRestApiV2.CustomReportExecutionRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parameters** | [**[CustomReportExecutionParameter]**](CustomReportExecutionParameter.md) |  | [optional] 
+
+

package/docs/CustomReportParameter.md

@@ -0,0 +1,13 @@
+# UltraCartRestApiV2.CustomReportParameter
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**display_name** | **String** |  | [optional] 
+**meta** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**options** | [**[CustomReportParameterOption]**](CustomReportParameterOption.md) |  | [optional] 
+**required** | **Boolean** |  | [optional] 
+**type** | **String** |  | [optional] 
+
+

package/docs/CustomReportParameterOption.md

@@ -0,0 +1,9 @@
+# UltraCartRestApiV2.CustomReportParameterOption
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** |  | [optional] 
+**value** | **String** |  | [optional] 
+
+

package/docs/CustomReportQuery.md

@@ -0,0 +1,13 @@
+# UltraCartRestApiV2.CustomReportQuery
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conditional_formatting_start_column** | **Number** |  | [optional] 
+**freeze_columns** | **Number** |  | [optional] 
+**pii_columns** | **[String]** |  | [optional] 
+**query** | **String** |  | [optional] 
+**sheet_name** | **String** |  | [optional] 
+**title** | **String** |  | [optional] 
+
+

package/docs/CustomReportResponse.md

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

package/docs/CustomReportTooltip.md

@@ -0,0 +1,9 @@
+# UltraCartRestApiV2.CustomReportTooltip
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**column_name** | **String** |  | [optional] 
+**tooltip** | **String** |  | [optional] 
+
+

package/docs/CustomReportsResponse.md

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