groupdocs_signature_cloud 19.5 → 20.7

data/lib/groupdocs_signature_cloud/models/update_settings.rb

@@ -0,0 +1,231 @@
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose Pty Ltd" file="update_settings.rb">
+ #   Copyright (c) 2003-2020 Aspose Pty Ltd
+ # </copyright>
+ # <summary>
+ #  Permission is hereby granted, free of charge, to any person obtaining a copy
+ #  of this software and associated documentation files (the "Software"), to deal
+ #  in the Software without restriction, including without limitation the rights
+ #  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ #  copies of the Software, and to permit persons to whom the Software is
+ #  furnished to do so, subject to the following conditions:
+ #
+ #  The above copyright notice and this permission notice shall be included in all
+ #  copies or substantial portions of the Software.
+ #
+ #  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ #  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ #  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ #  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ #  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ #  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ #  SOFTWARE.
+ # </summary>
+ # --------------------------------------------------------------------------------------------------------------------
+ #
+
+require 'date'
+
+module GroupDocsSignatureCloud
+  # Defines update sign document settings
+  class UpdateSettings
+
+    # File info
+    attr_accessor :file_info
+
+    # Gets or sets options to perform signatures update
+    attr_accessor :options
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'file_info' => :'FileInfo',
+        :'options' => :'Options'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'file_info' => :'FileInfo',
+        :'options' => :'Array<UpdateOptions>'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.key?(:'FileInfo')
+        self.file_info = attributes[:'FileInfo']
+      end
+
+      if attributes.key?(:'Options')
+        if (value = attributes[:'Options']).is_a?(Array)
+          self.options = value
+        end
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = []
+      return 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?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(other)
+      return true if self.equal?(other)
+      self.class == other.class &&
+          file_info == other.file_info &&
+          options == other.options
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(other)
+      self == other
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [file_info, options].hash
+    end
+
+    # Downcases first letter.
+    # @return downcased string
+    def uncap(str)
+      str[0, 1].downcase + str[1..-1]
+    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)
+      self.class.swagger_types.each_pair do |key, type|
+        pname = uncap(self.class.attribute_map[key]).intern
+        value = attributes[pname]
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not                    
+          if value.is_a?(Array)
+            self.send("#{key}=", value.map { |v| _deserialize($1, v) })
+          end
+        elsif !value.nil?                  
+          self.send("#{key}=", _deserialize(type, value))
+        end
+        # or else data not found in attributes(hash), not an issue as the data can be optional
+      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 :DateTime
+        Date.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
+        # Signature type fix
+        ttype = type
+        if value.is_a?(Hash) and !value[:signatureType].nil?
+          ttype = value[:signatureType] + 'Signature'
+        end      
+        temp_model = GroupDocsSignatureCloud.const_get(ttype).new
+        temp_model.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)
+        next if value.nil?
+        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/groupdocs_signature_cloud/models/verify_barcode_options.rb

@@ -1,7 +1,7 @@
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="verify_barcode_options.rb">
- #   Copyright (c) 2003-2019 Aspose Pty Ltd
+ #   Copyright (c) 2003-2020 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -31,9 +31,6 @@ module GroupDocsSignatureCloud
   # Defines options to verify Barcode signature within a document
   class VerifyBarcodeOptions
 
-    # Specifies the type of document to process
-    attr_accessor :document_type
-
     # Specifies the signature type of processing
     attr_accessor :signature_type
 
@@ -79,7 +76,6 @@ module GroupDocsSignatureCloud
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'document_type' => :'DocumentType',
         :'signature_type' => :'SignatureType',
         :'page' => :'Page',
         :'all_pages' => :'AllPages',
@@ -93,7 +89,6 @@ module GroupDocsSignatureCloud
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'document_type' => :'String',
         :'signature_type' => :'String',
         :'page' => :'Integer',
         :'all_pages' => :'BOOLEAN',
@@ -112,10 +107,6 @@ module GroupDocsSignatureCloud
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.key?(:'DocumentType')
-        self.document_type = attributes[:'DocumentType']
-      end
-
       if attributes.key?(:'SignatureType')
         self.signature_type = attributes[:'SignatureType']
       end
@@ -150,10 +141,6 @@ module GroupDocsSignatureCloud
     # @return Array for valid properies with the reasons
     def list_invalid_properties
       invalid_properties = []
-      if @document_type.nil?
-        invalid_properties.push("invalid value for 'document_type', document_type cannot be nil.")
-      end
-
       if @signature_type.nil?
         invalid_properties.push("invalid value for 'signature_type', signature_type cannot be nil.")
       end
@@ -172,9 +159,6 @@ module GroupDocsSignatureCloud
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return false if @document_type.nil?
-      document_type_validator = EnumAttributeValidator.new('String', ["Image", "Pdf", "Presentation", "Spreadsheet", "WordProcessing"])
-      return false unless document_type_validator.valid?(@document_type)
       return false if @signature_type.nil?
       signature_type_validator = EnumAttributeValidator.new('String', ["None", "Text", "Image", "Digital", "Barcode", "QRCode", "Stamp"])
       return false unless signature_type_validator.valid?(@signature_type)
@@ -185,20 +169,6 @@ module GroupDocsSignatureCloud
       return true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] document_type Object to be assigned
-    def document_type=(document_type)
-      validator = EnumAttributeValidator.new('String', ["Image", "Pdf", "Presentation", "Spreadsheet", "WordProcessing"])
-      if document_type.to_i == 0
-        unless validator.valid?(document_type)
-          raise ArgumentError, "invalid value for 'document_type', must be one of #{validator.allowable_values}."
-        end
-        @document_type = document_type
-      else
-        @document_type = validator.allowable_values[document_type.to_i]
-      end
-    end
-
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] signature_type Object to be assigned
     def signature_type=(signature_type)
@@ -232,7 +202,6 @@ module GroupDocsSignatureCloud
     def ==(other)
       return true if self.equal?(other)
       self.class == other.class &&
-          document_type == other.document_type &&
           signature_type == other.signature_type &&
           page == other.page &&
           all_pages == other.all_pages &&
@@ -251,7 +220,7 @@ module GroupDocsSignatureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [document_type, signature_type, page, all_pages, pages_setup, text, match_type, barcode_type].hash
+      [signature_type, page, all_pages, pages_setup, text, match_type, barcode_type].hash
     end
 
     # Downcases first letter.

data/lib/groupdocs_signature_cloud/models/verify_digital_options.rb

@@ -1,7 +1,7 @@
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="verify_digital_options.rb">
- #   Copyright (c) 2003-2019 Aspose Pty Ltd
+ #   Copyright (c) 2003-2020 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -31,9 +31,6 @@ module GroupDocsSignatureCloud
   # Defines options to verify Digital signature within a document
   class VerifyDigitalOptions
 
-    # Specifies the type of document to process
-    attr_accessor :document_type
-
     # Specifies the signature type of processing
     attr_accessor :signature_type
 
@@ -50,7 +47,7 @@ module GroupDocsSignatureCloud
     attr_accessor :password
 
     # File Guid of Digital Certificate
-    attr_accessor :certificate_guid
+    attr_accessor :certificate_file_path
 
     # Comments of Digital Signature to validate Suitable for Spreadsheet and Words Processing document types
     attr_accessor :comments
@@ -94,13 +91,12 @@ module GroupDocsSignatureCloud
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'document_type' => :'DocumentType',
         :'signature_type' => :'SignatureType',
         :'page' => :'Page',
         :'all_pages' => :'AllPages',
         :'pages_setup' => :'PagesSetup',
         :'password' => :'Password',
-        :'certificate_guid' => :'CertificateGuid',
+        :'certificate_file_path' => :'CertificateFilePath',
         :'comments' => :'Comments',
         :'sign_date_time_from' => :'SignDateTimeFrom',
         :'sign_date_time_to' => :'SignDateTimeTo',
@@ -113,13 +109,12 @@ module GroupDocsSignatureCloud
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'document_type' => :'String',
         :'signature_type' => :'String',
         :'page' => :'Integer',
         :'all_pages' => :'BOOLEAN',
         :'pages_setup' => :'PagesSetup',
         :'password' => :'String',
-        :'certificate_guid' => :'String',
+        :'certificate_file_path' => :'String',
         :'comments' => :'String',
         :'sign_date_time_from' => :'DateTime',
         :'sign_date_time_to' => :'DateTime',
@@ -137,10 +132,6 @@ module GroupDocsSignatureCloud
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.key?(:'DocumentType')
-        self.document_type = attributes[:'DocumentType']
-      end
-
       if attributes.key?(:'SignatureType')
         self.signature_type = attributes[:'SignatureType']
       end
@@ -161,8 +152,8 @@ module GroupDocsSignatureCloud
         self.password = attributes[:'Password']
       end
 
-      if attributes.key?(:'CertificateGuid')
-        self.certificate_guid = attributes[:'CertificateGuid']
+      if attributes.key?(:'CertificateFilePath')
+        self.certificate_file_path = attributes[:'CertificateFilePath']
       end
 
       if attributes.key?(:'Comments')
@@ -195,10 +186,6 @@ module GroupDocsSignatureCloud
     # @return Array for valid properies with the reasons
     def list_invalid_properties
       invalid_properties = []
-      if @document_type.nil?
-        invalid_properties.push("invalid value for 'document_type', document_type cannot be nil.")
-      end
-
       if @signature_type.nil?
         invalid_properties.push("invalid value for 'signature_type', signature_type cannot be nil.")
       end
@@ -213,9 +200,6 @@ module GroupDocsSignatureCloud
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return false if @document_type.nil?
-      document_type_validator = EnumAttributeValidator.new('String', ["Image", "Pdf", "Presentation", "Spreadsheet", "WordProcessing"])
-      return false unless document_type_validator.valid?(@document_type)
       return false if @signature_type.nil?
       signature_type_validator = EnumAttributeValidator.new('String', ["None", "Text", "Image", "Digital", "Barcode", "QRCode", "Stamp"])
       return false unless signature_type_validator.valid?(@signature_type)
@@ -223,20 +207,6 @@ module GroupDocsSignatureCloud
       return true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] document_type Object to be assigned
-    def document_type=(document_type)
-      validator = EnumAttributeValidator.new('String', ["Image", "Pdf", "Presentation", "Spreadsheet", "WordProcessing"])
-      if document_type.to_i == 0
-        unless validator.valid?(document_type)
-          raise ArgumentError, "invalid value for 'document_type', must be one of #{validator.allowable_values}."
-        end
-        @document_type = document_type
-      else
-        @document_type = validator.allowable_values[document_type.to_i]
-      end
-    end
-
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] signature_type Object to be assigned
     def signature_type=(signature_type)
@@ -256,13 +226,12 @@ module GroupDocsSignatureCloud
     def ==(other)
       return true if self.equal?(other)
       self.class == other.class &&
-          document_type == other.document_type &&
           signature_type == other.signature_type &&
           page == other.page &&
           all_pages == other.all_pages &&
           pages_setup == other.pages_setup &&
           password == other.password &&
-          certificate_guid == other.certificate_guid &&
+          certificate_file_path == other.certificate_file_path &&
           comments == other.comments &&
           sign_date_time_from == other.sign_date_time_from &&
           sign_date_time_to == other.sign_date_time_to &&
@@ -280,7 +249,7 @@ module GroupDocsSignatureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [document_type, signature_type, page, all_pages, pages_setup, password, certificate_guid, comments, sign_date_time_from, sign_date_time_to, reason, contact, location].hash
+      [signature_type, page, all_pages, pages_setup, password, certificate_file_path, comments, sign_date_time_from, sign_date_time_to, reason, contact, location].hash
     end
 
     # Downcases first letter.