ultracart_api 4.1.183 → 4.1.185

data/lib/ultracart_api/models/sfvb_library_delete_result.rb

@@ -0,0 +1,264 @@
+=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 SfvbLibraryDeleteResult
+    # The entry.
+    attr_accessor :library_oid
+
+    # deleted when the entry was private and never published or installed, so it is gone.  retired when it had been published or installed, so it was kept for the storefronts that use it and taken out of search.
+    attr_accessor :result
+
+    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
+      {
+        :'library_oid' => :'library_oid',
+        :'result' => :'result'
+      }
+    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
+      {
+        :'library_oid' => :'Integer',
+        :'result' => :'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::SfvbLibraryDeleteResult` 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::SfvbLibraryDeleteResult`. 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?(:'library_oid')
+        self.library_oid = attributes[:'library_oid']
+      end
+
+      if attributes.key?(:'result')
+        self.result = attributes[:'result']
+      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?
+      result_validator = EnumAttributeValidator.new('String', ["deleted", "retired"])
+      return false unless result_validator.valid?(@result)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] result Object to be assigned
+    def result=(result)
+      validator = EnumAttributeValidator.new('String', ["deleted", "retired"])
+      unless validator.valid?(result)
+        fail ArgumentError, "invalid value for \"result\", must be one of #{validator.allowable_values}."
+      end
+      @result = result
+    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 &&
+          library_oid == o.library_oid &&
+          result == o.result
+    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
+      [library_oid, result].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_library_entry.rb

@@ -21,9 +21,17 @@ module UltracartClient
     # The fragment's CJSON.  Omitted from search results to keep them terse; fetch a single entry to get it.
     attr_accessor :cjson
 
+    attr_accessor :content_manifest
+
     # What this fragment is for.
     attr_accessor :description
 
+    # Hash of the draft's writable fields.  Send it back as If-Match to update, delete or publish.  Present only for the owner.
+    attr_accessor :hash_sha256
+
+    # When the draft was last saved, ISO 8601.
+    attr_accessor :last_modified_dts
+
     # Library entry oid.
     attr_accessor :library_oid
 
@@ -33,34 +41,102 @@ module UltracartClient
     # True when the calling user owns this entry.
     attr_accessor :owned
 
+    # Named values the fragment expects the installer to supply.
+    attr_accessor :parameters
+
+    # The latest published revision, or null when the entry has never been published.
+    attr_accessor :published_revision_number
+
     # Storefront file paths this fragment references.  Installing the fragment copies them into the storefront; reading it does not.
     attr_accessor :referenced_files
 
+    # True when the owner deleted an entry that had been published or installed.  It is kept so existing installs still resolve, and it leaves search.
+    attr_accessor :retired
+
+    # The revision returned.  For the owner this is the draft, which every save increments.  For anyone else it is the published revision.
+    attr_accessor :revision_number
+
+    # Screenshot height in pixels.
+    attr_accessor :screenshot_height
+
     # S3 listing key for the large screenshot, when one has been generated.
     attr_accessor :screenshot_key
 
+    # Hash of the uploaded screenshot.
+    attr_accessor :screenshot_sha256
+
+    # True on an update that changed the fragment of an entry with a screenshot.  Retake it and set it again with the library screenshot endpoint.
+    attr_accessor :screenshot_stale
+
+    # Screenshot width in pixels.
+    attr_accessor :screenshot_width
+
     # True when the entry is shared across the merchant account.
     attr_accessor :share_with_account
 
+    # Linked accounts the entry is shared with.  Present only for the owner.
+    attr_accessor :shared_with
+
+    attr_accessor :taxonomy
+
     # S3 listing key for the medium thumbnail, when one has been generated.  Thumbnails are produced asynchronously and can lag a save by a minute or two.
     attr_accessor :thumbnail_key
 
+    # private, shared or public.
+    attr_accessor :visibility
+
     # Element type at the root of the fragment.
     attr_accessor :widget_type
 
+    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
       {
         :'bookmarked' => :'bookmarked',
         :'cjson' => :'cjson',
+        :'content_manifest' => :'content_manifest',
         :'description' => :'description',
+        :'hash_sha256' => :'hash_sha256',
+        :'last_modified_dts' => :'last_modified_dts',
         :'library_oid' => :'library_oid',
         :'name' => :'name',
         :'owned' => :'owned',
+        :'parameters' => :'parameters',
+        :'published_revision_number' => :'published_revision_number',
         :'referenced_files' => :'referenced_files',
+        :'retired' => :'retired',
+        :'revision_number' => :'revision_number',
+        :'screenshot_height' => :'screenshot_height',
         :'screenshot_key' => :'screenshot_key',
+        :'screenshot_sha256' => :'screenshot_sha256',
+        :'screenshot_stale' => :'screenshot_stale',
+        :'screenshot_width' => :'screenshot_width',
         :'share_with_account' => :'share_with_account',
+        :'shared_with' => :'shared_with',
+        :'taxonomy' => :'taxonomy',
         :'thumbnail_key' => :'thumbnail_key',
+        :'visibility' => :'visibility',
         :'widget_type' => :'widget_type'
       }
     end
@@ -75,14 +151,28 @@ module UltracartClient
       {
         :'bookmarked' => :'Boolean',
         :'cjson' => :'String',
+        :'content_manifest' => :'SfvbLibraryContentManifest',
         :'description' => :'String',
+        :'hash_sha256' => :'String',
+        :'last_modified_dts' => :'String',
         :'library_oid' => :'Integer',
         :'name' => :'String',
         :'owned' => :'Boolean',
+        :'parameters' => :'Array<SfvbLibraryParameter>',
+        :'published_revision_number' => :'Integer',
         :'referenced_files' => :'Array<String>',
+        :'retired' => :'Boolean',
+        :'revision_number' => :'Integer',
+        :'screenshot_height' => :'Integer',
         :'screenshot_key' => :'String',
+        :'screenshot_sha256' => :'String',
+        :'screenshot_stale' => :'Boolean',
+        :'screenshot_width' => :'Integer',
         :'share_with_account' => :'Boolean',
+        :'shared_with' => :'Array<SfvbLibraryShareTarget>',
+        :'taxonomy' => :'SfvbLibraryTaxonomy',
         :'thumbnail_key' => :'String',
+        :'visibility' => :'String',
         :'widget_type' => :'String'
       }
     end
@@ -116,10 +206,22 @@ module UltracartClient
         self.cjson = attributes[:'cjson']
       end
 
+      if attributes.key?(:'content_manifest')
+        self.content_manifest = attributes[:'content_manifest']
+      end
+
       if attributes.key?(:'description')
         self.description = attributes[:'description']
       end
 
+      if attributes.key?(:'hash_sha256')
+        self.hash_sha256 = attributes[:'hash_sha256']
+      end
+
+      if attributes.key?(:'last_modified_dts')
+        self.last_modified_dts = attributes[:'last_modified_dts']
+      end
+
       if attributes.key?(:'library_oid')
         self.library_oid = attributes[:'library_oid']
       end
@@ -132,24 +234,72 @@ module UltracartClient
         self.owned = attributes[:'owned']
       end
 
+      if attributes.key?(:'parameters')
+        if (value = attributes[:'parameters']).is_a?(Array)
+          self.parameters = value
+        end
+      end
+
+      if attributes.key?(:'published_revision_number')
+        self.published_revision_number = attributes[:'published_revision_number']
+      end
+
       if attributes.key?(:'referenced_files')
         if (value = attributes[:'referenced_files']).is_a?(Array)
           self.referenced_files = value
         end
       end
 
+      if attributes.key?(:'retired')
+        self.retired = attributes[:'retired']
+      end
+
+      if attributes.key?(:'revision_number')
+        self.revision_number = attributes[:'revision_number']
+      end
+
+      if attributes.key?(:'screenshot_height')
+        self.screenshot_height = attributes[:'screenshot_height']
+      end
+
       if attributes.key?(:'screenshot_key')
         self.screenshot_key = attributes[:'screenshot_key']
       end
 
+      if attributes.key?(:'screenshot_sha256')
+        self.screenshot_sha256 = attributes[:'screenshot_sha256']
+      end
+
+      if attributes.key?(:'screenshot_stale')
+        self.screenshot_stale = attributes[:'screenshot_stale']
+      end
+
+      if attributes.key?(:'screenshot_width')
+        self.screenshot_width = attributes[:'screenshot_width']
+      end
+
       if attributes.key?(:'share_with_account')
         self.share_with_account = attributes[:'share_with_account']
       end
 
+      if attributes.key?(:'shared_with')
+        if (value = attributes[:'shared_with']).is_a?(Array)
+          self.shared_with = value
+        end
+      end
+
+      if attributes.key?(:'taxonomy')
+        self.taxonomy = attributes[:'taxonomy']
+      end
+
       if attributes.key?(:'thumbnail_key')
         self.thumbnail_key = attributes[:'thumbnail_key']
       end
 
+      if attributes.key?(:'visibility')
+        self.visibility = attributes[:'visibility']
+      end
+
       if attributes.key?(:'widget_type')
         self.widget_type = attributes[:'widget_type']
       end
@@ -165,9 +315,21 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      visibility_validator = EnumAttributeValidator.new('String', ["private", "shared", "public"])
+      return false unless visibility_validator.valid?(@visibility)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] visibility Object to be assigned
+    def visibility=(visibility)
+      validator = EnumAttributeValidator.new('String', ["private", "shared", "public"])
+      unless validator.valid?(visibility)
+        fail ArgumentError, "invalid value for \"visibility\", must be one of #{validator.allowable_values}."
+      end
+      @visibility = visibility
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -175,14 +337,28 @@ module UltracartClient
       self.class == o.class &&
           bookmarked == o.bookmarked &&
           cjson == o.cjson &&
+          content_manifest == o.content_manifest &&
           description == o.description &&
+          hash_sha256 == o.hash_sha256 &&
+          last_modified_dts == o.last_modified_dts &&
           library_oid == o.library_oid &&
           name == o.name &&
           owned == o.owned &&
+          parameters == o.parameters &&
+          published_revision_number == o.published_revision_number &&
           referenced_files == o.referenced_files &&
+          retired == o.retired &&
+          revision_number == o.revision_number &&
+          screenshot_height == o.screenshot_height &&
           screenshot_key == o.screenshot_key &&
+          screenshot_sha256 == o.screenshot_sha256 &&
+          screenshot_stale == o.screenshot_stale &&
+          screenshot_width == o.screenshot_width &&
           share_with_account == o.share_with_account &&
+          shared_with == o.shared_with &&
+          taxonomy == o.taxonomy &&
           thumbnail_key == o.thumbnail_key &&
+          visibility == o.visibility &&
           widget_type == o.widget_type
     end
 
@@ -195,7 +371,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [bookmarked, cjson, description, library_oid, name, owned, referenced_files, screenshot_key, share_with_account, thumbnail_key, widget_type].hash
+      [bookmarked, cjson, content_manifest, description, hash_sha256, last_modified_dts, library_oid, name, owned, parameters, published_revision_number, referenced_files, retired, revision_number, screenshot_height, screenshot_key, screenshot_sha256, screenshot_stale, screenshot_width, share_with_account, shared_with, taxonomy, thumbnail_key, visibility, widget_type].hash
     end
 
     # Builds the object from hash