aspose_words_cloud 23.9.0 → 23.10.0

data/lib/aspose_words_cloud/models/responses/insert_list_online_response.rb

@@ -29,7 +29,8 @@ module AsposeWordsCloud
   # Response model for insert_list_online operation.
   #
   class InsertListOnlineResponse
-    # The response model.
+    # The REST response with a list information.
+    # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/lists/{n}" REST API requests.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/insert_or_update_paragraph_tab_stop_online_response.rb

@@ -29,7 +29,8 @@ module AsposeWordsCloud
   # Response model for insert_or_update_paragraph_tab_stop_online operation.
   #
   class InsertOrUpdateParagraphTabStopOnlineResponse
-    # The response model.
+    # The REST response with an array of tab stops.
+    # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/paragraphs/{0}/tabstops" REST API requests.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/insert_page_numbers_online_response.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Response model for insert_page_numbers_online operation.
   #
   class InsertPageNumbersOnlineResponse
-    # The response model.
+    # The REST response with a document description.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/insert_paragraph_online_response.rb

@@ -29,7 +29,8 @@ module AsposeWordsCloud
   # Response model for insert_paragraph_online operation.
   #
   class InsertParagraphOnlineResponse
-    # The response model.
+    # The REST response with a paragraph.
+    # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/paragraphs/{0}" REST API requests.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/insert_run_online_response.rb

@@ -29,7 +29,8 @@ module AsposeWordsCloud
   # Response model for insert_run_online operation.
   #
   class InsertRunOnlineResponse
-    # The response model.
+    # The REST response with a Run element.
+    # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/paragraphs/{0}/runs/{1}" REST API requests.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/insert_structured_document_tag_online_response.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Response model for insert_structured_document_tag_online operation.
   #
   class InsertStructuredDocumentTagOnlineResponse
-    # The response model.
+    # The REST response with a StructuredDocumentTag.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/insert_style_online_response.rb

@@ -29,7 +29,8 @@ module AsposeWordsCloud
   # Response model for insert_style_online operation.
   #
   class InsertStyleOnlineResponse
-    # The response model.
+    # The REST response with a style.
+    # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/styles/{0}" REST API requests.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/insert_table_cell_online_response.rb

@@ -29,7 +29,8 @@ module AsposeWordsCloud
   # Response model for insert_table_cell_online operation.
   #
   class InsertTableCellOnlineResponse
-    # The response model.
+    # The REST response with a table cell.
+    # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/tables/{0}" REST API requests.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/insert_table_online_response.rb

@@ -29,7 +29,8 @@ module AsposeWordsCloud
   # Response model for insert_table_online operation.
   #
   class InsertTableOnlineResponse
-    # The response model.
+    # The REST response with a table.
+    # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/tables/{0}" REST API requests.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/insert_table_row_online_response.rb

@@ -29,7 +29,8 @@ module AsposeWordsCloud
   # Response model for insert_table_row_online operation.
   #
   class InsertTableRowOnlineResponse
-    # The response model.
+    # The REST response with a table row.
+    # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/tables/{0}" REST API requests.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/insert_watermark_image_online_response.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Response model for insert_watermark_image_online operation.
   #
   class InsertWatermarkImageOnlineResponse
-    # The response model.
+    # The REST response with a document description.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/insert_watermark_text_online_response.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Response model for insert_watermark_text_online operation.
   #
   class InsertWatermarkTextOnlineResponse
-    # The response model.
+    # The REST response with a document description.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/protect_document_online_response.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Response model for protect_document_online operation.
   #
   class ProtectDocumentOnlineResponse
-    # The response model.
+    # The REST response with data on document's protection.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/reject_all_revisions_online_response.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Response model for reject_all_revisions_online operation.
   #
   class RejectAllRevisionsOnlineResponse
-    # The response model.
+    # The REST response with a result of the modification operations for the revisions collection (now these are acceptAll and rejectAll).
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/remove_range_online_response.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Response model for remove_range_online operation.
   #
   class RemoveRangeOnlineResponse
-    # The response model.
+    # The REST response with a document description.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/replace_text_online_response.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Response model for replace_text_online operation.
   #
   class ReplaceTextOnlineResponse
-    # The response model.
+    # The REST response with a number of occurrences of the captured text in the document.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/replace_with_text_online_response.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Response model for replace_with_text_online operation.
   #
   class ReplaceWithTextOnlineResponse
-    # The response model.
+    # The REST response with a document description.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/save_as_online_response.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Response model for save_as_online operation.
   #
   class SaveAsOnlineResponse
-    # The response model.
+    # The REST response with a save result.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/save_as_range_online_response.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Response model for save_as_range_online operation.
   #
   class SaveAsRangeOnlineResponse
-    # The response model.
+    # The REST response with a document description.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/save_as_tiff_online_response.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Response model for save_as_tiff_online operation.
   #
   class SaveAsTiffOnlineResponse
-    # The response model.
+    # The REST response with a save result.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/split_document_online_response.rb

@@ -29,7 +29,8 @@ module AsposeWordsCloud
   # Response model for split_document_online operation.
   #
   class SplitDocumentOnlineResponse
-    # The response model.
+    # The REST response with a result of document splitting.
+    # This response should be returned by the service when handling: POST /{name}/split.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/unprotect_document_online_response.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Response model for unprotect_document_online operation.
   #
   class UnprotectDocumentOnlineResponse
-    # The response model.
+    # The REST response with data on document's protection.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/update_bookmark_online_response.rb

@@ -29,7 +29,8 @@ module AsposeWordsCloud
   # Response model for update_bookmark_online operation.
   #
   class UpdateBookmarkOnlineResponse
-    # The response model.
+    # The REST response with a bookmark.
+    # This response should be returned by the service when handling: GET bookmarks/{bookmarkName}.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/update_border_online_response.rb

@@ -29,7 +29,8 @@ module AsposeWordsCloud
   # Response model for update_border_online operation.
   #
   class UpdateBorderOnlineResponse
-    # The response model.
+    # The REST response with a border.
+    # This response is returned by the Service when handling "GET {nodeWithBorders}/borders" REST API requests.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/update_comment_online_response.rb

@@ -29,7 +29,8 @@ module AsposeWordsCloud
   # Response model for update_comment_online operation.
   #
   class UpdateCommentOnlineResponse
-    # The response model.
+    # The REST response with a comment.
+    # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/comments/0" REST API requests.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/update_custom_xml_part_online_response.rb

@@ -29,7 +29,8 @@ module AsposeWordsCloud
   # Response model for update_custom_xml_part_online operation.
   #
   class UpdateCustomXmlPartOnlineResponse
-    # The response model.
+    # The REST response with a custom xml part.
+    # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/customXmlParts/0" REST API requests.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/update_drawing_object_online_response.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Response model for update_drawing_object_online operation.
   #
   class UpdateDrawingObjectOnlineResponse
-    # The response model.
+    # The REST response with a DrawingObject.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/update_field_online_response.rb

@@ -29,7 +29,8 @@ module AsposeWordsCloud
   # Response model for update_field_online operation.
   #
   class UpdateFieldOnlineResponse
-    # The response model.
+    # The REST response with a field.
+    # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/paragraphs/{0}/fields/{1}" REST API requests.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/update_fields_online_response.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Response model for update_fields_online operation.
   #
   class UpdateFieldsOnlineResponse
-    # The response model.
+    # The REST response with a document description.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/update_footnote_online_response.rb

@@ -29,7 +29,8 @@ module AsposeWordsCloud
   # Response model for update_footnote_online operation.
   #
   class UpdateFootnoteOnlineResponse
-    # The response model.
+    # The REST response with a footnote.
+    # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/footnote/0" REST API requests.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/update_form_field_online_response.rb

@@ -29,7 +29,8 @@ module AsposeWordsCloud
   # Response model for update_form_field_online operation.
   #
   class UpdateFormFieldOnlineResponse
-    # The response model.
+    # The REST response with a form field.
+    # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/paragraphs/{0}/form fields/{1}" REST API requests.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/update_list_level_online_response.rb

@@ -29,7 +29,8 @@ module AsposeWordsCloud
   # Response model for update_list_level_online operation.
   #
   class UpdateListLevelOnlineResponse
-    # The response model.
+    # The REST response with a list information.
+    # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/lists/{n}" REST API requests.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/update_list_online_response.rb

@@ -29,7 +29,8 @@ module AsposeWordsCloud
   # Response model for update_list_online operation.
   #
   class UpdateListOnlineResponse
-    # The response model.
+    # The REST response with a list information.
+    # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/lists/{n}" REST API requests.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/update_paragraph_format_online_response.rb

@@ -29,7 +29,8 @@ module AsposeWordsCloud
   # Response model for update_paragraph_format_online operation.
   #
   class UpdateParagraphFormatOnlineResponse
-    # The response model.
+    # The REST response with the formatting properties of a paragraph.
+    # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/paragraphs/{0}/format" REST API requests.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/update_paragraph_list_format_online_response.rb

@@ -29,7 +29,8 @@ module AsposeWordsCloud
   # Response model for update_paragraph_list_format_online operation.
   #
   class UpdateParagraphListFormatOnlineResponse
-    # The response model.
+    # The REST response with a list format for a paragraph.
+    # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/paragraphs/{0}/listFormat" REST API requests.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/update_run_font_online_response.rb

@@ -29,7 +29,8 @@ module AsposeWordsCloud
   # Response model for update_run_font_online operation.
   #
   class UpdateRunFontOnlineResponse
-    # The response model.
+    # The REST response with a font.
+    # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/paragraphs/{0}/runs/{1}/font" REST API requests.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/update_run_online_response.rb

@@ -29,7 +29,8 @@ module AsposeWordsCloud
   # Response model for update_run_online operation.
   #
   class UpdateRunOnlineResponse
-    # The response model.
+    # The REST response with a Run element.
+    # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/paragraphs/{0}/runs/{1}" REST API requests.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/update_section_page_setup_online_response.rb

@@ -29,7 +29,8 @@ module AsposeWordsCloud
   # Response model for update_section_page_setup_online operation.
   #
   class UpdateSectionPageSetupOnlineResponse
-    # The response model.
+    # The REST response with a page setup of a section.
+    # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/sections/{0}/PageSetup" REST API requests.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/update_structured_document_tag_online_response.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Response model for update_structured_document_tag_online operation.
   #
   class UpdateStructuredDocumentTagOnlineResponse
-    # The response model.
+    # The REST response with a StructuredDocumentTag.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/update_style_online_response.rb

@@ -29,7 +29,8 @@ module AsposeWordsCloud
   # Response model for update_style_online operation.
   #
   class UpdateStyleOnlineResponse
-    # The response model.
+    # The REST response with a style.
+    # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/styles/{0}" REST API requests.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/update_table_cell_format_online_response.rb

@@ -29,7 +29,8 @@ module AsposeWordsCloud
   # Response model for update_table_cell_format_online operation.
   #
   class UpdateTableCellFormatOnlineResponse
-    # The response model.
+    # The REST response with the formatting properties of a table cell.
+    # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/tables/{0}/rows/{1}/cells/{2}/cellformat" REST API requests.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/update_table_properties_online_response.rb

@@ -29,7 +29,8 @@ module AsposeWordsCloud
   # Response model for update_table_properties_online operation.
   #
   class UpdateTablePropertiesOnlineResponse
-    # The response model.
+    # The REST response with a table.
+    # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/tables/{0}/properties" REST API requests.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/responses/update_table_row_format_online_response.rb

@@ -29,7 +29,8 @@ module AsposeWordsCloud
   # Response model for update_table_row_format_online operation.
   #
   class UpdateTableRowFormatOnlineResponse
-    # The response model.
+    # The REST response with the formatting properties of a table row.
+    # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/tables/{0}/rows/{1}/rowformat" REST API requests.
     attr_accessor :model
 
     # The document after modification.

data/lib/aspose_words_cloud/models/rtf_save_options_data.rb

@@ -30,25 +30,34 @@ module AsposeWordsCloud
   # Container class for rtf save options.
   class RtfSaveOptionsData
     # Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is false..
+    # Note, Word does not embed PostScript fonts, but can open documents with embedded fonts of this type.
+    # This option only works when Aspose.Words.Fonts.FontInfoCollection.EmbedTrueTypeFonts of the Aspose.Words.DocumentBase.FontInfos property is set to true.
+    # The default value is false.
     attr_accessor :allow_embedding_post_script_fonts
 
     # Gets or sets CustomTimeZoneInfo.
     attr_accessor :custom_time_zone_info_data
 
     # Gets or sets the value determining how 3D effects are rendered.
+    # The default value is Aspose.Words.Saving.Dml3DEffectsRenderingMode.Basic.
     attr_accessor :dml3_d_effects_rendering_mode
 
     # Gets or sets the value determining how DrawingML effects are rendered.
     # { Simplified | None | Fine }.
+    # The default value is Simplified.
+    # This property is used when the document is exported to fixed page formats.
     attr_accessor :dml_effects_rendering_mode
 
     # Gets or sets the option that controls how DrawingML shapes are rendered.
+    # { Fallback | DrawingML }. The default value is Fallback.
+    # This property is used when the document is exported to fixed page formats.
     attr_accessor :dml_rendering_mode
 
     # Gets or sets the name of destination file.
     attr_accessor :file_name
 
     # Gets or sets the value determining how ink (InkML) objects are rendered.
+    # The default value is Aspose.Words.Saving.ImlRenderingMode.InkML.
     attr_accessor :iml_rendering_mode
 
     # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.CreatedTime property is updated before saving.
@@ -62,10 +71,12 @@ module AsposeWordsCloud
     attr_accessor :update_last_printed_property
 
     # Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime property is updated before saving.
+    # The default value is false.
     attr_accessor :update_last_saved_time_property
 
     # Gets or sets a value indicating whether to zip output or not.
     # The default value is false.
+    # When set to true, output files will be zipped.
     attr_accessor :zip_output
 
     # Gets or sets a value indicating whether to make output RTF documents smaller in size, but if they contain RTL (right-to-left) text, it will not be displayed correctly.

data/lib/aspose_words_cloud/models/run_response.rb

@@ -28,6 +28,7 @@ require 'date'
 module AsposeWordsCloud
 
   # The REST response with a Run element.
+  # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/paragraphs/{0}/runs/{1}" REST API requests.
   class RunResponse
     # Gets or sets the request Id.
     attr_accessor :request_id

data/lib/aspose_words_cloud/models/runs_response.rb

@@ -28,6 +28,7 @@ require 'date'
 module AsposeWordsCloud
 
   # The REST response with a collection of Run elements.
+  # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/{paragraphPath}/runs" REST API requests.
   class RunsResponse
     # Gets or sets the request Id.
     attr_accessor :request_id

data/lib/aspose_words_cloud/models/search_response.rb

@@ -28,6 +28,7 @@ require 'date'
 module AsposeWordsCloud
 
   # The REST response with a regular expression pattern and a collection of search results.
+  # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/search" REST API requests.
   class SearchResponse
     # Gets or sets the request Id.
     attr_accessor :request_id

data/lib/aspose_words_cloud/models/section_link_collection_response.rb

@@ -28,6 +28,7 @@ require 'date'
 module AsposeWordsCloud
 
   # The REST response with a collection of sections.
+  # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/sections" REST API requests.
   class SectionLinkCollectionResponse
     # Gets or sets the request Id.
     attr_accessor :request_id

data/lib/aspose_words_cloud/models/section_page_setup_response.rb

@@ -28,6 +28,7 @@ require 'date'
 module AsposeWordsCloud
 
   # The REST response with a page setup of a section.
+  # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/sections/{0}/PageSetup" REST API requests.
   class SectionPageSetupResponse
     # Gets or sets the request Id.
     attr_accessor :request_id

data/lib/aspose_words_cloud/models/section_response.rb

@@ -28,6 +28,7 @@ require 'date'
 module AsposeWordsCloud
 
   # The REST response with a section.
+  # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/sections/{0}" REST API requests.
   class SectionResponse
     # Gets or sets the request Id.
     attr_accessor :request_id

data/lib/aspose_words_cloud/models/split_document_response.rb

@@ -28,6 +28,7 @@ require 'date'
 module AsposeWordsCloud
 
   # The REST response with a result of document splitting.
+  # This response should be returned by the service when handling: POST /{name}/split.
   class SplitDocumentResponse
     # Gets or sets the request Id.
     attr_accessor :request_id