ultracart_api 3.1.45 → 3.2.4

data/lib/ultracart_api/api/integration_log_api.rb

@@ -0,0 +1,228 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'uri'
+
+module UltracartClient
+  class IntegrationLogApi
+    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::IntegrationLogApi.new(api_client)
+    end
+
+    # Retrieve an integration log
+    # Retrieve an integration logs from the account based identifiers 
+    # @param pk 
+    # @param sk 
+    # @param [Hash] opts the optional parameters
+    # @return [IntegrationLogResponse]
+    def get_integration_log(pk, sk, opts = {})
+      data, _status_code, _headers = get_integration_log_with_http_info(pk, sk, opts)
+      data
+    end
+
+    # Retrieve an integration log
+    # Retrieve an integration logs from the account based identifiers 
+    # @param pk 
+    # @param sk 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IntegrationLogResponse, Fixnum, Hash)>] IntegrationLogResponse data, response status code and response headers
+    def get_integration_log_with_http_info(pk, sk, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IntegrationLogApi.get_integration_log ...'
+      end
+      # verify the required parameter 'pk' is set
+      if @api_client.config.client_side_validation && pk.nil?
+        fail ArgumentError, "Missing the required parameter 'pk' when calling IntegrationLogApi.get_integration_log"
+      end
+      # verify the required parameter 'sk' is set
+      if @api_client.config.client_side_validation && sk.nil?
+        fail ArgumentError, "Missing the required parameter 'sk' when calling IntegrationLogApi.get_integration_log"
+      end
+      # resource path
+      local_var_path = '/integration_log/query/{pk}/{sk}'.sub('{' + 'pk' + '}', pk.to_s).sub('{' + 'sk' + '}', sk.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(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'IntegrationLogResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IntegrationLogApi#get_integration_log\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Retrieve an integration log file
+    # Retrieve an integration log file from the account based identifiers 
+    # @param pk 
+    # @param sk 
+    # @param uuid 
+    # @param [Hash] opts the optional parameters
+    # @return [File]
+    def get_integration_log_file(pk, sk, uuid, opts = {})
+      data, _status_code, _headers = get_integration_log_file_with_http_info(pk, sk, uuid, opts)
+      data
+    end
+
+    # Retrieve an integration log file
+    # Retrieve an integration log file from the account based identifiers 
+    # @param pk 
+    # @param sk 
+    # @param uuid 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
+    def get_integration_log_file_with_http_info(pk, sk, uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IntegrationLogApi.get_integration_log_file ...'
+      end
+      # verify the required parameter 'pk' is set
+      if @api_client.config.client_side_validation && pk.nil?
+        fail ArgumentError, "Missing the required parameter 'pk' when calling IntegrationLogApi.get_integration_log_file"
+      end
+      # verify the required parameter 'sk' is set
+      if @api_client.config.client_side_validation && sk.nil?
+        fail ArgumentError, "Missing the required parameter 'sk' when calling IntegrationLogApi.get_integration_log_file"
+      end
+      # verify the required parameter 'uuid' is set
+      if @api_client.config.client_side_validation && uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'uuid' when calling IntegrationLogApi.get_integration_log_file"
+      end
+      # resource path
+      local_var_path = '/integration_log/query/{pk}/{sk}/{uuid}'.sub('{' + 'pk' + '}', pk.to_s).sub('{' + 'sk' + '}', sk.to_s).sub('{' + 'uuid' + '}', uuid.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/octet-stream'])
+      # 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(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'File')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IntegrationLogApi#get_integration_log_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Retrieve integration logs
+    # Retrieves a set of integration logs from the account based on a query object. 
+    # @param integration_log_query Integration log query
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Default 100, Max 500) (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 items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+    # @return [IntegrationLogQueryResponse]
+    def get_integration_logs_query(integration_log_query, opts = {})
+      data, _status_code, _headers = get_integration_logs_query_with_http_info(integration_log_query, opts)
+      data
+    end
+
+    # Retrieve integration logs
+    # Retrieves a set of integration logs from the account based on a query object. 
+    # @param integration_log_query Integration log query
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Default 100, Max 500)
+    # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index.
+    # @option opts [String] :_sort The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+    # @return [Array<(IntegrationLogQueryResponse, Fixnum, Hash)>] IntegrationLogQueryResponse data, response status code and response headers
+    def get_integration_logs_query_with_http_info(integration_log_query, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IntegrationLogApi.get_integration_logs_query ...'
+      end
+      # verify the required parameter 'integration_log_query' is set
+      if @api_client.config.client_side_validation && integration_log_query.nil?
+        fail ArgumentError, "Missing the required parameter 'integration_log_query' when calling IntegrationLogApi.get_integration_logs_query"
+      end
+      # resource path
+      local_var_path = '/integration_log/query'
+
+      # query parameters
+      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 = {}
+      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(integration_log_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 => 'IntegrationLogQueryResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IntegrationLogApi#get_integration_logs_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/ultracart_api/api/storefront_api.rb

@@ -4562,19 +4562,27 @@ module UltracartClient
     # Get screen recording heatmap index
     # Get screen recording heatmap index 
     # @param storefront_oid 
+    # @param query Query
     # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Default 100, Max 500) (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 items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
     # @return [ScreenRecordingHeatmapIndexResponse]
-    def get_heatmap_index(storefront_oid, opts = {})
-      data, _status_code, _headers = get_heatmap_index_with_http_info(storefront_oid, opts)
+    def get_heatmap_index(storefront_oid, query, opts = {})
+      data, _status_code, _headers = get_heatmap_index_with_http_info(storefront_oid, query, opts)
       data
     end
 
     # Get screen recording heatmap index
     # Get screen recording heatmap index 
     # @param storefront_oid 
+    # @param query Query
     # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Default 100, Max 500)
+    # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index.
+    # @option opts [String] :_sort The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
     # @return [Array<(ScreenRecordingHeatmapIndexResponse, Fixnum, Hash)>] ScreenRecordingHeatmapIndexResponse data, response status code and response headers
-    def get_heatmap_index_with_http_info(storefront_oid, opts = {})
+    def get_heatmap_index_with_http_info(storefront_oid, query, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: StorefrontApi.get_heatmap_index ...'
       end
@@ -4582,11 +4590,18 @@ module UltracartClient
       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
+      # 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_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 = {}
+      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 = {}
@@ -4600,7 +4615,7 @@ module UltracartClient
       form_params = {}
 
       # http body (model)
-      post_body = nil
+      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,
@@ -4889,58 +4904,6 @@ module UltracartClient
       end
       return data, status_code, headers
     end
-    # Retrieve pricing tiers
-    # Retrieves the pricing tiers 
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
-    # @return [PricingTiersResponse]
-    def get_pricing_tiers(opts = {})
-      data, _status_code, _headers = get_pricing_tiers_with_http_info(opts)
-      data
-    end
-
-    # Retrieve pricing tiers
-    # Retrieves the pricing tiers 
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
-    # @return [Array<(PricingTiersResponse, Fixnum, Hash)>] PricingTiersResponse data, response status code and response headers
-    def get_pricing_tiers_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: StorefrontApi.get_pricing_tiers ...'
-      end
-      # resource path
-      local_var_path = '/storefront/pricing_tiers'
-
-      # query parameters
-      query_params = {}
-      query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
-
-      # 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(:GET, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'PricingTiersResponse')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: StorefrontApi#get_pricing_tiers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
     # Get screen recording
     # Get screen recording 
     # @param storefront_oid 
@@ -5429,6 +5392,58 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Retrieve pricing tiers
+    # Retrieves the pricing tiers 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @return [PricingTiersResponse]
+    def get_store_front_pricing_tiers(opts = {})
+      data, _status_code, _headers = get_store_front_pricing_tiers_with_http_info(opts)
+      data
+    end
+
+    # Retrieve pricing tiers
+    # Retrieves the pricing tiers 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @return [Array<(PricingTiersResponse, Fixnum, Hash)>] PricingTiersResponse data, response status code and response headers
+    def get_store_front_pricing_tiers_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.get_store_front_pricing_tiers ...'
+      end
+      # resource path
+      local_var_path = '/storefront/pricing_tiers'
+
+      # query parameters
+      query_params = {}
+      query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
+
+      # 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(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'PricingTiersResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#get_store_front_pricing_tiers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Get thumbnail parameters
     # @param thumbnail_parameters Thumbnail Parameters
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/models/error.rb

@@ -23,6 +23,9 @@ module UltracartClient
     # Additional information often a link to additional documentation
     attr_accessor :more_info
 
+    # Object id that the error is associated with
+    attr_accessor :object_id
+
     # An end-user friendly message suitable for display to the customer
     attr_accessor :user_message
 
@@ -32,6 +35,7 @@ module UltracartClient
         :'developer_message' => :'developer_message',
         :'error_code' => :'error_code',
         :'more_info' => :'more_info',
+        :'object_id' => :'object_id',
         :'user_message' => :'user_message'
       }
     end
@@ -42,6 +46,7 @@ module UltracartClient
         :'developer_message' => :'String',
         :'error_code' => :'String',
         :'more_info' => :'String',
+        :'object_id' => :'String',
         :'user_message' => :'String'
       }
     end
@@ -66,6 +71,10 @@ module UltracartClient
         self.more_info = attributes[:'more_info']
       end
 
+      if attributes.has_key?(:'object_id')
+        self.object_id = attributes[:'object_id']
+      end
+
       if attributes.has_key?(:'user_message')
         self.user_message = attributes[:'user_message']
       end
@@ -92,6 +101,7 @@ module UltracartClient
           developer_message == o.developer_message &&
           error_code == o.error_code &&
           more_info == o.more_info &&
+          object_id == o.object_id &&
           user_message == o.user_message
     end
 
@@ -104,7 +114,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [developer_message, error_code, more_info, user_message].hash
+      [developer_message, error_code, more_info, object_id, user_message].hash
     end
 
     # Builds the object from hash