aspose_pdf_cloud 20.8.0 → 21.10.0

data/lib/aspose_pdf_cloud/models/signature_custom_appearance.rb

@@ -1,329 +1,329 @@
-=begin
---------------------------------------------------------------------------------------------------------------------
-  Copyright (c) 2020 Aspose.PDF Cloud
-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.
---------------------------------------------------------------------------------------------------------------------
-=end
-
-require 'date'
-require 'time'
-
-module AsposePdfCloud
-  # An abstract class which represents signature custon appearance object.
-  class SignatureCustomAppearance
-    # Gets/sets font family name. It should be existed in the document. Default value: Arial.
-    attr_accessor :font_family_name
-
-    # Gets/sets font size. Default value: 10.
-    attr_accessor :font_size
-
-    # Gets/sets contact info visibility. Default value: true.
-    attr_accessor :show_contact_info
-
-    # Gets/sets reason visibility. Default value: true.
-    attr_accessor :show_reason
-
-    # Gets/sets location visibility. Default value: true.
-    attr_accessor :show_location
-
-    # Gets/sets contact info label. Default value: \"Contact\".
-    attr_accessor :contact_info_label
-
-    # Gets/sets reason label. Default value: \"Reason\".
-    attr_accessor :reason_label
-
-    # Gets/sets location label. Default value: \"Location\".
-    attr_accessor :location_label
-
-    # Gets/sets digital signed label. Default value: \"Digitally signed by\".
-    attr_accessor :digital_signed_label
-
-    # Gets/sets date signed label. Default value: \"Date\".
-    attr_accessor :date_signed_at_label
-
-    # Gets/sets datetime local format. Default value: \"yyyy.MM.dd HH:mm:ss zzz\".
-    attr_accessor :date_time_local_format
-
-    # Gets/sets datetime format. Default value: \"yyyy.MM.dd HH:mm:ss\".
-    attr_accessor :date_time_format
-
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'font_family_name' => :'FontFamilyName',
-        :'font_size' => :'FontSize',
-        :'show_contact_info' => :'ShowContactInfo',
-        :'show_reason' => :'ShowReason',
-        :'show_location' => :'ShowLocation',
-        :'contact_info_label' => :'ContactInfoLabel',
-        :'reason_label' => :'ReasonLabel',
-        :'location_label' => :'LocationLabel',
-        :'digital_signed_label' => :'DigitalSignedLabel',
-        :'date_signed_at_label' => :'DateSignedAtLabel',
-        :'date_time_local_format' => :'DateTimeLocalFormat',
-        :'date_time_format' => :'DateTimeFormat'
-      }
-    end
-
-    # Attribute type mapping.
-    def self.swagger_types
-      {
-        :'font_family_name' => :'String',
-        :'font_size' => :'Float',
-        :'show_contact_info' => :'BOOLEAN',
-        :'show_reason' => :'BOOLEAN',
-        :'show_location' => :'BOOLEAN',
-        :'contact_info_label' => :'String',
-        :'reason_label' => :'String',
-        :'location_label' => :'String',
-        :'digital_signed_label' => :'String',
-        :'date_signed_at_label' => :'String',
-        :'date_time_local_format' => :'String',
-        :'date_time_format' => :'String'
-      }
-    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.has_key?(:'FontFamilyName')
-        self.font_family_name = attributes[:'FontFamilyName']
-      end
-
-      if attributes.has_key?(:'FontSize')
-        self.font_size = attributes[:'FontSize']
-      end
-
-      if attributes.has_key?(:'ShowContactInfo')
-        self.show_contact_info = attributes[:'ShowContactInfo']
-      end
-
-      if attributes.has_key?(:'ShowReason')
-        self.show_reason = attributes[:'ShowReason']
-      end
-
-      if attributes.has_key?(:'ShowLocation')
-        self.show_location = attributes[:'ShowLocation']
-      end
-
-      if attributes.has_key?(:'ContactInfoLabel')
-        self.contact_info_label = attributes[:'ContactInfoLabel']
-      end
-
-      if attributes.has_key?(:'ReasonLabel')
-        self.reason_label = attributes[:'ReasonLabel']
-      end
-
-      if attributes.has_key?(:'LocationLabel')
-        self.location_label = attributes[:'LocationLabel']
-      end
-
-      if attributes.has_key?(:'DigitalSignedLabel')
-        self.digital_signed_label = attributes[:'DigitalSignedLabel']
-      end
-
-      if attributes.has_key?(:'DateSignedAtLabel')
-        self.date_signed_at_label = attributes[:'DateSignedAtLabel']
-      end
-
-      if attributes.has_key?(:'DateTimeLocalFormat')
-        self.date_time_local_format = attributes[:'DateTimeLocalFormat']
-      end
-
-      if attributes.has_key?(:'DateTimeFormat')
-        self.date_time_format = attributes[:'DateTimeFormat']
-      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 = Array.new
-      if @font_size.nil?
-        invalid_properties.push("invalid value for 'font_size', font_size cannot be nil.")
-      end
-
-      if @show_contact_info.nil?
-        invalid_properties.push("invalid value for 'show_contact_info', show_contact_info cannot be nil.")
-      end
-
-      if @show_reason.nil?
-        invalid_properties.push("invalid value for 'show_reason', show_reason cannot be nil.")
-      end
-
-      if @show_location.nil?
-        invalid_properties.push("invalid value for 'show_location', show_location 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 @font_size.nil?
-      return false if @show_contact_info.nil?
-      return false if @show_reason.nil?
-      return false if @show_location.nil?
-      return 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 &&
-          font_family_name == o.font_family_name &&
-          font_size == o.font_size &&
-          show_contact_info == o.show_contact_info &&
-          show_reason == o.show_reason &&
-          show_location == o.show_location &&
-          contact_info_label == o.contact_info_label &&
-          reason_label == o.reason_label &&
-          location_label == o.location_label &&
-          digital_signed_label == o.digital_signed_label &&
-          date_signed_at_label == o.date_signed_at_label &&
-          date_time_local_format == o.date_time_local_format &&
-          date_time_format == o.date_time_format
-    end
-
-    # @see the `==` method
-    # @param [Object] Object to be compared
-    def eql?(o)
-      self == o
-    end
-
-    # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
-    def hash
-      [font_family_name, font_size, show_contact_info, show_reason, show_location, contact_info_label, reason_label, location_label, digital_signed_label, date_signed_at_label, date_time_local_format, date_time_format].hash
-    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|
-        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 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 # 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
-        DateTime.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
-        temp_model = AsposePdfCloud.const_get(type).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
+=begin
+--------------------------------------------------------------------------------------------------------------------
+Copyright (c) 2021 Aspose.PDF Cloud
+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.
+--------------------------------------------------------------------------------------------------------------------
+=end
+
+require 'date'
+require 'time'
+
+module AsposePdfCloud
+  # An abstract class which represents signature custom appearance object.
+  class SignatureCustomAppearance
+    # Gets/sets font family name. It should be existed in the document. Default value: Arial.
+    attr_accessor :font_family_name
+
+    # Gets/sets font size. Default value: 10.
+    attr_accessor :font_size
+
+    # Gets/sets contact info visibility. Default value: true.
+    attr_accessor :show_contact_info
+
+    # Gets/sets reason visibility. Default value: true.
+    attr_accessor :show_reason
+
+    # Gets/sets location visibility. Default value: true.
+    attr_accessor :show_location
+
+    # Gets/sets contact info label. Default value: \"Contact\".
+    attr_accessor :contact_info_label
+
+    # Gets/sets reason label. Default value: \"Reason\".
+    attr_accessor :reason_label
+
+    # Gets/sets location label. Default value: \"Location\".
+    attr_accessor :location_label
+
+    # Gets/sets digital signed label. Default value: \"Digitally signed by\".
+    attr_accessor :digital_signed_label
+
+    # Gets/sets date signed label. Default value: \"Date\".
+    attr_accessor :date_signed_at_label
+
+    # Gets/sets datetime local format. Default value: \"yyyy.MM.dd HH:mm:ss zzz\".
+    attr_accessor :date_time_local_format
+
+    # Gets/sets datetime format. Default value: \"yyyy.MM.dd HH:mm:ss\".
+    attr_accessor :date_time_format
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'font_family_name' => :'FontFamilyName',
+        :'font_size' => :'FontSize',
+        :'show_contact_info' => :'ShowContactInfo',
+        :'show_reason' => :'ShowReason',
+        :'show_location' => :'ShowLocation',
+        :'contact_info_label' => :'ContactInfoLabel',
+        :'reason_label' => :'ReasonLabel',
+        :'location_label' => :'LocationLabel',
+        :'digital_signed_label' => :'DigitalSignedLabel',
+        :'date_signed_at_label' => :'DateSignedAtLabel',
+        :'date_time_local_format' => :'DateTimeLocalFormat',
+        :'date_time_format' => :'DateTimeFormat'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'font_family_name' => :'String',
+        :'font_size' => :'Float',
+        :'show_contact_info' => :'BOOLEAN',
+        :'show_reason' => :'BOOLEAN',
+        :'show_location' => :'BOOLEAN',
+        :'contact_info_label' => :'String',
+        :'reason_label' => :'String',
+        :'location_label' => :'String',
+        :'digital_signed_label' => :'String',
+        :'date_signed_at_label' => :'String',
+        :'date_time_local_format' => :'String',
+        :'date_time_format' => :'String'
+      }
+    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.has_key?(:'FontFamilyName')
+        self.font_family_name = attributes[:'FontFamilyName']
+      end
+
+      if attributes.has_key?(:'FontSize')
+        self.font_size = attributes[:'FontSize']
+      end
+
+      if attributes.has_key?(:'ShowContactInfo')
+        self.show_contact_info = attributes[:'ShowContactInfo']
+      end
+
+      if attributes.has_key?(:'ShowReason')
+        self.show_reason = attributes[:'ShowReason']
+      end
+
+      if attributes.has_key?(:'ShowLocation')
+        self.show_location = attributes[:'ShowLocation']
+      end
+
+      if attributes.has_key?(:'ContactInfoLabel')
+        self.contact_info_label = attributes[:'ContactInfoLabel']
+      end
+
+      if attributes.has_key?(:'ReasonLabel')
+        self.reason_label = attributes[:'ReasonLabel']
+      end
+
+      if attributes.has_key?(:'LocationLabel')
+        self.location_label = attributes[:'LocationLabel']
+      end
+
+      if attributes.has_key?(:'DigitalSignedLabel')
+        self.digital_signed_label = attributes[:'DigitalSignedLabel']
+      end
+
+      if attributes.has_key?(:'DateSignedAtLabel')
+        self.date_signed_at_label = attributes[:'DateSignedAtLabel']
+      end
+
+      if attributes.has_key?(:'DateTimeLocalFormat')
+        self.date_time_local_format = attributes[:'DateTimeLocalFormat']
+      end
+
+      if attributes.has_key?(:'DateTimeFormat')
+        self.date_time_format = attributes[:'DateTimeFormat']
+      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 = Array.new
+      if @font_size.nil?
+        invalid_properties.push("invalid value for 'font_size', font_size cannot be nil.")
+      end
+
+      if @show_contact_info.nil?
+        invalid_properties.push("invalid value for 'show_contact_info', show_contact_info cannot be nil.")
+      end
+
+      if @show_reason.nil?
+        invalid_properties.push("invalid value for 'show_reason', show_reason cannot be nil.")
+      end
+
+      if @show_location.nil?
+        invalid_properties.push("invalid value for 'show_location', show_location 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 @font_size.nil?
+      return false if @show_contact_info.nil?
+      return false if @show_reason.nil?
+      return false if @show_location.nil?
+      return 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 &&
+          font_family_name == o.font_family_name &&
+          font_size == o.font_size &&
+          show_contact_info == o.show_contact_info &&
+          show_reason == o.show_reason &&
+          show_location == o.show_location &&
+          contact_info_label == o.contact_info_label &&
+          reason_label == o.reason_label &&
+          location_label == o.location_label &&
+          digital_signed_label == o.digital_signed_label &&
+          date_signed_at_label == o.date_signed_at_label &&
+          date_time_local_format == o.date_time_local_format &&
+          date_time_format == o.date_time_format
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [font_family_name, font_size, show_contact_info, show_reason, show_location, contact_info_label, reason_label, location_label, digital_signed_label, date_signed_at_label, date_time_local_format, date_time_format].hash
+    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|
+        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 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 # 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
+        DateTime.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
+        temp_model = AsposePdfCloud.const_get(type).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