ultracart_api 4.1.14 → 4.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b073dc578c5fc9b1a007943543ef1adfb8bf174e461fcafdd0a626693d14aca9
-  data.tar.gz: d4ec73507692ecef97202e4052ec75da5b046934af88ac8b71572cfa0d38e74d
+  metadata.gz: ba315b7e97b3e9067d6a15640d3cdb873006d13bd8f53f48cc2d0c40c4db11af
+  data.tar.gz: a159dbb08abcf2d9ff720194ddc58bd4206ee57978371297b0198308e45cc98e
 SHA512:
-  metadata.gz: 88b516f0ce50dd7987d960b2041cd8b12ca3c8dd9e63c7b67186a4718d7b2312219d31664e852996f5e9b906f26e35a9da97da7d9d7dfb7e755b58fb70438981
-  data.tar.gz: db3451cc4c6896f7f22bbc937bd4c935faea478ddd425f21cf26d6ce811e96d401aaaeda11d405a2ba265a042bbd4b5c10f4e076f176a926b2009818dff3c419
+  metadata.gz: 7454402c148af2ee31f596640dce2191980bb65364017921129a8611ea360f7ee948461de64941c83be30d13dd04d5d43a3fe2577be6e4bfdfdbce7453080fa7
+  data.tar.gz: 2df955c52f353b0990ca11d1e6deb381bdf98033c45ff2ad60fc7326f2803f8540c553db78287a6b854d1241e432d361338e6dae419c65b40c064e0386d957ae

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.14
+- Package version: 4.1.16
 - 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.14'
+gem 'ultracart_api', '4.1.16'
 ```
 
 install:
@@ -265,15 +265,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.
@@ -320,6 +328,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
@@ -340,10 +349,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
@@ -896,6 +905,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)
@@ -1530,6 +1550,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 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 |
 | 4.1.13 | 05/20/2025 | conversation - virtual agent flag and virtual agent cost |
 | 4.1.12 | 05/19/2025 | conversations - AI agent capabilities method |

data/docs/CartUpsellAfter.md

@@ -6,7 +6,9 @@
 | ---- | ---- | ----------- | ----- |
 | **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] |
 
 ## Example
 
@@ -16,7 +18,9 @@ require 'ultracart_api'
 instance = UltracartClient::CartUpsellAfter.new(
   finalize_after_dts: null,
   finalize_after_minutes: null,
-  upsell_path_code: null
+  upsell_path_code: null,
+  upsell_path_name: null,
+  upsell_path_variation: null
 )
 ```
 

data/docs/ConversationVirtualAgentCapabilities.md

@@ -9,6 +9,8 @@
 | **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] |
@@ -25,6 +27,8 @@ instance = UltracartClient::ConversationVirtualAgentCapabilities.new(
   lookup_order_information: null,
   lookup_subscription_information: null,
   open_support_ticket: null,
+  open_support_ticket_channel: null,
+  open_support_ticket_channel_email: null,
   pause_subscription: null,
   resume_subscription: null,
   transfer_chat_to_live_agent: null,

data/docs/CustomReport.md

@@ -0,0 +1,36 @@
+# 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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::CustomReport.new(
+  chart_javascript: null,
+  chart_javascript_url: null,
+  data_warehouse_report_config_oid: null,
+  dataset_security_level: null,
+  group_name: null,
+  merchant_id: null,
+  name: null,
+  parameters: null,
+  queries: null,
+  tooltips: null
+)
+```
+

data/docs/CustomReportAccountConfig.md

@@ -0,0 +1,34 @@
+# 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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::CustomReportAccountConfig.new(
+  ai_budget: null,
+  ai_usage: null,
+  merchant_id: null,
+  novice_sql_comments: null,
+  opt_in: null,
+  opt_in_by_user: null,
+  opt_in_date: null,
+  sql_budget: null,
+  sql_usage: null
+)
+```
+

data/docs/CustomReportAccountConfigResponse.md

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

data/docs/CustomReportExecutionParameter.md

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

data/docs/CustomReportExecutionRequest.md

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

data/docs/CustomReportParameter.md

@@ -0,0 +1,28 @@
+# 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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::CustomReportParameter.new(
+  display_name: null,
+  meta: null,
+  name: null,
+  options: null,
+  required: null,
+  type: null
+)
+```
+

data/docs/CustomReportParameterOption.md

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

data/docs/CustomReportQuery.md

@@ -0,0 +1,28 @@
+# 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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::CustomReportQuery.new(
+  conditional_formatting_start_column: null,
+  freeze_columns: null,
+  pii_columns: null,
+  query: null,
+  sheet_name: null,
+  title: null
+)
+```
+

data/docs/CustomReportResponse.md

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

data/docs/CustomReportTooltip.md

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

data/docs/CustomReportsResponse.md

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