ultracart_api 4.1.13 → 4.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a946d9c9a1fc472d1268629bdecc625b9b69254fe4ab711e65e2b6bb46ff81e
-  data.tar.gz: cc195035bc8e94040c3abd2564141c632d6ec2ae3bc6149859305938e6fc763d
+  metadata.gz: 88b53e73ee66470db4628071562e135f24c4ed2fd083e8590ce5be1e9e9bbb89
+  data.tar.gz: 61db53c58daef42a6fddd83dfbd4a131ed9ecfd64b579f84ca1a3dc00649824a
 SHA512:
-  metadata.gz: 612d6641cbba23242cb36825571989d82f2148fcac953db69e55c114e57e21833dfb19cda0c5dd650c7972def15542ef840c614aa689c4a8655f22308bf7cca6
-  data.tar.gz: b631b15fbe14bc3e330b58d3f8e9cfc3e20c97b6f13a2fba51a1029a9dc417368837f42227b39788cc658b9b4b5f02052f36b556e2f5ca2b6c4f686f4404c063
+  metadata.gz: e3656f6385e94d3a2d71a86e09364176e42564c10808583f7553441ceb32654f7507cd6ed2d188f3ae4a495695c6c135991058bf01aeb902bd829503408c63e1
+  data.tar.gz: 6c4787a05dd1def0585e5bc55ab64371ebe901c08d630e78aa790d8bd188218ba6618f1b1e29e9f5ad26ea09a54693127263c9e97820dc536f4ec82ea14b216f

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.13
+- Package version: 4.1.15
 - 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.13'
+gem 'ultracart_api', '4.1.15'
 ```
 
 install:
@@ -265,15 +265,22 @@ 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_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 +327,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* | [**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,6 +352,7 @@ Class | Method | HTTP request | Description
 *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* | [**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,16 @@ 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::Customer](docs/Customer.md)
  - [UltracartClient::CustomerActivity](docs/CustomerActivity.md)
  - [UltracartClient::CustomerAffiliate](docs/CustomerAffiliate.md)
@@ -1530,6 +1549,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 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 |
 | 4.1.11 | 05/19/2025 | conversations - virtual AI budgets |

data/docs/AffiliateApi.md

@@ -1,167 +1,123 @@
-# UltracartClient::AffiliateApi
-
-All URIs are relative to *https://secure.ultracart.com/rest/v2*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**get_clicks_by_query**](AffiliateApi.md#get_clicks_by_query) | **POST** /affiliate/clicks/query | Retrieve clicks |
-| [**get_ledgers_by_query**](AffiliateApi.md#get_ledgers_by_query) | **POST** /affiliate/ledgers/query | Retrieve ledger entries |
-
-
-## get_clicks_by_query
-
-> <AffiliateClicksResponse> get_clicks_by_query(click_query, opts)
-
-Retrieve clicks
-
-Retrieves a group of clicks from the account based on a query object.  If no parameters are specified, the API call will fail with a bad request error.  Always specify some parameters to limit the scope of the clicks returned to ones you are truly interested in.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. 
-
-### Examples
-
-```ruby
-require 'time'
-require 'ultracart_api'
-require 'json'
-require 'yaml'
-require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
-
-# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
-# As such, this might not be the best way to use this object.
-# Please see https://github.com/UltraCart/sdk_samples for working examples.
-
-api = UltracartClient::AffiliateApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
-click_query = UltracartClient::AffiliateClickQuery.new # AffiliateClickQuery | Click query
-opts = {
-  _limit: 56, # Integer | The maximum number of records to return on this one API call. (Maximum 10000)
-  _offset: 56, # Integer | Pagination of the record set.  Offset is a zero based index.
-  _expand: '_expand_example' # String | The object expansion to perform on the result.  Only option is link.
-}
-
-begin
-  # Retrieve clicks
-  result = api_instance.get_clicks_by_query(click_query, opts)
-  p result
-rescue UltracartClient::ApiError => e
-  puts "Error when calling AffiliateApi->get_clicks_by_query: #{e}"
-end
-```
-
-#### Using the get_clicks_by_query_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<AffiliateClicksResponse>, Integer, Hash)> get_clicks_by_query_with_http_info(click_query, opts)
-
-```ruby
-begin
-  # Retrieve clicks
-  data, status_code, headers = api_instance.get_clicks_by_query_with_http_info(click_query, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <AffiliateClicksResponse>
-rescue UltracartClient::ApiError => e
-  puts "Error when calling AffiliateApi->get_clicks_by_query_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **click_query** | [**AffiliateClickQuery**](AffiliateClickQuery.md) | Click query |  |
-| **_limit** | **Integer** | The maximum number of records to return on this one API call. (Maximum 10000) | [optional][default to 10000] |
-| **_offset** | **Integer** | Pagination of the record set.  Offset is a zero based index. | [optional][default to 0] |
-| **_expand** | **String** | The object expansion to perform on the result.  Only option is link. | [optional] |
-
-### Return type
-
-[**AffiliateClicksResponse**](AffiliateClicksResponse.md)
-
-### Authorization
-
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## get_ledgers_by_query
-
-> <AffiliateLedgersResponse> get_ledgers_by_query(ledger_query, opts)
-
-Retrieve ledger entries
-
-Retrieves a group of ledger entries from the account based on a query object.  If no parameters are specified, the API call will fail with a bad request error.  Always specify some parameters to limit the scope of the ledgers returned to ones you are truly interested in.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. 
-
-### Examples
-
-```ruby
-require 'time'
-require 'ultracart_api'
-require 'json'
-require 'yaml'
-require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
-
-# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
-# As such, this might not be the best way to use this object.
-# Please see https://github.com/UltraCart/sdk_samples for working examples.
-
-api = UltracartClient::AffiliateApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
-ledger_query = UltracartClient::AffiliateLedgerQuery.new # AffiliateLedgerQuery | Ledger query
-opts = {
-  _limit: 56, # Integer | The maximum number of records to return on this one API call. (Maximum 200)
-  _offset: 56, # Integer | Pagination of the record set.  Offset is a zero based index.
-  _expand: '_expand_example' # String | The object expansion to perform on the result.  Only option is link.
-}
-
-begin
-  # Retrieve ledger entries
-  result = api_instance.get_ledgers_by_query(ledger_query, opts)
-  p result
-rescue UltracartClient::ApiError => e
-  puts "Error when calling AffiliateApi->get_ledgers_by_query: #{e}"
-end
-```
-
-#### Using the get_ledgers_by_query_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<AffiliateLedgersResponse>, Integer, Hash)> get_ledgers_by_query_with_http_info(ledger_query, opts)
-
-```ruby
-begin
-  # Retrieve ledger entries
-  data, status_code, headers = api_instance.get_ledgers_by_query_with_http_info(ledger_query, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <AffiliateLedgersResponse>
-rescue UltracartClient::ApiError => e
-  puts "Error when calling AffiliateApi->get_ledgers_by_query_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **ledger_query** | [**AffiliateLedgerQuery**](AffiliateLedgerQuery.md) | Ledger query |  |
-| **_limit** | **Integer** | The maximum number of records to return on this one API call. (Maximum 200) | [optional][default to 100] |
-| **_offset** | **Integer** | Pagination of the record set.  Offset is a zero based index. | [optional][default to 0] |
-| **_expand** | **String** | The object expansion to perform on the result.  Only option is link. | [optional] |
-
-### Return type
-
-[**AffiliateLedgersResponse**](AffiliateLedgersResponse.md)
-
-### Authorization
-
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
+# UltracartClient::AffiliateApi
+
+All URIs are relative to *https://secure.ultracart.com/rest/v2*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_clicks_by_query**](AffiliateApi.md#get_clicks_by_query) | **POST** /affiliate/clicks/query | Retrieve clicks |
+| [**get_ledgers_by_query**](AffiliateApi.md#get_ledgers_by_query) | **POST** /affiliate/ledgers/query | Retrieve ledger entries |
+
+
+## get_clicks_by_query
+
+> <AffiliateClicksResponse> get_clicks_by_query(click_query, opts)
+
+Retrieve clicks
+
+Retrieves a group of clicks from the account based on a query object.  If no parameters are specified, the API call will fail with a bad request error.  Always specify some parameters to limit the scope of the clicks returned to ones you are truly interested in.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. 
+
+
+### Examples
+
+```ruby
+# Internal API.  No samples are provided as merchants will never need this api method
+```
+
+
+#### Using the get_clicks_by_query_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AffiliateClicksResponse>, Integer, Hash)> get_clicks_by_query_with_http_info(click_query, opts)
+
+```ruby
+begin
+  # Retrieve clicks
+  data, status_code, headers = api_instance.get_clicks_by_query_with_http_info(click_query, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AffiliateClicksResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling AffiliateApi->get_clicks_by_query_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **click_query** | [**AffiliateClickQuery**](AffiliateClickQuery.md) | Click query |  |
+| **_limit** | **Integer** | The maximum number of records to return on this one API call. (Maximum 10000) | [optional][default to 10000] |
+| **_offset** | **Integer** | Pagination of the record set.  Offset is a zero based index. | [optional][default to 0] |
+| **_expand** | **String** | The object expansion to perform on the result.  Only option is link. | [optional] |
+
+### Return type
+
+[**AffiliateClicksResponse**](AffiliateClicksResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_ledgers_by_query
+
+> <AffiliateLedgersResponse> get_ledgers_by_query(ledger_query, opts)
+
+Retrieve ledger entries
+
+Retrieves a group of ledger entries from the account based on a query object.  If no parameters are specified, the API call will fail with a bad request error.  Always specify some parameters to limit the scope of the ledgers returned to ones you are truly interested in.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. 
+
+
+### Examples
+
+```ruby
+# Internal API.  No samples are provided as merchants will never need this api method
+```
+
+
+#### Using the get_ledgers_by_query_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AffiliateLedgersResponse>, Integer, Hash)> get_ledgers_by_query_with_http_info(ledger_query, opts)
+
+```ruby
+begin
+  # Retrieve ledger entries
+  data, status_code, headers = api_instance.get_ledgers_by_query_with_http_info(ledger_query, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AffiliateLedgersResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling AffiliateApi->get_ledgers_by_query_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ledger_query** | [**AffiliateLedgerQuery**](AffiliateLedgerQuery.md) | Ledger query |  |
+| **_limit** | **Integer** | The maximum number of records to return on this one API call. (Maximum 200) | [optional][default to 100] |
+| **_offset** | **Integer** | Pagination of the record set.  Offset is a zero based index. | [optional][default to 0] |
+| **_expand** | **String** | The object expansion to perform on the result.  Only option is link. | [optional] |
+
+### Return type
+
+[**AffiliateLedgersResponse**](AffiliateLedgersResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+