aspose_words_cloud 20.10.0 → 20.11.0

data/lib/aspose_words_cloud/models/preferred_width.rb

@@ -27,7 +27,7 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # Preferred width.
+  # DTO container with a preferred width value.
   class PreferredWidth
     # Gets or sets the unit of measure used for this preferred width value.
     attr_accessor :type

data/lib/aspose_words_cloud/models/protection_data_response.rb

@@ -27,15 +27,15 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # Response for the request of data about protection.
+  # The REST response with data on document's protection.
   class ProtectionDataResponse
-    # Gets or sets request Id.
+    # Gets or sets the request Id.
     attr_accessor :request_id
 
-    # Gets or sets link to the document.
+    # Gets or sets the link to the document.
     attr_accessor :document_link
 
-    # Gets or sets protection's data of the document.
+    # Gets or sets the protection properties of the document.
     attr_accessor :protection_data
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/protection_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
 
   # Request on changing of protection.
   class ProtectionRequest
-    # Gets or sets new password.
+    # Gets or sets the new password.
     attr_accessor :new_password
 
-    # Gets or sets current password.
+    # Gets or sets the current password.
     attr_accessor :password
 
-    # Gets or sets new type of protection.
+    # Gets or sets the new type of protection.
     attr_accessor :protection_type
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/ps_save_options_data.rb

@@ -27,68 +27,65 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # container class for ps save options.
+  # Container class for ps save options.
   class PsSaveOptionsData
-    # 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
 
-    # Gets or sets determines whether the document should be saved using a booklet printing layout.
+    # Gets or sets a value indicating whether the document should be saved using a booklet printing layout.
     attr_accessor :use_book_fold_printing_settings
 
     class EnumAttributeValidator

data/lib/aspose_words_cloud/models/range_document.rb

@@ -27,9 +27,9 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # Range element.
+  # DTO container with a Range element.
   class RangeDocument
-    # Gets or sets name for new document.
+    # Gets or sets the name for a new document.
     attr_accessor :document_name
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/range_text_response.rb

@@ -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/range/{0}/{1}/.
+  # The REST response with a range's text.
   class RangeTextResponse
-    # Gets or sets request Id.
+    # Gets or sets the request Id.
     attr_accessor :request_id
 
-    # Gets or sets text from range.
+    # Gets or sets the range's text.
     attr_accessor :text
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/replace_range.rb

@@ -27,12 +27,12 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # Range element.
+  # DTO container with a range element.
   class ReplaceRange
-    # Gets or sets range's text.
+    # Gets or sets the range's text.
     attr_accessor :text
 
-    # Gets or sets range's text type.
+    # Gets or sets the range's text type.
     attr_accessor :text_type
 
     class EnumAttributeValidator

data/lib/aspose_words_cloud/models/replace_text_parameters.rb

@@ -38,10 +38,10 @@ module AsposeWordsCloud
     # Gets or sets a value indicating whether flag, means that OldValue contains regex expression.
     attr_accessor :is_old_value_regex
 
-    # Gets or sets new text value to replace by.
+    # Gets or sets the new text value to replace by.
     attr_accessor :new_value
 
-    # Gets or sets old text value (or regex pattern IsOldValueRegex) to replace.
+    # Gets or sets the old text value (or regex pattern IsOldValueRegex) to replace.
     attr_accessor :old_value
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/replace_text_response.rb

@@ -27,15 +27,15 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # Response for "Replace text" action.
+  # The REST response with a number of occurrences of the captured text in the document.
   class ReplaceTextResponse
-    # Gets or sets request Id.
+    # Gets or sets the request Id.
     attr_accessor :request_id
 
-    # Gets or sets link to the document.
+    # Gets or sets the link to the document.
     attr_accessor :document_link
 
-    # Gets or sets number of occurrences of the captured text in the document.
+    # Gets or sets the number of occurrences of the captured text in the document.
     attr_accessor :matches
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/report_engine_settings.rb

@@ -29,10 +29,10 @@ module AsposeWordsCloud
 
   # Report engine settings.
   class ReportEngineSettings
-    # Gets or sets options for parsing CSV data.
+    # Gets or sets the options for parsing CSV data.
     attr_accessor :csv_data_load_options
 
-    # Gets or sets a name to reference the data source object in the template.
+    # Gets or sets the name to reference the data source object in the template.
     attr_accessor :data_source_name
 
     # Gets or sets type of datasource.

data/lib/aspose_words_cloud/models/requests/accept_all_revisions_request.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Request model for accept_all_revisions operation.
   #
   class AcceptAllRevisionsRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Original document folder.
@@ -49,7 +49,7 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param name The filename of the input document.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

data/lib/aspose_words_cloud/models/requests/append_document_request.rb

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for append_document operation.
   #
   class AppendDocumentRequest
-    # Original document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # DocumentEntryList with a list of documents to append.
+    # The collection of documents to append.
     attr_accessor :document_list
 
     # Original document folder.
@@ -58,8 +58,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name Original document name.
-    # @param document_list DocumentEntryList with a list of documents to append.
+    # @param name The filename of the input document.
+    # @param document_list The collection of documents to append.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

data/lib/aspose_words_cloud/models/requests/apply_style_to_document_element_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for apply_style_to_document_element operation.
   #
   class ApplyStyleToDocumentElementRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Style to apply.
+    # The style to apply.
     attr_accessor :style_apply
 
-    # The path to the node that supports a style. Supported node types: ParagraphFormat, List, ListLevel, Table.
+    # The path to the node in the document tree, that supports styles: ParagraphFormat, List, ListLevel, Table.
     attr_accessor :styled_node_path
 
     # Original document folder.
@@ -61,9 +61,9 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param style_apply Style to apply.
-    # @param styled_node_path The path to the node that supports a style. Supported node types: ParagraphFormat, List, ListLevel, Table.
+    # @param name The filename of the input document.
+    # @param style_apply The style to apply.
+    # @param styled_node_path The path to the node in the document tree, that supports styles: ParagraphFormat, List, ListLevel, Table.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

data/lib/aspose_words_cloud/models/requests/build_report_online_request.rb

@@ -38,7 +38,7 @@ module AsposeWordsCloud
     # An object providing a settings of report engine.
     attr_accessor :report_engine_settings
 
-    # This file name will be used when resulting document has dynamic field for document file name {filename}. If it is not set, "template" will be used instead.
+    # The filename of the output document, that will be used when the resulting document has a dynamic field {filename}. If it is not set, the "template" will be used instead.
     attr_accessor :document_file_name
 
     #
@@ -46,7 +46,7 @@ module AsposeWordsCloud
     # @param template File with template.
     # @param data A string providing a data to populate the specified template. The string must be of one of the following types: xml, json, csv.
     # @param report_engine_settings An object providing a settings of report engine.
-    # @param document_file_name This file name will be used when resulting document has dynamic field for document file name {filename}. If it is not set, "template" will be used instead.
+    # @param document_file_name The filename of the output document, that will be used when the resulting document has a dynamic field {filename}. If it is not set, the "template" will be used instead.
 
     def initialize(template, data, report_engine_settings, document_file_name = nil)
       self.template = template

data/lib/aspose_words_cloud/models/requests/build_report_request.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Request model for build_report operation.
   #
   class BuildReportRequest
-    # The template name.
+    # The filename of the input document.
     attr_accessor :name
 
     # A string providing a data to populate the specified template. The string must be of one of the following types: xml, json, csv.
@@ -50,19 +50,19 @@ module AsposeWordsCloud
     # Password for opening an encrypted document.
     attr_accessor :password
 
-    # Result name of the document after the operation. If this parameter is omitted then result of the operation will be saved with autogenerated name.
+    # The filename of the output document. If this parameter is omitted, the result will be saved with autogenerated name.
     attr_accessor :dest_file_name
 
     #
     # Initializes a new instance.
-    # @param name The template name.
+    # @param name The filename of the input document.
     # @param data A string providing a data to populate the specified template. The string must be of one of the following types: xml, json, csv.
     # @param report_engine_settings An object providing a settings of report engine.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     # @param password Password for opening an encrypted document.
-    # @param dest_file_name Result name of the document after the operation. If this parameter is omitted then result of the operation will be saved with autogenerated name.
+    # @param dest_file_name The filename of the output document. If this parameter is omitted, the result will be saved with autogenerated name.
 
     def initialize(name, data, report_engine_settings, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil)
       self.name = name

data/lib/aspose_words_cloud/models/requests/classify_document_request.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Request model for classify_document operation.
   #
   class ClassifyDocumentRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :document_name
 
     # Original document folder.
@@ -44,21 +44,21 @@ module AsposeWordsCloud
     # Password for opening an encrypted document.
     attr_accessor :password
 
-    # Count of the best classes to return.
+    # The number of the best classes to return.
     attr_accessor :best_classes_count
 
-    # Taxonomy to use for classification return.
+    # The taxonomy to use.
     attr_accessor :taxonomy
 
     #
     # Initializes a new instance.
-    # @param document_name The document name.
+    # @param document_name The filename of the input document.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     # @param password Password for opening an encrypted document.
-    # @param best_classes_count Count of the best classes to return.
-    # @param taxonomy Taxonomy to use for classification return.
+    # @param best_classes_count The number of the best classes to return.
+    # @param taxonomy The taxonomy to use.
 
     def initialize(document_name, folder = nil, storage = nil, load_encoding = nil, password = nil, best_classes_count = nil, taxonomy = nil)
       self.document_name = document_name

data/lib/aspose_words_cloud/models/requests/classify_request.rb

@@ -29,16 +29,16 @@ module AsposeWordsCloud
   # Request model for classify operation.
   #
   class ClassifyRequest
-    # Text to classify.
+    # The text to classify.
     attr_accessor :text
 
-    # Number of the best classes to return.
+    # The number of the best classes to return.
     attr_accessor :best_classes_count
 
     #
     # Initializes a new instance.
-    # @param text Text to classify.
-    # @param best_classes_count Number of the best classes to return.
+    # @param text The text to classify.
+    # @param best_classes_count The number of the best classes to return.
 
     def initialize(text, best_classes_count = nil)
       self.text = text

data/lib/aspose_words_cloud/models/requests/compare_document_request.rb

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for compare_document operation.
   #
   class CompareDocumentRequest
-    # Original document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # CompareData with a document to compare.
+    # The properties of the document to compare with.
     attr_accessor :compare_data
 
     # Original document folder.
@@ -52,8 +52,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name Original document name.
-    # @param compare_data CompareData with a document to compare.
+    # @param name The filename of the input document.
+    # @param compare_data The properties of the document to compare with.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

data/lib/aspose_words_cloud/models/requests/convert_document_request.rb

@@ -32,16 +32,16 @@ module AsposeWordsCloud
     # Converting document.
     attr_accessor :document
 
-    # Format to convert.
+    # The format to convert.
     attr_accessor :format
 
     # Original document storage.
     attr_accessor :storage
 
-    # Path for saving operation result to the local storage.
+    # The path to the output document on a local storage.
     attr_accessor :out_path
 
-    # This file name will be used when resulting document has dynamic field for document file name {filename}. If it is not set, "sourceFilename" will be used instead.
+    # The filename of the output document, that will be used when the resulting document has a dynamic field {filename}. If it is not set, the "sourceFilename" will be used instead.
     attr_accessor :file_name_field_value
 
     # Folder in filestorage with custom fonts.
@@ -50,10 +50,10 @@ module AsposeWordsCloud
     #
     # Initializes a new instance.
     # @param document Converting document.
-    # @param format Format to convert.
+    # @param format The format to convert.
     # @param storage Original document storage.
-    # @param out_path Path for saving operation result to the local storage.
-    # @param file_name_field_value This file name will be used when resulting document has dynamic field for document file name {filename}. If it is not set, "sourceFilename" will be used instead.
+    # @param out_path The path to the output document on a local storage.
+    # @param file_name_field_value The filename of the output document, that will be used when the resulting document has a dynamic field {filename}. If it is not set, the "sourceFilename" will be used instead.
     # @param fonts_location Folder in filestorage with custom fonts.
 
     def initialize(document, format, storage = nil, out_path = nil, file_name_field_value = nil, fonts_location = nil)