ultracart_api 4.1.228 → 4.1.230

data/lib/ultracart_api/models/sfvb_comms_list_write_request.rb

@@ -0,0 +1,250 @@
+=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 SfvbCommsListWriteRequest
+    # A list and segment folder on this storefront, or an empty string for none.
+    attr_accessor :folder_uuid
+
+    # The list name, 1 to 250 characters.  Required to create.
+    attr_accessor :name
+
+    # Plain text subscribers see for a public list, up to 100 characters, or an empty string for none.
+    attr_accessor :public_description
+
+    # True to let subscribers choose this list on the storefront's email preferences page.  Defaults to false.
+    attr_accessor :public_list
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'folder_uuid' => :'folder_uuid',
+        :'name' => :'name',
+        :'public_description' => :'public_description',
+        :'public_list' => :'public_list'
+      }
+    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
+      {
+        :'folder_uuid' => :'String',
+        :'name' => :'String',
+        :'public_description' => :'String',
+        :'public_list' => :'Boolean'
+      }
+    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::SfvbCommsListWriteRequest` 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::SfvbCommsListWriteRequest`. 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?(:'folder_uuid')
+        self.folder_uuid = attributes[:'folder_uuid']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'public_description')
+        self.public_description = attributes[:'public_description']
+      end
+
+      if attributes.key?(:'public_list')
+        self.public_list = attributes[:'public_list']
+      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 &&
+          folder_uuid == o.folder_uuid &&
+          name == o.name &&
+          public_description == o.public_description &&
+          public_list == o.public_list
+    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
+      [folder_uuid, name, public_description, public_list].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_flow_write_request.rb

@@ -42,10 +42,10 @@ module UltracartClient
     # The part of the from address before the at sign.  Defaults to the storefront's marketing setting.
     attr_accessor :sending_user
 
-    # The list or segment uuid for a list or segment trigger.  Create only.
+    # The list or segment uuid for a list or segment trigger.  Cleared when the trigger changes to one that takes none.
     attr_accessor :trigger_parameter
 
-    # What enrolls a customer, such as cart abandoned.  Create only.
+    # What enrolls a customer, such as cart abandoned.  Required to create.  On a change, only while the flow is off.
     attr_accessor :trigger_type
 
     class EnumAttributeValidator

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