ultracart_api 4.1.96 → 4.1.97

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50eea23bef9f9f23d5b91c373e5803ac371c99850e7e7f83d48cfd7c6e050d63
-  data.tar.gz: dd2430fbdeab17b5943efc2bfe6d1ba169a70658400a039ea263ba934197ef22
+  metadata.gz: 713e1c8d45bf621b2beb0af2a5f2cca5ad01b5e795c9ec44ba18144ecbadf65d
+  data.tar.gz: 06ab9e7eeeed38e86531b06b460cfe891c323613467aff6a7e79348660a48d44
 SHA512:
-  metadata.gz: 8f09615e424ca49497814e9d58eee3648e95c609fe61657572272805f9d657db4383019790f7fc562031099111c0c8549b583be115a56ba58dcb2b88652b983d
-  data.tar.gz: 995b0794acf0d36b77a618b399dbc216fef8286e56c1ed7a3ef432ef05c8ac49268922565020af645023d3b35b5548872767694475b032bd2035bad457b6c57b
+  metadata.gz: b8f837b96fde9815b8104b28b10b2b0e7019f54959fb1e5eb3f3bd0190ee4eab5ce81ef6f58bf7fb124a86bb077403caab63669ba2e07b68b9c626abcd9fe613
+  data.tar.gz: 66485a5d84cfb2646bc4ceaee71965a54a2894007fa88b4e8897c83faeb511f0d544341f9f653e771aac2ba838e98bc86407ac7428345b50ec768c3ced7eaa5b

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.96
+- Package version: 4.1.97
 - 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.96'
+gem 'ultracart_api', '4.1.97'
 ```
 
 install:
@@ -353,8 +353,9 @@ Class | Method | HTTP request | Description
 *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::FraudApi* | [**decline_email**](docs/FraudApi.md#decline_email) | **POST** /fraud/decline_email | Decline emails during checkout fraud review
+*UltracartClient::FraudApi* | [**decline_email**](docs/FraudApi.md#decline_email) | **POST** /fraud/decline_email | Decline email during checkout fraud review
 *UltracartClient::FraudApi* | [**delete_fraud_rule**](docs/FraudApi.md#delete_fraud_rule) | **DELETE** /fraud/rules/{fraud_rule_oid} | Delete a fraud rule
+*UltracartClient::FraudApi* | [**establish_fraud_rules_from_order**](docs/FraudApi.md#establish_fraud_rules_from_order) | **POST** /fraud/rules/from_order | Establish fraud rules from an order
 *UltracartClient::FraudApi* | [**get_fraud_lookup_values**](docs/FraudApi.md#get_fraud_lookup_values) | **GET** /fraud/lookup_values | Retrieve fraud rule lookup values
 *UltracartClient::FraudApi* | [**insert_fraud_rule**](docs/FraudApi.md#insert_fraud_rule) | **POST** /fraud/rules | Insert a fraud rule
 *UltracartClient::FraudApi* | [**search_fraud_rules**](docs/FraudApi.md#search_fraud_rules) | **POST** /fraud/rules/search | Search fraud rules
@@ -1279,8 +1280,12 @@ Class | Method | HTTP request | Description
  - [UltracartClient::FileManagerUploadRequest](docs/FileManagerUploadRequest.md)
  - [UltracartClient::FileManagerUploadUrlResponse](docs/FileManagerUploadUrlResponse.md)
  - [UltracartClient::FraudDeclineEmailRequest](docs/FraudDeclineEmailRequest.md)
+ - [UltracartClient::FraudLookupAffiliate](docs/FraudLookupAffiliate.md)
+ - [UltracartClient::FraudLookupGateway](docs/FraudLookupGateway.md)
+ - [UltracartClient::FraudLookupTheme](docs/FraudLookupTheme.md)
  - [UltracartClient::FraudLookupValues](docs/FraudLookupValues.md)
  - [UltracartClient::FraudLookupValuesResponse](docs/FraudLookupValuesResponse.md)
+ - [UltracartClient::FraudRuleFromOrderRequest](docs/FraudRuleFromOrderRequest.md)
  - [UltracartClient::FraudRuleInsertRequest](docs/FraudRuleInsertRequest.md)
  - [UltracartClient::FraudRuleItemFilter](docs/FraudRuleItemFilter.md)
  - [UltracartClient::FraudRulePublic](docs/FraudRulePublic.md)
@@ -1769,6 +1774,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.97 | 06/03/2026 | fraud api alpha version |
 | 4.1.96 | 06/03/2026 | fraud api alpha build |
 | 4.1.95 | 06/02/2026 | fraud api alpha version |
 | 4.1.94 | 06/02/2026 | fraud api alpha version |

data/docs/FraudApi.md

@@ -4,8 +4,9 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**decline_email**](FraudApi.md#decline_email) | **POST** /fraud/decline_email | Decline emails during checkout fraud review |
+| [**decline_email**](FraudApi.md#decline_email) | **POST** /fraud/decline_email | Decline email during checkout fraud review |
 | [**delete_fraud_rule**](FraudApi.md#delete_fraud_rule) | **DELETE** /fraud/rules/{fraud_rule_oid} | Delete a fraud rule |
+| [**establish_fraud_rules_from_order**](FraudApi.md#establish_fraud_rules_from_order) | **POST** /fraud/rules/from_order | Establish fraud rules from an order |
 | [**get_fraud_lookup_values**](FraudApi.md#get_fraud_lookup_values) | **GET** /fraud/lookup_values | Retrieve fraud rule lookup values |
 | [**insert_fraud_rule**](FraudApi.md#insert_fraud_rule) | **POST** /fraud/rules | Insert a fraud rule |
 | [**search_fraud_rules**](FraudApi.md#search_fraud_rules) | **POST** /fraud/rules/search | Search fraud rules |
@@ -15,9 +16,9 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 
 > decline_email(fraud_decline_emails_request)
 
-Decline emails during checkout fraud review
+Decline email during checkout fraud review
 
-Adds one or more email addresses to the fraud decline list for this merchant account. 
+Adds one email address to the fraud decline list for this merchant account. 
 
 
 ### Examples
@@ -34,7 +35,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
 
 ```ruby
 begin
-  # Decline emails during checkout fraud review
+  # Decline email during checkout fraud review
   data, status_code, headers = api_instance.decline_email_with_http_info(fraud_decline_emails_request)
   p status_code # => 2xx
   p headers # => { ... }
@@ -117,6 +118,59 @@ nil (empty response body)
 - **Accept**: application/json
 
 
+## establish_fraud_rules_from_order
+
+> <FraudRulesResponse> establish_fraud_rules_from_order(fraud_rule_from_order_request)
+
+Establish fraud rules from an order
+
+Creates one or more fraud rules for this merchant account derived from an existing order, mirroring the 'establish fraud filter' action in the order processing screen. Select which filters to establish; all values are taken from the order. The IP rule is created against the order's /24 subnet (last octet masked). The credit card filter duplicates the order's stored card vault token, so no card number is sent through the API. Filters whose order data is missing (no stored card, no email, no usable IP, or no numeric street) are skipped and reported in the warning slot rather than failing the request. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the establish_fraud_rules_from_order_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FraudRulesResponse>, Integer, Hash)> establish_fraud_rules_from_order_with_http_info(fraud_rule_from_order_request)
+
+```ruby
+begin
+  # Establish fraud rules from an order
+  data, status_code, headers = api_instance.establish_fraud_rules_from_order_with_http_info(fraud_rule_from_order_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FraudRulesResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling FraudApi->establish_fraud_rules_from_order_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **fraud_rule_from_order_request** | [**FraudRuleFromOrderRequest**](FraudRuleFromOrderRequest.md) | Fraud rule from order request |  |
+
+### Return type
+
+[**FraudRulesResponse**](FraudRulesResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## get_fraud_lookup_values
 
 > <FraudLookupValuesResponse> get_fraud_lookup_values

data/docs/FraudLookupAffiliate.md

@@ -0,0 +1,20 @@
+# UltracartClient::FraudLookupAffiliate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **affiliate_oid** | **Integer** | Oid of the affiliate. Use this value in affiliate_oid on insert for the 'affiliate matches' rule type. | [optional] |
+| **email** | **String** | Email of the affiliate. May also be supplied as affiliate_email on insert in place of affiliate_oid. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::FraudLookupAffiliate.new(
+  affiliate_oid: null,
+  email: null
+)
+```
+

data/docs/FraudLookupGateway.md

@@ -0,0 +1,22 @@
+# UltracartClient::FraudLookupGateway
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Code of the rotating transaction gateway. | [optional] |
+| **name** | **String** | Display name of the rotating transaction gateway. | [optional] |
+| **rotating_transaction_gateway_oid** | **Integer** | Oid of the rotating transaction gateway. Use this value in rotating_transaction_gateway_filters on insert. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::FraudLookupGateway.new(
+  code: null,
+  name: null,
+  rotating_transaction_gateway_oid: null
+)
+```
+

data/docs/FraudLookupTheme.md

@@ -0,0 +1,22 @@
+# UltracartClient::FraudLookupTheme
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Code of the screen branding theme. | [optional] |
+| **screen_branding_theme_oid** | **Integer** | Oid of the screen branding theme. Use this value in screen_branding_theme_filters on insert. | [optional] |
+| **storefront_hostname** | **String** | Storefront hostname associated with this theme, when available. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::FraudLookupTheme.new(
+  code: null,
+  screen_branding_theme_oid: null,
+  storefront_hostname: null
+)
+```
+

data/docs/FraudLookupValues.md

@@ -4,12 +4,17 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **affiliates** | **Object** | Affiliates with non-empty email, sorted by email. | [optional] |
-| **countries** | **Object** | ISO country codes available to this merchant. | [optional] |
-| **ip_range_types** | **Object** | Valid values for ip_range_type on IP-based rules. | [optional] |
+| **affiliates** | [**Array<FraudLookupAffiliate>**](FraudLookupAffiliate.md) | Affiliates with non-empty email, sorted by email. | [optional] |
+| **avs_match_types** | **Array<String>** | Valid values for avs_match_type on the 'address street and zip avs' rule type. | [optional] |
+| **countries** | **Array<String>** | ISO country codes available to this merchant. | [optional] |
+| **failure_actions** | **Array<String>** | Valid values for failure_action on insert and search requests. | [optional] |
+| **ip_range_types** | **Array<String>** | Valid values for ip_range_type on IP-based rules. | [optional] |
 | **linked_accounts** | **Boolean** | True when this merchant has at least one linked merchant account. | [optional] |
-| **rule_groups** | **Object** | Valid values for rule_group on search requests. | [optional] |
-| **rule_types** | **Object** | Valid values for rule_type on insert and search requests. | [optional] |
+| **rotating_transaction_gateways** | [**Array<FraudLookupGateway>**](FraudLookupGateway.md) | Rotating transaction gateways configured for this merchant. Use the oid as a value in rotating_transaction_gateway_filters on insert. | [optional] |
+| **rule_groups** | **Array<String>** | Valid values for rule_group on search requests. | [optional] |
+| **rule_types** | **Array<String>** | Valid values for rule_type on insert and search requests. | [optional] |
+| **screen_branding_themes** | [**Array<FraudLookupTheme>**](FraudLookupTheme.md) | Screen branding themes configured for this merchant. Use the oid as a value in screen_branding_theme_filters on insert. | [optional] |
+| **user_actions** | **Array<String>** | Valid values for user_action on rule types that distinguish between attempted and approved transactions. | [optional] |
 
 ## Example
 
@@ -18,11 +23,16 @@ require 'ultracart_api'
 
 instance = UltracartClient::FraudLookupValues.new(
   affiliates: null,
+  avs_match_types: null,
   countries: null,
+  failure_actions: null,
   ip_range_types: null,
   linked_accounts: null,
+  rotating_transaction_gateways: null,
   rule_groups: null,
-  rule_types: null
+  rule_types: null,
+  screen_branding_themes: null,
+  user_actions: null
 )
 ```
 

data/docs/FraudRuleFromOrderRequest.md

@@ -0,0 +1,30 @@
+# UltracartClient::FraudRuleFromOrderRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auto_note** | **String** | Note automatically appended to the order's merchant note when these rules fire. | [optional] |
+| **establish_address_filter** | **Boolean** | Establish an 'address street and zip avs' rule from the order's ship-to street and zip. | [optional] |
+| **establish_card_filter** | **Boolean** | Establish a 'credit card matches' rule by duplicating the order's stored card vault token. Skipped if the order has no stored card. | [optional] |
+| **establish_email_filter** | **Boolean** | Establish an 'address email' rule from the order's email address. | [optional] |
+| **establish_ip_filter** | **Boolean** | Establish an 'ip matches' subnet rule from the order's customer IP address (last octet masked to a subnet). | [optional] |
+| **failure_action** | **String** | Action to take when these rules fire. Defaults to 'Flag For Review' when omitted. | [optional] |
+| **order_id** | **String** | The order id to establish the fraud rule(s) from. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::FraudRuleFromOrderRequest.new(
+  auto_note: null,
+  establish_address_filter: null,
+  establish_card_filter: null,
+  establish_email_filter: null,
+  establish_ip_filter: null,
+  failure_action: null,
+  order_id: null
+)
+```
+

data/docs/FraudRuleInsertRequest.md

@@ -12,27 +12,27 @@
 | **avs_response_codes** | **String** | AVS response codes (street). Used by the 'address street and zip avs' rule type. | [optional] |
 | **count_threshold** | **Integer** | Integer count threshold. Used by *count exceeds*, *change number*, *quantity exceeds*, and *purchased within last hours* rules. | [optional] |
 | **country_code** | **String** | ISO country code. Used by the 'address not in country' rule type. | [optional] |
-| **credit_card_bins** | **Object** | Credit card BINs to block (max 20). Used by the 'credit card block bin' rule type. | [optional] |
+| **credit_card_bins** | **Array<String>** | Credit card BINs to block (max 20). Used by the 'credit card block bin' rule type. | [optional] |
 | **email** | **String** | Email address. Used by the 'address email' rule type. | [optional] |
 | **failure_action** | **String** | Action to take when this rule fires. | [optional] |
 | **gateway_response_codes** | **String** | Gateway response code key. Used by the 'gateway response' rule type. | [optional] |
 | **gateway_response_value** | **String** | Gateway response code value. Used by the 'gateway response' rule type. | [optional] |
 | **ip_address** | **String** | IP address or subnet (eg '192.168.1.1' or '10.0.0.0/8'). Used by 'exempt ip' and 'ip matches' rules. | [optional] |
 | **ip_range_type** | **String** | Specifies whether an IP rule applies to a single address or a subnet. | [optional] |
-| **item_filters** | **Object** | Optional list of merchant item ids restricting this rule to orders containing one or more of these items. | [optional] |
+| **item_filters** | **Array<String>** | Optional list of merchant item ids restricting this rule to orders containing one or more of these items. | [optional] |
 | **merchant_item_id** | **String** | Merchant item id. Used by the 'item matches' rule type. | [optional] |
-| **modify_custom_field1** | **String** |  | [optional] |
-| **modify_custom_field2** | **String** |  | [optional] |
-| **modify_custom_field3** | **String** |  | [optional] |
-| **modify_custom_field4** | **String** |  | [optional] |
-| **modify_custom_field5** | **String** |  | [optional] |
-| **modify_custom_field6** | **String** |  | [optional] |
-| **modify_custom_field7** | **String** |  | [optional] |
-| **modify_skip_affiliate** | **Boolean** |  | [optional] |
-| **modify_skip_affiliate_network_pixel** | **Boolean** |  | [optional] |
-| **rotating_transaction_gateway_filters** | **Object** | Optional list of rotating transaction gateway oids restricting this rule to orders processed by one of these gateways. | [optional] |
+| **modify_custom_field1** | **String** | When failure_action is 'Process Payment and Modify', set order custom field 1 to this value. | [optional] |
+| **modify_custom_field2** | **String** | When failure_action is 'Process Payment and Modify', set order custom field 2 to this value. | [optional] |
+| **modify_custom_field3** | **String** | When failure_action is 'Process Payment and Modify', set order custom field 3 to this value. | [optional] |
+| **modify_custom_field4** | **String** | When failure_action is 'Process Payment and Modify', set order custom field 4 to this value. | [optional] |
+| **modify_custom_field5** | **String** | When failure_action is 'Process Payment and Modify', set order custom field 5 to this value. | [optional] |
+| **modify_custom_field6** | **String** | When failure_action is 'Process Payment and Modify', set order custom field 6 to this value. | [optional] |
+| **modify_custom_field7** | **String** | When failure_action is 'Process Payment and Modify', set order custom field 7 to this value. | [optional] |
+| **modify_skip_affiliate** | **Boolean** | When failure_action is 'Process Payment and Modify', strip the affiliate from the order. | [optional] |
+| **modify_skip_affiliate_network_pixel** | **Boolean** | When failure_action is 'Process Payment and Modify', skip firing the affiliate network pixel. | [optional] |
+| **rotating_transaction_gateway_filters** | **Array<Integer>** | Optional list of rotating transaction gateway oids restricting this rule to orders processed by one of these gateways. | [optional] |
 | **rule_type** | **String** | Rule type. Also returned by GET /v2/fraud/lookup_values. | [optional] |
-| **screen_branding_theme_filters** | **Object** | Optional list of screen branding theme oids restricting this rule to orders associated with one or more storefronts. | [optional] |
+| **screen_branding_theme_filters** | **Array<Integer>** | Optional list of screen branding theme oids restricting this rule to orders associated with one or more storefronts. | [optional] |
 | **user_action** | **String** | Only used by rule types that distinguish between attempted and approved transactions. | [optional] |
 
 ## Example

data/docs/FraudRulePublic.md

@@ -4,42 +4,42 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **affiliate_oid** | **Integer** |  | [optional] |
-| **amount_threshold** | **Float** |  | [optional] |
-| **auto_note** | **String** |  | [optional] |
+| **affiliate_oid** | **Integer** | Affiliate oid for the 'affiliate matches' rule type. | [optional] |
+| **amount_threshold** | **Float** | Monetary or score threshold for amount/score/percentage rule types. | [optional] |
+| **auto_note** | **String** | Note automatically appended to the order's merchant note when this rule fires. | [optional] |
 | **avs_match_type** | **String** |  | [optional] |
-| **avs_response_codes** | **String** |  | [optional] |
+| **avs_response_codes** | **String** | AVS response codes for the 'address street and zip avs' rule type. | [optional] |
 | **card_number** | **String** | Masked credit card number for rules tied to a specific card | [optional] |
-| **count_threshold** | **Integer** |  | [optional] |
-| **country_code** | **String** |  | [optional] |
+| **count_threshold** | **Integer** | Integer count threshold for count/quantity/hours rule types. | [optional] |
+| **country_code** | **String** | ISO country code for the 'address not in country' rule type. | [optional] |
 | **created_by** | **String** |  | [optional] |
 | **created_dts** | **String** | Created date | [optional] |
-| **credit_card_bins** | **Object** | Credit card BINs blocked by the 'credit card block bin' rule type. | [optional] |
-| **decline_message** | **String** |  | [optional] |
+| **credit_card_bins** | **Array<String>** | Credit card BINs blocked by the 'credit card block bin' rule type. | [optional] |
+| **decline_message** | **String** | Message shown in the A/R review screen when this rule fires. | [optional] |
 | **description** | **String** | Human-readable description of the rule | [optional] |
 | **description_html** | **String** | HTML version of the rule description | [optional] |
-| **email** | **String** |  | [optional] |
+| **email** | **String** | Email address for the 'address email' rule type. | [optional] |
 | **failure_action** | **String** | Action taken when this rule fires. | [optional] |
 | **fraud_rule_oid** | **Integer** | UltraCart unique identifier for this fraud rule | [optional] |
-| **gateway_response_codes** | **String** |  | [optional] |
-| **gateway_response_value** | **String** |  | [optional] |
-| **ip_address** | **String** |  | [optional] |
+| **gateway_response_codes** | **String** | Gateway response code key for the 'gateway response' rule type. | [optional] |
+| **gateway_response_value** | **String** | Gateway response code value for the 'gateway response' rule type. | [optional] |
+| **ip_address** | **String** | IP address or subnet for 'exempt ip' and 'ip matches' rule types. | [optional] |
 | **ip_range_type** | **String** |  | [optional] |
-| **item_filters** | [**Array<FraudRuleItemFilter>**](FraudRuleItemFilter.md) |  | [optional] |
-| **merchant_item_id** | **String** |  | [optional] |
-| **modify_custom_field1** | **String** |  | [optional] |
-| **modify_custom_field2** | **String** |  | [optional] |
-| **modify_custom_field3** | **String** |  | [optional] |
-| **modify_custom_field4** | **String** |  | [optional] |
-| **modify_custom_field5** | **String** |  | [optional] |
-| **modify_custom_field6** | **String** |  | [optional] |
-| **modify_custom_field7** | **String** |  | [optional] |
-| **modify_skip_affiliate** | **Boolean** |  | [optional] |
-| **modify_skip_affiliate_network_pixel** | **Boolean** |  | [optional] |
-| **rotating_transaction_gateway_filters** | [**Array<FraudRuleRotatingTransactionGatewayFilter>**](FraudRuleRotatingTransactionGatewayFilter.md) |  | [optional] |
+| **item_filters** | [**Array<FraudRuleItemFilter>**](FraudRuleItemFilter.md) | Item filters restricting this rule to orders containing one or more of these items. | [optional] |
+| **merchant_item_id** | **String** | Merchant item id for the 'item matches' rule type. | [optional] |
+| **modify_custom_field1** | **String** | Value the rule sets on order custom field 1 (only meaningful for 'Process Payment and Modify'). | [optional] |
+| **modify_custom_field2** | **String** | Value the rule sets on order custom field 2 (only meaningful for 'Process Payment and Modify'). | [optional] |
+| **modify_custom_field3** | **String** | Value the rule sets on order custom field 3 (only meaningful for 'Process Payment and Modify'). | [optional] |
+| **modify_custom_field4** | **String** | Value the rule sets on order custom field 4 (only meaningful for 'Process Payment and Modify'). | [optional] |
+| **modify_custom_field5** | **String** | Value the rule sets on order custom field 5 (only meaningful for 'Process Payment and Modify'). | [optional] |
+| **modify_custom_field6** | **String** | Value the rule sets on order custom field 6 (only meaningful for 'Process Payment and Modify'). | [optional] |
+| **modify_custom_field7** | **String** | Value the rule sets on order custom field 7 (only meaningful for 'Process Payment and Modify'). | [optional] |
+| **modify_skip_affiliate** | **Boolean** | When true, the rule strips the affiliate from the order (only meaningful for 'Process Payment and Modify'). | [optional] |
+| **modify_skip_affiliate_network_pixel** | **Boolean** | When true, the rule suppresses the affiliate network pixel (only meaningful for 'Process Payment and Modify'). | [optional] |
+| **rotating_transaction_gateway_filters** | [**Array<FraudRuleRotatingTransactionGatewayFilter>**](FraudRuleRotatingTransactionGatewayFilter.md) | Gateway filters restricting this rule to orders processed by one of these rotating transaction gateways. | [optional] |
 | **rule_group** | **String** | Group containing this rule type (eg 'creditCardRules'). Deliberately not constrained by allowableValues on the response so SDK consumers do not hard-fail on an unexpected value if a future rule_type slips through the server-side mapping. Search REQUESTS still restrict rule_group to the known set. | [optional] |
 | **rule_type** | **String** | Rule type. | [optional] |
-| **storefront_filters** | [**Array<FraudRuleStorefrontFilter>**](FraudRuleStorefrontFilter.md) |  | [optional] |
+| **storefront_filters** | [**Array<FraudRuleStorefrontFilter>**](FraudRuleStorefrontFilter.md) | Storefront filters restricting this rule to orders placed on one of these storefronts. | [optional] |
 | **user_action** | **String** |  | [optional] |
 
 ## Example

data/docs/FraudRuleSearchRequest.md

@@ -6,34 +6,34 @@
 | ---- | ---- | ----------- | ----- |
 | **affiliate_oid_or_email** | **String** | Affiliate oid (integer) or affiliate email. Email is resolved to oid before searching. | [optional] |
 | **amount_threshold_begin** | **Float** | Lower bound on amount/score/percentage thresholds (rules backed by the same numeric column). | [optional] |
-| **amount_threshold_end** | **Float** |  | [optional] |
+| **amount_threshold_end** | **Float** | Upper bound on amount/score/percentage thresholds (rules backed by the same numeric column). | [optional] |
 | **auto_note** | **String** | Wildcard search on the rule's auto_note. Use '*' for wildcards. | [optional] |
 | **count_threshold_begin** | **Integer** | Lower bound on count thresholds (rules backed by the same integer count column). | [optional] |
-| **count_threshold_end** | **Integer** |  | [optional] |
-| **created_by** | **String** |  | [optional] |
+| **count_threshold_end** | **Integer** | Upper bound on count thresholds (rules backed by the same integer count column). | [optional] |
+| **created_by** | **String** | Filter to rules created by this user login. | [optional] |
 | **created_date_begin** | **String** | Rule creation date begin (MM/dd/yyyy) | [optional] |
 | **created_date_end** | **String** | Rule creation date end (MM/dd/yyyy) | [optional] |
 | **credit_card_partial** | **String** | Partial credit card number for matching 'credit card matches' rules. Use '*' wildcards. | [optional] |
 | **decline_message** | **String** | Wildcard search on the rule's decline_message. Use '*' for wildcards. | [optional] |
 | **failure_action** | **String** |  | [optional] |
-| **gateway_code** | **String** |  | [optional] |
-| **merchant_item_id** | **String** |  | [optional] |
+| **gateway_code** | **String** | Filter to rules with this rotating transaction gateway code in their rotating_transaction_gateway_filters list. | [optional] |
+| **merchant_item_id** | **String** | Filter to rules with this merchant item id in their item_filters list. | [optional] |
 | **modifier_value** | **String** | Wildcard search on the rule's secondary modifier (eg 'address'/'subnet', gateway codes, avs match types). | [optional] |
-| **modify_custom_field1** | **String** |  | [optional] |
-| **modify_custom_field2** | **String** |  | [optional] |
-| **modify_custom_field3** | **String** |  | [optional] |
-| **modify_custom_field4** | **String** |  | [optional] |
-| **modify_custom_field5** | **String** |  | [optional] |
-| **modify_custom_field6** | **String** |  | [optional] |
-| **modify_custom_field7** | **String** |  | [optional] |
-| **modify_skip_affiliate** | **Boolean** |  | [optional] |
-| **modify_skip_affiliate_network_pixel** | **Boolean** |  | [optional] |
+| **modify_custom_field1** | **String** | Wildcard search on rules' modify_custom_field1 value. | [optional] |
+| **modify_custom_field2** | **String** | Wildcard search on rules' modify_custom_field2 value. | [optional] |
+| **modify_custom_field3** | **String** | Wildcard search on rules' modify_custom_field3 value. | [optional] |
+| **modify_custom_field4** | **String** | Wildcard search on rules' modify_custom_field4 value. | [optional] |
+| **modify_custom_field5** | **String** | Wildcard search on rules' modify_custom_field5 value. | [optional] |
+| **modify_custom_field6** | **String** | Wildcard search on rules' modify_custom_field6 value. | [optional] |
+| **modify_custom_field7** | **String** | Wildcard search on rules' modify_custom_field7 value. | [optional] |
+| **modify_skip_affiliate** | **Boolean** | Filter to rules whose modify_skip_affiliate flag matches this value. | [optional] |
+| **modify_skip_affiliate_network_pixel** | **Boolean** | Filter to rules whose modify_skip_affiliate_network_pixel flag matches this value. | [optional] |
 | **rule_group** | **String** | Rule group to filter by. | [optional] |
 | **rule_type** | **String** | Rule type to filter by. | [optional] |
 | **search_linked_accounts** | **Boolean** | Include rules from accounts linked to this merchant. Defaults to false. | [optional] |
-| **storefront_hostname** | **String** |  | [optional] |
+| **storefront_hostname** | **String** | Filter to rules with this storefront hostname in their screen_branding_theme_filters list. | [optional] |
 | **text_value** | **String** | Wildcard search on the rule's text parameter (email / ip / bin / country / item id / avs codes - the backend disambiguates by rule_type). | [optional] |
-| **theme_code** | **String** |  | [optional] |
+| **theme_code** | **String** | Filter to rules with this screen branding theme code in their screen_branding_theme_filters list. | [optional] |
 | **user_action** | **String** |  | [optional] |
 
 ## Example

data/lib/ultracart_api/api/fraud_api.rb

@@ -32,8 +32,8 @@ module UltracartClient
       UltracartClient::FraudApi.new(api_client)
     end
 
-    # Decline emails during checkout fraud review
-    # Adds one or more email addresses to the fraud decline list for this merchant account. 
+    # Decline email during checkout fraud review
+    # Adds one email address to the fraud decline list for this merchant account. 
     # @param fraud_decline_emails_request [FraudDeclineEmailRequest] Fraud decline emails request
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -42,8 +42,8 @@ module UltracartClient
       nil
     end
 
-    # Decline emails during checkout fraud review
-    # Adds one or more email addresses to the fraud decline list for this merchant account. 
+    # Decline email during checkout fraud review
+    # Adds one email address to the fraud decline list for this merchant account. 
     # @param fraud_decline_emails_request [FraudDeclineEmailRequest] Fraud decline emails request
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -165,6 +165,75 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Establish fraud rules from an order
+    # Creates one or more fraud rules for this merchant account derived from an existing order, mirroring the 'establish fraud filter' action in the order processing screen. Select which filters to establish; all values are taken from the order. The IP rule is created against the order's /24 subnet (last octet masked). The credit card filter duplicates the order's stored card vault token, so no card number is sent through the API. Filters whose order data is missing (no stored card, no email, no usable IP, or no numeric street) are skipped and reported in the warning slot rather than failing the request. 
+    # @param fraud_rule_from_order_request [FraudRuleFromOrderRequest] Fraud rule from order request
+    # @param [Hash] opts the optional parameters
+    # @return [FraudRulesResponse]
+    def establish_fraud_rules_from_order(fraud_rule_from_order_request, opts = {})
+      data, _status_code, _headers = establish_fraud_rules_from_order_with_http_info(fraud_rule_from_order_request, opts)
+      data
+    end
+
+    # Establish fraud rules from an order
+    # Creates one or more fraud rules for this merchant account derived from an existing order, mirroring the &#39;establish fraud filter&#39; action in the order processing screen. Select which filters to establish; all values are taken from the order. The IP rule is created against the order&#39;s /24 subnet (last octet masked). The credit card filter duplicates the order&#39;s stored card vault token, so no card number is sent through the API. Filters whose order data is missing (no stored card, no email, no usable IP, or no numeric street) are skipped and reported in the warning slot rather than failing the request. 
+    # @param fraud_rule_from_order_request [FraudRuleFromOrderRequest] Fraud rule from order request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FraudRulesResponse, Integer, Hash)>] FraudRulesResponse data, response status code and response headers
+    def establish_fraud_rules_from_order_with_http_info(fraud_rule_from_order_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FraudApi.establish_fraud_rules_from_order ...'
+      end
+      # verify the required parameter 'fraud_rule_from_order_request' is set
+      if @api_client.config.client_side_validation && fraud_rule_from_order_request.nil?
+        fail ArgumentError, "Missing the required parameter 'fraud_rule_from_order_request' when calling FraudApi.establish_fraud_rules_from_order"
+      end
+      # resource path
+      local_var_path = '/fraud/rules/from_order'
+
+      # 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'])
+      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(fraud_rule_from_order_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'FraudRulesResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"FraudApi.establish_fraud_rules_from_order",
+        :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: FraudApi#establish_fraud_rules_from_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Retrieve fraud rule lookup values
     # Returns the dropdown values required to build valid fraud rule insert and search requests. Includes rule types, failure actions, user actions, IP range types, AVS match types, the merchant's rotating transaction gateways, screen branding themes, countries, and affiliates. 
     # @param [Hash] opts the optional parameters