ultracart_api 4.0.177 → 4.0.178

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ffc40d5315a915831fcd60e2c4e5fcb62b6f5748d12860b371760ab988efabd
-  data.tar.gz: 1f9729c540d9c670086514b86f0678ac40e3dee333e8676898c596816ebb7699
+  metadata.gz: 7f08dbaed916a79d9f3d50cd1dae8ae1ed32fb2b6bc1ae14dc2d0e358a9fe75f
+  data.tar.gz: d209c2c2a7d7da973e67be58867eb9cf7332be7a770bb32f697486cceeea1519
 SHA512:
-  metadata.gz: 7b66f64c44772f5b0162454fadfb4220ba53d9bb05c10c2bc605f94769ed4a2c16842db5122ca3cf7c42a6824bc3be3e217f00234e778db6627c3df4064b3a86
-  data.tar.gz: 4311d664f619f70f2c017c70d249302e633d78979fd656c825f9091d2ba77e50fbde5d21a506280803afbcf150000e8517ac368d3b3effca9e6f7366214c99a9
+  metadata.gz: 7584893c53896afdd240a8b48330c99e59f2a85d1ac681a5fbdc2877ad3f00f0eb3b9cebe33163e1f62d7920fd185de8d210f8e50e3720b3f50fd350c8c7ae05
+  data.tar.gz: bbe29dae890bb926b858a721f919e0830c221da3bd82ebdeea4fd664698502d43450129fa140a2e4f877820ae841cd2d81224e49f87c1b7b21a2c03cc65e52ff

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.0.177
+- Package version: 4.0.178
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-4.0.177.gem
+gem install ./ultracart_api-4.0.178.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.177.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.178.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ultracart_api', '~> 4.0.177'
+    gem 'ultracart_api', '~> 4.0.178'
 
 ### Install from Git
 
@@ -1159,6 +1159,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ReportDataSetPage](docs/ReportDataSetPage.md)
  - [UltracartClient::ReportDataSetPageResponse](docs/ReportDataSetPageResponse.md)
  - [UltracartClient::ReportDataSetQuery](docs/ReportDataSetQuery.md)
+ - [UltracartClient::ReportDataSetQueryOrderByColumn](docs/ReportDataSetQueryOrderByColumn.md)
  - [UltracartClient::ReportDataSetResponse](docs/ReportDataSetResponse.md)
  - [UltracartClient::ReportDataSetRow](docs/ReportDataSetRow.md)
  - [UltracartClient::ReportDataSetSchema](docs/ReportDataSetSchema.md)
@@ -1370,6 +1371,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.178 | 09/22/2023 | dwbi - new option to control order-by of result set |
 | 4.0.177 | 09/15/2023 | new item fields for additional barcodes |
 | 4.0.176 | 09/12/2023 | added oids to customer properties |
 | 4.0.175 | 09/06/2023 | esp condition for survey trigger |

data/docs/ReportDataSetQuery.md

@@ -12,6 +12,7 @@
 | **for_object_id** | **String** | An identifier that can be used to help match up the returned data set | [optional] |
 | **for_object_type** | **String** | The type of object this data set is for | [optional] |
 | **metrics** | [**Array<ReportPageVisualizationMetric>**](ReportPageVisualizationMetric.md) |  | [optional] |
+| **order_by_columns** | [**Array<ReportDataSetQueryOrderByColumn>**](ReportDataSetQueryOrderByColumn.md) | The columns to order by in the final result.  If not specified the dimensions will be used | [optional] |
 | **page_size** | **Integer** | Result set page size.  The default value is 200 records.  Max is 10000. | [optional] |
 | **selected_filters** | [**Array<ReportFilter>**](ReportFilter.md) |  | [optional] |
 | **skip_cache** | **Boolean** | True if the 15 minute cache should be skipped. | [optional] |
@@ -31,6 +32,7 @@ instance = UltracartClient::ReportDataSetQuery.new(
   for_object_id: null,
   for_object_type: null,
   metrics: null,
+  order_by_columns: null,
   page_size: null,
   selected_filters: null,
   skip_cache: null,

data/docs/ReportDataSetQueryOrderByColumn.md

@@ -0,0 +1,20 @@
+# UltracartClient::ReportDataSetQueryOrderByColumn
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ascending** | **Boolean** |  | [optional] |
+| **column_name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ReportDataSetQueryOrderByColumn.new(
+  ascending: null,
+  column_name: null
+)
+```
+

data/lib/ultracart_api/models/report_data_set_query.rb

@@ -35,6 +35,9 @@ module UltracartClient
 
     attr_accessor :metrics
 
+    # The columns to order by in the final result.  If not specified the dimensions will be used
+    attr_accessor :order_by_columns
+
     # Result set page size.  The default value is 200 records.  Max is 10000.
     attr_accessor :page_size
 
@@ -79,6 +82,7 @@ module UltracartClient
         :'for_object_id' => :'for_object_id',
         :'for_object_type' => :'for_object_type',
         :'metrics' => :'metrics',
+        :'order_by_columns' => :'order_by_columns',
         :'page_size' => :'page_size',
         :'selected_filters' => :'selected_filters',
         :'skip_cache' => :'skip_cache',
@@ -102,6 +106,7 @@ module UltracartClient
         :'for_object_id' => :'String',
         :'for_object_type' => :'String',
         :'metrics' => :'Array<ReportPageVisualizationMetric>',
+        :'order_by_columns' => :'Array<ReportDataSetQueryOrderByColumn>',
         :'page_size' => :'Integer',
         :'selected_filters' => :'Array<ReportFilter>',
         :'skip_cache' => :'Boolean',
@@ -166,6 +171,12 @@ module UltracartClient
         end
       end
 
+      if attributes.key?(:'order_by_columns')
+        if (value = attributes[:'order_by_columns']).is_a?(Array)
+          self.order_by_columns = value
+        end
+      end
+
       if attributes.key?(:'page_size')
         self.page_size = attributes[:'page_size']
       end
@@ -223,6 +234,7 @@ module UltracartClient
           for_object_id == o.for_object_id &&
           for_object_type == o.for_object_type &&
           metrics == o.metrics &&
+          order_by_columns == o.order_by_columns &&
           page_size == o.page_size &&
           selected_filters == o.selected_filters &&
           skip_cache == o.skip_cache &&
@@ -238,7 +250,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [comparison_results, data_set_query_uuid, data_source, dimensions, filter, for_object_id, for_object_type, metrics, page_size, selected_filters, skip_cache, user_data].hash
+      [comparison_results, data_set_query_uuid, data_source, dimensions, filter, for_object_id, for_object_type, metrics, order_by_columns, page_size, selected_filters, skip_cache, user_data].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/report_data_set_query_order_by_column.rb

@@ -0,0 +1,228 @@
+=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 ReportDataSetQueryOrderByColumn
+    attr_accessor :ascending
+
+    attr_accessor :column_name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'ascending' => :'ascending',
+        :'column_name' => :'column_name'
+      }
+    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
+      {
+        :'ascending' => :'Boolean',
+        :'column_name' => :'String'
+      }
+    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::ReportDataSetQueryOrderByColumn` 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::ReportDataSetQueryOrderByColumn`. 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?(:'ascending')
+        self.ascending = attributes[:'ascending']
+      end
+
+      if attributes.key?(:'column_name')
+        self.column_name = attributes[:'column_name']
+      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 &&
+          ascending == o.ascending &&
+          column_name == o.column_name
+    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
+      [ascending, column_name].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.177'
+  VERSION = '4.0.178'
 end

data/lib/ultracart_api.rb

@@ -659,6 +659,7 @@ 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_query_order_by_column'
 require 'ultracart_api/models/report_data_set_response'
 require 'ultracart_api/models/report_data_set_row'
 require 'ultracart_api/models/report_data_set_schema'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.0.177
+  version: 4.0.178
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-15 00:00:00.000000000 Z
+date: 2023-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -718,6 +718,7 @@ files:
 - docs/ReportDataSetPage.md
 - docs/ReportDataSetPageResponse.md
 - docs/ReportDataSetQuery.md
+- docs/ReportDataSetQueryOrderByColumn.md
 - docs/ReportDataSetResponse.md
 - docs/ReportDataSetRow.md
 - docs/ReportDataSetSchema.md
@@ -1528,6 +1529,7 @@ files:
 - 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_query_order_by_column.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