ultracart_api 4.1.92 → 4.1.94

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a77ef9d44a0fca208587a594a7355963c1c52ce35350ddb2e4485c21c8d6d12b
-  data.tar.gz: a883df2b6a0c808186c5f04c258bb0c771375a8c00ad2cf38835e84716a287ef
+  metadata.gz: 9039a89e9e1a86f496622fbc690d91a7d3060521915b1d7b4b4546bff0640942
+  data.tar.gz: 17951d2b1878d2f6da99b50c1c0f7dc4d3c89e45935a88acd1db278e76afbf33
 SHA512:
-  metadata.gz: ef71a9ca0021da0ddde9395c57b440643e1ee53842090041a39fd9fa4d8da0e666b186cbc8c93e4db4524255bbc5f568f783fcd81bfa00f7d5f152e6084c6f26
-  data.tar.gz: 513f17f0460627ec0a7c9e5d4d5ddebc96cca8d4d4477b17cf950a22265445340a93b00d7885f3c61ef2334c2e59e9dd35562ab7d691abd09dd6805993677016
+  metadata.gz: 29d0fe1c6e9c5d9a00b005814b3a2fd2dc4b577cdb6c0507b6ca395b5fe22c2d1655322970dee4d795a25d75c68b5e2eeec7c8bbe628600f6502290eea7690e6
+  data.tar.gz: 7109641620abb4d0a0d9ecc7a19d558129b9a9da675795f14eec3d2d43aa06a220f53698252e8363e17125d490de3c0299fe2b7f58f051456b1ee8f3b473ee7f

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.92
+- Package version: 4.1.94
 - 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.92'
+gem 'ultracart_api', '4.1.94'
 ```
 
 install:
@@ -353,6 +353,11 @@ 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* | [**delete_fraud_rule**](docs/FraudApi.md#delete_fraud_rule) | **DELETE** /fraud/rules/{fraud_rule_oid} | Delete a fraud rule
+*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
 *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.
 *UltracartClient::FulfillmentApi* | [**get_distribution_center_orders**](docs/FulfillmentApi.md#get_distribution_center_orders) | **GET** /fulfillment/distribution_centers/{distribution_center_code}/orders | Retrieve orders queued up for this distribution center.
@@ -1273,6 +1278,17 @@ Class | Method | HTTP request | Description
  - [UltracartClient::FileManagerPageResponse](docs/FileManagerPageResponse.md)
  - [UltracartClient::FileManagerUploadRequest](docs/FileManagerUploadRequest.md)
  - [UltracartClient::FileManagerUploadUrlResponse](docs/FileManagerUploadUrlResponse.md)
+ - [UltracartClient::FraudDeclineEmailRequest](docs/FraudDeclineEmailRequest.md)
+ - [UltracartClient::FraudLookupValues](docs/FraudLookupValues.md)
+ - [UltracartClient::FraudLookupValuesResponse](docs/FraudLookupValuesResponse.md)
+ - [UltracartClient::FraudRuleInsertRequest](docs/FraudRuleInsertRequest.md)
+ - [UltracartClient::FraudRuleItemFilter](docs/FraudRuleItemFilter.md)
+ - [UltracartClient::FraudRulePublic](docs/FraudRulePublic.md)
+ - [UltracartClient::FraudRuleResponse](docs/FraudRuleResponse.md)
+ - [UltracartClient::FraudRuleRotatingTransactionGatewayFilter](docs/FraudRuleRotatingTransactionGatewayFilter.md)
+ - [UltracartClient::FraudRuleSearchRequest](docs/FraudRuleSearchRequest.md)
+ - [UltracartClient::FraudRuleStorefrontFilter](docs/FraudRuleStorefrontFilter.md)
+ - [UltracartClient::FraudRulesResponse](docs/FraudRulesResponse.md)
  - [UltracartClient::FulfillmentInventory](docs/FulfillmentInventory.md)
  - [UltracartClient::FulfillmentShipment](docs/FulfillmentShipment.md)
  - [UltracartClient::GeoPoint](docs/GeoPoint.md)
@@ -1713,6 +1729,8 @@ Class | Method | HTTP request | Description
   - coupon_write: Allows you to write coupon information.
   - customer_read: Allows you to read customer information.
   - customer_write: Allows you to write customer information.
+  - fraud_read: Allows you to read fraud information.
+  - fraud_write: Allows you to write fraud information.
   - fulfillment_read: Allows you to read fulfillment information.
   - fulfillment_write: Allows you to write fulfillment information.
   - gift_certificate_read: Allows you to read gift certificate information.
@@ -1751,6 +1769,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.94 | 06/02/2026 | fraud api alpha version |
+| 4.1.93 | 06/02/2026 | fraud api alpha version for testing |
 | 4.1.92 | 05/26/2026 | AutoOrderApi.getAutoOrderCancelReasons |
 | 4.1.91 | 05/18/2026 | ChannelPartner - support creation_dts on import of a store_completed (historical) order |
 | 4.1.90 | 05/13/2026 | webhook rest api - new method getWebhookEventCategories |

data/docs/FraudApi.md

@@ -0,0 +1,278 @@
+# UltracartClient::FraudApi
+
+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 |
+| [**delete_fraud_rule**](FraudApi.md#delete_fraud_rule) | **DELETE** /fraud/rules/{fraud_rule_oid} | Delete a fraud rule |
+| [**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 |
+
+
+## decline_email
+
+> decline_email(fraud_decline_emails_request)
+
+Decline emails during checkout fraud review
+
+Adds one or more email addresses to the fraud decline list for this merchant account. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the decline_email_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> decline_email_with_http_info(fraud_decline_emails_request)
+
+```ruby
+begin
+  # Decline emails 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 # => { ... }
+  p data # => nil
+rescue UltracartClient::ApiError => e
+  puts "Error when calling FraudApi->decline_email_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **fraud_decline_emails_request** | [**FraudDeclineEmailRequest**](FraudDeclineEmailRequest.md) | Fraud decline emails request |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_fraud_rule
+
+> delete_fraud_rule(fraud_rule_oid)
+
+Delete a fraud rule
+
+Deletes a fraud rule for this merchant account. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the delete_fraud_rule_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_fraud_rule_with_http_info(fraud_rule_oid)
+
+```ruby
+begin
+  # Delete a fraud rule
+  data, status_code, headers = api_instance.delete_fraud_rule_with_http_info(fraud_rule_oid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue UltracartClient::ApiError => e
+  puts "Error when calling FraudApi->delete_fraud_rule_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **fraud_rule_oid** | **Integer** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_fraud_lookup_values
+
+> <FraudLookupValuesResponse> get_fraud_lookup_values
+
+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. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_fraud_lookup_values_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FraudLookupValuesResponse>, Integer, Hash)> get_fraud_lookup_values_with_http_info
+
+```ruby
+begin
+  # Retrieve fraud rule lookup values
+  data, status_code, headers = api_instance.get_fraud_lookup_values_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FraudLookupValuesResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling FraudApi->get_fraud_lookup_values_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FraudLookupValuesResponse**](FraudLookupValuesResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## insert_fraud_rule
+
+> <FraudRuleResponse> insert_fraud_rule(fraud_rule_insert_request)
+
+Insert a fraud rule
+
+Creates a fraud rule for this merchant account. Field names in the request body are semantic (eg amount_threshold, email, ip_address). Call GET /v2/fraud/lookup_values for the list of valid rule_type, failure_action, and related dropdown values. The 'credit card matches' rule type is not supported via REST. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the insert_fraud_rule_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FraudRuleResponse>, Integer, Hash)> insert_fraud_rule_with_http_info(fraud_rule_insert_request)
+
+```ruby
+begin
+  # Insert a fraud rule
+  data, status_code, headers = api_instance.insert_fraud_rule_with_http_info(fraud_rule_insert_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FraudRuleResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling FraudApi->insert_fraud_rule_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **fraud_rule_insert_request** | [**FraudRuleInsertRequest**](FraudRuleInsertRequest.md) | Fraud rule insert request |  |
+
+### Return type
+
+[**FraudRuleResponse**](FraudRuleResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## search_fraud_rules
+
+> <FraudRulesResponse> search_fraud_rules(fraud_rule_search_request, opts)
+
+Search fraud rules
+
+Searches fraud rules for this merchant account using semantic filter fields. Pagination and sort are passed as query parameters (_limit, _offset, _sort). You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. Results are capped at 10,000 records by ElasticSearch and the warning slot indicates when that cap was hit. Use more selective filters in that case. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the search_fraud_rules_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FraudRulesResponse>, Integer, Hash)> search_fraud_rules_with_http_info(fraud_rule_search_request, opts)
+
+```ruby
+begin
+  # Search fraud rules
+  data, status_code, headers = api_instance.search_fraud_rules_with_http_info(fraud_rule_search_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FraudRulesResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling FraudApi->search_fraud_rules_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **fraud_rule_search_request** | [**FraudRuleSearchRequest**](FraudRuleSearchRequest.md) | Fraud rule search request |  |
+| **_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] |
+| **_sort** | **String** | The sort order of the fraud rules.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] |
+
+### Return type
+
+[**FraudRulesResponse**](FraudRulesResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/FraudDeclineEmailRequest.md

@@ -0,0 +1,18 @@
+# UltracartClient::FraudDeclineEmailRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | email to decline during checkout fraud review | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::FraudDeclineEmailRequest.new(
+  email: null
+)
+```
+

data/docs/FraudLookupValues.md

@@ -0,0 +1,28 @@
+# UltracartClient::FraudLookupValues
+
+## Properties
+
+| 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] |
+| **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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::FraudLookupValues.new(
+  affiliates: null,
+  countries: null,
+  ip_range_types: null,
+  linked_accounts: null,
+  rule_groups: null,
+  rule_types: null
+)
+```
+

data/docs/FraudLookupValuesResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::FraudLookupValuesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **fraud_lookup_values** | [**FraudLookupValues**](FraudLookupValues.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::FraudLookupValuesResponse.new(
+  error: null,
+  fraud_lookup_values: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/FraudRuleInsertRequest.md

@@ -0,0 +1,76 @@
+# UltracartClient::FraudRuleInsertRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **affiliate_email** | **String** | Affiliate email. Used by the 'affiliate matches' rule type when affiliate_oid is not supplied. | [optional] |
+| **affiliate_oid** | **Integer** | Affiliate OID. Used by the 'affiliate matches' rule type. If omitted, affiliate_email is required. | [optional] |
+| **amount_threshold** | **Float** | Monetary or score threshold. Used by *transaction amount exceeds*, *fraud score exceeds*, and *decline percentage exceeds* rules. | [optional] |
+| **auto_note** | **String** | Note automatically appended to the order's merchant note when this rule fires. | [optional] |
+| **avs_match_type** | **String** | AVS match type for the zip portion. Used by the 'address street and zip avs' rule type. | [optional] |
+| **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] |
+| **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] |
+| **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] |
+| **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] |
+| **user_action** | **String** | Only used by rule types that distinguish between attempted and approved transactions. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::FraudRuleInsertRequest.new(
+  affiliate_email: null,
+  affiliate_oid: null,
+  amount_threshold: null,
+  auto_note: null,
+  avs_match_type: null,
+  avs_response_codes: null,
+  count_threshold: null,
+  country_code: null,
+  credit_card_bins: null,
+  email: null,
+  failure_action: null,
+  gateway_response_codes: null,
+  gateway_response_value: null,
+  ip_address: null,
+  ip_range_type: null,
+  item_filters: null,
+  merchant_item_id: null,
+  modify_custom_field1: null,
+  modify_custom_field2: null,
+  modify_custom_field3: null,
+  modify_custom_field4: null,
+  modify_custom_field5: null,
+  modify_custom_field6: null,
+  modify_custom_field7: null,
+  modify_skip_affiliate: null,
+  modify_skip_affiliate_network_pixel: null,
+  rotating_transaction_gateway_filters: null,
+  rule_type: null,
+  screen_branding_theme_filters: null,
+  user_action: null
+)
+```
+

data/docs/FraudRuleItemFilter.md

@@ -0,0 +1,20 @@
+# UltracartClient::FraudRuleItemFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **merchant_item_id** | **String** | Unique item id of this item filter | [optional] |
+| **merchant_item_oid** | **Integer** | Unique object identifier of this item | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::FraudRuleItemFilter.new(
+  merchant_item_id: null,
+  merchant_item_oid: null
+)
+```
+

data/docs/FraudRulePublic.md

@@ -0,0 +1,90 @@
+# UltracartClient::FraudRulePublic
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **affiliate_oid** | **Integer** |  | [optional] |
+| **amount_threshold** | **Float** |  | [optional] |
+| **auto_note** | **String** |  | [optional] |
+| **avs_match_type** | **String** |  | [optional] |
+| **avs_response_codes** | **String** |  | [optional] |
+| **card_number** | **String** | Masked credit card number for rules tied to a specific card | [optional] |
+| **count_threshold** | **Integer** |  | [optional] |
+| **country_code** | **String** |  | [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] |
+| **description** | **String** | Human-readable description of the rule | [optional] |
+| **description_html** | **String** | HTML version of the rule description | [optional] |
+| **email** | **String** |  | [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] |
+| **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] |
+| **rule_group** | **String** | Group containing this rule type (eg 'creditCardRules') | [optional] |
+| **rule_type** | **String** | Rule type. | [optional] |
+| **storefront_filters** | [**Array<FraudRuleStorefrontFilter>**](FraudRuleStorefrontFilter.md) |  | [optional] |
+| **user_action** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::FraudRulePublic.new(
+  affiliate_oid: null,
+  amount_threshold: null,
+  auto_note: null,
+  avs_match_type: null,
+  avs_response_codes: null,
+  card_number: null,
+  count_threshold: null,
+  country_code: null,
+  created_by: null,
+  created_dts: null,
+  credit_card_bins: null,
+  decline_message: null,
+  description: null,
+  description_html: null,
+  email: null,
+  failure_action: null,
+  fraud_rule_oid: null,
+  gateway_response_codes: null,
+  gateway_response_value: null,
+  ip_address: null,
+  ip_range_type: null,
+  item_filters: null,
+  merchant_item_id: null,
+  modify_custom_field1: null,
+  modify_custom_field2: null,
+  modify_custom_field3: null,
+  modify_custom_field4: null,
+  modify_custom_field5: null,
+  modify_custom_field6: null,
+  modify_custom_field7: null,
+  modify_skip_affiliate: null,
+  modify_skip_affiliate_network_pixel: null,
+  rotating_transaction_gateway_filters: null,
+  rule_group: null,
+  rule_type: null,
+  storefront_filters: null,
+  user_action: null
+)
+```
+

data/docs/FraudRuleResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::FraudRuleResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **fraud_rule** | [**FraudRulePublic**](FraudRulePublic.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::FraudRuleResponse.new(
+  error: null,
+  fraud_rule: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/FraudRuleRotatingTransactionGatewayFilter.md

@@ -0,0 +1,20 @@
+# UltracartClient::FraudRuleRotatingTransactionGatewayFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | The short code identifier of this rotating transaction gateway used to filter this fraud rule | [optional] |
+| **rotating_transaction_gateway_oid** | **Integer** | Unique object identifier of a rotating transaction gateway filtering this fraud rule to only orders processed by this gateway | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::FraudRuleRotatingTransactionGatewayFilter.new(
+  code: null,
+  rotating_transaction_gateway_oid: null
+)
+```
+