ultracart_api 3.10.125 → 3.10.126

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf58195910f46fde5ef8031b5cbc2558f7b9918a2e9488aa480130c14d356c48
-  data.tar.gz: e8072049e8bb737eccdeb5f3b152dd7e003e41a011caf016f1ee51a6e4fa21d5
+  metadata.gz: e04c6f616cdf5cb99b8cde7b1c1de250f497340acf579d4ba24b80f36a64f164
+  data.tar.gz: cade080fb27b592da1d720713e7047e6d36347bd83624d966a7999aaacb1d9de
 SHA512:
-  metadata.gz: 23f21a0fa71d9e4310d912059868b9803973eeb764eea3f383946f0080855c0106f2da05adaa6f1ba9d5022f765bc31ba1ba64f29e759e804d7bcfff79d93b8e
-  data.tar.gz: 94d3421051eea455f89c066d9a1007673094be93f32074b10629699967b153fae8d4b4b23cba8dc12472e93646fbae94f1c1525f2b29f2c03be962256d9abd53
+  metadata.gz: 3b16540bc3169bb2ad5eeafe7d6821fd4913143b0ed53061438116524f0eb8aba74d4bdfdf1304c977eb47ff4ff608a0c23e80861f5a20e29d8b43ed3cba1401
+  data.tar.gz: 7c25afc3a6a01a7534ee028a3c3aada879a9962153c858deeb50fa9011faa8144d93e840dfc7f59c04acf2b407aaa09386e061be2a634582066d2de52a97801e

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.125
+- Package version: 3.10.126
 - 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.125.gem
+gem install ./ultracart_api-3.10.126.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.125.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.126.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.125'
+    gem 'ultracart_api', '~> 3.10.126'
 
 ### Install from Git
 
@@ -1138,6 +1138,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ReportDataSetResponse](docs/ReportDataSetResponse.md)
  - [UltracartClient::ReportDataSetRow](docs/ReportDataSetRow.md)
  - [UltracartClient::ReportDataSetSchema](docs/ReportDataSetSchema.md)
+ - [UltracartClient::ReportDataSetSummary](docs/ReportDataSetSummary.md)
  - [UltracartClient::ReportDataSource](docs/ReportDataSource.md)
  - [UltracartClient::ReportDataSourceSchema](docs/ReportDataSourceSchema.md)
  - [UltracartClient::ReportExecuteQueriesRequest](docs/ReportExecuteQueriesRequest.md)
@@ -1148,6 +1149,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ReportPageVisualizationDimension](docs/ReportPageVisualizationDimension.md)
  - [UltracartClient::ReportPageVisualizationMetric](docs/ReportPageVisualizationMetric.md)
  - [UltracartClient::ReportResponse](docs/ReportResponse.md)
+ - [UltracartClient::ReportWebsocketEvent](docs/ReportWebsocketEvent.md)
  - [UltracartClient::ReportsResponse](docs/ReportsResponse.md)
  - [UltracartClient::ResponseMetadata](docs/ResponseMetadata.md)
  - [UltracartClient::ResultSet](docs/ResultSet.md)
@@ -1338,6 +1340,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.126 | 03/22/2023 | data warehouse internal dev |
 | 3.10.125 | 03/22/2023 | dw initial framework |
 | 3.10.124 | 03/22/2023 | order api - refundable response added manual_because_multiple_charges boolean field |
 | 3.10.123 | 03/21/2023 | order api - new stage named Hold |

data/docs/ReportDataSetSummary.md

@@ -0,0 +1,14 @@
+# UltracartClient::ReportDataSetSummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data_set_uuid** | **String** | A unique identifier assigned to the data set that is returned. | [optional] 
+**error_message** | **String** | Error message if the query failed. | [optional] 
+**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] 
+**max_results** | **Integer** | The total number of results | [optional] 
+**schema** | [**Array<ReportDataSetSchema>**](ReportDataSetSchema.md) | The schema associated with the data set. | [optional] 
+**user_data** | **String** | Any other data that needs to be returned with the response to help the UI | [optional] 
+
+

data/docs/ReportWebsocketEvent.md

@@ -0,0 +1,9 @@
+# UltracartClient::ReportWebsocketEvent
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**event_type** | **String** | Event type | [optional] 
+**query_completion** | [**ReportDataSetSummary**](ReportDataSetSummary.md) |  | [optional] 
+
+

data/lib/ultracart_api/models/report_data_set_summary.rb

@@ -0,0 +1,281 @@
+=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 ReportDataSetSummary
+    # A unique identifier assigned to the data set that is returned.
+    attr_accessor :data_set_uuid
+
+    # Error message if the query failed.
+    attr_accessor :error_message
+
+    # An identifier that can be used to help match up the returned data set
+    attr_accessor :for_object_id
+
+    # The type of object this data set is for
+    attr_accessor :for_object_type
+
+    # The total number of results
+    attr_accessor :max_results
+
+    # The schema associated with the data set.
+    attr_accessor :schema
+
+    # Any other data that needs to be returned with the response to help the UI
+    attr_accessor :user_data
+
+    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
+      {
+        :'data_set_uuid' => :'data_set_uuid',
+        :'error_message' => :'error_message',
+        :'for_object_id' => :'for_object_id',
+        :'for_object_type' => :'for_object_type',
+        :'max_results' => :'max_results',
+        :'schema' => :'schema',
+        :'user_data' => :'user_data'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'data_set_uuid' => :'String',
+        :'error_message' => :'String',
+        :'for_object_id' => :'String',
+        :'for_object_type' => :'String',
+        :'max_results' => :'Integer',
+        :'schema' => :'Array<ReportDataSetSchema>',
+        :'user_data' => :'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?(:'data_set_uuid')
+        self.data_set_uuid = attributes[:'data_set_uuid']
+      end
+
+      if attributes.has_key?(:'error_message')
+        self.error_message = attributes[:'error_message']
+      end
+
+      if attributes.has_key?(:'for_object_id')
+        self.for_object_id = attributes[:'for_object_id']
+      end
+
+      if attributes.has_key?(:'for_object_type')
+        self.for_object_type = attributes[:'for_object_type']
+      end
+
+      if attributes.has_key?(:'max_results')
+        self.max_results = attributes[:'max_results']
+      end
+
+      if attributes.has_key?(:'schema')
+        if (value = attributes[:'schema']).is_a?(Array)
+          self.schema = value
+        end
+      end
+
+      if attributes.has_key?(:'user_data')
+        self.user_data = attributes[:'user_data']
+      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?
+      for_object_type_validator = EnumAttributeValidator.new('String', ['schema', 'filter', 'visualization'])
+      return false unless for_object_type_validator.valid?(@for_object_type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] for_object_type Object to be assigned
+    def for_object_type=(for_object_type)
+      validator = EnumAttributeValidator.new('String', ['schema', 'filter', 'visualization'])
+      unless validator.valid?(for_object_type)
+        fail ArgumentError, 'invalid value for "for_object_type", must be one of #{validator.allowable_values}.'
+      end
+      @for_object_type = for_object_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 &&
+          data_set_uuid == o.data_set_uuid &&
+          error_message == o.error_message &&
+          for_object_id == o.for_object_id &&
+          for_object_type == o.for_object_type &&
+          max_results == o.max_results &&
+          schema == o.schema &&
+          user_data == o.user_data
+    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
+      [data_set_uuid, error_message, for_object_id, for_object_type, max_results, schema, user_data].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/models/report_websocket_event.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 'date'
+
+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
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'event_type' => :'String',
+        :'query_completion' => :'ReportDataSetSummary'
+      }
+    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?(:'event_type')
+        self.event_type = attributes[:'event_type']
+      end
+
+      if attributes.has_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 [Fixnum] 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 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.125'
+  VERSION = '3.10.126'
 end

data/lib/ultracart_api.rb

@@ -652,6 +652,7 @@ 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'
@@ -662,6 +663,7 @@ 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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.10.125
+  version: 3.10.126
 platform: ruby
 authors:
 - UltraCart
@@ -871,6 +871,7 @@ files:
 - docs/ReportDataSetResponse.md
 - docs/ReportDataSetRow.md
 - docs/ReportDataSetSchema.md
+- docs/ReportDataSetSummary.md
 - docs/ReportDataSource.md
 - docs/ReportDataSourceSchema.md
 - docs/ReportExecuteQueriesRequest.md
@@ -881,6 +882,7 @@ files:
 - docs/ReportPageVisualizationDimension.md
 - docs/ReportPageVisualizationMetric.md
 - docs/ReportResponse.md
+- docs/ReportWebsocketEvent.md
 - docs/ReportsResponse.md
 - docs/ResponseMetadata.md
 - docs/ResultSet.md
@@ -1666,6 +1668,7 @@ files:
 - 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
@@ -1676,6 +1679,7 @@ files:
 - 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