groupdocs_signature_cloud 18.8.1 → 21.11

data/lib/groupdocs_signature_cloud/models/{pages_setup_data.rb → pages_setup.rb}

@@ -1,292 +1,299 @@
- #
- # --------------------------------------------------------------------------------------------------------------------
- # <copyright company="Aspose Pty Ltd" file="pages_setup_data.rb">
- #   Copyright (c) 2003-2018 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 special pages of Document to work with
-  class PagesSetupData
-
-    # Get or set flag to use first document page
-    attr_accessor :first_page
-
-    # Get or set flag to use last document page
-    attr_accessor :last_page
-
-    # Get or set flag to use odd pages of document
-    attr_accessor :odd_pages
-
-    # Get or set flag to use even pages of document
-    attr_accessor :even_pages
-
-    # Set arbitrary pages of document to use
-    attr_accessor :page_numbers
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'first_page' => :'FirstPage',
-        :'last_page' => :'LastPage',
-        :'odd_pages' => :'OddPages',
-        :'even_pages' => :'EvenPages',
-        :'page_numbers' => :'PageNumbers'
-      }
-    end
-
-    # Attribute type mapping.
-    def self.swagger_types
-      {
-        :'first_page' => :'BOOLEAN',
-        :'last_page' => :'BOOLEAN',
-        :'odd_pages' => :'BOOLEAN',
-        :'even_pages' => :'BOOLEAN',
-        :'page_numbers' => :'Array<Integer>'
-      }
-    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?(:'FirstPage')
-        self.first_page = attributes[:'FirstPage']
-      end
-
-      if attributes.key?(:'LastPage')
-        self.last_page = attributes[:'LastPage']
-      end
-
-      if attributes.key?(:'OddPages')
-        self.odd_pages = attributes[:'OddPages']
-      end
-
-      if attributes.key?(:'EvenPages')
-        self.even_pages = attributes[:'EvenPages']
-      end
-
-      if attributes.key?(:'PageNumbers')
-        if (value = attributes[:'PageNumbers']).is_a?(Array)
-          self.page_numbers = value
-        end
-      end
-
-	  
-	  if !((defined? options_type) == nil)
-        self.options_type = "PagesSetupData"
-      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 @first_page.nil?
-        invalid_properties.push("invalid value for 'first_page', first_page cannot be nil.")
-      end
-
-      if @last_page.nil?
-        invalid_properties.push("invalid value for 'last_page', last_page cannot be nil.")
-      end
-
-      if @odd_pages.nil?
-        invalid_properties.push("invalid value for 'odd_pages', odd_pages cannot be nil.")
-      end
-
-      if @even_pages.nil?
-        invalid_properties.push("invalid value for 'even_pages', even_pages 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 @first_page.nil?
-      return false if @last_page.nil?
-      return false if @odd_pages.nil?
-      return false if @even_pages.nil?
-      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 &&
-          first_page == other.first_page &&
-          last_page == other.last_page &&
-          odd_pages == other.odd_pages &&
-          even_pages == other.even_pages &&
-          page_numbers == other.page_numbers
-    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
-      [first_page, last_page, odd_pages, even_pages, page_numbers].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|
-
-        attributeName = self.class.attribute_map[key]
-        attributeNameLowerStr = attributeName.to_s
-        attributeNameLowerStr[0] = attributeNameLowerStr[0].downcase
-        attributeNameLower = attributeNameLowerStr.to_sym
-        attributeNameLowerStr2 = attributeName.to_s
-        attributeNameLowerStr2[0] = attributeNameLowerStr[0].downcase
-        attributeNameLowerStr2[1] = attributeNameLowerStr[1].downcase
-        attributeNameLower2 = attributeNameLowerStr2.to_sym
-
-        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[attributeName].is_a?(Array)
-            self.send("#{key}=", attributes[attributeName].map { |v| _deserialize($1, v) })
-          end
-          if attributes[attributeNameLower].is_a?(Array)
-            self.send("#{key}=", attributes[attributeNameLower].map { |v| _deserialize($1, v) })
-          end
-          if attributes[attributeNameLower2].is_a?(Array)
-            self.send("#{key}=", attributes[attributeNameLower2].map { |v| _deserialize($1, v) })
-          end
-        elsif !attributes[attributeName].nil?
-          self.send("#{key}=", _deserialize(type, attributes[attributeName]))
-        elsif !attributes[attributeNameLower].nil?
-          self.send("#{key}=", _deserialize(type, attributes[attributeNameLower]))
-        elsif !attributes[attributeNameLower2].nil?
-          self.send("#{key}=", _deserialize(type, attributes[attributeNameLower2]))
-        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
-        Time.at(/\d/.match(value)[0].to_f).to_datetime
-      when :Date
-        Time.at(/\d/.match(value)[0].to_f).to_date
-      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 = GroupDocsSignatureCloud.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
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose Pty Ltd" file="pages_setup.rb">
+ #   Copyright (c) 2003-2021 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 special pages of document to process
+  class PagesSetup
+
+    # Get or set flag to use first document page
+    attr_accessor :first_page
+
+    # Get or set flag to use last document page
+    attr_accessor :last_page
+
+    # Get or set flag to use odd pages of document
+    attr_accessor :odd_pages
+
+    # Get or set flag to use even pages of document
+    attr_accessor :even_pages
+
+    # Set arbitrary pages of document to use
+    attr_accessor :page_numbers
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'first_page' => :'FirstPage',
+        :'last_page' => :'LastPage',
+        :'odd_pages' => :'OddPages',
+        :'even_pages' => :'EvenPages',
+        :'page_numbers' => :'PageNumbers'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'first_page' => :'BOOLEAN',
+        :'last_page' => :'BOOLEAN',
+        :'odd_pages' => :'BOOLEAN',
+        :'even_pages' => :'BOOLEAN',
+        :'page_numbers' => :'Array<Integer>'
+      }
+    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?(:'FirstPage')
+        self.first_page = attributes[:'FirstPage']
+      end
+
+      if attributes.key?(:'LastPage')
+        self.last_page = attributes[:'LastPage']
+      end
+
+      if attributes.key?(:'OddPages')
+        self.odd_pages = attributes[:'OddPages']
+      end
+
+      if attributes.key?(:'EvenPages')
+        self.even_pages = attributes[:'EvenPages']
+      end
+
+      if attributes.key?(:'PageNumbers')
+        if (value = attributes[:'PageNumbers']).is_a?(Array)
+          self.page_numbers = 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 = []
+      if @first_page.nil?
+        invalid_properties.push("invalid value for 'first_page', first_page cannot be nil.")
+      end
+
+      if @last_page.nil?
+        invalid_properties.push("invalid value for 'last_page', last_page cannot be nil.")
+      end
+
+      if @odd_pages.nil?
+        invalid_properties.push("invalid value for 'odd_pages', odd_pages cannot be nil.")
+      end
+
+      if @even_pages.nil?
+        invalid_properties.push("invalid value for 'even_pages', even_pages 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 @first_page.nil?
+      return false if @last_page.nil?
+      return false if @odd_pages.nil?
+      return false if @even_pages.nil?
+      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 &&
+          first_page == other.first_page &&
+          last_page == other.last_page &&
+          odd_pages == other.odd_pages &&
+          even_pages == other.even_pages &&
+          page_numbers == other.page_numbers
+    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
+      [first_page, last_page, odd_pages, even_pages, page_numbers].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