ultracart_api 3.1.37 → 3.1.43

data/docs/WebhookLog.md

@@ -5,6 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **delivery_dts** | **String** | Date/time of delivery | [optional] 
 **duration** | **Integer** | Number of milliseconds to process the notification | [optional] 
+**queue_delay** | **Integer** | Number of milliseconds of delay caused by queuing | [optional] 
 **request** | **String** | Request payload (first 100,000 characters) | [optional] 
 **request_headers** | [**Array<HTTPHeader>**](HTTPHeader.md) | Request headers sent to the server | [optional] 
 **request_id** | **String** | Request id is a unique string that you can look up in the logs | [optional] 

data/lib/ultracart_api.rb

@@ -504,6 +504,12 @@ require 'ultracart_api/models/screen_recording_filter_values_event'
 require 'ultracart_api/models/screen_recording_filter_values_event_params'
 require 'ultracart_api/models/screen_recording_filter_values_page_param'
 require 'ultracart_api/models/screen_recording_filter_values_page_view'
+require 'ultracart_api/models/screen_recording_heatmap'
+require 'ultracart_api/models/screen_recording_heatmap_index_response'
+require 'ultracart_api/models/screen_recording_heatmap_request'
+require 'ultracart_api/models/screen_recording_heatmap_reset'
+require 'ultracart_api/models/screen_recording_heatmap_response'
+require 'ultracart_api/models/screen_recording_heatmap_url'
 require 'ultracart_api/models/screen_recording_merchant_notes_request'
 require 'ultracart_api/models/screen_recording_multifield'
 require 'ultracart_api/models/screen_recording_page_view'

data/lib/ultracart_api/api/order_api.rb

@@ -33,7 +33,7 @@ module UltracartClient
     end
 
     # Adjusts an order total
-    # Adjusts an order total.  Adjusts individual items appropriately and considers taxes.  Desired total should be provided in the same currency as the order.  Returns true if successful. 
+    # Adjusts an order total.  Adjusts individual items appropriately and considers taxes.  Desired total should be provided in the same currency as the order and must be less than the current total and greater than zero.  This call will change the order total.  It returns true if the desired total is achieved.  If the goal seeking algorithm falls short (usually by pennies), this method returns back false.  View the merchant notes for the order for further details. 
     # @param order_id The order id to cancel.
     # @param desired_total The desired total with no formatting. example 123.45
     # @param [Hash] opts the optional parameters
@@ -44,7 +44,7 @@ module UltracartClient
     end
 
     # Adjusts an order total
-    # Adjusts an order total.  Adjusts individual items appropriately and considers taxes.  Desired total should be provided in the same currency as the order.  Returns true if successful. 
+    # Adjusts an order total.  Adjusts individual items appropriately and considers taxes.  Desired total should be provided in the same currency as the order and must be less than the current total and greater than zero.  This call will change the order total.  It returns true if the desired total is achieved.  If the goal seeking algorithm falls short (usually by pennies), this method returns back false.  View the merchant notes for the order for further details. 
     # @param order_id The order id to cancel.
     # @param desired_total The desired total with no formatting. example 123.45
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/api/storefront_api.rb

@@ -1033,6 +1033,66 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Delete screen recording heatmap
+    # Delete screen recording heatmap 
+    # @param storefront_oid 
+    # @param query Query
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_heatmap(storefront_oid, query, opts = {})
+      delete_heatmap_with_http_info(storefront_oid, query, opts)
+      nil
+    end
+
+    # Delete screen recording heatmap
+    # Delete screen recording heatmap 
+    # @param storefront_oid 
+    # @param query Query
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_heatmap_with_http_info(storefront_oid, query, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.delete_heatmap ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.delete_heatmap"
+      end
+      # verify the required parameter 'query' is set
+      if @api_client.config.client_side_validation && query.nil?
+        fail ArgumentError, "Missing the required parameter 'query' when calling StorefrontApi.delete_heatmap"
+      end
+      # resource path
+      local_var_path = '/storefront/{storefront_oid}/screen_recordings/heatmap'.sub('{' + 'storefront_oid' + '}', storefront_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      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'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(query)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#delete_heatmap\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Delete library item
     # @param library_item_oid 
     # @param [Hash] opts the optional parameters
@@ -4438,6 +4498,122 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Get screen recording heatmap
+    # Get screen recording heatmap 
+    # @param storefront_oid 
+    # @param query Query
+    # @param [Hash] opts the optional parameters
+    # @return [ScreenRecordingHeatmapResponse]
+    def get_heatmap(storefront_oid, query, opts = {})
+      data, _status_code, _headers = get_heatmap_with_http_info(storefront_oid, query, opts)
+      data
+    end
+
+    # Get screen recording heatmap
+    # Get screen recording heatmap 
+    # @param storefront_oid 
+    # @param query Query
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ScreenRecordingHeatmapResponse, Fixnum, Hash)>] ScreenRecordingHeatmapResponse data, response status code and response headers
+    def get_heatmap_with_http_info(storefront_oid, query, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.get_heatmap ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_heatmap"
+      end
+      # verify the required parameter 'query' is set
+      if @api_client.config.client_side_validation && query.nil?
+        fail ArgumentError, "Missing the required parameter 'query' when calling StorefrontApi.get_heatmap"
+      end
+      # resource path
+      local_var_path = '/storefront/{storefront_oid}/screen_recordings/heatmap'.sub('{' + 'storefront_oid' + '}', storefront_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      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'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(query)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ScreenRecordingHeatmapResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#get_heatmap\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Get screen recording heatmap index
+    # Get screen recording heatmap index 
+    # @param storefront_oid 
+    # @param [Hash] opts the optional parameters
+    # @return [ScreenRecordingHeatmapIndexResponse]
+    def get_heatmap_index(storefront_oid, opts = {})
+      data, _status_code, _headers = get_heatmap_index_with_http_info(storefront_oid, opts)
+      data
+    end
+
+    # Get screen recording heatmap index
+    # Get screen recording heatmap index 
+    # @param storefront_oid 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ScreenRecordingHeatmapIndexResponse, Fixnum, Hash)>] ScreenRecordingHeatmapIndexResponse data, response status code and response headers
+    def get_heatmap_index_with_http_info(storefront_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.get_heatmap_index ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_heatmap_index"
+      end
+      # resource path
+      local_var_path = '/storefront/{storefront_oid}/screen_recordings/heatmap/index'.sub('{' + 'storefront_oid' + '}', storefront_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      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'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ScreenRecordingHeatmapIndexResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#get_heatmap_index\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Get histogram property names
     # Obtain a list of property names for a given property type 
     # @param storefront_oid 

data/lib/ultracart_api/models/coupon_tier_amount.rb

@@ -17,6 +17,9 @@ module UltracartClient
     # The amount of subtotal discount
     attr_accessor :discount_amount
 
+    # Quickbooks accounting code.
+    attr_accessor :quickbooks_code
+
     # The amount of subtotal required to receive the discount amount
     attr_accessor :subtotal_amount
 
@@ -24,6 +27,7 @@ module UltracartClient
     def self.attribute_map
       {
         :'discount_amount' => :'discount_amount',
+        :'quickbooks_code' => :'quickbooks_code',
         :'subtotal_amount' => :'subtotal_amount'
       }
     end
@@ -32,6 +36,7 @@ module UltracartClient
     def self.swagger_types
       {
         :'discount_amount' => :'Float',
+        :'quickbooks_code' => :'String',
         :'subtotal_amount' => :'Float'
       }
     end
@@ -48,6 +53,10 @@ module UltracartClient
         self.discount_amount = attributes[:'discount_amount']
       end
 
+      if attributes.has_key?(:'quickbooks_code')
+        self.quickbooks_code = attributes[:'quickbooks_code']
+      end
+
       if attributes.has_key?(:'subtotal_amount')
         self.subtotal_amount = attributes[:'subtotal_amount']
       end
@@ -57,21 +66,37 @@ module UltracartClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if !@quickbooks_code.nil? && @quickbooks_code.to_s.length > 20
+        invalid_properties.push('invalid value for "quickbooks_code", the character length must be smaller than or equal to 20.')
+      end
+
       invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      return false if !@quickbooks_code.nil? && @quickbooks_code.to_s.length > 20
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] quickbooks_code Value to be assigned
+    def quickbooks_code=(quickbooks_code)
+      if !quickbooks_code.nil? && quickbooks_code.to_s.length > 20
+        fail ArgumentError, 'invalid value for "quickbooks_code", the character length must be smaller than or equal to 20.'
+      end
+
+      @quickbooks_code = quickbooks_code
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
           discount_amount == o.discount_amount &&
+          quickbooks_code == o.quickbooks_code &&
           subtotal_amount == o.subtotal_amount
     end
 
@@ -84,7 +109,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [discount_amount, subtotal_amount].hash
+      [discount_amount, quickbooks_code, subtotal_amount].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/coupon_tier_percent.rb

@@ -17,6 +17,9 @@ module UltracartClient
     # The percent of subtotal discount
     attr_accessor :discount_percent
 
+    # Quickbooks accounting code.
+    attr_accessor :quickbooks_code
+
     # The amount of subtotal required to receive the discount percent
     attr_accessor :subtotal_amount
 
@@ -24,6 +27,7 @@ module UltracartClient
     def self.attribute_map
       {
         :'discount_percent' => :'discount_percent',
+        :'quickbooks_code' => :'quickbooks_code',
         :'subtotal_amount' => :'subtotal_amount'
       }
     end
@@ -32,6 +36,7 @@ module UltracartClient
     def self.swagger_types
       {
         :'discount_percent' => :'Float',
+        :'quickbooks_code' => :'String',
         :'subtotal_amount' => :'Float'
       }
     end
@@ -48,6 +53,10 @@ module UltracartClient
         self.discount_percent = attributes[:'discount_percent']
       end
 
+      if attributes.has_key?(:'quickbooks_code')
+        self.quickbooks_code = attributes[:'quickbooks_code']
+      end
+
       if attributes.has_key?(:'subtotal_amount')
         self.subtotal_amount = attributes[:'subtotal_amount']
       end
@@ -57,21 +66,37 @@ module UltracartClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if !@quickbooks_code.nil? && @quickbooks_code.to_s.length > 20
+        invalid_properties.push('invalid value for "quickbooks_code", the character length must be smaller than or equal to 20.')
+      end
+
       invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      return false if !@quickbooks_code.nil? && @quickbooks_code.to_s.length > 20
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] quickbooks_code Value to be assigned
+    def quickbooks_code=(quickbooks_code)
+      if !quickbooks_code.nil? && quickbooks_code.to_s.length > 20
+        fail ArgumentError, 'invalid value for "quickbooks_code", the character length must be smaller than or equal to 20.'
+      end
+
+      @quickbooks_code = quickbooks_code
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
           discount_percent == o.discount_percent &&
+          quickbooks_code == o.quickbooks_code &&
           subtotal_amount == o.subtotal_amount
     end
 
@@ -84,7 +109,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [discount_percent, subtotal_amount].hash
+      [discount_percent, quickbooks_code, subtotal_amount].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/coupon_tier_quantity_amount.rb

@@ -20,11 +20,15 @@ module UltracartClient
     # The quantity of item purchased (in units)
     attr_accessor :item_quantity
 
+    # Quickbooks accounting code.
+    attr_accessor :quickbooks_code
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'discount_amount' => :'discount_amount',
-        :'item_quantity' => :'item_quantity'
+        :'item_quantity' => :'item_quantity',
+        :'quickbooks_code' => :'quickbooks_code'
       }
     end
 
@@ -32,7 +36,8 @@ module UltracartClient
     def self.swagger_types
       {
         :'discount_amount' => :'Float',
-        :'item_quantity' => :'Integer'
+        :'item_quantity' => :'Integer',
+        :'quickbooks_code' => :'String'
       }
     end
 
@@ -51,28 +56,48 @@ module UltracartClient
       if attributes.has_key?(:'item_quantity')
         self.item_quantity = attributes[:'item_quantity']
       end
+
+      if attributes.has_key?(:'quickbooks_code')
+        self.quickbooks_code = attributes[:'quickbooks_code']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if !@quickbooks_code.nil? && @quickbooks_code.to_s.length > 20
+        invalid_properties.push('invalid value for "quickbooks_code", the character length must be smaller than or equal to 20.')
+      end
+
       invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      return false if !@quickbooks_code.nil? && @quickbooks_code.to_s.length > 20
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] quickbooks_code Value to be assigned
+    def quickbooks_code=(quickbooks_code)
+      if !quickbooks_code.nil? && quickbooks_code.to_s.length > 20
+        fail ArgumentError, 'invalid value for "quickbooks_code", the character length must be smaller than or equal to 20.'
+      end
+
+      @quickbooks_code = quickbooks_code
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
           discount_amount == o.discount_amount &&
-          item_quantity == o.item_quantity
+          item_quantity == o.item_quantity &&
+          quickbooks_code == o.quickbooks_code
     end
 
     # @see the `==` method
@@ -84,7 +109,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [discount_amount, item_quantity].hash
+      [discount_amount, item_quantity, quickbooks_code].hash
     end
 
     # Builds the object from hash