ultracart_api 4.1.92 → 4.1.94

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/fraud_api.rb

@@ -0,0 +1,373 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'cgi'
+
+module UltracartClient
+  class FraudApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
+      api_config = Configuration.new
+      api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
+      api_config.api_version = '2017-03-01'
+      api_config.verify_ssl = verify_ssl
+
+      api_client = ApiClient.new(api_config)
+      api_client.config.debugging = debugging
+
+      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. 
+    # @param fraud_decline_emails_request [FraudDeclineEmailRequest] Fraud decline emails request
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def decline_email(fraud_decline_emails_request, opts = {})
+      decline_email_with_http_info(fraud_decline_emails_request, opts)
+      nil
+    end
+
+    # Decline emails during checkout fraud review
+    # Adds one or more email addresses 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
+    def decline_email_with_http_info(fraud_decline_emails_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FraudApi.decline_email ...'
+      end
+      # verify the required parameter 'fraud_decline_emails_request' is set
+      if @api_client.config.client_side_validation && fraud_decline_emails_request.nil?
+        fail ArgumentError, "Missing the required parameter 'fraud_decline_emails_request' when calling FraudApi.decline_email"
+      end
+      # resource path
+      local_var_path = '/fraud/decline_email'
+
+      # 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_decline_emails_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"FraudApi.decline_email",
+        :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#decline_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete a fraud rule
+    # Deletes a fraud rule for this merchant account. 
+    # @param fraud_rule_oid [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_fraud_rule(fraud_rule_oid, opts = {})
+      delete_fraud_rule_with_http_info(fraud_rule_oid, opts)
+      nil
+    end
+
+    # Delete a fraud rule
+    # Deletes a fraud rule for this merchant account. 
+    # @param fraud_rule_oid [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_fraud_rule_with_http_info(fraud_rule_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FraudApi.delete_fraud_rule ...'
+      end
+      # verify the required parameter 'fraud_rule_oid' is set
+      if @api_client.config.client_side_validation && fraud_rule_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'fraud_rule_oid' when calling FraudApi.delete_fraud_rule"
+      end
+      # resource path
+      local_var_path = '/fraud/rules/{fraud_rule_oid}'.sub('{' + 'fraud_rule_oid' + '}', CGI.escape(fraud_rule_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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"FraudApi.delete_fraud_rule",
+        :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(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FraudApi#delete_fraud_rule\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
+    # @return [FraudLookupValuesResponse]
+    def get_fraud_lookup_values(opts = {})
+      data, _status_code, _headers = get_fraud_lookup_values_with_http_info(opts)
+      data
+    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&#39;s rotating transaction gateways, screen branding themes, countries, and affiliates. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FraudLookupValuesResponse, Integer, Hash)>] FraudLookupValuesResponse data, response status code and response headers
+    def get_fraud_lookup_values_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FraudApi.get_fraud_lookup_values ...'
+      end
+      # resource path
+      local_var_path = '/fraud/lookup_values'
+
+      # 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] || 'FraudLookupValuesResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"FraudApi.get_fraud_lookup_values",
+        :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: FraudApi#get_fraud_lookup_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 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. 
+    # @param fraud_rule_insert_request [FraudRuleInsertRequest] Fraud rule insert request
+    # @param [Hash] opts the optional parameters
+    # @return [FraudRuleResponse]
+    def insert_fraud_rule(fraud_rule_insert_request, opts = {})
+      data, _status_code, _headers = insert_fraud_rule_with_http_info(fraud_rule_insert_request, opts)
+      data
+    end
+
+    # 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 &#39;credit card matches&#39; rule type is not supported via REST. 
+    # @param fraud_rule_insert_request [FraudRuleInsertRequest] Fraud rule insert request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FraudRuleResponse, Integer, Hash)>] FraudRuleResponse data, response status code and response headers
+    def insert_fraud_rule_with_http_info(fraud_rule_insert_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FraudApi.insert_fraud_rule ...'
+      end
+      # verify the required parameter 'fraud_rule_insert_request' is set
+      if @api_client.config.client_side_validation && fraud_rule_insert_request.nil?
+        fail ArgumentError, "Missing the required parameter 'fraud_rule_insert_request' when calling FraudApi.insert_fraud_rule"
+      end
+      # resource path
+      local_var_path = '/fraud/rules'
+
+      # 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_insert_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'FraudRuleResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"FraudApi.insert_fraud_rule",
+        :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#insert_fraud_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 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. 
+    # @param fraud_rule_search_request [FraudRuleSearchRequest] Fraud rule search request
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200) (default to 100)
+    # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index. (default to 0)
+    # @option opts [String] :_sort The sort order of the fraud rules.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+    # @return [FraudRulesResponse]
+    def search_fraud_rules(fraud_rule_search_request, opts = {})
+      data, _status_code, _headers = search_fraud_rules_with_http_info(fraud_rule_search_request, opts)
+      data
+    end
+
+    # 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. 
+    # @param fraud_rule_search_request [FraudRuleSearchRequest] Fraud rule search request
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200) (default to 100)
+    # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index. (default to 0)
+    # @option opts [String] :_sort The sort order of the fraud rules.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+    # @return [Array<(FraudRulesResponse, Integer, Hash)>] FraudRulesResponse data, response status code and response headers
+    def search_fraud_rules_with_http_info(fraud_rule_search_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FraudApi.search_fraud_rules ...'
+      end
+      # verify the required parameter 'fraud_rule_search_request' is set
+      if @api_client.config.client_side_validation && fraud_rule_search_request.nil?
+        fail ArgumentError, "Missing the required parameter 'fraud_rule_search_request' when calling FraudApi.search_fraud_rules"
+      end
+      # resource path
+      local_var_path = '/fraud/rules/search'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
+      query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
+      query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
+
+      # 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_search_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.search_fraud_rules",
+        :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#search_fraud_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end