ultracart_api 4.1.198 → 4.1.200

data/lib/ultracart_api/models/sfvb_approval.rb

@@ -56,10 +56,12 @@ module UltracartClient
     # The reason the agent sent, as stored and shown (cleaned and capped).
     attr_accessor :reason
 
+    attr_accessor :review
+
     # Where the action applies.  The storefront host name, or account for account-wide actions.
     attr_accessor :scope
 
-    # pending, approved, denied, cancelled, expired or used.  Only approved may be sent with the gated call.
+    # reviewing, pending, approved, denied, cancelled, expired, used or refused.  Only approved may be sent with the gated call.  A script write starts as reviewing while UltraCart reviews it; keep polling, and show approval_url only once it is pending.  refused means the review refused the script; outcome_code and review say why.
     attr_accessor :status
 
     # The storefront the action runs on.  Absent for account-wide actions.
@@ -110,6 +112,7 @@ module UltracartClient
         :'outcome_http_status' => :'outcome_http_status',
         :'params' => :'params',
         :'reason' => :'reason',
+        :'review' => :'review',
         :'scope' => :'scope',
         :'status' => :'status',
         :'storefront_oid' => :'storefront_oid',
@@ -140,6 +143,7 @@ module UltracartClient
         :'outcome_http_status' => :'Integer',
         :'params' => :'SfvbApprovalParams',
         :'reason' => :'String',
+        :'review' => :'SfvbApprovalReview',
         :'scope' => :'String',
         :'status' => :'String',
         :'storefront_oid' => :'Integer',
@@ -225,6 +229,10 @@ module UltracartClient
         self.reason = attributes[:'reason']
       end
 
+      if attributes.key?(:'review')
+        self.review = attributes[:'review']
+      end
+
       if attributes.key?(:'scope')
         self.scope = attributes[:'scope']
       end
@@ -258,7 +266,7 @@ module UltracartClient
     def valid?
       outcome_validator = EnumAttributeValidator.new('String', ["succeeded", "failed"])
       return false unless outcome_validator.valid?(@outcome)
-      status_validator = EnumAttributeValidator.new('String', ["pending", "approved", "denied", "cancelled", "expired", "used"])
+      status_validator = EnumAttributeValidator.new('String', ["reviewing", "pending", "approved", "denied", "cancelled", "expired", "used", "refused"])
       return false unless status_validator.valid?(@status)
       true
     end
@@ -276,7 +284,7 @@ module UltracartClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] status Object to be assigned
     def status=(status)
-      validator = EnumAttributeValidator.new('String', ["pending", "approved", "denied", "cancelled", "expired", "used"])
+      validator = EnumAttributeValidator.new('String', ["reviewing", "pending", "approved", "denied", "cancelled", "expired", "used", "refused"])
       unless validator.valid?(status)
         fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
       end
@@ -302,6 +310,7 @@ module UltracartClient
           outcome_http_status == o.outcome_http_status &&
           params == o.params &&
           reason == o.reason &&
+          review == o.review &&
           scope == o.scope &&
           status == o.status &&
           storefront_oid == o.storefront_oid &&
@@ -318,7 +327,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [action, approval_id, approval_url, created_at, description, expires_at, expires_in_seconds, fresh_code_required, interval_seconds, outcome, outcome_code, outcome_http_status, params, reason, scope, status, storefront_oid, used_at, user_code].hash
+      [action, approval_id, approval_url, created_at, description, expires_at, expires_in_seconds, fresh_code_required, interval_seconds, outcome, outcome_code, outcome_http_status, params, reason, review, scope, status, storefront_oid, used_at, user_code].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_approval_create_request.rb

@@ -18,11 +18,24 @@ module UltracartClient
     # The gated action to approve.
     attr_accessor :action
 
+    # 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.
     attr_accessor :reason
 
+    # For redirect.delete_batch, exactly the rows the batch delete will send, up to 5,000, each with its hash_sha256.  UltraCart keeps only their hash.
+    attr_accessor :redirect_rows
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -49,8 +62,13 @@ module UltracartClient
     def self.attribute_map
       {
         :'action' => :'action',
+        :'content' => :'content',
+        :'experiment_start' => :'experiment_start',
+        :'item_attribute_rows' => :'item_attribute_rows',
+        :'item_pricing' => :'item_pricing',
         :'params' => :'params',
-        :'reason' => :'reason'
+        :'reason' => :'reason',
+        :'redirect_rows' => :'redirect_rows'
       }
     end
 
@@ -63,8 +81,13 @@ module UltracartClient
     def self.openapi_types
       {
         :'action' => :'String',
+        :'content' => :'String',
+        :'experiment_start' => :'SfvbExperimentStartRequest',
+        :'item_attribute_rows' => :'Array<SfvbItemAttributeBatchRow>',
+        :'item_pricing' => :'SfvbItemPricingRequest',
         :'params' => :'SfvbApprovalParams',
-        :'reason' => :'String'
+        :'reason' => :'String',
+        :'redirect_rows' => :'Array<SfvbRedirectDeleteRow>'
       }
     end
 
@@ -93,6 +116,24 @@ module UltracartClient
         self.action = attributes[:'action']
       end
 
+      if attributes.key?(:'content')
+        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
@@ -100,6 +141,12 @@ module UltracartClient
       if attributes.key?(:'reason')
         self.reason = attributes[:'reason']
       end
+
+      if attributes.key?(:'redirect_rows')
+        if (value = attributes[:'redirect_rows']).is_a?(Array)
+          self.redirect_rows = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -112,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"])
+      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
@@ -120,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"])
+      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
@@ -133,8 +180,13 @@ module UltracartClient
       return true if self.equal?(o)
       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
+          reason == o.reason &&
+          redirect_rows == o.redirect_rows
     end
 
     # @see the `==` method
@@ -146,7 +198,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [action, params, reason].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,17 +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
 
-    # The file path, for file.delete.  Exactly as the delete call will send it.
+    # 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
+
+    # 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 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',
-        :'path' => :'path'
+        :'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',
+        :'slot' => :'slot',
+        :'upsell_kind' => :'upsell_kind',
+        :'upsell_oid' => :'upsell_oid',
+        :'version' => :'version',
+        :'widget_id' => :'widget_id',
+        :'winner_variation_number' => :'winner_variation_number'
       }
     end
 
@@ -37,8 +115,22 @@ module UltracartClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'attribute_names' => :'Array<String>',
         :'blog_post_oid' => :'Integer',
-        :'path' => :'String'
+        :'content_sha256' => :'String',
+        :'experiment_oid' => :'Integer',
+        :'item_count' => :'Integer',
+        :'merchant_item_oid' => :'Integer',
+        :'path' => :'String',
+        :'request_sha256' => :'String',
+        :'rows_sha256' => :'String',
+        :'rule_count' => :'Integer',
+        :'slot' => :'String',
+        :'upsell_kind' => :'String',
+        :'upsell_oid' => :'Integer',
+        :'version' => :'Integer',
+        :'widget_id' => :'String',
+        :'winner_variation_number' => :'Integer'
       }
     end
 
@@ -63,13 +155,71 @@ 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
 
+      if attributes.key?(:'content_sha256')
+        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
+
+      if attributes.key?(:'rule_count')
+        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?
@@ -82,16 +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 &&
-          path == o.path
+          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 &&
+          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
@@ -103,7 +279,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [blog_post_oid, path].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