ultracart_api 4.1.136 → 4.1.140

data/lib/ultracart_api/models/sfvb_error_detail.rb

@@ -0,0 +1,346 @@
+=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 SfvbErrorDetail
+    # Stable machine readable code.  Namespaced sfvb.*  Safe to match on; these are never reworded.
+    attr_accessor :code
+
+    # 1-indexed column number.  Populated for Velocity problems.
+    attr_accessor :column
+
+    # Close matches for an unrecognized value, best match first.  Populated for unknown element types and unknown configuration keys.
+    attr_accessor :did_you_mean
+
+    # Description of what was expected instead.
+    attr_accessor :expected
+
+    # The value that was actually found, when the problem is about a value.
+    attr_accessor :found
+
+    # 1-indexed line number.  Populated for Velocity problems; null for CJSON problems, which carry a pointer instead.
+    attr_accessor :line
+
+    # Human readable description of the problem.
+    attr_accessor :message
+
+    # JSON Pointer (RFC 6901) to the offending node within the submitted CJSON.  Null for whole-document problems.
+    attr_accessor :pointer
+
+    # error or warning.  Warnings never fail a request.
+    attr_accessor :severity
+
+    # Optional pointer at a known good example, typically a storefront library fragment that solves the same problem properly.
+    attr_accessor :suggestion
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'code' => :'code',
+        :'column' => :'column',
+        :'did_you_mean' => :'didYouMean',
+        :'expected' => :'expected',
+        :'found' => :'found',
+        :'line' => :'line',
+        :'message' => :'message',
+        :'pointer' => :'pointer',
+        :'severity' => :'severity',
+        :'suggestion' => :'suggestion'
+      }
+    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
+      {
+        :'code' => :'String',
+        :'column' => :'Integer',
+        :'did_you_mean' => :'Array<String>',
+        :'expected' => :'String',
+        :'found' => :'String',
+        :'line' => :'Integer',
+        :'message' => :'String',
+        :'pointer' => :'String',
+        :'severity' => :'String',
+        :'suggestion' => :'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::SfvbErrorDetail` 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::SfvbErrorDetail`. 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?(:'code')
+        self.code = attributes[:'code']
+      end
+
+      if attributes.key?(:'column')
+        self.column = attributes[:'column']
+      end
+
+      if attributes.key?(:'did_you_mean')
+        if (value = attributes[:'did_you_mean']).is_a?(Array)
+          self.did_you_mean = value
+        end
+      end
+
+      if attributes.key?(:'expected')
+        self.expected = attributes[:'expected']
+      end
+
+      if attributes.key?(:'found')
+        self.found = attributes[:'found']
+      end
+
+      if attributes.key?(:'line')
+        self.line = attributes[:'line']
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      end
+
+      if attributes.key?(:'pointer')
+        self.pointer = attributes[:'pointer']
+      end
+
+      if attributes.key?(:'severity')
+        self.severity = attributes[:'severity']
+      end
+
+      if attributes.key?(:'suggestion')
+        self.suggestion = attributes[:'suggestion']
+      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?
+      severity_validator = EnumAttributeValidator.new('String', ["error", "warning"])
+      return false unless severity_validator.valid?(@severity)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] severity Object to be assigned
+    def severity=(severity)
+      validator = EnumAttributeValidator.new('String', ["error", "warning"])
+      unless validator.valid?(severity)
+        fail ArgumentError, "invalid value for \"severity\", must be one of #{validator.allowable_values}."
+      end
+      @severity = severity
+    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 &&
+          code == o.code &&
+          column == o.column &&
+          did_you_mean == o.did_you_mean &&
+          expected == o.expected &&
+          found == o.found &&
+          line == o.line &&
+          message == o.message &&
+          pointer == o.pointer &&
+          severity == o.severity &&
+          suggestion == o.suggestion
+    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
+      [code, column, did_you_mean, expected, found, line, message, pointer, severity, suggestion].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_file_content_response.rb

@@ -0,0 +1,320 @@
+=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 SfvbFileContentResponse
+    # True when this file is compiler output and must not be edited directly.
+    attr_accessor :auto_compiled
+
+    # UTF-8 content.  Only text/* files can be read this way.
+    attr_accessor :content
+
+    # StoreFront file system file oid.
+    attr_accessor :fs_file_oid
+
+    # SHA-256 of the content.  Also returned as the ETag header; send it back as If-Match when writing.
+    attr_accessor :hash_sha256
+
+    # Mime type.
+    attr_accessor :mime_type
+
+    # Full path of the file.
+    attr_accessor :path
+
+    # Size in bytes.
+    attr_accessor :size
+
+    # True when the content was cut short.  Never truncated silently.
+    attr_accessor :truncated
+
+    # False when the file failed Velocity validation on its last write.
+    attr_accessor :valid
+
+    # Velocity errors recorded on the last write.  Null when valid.
+    attr_accessor :velocity_errors
+
+    # Version number of the content returned.
+    attr_accessor :version
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'auto_compiled' => :'autoCompiled',
+        :'content' => :'content',
+        :'fs_file_oid' => :'fsFileOid',
+        :'hash_sha256' => :'hashSha256',
+        :'mime_type' => :'mimeType',
+        :'path' => :'path',
+        :'size' => :'size',
+        :'truncated' => :'truncated',
+        :'valid' => :'valid',
+        :'velocity_errors' => :'velocityErrors',
+        :'version' => :'version'
+      }
+    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
+      {
+        :'auto_compiled' => :'Boolean',
+        :'content' => :'String',
+        :'fs_file_oid' => :'Integer',
+        :'hash_sha256' => :'String',
+        :'mime_type' => :'String',
+        :'path' => :'String',
+        :'size' => :'Integer',
+        :'truncated' => :'Boolean',
+        :'valid' => :'Boolean',
+        :'velocity_errors' => :'String',
+        :'version' => :'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::SfvbFileContentResponse` 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::SfvbFileContentResponse`. 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?(:'auto_compiled')
+        self.auto_compiled = attributes[:'auto_compiled']
+      end
+
+      if attributes.key?(:'content')
+        self.content = attributes[:'content']
+      end
+
+      if attributes.key?(:'fs_file_oid')
+        self.fs_file_oid = attributes[:'fs_file_oid']
+      end
+
+      if attributes.key?(:'hash_sha256')
+        self.hash_sha256 = attributes[:'hash_sha256']
+      end
+
+      if attributes.key?(:'mime_type')
+        self.mime_type = attributes[:'mime_type']
+      end
+
+      if attributes.key?(:'path')
+        self.path = attributes[:'path']
+      end
+
+      if attributes.key?(:'size')
+        self.size = attributes[:'size']
+      end
+
+      if attributes.key?(:'truncated')
+        self.truncated = attributes[:'truncated']
+      end
+
+      if attributes.key?(:'valid')
+        self.valid = attributes[:'valid']
+      end
+
+      if attributes.key?(:'velocity_errors')
+        self.velocity_errors = attributes[:'velocity_errors']
+      end
+
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
+      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 &&
+          auto_compiled == o.auto_compiled &&
+          content == o.content &&
+          fs_file_oid == o.fs_file_oid &&
+          hash_sha256 == o.hash_sha256 &&
+          mime_type == o.mime_type &&
+          path == o.path &&
+          size == o.size &&
+          truncated == o.truncated &&
+          valid == o.valid &&
+          velocity_errors == o.velocity_errors &&
+          version == o.version
+    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
+      [auto_compiled, content, fs_file_oid, hash_sha256, mime_type, path, size, truncated, valid, velocity_errors, version].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