ultracart_api 4.1.227 → 4.1.229

data/lib/ultracart_api/models/sfvb_approval_create_request.rb

@@ -40,6 +40,8 @@ module UltracartClient
 
     attr_accessor :segment_update
 
+    attr_accessor :site_seo
+
     attr_accessor :smart_attribution
 
     attr_accessor :tracking_provider
@@ -79,6 +81,7 @@ module UltracartClient
         :'reason' => :'reason',
         :'redirect_rows' => :'redirect_rows',
         :'segment_update' => :'segment_update',
+        :'site_seo' => :'site_seo',
         :'smart_attribution' => :'smart_attribution',
         :'tracking_provider' => :'tracking_provider'
       }
@@ -102,6 +105,7 @@ module UltracartClient
         :'reason' => :'String',
         :'redirect_rows' => :'Array<SfvbRedirectDeleteRow>',
         :'segment_update' => :'SfvbCommsSegmentWriteRequest',
+        :'site_seo' => :'SfvbSiteSeoRequest',
         :'smart_attribution' => :'SfvbSmartAttributionRequest',
         :'tracking_provider' => :'SfvbTrackingProviderRequest'
       }
@@ -172,6 +176,10 @@ module UltracartClient
         self.segment_update = attributes[:'segment_update']
       end
 
+      if attributes.key?(:'site_seo')
+        self.site_seo = attributes[:'site_seo']
+      end
+
       if attributes.key?(:'smart_attribution')
         self.smart_attribution = attributes[:'smart_attribution']
       end
@@ -191,7 +199,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", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete", "sequence_step.move", "sequence_step.enable_postcard", "segment.update", "smart_attribution.change", "smart_attribution.delete", "tracking_provider.change", "tracking_html.put", "affiliate_network.change", "affiliate_network.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", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete", "sequence_step.move", "sequence_step.enable_postcard", "segment.update", "smart_attribution.change", "smart_attribution.delete", "tracking_provider.change", "tracking_html.put", "affiliate_network.change", "affiliate_network.delete", "site_seo.change"])
       return false unless action_validator.valid?(@action)
       true
     end
@@ -199,7 +207,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", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete", "sequence_step.move", "sequence_step.enable_postcard", "segment.update", "smart_attribution.change", "smart_attribution.delete", "tracking_provider.change", "tracking_html.put", "affiliate_network.change", "affiliate_network.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", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete", "sequence_step.move", "sequence_step.enable_postcard", "segment.update", "smart_attribution.change", "smart_attribution.delete", "tracking_provider.change", "tracking_html.put", "affiliate_network.change", "affiliate_network.delete", "site_seo.change"])
       unless validator.valid?(action)
         fail ArgumentError, "invalid value for \"action\", must be one of #{validator.allowable_values}."
       end
@@ -221,6 +229,7 @@ module UltracartClient
           reason == o.reason &&
           redirect_rows == o.redirect_rows &&
           segment_update == o.segment_update &&
+          site_seo == o.site_seo &&
           smart_attribution == o.smart_attribution &&
           tracking_provider == o.tracking_provider
     end
@@ -234,7 +243,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [action, affiliate_network, content, experiment_start, item_attribute_rows, item_pricing, params, reason, redirect_rows, segment_update, smart_attribution, tracking_provider].hash
+      [action, affiliate_network, content, experiment_start, item_attribute_rows, item_pricing, params, reason, redirect_rows, segment_update, site_seo, smart_attribution, tracking_provider].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_blog_post_detail.rb

@@ -30,6 +30,9 @@ module UltracartClient
     # When the post was created (ISO 8601, UTC).
     attr_accessor :created_dts
 
+    # True when this is the result of a dry run and nothing was saved.  The post is shown as it is stored.
+    attr_accessor :dry_run
+
     # The post excerpt as HTML, exactly as stored.
     attr_accessor :excerpt
 
@@ -77,6 +80,7 @@ module UltracartClient
         :'blog_post_oid' => :'blog_post_oid',
         :'body' => :'body',
         :'created_dts' => :'created_dts',
+        :'dry_run' => :'dry_run',
         :'excerpt' => :'excerpt',
         :'images' => :'images',
         :'last_modified_dts' => :'last_modified_dts',
@@ -106,6 +110,7 @@ module UltracartClient
         :'blog_post_oid' => :'Integer',
         :'body' => :'String',
         :'created_dts' => :'String',
+        :'dry_run' => :'Boolean',
         :'excerpt' => :'String',
         :'images' => :'Array<SfvbBlogPostImage>',
         :'last_modified_dts' => :'String',
@@ -163,6 +168,10 @@ module UltracartClient
         self.created_dts = attributes[:'created_dts']
       end
 
+      if attributes.key?(:'dry_run')
+        self.dry_run = attributes[:'dry_run']
+      end
+
       if attributes.key?(:'excerpt')
         self.excerpt = attributes[:'excerpt']
       end
@@ -243,6 +252,7 @@ module UltracartClient
           blog_post_oid == o.blog_post_oid &&
           body == o.body &&
           created_dts == o.created_dts &&
+          dry_run == o.dry_run &&
           excerpt == o.excerpt &&
           images == o.images &&
           last_modified_dts == o.last_modified_dts &&
@@ -267,7 +277,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [allow_comments, author, blog_post_oid, body, created_dts, excerpt, images, last_modified_dts, publication_dts, seo_description, seo_keywords, seo_title, tags, title, unassigned, url_part, view_url, visibility].hash
+      [allow_comments, author, blog_post_oid, body, created_dts, dry_run, excerpt, images, last_modified_dts, publication_dts, seo_description, seo_keywords, seo_title, tags, title, unassigned, url_part, view_url, visibility].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_blog_post_request.rb

@@ -24,6 +24,9 @@ module UltracartClient
     # The post body as HTML, up to 1 MB, rendered exactly as stored.  Refused with sfvb.unsafe_html if it could run script - script and other executable tags, on attributes, links that are not http, https, mailto, tel or relative, and iframes other than YouTube or Vimeo players.  Reference an attached image by the url the post's images report.
     attr_accessor :body
 
+    # On an update, true to run every check the write would run and save nothing.  A refusal comes back exactly as it would on the real write.
+    attr_accessor :dry_run
+
     # The post excerpt as HTML, up to 256 KB.  Held to the same rule as body.
     attr_accessor :excerpt
 
@@ -79,6 +82,7 @@ module UltracartClient
         :'allow_comments' => :'allow_comments',
         :'author' => :'author',
         :'body' => :'body',
+        :'dry_run' => :'dry_run',
         :'excerpt' => :'excerpt',
         :'publication_dts' => :'publication_dts',
         :'seo_description' => :'seo_description',
@@ -102,6 +106,7 @@ module UltracartClient
         :'allow_comments' => :'Boolean',
         :'author' => :'String',
         :'body' => :'String',
+        :'dry_run' => :'Boolean',
         :'excerpt' => :'String',
         :'publication_dts' => :'String',
         :'seo_description' => :'String',
@@ -147,6 +152,10 @@ module UltracartClient
         self.body = attributes[:'body']
       end
 
+      if attributes.key?(:'dry_run')
+        self.dry_run = attributes[:'dry_run']
+      end
+
       if attributes.key?(:'excerpt')
         self.excerpt = attributes[:'excerpt']
       end
@@ -219,6 +228,7 @@ module UltracartClient
           allow_comments == o.allow_comments &&
           author == o.author &&
           body == o.body &&
+          dry_run == o.dry_run &&
           excerpt == o.excerpt &&
           publication_dts == o.publication_dts &&
           seo_description == o.seo_description &&
@@ -239,7 +249,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [allow_comments, author, body, excerpt, publication_dts, seo_description, seo_keywords, seo_title, tags, title, url_part, visibility].hash
+      [allow_comments, author, body, dry_run, excerpt, publication_dts, seo_description, seo_keywords, seo_title, tags, title, url_part, visibility].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_not_found_entry.rb

@@ -27,6 +27,9 @@ module UltracartClient
     # First hit, ISO 8601.
     attr_accessor :first_seen_dts
 
+    # True when the entry is marked fixed or mapped.  The next hit on the path clears it.
+    attr_accessor :fixed
+
     # Every recorded hit, bots included.
     attr_accessor :hits
 
@@ -55,6 +58,7 @@ module UltracartClient
         :'bot_share' => :'bot_share',
         :'counted_hits' => :'counted_hits',
         :'first_seen_dts' => :'first_seen_dts',
+        :'fixed' => :'fixed',
         :'hits' => :'hits',
         :'ignored' => :'ignored',
         :'last_seen_dts' => :'last_seen_dts',
@@ -77,6 +81,7 @@ module UltracartClient
         :'bot_share' => :'Object',
         :'counted_hits' => :'Integer',
         :'first_seen_dts' => :'String',
+        :'fixed' => :'Boolean',
         :'hits' => :'Integer',
         :'ignored' => :'Boolean',
         :'last_seen_dts' => :'String',
@@ -124,6 +129,10 @@ module UltracartClient
         self.first_seen_dts = attributes[:'first_seen_dts']
       end
 
+      if attributes.key?(:'fixed')
+        self.fixed = attributes[:'fixed']
+      end
+
       if attributes.key?(:'hits')
         self.hits = attributes[:'hits']
       end
@@ -177,6 +186,7 @@ module UltracartClient
           bot_share == o.bot_share &&
           counted_hits == o.counted_hits &&
           first_seen_dts == o.first_seen_dts &&
+          fixed == o.fixed &&
           hits == o.hits &&
           ignored == o.ignored &&
           last_seen_dts == o.last_seen_dts &&
@@ -195,7 +205,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [bot_hits, bot_share, counted_hits, first_seen_dts, hits, ignored, last_seen_dts, not_found_id, path, redirected_to, referrer_hosts].hash
+      [bot_hits, bot_share, counted_hits, first_seen_dts, fixed, hits, ignored, last_seen_dts, not_found_id, path, redirected_to, referrer_hosts].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_not_found_summary.rb

@@ -0,0 +1,280 @@
+=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 SfvbNotFoundSummary
+    # 404 hits per hour for the last 24 hours, oldest first.
+    attr_accessor :last_24_hours
+
+    # 404 hits per day, oldest first, ending today in the server's time zone.  Bots and shoppers together.
+    attr_accessor :last_30_days
+
+    # 404 hits per day for the last 7 days, oldest first.
+    attr_accessor :last_7_days
+
+    # Up to 10 open paths first seen in the last 30 days, most hits first, leaving out paths only bots have hit.
+    attr_accessor :new_paths
+
+    # What a person should know about reading these counts.
+    attr_accessor :notes
+
+    # The sum of last_30_days.
+    attr_accessor :total_30_days
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'last_24_hours' => :'last_24_hours',
+        :'last_30_days' => :'last_30_days',
+        :'last_7_days' => :'last_7_days',
+        :'new_paths' => :'new_paths',
+        :'notes' => :'notes',
+        :'total_30_days' => :'total_30_days'
+      }
+    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
+      {
+        :'last_24_hours' => :'Array<Integer>',
+        :'last_30_days' => :'Array<Integer>',
+        :'last_7_days' => :'Array<Integer>',
+        :'new_paths' => :'Array<SfvbNotFoundEntry>',
+        :'notes' => :'Array<String>',
+        :'total_30_days' => :'Integer'
+      }
+    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::SfvbNotFoundSummary` 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::SfvbNotFoundSummary`. 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?(:'last_24_hours')
+        if (value = attributes[:'last_24_hours']).is_a?(Array)
+          self.last_24_hours = value
+        end
+      end
+
+      if attributes.key?(:'last_30_days')
+        if (value = attributes[:'last_30_days']).is_a?(Array)
+          self.last_30_days = value
+        end
+      end
+
+      if attributes.key?(:'last_7_days')
+        if (value = attributes[:'last_7_days']).is_a?(Array)
+          self.last_7_days = value
+        end
+      end
+
+      if attributes.key?(:'new_paths')
+        if (value = attributes[:'new_paths']).is_a?(Array)
+          self.new_paths = value
+        end
+      end
+
+      if attributes.key?(:'notes')
+        if (value = attributes[:'notes']).is_a?(Array)
+          self.notes = value
+        end
+      end
+
+      if attributes.key?(:'total_30_days')
+        self.total_30_days = attributes[:'total_30_days']
+      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 &&
+          last_24_hours == o.last_24_hours &&
+          last_30_days == o.last_30_days &&
+          last_7_days == o.last_7_days &&
+          new_paths == o.new_paths &&
+          notes == o.notes &&
+          total_30_days == o.total_30_days
+    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
+      [last_24_hours, last_30_days, last_7_days, new_paths, notes, total_30_days].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

data/lib/ultracart_api/models/sfvb_redirect_import_row.rb

@@ -15,6 +15,9 @@ require 'time'
 
 module UltracartClient
   class SfvbRedirectImportRow
+    # True to leave the rule's source out of the generated sitemap.  Left out means false, as in the admin.
+    attr_accessor :exclude_from_sitemap
+
     # Why the rule exists.
     attr_accessor :note
 
@@ -27,6 +30,7 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'exclude_from_sitemap' => :'exclude_from_sitemap',
         :'note' => :'note',
         :'source' => :'source',
         :'target' => :'target'
@@ -41,6 +45,7 @@ module UltracartClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'exclude_from_sitemap' => :'Boolean',
         :'note' => :'String',
         :'source' => :'String',
         :'target' => :'String'
@@ -68,6 +73,10 @@ module UltracartClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'exclude_from_sitemap')
+        self.exclude_from_sitemap = attributes[:'exclude_from_sitemap']
+      end
+
       if attributes.key?(:'note')
         self.note = attributes[:'note']
       end
@@ -99,6 +108,7 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          exclude_from_sitemap == o.exclude_from_sitemap &&
           note == o.note &&
           source == o.source &&
           target == o.target
@@ -113,7 +123,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [note, source, target].hash
+      [exclude_from_sitemap, note, source, target].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_redirect_request.rb

@@ -15,6 +15,9 @@ require 'time'
 
 module UltracartClient
   class SfvbRedirectRequest
+    # True to leave the rule's source out of the generated sitemap.  On a create, left out means false, as in the admin.  On an update, left out keeps the rule's value.
+    attr_accessor :exclude_from_sitemap
+
     # Why the rule exists, up to 500 characters.
     attr_accessor :note
 
@@ -33,6 +36,7 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'exclude_from_sitemap' => :'exclude_from_sitemap',
         :'note' => :'note',
         :'over_live_page' => :'over_live_page',
         :'source' => :'source',
@@ -49,6 +53,7 @@ module UltracartClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'exclude_from_sitemap' => :'Boolean',
         :'note' => :'String',
         :'over_live_page' => :'Boolean',
         :'source' => :'String',
@@ -78,6 +83,10 @@ module UltracartClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'exclude_from_sitemap')
+        self.exclude_from_sitemap = attributes[:'exclude_from_sitemap']
+      end
+
       if attributes.key?(:'note')
         self.note = attributes[:'note']
       end
@@ -117,6 +126,7 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          exclude_from_sitemap == o.exclude_from_sitemap &&
           note == o.note &&
           over_live_page == o.over_live_page &&
           source == o.source &&
@@ -133,7 +143,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [note, over_live_page, source, status, target].hash
+      [exclude_from_sitemap, note, over_live_page, source, status, target].hash
     end
 
     # Builds the object from hash