ultracart_api 4.1.136 → 4.1.140

data/lib/ultracart_api/models/sfvb_file_search_request.rb

@@ -0,0 +1,370 @@
+=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 SfvbFileSearchRequest
+    # Whether the text search is case sensitive.  Defaults to false.
+    attr_accessor :case_sensitive
+
+    # Only dynamic HTML (arbitrary) files.
+    attr_accessor :dynamic_html
+
+    # Comma separated file name patterns, matched case insensitively with wildcards.
+    attr_accessor :file_name
+
+    # Only files with internationalization violations.
+    attr_accessor :i18n_violations
+
+    # Only files that failed Velocity validation.
+    attr_accessor :invalid
+
+    # Maximum results to return.  Clamped to the server maximum.
+    attr_accessor :max_results
+
+    # Only files with unresolved theme merge conflicts.
+    attr_accessor :merge_conflicts
+
+    # Restrict to a mime type.
+    attr_accessor :mime_type
+
+    # Only files modified at or before this ISO-8601 timestamp.
+    attr_accessor :modified_max
+
+    # Only files modified at or after this ISO-8601 timestamp.
+    attr_accessor :modified_min
+
+    # Results to skip.  Send the next_offset from a truncated response to continue.  Ordering is by path with the file oid as a tie breaker, so pages do not overlap or skip entries between calls.
+    attr_accessor :offset
+
+    # Restrict to a directory path.  Strongly recommended alongside text.
+    attr_accessor :path
+
+    # Maximum size in bytes.
+    attr_accessor :size_max
+
+    # Minimum size in bytes.
+    attr_accessor :size_min
+
+    # Recurse below path.  Defaults to true.
+    attr_accessor :sub_directories
+
+    # Text to find inside files.  Only text/* files are searched.  This is the expensive filter; narrow with path or file_name where possible.
+    attr_accessor :text
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'case_sensitive' => :'caseSensitive',
+        :'dynamic_html' => :'dynamicHtml',
+        :'file_name' => :'fileName',
+        :'i18n_violations' => :'i18nViolations',
+        :'invalid' => :'invalid',
+        :'max_results' => :'maxResults',
+        :'merge_conflicts' => :'mergeConflicts',
+        :'mime_type' => :'mimeType',
+        :'modified_max' => :'modifiedMax',
+        :'modified_min' => :'modifiedMin',
+        :'offset' => :'offset',
+        :'path' => :'path',
+        :'size_max' => :'sizeMax',
+        :'size_min' => :'sizeMin',
+        :'sub_directories' => :'subDirectories',
+        :'text' => :'text'
+      }
+    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
+      {
+        :'case_sensitive' => :'Boolean',
+        :'dynamic_html' => :'Boolean',
+        :'file_name' => :'String',
+        :'i18n_violations' => :'Boolean',
+        :'invalid' => :'Boolean',
+        :'max_results' => :'Integer',
+        :'merge_conflicts' => :'Boolean',
+        :'mime_type' => :'String',
+        :'modified_max' => :'String',
+        :'modified_min' => :'String',
+        :'offset' => :'Integer',
+        :'path' => :'String',
+        :'size_max' => :'Integer',
+        :'size_min' => :'Integer',
+        :'sub_directories' => :'Boolean',
+        :'text' => :'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::SfvbFileSearchRequest` 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::SfvbFileSearchRequest`. 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?(:'case_sensitive')
+        self.case_sensitive = attributes[:'case_sensitive']
+      end
+
+      if attributes.key?(:'dynamic_html')
+        self.dynamic_html = attributes[:'dynamic_html']
+      end
+
+      if attributes.key?(:'file_name')
+        self.file_name = attributes[:'file_name']
+      end
+
+      if attributes.key?(:'i18n_violations')
+        self.i18n_violations = attributes[:'i18n_violations']
+      end
+
+      if attributes.key?(:'invalid')
+        self.invalid = attributes[:'invalid']
+      end
+
+      if attributes.key?(:'max_results')
+        self.max_results = attributes[:'max_results']
+      end
+
+      if attributes.key?(:'merge_conflicts')
+        self.merge_conflicts = attributes[:'merge_conflicts']
+      end
+
+      if attributes.key?(:'mime_type')
+        self.mime_type = attributes[:'mime_type']
+      end
+
+      if attributes.key?(:'modified_max')
+        self.modified_max = attributes[:'modified_max']
+      end
+
+      if attributes.key?(:'modified_min')
+        self.modified_min = attributes[:'modified_min']
+      end
+
+      if attributes.key?(:'offset')
+        self.offset = attributes[:'offset']
+      end
+
+      if attributes.key?(:'path')
+        self.path = attributes[:'path']
+      end
+
+      if attributes.key?(:'size_max')
+        self.size_max = attributes[:'size_max']
+      end
+
+      if attributes.key?(:'size_min')
+        self.size_min = attributes[:'size_min']
+      end
+
+      if attributes.key?(:'sub_directories')
+        self.sub_directories = attributes[:'sub_directories']
+      end
+
+      if attributes.key?(:'text')
+        self.text = attributes[:'text']
+      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 &&
+          case_sensitive == o.case_sensitive &&
+          dynamic_html == o.dynamic_html &&
+          file_name == o.file_name &&
+          i18n_violations == o.i18n_violations &&
+          invalid == o.invalid &&
+          max_results == o.max_results &&
+          merge_conflicts == o.merge_conflicts &&
+          mime_type == o.mime_type &&
+          modified_max == o.modified_max &&
+          modified_min == o.modified_min &&
+          offset == o.offset &&
+          path == o.path &&
+          size_max == o.size_max &&
+          size_min == o.size_min &&
+          sub_directories == o.sub_directories &&
+          text == o.text
+    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
+      [case_sensitive, dynamic_html, file_name, i18n_violations, invalid, max_results, merge_conflicts, mime_type, modified_max, modified_min, offset, path, size_max, size_min, sub_directories, text].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_search_response.rb

@@ -0,0 +1,292 @@
+=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 SfvbFileSearchResponse
+    # Matching files.
+    attr_accessor :files
+
+    # The cap that was applied.
+    attr_accessor :max_results
+
+    # Offset to send for the next page.  Zero when truncated is false.  Never truncates without giving a way to continue.
+    attr_accessor :next_offset
+
+    # Results skipped to produce this page.
+    attr_accessor :offset
+
+    # Number of results returned.
+    attr_accessor :result_count
+
+    # Total matches found.  Available because the underlying query is unbounded and returns everything anyway; it is not evidence that fetching them all is cheap.
+    attr_accessor :total_count
+
+    # True when matches exist beyond this page.  next_offset is populated when it is.
+    attr_accessor :truncated
+
+    # Advice for the caller when truncated is true.
+    attr_accessor :truncation_advice
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'files' => :'files',
+        :'max_results' => :'maxResults',
+        :'next_offset' => :'nextOffset',
+        :'offset' => :'offset',
+        :'result_count' => :'resultCount',
+        :'total_count' => :'totalCount',
+        :'truncated' => :'truncated',
+        :'truncation_advice' => :'truncationAdvice'
+      }
+    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
+      {
+        :'files' => :'Array<SfvbFileEntry>',
+        :'max_results' => :'Integer',
+        :'next_offset' => :'Integer',
+        :'offset' => :'Integer',
+        :'result_count' => :'Integer',
+        :'total_count' => :'Integer',
+        :'truncated' => :'Boolean',
+        :'truncation_advice' => :'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::SfvbFileSearchResponse` 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::SfvbFileSearchResponse`. 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?(:'files')
+        if (value = attributes[:'files']).is_a?(Array)
+          self.files = value
+        end
+      end
+
+      if attributes.key?(:'max_results')
+        self.max_results = attributes[:'max_results']
+      end
+
+      if attributes.key?(:'next_offset')
+        self.next_offset = attributes[:'next_offset']
+      end
+
+      if attributes.key?(:'offset')
+        self.offset = attributes[:'offset']
+      end
+
+      if attributes.key?(:'result_count')
+        self.result_count = attributes[:'result_count']
+      end
+
+      if attributes.key?(:'total_count')
+        self.total_count = attributes[:'total_count']
+      end
+
+      if attributes.key?(:'truncated')
+        self.truncated = attributes[:'truncated']
+      end
+
+      if attributes.key?(:'truncation_advice')
+        self.truncation_advice = attributes[:'truncation_advice']
+      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 &&
+          files == o.files &&
+          max_results == o.max_results &&
+          next_offset == o.next_offset &&
+          offset == o.offset &&
+          result_count == o.result_count &&
+          total_count == o.total_count &&
+          truncated == o.truncated &&
+          truncation_advice == o.truncation_advice
+    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
+      [files, max_results, next_offset, offset, result_count, total_count, truncated, truncation_advice].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