ultracart_api 4.0.141 → 4.0.143

data/lib/ultracart_api/models/report_websocket_event.rb

@@ -0,0 +1,263 @@
+=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 'date'
+require 'time'
+
+module UltracartClient
+  class ReportWebsocketEvent
+    # Event type
+    attr_accessor :event_type
+
+    attr_accessor :query_completion
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'event_type' => :'event_type',
+        :'query_completion' => :'query_completion'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'event_type' => :'String',
+        :'query_completion' => :'ReportDataSetSummary'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::ReportWebsocketEvent` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::ReportWebsocketEvent`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'event_type')
+        self.event_type = attributes[:'event_type']
+      end
+
+      if attributes.key?(:'query_completion')
+        self.query_completion = attributes[:'query_completion']
+      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?
+      event_type_validator = EnumAttributeValidator.new('String', ["ping", "query completion"])
+      return false unless event_type_validator.valid?(@event_type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] event_type Object to be assigned
+    def event_type=(event_type)
+      validator = EnumAttributeValidator.new('String', ["ping", "query completion"])
+      unless validator.valid?(event_type)
+        fail ArgumentError, "invalid value for \"event_type\", must be one of #{validator.allowable_values}."
+      end
+      @event_type = event_type
+    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 &&
+          event_type == o.event_type &&
+          query_completion == o.query_completion
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [event_type, query_completion].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    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)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif 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
+      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 :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = UltracartClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        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

data/lib/ultracart_api/models/reports_response.rb

@@ -0,0 +1,258 @@
+=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 'date'
+require 'time'
+
+module UltracartClient
+  class ReportsResponse
+    attr_accessor :error
+
+    attr_accessor :metadata
+
+    attr_accessor :reports
+
+    # Indicates if API call was successful
+    attr_accessor :success
+
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'error' => :'error',
+        :'metadata' => :'metadata',
+        :'reports' => :'reports',
+        :'success' => :'success',
+        :'warning' => :'warning'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'error' => :'Error',
+        :'metadata' => :'ResponseMetadata',
+        :'reports' => :'Array<Report>',
+        :'success' => :'Boolean',
+        :'warning' => :'Warning'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::ReportsResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::ReportsResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'reports')
+        if (value = attributes[:'reports']).is_a?(Array)
+          self.reports = value
+        end
+      end
+
+      if attributes.key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.key?(:'warning')
+        self.warning = attributes[:'warning']
+      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 &&
+          error == o.error &&
+          metadata == o.metadata &&
+          reports == o.reports &&
+          success == o.success &&
+          warning == o.warning
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [error, metadata, reports, success, warning].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    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)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif 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
+      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 :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = UltracartClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        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

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.0.141'
+  VERSION = '4.0.143'
 end

data/lib/ultracart_api.rb

@@ -640,6 +640,30 @@ require 'ultracart_api/models/property'
 require 'ultracart_api/models/publish_library_item_request'
 require 'ultracart_api/models/register_affiliate_click_request'
 require 'ultracart_api/models/register_affiliate_click_response'
+require 'ultracart_api/models/report'
+require 'ultracart_api/models/report_auth'
+require 'ultracart_api/models/report_auth_response'
+require 'ultracart_api/models/report_data_set'
+require 'ultracart_api/models/report_data_set_column'
+require 'ultracart_api/models/report_data_set_page'
+require 'ultracart_api/models/report_data_set_page_response'
+require 'ultracart_api/models/report_data_set_query'
+require 'ultracart_api/models/report_data_set_response'
+require 'ultracart_api/models/report_data_set_row'
+require 'ultracart_api/models/report_data_set_schema'
+require 'ultracart_api/models/report_data_set_summary'
+require 'ultracart_api/models/report_data_source'
+require 'ultracart_api/models/report_data_source_schema'
+require 'ultracart_api/models/report_execute_queries_request'
+require 'ultracart_api/models/report_filter'
+require 'ultracart_api/models/report_filter_connection'
+require 'ultracart_api/models/report_page'
+require 'ultracart_api/models/report_page_visualization'
+require 'ultracart_api/models/report_page_visualization_dimension'
+require 'ultracart_api/models/report_page_visualization_metric'
+require 'ultracart_api/models/report_response'
+require 'ultracart_api/models/report_websocket_event'
+require 'ultracart_api/models/reports_response'
 require 'ultracart_api/models/response_metadata'
 require 'ultracart_api/models/result_set'
 require 'ultracart_api/models/ruler_validation_request'
@@ -769,6 +793,7 @@ require 'ultracart_api/api/checkout_api'
 require 'ultracart_api/api/conversation_api'
 require 'ultracart_api/api/coupon_api'
 require 'ultracart_api/api/customer_api'
+require 'ultracart_api/api/datawarehouse_api'
 require 'ultracart_api/api/fulfillment_api'
 require 'ultracart_api/api/gift_certificate_api'
 require 'ultracart_api/api/integration_log_api'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.0.141
+  version: 4.0.143
 platform: ruby
 authors:
 - UltraCart
@@ -354,6 +354,7 @@ files:
 - docs/CustomerTaxCodes.md
 - docs/CustomersResponse.md
 - docs/DataTablesServerSideResponse.md
+- docs/DatawarehouseApi.md
 - docs/Distance.md
 - docs/DistributionCenter.md
 - docs/DistributionCentersResponse.md
@@ -698,6 +699,30 @@ files:
 - docs/PublishLibraryItemRequest.md
 - docs/RegisterAffiliateClickRequest.md
 - docs/RegisterAffiliateClickResponse.md
+- docs/Report.md
+- docs/ReportAuth.md
+- docs/ReportAuthResponse.md
+- docs/ReportDataSet.md
+- docs/ReportDataSetColumn.md
+- docs/ReportDataSetPage.md
+- docs/ReportDataSetPageResponse.md
+- docs/ReportDataSetQuery.md
+- docs/ReportDataSetResponse.md
+- docs/ReportDataSetRow.md
+- docs/ReportDataSetSchema.md
+- docs/ReportDataSetSummary.md
+- docs/ReportDataSource.md
+- docs/ReportDataSourceSchema.md
+- docs/ReportExecuteQueriesRequest.md
+- docs/ReportFilter.md
+- docs/ReportFilterConnection.md
+- docs/ReportPage.md
+- docs/ReportPageVisualization.md
+- docs/ReportPageVisualizationDimension.md
+- docs/ReportPageVisualizationMetric.md
+- docs/ReportResponse.md
+- docs/ReportWebsocketEvent.md
+- docs/ReportsResponse.md
 - docs/ResponseMetadata.md
 - docs/ResultSet.md
 - docs/RulerValidationRequest.md
@@ -832,6 +857,7 @@ files:
 - lib/ultracart_api/api/conversation_api.rb
 - lib/ultracart_api/api/coupon_api.rb
 - lib/ultracart_api/api/customer_api.rb
+- lib/ultracart_api/api/datawarehouse_api.rb
 - lib/ultracart_api/api/fulfillment_api.rb
 - lib/ultracart_api/api/gift_certificate_api.rb
 - lib/ultracart_api/api/integration_log_api.rb
@@ -1469,6 +1495,30 @@ files:
 - lib/ultracart_api/models/publish_library_item_request.rb
 - lib/ultracart_api/models/register_affiliate_click_request.rb
 - lib/ultracart_api/models/register_affiliate_click_response.rb
+- lib/ultracart_api/models/report.rb
+- lib/ultracart_api/models/report_auth.rb
+- lib/ultracart_api/models/report_auth_response.rb
+- lib/ultracart_api/models/report_data_set.rb
+- lib/ultracart_api/models/report_data_set_column.rb
+- lib/ultracart_api/models/report_data_set_page.rb
+- lib/ultracart_api/models/report_data_set_page_response.rb
+- lib/ultracart_api/models/report_data_set_query.rb
+- lib/ultracart_api/models/report_data_set_response.rb
+- lib/ultracart_api/models/report_data_set_row.rb
+- lib/ultracart_api/models/report_data_set_schema.rb
+- lib/ultracart_api/models/report_data_set_summary.rb
+- lib/ultracart_api/models/report_data_source.rb
+- lib/ultracart_api/models/report_data_source_schema.rb
+- lib/ultracart_api/models/report_execute_queries_request.rb
+- lib/ultracart_api/models/report_filter.rb
+- lib/ultracart_api/models/report_filter_connection.rb
+- lib/ultracart_api/models/report_page.rb
+- lib/ultracart_api/models/report_page_visualization.rb
+- lib/ultracart_api/models/report_page_visualization_dimension.rb
+- lib/ultracart_api/models/report_page_visualization_metric.rb
+- lib/ultracart_api/models/report_response.rb
+- lib/ultracart_api/models/report_websocket_event.rb
+- lib/ultracart_api/models/reports_response.rb
 - lib/ultracart_api/models/response_metadata.rb
 - lib/ultracart_api/models/result_set.rb
 - lib/ultracart_api/models/ruler_validation_request.rb