aspose_words_cloud 20.7.0 → 21.1.0

data/lib/aspose_words_cloud/models/compare_data.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="compare_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,13 +29,13 @@ module AsposeWordsCloud
 
   # Container class for compare documents.
   class CompareData
-    # Gets or sets initials of the author to use for revisions.
+    # Gets or sets the initials of the author to use for revisions.
     attr_accessor :author
 
     # Gets or sets the compare options.
     attr_accessor :compare_options
 
-    # Gets or sets path to document to compare at the server.
+    # Gets or sets the path to document to compare at the server.
     attr_accessor :comparing_with_document
 
     # Gets or sets the date and time to use for revisions.

data/lib/aspose_words_cloud/models/compare_options.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="compare_options.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,40 +27,33 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # Container class for compare documents options.
+  # DTO container with compare documents options.
   class CompareOptions
-    # Gets or sets a value indicating whether true indicates that documents comparison is case insensitive. By default comparison is case sensitive.
+    # Gets or sets a value indicating whether documents comparison is case insensitive. By default comparison is case sensitive.
     attr_accessor :ignore_case_changes
 
-    # Gets or sets a value indicating whether specifies whether to compare differences in comments. By default comments are
-    # not ignored.
+    # Gets or sets a value indicating whether comments content is ignored. By default comments are not ignored.
     attr_accessor :ignore_comments
 
-    # Gets or sets a value indicating whether specifies whether to compare differences in fields. By default fields are not
-    # ignored.
+    # Gets or sets a value indicating whether fields content is ignored. By default fields are not ignored.
     attr_accessor :ignore_fields
 
-    # Gets or sets a value indicating whether specifies whether to compare differences in footnotes and endnotes. By default
-    # footnotes are not ignored.
+    # Gets or sets a value indicating whether footnotes/endnotes content is ignored. By default footnotes/endnotes are not ignored.
     attr_accessor :ignore_footnotes
 
-    # Gets or sets a value indicating whether true indicates that formatting is ignored. By default document formatting is
-    # not ignored.
+    # Gets or sets a value indicating whether formatting is ignored. By default document formatting is not ignored.
     attr_accessor :ignore_formatting
 
-    # Gets or sets a value indicating whether true indicates that headers and footers content is ignored. By default headers
-    # and footers are not ignored.
+    # Gets or sets a value indicating whether headers and footers content is ignored. By default headers and footers are not ignored.
     attr_accessor :ignore_headers_and_footers
 
-    # Gets or sets a value indicating whether specifies whether to compare the differences in data contained in tables. By
-    # default tables are not ignored.
+    # Gets or sets a value indicating whether tables content is ignored. By default tables are not ignored.
     attr_accessor :ignore_tables
 
-    # Gets or sets a value indicating whether specifies whether to compare differences in the data contained within text boxes.
-    # By default textboxes are not ignored.
+    # Gets or sets a value indicating whether textboxes content is ignored. By default textboxes are not ignored.
     attr_accessor :ignore_textboxes
 
-    # Gets or sets specifies which document shall be used as a target during comparison.
+    # Gets or sets the option that controls which document shall be used as a target during comparison.
     attr_accessor :target
 
     class EnumAttributeValidator

data/lib/aspose_words_cloud/models/csv_data_load_options.rb

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="doc_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
@@ -27,55 +27,52 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # container class for doc/dot save options.
+  # Container class for doc/dot save options.
   class DocSaveOptionsData
-    # 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 When false, small metafiles are not compressed for performance reason.
-    # Default value is true, all metafiles are compressed regardless of its size.
+    # Gets or sets a value indicating when False, that small metafiles are not compressed for performance reason.
+    # The default value is true, all metafiles are compressed regardless of its size.
     attr_accessor :always_compress_metafiles
 
-    # Gets or sets password.
+    # Gets or sets the password.
     attr_accessor :password
 
-    # Gets or sets When false, PictureBullet data is not saved to output document.
-    # Default value is true.
+    # Gets or sets a value indicating when False, that PictureBullet data is not saved to the output document.
+    # The default value is true.
     attr_accessor :save_picture_bullet
 
-    # Gets or sets determine whether or not save RoutingSlip data saved to output document.
+    # Gets or sets a value indicating whether to save RoutingSlip data to output document.
     attr_accessor :save_routing_slip
 
     class EnumAttributeValidator

data/lib/aspose_words_cloud/models/document.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="document.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,20 +29,19 @@ module AsposeWordsCloud
 
   # Represents Words document DTO.
   class Document
-    # Gets or sets returns document properties.
+    # Gets or sets the document properties.
     attr_accessor :document_properties
 
     # Gets or sets the name of the file.
     attr_accessor :file_name
 
-    # Gets or sets a value indicating whether returns true if the document is encrypted and requires a password to open.
+    # Gets or sets a value indicating whether the document is encrypted and requires a password to open.
     attr_accessor :is_encrypted
 
-    # Gets or sets a value indicating whether returns true if the document contains a digital signature. This property merely informs that a
-    # digital signature is present on a document, but it does not specify whether the signature is valid or not.
+    # Gets or sets a value indicating whether the document contains a digital signature. This property merely informs that a digital signature is present on a document, but it does not specify whether the signature is valid or not.
     attr_accessor :is_signed
 
-    # Gets or sets a list of links that originate from this document.
+    # Gets or sets the list of links that originate from this document.
     attr_accessor :links
 
     # Gets or sets the original format of the document.

data/lib/aspose_words_cloud/models/document_entry.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="document_entry.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
 
   # Represents a document which will be appended to the original resource document.
   class DocumentEntry
-    # Gets or sets path to document to append at the server.
+    # Gets or sets the path to document to append at the server.
     attr_accessor :href
 
-    # Gets or sets defines which formatting will be used: appended or destination document.Can be KeepSourceFormatting or UseDestinationStyles.
+    # Gets or sets the option that controls formatting will be used: appended or destination document. Can be KeepSourceFormatting or UseDestinationStyles.
     attr_accessor :import_format_mode
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/document_entry_list.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="document_entry_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
@@ -29,11 +29,15 @@ module AsposeWordsCloud
 
   # Represents a list of documents which will be appended to the original resource document.
   class DocumentEntryList
-    # Gets or sets list of documents.
+    # Gets or sets a value indicating whether to apply headers and footers from base document to appending documents. The default value is true.
+    attr_accessor :apply_base_document_headers_and_footers_to_appending_documents
+
+    # Gets or sets the list of documents.
     attr_accessor :document_entries
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'apply_base_document_headers_and_footers_to_appending_documents' => :'ApplyBaseDocumentHeadersAndFootersToAppendingDocuments',
         :'document_entries' => :'DocumentEntries'
       }
     end
@@ -41,6 +45,7 @@ module AsposeWordsCloud
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'apply_base_document_headers_and_footers_to_appending_documents' => :'BOOLEAN',
         :'document_entries' => :'Array<DocumentEntry>'
       }
     end
@@ -53,6 +58,10 @@ module AsposeWordsCloud
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
+      if attributes.key?(:'ApplyBaseDocumentHeadersAndFootersToAppendingDocuments')
+        self.apply_base_document_headers_and_footers_to_appending_documents = attributes[:'ApplyBaseDocumentHeadersAndFootersToAppendingDocuments']
+      end
+
       if attributes.key?(:'DocumentEntries')
         if (value = attributes[:'DocumentEntries']).is_a?(Array)
           self.document_entries = value
@@ -78,6 +87,7 @@ module AsposeWordsCloud
     def ==(other)
       return true if self.equal?(other)
       self.class == other.class &&
+          apply_base_document_headers_and_footers_to_appending_documents == other.apply_base_document_headers_and_footers_to_appending_documents &&
           document_entries == other.document_entries
     end
 
@@ -90,7 +100,7 @@ module AsposeWordsCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [document_entries].hash
+      [apply_base_document_headers_and_footers_to_appending_documents, document_entries].hash
     end
 
     # Builds the object from hash

data/lib/aspose_words_cloud/models/document_position.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="document_position.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
 
-  # Represents a position in the document tree.
+  # DTO container with a position in the document tree.
   class DocumentPosition
-    # Gets or sets link to  node.
+    # Gets or sets the link to a node.
     attr_accessor :node
 
-    # Gets or sets offset into the node.
+    # Gets or sets the offset in the node.
     attr_accessor :offset
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/document_properties.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="document_properties.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 document properties.
+  # The collection of document properties.
   class DocumentProperties
-    # Gets or sets link to the document.
+    # Gets or sets the link to the document.
     attr_accessor :link
 
-    # Gets or sets collection of document properties.
+    # Gets or sets the collection of document properties.
     attr_accessor :list
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/document_properties_response.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="document_properties_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,12 +27,12 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # This response should be returned by the service when handling:  GET /documentProperties.
+  # The REST response with a collection of document properties.
   class DocumentPropertiesResponse
-    # Gets or sets request Id.
+    # Gets or sets the request Id.
     attr_accessor :request_id
 
-    # Gets or sets collection of document properties.
+    # Gets or sets the collection of document properties.
     attr_accessor :document_properties
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/document_property.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="document_property.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
 
   # Words document property DTO.
   class DocumentProperty
-    # Gets or sets link to the document.
+    # Gets or sets the link to the document.
     attr_accessor :link
 
-    # Gets or sets a value indicating whether flag indicates whether the property is built-in or not.
+    # Gets or sets a value indicating whether the property is built-in or not.
     # If true the property is built-in, if false the property is custom.
     attr_accessor :built_in
 
-    # Gets or sets name of the document property.
+    # Gets or sets the name of the document property.
     attr_accessor :name
 
-    # Gets or sets string value of the document property.
+    # Gets or sets the value of the document property.
     attr_accessor :value
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/document_property_base.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="document_property_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,7 +29,7 @@ module AsposeWordsCloud
 
   # Words document property DTO base class.
   class DocumentPropertyBase
-    # Gets or sets string value of the document property.
+    # Gets or sets the value of the document property.
     attr_accessor :value
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/document_property_create_or_update.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="document_property_create_or_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,7 +29,7 @@ module AsposeWordsCloud
 
   # Words document property DTO for create or update.
   class DocumentPropertyCreateOrUpdate
-    # Gets or sets string value of the document property.
+    # Gets or sets the value of the document property.
     attr_accessor :value
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/document_property_response.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="document_property_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,12 +27,12 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # This response should be returned by the service when handling:  GET documentProperties/{propertyName}.
+  # The REST response with a document property.
   class DocumentPropertyResponse
-    # Gets or sets request Id.
+    # Gets or sets the request Id.
     attr_accessor :request_id
 
-    # Gets or sets document property.
+    # Gets or sets the document property.
     attr_accessor :document_property
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map