ultracart_api 4.1.121 → 4.1.124

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d5d871e0bb19eab14c055ac6a5c89c7ced3ca2c9127aab28c17c15721f51e22
-  data.tar.gz: 8fba28391554e4fe29d510482bd37805a01d3c313d94c50e6f4818df9cd91425
+  metadata.gz: 18d43bd543cc8099b995151cb2e8eba1b3d395ebf4295b7dda09f6e0b551e6ff
+  data.tar.gz: 31bdb671cf67931fdfd9cebd7dcc86a9c62a625b7582db370f43def75bb61b1e
 SHA512:
-  metadata.gz: 1294d57bcd66fae30a395c4306a060acc3d68f61657363453222cf5e797cd03667f737e2889c23f452357784978e69e75439c0850f6f0299ddf1b97f1f492ef6
-  data.tar.gz: 281ca6e2d950f6eab70a5cc311fffa540c105b074238a3e9c29114414f3c90e1e4dca0f7e3700fe69a5c15c3598bbd2b14f890ea301b8798544ecde9abb17a14
+  metadata.gz: dc463b0191fd737be10900d9ad5099d5fb66460f356b6976222873d7f8161ff399744eeb4401dd5b0c1a1253689bcdb308507f1c3886b466b9b075e09ff694a5
+  data.tar.gz: 9579f70e1d58c91f7a3b2fb9c89c38db34adc26b28deb6e5e18414006926ba69c703b72e51e37730329af97d3bd730f1012a19f4f9583a4128bf689013f3dddd

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.121
+- Package version: 4.1.124
 - 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.121'
+gem 'ultracart_api', '4.1.124'
 ```
 
 install:
@@ -90,6 +90,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::AffiliateApi* | [**insert_affiliate**](docs/AffiliateApi.md#insert_affiliate) | **POST** /affiliate/affiliates | Insert an affiliate
 *UltracartClient::AffiliateApi* | [**send_affiliate_welcome_email**](docs/AffiliateApi.md#send_affiliate_welcome_email) | **POST** /affiliate/affiliates/{affiliate_oid}/welcome_email | Send a welcome email to an affiliate
 *UltracartClient::AffiliateApi* | [**update_affiliate**](docs/AffiliateApi.md#update_affiliate) | **PUT** /affiliate/affiliates/{affiliate_oid} | Update an affiliate
+*UltracartClient::AutoOrderApi* | [**attempt_auto_order_rebill**](docs/AutoOrderApi.md#attempt_auto_order_rebill) | **POST** /auto_order/auto_orders/{auto_order_oid}/rebill | Attempt a failed rebill on an auto order
 *UltracartClient::AutoOrderApi* | [**cancel_auto_order_item_by_reference_order_id**](docs/AutoOrderApi.md#cancel_auto_order_item_by_reference_order_id) | **POST** /auto_order/auto_orders/reference_order_id/{reference_order_id}/items/original/{original_item_id}/cancel | Cancel a single item on an auto order
 *UltracartClient::AutoOrderApi* | [**consolidate_auto_orders**](docs/AutoOrderApi.md#consolidate_auto_orders) | **PUT** /auto_order/auto_orders/{auto_order_oid}/consolidate | Consolidates multiple auto orders
 *UltracartClient::AutoOrderApi* | [**establish_auto_order_by_reference_order_id**](docs/AutoOrderApi.md#establish_auto_order_by_reference_order_id) | **POST** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Establish an auto order by referencing a regular order id
@@ -105,6 +106,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::AutoOrderApi* | [**update_auto_order**](docs/AutoOrderApi.md#update_auto_order) | **PUT** /auto_order/auto_orders/{auto_order_oid} | Update an auto order
 *UltracartClient::AutoOrderApi* | [**update_auto_order_item_add_ons**](docs/AutoOrderApi.md#update_auto_order_item_add_ons) | **PUT** /auto_order/auto_orders/{auto_order_oid}/items/{auto_order_item_oid}/add_ons | Update an auto order item add ons
 *UltracartClient::AutoOrderApi* | [**update_auto_order_item_properties**](docs/AutoOrderApi.md#update_auto_order_item_properties) | **PUT** /auto_order/auto_orders/{auto_order_oid}/items/{auto_order_item_oid}/properties | Update an auto order item properties
+*UltracartClient::AutoOrderApi* | [**update_auto_order_payment**](docs/AutoOrderApi.md#update_auto_order_payment) | **PUT** /auto_order/auto_orders/{auto_order_oid}/payment | Update the payment information on an auto order
 *UltracartClient::AutoOrderApi* | [**update_auto_order_properties**](docs/AutoOrderApi.md#update_auto_order_properties) | **PUT** /auto_order/auto_orders/{auto_order_oid}/properties | Update an auto order properties
 *UltracartClient::AutoOrderApi* | [**update_auto_orders_batch**](docs/AutoOrderApi.md#update_auto_orders_batch) | **PUT** /auto_order/auto_orders/batch | Update multiple auto orders
 *UltracartClient::BulkApi* | [**bulk_cancel_job**](docs/BulkApi.md#bulk_cancel_job) | **DELETE** /bulk/{object}/{job_id} | Request cancellation of a bulk job
@@ -335,6 +337,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::CustomerApi* | [**search_customers**](docs/CustomerApi.md#search_customers) | **GET** /customer/customers/search | Search for customers
 *UltracartClient::CustomerApi* | [**update_customer**](docs/CustomerApi.md#update_customer) | **PUT** /customer/customers/{customer_profile_oid} | Update a customer
 *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_customer_email_suppression**](docs/CustomerApi.md#update_customer_email_suppression) | **POST** /customer/customers/{customer_profile_oid}/email_suppression | Clear email suppression 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* | [**analyze_custom_report**](docs/DatawarehouseApi.md#analyze_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid}/analysis | Analyze a custom report
@@ -764,10 +767,12 @@ Class | Method | HTTP request | Description
  - [UltracartClient::AutoOrderItemSimpleSchedule](docs/AutoOrderItemSimpleSchedule.md)
  - [UltracartClient::AutoOrderLog](docs/AutoOrderLog.md)
  - [UltracartClient::AutoOrderManagement](docs/AutoOrderManagement.md)
+ - [UltracartClient::AutoOrderPaymentUpdateRequest](docs/AutoOrderPaymentUpdateRequest.md)
  - [UltracartClient::AutoOrderPropertiesUpdateRequest](docs/AutoOrderPropertiesUpdateRequest.md)
  - [UltracartClient::AutoOrderProperty](docs/AutoOrderProperty.md)
  - [UltracartClient::AutoOrderQuery](docs/AutoOrderQuery.md)
  - [UltracartClient::AutoOrderQueryBatch](docs/AutoOrderQueryBatch.md)
+ - [UltracartClient::AutoOrderRebillResponse](docs/AutoOrderRebillResponse.md)
  - [UltracartClient::AutoOrderResponse](docs/AutoOrderResponse.md)
  - [UltracartClient::AutoOrdersRequest](docs/AutoOrdersRequest.md)
  - [UltracartClient::AutoOrdersResponse](docs/AutoOrdersResponse.md)
@@ -1153,6 +1158,9 @@ Class | Method | HTTP request | Description
  - [UltracartClient::CustomerEditorValues](docs/CustomerEditorValues.md)
  - [UltracartClient::CustomerEmail](docs/CustomerEmail.md)
  - [UltracartClient::CustomerEmailListChanges](docs/CustomerEmailListChanges.md)
+ - [UltracartClient::CustomerEmailSuppressionRequest](docs/CustomerEmailSuppressionRequest.md)
+ - [UltracartClient::CustomerEmailSuppressionResponse](docs/CustomerEmailSuppressionResponse.md)
+ - [UltracartClient::CustomerEmailSuppressionResult](docs/CustomerEmailSuppressionResult.md)
  - [UltracartClient::CustomerLoyalty](docs/CustomerLoyalty.md)
  - [UltracartClient::CustomerLoyaltyLedger](docs/CustomerLoyaltyLedger.md)
  - [UltracartClient::CustomerLoyaltyRedemption](docs/CustomerLoyaltyRedemption.md)
@@ -1300,6 +1308,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::EmailStepStatResponse](docs/EmailStepStatResponse.md)
  - [UltracartClient::EmailStepWaitingRequest](docs/EmailStepWaitingRequest.md)
  - [UltracartClient::EmailStepWaitingResponse](docs/EmailStepWaitingResponse.md)
+ - [UltracartClient::EmailSuppressionSurfaces](docs/EmailSuppressionSurfaces.md)
  - [UltracartClient::EmailTemplate](docs/EmailTemplate.md)
  - [UltracartClient::EmailTemplatesResponse](docs/EmailTemplatesResponse.md)
  - [UltracartClient::EmailThirdPartyList](docs/EmailThirdPartyList.md)
@@ -1825,6 +1834,9 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.124 | 08/04/2026 | customer - method to remove customer profile from email suppression |
+| 4.1.123 | 08/04/2026 | customer - method to remove customer profile from email suppression |
+| 4.1.122 | 07/29/2026 | auto order api - new methods for payment information and rebill |
 | 4.1.121 | 07/15/2026 | storefront - parameter to include details on dispatch log methods |
 | 4.1.120 | 07/15/2026 | storefront - parameter to include details on dispatch log methods |
 | 4.1.119 | 07/15/2026 | order api - query transaction details for cache target |

data/docs/AutoOrderApi.md

@@ -4,6 +4,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**attempt_auto_order_rebill**](AutoOrderApi.md#attempt_auto_order_rebill) | **POST** /auto_order/auto_orders/{auto_order_oid}/rebill | Attempt a failed rebill on an auto order |
 | [**cancel_auto_order_item_by_reference_order_id**](AutoOrderApi.md#cancel_auto_order_item_by_reference_order_id) | **POST** /auto_order/auto_orders/reference_order_id/{reference_order_id}/items/original/{original_item_id}/cancel | Cancel a single item on an auto order |
 | [**consolidate_auto_orders**](AutoOrderApi.md#consolidate_auto_orders) | **PUT** /auto_order/auto_orders/{auto_order_oid}/consolidate | Consolidates multiple auto orders |
 | [**establish_auto_order_by_reference_order_id**](AutoOrderApi.md#establish_auto_order_by_reference_order_id) | **POST** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Establish an auto order by referencing a regular order id |
@@ -19,10 +20,65 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**update_auto_order**](AutoOrderApi.md#update_auto_order) | **PUT** /auto_order/auto_orders/{auto_order_oid} | Update an auto order |
 | [**update_auto_order_item_add_ons**](AutoOrderApi.md#update_auto_order_item_add_ons) | **PUT** /auto_order/auto_orders/{auto_order_oid}/items/{auto_order_item_oid}/add_ons | Update an auto order item add ons |
 | [**update_auto_order_item_properties**](AutoOrderApi.md#update_auto_order_item_properties) | **PUT** /auto_order/auto_orders/{auto_order_oid}/items/{auto_order_item_oid}/properties | Update an auto order item properties |
+| [**update_auto_order_payment**](AutoOrderApi.md#update_auto_order_payment) | **PUT** /auto_order/auto_orders/{auto_order_oid}/payment | Update the payment information on an auto order |
 | [**update_auto_order_properties**](AutoOrderApi.md#update_auto_order_properties) | **PUT** /auto_order/auto_orders/{auto_order_oid}/properties | Update an auto order properties |
 | [**update_auto_orders_batch**](AutoOrderApi.md#update_auto_orders_batch) | **PUT** /auto_order/auto_orders/batch | Update multiple auto orders |
 
 
+## attempt_auto_order_rebill
+
+> <AutoOrderRebillResponse> attempt_auto_order_rebill(auto_order_oid, opts)
+
+Attempt a failed rebill on an auto order
+
+Attempts to rebill an auto order using the payment information already on the original order.  The attempt is refused if the auto order is scheduled to charge within the next five minutes, or if it was already billed within the last 24 hours, both of which guard against double charging.  Runs synchronously and may take some time while the gateway is contacted.  A declined card is reported in the response body rather than as an API error. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the attempt_auto_order_rebill_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AutoOrderRebillResponse>, Integer, Hash)> attempt_auto_order_rebill_with_http_info(auto_order_oid, opts)
+
+```ruby
+begin
+  # Attempt a failed rebill on an auto order
+  data, status_code, headers = api_instance.attempt_auto_order_rebill_with_http_info(auto_order_oid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AutoOrderRebillResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling AutoOrderApi->attempt_auto_order_rebill_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auto_order_oid** | **Integer** | The auto order oid to rebill. |  |
+| **_expand** | **String** | The object expansion to perform on the result.  See documentation for examples | [optional] |
+
+### Return type
+
+[**AutoOrderRebillResponse**](AutoOrderRebillResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## cancel_auto_order_item_by_reference_order_id
 
 > <AutoOrderResponse> cancel_auto_order_item_by_reference_order_id(reference_order_id, original_item_id, opts)
@@ -1430,6 +1486,61 @@ end
 - **Accept**: application/json
 
 
+## update_auto_order_payment
+
+> <AutoOrderRebillResponse> update_auto_order_payment(auto_order_oid, auto_order_payment_update_request, opts)
+
+Update the payment information on an auto order
+
+Updates the credit card on the original order behind an auto order, along with any rebills sitting in accounts receivable, and reactivates the auto order.  Card data is accepted as hosted field tokens only. raw card numbers and card verification numbers are rejected.  Set attempt_rebill to true to also attempt the rebill immediately, which runs synchronously and may take some time while the gateway is contacted.  A declined card is reported in the response body rather than as an API error. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the update_auto_order_payment_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AutoOrderRebillResponse>, Integer, Hash)> update_auto_order_payment_with_http_info(auto_order_oid, auto_order_payment_update_request, opts)
+
+```ruby
+begin
+  # Update the payment information on an auto order
+  data, status_code, headers = api_instance.update_auto_order_payment_with_http_info(auto_order_oid, auto_order_payment_update_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AutoOrderRebillResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling AutoOrderApi->update_auto_order_payment_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auto_order_oid** | **Integer** | The auto order oid to update payment information on. |  |
+| **auto_order_payment_update_request** | [**AutoOrderPaymentUpdateRequest**](AutoOrderPaymentUpdateRequest.md) | Payment information to place on the auto order |  |
+| **_expand** | **String** | The object expansion to perform on the result.  See documentation for examples | [optional] |
+
+### Return type
+
+[**AutoOrderRebillResponse**](AutoOrderRebillResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json; charset=UTF-8
+- **Accept**: application/json
+
+
 ## update_auto_order_properties
 
 > <AutoOrderResponse> update_auto_order_properties(auto_order_oid, auto_order_properties_update_request, opts)

data/docs/AutoOrderPaymentUpdateRequest.md

@@ -0,0 +1,28 @@
+# UltracartClient::AutoOrderPaymentUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **attempt_rebill** | **Boolean** | Attempt to rebill the auto order immediately after the payment information is updated.  Defaults to false. | [optional] |
+| **card_expiration_month** | **Integer** | Card expiration month (1-12) | [optional] |
+| **card_expiration_year** | **Integer** | Card expiration year (four digit) | [optional] |
+| **card_number_token** | **String** | Hosted field token for the credit card number.  Tokens are valid for two hours. | [optional] |
+| **card_type** | **String** | Credit card type.  Optional.  When the hosted field token carries the card type, the token wins. | [optional] |
+| **card_verification_number_token** | **String** | Hosted field token for the card verification number (CVV).  Required when the order has a vaulted card that must be re-vaulted. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::AutoOrderPaymentUpdateRequest.new(
+  attempt_rebill: null,
+  card_expiration_month: null,
+  card_expiration_year: null,
+  card_number_token: null,
+  card_type: null,
+  card_verification_number_token: null
+)
+```
+

data/docs/AutoOrderRebillResponse.md

@@ -0,0 +1,34 @@
+# UltracartClient::AutoOrderRebillResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auto_order** | [**AutoOrder**](AutoOrder.md) |  | [optional] |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **failure_reason** | **String** | Why the rebill attempt did not succeed | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **rebill_attempted** | **Boolean** | True if a rebill was attempted during this call | [optional] |
+| **rebill_order_id** | **String** | The order id created by a successful rebill | [optional] |
+| **rebill_success** | **Boolean** | True if the rebill attempt produced an order | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::AutoOrderRebillResponse.new(
+  auto_order: null,
+  error: null,
+  failure_reason: null,
+  metadata: null,
+  rebill_attempted: null,
+  rebill_order_id: null,
+  rebill_success: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/CustomerApi.md

@@ -28,6 +28,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**search_customers**](CustomerApi.md#search_customers) | **GET** /customer/customers/search | Search for customers |
 | [**update_customer**](CustomerApi.md#update_customer) | **PUT** /customer/customers/{customer_profile_oid} | Update a customer |
 | [**update_customer_email_lists**](CustomerApi.md#update_customer_email_lists) | **POST** /customer/customers/{customer_profile_oid}/email_lists | Update email list subscriptions for a customer |
+| [**update_customer_email_suppression**](CustomerApi.md#update_customer_email_suppression) | **POST** /customer/customers/{customer_profile_oid}/email_suppression | Clear email suppression for a customer |
 | [**update_wish_list_item**](CustomerApi.md#update_wish_list_item) | **PUT** /customer/customers/{customer_profile_oid}/wishlist/{customer_wishlist_item_oid} | Update a customer wishlist item |
 | [**validate_email_verification_token**](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 |
 
@@ -2445,6 +2446,60 @@ end
 - **Accept**: application/json
 
 
+## update_customer_email_suppression
+
+> <CustomerEmailSuppressionResponse> update_customer_email_suppression(customer_profile_oid, suppression_changes)
+
+Clear email suppression for a customer
+
+Clears global unsubscribe, spam complaint and/or bounce suppression for a customer.  This method is clear-only and cannot set a suppression flag.  Clearing a suppression removes the send gate but does not subscribe the customer to any email list -- list membership survives a global unsubscribe untouched, so the customer's original lists become deliverable again with no further action.  Returns 200 with a warning if the flags were cleared but an upstream ESP suppression removal failed; the profile was still modified in that case. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the update_customer_email_suppression_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomerEmailSuppressionResponse>, Integer, Hash)> update_customer_email_suppression_with_http_info(customer_profile_oid, suppression_changes)
+
+```ruby
+begin
+  # Clear email suppression for a customer
+  data, status_code, headers = api_instance.update_customer_email_suppression_with_http_info(customer_profile_oid, suppression_changes)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomerEmailSuppressionResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling CustomerApi->update_customer_email_suppression_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_profile_oid** | **Integer** | The customer profile oid |  |
+| **suppression_changes** | [**CustomerEmailSuppressionRequest**](CustomerEmailSuppressionRequest.md) | Suppression changes |  |
+
+### Return type
+
+[**CustomerEmailSuppressionResponse**](CustomerEmailSuppressionResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json; charset=UTF-8
+- **Accept**: application/json
+
+
 ## update_wish_list_item
 
 > <CustomerWishListItem> update_wish_list_item(customer_profile_oid, customer_wishlist_item_oid, wishlist_item)

data/docs/CustomerEmailSuppressionRequest.md

@@ -0,0 +1,26 @@
+# UltracartClient::CustomerEmailSuppressionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **clear_bounce** | **Boolean** | Clear bounce suppression for this address.  Bounce has no per-customer flag; it exists only on the suppression tables. | [optional] |
+| **clear_global_unsubscribe** | **Boolean** | Clear the global unsubscribe flag.  No-op if it is already clear. | [optional] |
+| **clear_spam_complaint** | **Boolean** | Clear the spam complaint flag.  Requires a reason.  No-op if it is already clear. | [optional] |
+| **consent_source** | **String** | How the customer communicated consent. | [optional] |
+| **reason** | **String** | Justification for the clear.  Required when clearing a spam complaint.  Retained on the audit record. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::CustomerEmailSuppressionRequest.new(
+  clear_bounce: null,
+  clear_global_unsubscribe: null,
+  clear_spam_complaint: null,
+  consent_source: null,
+  reason: null
+)
+```
+

data/docs/CustomerEmailSuppressionResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::CustomerEmailSuppressionResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email_suppression** | [**CustomerEmailSuppressionResult**](CustomerEmailSuppressionResult.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::CustomerEmailSuppressionResponse.new(
+  email_suppression: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/CustomerEmailSuppressionResult.md

@@ -0,0 +1,40 @@
+# UltracartClient::CustomerEmailSuppressionResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bounce_cleared** | **Boolean** | True only if this call actually removed bounce suppression.  Bounce has no per-customer flag, so there is no corresponding state field. | [optional] |
+| **customer_profile_oid** | **Integer** | The customer profile oid that was operated on | [optional] |
+| **email** | **String** | The email address that was operated on | [optional] |
+| **esp_suppression_removed** | **Boolean** | True only if every requested suppression surface was successfully cleared.  When false, see esp_warning -- the profile was still modified. | [optional] |
+| **esp_warning** | **String** | Human readable explanation when esp_suppression_removed is false.  Suitable for display to a support agent. | [optional] |
+| **global_unsubscribe_cleared** | **Boolean** | True only if this call actually changed the global unsubscribe flag.  False if it was already clear. | [optional] |
+| **global_unsubscribed** | **Boolean** | Global unsubscribe state AFTER this call | [optional] |
+| **global_unsubscribed_dts** | **String** | Global unsubscribe timestamp after this call.  Nulled when cleared; the prior value is retained on the audit record. | [optional] |
+| **spam_complaint** | **Boolean** | Spam complaint state AFTER this call | [optional] |
+| **spam_complaint_cleared** | **Boolean** | True only if this call actually changed the spam complaint flag.  False if it was already clear. | [optional] |
+| **spam_complaint_dts** | **String** | Spam complaint timestamp after this call.  Nulled when cleared; the prior value is retained on the audit record. | [optional] |
+| **suppression_surfaces** | [**EmailSuppressionSurfaces**](EmailSuppressionSurfaces.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::CustomerEmailSuppressionResult.new(
+  bounce_cleared: null,
+  customer_profile_oid: null,
+  email: null,
+  esp_suppression_removed: null,
+  esp_warning: null,
+  global_unsubscribe_cleared: null,
+  global_unsubscribed: null,
+  global_unsubscribed_dts: null,
+  spam_complaint: null,
+  spam_complaint_cleared: null,
+  spam_complaint_dts: null,
+  suppression_surfaces: null
+)
+```
+

data/docs/EmailSettings.md

@@ -7,6 +7,7 @@
 | **emails_per_day** | **Integer** | Emails per day allowed | [optional] |
 | **emails_per_hour** | **Integer** | Emails per hour allowed | [optional] |
 | **emails_per_month** | **Integer** | Emails per month allowed | [optional] |
+| **machine_open_ignore** | **Boolean** | If machine open should be ignored | [optional] |
 | **marketing_esp_domain_user** | **String** |  | [optional] |
 | **marketing_esp_domain_uuid** | **String** |  | [optional] |
 | **marketing_esp_friendly_name** | **String** |  | [optional] |
@@ -33,6 +34,7 @@ instance = UltracartClient::EmailSettings.new(
   emails_per_day: null,
   emails_per_hour: null,
   emails_per_month: null,
+  machine_open_ignore: null,
   marketing_esp_domain_user: null,
   marketing_esp_domain_uuid: null,
   marketing_esp_friendly_name: null,

data/docs/EmailSuppressionSurfaces.md

@@ -0,0 +1,22 @@
+# UltracartClient::EmailSuppressionSurfaces
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **central_ses_suppression** | **String** | Outcome of removing the address from the central cross-account ses_suppression table | [optional] |
+| **esp_customer_flags** | **String** | Outcome of clearing the per-customer send gates on esp_customer | [optional] |
+| **ses_account_suppression** | **String** | Outcome of removing the address from the SES-native account-level suppression list | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::EmailSuppressionSurfaces.new(
+  central_ses_suppression: null,
+  esp_customer_flags: null,
+  ses_account_suppression: null
+)
+```
+

data/docs/TaxCountry.md

@@ -13,6 +13,8 @@
 | **tax_rate** | **Float** | Tax Rate | [optional] |
 | **tax_rate_formatted** | **String** | Tax rate formatted | [optional] |
 | **tax_shipping** | **Boolean** | True if taxation within this jurisdiction should charge tax on shipping | [optional] |
+| **vat_threshold** | **Float** | VAT collection threshold for this country. Blank means no threshold, 0 always collects VAT, a positive value collects at or below that order subtotal. | [optional] |
+| **vat_threshold_currency** | **String** | Currency code the vat_threshold amount is expressed in (USD, EUR or GBP). | [optional] |
 
 ## Example
 
@@ -28,7 +30,9 @@ instance = UltracartClient::TaxCountry.new(
   tax_gift_wrap: null,
   tax_rate: null,
   tax_rate_formatted: null,
-  tax_shipping: null
+  tax_shipping: null,
+  vat_threshold: null,
+  vat_threshold_currency: null
 )
 ```
 

data/docs/TaxState.md

@@ -22,6 +22,8 @@
 | **tax_rate_formatted** | **String** | Tax rate formatted | [optional] |
 | **tax_shipping** | **Boolean** | True if taxation within this jurisdiction should charge tax on shipping | [optional] |
 | **use_ultracart_managed_rates** | **Boolean** | If true, use UltraCart managed rates for this state | [optional] |
+| **vat_threshold** | **Float** | VAT collection threshold override for this region. Blank inherits the country threshold, 0 always collects VAT, a positive value collects at or below that order subtotal. | [optional] |
+| **vat_threshold_currency** | **String** | Currency code the vat_threshold amount is expressed in (USD, EUR or GBP). | [optional] |
 
 ## Example
 
@@ -46,7 +48,9 @@ instance = UltracartClient::TaxState.new(
   tax_rate: null,
   tax_rate_formatted: null,
   tax_shipping: null,
-  use_ultracart_managed_rates: null
+  use_ultracart_managed_rates: null,
+  vat_threshold: null,
+  vat_threshold_currency: null
 )
 ```