cloudmersive-convert-api-client 1.6.5 → 1.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31c3b9486b0fb3e997dfe4154dc594e663cfa34b2d0178aad7b0e5006e1f1b4c
-  data.tar.gz: ed42cfd522a8022cd2a5c70fb5fa7511f0b14d160cf9f831d8d7434e0a7b31fb
+  metadata.gz: facc7ac024b01cf5b5296585db5a2dcd45056528f394746523542bbc854c826c
+  data.tar.gz: 664dec7f3e0c323f51edbb050e9bce8daf9a29daeec380fe050c15228d9f2fd2
 SHA512:
-  metadata.gz: 31eb5abdbb51f33f14bf0f14cc88926fbfd5f3263ef24b9801cb06a12fb22019fbdab2e3322deec92efc6a17739dc82dfe1cb5441ec9eec37e807b0697cb54ea
-  data.tar.gz: 4a4dc57cd8bb31311232fd3e98d5fe9c02383d1b19d0a7ab27b6b1dc685f4a65afffaa13b1f254fbdef79f6bfbb1170004d8865f2b974cfa6925e4334b7ce761
+  metadata.gz: 2ebd02c4b2d689a280b62876e5d0f8558ab753c5cbdac7560cc2d068883ce0b6293cf2953d310917475d343e1eace3bb6651e56e5edc141ec1405dca97acaf46
+  data.tar.gz: 49f463075940c4271df5061f2bb35f0f6bf6ea26171fa02433a0b6001ad80ebc456ea4490d6a5ec74e40e2d45c4d31150898186d6ff254db96cf63c6a2a36e83

data/README.md

@@ -7,7 +7,7 @@ Convert API lets you effortlessly convert file formats and types.
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: v1
-- Package version: 1.6.5
+- Package version: 1.6.6
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -23,15 +23,15 @@ gem build cloudmersive-convert-api-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./cloudmersive-convert-api-client-1.6.5.gem
+gem install ./cloudmersive-convert-api-client-1.6.6.gem
 ```
-(for development, run `gem install --dev ./cloudmersive-convert-api-client-1.6.5.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cloudmersive-convert-api-client-1.6.6.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'cloudmersive-convert-api-client', '~> 1.6.5'
+    gem 'cloudmersive-convert-api-client', '~> 1.6.6'
 
 ### Install from Git
 
@@ -151,6 +151,8 @@ Class | Method | HTTP request | Description
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_delete_pages**](docs/EditDocumentApi.md#edit_document_docx_delete_pages) | **POST** /convert/edit/docx/delete-pages | Delete, remove pages from a Word DOCX document
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_delete_table_row**](docs/EditDocumentApi.md#edit_document_docx_delete_table_row) | **POST** /convert/edit/docx/delete-table-row | Deletes a table row in an existing table in a Word DOCX document
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_delete_table_row_range**](docs/EditDocumentApi.md#edit_document_docx_delete_table_row_range) | **POST** /convert/edit/docx/delete-table-row/range | Deletes a range of multiple table rows in an existing table in a Word DOCX document
+*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_comments**](docs/EditDocumentApi.md#edit_document_docx_get_comments) | **POST** /convert/edit/docx/get-comments/flat-list | Get comments from a Word DOCX document as a flat list
+*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_comments_hierarchical**](docs/EditDocumentApi.md#edit_document_docx_get_comments_hierarchical) | **POST** /convert/edit/docx/get-comments/hierarchical | Get comments from a Word DOCX document hierarchically
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_headers_and_footers**](docs/EditDocumentApi.md#edit_document_docx_get_headers_and_footers) | **POST** /convert/edit/docx/get-headers-and-footers | Get content of a footer from a Word DOCX document
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_images**](docs/EditDocumentApi.md#edit_document_docx_get_images) | **POST** /convert/edit/docx/get-images | Get images from a Word DOCX document
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_sections**](docs/EditDocumentApi.md#edit_document_docx_get_sections) | **POST** /convert/edit/docx/get-sections | Get sections from a Word DOCX document
@@ -158,6 +160,7 @@ Class | Method | HTTP request | Description
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_table_by_index**](docs/EditDocumentApi.md#edit_document_docx_get_table_by_index) | **POST** /convert/edit/docx/get-table/by-index | Get a specific table by index in a Word DOCX document
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_table_row**](docs/EditDocumentApi.md#edit_document_docx_get_table_row) | **POST** /convert/edit/docx/get-table-row | Gets the contents of an existing table row in an existing table in a Word DOCX document
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_tables**](docs/EditDocumentApi.md#edit_document_docx_get_tables) | **POST** /convert/edit/docx/get-tables | Get all tables in Word DOCX document
+*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_insert_comment_on_paragraph**](docs/EditDocumentApi.md#edit_document_docx_insert_comment_on_paragraph) | **POST** /convert/edit/docx/insert-comment/on/paragraph | Insert a new comment into a Word DOCX document attached to a paragraph
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_insert_image**](docs/EditDocumentApi.md#edit_document_docx_insert_image) | **POST** /convert/edit/docx/insert-image | Insert image into a Word DOCX document
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_insert_paragraph**](docs/EditDocumentApi.md#edit_document_docx_insert_paragraph) | **POST** /convert/edit/docx/insert-paragraph | Insert a new paragraph into a Word DOCX document
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_insert_table**](docs/EditDocumentApi.md#edit_document_docx_insert_table) | **POST** /convert/edit/docx/insert-table | Insert a new table into a Word DOCX document
@@ -255,9 +258,11 @@ Class | Method | HTTP request | Description
  - [CloudmersiveConvertApiClient::DocumentValidationResult](docs/DocumentValidationResult.md)
  - [CloudmersiveConvertApiClient::DocxBody](docs/DocxBody.md)
  - [CloudmersiveConvertApiClient::DocxCellStyle](docs/DocxCellStyle.md)
+ - [CloudmersiveConvertApiClient::DocxComment](docs/DocxComment.md)
  - [CloudmersiveConvertApiClient::DocxFooter](docs/DocxFooter.md)
  - [CloudmersiveConvertApiClient::DocxHeader](docs/DocxHeader.md)
  - [CloudmersiveConvertApiClient::DocxImage](docs/DocxImage.md)
+ - [CloudmersiveConvertApiClient::DocxInsertCommentOnParagraphRequest](docs/DocxInsertCommentOnParagraphRequest.md)
  - [CloudmersiveConvertApiClient::DocxInsertImageRequest](docs/DocxInsertImageRequest.md)
  - [CloudmersiveConvertApiClient::DocxInsertImageResponse](docs/DocxInsertImageResponse.md)
  - [CloudmersiveConvertApiClient::DocxPage](docs/DocxPage.md)
@@ -278,10 +283,15 @@ Class | Method | HTTP request | Description
  - [CloudmersiveConvertApiClient::DocxTemplateApplicationRequest](docs/DocxTemplateApplicationRequest.md)
  - [CloudmersiveConvertApiClient::DocxTemplateOperation](docs/DocxTemplateOperation.md)
  - [CloudmersiveConvertApiClient::DocxText](docs/DocxText.md)
+ - [CloudmersiveConvertApiClient::DocxTopLevelComment](docs/DocxTopLevelComment.md)
  - [CloudmersiveConvertApiClient::ExifValue](docs/ExifValue.md)
  - [CloudmersiveConvertApiClient::FinishEditingRequest](docs/FinishEditingRequest.md)
  - [CloudmersiveConvertApiClient::GetDocxBodyRequest](docs/GetDocxBodyRequest.md)
  - [CloudmersiveConvertApiClient::GetDocxBodyResponse](docs/GetDocxBodyResponse.md)
+ - [CloudmersiveConvertApiClient::GetDocxCommentsHierarchicalResponse](docs/GetDocxCommentsHierarchicalResponse.md)
+ - [CloudmersiveConvertApiClient::GetDocxCommentsResponse](docs/GetDocxCommentsResponse.md)
+ - [CloudmersiveConvertApiClient::GetDocxGetCommentsHierarchicalRequest](docs/GetDocxGetCommentsHierarchicalRequest.md)
+ - [CloudmersiveConvertApiClient::GetDocxGetCommentsRequest](docs/GetDocxGetCommentsRequest.md)
  - [CloudmersiveConvertApiClient::GetDocxHeadersAndFootersRequest](docs/GetDocxHeadersAndFootersRequest.md)
  - [CloudmersiveConvertApiClient::GetDocxHeadersAndFootersResponse](docs/GetDocxHeadersAndFootersResponse.md)
  - [CloudmersiveConvertApiClient::GetDocxImagesRequest](docs/GetDocxImagesRequest.md)
@@ -323,6 +333,7 @@ Class | Method | HTTP request | Description
  - [CloudmersiveConvertApiClient::HtmlToPngRequest](docs/HtmlToPngRequest.md)
  - [CloudmersiveConvertApiClient::HtmlToTextRequest](docs/HtmlToTextRequest.md)
  - [CloudmersiveConvertApiClient::HtmlToTextResponse](docs/HtmlToTextResponse.md)
+ - [CloudmersiveConvertApiClient::InsertDocxCommentOnParagraphResponse](docs/InsertDocxCommentOnParagraphResponse.md)
  - [CloudmersiveConvertApiClient::InsertDocxInsertParagraphRequest](docs/InsertDocxInsertParagraphRequest.md)
  - [CloudmersiveConvertApiClient::InsertDocxInsertParagraphResponse](docs/InsertDocxInsertParagraphResponse.md)
  - [CloudmersiveConvertApiClient::InsertDocxTableRowRequest](docs/InsertDocxTableRowRequest.md)

data/docs/DocxComment.md

@@ -0,0 +1,16 @@
+# CloudmersiveConvertApiClient::DocxComment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**path** | **String** | Path to the comment in the document | [optional] 
+**author** | **String** | Author name of the comment | [optional] 
+**author_initials** | **String** | Initials of the author of the comment | [optional] 
+**comment_text** | **String** | Text content of the comment | [optional] 
+**comment_date** | **DateTime** | Date timestamp of the comment | [optional] 
+**is_top_level** | **BOOLEAN** | True if the comment is at the top level, false if this comment is a child reply of another comment | [optional] 
+**is_reply** | **BOOLEAN** | True if this comment is a reply to another comment, false otherwise | [optional] 
+**parent_comment_path** | **String** | Path to the parent of this comment, if this comment is a reply, otherwise this value will be null | [optional] 
+**done** | **BOOLEAN** | True if this comment is marked as Done in Word, otherwise it is false | [optional] 
+
+

data/docs/DocxInsertCommentOnParagraphRequest.md

@@ -0,0 +1,11 @@
+# CloudmersiveConvertApiClient::DocxInsertCommentOnParagraphRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_file_bytes** | **String** | Optional: Bytes of the input file to operate on | [optional] 
+**input_file_url** | **String** | Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public). | [optional] 
+**paragraph_path** | **String** | Path to the paragraph to attach the comment to.  You can get the Path by retrieving all of the Paragraphs in document by calling Get Body and taking the Path property of the desired paragraph to add the comment to. | [optional] 
+**comment_to_insert** | [**DocxComment**](DocxComment.md) | Comment to insert | [optional] 
+
+

data/docs/DocxTopLevelComment.md

@@ -0,0 +1,14 @@
+# CloudmersiveConvertApiClient::DocxTopLevelComment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**path** | **String** | Path to the comment in the document | [optional] 
+**author** | **String** | Author name of the comment | [optional] 
+**author_initials** | **String** | Initials of the author of the comment | [optional] 
+**comment_text** | **String** | Text content of the comment | [optional] 
+**comment_date** | **DateTime** | Date timestamp of the comment | [optional] 
+**reply_child_comments** | [**Array<DocxComment>**](DocxComment.md) | Child comments, that are replies to this one | [optional] 
+**done** | **BOOLEAN** | True if this comment is marked as Done in Word, otherwise it is false | [optional] 
+
+

data/docs/EditDocumentApi.md

@@ -10,6 +10,8 @@ Method | HTTP request | Description
 [**edit_document_docx_delete_pages**](EditDocumentApi.md#edit_document_docx_delete_pages) | **POST** /convert/edit/docx/delete-pages | Delete, remove pages from a Word DOCX document
 [**edit_document_docx_delete_table_row**](EditDocumentApi.md#edit_document_docx_delete_table_row) | **POST** /convert/edit/docx/delete-table-row | Deletes a table row in an existing table in a Word DOCX document
 [**edit_document_docx_delete_table_row_range**](EditDocumentApi.md#edit_document_docx_delete_table_row_range) | **POST** /convert/edit/docx/delete-table-row/range | Deletes a range of multiple table rows in an existing table in a Word DOCX document
+[**edit_document_docx_get_comments**](EditDocumentApi.md#edit_document_docx_get_comments) | **POST** /convert/edit/docx/get-comments/flat-list | Get comments from a Word DOCX document as a flat list
+[**edit_document_docx_get_comments_hierarchical**](EditDocumentApi.md#edit_document_docx_get_comments_hierarchical) | **POST** /convert/edit/docx/get-comments/hierarchical | Get comments from a Word DOCX document hierarchically
 [**edit_document_docx_get_headers_and_footers**](EditDocumentApi.md#edit_document_docx_get_headers_and_footers) | **POST** /convert/edit/docx/get-headers-and-footers | Get content of a footer from a Word DOCX document
 [**edit_document_docx_get_images**](EditDocumentApi.md#edit_document_docx_get_images) | **POST** /convert/edit/docx/get-images | Get images from a Word DOCX document
 [**edit_document_docx_get_sections**](EditDocumentApi.md#edit_document_docx_get_sections) | **POST** /convert/edit/docx/get-sections | Get sections from a Word DOCX document
@@ -17,6 +19,7 @@ Method | HTTP request | Description
 [**edit_document_docx_get_table_by_index**](EditDocumentApi.md#edit_document_docx_get_table_by_index) | **POST** /convert/edit/docx/get-table/by-index | Get a specific table by index in a Word DOCX document
 [**edit_document_docx_get_table_row**](EditDocumentApi.md#edit_document_docx_get_table_row) | **POST** /convert/edit/docx/get-table-row | Gets the contents of an existing table row in an existing table in a Word DOCX document
 [**edit_document_docx_get_tables**](EditDocumentApi.md#edit_document_docx_get_tables) | **POST** /convert/edit/docx/get-tables | Get all tables in Word DOCX document
+[**edit_document_docx_insert_comment_on_paragraph**](EditDocumentApi.md#edit_document_docx_insert_comment_on_paragraph) | **POST** /convert/edit/docx/insert-comment/on/paragraph | Insert a new comment into a Word DOCX document attached to a paragraph
 [**edit_document_docx_insert_image**](EditDocumentApi.md#edit_document_docx_insert_image) | **POST** /convert/edit/docx/insert-image | Insert image into a Word DOCX document
 [**edit_document_docx_insert_paragraph**](EditDocumentApi.md#edit_document_docx_insert_paragraph) | **POST** /convert/edit/docx/insert-paragraph | Insert a new paragraph into a Word DOCX document
 [**edit_document_docx_insert_table**](EditDocumentApi.md#edit_document_docx_insert_table) | **POST** /convert/edit/docx/insert-table | Insert a new table into a Word DOCX document
@@ -373,6 +376,114 @@ Name | Type | Description  | Notes
 
 
 
+# **edit_document_docx_get_comments**
+> GetDocxCommentsResponse edit_document_docx_get_comments(req_config)
+
+Get comments from a Word DOCX document as a flat list
+
+Returns the comments and review annotations stored in the Word Document (DOCX) format file as a flattened list (not as a hierarchy of comments and replies).
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-convert-api-client'
+# setup authorization
+CloudmersiveConvertApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
+
+req_config = CloudmersiveConvertApiClient::GetDocxGetCommentsRequest.new # GetDocxGetCommentsRequest | Document input request
+
+
+begin
+  #Get comments from a Word DOCX document as a flat list
+  result = api_instance.edit_document_docx_get_comments(req_config)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling EditDocumentApi->edit_document_docx_get_comments: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **req_config** | [**GetDocxGetCommentsRequest**](GetDocxGetCommentsRequest.md)| Document input request | 
+
+### Return type
+
+[**GetDocxCommentsResponse**](GetDocxCommentsResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
+# **edit_document_docx_get_comments_hierarchical**
+> GetDocxCommentsHierarchicalResponse edit_document_docx_get_comments_hierarchical(req_config)
+
+Get comments from a Word DOCX document hierarchically
+
+Returns the comments and review annotations stored in the Word Document (DOCX) format file hierarchically, where reply comments are nested as children under top-level comments in the results returned.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-convert-api-client'
+# setup authorization
+CloudmersiveConvertApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
+
+req_config = CloudmersiveConvertApiClient::GetDocxGetCommentsHierarchicalRequest.new # GetDocxGetCommentsHierarchicalRequest | Document input request
+
+
+begin
+  #Get comments from a Word DOCX document hierarchically
+  result = api_instance.edit_document_docx_get_comments_hierarchical(req_config)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling EditDocumentApi->edit_document_docx_get_comments_hierarchical: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **req_config** | [**GetDocxGetCommentsHierarchicalRequest**](GetDocxGetCommentsHierarchicalRequest.md)| Document input request | 
+
+### Return type
+
+[**GetDocxCommentsHierarchicalResponse**](GetDocxCommentsHierarchicalResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
 # **edit_document_docx_get_headers_and_footers**
 > GetDocxHeadersAndFootersResponse edit_document_docx_get_headers_and_footers(req_config)
 
@@ -751,6 +862,60 @@ Name | Type | Description  | Notes
 
 
 
+# **edit_document_docx_insert_comment_on_paragraph**
+> InsertDocxCommentOnParagraphResponse edit_document_docx_insert_comment_on_paragraph(req_config)
+
+Insert a new comment into a Word DOCX document attached to a paragraph
+
+Adds a new comment into a Word DOCX document attached to a paragraph and returns the result.  Call Finish Editing on the output URL to complete the operation.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-convert-api-client'
+# setup authorization
+CloudmersiveConvertApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
+
+req_config = CloudmersiveConvertApiClient::DocxInsertCommentOnParagraphRequest.new # DocxInsertCommentOnParagraphRequest | Document input request
+
+
+begin
+  #Insert a new comment into a Word DOCX document attached to a paragraph
+  result = api_instance.edit_document_docx_insert_comment_on_paragraph(req_config)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling EditDocumentApi->edit_document_docx_insert_comment_on_paragraph: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **req_config** | [**DocxInsertCommentOnParagraphRequest**](DocxInsertCommentOnParagraphRequest.md)| Document input request | 
+
+### Return type
+
+[**InsertDocxCommentOnParagraphResponse**](InsertDocxCommentOnParagraphResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
 # **edit_document_docx_insert_image**
 > DocxInsertImageResponse edit_document_docx_insert_image(req_config)
 

data/docs/GetDocxCommentsHierarchicalResponse.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::GetDocxCommentsHierarchicalResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**comments** | [**Array<DocxTopLevelComment>**](DocxTopLevelComment.md) | Comments in the document | [optional] 
+**top_level_comment_count** | **Integer** | The number of comments in the document | [optional] 
+
+

data/docs/GetDocxCommentsResponse.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::GetDocxCommentsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**comments** | [**Array<DocxComment>**](DocxComment.md) | Comments in the document | [optional] 
+**comment_count** | **Integer** | The number of comments in the document | [optional] 
+
+

data/docs/GetDocxGetCommentsHierarchicalRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::GetDocxGetCommentsHierarchicalRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_file_bytes** | **String** | Optional: Bytes of the input file to operate on | [optional] 
+**input_file_url** | **String** | Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public). | [optional] 
+
+

data/docs/GetDocxGetCommentsRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::GetDocxGetCommentsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_file_bytes** | **String** | Optional: Bytes of the input file to operate on | [optional] 
+**input_file_url** | **String** | Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public). | [optional] 
+
+

data/docs/GetDocxPagesResponse.md

@@ -3,8 +3,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**successful** | **BOOLEAN** |  | [optional] 
-**pages** | [**Array<DocxPage>**](DocxPage.md) |  | [optional] 
-**page_count** | **Integer** |  | [optional] 
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**pages** | [**Array<DocxPage>**](DocxPage.md) | Pages in the document | [optional] 
+**page_count** | **Integer** | Count of pages | [optional] 
 
 

data/docs/InsertDocxCommentOnParagraphResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::InsertDocxCommentOnParagraphResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**edited_document_url** | **String** | URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents. | [optional] 
+
+

data/lib/cloudmersive-convert-api-client.rb

@@ -39,9 +39,11 @@ require 'cloudmersive-convert-api-client/models/document_validation_error'
 require 'cloudmersive-convert-api-client/models/document_validation_result'
 require 'cloudmersive-convert-api-client/models/docx_body'
 require 'cloudmersive-convert-api-client/models/docx_cell_style'
+require 'cloudmersive-convert-api-client/models/docx_comment'
 require 'cloudmersive-convert-api-client/models/docx_footer'
 require 'cloudmersive-convert-api-client/models/docx_header'
 require 'cloudmersive-convert-api-client/models/docx_image'
+require 'cloudmersive-convert-api-client/models/docx_insert_comment_on_paragraph_request'
 require 'cloudmersive-convert-api-client/models/docx_insert_image_request'
 require 'cloudmersive-convert-api-client/models/docx_insert_image_response'
 require 'cloudmersive-convert-api-client/models/docx_page'
@@ -62,10 +64,15 @@ require 'cloudmersive-convert-api-client/models/docx_table_row'
 require 'cloudmersive-convert-api-client/models/docx_template_application_request'
 require 'cloudmersive-convert-api-client/models/docx_template_operation'
 require 'cloudmersive-convert-api-client/models/docx_text'
+require 'cloudmersive-convert-api-client/models/docx_top_level_comment'
 require 'cloudmersive-convert-api-client/models/exif_value'
 require 'cloudmersive-convert-api-client/models/finish_editing_request'
 require 'cloudmersive-convert-api-client/models/get_docx_body_request'
 require 'cloudmersive-convert-api-client/models/get_docx_body_response'
+require 'cloudmersive-convert-api-client/models/get_docx_comments_hierarchical_response'
+require 'cloudmersive-convert-api-client/models/get_docx_comments_response'
+require 'cloudmersive-convert-api-client/models/get_docx_get_comments_hierarchical_request'
+require 'cloudmersive-convert-api-client/models/get_docx_get_comments_request'
 require 'cloudmersive-convert-api-client/models/get_docx_headers_and_footers_request'
 require 'cloudmersive-convert-api-client/models/get_docx_headers_and_footers_response'
 require 'cloudmersive-convert-api-client/models/get_docx_images_request'
@@ -107,6 +114,7 @@ require 'cloudmersive-convert-api-client/models/html_to_pdf_request'
 require 'cloudmersive-convert-api-client/models/html_to_png_request'
 require 'cloudmersive-convert-api-client/models/html_to_text_request'
 require 'cloudmersive-convert-api-client/models/html_to_text_response'
+require 'cloudmersive-convert-api-client/models/insert_docx_comment_on_paragraph_response'
 require 'cloudmersive-convert-api-client/models/insert_docx_insert_paragraph_request'
 require 'cloudmersive-convert-api-client/models/insert_docx_insert_paragraph_response'
 require 'cloudmersive-convert-api-client/models/insert_docx_table_row_request'

data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb

@@ -351,6 +351,116 @@ module CloudmersiveConvertApiClient
       return data, status_code, headers
     end
 
+    # Get comments from a Word DOCX document as a flat list
+    # Returns the comments and review annotations stored in the Word Document (DOCX) format file as a flattened list (not as a hierarchy of comments and replies).
+    # @param req_config Document input request
+    # @param [Hash] opts the optional parameters
+    # @return [GetDocxCommentsResponse]
+    def edit_document_docx_get_comments(req_config, opts = {})
+      data, _status_code, _headers = edit_document_docx_get_comments_with_http_info(req_config, opts)
+      return data
+    end
+
+    # Get comments from a Word DOCX document as a flat list
+    # Returns the comments and review annotations stored in the Word Document (DOCX) format file as a flattened list (not as a hierarchy of comments and replies).
+    # @param req_config Document input request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetDocxCommentsResponse, Fixnum, Hash)>] GetDocxCommentsResponse data, response status code and response headers
+    def edit_document_docx_get_comments_with_http_info(req_config, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: EditDocumentApi.edit_document_docx_get_comments ..."
+      end
+      # verify the required parameter 'req_config' is set
+      if @api_client.config.client_side_validation && req_config.nil?
+        fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_get_comments"
+      end
+      # resource path
+      local_var_path = "/convert/edit/docx/get-comments/flat-list"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(req_config)
+      auth_names = ['Apikey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'GetDocxCommentsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_get_comments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get comments from a Word DOCX document hierarchically
+    # Returns the comments and review annotations stored in the Word Document (DOCX) format file hierarchically, where reply comments are nested as children under top-level comments in the results returned.
+    # @param req_config Document input request
+    # @param [Hash] opts the optional parameters
+    # @return [GetDocxCommentsHierarchicalResponse]
+    def edit_document_docx_get_comments_hierarchical(req_config, opts = {})
+      data, _status_code, _headers = edit_document_docx_get_comments_hierarchical_with_http_info(req_config, opts)
+      return data
+    end
+
+    # Get comments from a Word DOCX document hierarchically
+    # Returns the comments and review annotations stored in the Word Document (DOCX) format file hierarchically, where reply comments are nested as children under top-level comments in the results returned.
+    # @param req_config Document input request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetDocxCommentsHierarchicalResponse, Fixnum, Hash)>] GetDocxCommentsHierarchicalResponse data, response status code and response headers
+    def edit_document_docx_get_comments_hierarchical_with_http_info(req_config, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: EditDocumentApi.edit_document_docx_get_comments_hierarchical ..."
+      end
+      # verify the required parameter 'req_config' is set
+      if @api_client.config.client_side_validation && req_config.nil?
+        fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_get_comments_hierarchical"
+      end
+      # resource path
+      local_var_path = "/convert/edit/docx/get-comments/hierarchical"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(req_config)
+      auth_names = ['Apikey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'GetDocxCommentsHierarchicalResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_get_comments_hierarchical\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get content of a footer from a Word DOCX document
     # Returns the footer content from a Word Document (DOCX) format file
     # @param req_config Document input request
@@ -736,6 +846,61 @@ module CloudmersiveConvertApiClient
       return data, status_code, headers
     end
 
+    # Insert a new comment into a Word DOCX document attached to a paragraph
+    # Adds a new comment into a Word DOCX document attached to a paragraph and returns the result.  Call Finish Editing on the output URL to complete the operation.
+    # @param req_config Document input request
+    # @param [Hash] opts the optional parameters
+    # @return [InsertDocxCommentOnParagraphResponse]
+    def edit_document_docx_insert_comment_on_paragraph(req_config, opts = {})
+      data, _status_code, _headers = edit_document_docx_insert_comment_on_paragraph_with_http_info(req_config, opts)
+      return data
+    end
+
+    # Insert a new comment into a Word DOCX document attached to a paragraph
+    # Adds a new comment into a Word DOCX document attached to a paragraph and returns the result.  Call Finish Editing on the output URL to complete the operation.
+    # @param req_config Document input request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InsertDocxCommentOnParagraphResponse, Fixnum, Hash)>] InsertDocxCommentOnParagraphResponse data, response status code and response headers
+    def edit_document_docx_insert_comment_on_paragraph_with_http_info(req_config, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: EditDocumentApi.edit_document_docx_insert_comment_on_paragraph ..."
+      end
+      # verify the required parameter 'req_config' is set
+      if @api_client.config.client_side_validation && req_config.nil?
+        fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_insert_comment_on_paragraph"
+      end
+      # resource path
+      local_var_path = "/convert/edit/docx/insert-comment/on/paragraph"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(req_config)
+      auth_names = ['Apikey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'InsertDocxCommentOnParagraphResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_insert_comment_on_paragraph\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Insert image into a Word DOCX document
     # Set the footer in a Word Document (DOCX).  Call Finish Editing on the output URL to complete the operation.
     # @param req_config Document input request