ultracart_api 3.10.160 → 3.10.161

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b030241bd9251e1cbbf04675286624f2c471a9dc2b2e2f77f7c5cd2b0518bf80
-  data.tar.gz: 97cf966347d315d15e257abf4fc8383e6a090422a9bc3615e9a3567a24bab2d6
+  metadata.gz: 91d06ded053441fa51cbc536473c18fa3272c7faef94b4659eada67106a6fb4d
+  data.tar.gz: 3c2fea2b478dc3d604337b36350fc0317416016feb1eddf57d1180d8efcd8ea1
 SHA512:
-  metadata.gz: 4ed33851dec92aeb545a1cadc1e7a7c6e1f6f2ea91c0caaeea443b66f402a800681ebaf611d4e5aabbf9454ff14ac81f369c6a84b7ab5ac8e3f1c43f902d3532
-  data.tar.gz: d0c593c87739d88de0b81979ab3aeff624e9fb5342afabe38fa8af1898032baaa0ae8295e280f2ba18a0c3335fbaf3b6e0fdb0f6ab557f471439022ba93d3b6c
+  metadata.gz: a2ee526b862b5cf858d7007649c623cabbdd538260a1989eb08dcceda37f29bbcf04f1ea427de37d4c8cc64276e6b80dbef25e87a41311a5b32b14d956784bd6
+  data.tar.gz: b35c18a4dd266b50f2570d787b12b14875f3751d5ad7c40f4c9cc78663ea52275cf2b64646a49ca2ebb8af0c926b03643c9a143c71e139a774ae45f56c4eb224

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.10.160
+- Package version: 3.10.161
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.10.160.gem
+gem install ./ultracart_api-3.10.161.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.160.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.161.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', '~> 3.10.160'
+    gem 'ultracart_api', '~> 3.10.161'
 
 ### Install from Git
 
@@ -1154,6 +1154,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)
@@ -1362,6 +1363,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.161 | 09/22/2023 | dwbi - new option to control order-by of result set |
 | 3.10.160 | 09/15/2023 | new item fields for additional barcodes |
 | 3.10.159 | 09/12/2023 | added oids to customer properties |
 | 3.10.158 | 09/06/2023 | esp condition for survey trigger |

data/docs/ReportDataSetQuery.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **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] 

data/docs/ReportDataSetQueryOrderByColumn.md

@@ -0,0 +1,9 @@
+# UltracartClient::ReportDataSetQueryOrderByColumn
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ascending** | **BOOLEAN** |  | [optional] 
+**column_name** | **String** |  | [optional] 
+
+

data/lib/ultracart_api/models/report_data_set_query.rb

@@ -34,6 +34,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
 
@@ -78,6 +81,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',
@@ -96,6 +100,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',
@@ -147,6 +152,12 @@ module UltracartClient
         end
       end
 
+      if attributes.has_key?(:'order_by_columns')
+        if (value = attributes[:'order_by_columns']).is_a?(Array)
+          self.order_by_columns = value
+        end
+      end
+
       if attributes.has_key?(:'page_size')
         self.page_size = attributes[:'page_size']
       end
@@ -204,6 +215,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 &&
@@ -219,7 +231,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] 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,193 @@
+=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 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
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'ascending' => :'BOOLEAN',
+        :'column_name' => :'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?(:'ascending')
+        self.ascending = attributes[:'ascending']
+      end
+
+      if attributes.has_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 [Fixnum] 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 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

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '3.10.160'
+  VERSION = '3.10.161'
 end

data/lib/ultracart_api.rb

@@ -660,6 +660,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: 3.10.160
+  version: 3.10.161
 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
@@ -879,6 +879,7 @@ files:
 - docs/ReportDataSetPage.md
 - docs/ReportDataSetPageResponse.md
 - docs/ReportDataSetQuery.md
+- docs/ReportDataSetQueryOrderByColumn.md
 - docs/ReportDataSetResponse.md
 - docs/ReportDataSetRow.md
 - docs/ReportDataSetSchema.md
@@ -1690,6 +1691,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