ultracart_api 4.1.199 → 4.1.201

data/lib/ultracart_api/models/sfvb_approval_create_request.rb

@@ -21,6 +21,13 @@ module UltracartClient
     # For a file.put_script write, the exact script to be written, at most 256 KB.  UltraCart reviews it and keeps only its hash, so send the same bytes again on the write.  Leave it out for a revert, which names params.version.
     attr_accessor :content
 
+    attr_accessor :experiment_start
+
+    # For item.attribute_batch, exactly the rows the batch will send - the dry run's change rows, each with merchant_item_oid and current_sha256.  UltraCart keeps only their hash.
+    attr_accessor :item_attribute_rows
+
+    attr_accessor :item_pricing
+
     attr_accessor :params
 
     # Why the agent wants to do this, in a sentence.  Shown to the person as unverified text, capped at 500 characters.
@@ -56,6 +63,9 @@ module UltracartClient
       {
         :'action' => :'action',
         :'content' => :'content',
+        :'experiment_start' => :'experiment_start',
+        :'item_attribute_rows' => :'item_attribute_rows',
+        :'item_pricing' => :'item_pricing',
         :'params' => :'params',
         :'reason' => :'reason',
         :'redirect_rows' => :'redirect_rows'
@@ -72,6 +82,9 @@ module UltracartClient
       {
         :'action' => :'String',
         :'content' => :'String',
+        :'experiment_start' => :'SfvbExperimentStartRequest',
+        :'item_attribute_rows' => :'Array<SfvbItemAttributeBatchRow>',
+        :'item_pricing' => :'SfvbItemPricingRequest',
         :'params' => :'SfvbApprovalParams',
         :'reason' => :'String',
         :'redirect_rows' => :'Array<SfvbRedirectDeleteRow>'
@@ -107,6 +120,20 @@ module UltracartClient
         self.content = attributes[:'content']
       end
 
+      if attributes.key?(:'experiment_start')
+        self.experiment_start = attributes[:'experiment_start']
+      end
+
+      if attributes.key?(:'item_attribute_rows')
+        if (value = attributes[:'item_attribute_rows']).is_a?(Array)
+          self.item_attribute_rows = value
+        end
+      end
+
+      if attributes.key?(:'item_pricing')
+        self.item_pricing = attributes[:'item_pricing']
+      end
+
       if attributes.key?(:'params')
         self.params = attributes[:'params']
       end
@@ -132,7 +159,7 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      action_validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "redirect.delete_batch"])
+      action_validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing"])
       return false unless action_validator.valid?(@action)
       true
     end
@@ -140,7 +167,7 @@ module UltracartClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] action Object to be assigned
     def action=(action)
-      validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "redirect.delete_batch"])
+      validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing"])
       unless validator.valid?(action)
         fail ArgumentError, "invalid value for \"action\", must be one of #{validator.allowable_values}."
       end
@@ -154,6 +181,9 @@ module UltracartClient
       self.class == o.class &&
           action == o.action &&
           content == o.content &&
+          experiment_start == o.experiment_start &&
+          item_attribute_rows == o.item_attribute_rows &&
+          item_pricing == o.item_pricing &&
           params == o.params &&
           reason == o.reason &&
           redirect_rows == o.redirect_rows
@@ -168,7 +198,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [action, content, params, reason, redirect_rows].hash
+      [action, content, experiment_start, item_attribute_rows, item_pricing, params, reason, redirect_rows].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_approval_params.rb

@@ -15,33 +15,95 @@ require 'time'
 
 module UltracartClient
   class SfvbApprovalParams
+    # For item.attribute_batch, the attributes the batch would change.  Set by the server.
+    attr_accessor :attribute_names
+
     # The blog post, for blog_post.delete.
     attr_accessor :blog_post_oid
 
     # For file.put_script, the SHA-256 of the exact bytes approved.  Set by the server, never by the caller.  The write must send bytes with this hash.
     attr_accessor :content_sha256
 
-    # The file path, for file.delete and file.put_script.  Exactly as the gated call will send it.
+    # For experiment.end, the experiment to end.
+    attr_accessor :experiment_oid
+
+    # For item.attribute_batch, how many items the batch would change when it was requested.  Set by the server.
+    attr_accessor :item_count
+
+    # For item.pricing, the item whose pricing changes.
+    attr_accessor :merchant_item_oid
+
+    # The file path, for file.delete and file.put_script, or the page path for experiment.start of a page experiment.  Exactly as the gated call will send it.
     attr_accessor :path
 
-    # For redirect.delete_batch, the plan_hash of the exact rows approved.  Set by the server.  The batch delete must send rows with this hash.
+    # For experiment.start of a url experiment, the hash of the checked experiment approved, and for item.pricing the hash of the change.  Set by the server.  The gated call must send the same.
+    attr_accessor :request_sha256
+
+    # For redirect.delete_batch and item.attribute_batch, the plan_hash of the exact rows approved.  Set by the server.  The batch must send rows with this hash.
     attr_accessor :rows_sha256
 
     # For redirect.delete_batch, how many rules the batch would delete when it was requested.  Set by the server.
     attr_accessor :rule_count
 
+    # For experiment.start of a page experiment, the page body name.  Defaults to body.
+    attr_accessor :slot
+
+    # For upsell.enable, what to switch on.
+    attr_accessor :upsell_kind
+
+    # For upsell.enable, the oid of the offer or path to switch on.
+    attr_accessor :upsell_oid
+
     # For file.put_script, the history version a revert restores.  Leave it out, and send content instead, for a write.
     attr_accessor :version
 
+    # For experiment.start of a page experiment, the id of the experiment element.
+    attr_accessor :widget_id
+
+    # For experiment.end, the winning variation.  Leave it out to end without a winner, and leave it out of the end call too.
+    attr_accessor :winner_variation_number
+
+    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
       {
+        :'attribute_names' => :'attribute_names',
         :'blog_post_oid' => :'blog_post_oid',
         :'content_sha256' => :'content_sha256',
+        :'experiment_oid' => :'experiment_oid',
+        :'item_count' => :'item_count',
+        :'merchant_item_oid' => :'merchant_item_oid',
         :'path' => :'path',
+        :'request_sha256' => :'request_sha256',
         :'rows_sha256' => :'rows_sha256',
         :'rule_count' => :'rule_count',
-        :'version' => :'version'
+        :'slot' => :'slot',
+        :'upsell_kind' => :'upsell_kind',
+        :'upsell_oid' => :'upsell_oid',
+        :'version' => :'version',
+        :'widget_id' => :'widget_id',
+        :'winner_variation_number' => :'winner_variation_number'
       }
     end
 
@@ -53,12 +115,22 @@ module UltracartClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'attribute_names' => :'Array<String>',
         :'blog_post_oid' => :'Integer',
         :'content_sha256' => :'String',
+        :'experiment_oid' => :'Integer',
+        :'item_count' => :'Integer',
+        :'merchant_item_oid' => :'Integer',
         :'path' => :'String',
+        :'request_sha256' => :'String',
         :'rows_sha256' => :'String',
         :'rule_count' => :'Integer',
-        :'version' => :'Integer'
+        :'slot' => :'String',
+        :'upsell_kind' => :'String',
+        :'upsell_oid' => :'Integer',
+        :'version' => :'Integer',
+        :'widget_id' => :'String',
+        :'winner_variation_number' => :'Integer'
       }
     end
 
@@ -83,6 +155,12 @@ module UltracartClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'attribute_names')
+        if (value = attributes[:'attribute_names']).is_a?(Array)
+          self.attribute_names = value
+        end
+      end
+
       if attributes.key?(:'blog_post_oid')
         self.blog_post_oid = attributes[:'blog_post_oid']
       end
@@ -91,10 +169,26 @@ module UltracartClient
         self.content_sha256 = attributes[:'content_sha256']
       end
 
+      if attributes.key?(:'experiment_oid')
+        self.experiment_oid = attributes[:'experiment_oid']
+      end
+
+      if attributes.key?(:'item_count')
+        self.item_count = attributes[:'item_count']
+      end
+
+      if attributes.key?(:'merchant_item_oid')
+        self.merchant_item_oid = attributes[:'merchant_item_oid']
+      end
+
       if attributes.key?(:'path')
         self.path = attributes[:'path']
       end
 
+      if attributes.key?(:'request_sha256')
+        self.request_sha256 = attributes[:'request_sha256']
+      end
+
       if attributes.key?(:'rows_sha256')
         self.rows_sha256 = attributes[:'rows_sha256']
       end
@@ -103,9 +197,29 @@ module UltracartClient
         self.rule_count = attributes[:'rule_count']
       end
 
+      if attributes.key?(:'slot')
+        self.slot = attributes[:'slot']
+      end
+
+      if attributes.key?(:'upsell_kind')
+        self.upsell_kind = attributes[:'upsell_kind']
+      end
+
+      if attributes.key?(:'upsell_oid')
+        self.upsell_oid = attributes[:'upsell_oid']
+      end
+
       if attributes.key?(:'version')
         self.version = attributes[:'version']
       end
+
+      if attributes.key?(:'widget_id')
+        self.widget_id = attributes[:'widget_id']
+      end
+
+      if attributes.key?(:'winner_variation_number')
+        self.winner_variation_number = attributes[:'winner_variation_number']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -118,20 +232,42 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      upsell_kind_validator = EnumAttributeValidator.new('String', ["offer", "path"])
+      return false unless upsell_kind_validator.valid?(@upsell_kind)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] upsell_kind Object to be assigned
+    def upsell_kind=(upsell_kind)
+      validator = EnumAttributeValidator.new('String', ["offer", "path"])
+      unless validator.valid?(upsell_kind)
+        fail ArgumentError, "invalid value for \"upsell_kind\", must be one of #{validator.allowable_values}."
+      end
+      @upsell_kind = upsell_kind
+    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 &&
+          attribute_names == o.attribute_names &&
           blog_post_oid == o.blog_post_oid &&
           content_sha256 == o.content_sha256 &&
+          experiment_oid == o.experiment_oid &&
+          item_count == o.item_count &&
+          merchant_item_oid == o.merchant_item_oid &&
           path == o.path &&
+          request_sha256 == o.request_sha256 &&
           rows_sha256 == o.rows_sha256 &&
           rule_count == o.rule_count &&
-          version == o.version
+          slot == o.slot &&
+          upsell_kind == o.upsell_kind &&
+          upsell_oid == o.upsell_oid &&
+          version == o.version &&
+          widget_id == o.widget_id &&
+          winner_variation_number == o.winner_variation_number
     end
 
     # @see the `==` method
@@ -143,7 +279,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [blog_post_oid, content_sha256, path, rows_sha256, rule_count, version].hash
+      [attribute_names, blog_post_oid, content_sha256, experiment_oid, item_count, merchant_item_oid, path, request_sha256, rows_sha256, rule_count, slot, upsell_kind, upsell_oid, version, widget_id, winner_variation_number].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_container_version.rb

@@ -27,7 +27,7 @@ module UltracartClient
     # Container name, where the owner has more than one container.
     attr_accessor :container_name
 
-    # When this snapshot was taken.
+    # When this snapshot was taken, ISO 8601 UTC.
     attr_accessor :created_dts
 
     # True for the value currently stored.

data/lib/ultracart_api/models/sfvb_event.rb

@@ -0,0 +1,270 @@
+=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 SfvbEvent
+    # When it happened, ISO 8601.
+    attr_accessor :event_dts
+
+    # Time-ordered id.  Pass the last one seen as after to replay what came since.
+    attr_accessor :event_id
+
+    # The id of what changed, such as the approval_id.
+    attr_accessor :object_id
+
+    # What changed, such as approval.
+    attr_accessor :object_type
+
+    # The storefront it concerns.  Empty for merchant-level objects.
+    attr_accessor :storefront_oid
+
+    # approval.decided (approved, denied, cancelled or refused by the script review) or approval.ready (the review finished and the person can decide).
+    attr_accessor :type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'event_dts' => :'event_dts',
+        :'event_id' => :'event_id',
+        :'object_id' => :'object_id',
+        :'object_type' => :'object_type',
+        :'storefront_oid' => :'storefront_oid',
+        :'type' => :'type'
+      }
+    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_dts' => :'String',
+        :'event_id' => :'String',
+        :'object_id' => :'String',
+        :'object_type' => :'String',
+        :'storefront_oid' => :'Integer',
+        :'type' => :'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::SfvbEvent` 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::SfvbEvent`. 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_dts')
+        self.event_dts = attributes[:'event_dts']
+      end
+
+      if attributes.key?(:'event_id')
+        self.event_id = attributes[:'event_id']
+      end
+
+      if attributes.key?(:'object_id')
+        self.object_id = attributes[:'object_id']
+      end
+
+      if attributes.key?(:'object_type')
+        self.object_type = attributes[:'object_type']
+      end
+
+      if attributes.key?(:'storefront_oid')
+        self.storefront_oid = attributes[:'storefront_oid']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      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 &&
+          event_dts == o.event_dts &&
+          event_id == o.event_id &&
+          object_id == o.object_id &&
+          object_type == o.object_type &&
+          storefront_oid == o.storefront_oid &&
+          type == o.type
+    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_dts, event_id, object_id, object_type, storefront_oid, type].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