aspose_words_cloud 20.7.0 → 21.1.0

data/lib/aspose_words_cloud/models/field_update.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="field_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,10 +29,10 @@ module AsposeWordsCloud
 
   # Field for update.
   class FieldUpdate
-    # Gets or sets field code.
+    # Gets or sets the field code.
     attr_accessor :field_code
 
-    # Gets or sets LCID of the field.
+    # Gets or sets the LCID of the field.
     attr_accessor :locale_id
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/fields_response.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="fields_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/{nodePath}/fields.
+  # The REST response with a collection of fields.
   class FieldsResponse
-    # Gets or sets request Id.
+    # Gets or sets the request Id.
     attr_accessor :request_id
 
-    # Gets or sets collection of fields.
+    # Gets or sets the collection of fields.
     attr_accessor :fields
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/file_link.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="file_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,24 +29,16 @@ module AsposeWordsCloud
 
   # Provides information for the file link.
   class FileLink
-    # Gets or sets the "href" attribute contains the link's IRI. atom:link elements MUST
-    # have an href attribute, whose value MUST be a IRI reference.
+    # Gets or sets the "href" attribute with the link's IRI. atom:link elements MUST have an href attribute, whose value MUST be a IRI reference.
     attr_accessor :href
 
-    # Gets or sets atom:link elements MAY have a "rel" attribute that indicates the link
-    # relation type.  If the "rel" attribute is not present, the link
-    # element MUST be interpreted as if the link relation type is "alternate".
+    # Gets or sets the option that controls whether atom:link elements MAY have a "rel" attribute that indicates the link relation type.  If the "rel" attribute is not present, the link element MUST be interpreted as if the link relation type is "alternate".
     attr_accessor :rel
 
-    # Gets or sets the "title" attribute conveys human-readable information about the
-    # link.  The content of the "title" attribute is Language-Sensitive.
+    # Gets or sets the "title" attribute, that conveys human-readable information about the link. The content of the "title" attribute is Language-Sensitive.
     attr_accessor :title
 
-    # Gets or sets on the link element, the "type" attribute's value is an advisory
-    # media type: it is a hint about the type of the representation that is
-    # expected to be returned when the value of the href attribute is
-    # dereferenced.  Note that the type attribute does not override the
-    # actual media type returned with the representation.
+    # Gets or sets the "type" attribute. The "type" attribute's value is an advisory media type: it is a hint about the type of the representation that is expected to be returned when the value of the href attribute is dereferenced. Note that the type attribute does not override the actual media type returned with the representation.
     attr_accessor :type
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/files_list.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="files_list.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

data/lib/aspose_words_cloud/models/files_upload_result.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="files_upload_result.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

data/lib/aspose_words_cloud/models/fixed_page_save_options_data.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="fixed_page_save_options_data.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,63 +29,60 @@ module AsposeWordsCloud
 
   # Contains common options that can be specified when saving a document into fixed page formats (PDF, XPS, images etc).
   class FixedPageSaveOptionsData
-    # Gets or sets a value determining how 3D effects are rendered.
+    # Gets or sets the value determining how 3D effects are rendered.
     attr_accessor :dml3_d_effects_rendering_mode
 
-    # Gets or sets a value determining how DrawingML effects are rendered.
+    # Gets or sets the value determining how DrawingML effects are rendered.
     # { Simplified | None | Fine }.
     attr_accessor :dml_effects_rendering_mode
 
-    # Gets or sets a value determining how DrawingML shapes are rendered.
-    # { Fallback | DrawingML }.
+    # Gets or sets the option that controls how DrawingML shapes are rendered.
     attr_accessor :dml_rendering_mode
 
-    # Gets or sets name of destination file.
+    # Gets or sets the name of destination file.
     attr_accessor :file_name
 
-    # Gets or sets format of save.
+    # Gets or sets the format of save.
     attr_accessor :save_format
 
-    # Gets or sets a value determining if fields should be updated before saving the document to a fixed page format.
-    # Default value for this property is. true.
+    # Gets or sets a value indicating whether fields should be updated before saving the document to a fixed page format. The default value is true.
     attr_accessor :update_fields
 
-    # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastPrinted
-    # property is updated before saving.
+    # Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastPrinted property is updated before saving.
     attr_accessor :update_last_printed_property
 
-    # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime property is updated before saving.
+    # Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime property is updated before saving.
     attr_accessor :update_last_saved_time_property
 
-    # Gets or sets value determining whether content of StructuredDocumentTag is updated before saving.
+    # Gets or sets a value indicating whether content of StructuredDocumentTag is updated before saving.
     attr_accessor :update_sdt_content
 
-    # Gets or sets controls zip output or not.
-    # Default value is false.
+    # Gets or sets a value indicating whether to zip output or not.
+    # The default value is false.
     attr_accessor :zip_output
 
-    # Gets or sets a value determining how colors are rendered.
+    # Gets or sets the value determining how colors are rendered.
     # { Normal | Grayscale}.
     attr_accessor :color_mode
 
-    # Gets or sets determines the quality of the JPEG images inside PDF document.
+    # Gets or sets the quality of the JPEG images inside PDF document.
     attr_accessor :jpeg_quality
 
-    # Gets or sets allows to specify metafile rendering options.
+    # Gets or sets the metafile rendering options.
     attr_accessor :metafile_rendering_options
 
-    # Gets or sets indicates the symbol set that is used to represent numbers while rendering to fixed page formats.
+    # Gets or sets the symbol set, that is used to represent numbers while rendering to fixed page formats.
     attr_accessor :numeral_format
 
-    # Gets or sets flag indicates whether it is required to optimize output of XPS.
+    # Gets or sets a value indicating whether it is required to optimize output of XPS.
     # If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formatting are concatenated.
-    # Note: The accuracy of the content display may be affected if this property is set to true.  Default is false.
+    # Note: The accuracy of the content display may be affected if this property is set to true.. The default value is false.
     attr_accessor :optimize_output
 
-    # Gets or sets determines number of pages to render.
+    # Gets or sets the number of pages to render.
     attr_accessor :page_count
 
-    # Gets or sets determines 0-based index of the first page to render.
+    # Gets or sets the 0-based index of the first page to render.
     attr_accessor :page_index
 
     class EnumAttributeValidator

data/lib/aspose_words_cloud/models/font.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="font.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,52 +27,51 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # Font element.
+  # DTO container with a font element.
   class Font
-    # Gets or sets link to the document.
+    # Gets or sets the link to the document.
     attr_accessor :link
 
-    # Gets or sets true if the font is formatted as all capital letters.
+    # Gets or sets a value indicating whether the font is formatted as all capital letters.
     attr_accessor :all_caps
 
-    # Gets or sets specifies whether the contents of this run shall have right-to-left characteristics.
+    # Gets or sets a value indicating whether the contents of this run shall have right-to-left characteristics.
     attr_accessor :bidi
 
-    # Gets or sets true if the font is formatted as bold.
+    # Gets or sets a value indicating whether the font is formatted as bold.
     attr_accessor :bold
 
-    # Gets or sets true if the right-to-left text is formatted as bold.
+    # Gets or sets a value indicating whether the right-to-left text is formatted as bold.
     attr_accessor :bold_bi
 
-    # Gets or sets border object that specifies border for the font.
+    # Gets or sets the border object, that specifies border for the font.
     attr_accessor :border
 
     # Gets or sets the color of the font.
     attr_accessor :color
 
-    # Gets or sets specifies whether the contents of this run shall be treated as complex script text regardless
-    # of their Unicode character values when determining the formatting for this run.
+    # Gets or sets a value indicating whether the contents of this run shall be treated as complex script text regardless of their Unicode character values when determining the formatting for this run.
     attr_accessor :complex_script
 
-    # Gets or sets true if the font is formatted as double strikethrough text.
+    # Gets or sets a value indicating whether the font is formatted as double strikethrough text.
     attr_accessor :double_strike_through
 
-    # Gets or sets true if the font is formatted as embossed.
+    # Gets or sets a value indicating whether the font is formatted as embossed.
     attr_accessor :emboss
 
-    # Gets or sets true if the font is formatted as engraved.
+    # Gets or sets a value indicating whether the font is formatted as engraved.
     attr_accessor :engrave
 
-    # Gets or sets true if the font is formatted as hidden text.
+    # Gets or sets a value indicating whether the font is formatted as hidden text.
     attr_accessor :hidden
 
     # Gets or sets the highlight (marker) color.
     attr_accessor :highlight_color
 
-    # Gets or sets true if the font is formatted as italic.
+    # Gets or sets a value indicating whether the font is formatted as italic.
     attr_accessor :italic
 
-    # Gets or sets true if the right-to-left text is formatted as italic.
+    # Gets or sets a value indicating whether the right-to-left text is formatted as italic.
     attr_accessor :italic_bi
 
     # Gets or sets the font size at which kerning starts.
@@ -90,22 +89,22 @@ module AsposeWordsCloud
     # Gets or sets the name of the font.
     attr_accessor :name
 
-    # Gets or sets returns or sets the font used for Latin text (characters with character codes from 0 (zero) through 127).
+    # Gets or sets the font used for Latin text (characters with character codes from 0 (zero) through 127).
     attr_accessor :name_ascii
 
-    # Gets or sets returns or sets the name of the font in a right-to-left language document.
+    # Gets or sets the name of the font in a right-to-left language document.
     attr_accessor :name_bi
 
-    # Gets or sets returns or sets an East Asian font name.
+    # Gets or sets the East Asian font name.
     attr_accessor :name_far_east
 
-    # Gets or sets returns or sets the font used for characters with character codes from 128 through 255.
+    # Gets or sets the font used for characters with character codes from 128 through 255.
     attr_accessor :name_other
 
-    # Gets or sets true when the formatted characters are not to be spell checked.
+    # Gets or sets a value indicating whether the formatted characters are not to be spell checked.
     attr_accessor :no_proofing
 
-    # Gets or sets true if the font is formatted as outline.
+    # Gets or sets a value indicating whether the font is formatted as outline.
     attr_accessor :outline
 
     # Gets or sets the position of text (in points) relative to the base line.
@@ -115,7 +114,7 @@ module AsposeWordsCloud
     # Gets or sets character width scaling in percent.
     attr_accessor :scaling
 
-    # Gets or sets true if the font is formatted as shadowed.
+    # Gets or sets a value indicating whether the font is formatted as shadowed.
     attr_accessor :shadow
 
     # Gets or sets the font size in points.
@@ -124,13 +123,13 @@ module AsposeWordsCloud
     # Gets or sets the font size in points used in a right-to-left document.
     attr_accessor :size_bi
 
-    # Gets or sets true if the font is formatted as small capital letters.
+    # Gets or sets a value indicating whether the font is formatted as small capital letters.
     attr_accessor :small_caps
 
-    # Gets or sets returns or sets the spacing (in points) between characters.
+    # Gets or sets the spacing (in points) between characters.
     attr_accessor :spacing
 
-    # Gets or sets true if the font is formatted as strikethrough text.
+    # Gets or sets a value indicating whether the font is formatted as strikethrough text.
     attr_accessor :strike_through
 
     # Gets or sets the locale independent style identifier of the character style applied to this formatting.
@@ -139,10 +138,10 @@ module AsposeWordsCloud
     # Gets or sets the name of the character style applied to this formatting.
     attr_accessor :style_name
 
-    # Gets or sets true if the font is formatted as subscript.
+    # Gets or sets a value indicating whether the font is formatted as subscript.
     attr_accessor :subscript
 
-    # Gets or sets true if the font is formatted as superscript.
+    # Gets or sets a value indicating whether the font is formatted as superscript.
     attr_accessor :superscript
 
     # Gets or sets the font animation effect.

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