groupdocs_signature_cloud 20.7 → 22.6

data/lib/groupdocs_signature_cloud/models/image_appearance.rb

@@ -0,0 +1,339 @@
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose Pty Ltd" file="image_appearance.rb">
+ #   Copyright (c) 2003-2022 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
+  # Describes extended appearance features for Image Signature.
+  class ImageAppearance
+
+    # Specifies the type of appearance
+    attr_accessor :appearance_type
+
+    # Gets or sets image brightness. Default value is 1 it corresponds to original brightness of image.
+    attr_accessor :brightness
+
+    # Gets or sets image contrast. Default value is 1 it corresponds to original contrast of image.
+    attr_accessor :contrast
+
+    # Gets or sets image gamma. Default value is 1 it corresponds to original gamma of image.
+    attr_accessor :gamma_correction
+
+    # Setup this flag to true if gray-scale filter is required.
+    attr_accessor :grayscale
+    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
+      {
+        :'appearance_type' => :'AppearanceType',
+        :'brightness' => :'Brightness',
+        :'contrast' => :'Contrast',
+        :'gamma_correction' => :'GammaCorrection',
+        :'grayscale' => :'Grayscale'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'appearance_type' => :'String',
+        :'brightness' => :'Float',
+        :'contrast' => :'Float',
+        :'gamma_correction' => :'Float',
+        :'grayscale' => :'BOOLEAN'
+      }
+    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?(:'AppearanceType')
+        self.appearance_type = attributes[:'AppearanceType']
+      end
+
+      if attributes.key?(:'Brightness')
+        self.brightness = attributes[:'Brightness']
+      end
+
+      if attributes.key?(:'Contrast')
+        self.contrast = attributes[:'Contrast']
+      end
+
+      if attributes.key?(:'GammaCorrection')
+        self.gamma_correction = attributes[:'GammaCorrection']
+      end
+
+      if attributes.key?(:'Grayscale')
+        self.grayscale = attributes[:'Grayscale']
+      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 = []
+      if @appearance_type.nil?
+        invalid_properties.push("invalid value for 'appearance_type', appearance_type cannot be nil.")
+      end
+
+      if @brightness.nil?
+        invalid_properties.push("invalid value for 'brightness', brightness cannot be nil.")
+      end
+
+      if @contrast.nil?
+        invalid_properties.push("invalid value for 'contrast', contrast cannot be nil.")
+      end
+
+      if @gamma_correction.nil?
+        invalid_properties.push("invalid value for 'gamma_correction', gamma_correction cannot be nil.")
+      end
+
+      if @grayscale.nil?
+        invalid_properties.push("invalid value for 'grayscale', grayscale cannot be nil.")
+      end
+
+      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 false if @appearance_type.nil?
+      appearance_type_validator = EnumAttributeValidator.new('String', ["Undefined", "PdfTextAnnotation", "PdfTextSticker", "Image", "DigitalSignature", "PdfDigitalSignature"])
+      return false unless appearance_type_validator.valid?(@appearance_type)
+      return false if @brightness.nil?
+      return false if @contrast.nil?
+      return false if @gamma_correction.nil?
+      return false if @grayscale.nil?
+      return true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] appearance_type Object to be assigned
+    def appearance_type=(appearance_type)
+      validator = EnumAttributeValidator.new('String', ["Undefined", "PdfTextAnnotation", "PdfTextSticker", "Image", "DigitalSignature", "PdfDigitalSignature"])
+      if appearance_type.to_i == 0
+        unless validator.valid?(appearance_type)
+          raise ArgumentError, "invalid value for 'appearance_type', must be one of #{validator.allowable_values}."
+        end
+        @appearance_type = appearance_type
+      else
+        @appearance_type = validator.allowable_values[appearance_type.to_i]
+      end
+    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 &&
+          appearance_type == other.appearance_type &&
+          brightness == other.brightness &&
+          contrast == other.contrast &&
+          gamma_correction == other.gamma_correction &&
+          grayscale == other.grayscale
+    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
+      [appearance_type, brightness, contrast, gamma_correction, grayscale].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'
+          if value[:signatureType] == 'FormField' and !value[:type].nil?
+            type = value[:type]
+            if type == 'Checkbox'
+              ttype = 'CheckboxFormFieldSignature'
+            end
+            if type == 'Text'
+              ttype = 'TextFormFieldSignature'
+            end
+            if type == 'Combobox'
+              ttype = 'ComboboxFormFieldSignature'
+            end
+            if type == 'DigitalSignature'
+              ttype = 'DigitalFormFieldSignature'
+            end
+            if type == 'Radio'
+              ttype = 'RadioButtonFormFieldSignature'
+            end
+          end
+        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/image_signature.rb

@@ -1,7 +1,7 @@
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="image_signature.rb">
- #   Copyright (c) 2003-2020 Aspose Pty Ltd
+ #   Copyright (c) 2003-2022 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -229,7 +229,7 @@ module GroupDocsSignatureCloud
     # @return true if the model is valid
     def valid?
       return false if @signature_type.nil?
-      signature_type_validator = EnumAttributeValidator.new('String', ["None", "Text", "Image", "Digital", "Barcode", "QRCode", "Stamp"])
+      signature_type_validator = EnumAttributeValidator.new('String', ["None", "Text", "Image", "Digital", "Barcode", "QRCode", "Stamp", "FormField", "Metadata"])
       return false unless signature_type_validator.valid?(@signature_type)
       return false if @is_signature.nil?
       return false if @created_on.nil?
@@ -245,7 +245,7 @@ module GroupDocsSignatureCloud
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] signature_type Object to be assigned
     def signature_type=(signature_type)
-      validator = EnumAttributeValidator.new('String', ["None", "Text", "Image", "Digital", "Barcode", "QRCode", "Stamp"])
+      validator = EnumAttributeValidator.new('String', ["None", "Text", "Image", "Digital", "Barcode", "QRCode", "Stamp", "FormField", "Metadata"])
       if signature_type.to_i == 0
         unless validator.valid?(signature_type)
           raise ArgumentError, "invalid value for 'signature_type', must be one of #{validator.allowable_values}."
@@ -358,6 +358,24 @@ module GroupDocsSignatureCloud
         ttype = type
         if value.is_a?(Hash) and !value[:signatureType].nil?
           ttype = value[:signatureType] + 'Signature'
+          if value[:signatureType] == 'FormField' and !value[:type].nil?
+            type = value[:type]
+            if type == 'Checkbox'
+              ttype = 'CheckboxFormFieldSignature'
+            end
+            if type == 'Text'
+              ttype = 'TextFormFieldSignature'
+            end
+            if type == 'Combobox'
+              ttype = 'ComboboxFormFieldSignature'
+            end
+            if type == 'DigitalSignature'
+              ttype = 'DigitalFormFieldSignature'
+            end
+            if type == 'Radio'
+              ttype = 'RadioButtonFormFieldSignature'
+            end
+          end
         end      
         temp_model = GroupDocsSignatureCloud.const_get(ttype).new
         temp_model.build_from_hash(value)

data/lib/groupdocs_signature_cloud/models/info_result.rb

@@ -1,7 +1,7 @@
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="info_result.rb">
- #   Copyright (c) 2003-2020 Aspose Pty Ltd
+ #   Copyright (c) 2003-2022 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -31,7 +31,7 @@ module GroupDocsSignatureCloud
   # Document info result
   class InfoResult
 
-    # File info
+    # Input File info
     attr_accessor :file_info
 
     # Document extension
@@ -61,6 +61,9 @@ module GroupDocsSignatureCloud
     # List of document pages descriptions
     attr_accessor :pages
 
+    # Collection of document signatures
+    attr_accessor :signatures
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -73,7 +76,8 @@ module GroupDocsSignatureCloud
         :'date_modified' => :'DateModified',
         :'width_for_max_height' => :'WidthForMaxHeight',
         :'max_page_height' => :'MaxPageHeight',
-        :'pages' => :'Pages'
+        :'pages' => :'Pages',
+        :'signatures' => :'Signatures'
       }
     end
 
@@ -89,7 +93,8 @@ module GroupDocsSignatureCloud
         :'date_modified' => :'DateTime',
         :'width_for_max_height' => :'Integer',
         :'max_page_height' => :'Integer',
-        :'pages' => :'Array<PageInfo>'
+        :'pages' => :'Array<PageInfo>',
+        :'signatures' => :'Array<Signature>'
       }
     end
 
@@ -143,6 +148,12 @@ module GroupDocsSignatureCloud
         end
       end
 
+      if attributes.key?(:'Signatures')
+        if (value = attributes[:'Signatures']).is_a?(Array)
+          self.signatures = value
+        end
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -202,7 +213,8 @@ module GroupDocsSignatureCloud
           date_modified == other.date_modified &&
           width_for_max_height == other.width_for_max_height &&
           max_page_height == other.max_page_height &&
-          pages == other.pages
+          pages == other.pages &&
+          signatures == other.signatures
     end
 
     # @see the `==` method
@@ -214,7 +226,7 @@ module GroupDocsSignatureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [file_info, extension, file_format, size, pages_count, date_created, date_modified, width_for_max_height, max_page_height, pages].hash
+      [file_info, extension, file_format, size, pages_count, date_created, date_modified, width_for_max_height, max_page_height, pages, signatures].hash
     end
 
     # Downcases first letter.
@@ -288,6 +300,24 @@ module GroupDocsSignatureCloud
         ttype = type
         if value.is_a?(Hash) and !value[:signatureType].nil?
           ttype = value[:signatureType] + 'Signature'
+          if value[:signatureType] == 'FormField' and !value[:type].nil?
+            type = value[:type]
+            if type == 'Checkbox'
+              ttype = 'CheckboxFormFieldSignature'
+            end
+            if type == 'Text'
+              ttype = 'TextFormFieldSignature'
+            end
+            if type == 'Combobox'
+              ttype = 'ComboboxFormFieldSignature'
+            end
+            if type == 'DigitalSignature'
+              ttype = 'DigitalFormFieldSignature'
+            end
+            if type == 'Radio'
+              ttype = 'RadioButtonFormFieldSignature'
+            end
+          end
         end      
         temp_model = GroupDocsSignatureCloud.const_get(ttype).new
         temp_model.build_from_hash(value)

data/lib/groupdocs_signature_cloud/models/info_settings.rb

@@ -1,7 +1,7 @@
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="info_settings.rb">
- #   Copyright (c) 2003-2020 Aspose Pty Ltd
+ #   Copyright (c) 2003-2022 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -34,17 +34,22 @@ module GroupDocsSignatureCloud
     # File info
     attr_accessor :file_info
 
+    # Gets or sets flag that includes deleted signatures into Document Info result.
+    attr_accessor :show_deleted_signatures_info
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'file_info' => :'FileInfo'
+        :'file_info' => :'FileInfo',
+        :'show_deleted_signatures_info' => :'ShowDeletedSignaturesInfo'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'file_info' => :'FileInfo'
+        :'file_info' => :'FileInfo',
+        :'show_deleted_signatures_info' => :'BOOLEAN'
       }
     end
 
@@ -60,18 +65,27 @@ module GroupDocsSignatureCloud
         self.file_info = attributes[:'FileInfo']
       end
 
+      if attributes.key?(:'ShowDeletedSignaturesInfo')
+        self.show_deleted_signatures_info = attributes[:'ShowDeletedSignaturesInfo']
+      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 = []
+      if @show_deleted_signatures_info.nil?
+        invalid_properties.push("invalid value for 'show_deleted_signatures_info', show_deleted_signatures_info cannot be nil.")
+      end
+
       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 false if @show_deleted_signatures_info.nil?
       return true
     end
 
@@ -80,7 +94,8 @@ module GroupDocsSignatureCloud
     def ==(other)
       return true if self.equal?(other)
       self.class == other.class &&
-          file_info == other.file_info
+          file_info == other.file_info &&
+          show_deleted_signatures_info == other.show_deleted_signatures_info
     end
 
     # @see the `==` method
@@ -92,7 +107,7 @@ module GroupDocsSignatureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [file_info].hash
+      [file_info, show_deleted_signatures_info].hash
     end
 
     # Downcases first letter.
@@ -166,6 +181,24 @@ module GroupDocsSignatureCloud
         ttype = type
         if value.is_a?(Hash) and !value[:signatureType].nil?
           ttype = value[:signatureType] + 'Signature'
+          if value[:signatureType] == 'FormField' and !value[:type].nil?
+            type = value[:type]
+            if type == 'Checkbox'
+              ttype = 'CheckboxFormFieldSignature'
+            end
+            if type == 'Text'
+              ttype = 'TextFormFieldSignature'
+            end
+            if type == 'Combobox'
+              ttype = 'ComboboxFormFieldSignature'
+            end
+            if type == 'DigitalSignature'
+              ttype = 'DigitalFormFieldSignature'
+            end
+            if type == 'Radio'
+              ttype = 'RadioButtonFormFieldSignature'
+            end
+          end
         end      
         temp_model = GroupDocsSignatureCloud.const_get(ttype).new
         temp_model.build_from_hash(value)

data/lib/groupdocs_signature_cloud/models/linear_gradient_brush.rb

@@ -1,7 +1,7 @@
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="linear_gradient_brush.rb">
- #   Copyright (c) 2003-2020 Aspose Pty Ltd
+ #   Copyright (c) 2003-2022 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -201,6 +201,24 @@ module GroupDocsSignatureCloud
         ttype = type
         if value.is_a?(Hash) and !value[:signatureType].nil?
           ttype = value[:signatureType] + 'Signature'
+          if value[:signatureType] == 'FormField' and !value[:type].nil?
+            type = value[:type]
+            if type == 'Checkbox'
+              ttype = 'CheckboxFormFieldSignature'
+            end
+            if type == 'Text'
+              ttype = 'TextFormFieldSignature'
+            end
+            if type == 'Combobox'
+              ttype = 'ComboboxFormFieldSignature'
+            end
+            if type == 'DigitalSignature'
+              ttype = 'DigitalFormFieldSignature'
+            end
+            if type == 'Radio'
+              ttype = 'RadioButtonFormFieldSignature'
+            end
+          end
         end      
         temp_model = GroupDocsSignatureCloud.const_get(ttype).new
         temp_model.build_from_hash(value)

data/lib/groupdocs_signature_cloud/models/object_exist.rb

@@ -1,7 +1,7 @@
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="object_exist.rb">
- #   Copyright (c) 2003-2020 Aspose Pty Ltd
+ #   Copyright (c) 2003-2022 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -186,6 +186,24 @@ module GroupDocsSignatureCloud
         ttype = type
         if value.is_a?(Hash) and !value[:signatureType].nil?
           ttype = value[:signatureType] + 'Signature'
+          if value[:signatureType] == 'FormField' and !value[:type].nil?
+            type = value[:type]
+            if type == 'Checkbox'
+              ttype = 'CheckboxFormFieldSignature'
+            end
+            if type == 'Text'
+              ttype = 'TextFormFieldSignature'
+            end
+            if type == 'Combobox'
+              ttype = 'ComboboxFormFieldSignature'
+            end
+            if type == 'DigitalSignature'
+              ttype = 'DigitalFormFieldSignature'
+            end
+            if type == 'Radio'
+              ttype = 'RadioButtonFormFieldSignature'
+            end
+          end
         end      
         temp_model = GroupDocsSignatureCloud.const_get(ttype).new
         temp_model.build_from_hash(value)