ultracart_api 4.1.122 → 4.1.125

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71942b52f2c627128d180191ed15c60a07c07c82127fee920cf3126817de23f5
-  data.tar.gz: 649eda60fe73357484d88de638a90d6edccf883518b6ffb244f30a96e9a0414d
+  metadata.gz: a71acd908c524b94f7e117ea4cec002493901b2171f8292407d536f20f6edd53
+  data.tar.gz: 0c466b1d4a0e3595efe0182e6fdc1e620eb370912827a8cded022bbbee3b360c
 SHA512:
-  metadata.gz: 6e88efbd8fb93c3f7089c44acb19cc70e53661c2c79d16205b68888f3211f1d0581823736ae644973380a1841a7b33ec175f4787216cfb3e325e892a30b98772
-  data.tar.gz: 8a003fbcb04fc63a0389f864eba35a23d4c975f7f7725dad7a6635a8d2b403561253653bfa46d9e96f61eab7ea0d85e46e5d0a75de586e87a70b235e0fd88eed
+  metadata.gz: 4743f2e25a72ba9aed40fd369c1c5af781105d792c3ad045495ef802c8d6c505d434bf9aa216e213d104dca464b18681a94b387450e852ee23108e4724ff18c9
+  data.tar.gz: a74c0b65fb892c24923dd7301438421198870eebe0ca09924a3055ce98109a183e8077115177821644f2d31817cf45028cb84c763ff7b12878559a2afacc2213

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.122
+- Package version: 4.1.125
 - 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.122'
+gem 'ultracart_api', '4.1.125'
 ```
 
 install:
@@ -337,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
@@ -1157,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)
@@ -1304,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)
@@ -1829,6 +1834,9 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.125 | 08/06/2026 | order api - ability to query by bin and last 4 in unlimited scenarios for chargeback order association |
+| 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 |

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/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/OrderQuery.md

@@ -4,6 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **card_bin** | **String** | First six digits (BIN) of the credit card number.  Must be specified together with card_last4 and a payment_date_begin/payment_date_end range.  Requires query_target=cache. | [optional] |
+| **card_last4** | **String** | Last four digits of the credit card number.  Must be specified together with card_bin and a payment_date_begin/payment_date_end range.  Always supply four digits, including for American Express.  Requires query_target=cache. | [optional] |
 | **cc_email** | **String** | CC Email | [optional] |
 | **channel_partner_code** | **String** | The code of the channel partner | [optional] |
 | **channel_partner_order_id** | **String** | The order ID assigned by the channel partner for this order | [optional] |
@@ -32,7 +34,7 @@
 | **payment_date_begin** | **String** | Date/time that the order was successfully processed | [optional] |
 | **payment_date_end** | **String** | Date/time that the order was successfully processed | [optional] |
 | **payment_method** | **String** | Payment method | [optional] |
-| **payment_transaction_filters** | [**Array<OrderQueryPaymentTransactionFilter>**](OrderQueryPaymentTransactionFilter.md) | Exact-match filters on the detail name/value pairs of a single payment transaction, AND-ed against the same transaction. Requires query_target=cache which uses the ElasticSearch cache. The origin or database path cannot search transaction details. The rotating gateway is just another pair, name equals rotatingTransactionGatewayCode or rotatingTransactionGatewayName. | [optional] |
+| **payment_transaction_filters** | [**Array<OrderQueryPaymentTransactionFilter>**](OrderQueryPaymentTransactionFilter.md) | Exact-match filters on the detail name/value pairs of a single payment transaction, AND-ed against the same transaction. Requires query_target=cache. The origin or database path cannot search transaction details. The rotating gateway is just another pair, name equals rotatingTransactionGatewayCode or rotatingTransactionGatewayName. | [optional] |
 | **phone** | **String** | Phone | [optional] |
 | **postal_code** | **String** | Postal code | [optional] |
 | **purchase_order_number** | **String** | Purchase order number | [optional] |
@@ -55,6 +57,8 @@
 require 'ultracart_api'
 
 instance = UltracartClient::OrderQuery.new(
+  card_bin: null,
+  card_last4: null,
   cc_email: null,
   channel_partner_code: null,
   channel_partner_order_id: 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
 )
 ```
 

data/lib/ultracart_api/api/customer_api.rb

@@ -1790,6 +1790,81 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # 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. 
+    # @param customer_profile_oid [Integer] The customer profile oid
+    # @param suppression_changes [CustomerEmailSuppressionRequest] Suppression changes
+    # @param [Hash] opts the optional parameters
+    # @return [CustomerEmailSuppressionResponse]
+    def update_customer_email_suppression(customer_profile_oid, suppression_changes, opts = {})
+      data, _status_code, _headers = update_customer_email_suppression_with_http_info(customer_profile_oid, suppression_changes, opts)
+      data
+    end
+
+    # 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. 
+    # @param customer_profile_oid [Integer] The customer profile oid
+    # @param suppression_changes [CustomerEmailSuppressionRequest] Suppression changes
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomerEmailSuppressionResponse, Integer, Hash)>] CustomerEmailSuppressionResponse data, response status code and response headers
+    def update_customer_email_suppression_with_http_info(customer_profile_oid, suppression_changes, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CustomerApi.update_customer_email_suppression ...'
+      end
+      # verify the required parameter 'customer_profile_oid' is set
+      if @api_client.config.client_side_validation && customer_profile_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'customer_profile_oid' when calling CustomerApi.update_customer_email_suppression"
+      end
+      # verify the required parameter 'suppression_changes' is set
+      if @api_client.config.client_side_validation && suppression_changes.nil?
+        fail ArgumentError, "Missing the required parameter 'suppression_changes' when calling CustomerApi.update_customer_email_suppression"
+      end
+      # resource path
+      local_var_path = '/customer/customers/{customer_profile_oid}/email_suppression'.sub('{' + 'customer_profile_oid' + '}', CGI.escape(customer_profile_oid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(suppression_changes)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CustomerEmailSuppressionResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"CustomerApi.update_customer_email_suppression",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CustomerApi#update_customer_email_suppression\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update a customer wishlist item
     # Update a customer wishlist item 
     # @param customer_profile_oid [Integer] The customer oid for this wishlist.