aspose_words_cloud 20.10.0 → 21.4.0

data/lib/aspose_words_cloud/models/font_dto.rb

@@ -0,0 +1,192 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="font_dto.rb">
+#   Copyright (c) 2021 Aspose.Words for Cloud
+# </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 AsposeWordsCloud
+
+  class FontDto
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+      }
+    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 }
+
+    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
+    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
+      [].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
+        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 = AsposeWordsCloud.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

data/lib/aspose_words_cloud/models/font_info.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="font_info.rb">
-#   Copyright (c) 2020 Aspose.Words for Cloud
+#   Copyright (c) 2021 Aspose.Words for Cloud
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -27,18 +27,18 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # Font info.
+  # DTO container with font info.
   class FontInfo
-    # Gets or sets path to the font file if any.
+    # Gets or sets the path to the font file if any.
     attr_accessor :file_path
 
-    # Gets or sets family name of the font.
+    # Gets or sets the family name of the font.
     attr_accessor :font_family_name
 
-    # Gets or sets full name of the font.
+    # Gets or sets the full name of the font.
     attr_accessor :full_font_name
 
-    # Gets or sets version string of the font.
+    # Gets or sets the version string of the font.
     attr_accessor :version
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/font_response.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="font_response.rb">
-#   Copyright (c) 2020 Aspose.Words for Cloud
+#   Copyright (c) 2021 Aspose.Words for Cloud
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -27,13 +27,12 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # This response should be returned by the service when handling:
-  # GET https://api.aspose.cloud/v4.0/words/Test.doc/paragraphs/{0}/runs/{1}/font.
+  # The REST response with a font.
   class FontResponse
-    # Gets or sets request Id.
+    # Gets or sets the request Id.
     attr_accessor :request_id
 
-    # Gets or sets font.
+    # Gets or sets the font.
     attr_accessor :font
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/footnote.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="footnote.rb">
-#   Copyright (c) 2020 Aspose.Words for Cloud
+#   Copyright (c) 2021 Aspose.Words for Cloud
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -27,28 +27,28 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # Footnote.
+  # DTO container with a footnote.
   class Footnote
-    # Gets or sets link to the document.
+    # Gets or sets the link to the document.
     attr_accessor :link
 
-    # Gets or sets node id.
+    # Gets or sets the node id.
     attr_accessor :node_id
 
-    # Gets or sets content of footnote.
+    # Gets or sets the content of the footnote.
     attr_accessor :content
 
-    # Gets or sets returns a value that specifies whether this is a footnote or endnote.
+    # Gets or sets the value, that specifies whether this is a footnote or endnote.
     attr_accessor :footnote_type
 
-    # Gets or sets link to comment range start node.
+    # Gets or sets the link to comment range start node.
     attr_accessor :position
 
-    # Gets or sets /sets custom reference mark to be used for this footnote.
+    # Gets or sets the custom reference mark to be used for this footnote.
     # Default value is Empty, meaning auto-numbered footnotes are used.
     attr_accessor :reference_mark
 
-    # Gets or sets this is a convenience property that allows to easily get or set text of the footnote.
+    # Gets or sets text of the footnote.
     attr_accessor :text
 
     class EnumAttributeValidator

data/lib/aspose_words_cloud/models/footnote_base.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="footnote_base.rb">
-#   Copyright (c) 2020 Aspose.Words for Cloud
+#   Copyright (c) 2021 Aspose.Words for Cloud
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -29,17 +29,17 @@ module AsposeWordsCloud
 
   # Footnote base class.
   class FootnoteBase
-    # Gets or sets returns a value that specifies whether this is a footnote or endnote.
+    # Gets or sets the option, that specifies whether this is a footnote or endnote.
     attr_accessor :footnote_type
 
-    # Gets or sets link to comment range start node.
+    # Gets or sets the link to comment range start node.
     attr_accessor :position
 
-    # Gets or sets /sets custom reference mark to be used for this footnote.
+    # Gets or sets the custom reference mark to be used for this footnote.
     # Default value is Empty, meaning auto-numbered footnotes are used.
     attr_accessor :reference_mark
 
-    # Gets or sets this is a convenience property that allows to easily get or set text of the footnote.
+    # Gets or sets text of the footnote.
     attr_accessor :text
 
     class EnumAttributeValidator

data/lib/aspose_words_cloud/models/footnote_collection.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="footnote_collection.rb">
-#   Copyright (c) 2020 Aspose.Words for Cloud
+#   Copyright (c) 2021 Aspose.Words for Cloud
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -27,12 +27,12 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # Collection of footnotes.
+  # DTO container with a collection of footnotes.
   class FootnoteCollection
-    # Gets or sets link to the document.
+    # Gets or sets the link to the document.
     attr_accessor :link
 
-    # Gets or sets collection of foonotes links.
+    # Gets or sets the collection of footnotes.
     attr_accessor :list
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/footnote_insert.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="footnote_insert.rb">
-#   Copyright (c) 2020 Aspose.Words for Cloud
+#   Copyright (c) 2021 Aspose.Words for Cloud
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -29,17 +29,17 @@ module AsposeWordsCloud
 
   # Footnote for insert.
   class FootnoteInsert
-    # Gets or sets returns a value that specifies whether this is a footnote or endnote.
+    # Gets or sets the option, that specifies whether this is a footnote or endnote.
     attr_accessor :footnote_type
 
-    # Gets or sets link to comment range start node.
+    # Gets or sets the link to comment range start node.
     attr_accessor :position
 
-    # Gets or sets /sets custom reference mark to be used for this footnote.
+    # Gets or sets the custom reference mark to be used for this footnote.
     # Default value is Empty, meaning auto-numbered footnotes are used.
     attr_accessor :reference_mark
 
-    # Gets or sets this is a convenience property that allows to easily get or set text of the footnote.
+    # Gets or sets text of the footnote.
     attr_accessor :text
 
     class EnumAttributeValidator

data/lib/aspose_words_cloud/models/footnote_link.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="footnote_link.rb">
-#   Copyright (c) 2020 Aspose.Words for Cloud
+#   Copyright (c) 2021 Aspose.Words for Cloud
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -29,10 +29,10 @@ module AsposeWordsCloud
 
   # Footnote link.
   class FootnoteLink
-    # Gets or sets link to the document.
+    # Gets or sets the link to the document.
     attr_accessor :link
 
-    # Gets or sets node id.
+    # Gets or sets the node id.
     attr_accessor :node_id
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/footnote_response.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="footnote_response.rb">
-#   Copyright (c) 2020 Aspose.Words for Cloud
+#   Copyright (c) 2021 Aspose.Words for Cloud
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -27,13 +27,12 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # This response should be returned by the service when handling:
-  # GET https://api.aspose.cloud/v4.0/words/Test.doc/footnote/0.
+  # The REST response with a footnote.
   class FootnoteResponse
-    # Gets or sets request Id.
+    # Gets or sets the request Id.
     attr_accessor :request_id
 
-    # Gets or sets footnote information.
+    # Gets or sets the footnote.
     attr_accessor :footnote
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/footnote_update.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="footnote_update.rb">
-#   Copyright (c) 2020 Aspose.Words for Cloud
+#   Copyright (c) 2021 Aspose.Words for Cloud
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -29,17 +29,17 @@ module AsposeWordsCloud
 
   # Footnote for update.
   class FootnoteUpdate
-    # Gets or sets returns a value that specifies whether this is a footnote or endnote.
+    # Gets or sets the option, that specifies whether this is a footnote or endnote.
     attr_accessor :footnote_type
 
-    # Gets or sets link to comment range start node.
+    # Gets or sets the link to comment range start node.
     attr_accessor :position
 
-    # Gets or sets /sets custom reference mark to be used for this footnote.
+    # Gets or sets the custom reference mark to be used for this footnote.
     # Default value is Empty, meaning auto-numbered footnotes are used.
     attr_accessor :reference_mark
 
-    # Gets or sets this is a convenience property that allows to easily get or set text of the footnote.
+    # Gets or sets text of the footnote.
     attr_accessor :text
 
     class EnumAttributeValidator