ultracart_api 4.1.159 → 4.1.161

data/lib/ultracart_api/models/sfvb_page_settings_request.rb

@@ -0,0 +1,350 @@
+=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 SfvbPageSettingsRequest
+    # Template that renders the blog posts under this page.
+    attr_accessor :blog_post_template
+
+    # The page description.  Null or empty clears it.
+    attr_accessor :description
+
+    # Leave the page out of the sitemap and mark it noindex.
+    attr_accessor :exclude_from_sitemap
+
+    # Template that renders the page, a name from the template list.
+    attr_accessor :group_template
+
+    # Template that renders the item pages under this page.
+    attr_accessor :item_template
+
+    # Items per page on a template that paginates.  Null returns to the template's default.
+    attr_accessor :items_per_page
+
+    # S for a static page, D for a dynamic one.
+    attr_accessor :page_type
+
+    # Template that renders the item review pages under this page.
+    attr_accessor :review_template
+
+    # Position among its siblings when the parent sorts child pages by a custom order.  Null clears it.
+    attr_accessor :sort_order
+
+    # How the pages under this one are ordered.  TA or TD by title, DA or DD by description, C custom.
+    attr_accessor :sort_order_child_groups
+
+    # How the page's items are ordered.  IA or ID by item id, DA or DD by description, SA or SD by manufacturer SKU, PA or PD by price, RA or RD by review, NA or ND by inventory, C custom.
+    attr_accessor :sort_order_child_items
+
+    # The page title.
+    attr_accessor :title
+
+    # False hides the page, so it answers 404 to shoppers.  The root page cannot be hidden.
+    attr_accessor :visible
+
+    # Keep the page hidden until this time (ISO 8601).  Null or empty clears it.
+    attr_accessor :visible_dts
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'blog_post_template' => :'blog_post_template',
+        :'description' => :'description',
+        :'exclude_from_sitemap' => :'exclude_from_sitemap',
+        :'group_template' => :'group_template',
+        :'item_template' => :'item_template',
+        :'items_per_page' => :'items_per_page',
+        :'page_type' => :'page_type',
+        :'review_template' => :'review_template',
+        :'sort_order' => :'sort_order',
+        :'sort_order_child_groups' => :'sort_order_child_groups',
+        :'sort_order_child_items' => :'sort_order_child_items',
+        :'title' => :'title',
+        :'visible' => :'visible',
+        :'visible_dts' => :'visible_dts'
+      }
+    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
+      {
+        :'blog_post_template' => :'String',
+        :'description' => :'String',
+        :'exclude_from_sitemap' => :'Boolean',
+        :'group_template' => :'String',
+        :'item_template' => :'String',
+        :'items_per_page' => :'Integer',
+        :'page_type' => :'String',
+        :'review_template' => :'String',
+        :'sort_order' => :'Integer',
+        :'sort_order_child_groups' => :'String',
+        :'sort_order_child_items' => :'String',
+        :'title' => :'String',
+        :'visible' => :'Boolean',
+        :'visible_dts' => :'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::SfvbPageSettingsRequest` 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::SfvbPageSettingsRequest`. 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?(:'blog_post_template')
+        self.blog_post_template = attributes[:'blog_post_template']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'exclude_from_sitemap')
+        self.exclude_from_sitemap = attributes[:'exclude_from_sitemap']
+      end
+
+      if attributes.key?(:'group_template')
+        self.group_template = attributes[:'group_template']
+      end
+
+      if attributes.key?(:'item_template')
+        self.item_template = attributes[:'item_template']
+      end
+
+      if attributes.key?(:'items_per_page')
+        self.items_per_page = attributes[:'items_per_page']
+      end
+
+      if attributes.key?(:'page_type')
+        self.page_type = attributes[:'page_type']
+      end
+
+      if attributes.key?(:'review_template')
+        self.review_template = attributes[:'review_template']
+      end
+
+      if attributes.key?(:'sort_order')
+        self.sort_order = attributes[:'sort_order']
+      end
+
+      if attributes.key?(:'sort_order_child_groups')
+        self.sort_order_child_groups = attributes[:'sort_order_child_groups']
+      end
+
+      if attributes.key?(:'sort_order_child_items')
+        self.sort_order_child_items = attributes[:'sort_order_child_items']
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'visible')
+        self.visible = attributes[:'visible']
+      end
+
+      if attributes.key?(:'visible_dts')
+        self.visible_dts = attributes[:'visible_dts']
+      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 &&
+          blog_post_template == o.blog_post_template &&
+          description == o.description &&
+          exclude_from_sitemap == o.exclude_from_sitemap &&
+          group_template == o.group_template &&
+          item_template == o.item_template &&
+          items_per_page == o.items_per_page &&
+          page_type == o.page_type &&
+          review_template == o.review_template &&
+          sort_order == o.sort_order &&
+          sort_order_child_groups == o.sort_order_child_groups &&
+          sort_order_child_items == o.sort_order_child_items &&
+          title == o.title &&
+          visible == o.visible &&
+          visible_dts == o.visible_dts
+    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
+      [blog_post_template, description, exclude_from_sitemap, group_template, item_template, items_per_page, page_type, review_template, sort_order, sort_order_child_groups, sort_order_child_items, title, visible, visible_dts].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_page_summary.rb

@@ -0,0 +1,350 @@
+=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 SfvbPageSummary
+    # Number of pages directly under this one.
+    attr_accessor :child_count
+
+    # True when the page is left out of the sitemap and marked noindex.
+    attr_accessor :exclude_from_sitemap
+
+    # Template file that renders the page itself, a bare .vm name found anywhere in the active theme.
+    attr_accessor :group_template
+
+    # Number of items assigned to the page.  The catalog stops counting at its per-page item ceiling.
+    attr_accessor :item_count
+
+    # Template file that renders the item pages under this page.
+    attr_accessor :item_template
+
+    # S for a static page, D for a dynamic one.
+    attr_accessor :page_type
+
+    # Path of the page this one sits under.  Empty for the root page.
+    attr_accessor :parent_path
+
+    # The page path, beginning and ending with a slash.  The root page is /.
+    attr_accessor :path
+
+    # True for the storefront's home page.
+    attr_accessor :root
+
+    # Position among its siblings when the parent sorts child pages by a custom order.
+    attr_accessor :sort_order
+
+    # The page title.
+    attr_accessor :title
+
+    # True when the page's items or blog posts are chosen by selectors rather than assigned by hand.
+    attr_accessor :uses_selectors
+
+    # False when the page is hidden.  A hidden page answers 404 to shoppers.
+    attr_accessor :visible
+
+    # When set, the page stays hidden until this time (ISO 8601, UTC).
+    attr_accessor :visible_dts
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'child_count' => :'child_count',
+        :'exclude_from_sitemap' => :'exclude_from_sitemap',
+        :'group_template' => :'group_template',
+        :'item_count' => :'item_count',
+        :'item_template' => :'item_template',
+        :'page_type' => :'page_type',
+        :'parent_path' => :'parent_path',
+        :'path' => :'path',
+        :'root' => :'root',
+        :'sort_order' => :'sort_order',
+        :'title' => :'title',
+        :'uses_selectors' => :'uses_selectors',
+        :'visible' => :'visible',
+        :'visible_dts' => :'visible_dts'
+      }
+    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
+      {
+        :'child_count' => :'Integer',
+        :'exclude_from_sitemap' => :'Boolean',
+        :'group_template' => :'String',
+        :'item_count' => :'Integer',
+        :'item_template' => :'String',
+        :'page_type' => :'String',
+        :'parent_path' => :'String',
+        :'path' => :'String',
+        :'root' => :'Boolean',
+        :'sort_order' => :'Integer',
+        :'title' => :'String',
+        :'uses_selectors' => :'Boolean',
+        :'visible' => :'Boolean',
+        :'visible_dts' => :'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::SfvbPageSummary` 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::SfvbPageSummary`. 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?(:'child_count')
+        self.child_count = attributes[:'child_count']
+      end
+
+      if attributes.key?(:'exclude_from_sitemap')
+        self.exclude_from_sitemap = attributes[:'exclude_from_sitemap']
+      end
+
+      if attributes.key?(:'group_template')
+        self.group_template = attributes[:'group_template']
+      end
+
+      if attributes.key?(:'item_count')
+        self.item_count = attributes[:'item_count']
+      end
+
+      if attributes.key?(:'item_template')
+        self.item_template = attributes[:'item_template']
+      end
+
+      if attributes.key?(:'page_type')
+        self.page_type = attributes[:'page_type']
+      end
+
+      if attributes.key?(:'parent_path')
+        self.parent_path = attributes[:'parent_path']
+      end
+
+      if attributes.key?(:'path')
+        self.path = attributes[:'path']
+      end
+
+      if attributes.key?(:'root')
+        self.root = attributes[:'root']
+      end
+
+      if attributes.key?(:'sort_order')
+        self.sort_order = attributes[:'sort_order']
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'uses_selectors')
+        self.uses_selectors = attributes[:'uses_selectors']
+      end
+
+      if attributes.key?(:'visible')
+        self.visible = attributes[:'visible']
+      end
+
+      if attributes.key?(:'visible_dts')
+        self.visible_dts = attributes[:'visible_dts']
+      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 &&
+          child_count == o.child_count &&
+          exclude_from_sitemap == o.exclude_from_sitemap &&
+          group_template == o.group_template &&
+          item_count == o.item_count &&
+          item_template == o.item_template &&
+          page_type == o.page_type &&
+          parent_path == o.parent_path &&
+          path == o.path &&
+          root == o.root &&
+          sort_order == o.sort_order &&
+          title == o.title &&
+          uses_selectors == o.uses_selectors &&
+          visible == o.visible &&
+          visible_dts == o.visible_dts
+    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
+      [child_count, exclude_from_sitemap, group_template, item_count, item_template, page_type, parent_path, path, root, sort_order, title, uses_selectors, visible, visible_dts].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