ultracart_api 4.1.176 → 4.1.178

data/lib/ultracart_api/models/sfvb_blog_post_detail.rb

@@ -0,0 +1,364 @@
+=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 SfvbBlogPostDetail
+    # Whether shoppers may comment.
+    attr_accessor :allow_comments
+
+    # The post author.
+    attr_accessor :author
+
+    # The blog post's oid.  This is what a page's blog post assignment names.
+    attr_accessor :blog_post_oid
+
+    # The post body as HTML, exactly as stored.
+    attr_accessor :body
+
+    # When the post was created (ISO 8601, UTC).
+    attr_accessor :created_dts
+
+    # The post excerpt as HTML, exactly as stored.
+    attr_accessor :excerpt
+
+    # The post's images, the default image first.
+    attr_accessor :images
+
+    # When the post was last changed (ISO 8601, UTC), or null if it never was.
+    attr_accessor :last_modified_dts
+
+    # When the post is published (ISO 8601, UTC), or null for a draft.
+    attr_accessor :publication_dts
+
+    # The post's tags.
+    attr_accessor :tags
+
+    # The post title.
+    attr_accessor :title
+
+    # True when no page shows this post yet.
+    attr_accessor :unassigned
+
+    # The post's name in its URL.
+    attr_accessor :url_part
+
+    # The post's address on the storefront, or null until a page shows it.
+    attr_accessor :view_url
+
+    # P public, L logged in customers only, D draft.
+    attr_accessor :visibility
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'allow_comments' => :'allow_comments',
+        :'author' => :'author',
+        :'blog_post_oid' => :'blog_post_oid',
+        :'body' => :'body',
+        :'created_dts' => :'created_dts',
+        :'excerpt' => :'excerpt',
+        :'images' => :'images',
+        :'last_modified_dts' => :'last_modified_dts',
+        :'publication_dts' => :'publication_dts',
+        :'tags' => :'tags',
+        :'title' => :'title',
+        :'unassigned' => :'unassigned',
+        :'url_part' => :'url_part',
+        :'view_url' => :'view_url',
+        :'visibility' => :'visibility'
+      }
+    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
+      {
+        :'allow_comments' => :'Boolean',
+        :'author' => :'String',
+        :'blog_post_oid' => :'Integer',
+        :'body' => :'String',
+        :'created_dts' => :'String',
+        :'excerpt' => :'String',
+        :'images' => :'Array<SfvbBlogPostImage>',
+        :'last_modified_dts' => :'String',
+        :'publication_dts' => :'String',
+        :'tags' => :'Array<String>',
+        :'title' => :'String',
+        :'unassigned' => :'Boolean',
+        :'url_part' => :'String',
+        :'view_url' => :'String',
+        :'visibility' => :'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::SfvbBlogPostDetail` 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::SfvbBlogPostDetail`. 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?(:'allow_comments')
+        self.allow_comments = attributes[:'allow_comments']
+      end
+
+      if attributes.key?(:'author')
+        self.author = attributes[:'author']
+      end
+
+      if attributes.key?(:'blog_post_oid')
+        self.blog_post_oid = attributes[:'blog_post_oid']
+      end
+
+      if attributes.key?(:'body')
+        self.body = attributes[:'body']
+      end
+
+      if attributes.key?(:'created_dts')
+        self.created_dts = attributes[:'created_dts']
+      end
+
+      if attributes.key?(:'excerpt')
+        self.excerpt = attributes[:'excerpt']
+      end
+
+      if attributes.key?(:'images')
+        if (value = attributes[:'images']).is_a?(Array)
+          self.images = value
+        end
+      end
+
+      if attributes.key?(:'last_modified_dts')
+        self.last_modified_dts = attributes[:'last_modified_dts']
+      end
+
+      if attributes.key?(:'publication_dts')
+        self.publication_dts = attributes[:'publication_dts']
+      end
+
+      if attributes.key?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Array)
+          self.tags = value
+        end
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'unassigned')
+        self.unassigned = attributes[:'unassigned']
+      end
+
+      if attributes.key?(:'url_part')
+        self.url_part = attributes[:'url_part']
+      end
+
+      if attributes.key?(:'view_url')
+        self.view_url = attributes[:'view_url']
+      end
+
+      if attributes.key?(:'visibility')
+        self.visibility = attributes[:'visibility']
+      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 &&
+          allow_comments == o.allow_comments &&
+          author == o.author &&
+          blog_post_oid == o.blog_post_oid &&
+          body == o.body &&
+          created_dts == o.created_dts &&
+          excerpt == o.excerpt &&
+          images == o.images &&
+          last_modified_dts == o.last_modified_dts &&
+          publication_dts == o.publication_dts &&
+          tags == o.tags &&
+          title == o.title &&
+          unassigned == o.unassigned &&
+          url_part == o.url_part &&
+          view_url == o.view_url &&
+          visibility == o.visibility
+    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
+      [allow_comments, author, blog_post_oid, body, created_dts, excerpt, images, last_modified_dts, publication_dts, tags, title, unassigned, url_part, view_url, visibility].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_blog_post_image.rb

@@ -0,0 +1,290 @@
+=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 SfvbBlogPostImage
+    # The image's oid.  Detach names it this way.
+    attr_accessor :blog_post_multimedia_oid
+
+    # The image code, or null for the default image and for an image used only in the body.
+    attr_accessor :code
+
+    # True for the post's default image, which a blogpostimage element and og image use.
+    attr_accessor :default_image
+
+    # The description stored with the image, used as its alt text.
+    attr_accessor :description
+
+    # The image's file name.
+    attr_accessor :filename
+
+    # Height in pixels, when it could be measured.
+    attr_accessor :height
+
+    # The address to use in the post body, for example in an img src.  The storefront serves it from its image CDN once the image has been copied there.
+    attr_accessor :url
+
+    # Width in pixels, when it could be measured.
+    attr_accessor :width
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'blog_post_multimedia_oid' => :'blog_post_multimedia_oid',
+        :'code' => :'code',
+        :'default_image' => :'default_image',
+        :'description' => :'description',
+        :'filename' => :'filename',
+        :'height' => :'height',
+        :'url' => :'url',
+        :'width' => :'width'
+      }
+    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_multimedia_oid' => :'Integer',
+        :'code' => :'String',
+        :'default_image' => :'Boolean',
+        :'description' => :'String',
+        :'filename' => :'String',
+        :'height' => :'Integer',
+        :'url' => :'String',
+        :'width' => :'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::SfvbBlogPostImage` 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::SfvbBlogPostImage`. 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_multimedia_oid')
+        self.blog_post_multimedia_oid = attributes[:'blog_post_multimedia_oid']
+      end
+
+      if attributes.key?(:'code')
+        self.code = attributes[:'code']
+      end
+
+      if attributes.key?(:'default_image')
+        self.default_image = attributes[:'default_image']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'filename')
+        self.filename = attributes[:'filename']
+      end
+
+      if attributes.key?(:'height')
+        self.height = attributes[:'height']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.key?(:'width')
+        self.width = attributes[:'width']
+      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_multimedia_oid == o.blog_post_multimedia_oid &&
+          code == o.code &&
+          default_image == o.default_image &&
+          description == o.description &&
+          filename == o.filename &&
+          height == o.height &&
+          url == o.url &&
+          width == o.width
+    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_multimedia_oid, code, default_image, description, filename, height, url, width].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