ultracart_api 3.1.44 → 3.1.49

data/lib/ultracart_api.rb

@@ -325,6 +325,13 @@ require 'ultracart_api/models/group_response'
 require 'ultracart_api/models/group_user_membership'
 require 'ultracart_api/models/groups_response'
 require 'ultracart_api/models/http_header'
+require 'ultracart_api/models/integration_log'
+require 'ultracart_api/models/integration_log_file'
+require 'ultracart_api/models/integration_log_log'
+require 'ultracart_api/models/integration_log_query_filter_values'
+require 'ultracart_api/models/integration_log_query_request'
+require 'ultracart_api/models/integration_log_query_response'
+require 'ultracart_api/models/integration_log_response'
 require 'ultracart_api/models/item'
 require 'ultracart_api/models/item_accounting'
 require 'ultracart_api/models/item_amember'
@@ -505,6 +512,7 @@ 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_request'
 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'
@@ -599,6 +607,7 @@ require 'ultracart_api/api/checkout_api'
 require 'ultracart_api/api/coupon_api'
 require 'ultracart_api/api/customer_api'
 require 'ultracart_api/api/fulfillment_api'
+require 'ultracart_api/api/integration_log_api'
 require 'ultracart_api/api/item_api'
 require 'ultracart_api/api/oauth_api'
 require 'ultracart_api/api/order_api'

data/lib/ultracart_api/api/integration_log_api.rb

@@ -0,0 +1,161 @@
+=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 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,

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

data/lib/ultracart_api/models/integration_log.rb

@@ -0,0 +1,316 @@
+=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 'date'
+
+module UltracartClient
+  class IntegrationLog
+    attr_accessor :action
+
+    attr_accessor :direction
+
+    attr_accessor :email
+
+    attr_accessor :files
+
+    attr_accessor :integration_log_oid
+
+    attr_accessor :item_id
+
+    attr_accessor :item_ipn_oid
+
+    attr_accessor :log_dts
+
+    attr_accessor :log_type
+
+    attr_accessor :logger_id
+
+    attr_accessor :logs
+
+    attr_accessor :order_ids
+
+    attr_accessor :pk
+
+    attr_accessor :sk
+
+    attr_accessor :status
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'action' => :'action',
+        :'direction' => :'direction',
+        :'email' => :'email',
+        :'files' => :'files',
+        :'integration_log_oid' => :'integration_log_oid',
+        :'item_id' => :'item_id',
+        :'item_ipn_oid' => :'item_ipn_oid',
+        :'log_dts' => :'log_dts',
+        :'log_type' => :'log_type',
+        :'logger_id' => :'logger_id',
+        :'logs' => :'logs',
+        :'order_ids' => :'order_ids',
+        :'pk' => :'pk',
+        :'sk' => :'sk',
+        :'status' => :'status'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'action' => :'String',
+        :'direction' => :'String',
+        :'email' => :'String',
+        :'files' => :'Array<IntegrationLogFile>',
+        :'integration_log_oid' => :'Integer',
+        :'item_id' => :'String',
+        :'item_ipn_oid' => :'Integer',
+        :'log_dts' => :'String',
+        :'log_type' => :'String',
+        :'logger_id' => :'String',
+        :'logs' => :'Array<IntegrationLogLog>',
+        :'order_ids' => :'Array<String>',
+        :'pk' => :'String',
+        :'sk' => :'String',
+        :'status' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'action')
+        self.action = attributes[:'action']
+      end
+
+      if attributes.has_key?(:'direction')
+        self.direction = attributes[:'direction']
+      end
+
+      if attributes.has_key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.has_key?(:'files')
+        if (value = attributes[:'files']).is_a?(Array)
+          self.files = value
+        end
+      end
+
+      if attributes.has_key?(:'integration_log_oid')
+        self.integration_log_oid = attributes[:'integration_log_oid']
+      end
+
+      if attributes.has_key?(:'item_id')
+        self.item_id = attributes[:'item_id']
+      end
+
+      if attributes.has_key?(:'item_ipn_oid')
+        self.item_ipn_oid = attributes[:'item_ipn_oid']
+      end
+
+      if attributes.has_key?(:'log_dts')
+        self.log_dts = attributes[:'log_dts']
+      end
+
+      if attributes.has_key?(:'log_type')
+        self.log_type = attributes[:'log_type']
+      end
+
+      if attributes.has_key?(:'logger_id')
+        self.logger_id = attributes[:'logger_id']
+      end
+
+      if attributes.has_key?(:'logs')
+        if (value = attributes[:'logs']).is_a?(Array)
+          self.logs = value
+        end
+      end
+
+      if attributes.has_key?(:'order_ids')
+        if (value = attributes[:'order_ids']).is_a?(Array)
+          self.order_ids = value
+        end
+      end
+
+      if attributes.has_key?(:'pk')
+        self.pk = attributes[:'pk']
+      end
+
+      if attributes.has_key?(:'sk')
+        self.sk = attributes[:'sk']
+      end
+
+      if attributes.has_key?(:'status')
+        self.status = attributes[:'status']
+      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
+      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?
+      true
+    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 &&
+          action == o.action &&
+          direction == o.direction &&
+          email == o.email &&
+          files == o.files &&
+          integration_log_oid == o.integration_log_oid &&
+          item_id == o.item_id &&
+          item_ipn_oid == o.item_ipn_oid &&
+          log_dts == o.log_dts &&
+          log_type == o.log_type &&
+          logger_id == o.logger_id &&
+          logs == o.logs &&
+          order_ids == o.order_ids &&
+          pk == o.pk &&
+          sk == o.sk &&
+          status == o.status
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [action, direction, email, files, integration_log_oid, item_id, item_ipn_oid, log_dts, log_type, logger_id, logs, order_ids, pk, sk, status].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end