ultracart_api 4.1.91 → 4.1.94

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
+)
+```
+

data/docs/FraudRuleSearchRequest.md

@@ -0,0 +1,78 @@
+# UltracartClient::FraudRuleSearchRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+| **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] |
+| **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] |
+| **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] |
+| **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] |
+| **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] |
+| **user_action** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::FraudRuleSearchRequest.new(
+  affiliate_oid_or_email: null,
+  amount_threshold_begin: null,
+  amount_threshold_end: null,
+  auto_note: null,
+  count_threshold_begin: null,
+  count_threshold_end: null,
+  created_by: null,
+  created_date_begin: null,
+  created_date_end: null,
+  credit_card_partial: null,
+  decline_message: null,
+  failure_action: null,
+  gateway_code: null,
+  merchant_item_id: null,
+  modifier_value: 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,
+  rule_group: null,
+  rule_type: null,
+  search_linked_accounts: null,
+  storefront_hostname: null,
+  text_value: null,
+  theme_code: null,
+  user_action: null
+)
+```
+

data/docs/FraudRuleStorefrontFilter.md

@@ -0,0 +1,20 @@
+# UltracartClient::FraudRuleStorefrontFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **screen_branding_theme_code** | **String** | Screen branding theme code associated with this storefront (legacy checkouts) | [optional] |
+| **storefront_host_name** | **String** | StoreFront Host Name | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::FraudRuleStorefrontFilter.new(
+  screen_branding_theme_code: null,
+  storefront_host_name: null
+)
+```
+

data/docs/FraudRulesResponse.md

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

data/docs/ItemVariantItem.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **description** | **String** | Description | [optional] |
 | **merchant_item_multimedia_oid** | **Integer** | Multimedia object identifier | [optional] |
+| **quantity** | **Integer** | Quantity of the variant item added to the cart when this combination is selected.  Defaults to 1. | [optional] |
 | **variant_default_multimedia** | [**ItemContentMultimedia**](ItemContentMultimedia.md) |  | [optional] |
 | **variant_merchant_item_id** | **String** | Variant item id | [optional] |
 | **variant_merchant_item_oid** | **Integer** | Variant item object identifier | [optional] |
@@ -21,6 +22,7 @@ require 'ultracart_api'
 instance = UltracartClient::ItemVariantItem.new(
   description: null,
   merchant_item_multimedia_oid: null,
+  quantity: null,
   variant_default_multimedia: null,
   variant_merchant_item_id: null,
   variant_merchant_item_oid: null,

data/lib/ultracart_api/api/auto_order_api.rb

@@ -458,6 +458,64 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Retrieve auto order cancel reasons.
+    # Retrieves auto order cancel reasons. 
+    # @param [Hash] opts the optional parameters
+    # @return [AutoOrderCancelReasonsResponse]
+    def get_auto_order_cancel_reasons(opts = {})
+      data, _status_code, _headers = get_auto_order_cancel_reasons_with_http_info(opts)
+      data
+    end
+
+    # Retrieve auto order cancel reasons.
+    # Retrieves auto order cancel reasons. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AutoOrderCancelReasonsResponse, Integer, Hash)>] AutoOrderCancelReasonsResponse data, response status code and response headers
+    def get_auto_order_cancel_reasons_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AutoOrderApi.get_auto_order_cancel_reasons ...'
+      end
+      # resource path
+      local_var_path = '/auto_order/auto_orders/cancel_reasons'
+
+      # 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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AutoOrderCancelReasonsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"AutoOrderApi.get_auto_order_cancel_reasons",
+        :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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AutoOrderApi#get_auto_order_cancel_reasons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Retrieve email delivery information for this auto order.
     # Retrieves email delivery records associated with the specified auto order. 
     # @param auto_order_oid [Integer] The auto order oid to retrieve email delivery information for.