ultracart_api 4.0.143 → 4.0.144

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70a3a20e89bbd3ddaefed8abbcfe856321e4a59137f76e14fcbd0e54da9f28ee
-  data.tar.gz: 3f01ed0057b15ec7aa051c281506b70d3176b1688071ddbb4e21537903c3ae60
+  metadata.gz: 68fb71fdebd9db9a11b4efdc375f11acfc252232ecb998c01e45dd3a210dc35a
+  data.tar.gz: f6959bceb05282bfd5d1af9f0021ef7d9d3072908665e62a7ca6461b15d1de91
 SHA512:
-  metadata.gz: 25e6f5e8e0e1209b1972452f5bb64a0850b1699d30ae051b059588518547823fbe46905a71bf9892bdb6f452e2212f8cfee795d90de0e97936de1dd289a9e4e2
-  data.tar.gz: d6ef73f40c9e4bd1ba4bd384527216ef55bbc563c3830cd09017c92fb77c5984c98b30e27aeae6e20e722b5547d9f65ff4af50cc37d0c44c422165c598ffe24f
+  metadata.gz: fb87b0de09a27b85b50783414b449c2c6a1d1d4330b6e33748e6a734af26d8226dd0e03b8a03be6e0e1a1f415aa0f64bed82d8400809ca66e4f0b2e9b0b88ebe
+  data.tar.gz: b8219a5ca433d0ddb1ecfb61e334bc23627e77cc9591bb7db72c230dc857714199ac8776e845af0940168c2caf602947a861cdae8e4db229ae9d13f306b97cc8

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.143
+- Package version: 4.0.144
 - 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.143.gem
+gem install ./ultracart_api-4.0.144.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.143.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.144.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.143'
+    gem 'ultracart_api', '~> 4.0.144'
 
 ### Install from Git
 
@@ -1143,7 +1143,6 @@ 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)
@@ -1348,6 +1347,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.144 | 03/29/2023 | internal development |
 | 4.0.143 | 03/22/2023 | data warehouse internal dev |
 | 4.0.142 | 03/22/2023 | dw initial framework |
 | 4.0.141 | 03/22/2023 | order api - refundable response added manual_because_multiple_charges boolean field |

data/docs/Experiment.md

@@ -14,7 +14,12 @@
 | **notes** | **String** | Notes about the experiment | [optional] |
 | **objective** | **String** | Objective that is being optimized | [optional] |
 | **objective_parameter** | **String** | Objective parameter (such as event name) that is being optimized | [optional] |
+| **openai_current_iteration** | **Integer** | The current iteration of the OpenAI related experiment | [optional] |
+| **openai_element_type** | **String** | The type of OpenAI element being experimented on | [optional] |
+| **openai_model** | **String** | The type of OpenAI model used | [optional] |
+| **openai_total_iterations** | **Integer** | The total number of iterations to perform on the experiment | [optional] |
 | **optimization_type** | **String** | Type of optimization | [optional] |
+| **p_value** | **Float** | Statistics p-value for the experiment | [optional] |
 | **session_count** | **Integer** | Total number of sessions in the experiment | [optional] |
 | **start_dts** | **String** | Start date/time | [optional] |
 | **status** | **String** | Status of the experiment | [optional] |
@@ -39,7 +44,12 @@ instance = UltracartClient::Experiment.new(
   notes: null,
   objective: null,
   objective_parameter: null,
+  openai_current_iteration: null,
+  openai_element_type: null,
+  openai_model: null,
+  openai_total_iterations: null,
   optimization_type: null,
+  p_value: null,
   session_count: null,
   start_dts: null,
   status: null,

data/docs/ReportWebsocketEvent.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **event_type** | **String** | Event type | [optional] |
-| **query_completion** | [**ReportDataSetSummary**](ReportDataSetSummary.md) |  | [optional] |
+| **query_completion** | [**ReportDataSet**](ReportDataSet.md) |  | [optional] |
 
 ## Example
 

data/lib/ultracart_api/models/experiment.rb

@@ -45,9 +45,24 @@ module UltracartClient
     # Objective parameter (such as event name) that is being optimized
     attr_accessor :objective_parameter
 
+    # The current iteration of the OpenAI related experiment
+    attr_accessor :openai_current_iteration
+
+    # The type of OpenAI element being experimented on
+    attr_accessor :openai_element_type
+
+    # The type of OpenAI model used
+    attr_accessor :openai_model
+
+    # The total number of iterations to perform on the experiment
+    attr_accessor :openai_total_iterations
+
     # Type of optimization
     attr_accessor :optimization_type
 
+    # Statistics p-value for the experiment
+    attr_accessor :p_value
+
     # Total number of sessions in the experiment
     attr_accessor :session_count
 
@@ -104,7 +119,12 @@ module UltracartClient
         :'notes' => :'notes',
         :'objective' => :'objective',
         :'objective_parameter' => :'objective_parameter',
+        :'openai_current_iteration' => :'openai_current_iteration',
+        :'openai_element_type' => :'openai_element_type',
+        :'openai_model' => :'openai_model',
+        :'openai_total_iterations' => :'openai_total_iterations',
         :'optimization_type' => :'optimization_type',
+        :'p_value' => :'p_value',
         :'session_count' => :'session_count',
         :'start_dts' => :'start_dts',
         :'status' => :'status',
@@ -133,7 +153,12 @@ module UltracartClient
         :'notes' => :'String',
         :'objective' => :'String',
         :'objective_parameter' => :'String',
+        :'openai_current_iteration' => :'Integer',
+        :'openai_element_type' => :'String',
+        :'openai_model' => :'String',
+        :'openai_total_iterations' => :'Integer',
         :'optimization_type' => :'String',
+        :'p_value' => :'Float',
         :'session_count' => :'Integer',
         :'start_dts' => :'String',
         :'status' => :'String',
@@ -205,10 +230,30 @@ module UltracartClient
         self.objective_parameter = attributes[:'objective_parameter']
       end
 
+      if attributes.key?(:'openai_current_iteration')
+        self.openai_current_iteration = attributes[:'openai_current_iteration']
+      end
+
+      if attributes.key?(:'openai_element_type')
+        self.openai_element_type = attributes[:'openai_element_type']
+      end
+
+      if attributes.key?(:'openai_model')
+        self.openai_model = attributes[:'openai_model']
+      end
+
+      if attributes.key?(:'openai_total_iterations')
+        self.openai_total_iterations = attributes[:'openai_total_iterations']
+      end
+
       if attributes.key?(:'optimization_type')
         self.optimization_type = attributes[:'optimization_type']
       end
 
+      if attributes.key?(:'p_value')
+        self.p_value = attributes[:'p_value']
+      end
+
       if attributes.key?(:'session_count')
         self.session_count = attributes[:'session_count']
       end
@@ -250,11 +295,23 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      openai_element_type_validator = EnumAttributeValidator.new('String', ["headline", "text", "textblock"])
+      return false unless openai_element_type_validator.valid?(@openai_element_type)
       status_validator = EnumAttributeValidator.new('String', ["Running", "Ended", "Deleted"])
       return false unless status_validator.valid?(@status)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] openai_element_type Object to be assigned
+    def openai_element_type=(openai_element_type)
+      validator = EnumAttributeValidator.new('String', ["headline", "text", "textblock"])
+      unless validator.valid?(openai_element_type)
+        fail ArgumentError, "invalid value for \"openai_element_type\", must be one of #{validator.allowable_values}."
+      end
+      @openai_element_type = openai_element_type
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] status Object to be assigned
     def status=(status)
@@ -280,7 +337,12 @@ module UltracartClient
           notes == o.notes &&
           objective == o.objective &&
           objective_parameter == o.objective_parameter &&
+          openai_current_iteration == o.openai_current_iteration &&
+          openai_element_type == o.openai_element_type &&
+          openai_model == o.openai_model &&
+          openai_total_iterations == o.openai_total_iterations &&
           optimization_type == o.optimization_type &&
+          p_value == o.p_value &&
           session_count == o.session_count &&
           start_dts == o.start_dts &&
           status == o.status &&
@@ -299,7 +361,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [container_id, duration_days, end_dts, equal_weighting, experiment_type, id, name, notes, objective, objective_parameter, optimization_type, session_count, start_dts, status, storefront_experiment_oid, storefront_oid, uri, variations].hash
+      [container_id, duration_days, end_dts, equal_weighting, experiment_type, id, name, notes, objective, objective_parameter, openai_current_iteration, openai_element_type, openai_model, openai_total_iterations, optimization_type, p_value, session_count, start_dts, status, storefront_experiment_oid, storefront_oid, uri, variations].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/report_websocket_event.rb

@@ -59,7 +59,7 @@ module UltracartClient
     def self.openapi_types
       {
         :'event_type' => :'String',
-        :'query_completion' => :'ReportDataSetSummary'
+        :'query_completion' => :'ReportDataSet'
       }
     end
 

data/lib/ultracart_api/version.rb

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

data/lib/ultracart_api.rb

@@ -651,7 +651,6 @@ 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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.0.143
+  version: 4.0.144
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-22 00:00:00.000000000 Z
+date: 2023-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -710,7 +710,6 @@ files:
 - docs/ReportDataSetResponse.md
 - docs/ReportDataSetRow.md
 - docs/ReportDataSetSchema.md
-- docs/ReportDataSetSummary.md
 - docs/ReportDataSource.md
 - docs/ReportDataSourceSchema.md
 - docs/ReportExecuteQueriesRequest.md
@@ -1506,7 +1505,6 @@ 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

data/docs/ReportDataSetSummary.md

@@ -1,30 +0,0 @@
-# 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] |
-
-## Example
-
-```ruby
-require 'ultracart_api'
-
-instance = UltracartClient::ReportDataSetSummary.new(
-  data_set_uuid: null,
-  error_message: null,
-  for_object_id: null,
-  for_object_type: null,
-  max_results: null,
-  schema: null,
-  user_data: null
-)
-```
-

data/lib/ultracart_api/models/report_data_set_summary.rb

@@ -1,316 +0,0 @@
-=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 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
-
-    # Returns all the JSON keys this model knows about
-    def self.acceptable_attributes
-      attribute_map.values
-    end
-
-    # Attribute type mapping.
-    def self.openapi_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
-
-    # 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::ReportDataSetSummary` 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::ReportDataSetSummary`. 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?(:'data_set_uuid')
-        self.data_set_uuid = attributes[:'data_set_uuid']
-      end
-
-      if attributes.key?(:'error_message')
-        self.error_message = attributes[:'error_message']
-      end
-
-      if attributes.key?(:'for_object_id')
-        self.for_object_id = attributes[:'for_object_id']
-      end
-
-      if attributes.key?(:'for_object_type')
-        self.for_object_type = attributes[:'for_object_type']
-      end
-
-      if attributes.key?(:'max_results')
-        self.max_results = attributes[:'max_results']
-      end
-
-      if attributes.key?(:'schema')
-        if (value = attributes[:'schema']).is_a?(Array)
-          self.schema = value
-        end
-      end
-
-      if attributes.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 [Integer] 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 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