aspose_words_cloud 20.7.0 → 21.1.0

data/lib/aspose_words_cloud/models/epub_save_options_data.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="epub_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,171 +29,167 @@ module AsposeWordsCloud
 
   # Container class for epub save options.
   class EpubSaveOptionsData
-    # 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 specifies whether negative left and right indents of paragraphs are allowed (not normalized).
+    # Gets or sets a value indicating whether negative left and right indents of paragraphs are allowed (not normalized).
     attr_accessor :allow_negative_indent
 
-    # Gets or sets specifies a prefix which is added to all CSS class names. Default value is an empty string and generated CSS class names have no common prefix.
+    # Gets or sets the prefix which is added to all CSS class names. The default value is an empty string and generated CSS class names have no common prefix.
     # If this value is not empty, all CSS classes generated by Aspose.Words will start with the specified prefix.This might be useful, for example, if you add custom CSS to generated documents and want to prevent class name conflicts.
     # If the value is not null or empty, it must be a valid CSS identifier.
     attr_accessor :css_class_name_prefix
 
-    # Gets or sets specifies the name of the CSS file written when the document is exported to HTML.
+    # Gets or sets the name of the CSS file written when the document is exported to HTML.
     attr_accessor :css_style_sheet_file_name
 
-    # Gets or sets specifies how CSS styles are exported.
+    # Gets or sets the option that controls how the CSS styles are exported.
     attr_accessor :css_style_sheet_type
 
-    # Gets or sets specifies how the document should be split when saving.
+    # Gets or sets the option that controls how the document should be split when saving.
     attr_accessor :document_split_criteria
 
-    # Gets or sets specifies the maximum level of headings at which to split the document.
+    # Gets or sets the maximum level of headings at which to split the document.
     attr_accessor :document_split_heading_level
 
-    # Gets or sets specifies the encoding to use when exporting.
+    # Gets or sets the character encoding to use when exporting.
     attr_accessor :encoding
 
-    # Gets or sets specifies whether to export built-in and custom document properties.
+    # Gets or sets a value indicating whether to export built-in and custom document properties.
     attr_accessor :export_document_properties
 
-    # Gets or sets controls how drop-down form fields are saved to HTML.
-    # Default value is false.
+    # Gets or sets the flag, that controls how drop-down form fields are saved to HTML.
+    # The default value is false.
     attr_accessor :export_drop_down_form_field_as_text
 
-    # Gets or sets specifies whether font resources should be exported.
+    # Gets or sets a value indicating whether font resources should be exported.
     attr_accessor :export_font_resources
 
-    # Gets or sets specifies whether fonts resources should be embedded to HTML in Base64 encoding.  Default is false.
+    # Gets or sets a value indicating whether fonts resources should be embedded to HTML in Base64 encoding. The default value is false.
     attr_accessor :export_fonts_as_base64
 
-    # Gets or sets specifies how headers and footers are output.
+    # Gets or sets the option that controls how headers and footers are exported.
     attr_accessor :export_headers_footers_mode
 
-    # Gets or sets specifies whether images are saved in Base64 format.
+    # Gets or sets a value indicating whether images are saved in Base64 format.
     attr_accessor :export_images_as_base64
 
-    # Gets or sets specifies whether language information is exported.
+    # Gets or sets a value indicating whether language information is exported.
     attr_accessor :export_language_information
 
-    # Gets or sets controls how list labels are output.
+    # Gets or sets the option that controls how list labels are exported.
     attr_accessor :export_list_labels
 
-    # Gets or sets specifies whether original URL should be used as the URL of the linked images.
-    # Default value is false.
+    # Gets or sets a value indicating whether the original URL should be used as the URL of the linked images.
+    # The default value is false.
     attr_accessor :export_original_url_for_linked_images
 
-    # Gets or sets specifies whether page margins is exported to HTML, MHTML or EPUB.
-    # Default is false.
+    # Gets or sets a value indicating whether page margins are exported to HTML, MHTML or EPUB.
+    # The default value is false.
     attr_accessor :export_page_margins
 
-    # Gets or sets specifies whether page setup is exported.
+    # Gets or sets a value indicating whether page setup is exported.
     attr_accessor :export_page_setup
 
-    # Gets or sets specifies whether font sizes should be output in relative units when saving.
+    # Gets or sets a value indicating whether font sizes should be output in relative units when saving.
     attr_accessor :export_relative_font_size
 
-    # Gets or sets specifies whether to write the roundtrip information when saving to HTML
-    # Default value is true.
+    # Gets or sets a value indicating whether to write the roundtrip information when saving to HTML. The default value is true.
     attr_accessor :export_roundtrip_information
 
-    # Gets or sets controls how textboxes represented by Aspose.Words.Drawing.Shape are saved to HTML, MHTML or EPUB. Default value is false.
+    # Gets or sets the flag, that controls how textboxes represented by Aspose.Words.Drawing.Shape are saved to HTML, MHTML or EPUB. The default value is false.
     # When set to true, exports textboxes as inline "svg" elements. When false, exports as "image" elements.
     attr_accessor :export_text_box_as_svg
 
-    # Gets or sets controls how text input form fields are saved.
+    # Gets or sets the flag, that controls how text input form fields are saved.
     attr_accessor :export_text_input_form_field_as_text
 
-    # Gets or sets specifies whether to write page numbers to table of contents when saving.
+    # Gets or sets a value indicating whether to write page numbers to table of contents when saving.
     attr_accessor :export_toc_page_numbers
 
-    # Gets or sets specifies whether to write the DOCTYPE declaration when saving.
+    # Gets or sets a value indicating whether to write the DOCTYPE declaration when saving.
     attr_accessor :export_xhtml_transitional
 
-    # Gets or sets controls which font resources need subsetting when saving.
+    # Gets or sets the option that controls which font resources need subsetting when saving.
     attr_accessor :font_resources_subsetting_size_threshold
 
-    # Gets or sets specifies the physical folder where fonts are saved when exporting a document.
+    # Gets or sets the physical folder where fonts are saved when exporting a document.
     attr_accessor :fonts_folder
 
-    # Gets or sets specifies the name of the folder used to construct font URIs.
+    # Gets or sets the name of the folder used to construct font URIs.
     attr_accessor :fonts_folder_alias
 
-    # Gets or sets specifies version of HTML standard that should be used when saving the document to HTML or MHTML.
+    # Gets or sets the version of HTML standard, that should be used when saving the document to HTML or MHTML.
     # Default value is Aspose.Words.Saving.HtmlVersion.Xhtml.
     attr_accessor :html_version
 
-    # Gets or sets specifies the output resolution for images when exporting.
+    # Gets or sets the output resolution for images when exporting.
     attr_accessor :image_resolution
 
-    # Gets or sets specifies the physical folder where images are saved when exporting a document.
+    # Gets or sets the physical folder where images are saved when exporting a document.
     attr_accessor :images_folder
 
-    # Gets or sets specifies the name of the folder used to construct image URIs.
+    # Gets or sets the name of the folder used to construct image URIs.
     attr_accessor :images_folder_alias
 
-    # Gets or sets specifies in what format metafiles are saved when exporting to HTML, MHTML, or EPUB.
-    # Default value is Aspose.Words.Saving.HtmlMetafileFormat.Png, meaning that metafiles are rendered to raster PNG images.
+    # Gets or sets the options, that controls in what format metafiles are saved when exporting to HTML, MHTML, or EPUB.
+    # The default value is Aspose.Words.Saving.HtmlMetafileFormat.Png, meaning that metafiles are rendered to raster PNG images.
     # Metafiles are not natively displayed by HTML browsers. By default, Aspose.Words converts WMF and EMF images into PNG files when exporting to HTML.Other options are to convert metafiles to SVG images or to export them as is without conversion.
     # Some image transforms, in particular image cropping, will not be applied to metafile images if they are exported to HTML without conversion.
     attr_accessor :metafile_format
 
-    # Gets or sets controls how OfficeMath objects are exported to HTML, MHTML or EPUB.  Default value is HtmlOfficeMathOutputMode.Image.
+    # Gets or sets the option that controls how OfficeMath objects are exported to HTML, MHTML or EPUB. The default value is HtmlOfficeMathOutputMode.Image.
     attr_accessor :office_math_output_mode
 
-    # Gets or sets specifies whether or not use pretty formats output.
+    # Gets or sets a value indicating whether to use pretty formats output.
     attr_accessor :pretty_format
 
-    # Gets or sets specifies whether font family names used in the document are resolved and substituted according to FontSettings when being written into HTML-based formats.
-    # default value is false.
+    # Gets or sets a value indicating whether font family names used in the document are resolved and substituted according to FontSettings when being written into HTML-based formats.
+    # The default value is false.
     attr_accessor :resolve_font_names
 
-    # Gets or sets specifies a physical folder where all resources like images, fonts, and external CSS are saved when a document is exported to HTML. Default is an empty string.
+    # Gets or sets the physical folder where all resources like images, fonts, and external CSS are saved when a document is exported to HTML. The default value is an empty string.
     attr_accessor :resource_folder
 
-    # Gets or sets specifies the name of the folder used to construct URIs of all resources written into an HTML document.  Default is an empty string.
+    # Gets or sets the name of the folder used to construct URIs of all resources written into HTML document. The default value is an empty string.
     attr_accessor :resource_folder_alias
 
-    # Gets or sets specifies whether images are scaled by Aspose.Words to the bounding shape size when exporting.
+    # Gets or sets a value indicating whether images are scaled by Aspose.Words to the bounding shape size when exporting.
     attr_accessor :scale_image_to_shape_size
 
-    # Gets or sets controls how table, row and cell widths are exported.
+    # Gets or sets the option that controls how table, row and cell widths are exported.
     attr_accessor :table_width_output_mode
 
-    # Gets or sets specifies the maximum level of headings populated to the navigation map when exporting.
+    # Gets or sets the maximum level of headings populated to the navigation map when exporting.
     attr_accessor :epub_navigation_map_level
 
     class EnumAttributeValidator

data/lib/aspose_words_cloud/models/error.rb

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

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

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="field.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,21 +27,21 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # Field.
+  # DTO container with a field.
   class Field
-    # 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 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
 
-    # Gets or sets field result.
+    # Gets or sets the field result.
     attr_accessor :result
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/field_base.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="field_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,10 +29,10 @@ module AsposeWordsCloud
 
   # Field.
   class FieldBase
-    # 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/field_collection.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="field_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
 
-  # Represents DTO for collection of fields.
+  # DTO container with a collection of fields.
   class FieldCollection
-    # Gets or sets link to the document.
+    # Gets or sets the link to the document.
     attr_accessor :link
 
-    # Gets or sets collection of fields.
+    # Gets or sets the collection of fields.
     attr_accessor :list
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/field_insert.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="field_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,10 +29,10 @@ module AsposeWordsCloud
 
   # Field for insert.
   class FieldInsert
-    # 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/field_link.rb

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

data/lib/aspose_words_cloud/models/field_names.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose" file="field_names.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 collection of merge fields within a document.
   class FieldNames
-    # Gets or sets link to the document.
+    # Gets or sets the link to the document.
     attr_accessor :link
 
-    # Gets or sets collection of fields names.
+    # Gets or sets the collection of fields names.
     attr_accessor :names
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/field_names_response.rb

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

data/lib/aspose_words_cloud/models/field_response.rb

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