ultracart_api 3.11.14 → 3.11.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7022dda8948a45a7c5163cc0b21adc9c5c43cabbab93f4888ac81cb42621aae
-  data.tar.gz: 497539a61dae4af96603ac6c3c5148e223883bbb980e8940b69f32f897021d66
+  metadata.gz: 5193e746267b3197311ac8f0a9c849c2385e078ff3c58b7aa3d598e32a357ebf
+  data.tar.gz: fea6ee29a16616b6b3061392d707ddac908bf54e8913db5d45a2cc6b7389f560
 SHA512:
-  metadata.gz: f08b1b532ba32b17ae964e8263c92668c9fd5c85a6102fecef2bca2da14847d784af53e4fd25b780415e9b6b4787e6929bd43d7d01048e35655216acc5acabcf
-  data.tar.gz: d0419da92d5da3dcf4572ed2a92f29254e51d9454e7d193a54d6a442717a04395cefe23f9e711729d755025801aebed8ebcfabaa76def6dae414d6d204ef9483
+  metadata.gz: bea4d273179b62709428014f6a031bd2a25ae94214a3318a478f0045ddedce66763f319222bfc65f8c78adb35f5fb5771b11d39aca7188cb735e5cc4322b3569
+  data.tar.gz: 1512b5a8a1124216f36815e8cdc8876b1fa02e9a9a11e1bf40f585bdad3f5db450a7bcdd50eb1d750fe456b0fe1dd2a39b8236d2bd5a95b1cc246a55051264bf

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.14
+- Package version: 3.11.16
 - 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.14.gem
+gem install ./ultracart_api-3.11.16.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.11.14.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.11.16.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.14'
+    gem 'ultracart_api', '~> 3.11.16'
 
 ### Install from Git
 
@@ -269,15 +269,23 @@ 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_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_report_queries**](docs/DatawarehouseApi.md#execute_report_queries) | **PUT** /datawarehouse/reports/execute | Execute the report queries
+*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_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_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
 *UltracartClient::FulfillmentApi* | [**acknowledge_orders**](docs/FulfillmentApi.md#acknowledge_orders) | **PUT** /fulfillment/distribution_centers/{distribution_center_code}/acknowledgements | Acknowledge receipt of orders.
 *UltracartClient::FulfillmentApi* | [**generate_packing_slip**](docs/FulfillmentApi.md#generate_packing_slip) | **GET** /fulfillment/distribution_centers/{distribution_center_code}/orders/{order_id} | Generate a packing slip for this order for the given distribution center.
@@ -324,6 +332,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) | **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
@@ -344,10 +353,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) | **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
@@ -901,6 +910,17 @@ Class | Method | HTTP request | Description
  - [UltracartClient::CouponsRequest](docs/CouponsRequest.md)
  - [UltracartClient::CouponsResponse](docs/CouponsResponse.md)
  - [UltracartClient::Currency](docs/Currency.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::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::CustomReportsResponse](docs/CustomReportsResponse.md)
  - [UltracartClient::Customer](docs/Customer.md)
  - [UltracartClient::CustomerActivity](docs/CustomerActivity.md)
  - [UltracartClient::CustomerAffiliate](docs/CustomerAffiliate.md)
@@ -1532,6 +1552,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 |

data/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** | **Integer** | 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] 
 
 

data/docs/ConversationVirtualAgentCapabilities.md

@@ -8,6 +8,8 @@ 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] 

data/docs/CustomReport.md

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

data/docs/CustomReportAccountConfig.md

@@ -0,0 +1,16 @@
+# UltracartClient::CustomReportAccountConfig
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ai_budget** | **Float** |  | [optional] 
+**ai_usage** | **Float** | 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** | **Float** |  | [optional] 
+**sql_usage** | **Float** |  | [optional] 
+
+

data/docs/CustomReportAccountConfigResponse.md

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

data/docs/CustomReportExecutionParameter.md

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

data/docs/CustomReportExecutionRequest.md

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

data/docs/CustomReportParameter.md

@@ -0,0 +1,13 @@
+# UltracartClient::CustomReportParameter
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**display_name** | **String** |  | [optional] 
+**meta** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**options** | [**Array<CustomReportParameterOption>**](CustomReportParameterOption.md) |  | [optional] 
+**required** | **BOOLEAN** |  | [optional] 
+**type** | **String** |  | [optional] 
+
+

data/docs/CustomReportParameterOption.md

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

data/docs/CustomReportQuery.md

@@ -0,0 +1,13 @@
+# UltracartClient::CustomReportQuery
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conditional_formatting_start_column** | **Integer** |  | [optional] 
+**freeze_columns** | **Integer** |  | [optional] 
+**pii_columns** | **Array<String>** |  | [optional] 
+**query** | **String** |  | [optional] 
+**sheet_name** | **String** |  | [optional] 
+**title** | **String** |  | [optional] 
+
+

data/docs/CustomReportResponse.md

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

data/docs/CustomReportTooltip.md

@@ -0,0 +1,9 @@
+# UltracartClient::CustomReportTooltip
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**column_name** | **String** |  | [optional] 
+**tooltip** | **String** |  | [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] 
+
+