cloudmersive-convert-api-client 2.2.1 → 2.2.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +25 -8
- data/docs/DocumentEditingEditSession.md +9 -0
- data/docs/DocumentTransformEditSession.md +9 -0
- data/docs/DocxContentControl.md +8 -0
- data/docs/DocxSetFormFieldsRequest.md +10 -0
- data/docs/DocxTableSingleTableFill.md +10 -0
- data/docs/DocxTableTableFillMultiRequest.md +10 -0
- data/docs/EditDocumentApi.md +223 -3
- data/docs/FillHandlebarFormField.md +9 -0
- data/docs/GetDocxContentControlsResponse.md +9 -0
- data/docs/GetDocxGetFormFieldsResponse.md +10 -0
- data/docs/HandlebarFormField.md +8 -0
- data/docs/TransformDocumentApi.md +185 -9
- data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +220 -2
- data/lib/cloudmersive-convert-api-client/api/transform_document_api.rb +183 -6
- data/lib/cloudmersive-convert-api-client/models/document_editing_edit_session.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/document_transform_edit_session.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/docx_content_control.rb +186 -0
- data/lib/cloudmersive-convert-api-client/models/docx_set_form_fields_request.rb +223 -0
- data/lib/cloudmersive-convert-api-client/models/docx_table_single_table_fill.rb +208 -0
- data/lib/cloudmersive-convert-api-client/models/docx_table_table_fill_multi_request.rb +223 -0
- data/lib/cloudmersive-convert-api-client/models/fill_handlebar_form_field.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_content_controls_response.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_get_form_fields_response.rb +210 -0
- data/lib/cloudmersive-convert-api-client/models/handlebar_form_field.rb +186 -0
- data/lib/cloudmersive-convert-api-client/version.rb +1 -1
- data/lib/cloudmersive-convert-api-client.rb +10 -0
- data/spec/api/edit_document_api_spec.rb +49 -1
- data/spec/api/transform_document_api_spec.rb +43 -3
- data/spec/models/document_editing_edit_session_spec.rb +47 -0
- data/spec/models/document_transform_edit_session_spec.rb +47 -0
- data/spec/models/docx_content_control_spec.rb +41 -0
- data/spec/models/docx_set_form_fields_request_spec.rb +53 -0
- data/spec/models/docx_table_single_table_fill_spec.rb +53 -0
- data/spec/models/docx_table_table_fill_multi_request_spec.rb +53 -0
- data/spec/models/fill_handlebar_form_field_spec.rb +47 -0
- data/spec/models/get_docx_content_controls_response_spec.rb +47 -0
- data/spec/models/get_docx_get_form_fields_response_spec.rb +53 -0
- data/spec/models/handlebar_form_field_spec.rb +41 -0
- metadata +32 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 51382a8bbaf965dc823543394e2994c9e1ffe8d10f58da92f609521a474636ff
|
4
|
+
data.tar.gz: 29bd7d56a264fdb5d7543285d30fc13358a5488d1201f4eedba231e4bffee9ae
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4c51daf63a154f1d6b0c2dce4c64c84e562b65a1e70b54039aec31c3a4651ed87cbcc1815ded5156020e051a5c2c9a771fb7d996edb01714a6e3dfeaa7b11fe3
|
7
|
+
data.tar.gz: 42afc653a97fc3ea815c639cc833401ecf8f75f666265498e9275617913f591c95a450a6c750809128a64215c3eb71c8e051aad043961781de9e208403afdfeb
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ Convert API lets you effortlessly convert file formats and types.
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: v1
|
10
|
-
- Package version: 2.2.
|
10
|
+
- Package version: 2.2.5
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,15 +23,15 @@ gem build cloudmersive-convert-api-client.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./cloudmersive-convert-api-client-2.2.
|
26
|
+
gem install ./cloudmersive-convert-api-client-2.2.5.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-convert-api-client-2.2.
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-convert-api-client-2.2.5.gem` to install the development dependencies)
|
29
29
|
|
30
30
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
31
|
|
32
32
|
Finally add this to the Gemfile:
|
33
33
|
|
34
|
-
gem 'cloudmersive-convert-api-client', '~> 2.2.
|
34
|
+
gem 'cloudmersive-convert-api-client', '~> 2.2.5'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -208,6 +208,8 @@ Class | Method | HTTP request | Description
|
|
208
208
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_find_paragraph**](docs/EditDocumentApi.md#edit_document_docx_find_paragraph) | **POST** /convert/edit/docx/find/paragraph | Find matching paragraphs in a Word DOCX document
|
209
209
|
*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
|
210
210
|
*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
|
211
|
+
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_content_controls**](docs/EditDocumentApi.md#edit_document_docx_get_content_controls) | **POST** /convert/edit/docx/get-content-controls | Get all content controls (form fields) and values in a Word DOCX document
|
212
|
+
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_form_fields**](docs/EditDocumentApi.md#edit_document_docx_get_form_fields) | **POST** /convert/edit/docx/get-form-fields | Get all form fields in a Word DOCX document
|
211
213
|
*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
|
212
214
|
*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
|
213
215
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_macro_information**](docs/EditDocumentApi.md#edit_document_docx_get_macro_information) | **POST** /convert/edit/docx/get-macros | Get macro information from a Word DOCX/DOCM document
|
@@ -227,11 +229,13 @@ Class | Method | HTTP request | Description
|
|
227
229
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_remove_headers_and_footers**](docs/EditDocumentApi.md#edit_document_docx_remove_headers_and_footers) | **POST** /convert/edit/docx/remove-headers-and-footers | Remove headers and footers from Word DOCX document
|
228
230
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_remove_object**](docs/EditDocumentApi.md#edit_document_docx_remove_object) | **POST** /convert/edit/docx/remove-object | Delete any object in a Word DOCX document
|
229
231
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_replace**](docs/EditDocumentApi.md#edit_document_docx_replace) | **POST** /convert/edit/docx/replace-all | Replace string in Word DOCX document
|
230
|
-
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_replace_multi**](docs/EditDocumentApi.md#edit_document_docx_replace_multi) | **POST** /convert/edit/docx/replace-all/multi | Replace multiple strings in Word DOCX document
|
232
|
+
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_replace_multi**](docs/EditDocumentApi.md#edit_document_docx_replace_multi) | **POST** /convert/edit/docx/replace-all/multi | Replace multiple strings in Word DOCX document, return result
|
233
|
+
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_replace_multi_edit_session**](docs/EditDocumentApi.md#edit_document_docx_replace_multi_edit_session) | **POST** /convert/edit/docx/replace-all/multi/edit-session | Replace multiple strings in Word DOCX document, return edit session
|
231
234
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_replace_paragraph**](docs/EditDocumentApi.md#edit_document_docx_replace_paragraph) | **POST** /convert/edit/docx/replace/paragraph | Replace matching paragraphs in a Word DOCX document
|
232
235
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_set_custom_metadata_properties**](docs/EditDocumentApi.md#edit_document_docx_set_custom_metadata_properties) | **POST** /convert/edit/docx/set-metadata/custom-property | Set custom property metadata properties in Word DOCX document
|
233
236
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_set_footer**](docs/EditDocumentApi.md#edit_document_docx_set_footer) | **POST** /convert/edit/docx/set-footer | Set the footer in a Word DOCX document
|
234
237
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_set_footer_add_page_number**](docs/EditDocumentApi.md#edit_document_docx_set_footer_add_page_number) | **POST** /convert/edit/docx/set-footer/add-page-number | Add page number to footer in a Word DOCX document
|
238
|
+
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_set_form_fields**](docs/EditDocumentApi.md#edit_document_docx_set_form_fields) | **POST** /convert/edit/docx/set-form-fields | Set and fill values for form fields in a Word DOCX document
|
235
239
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_set_header**](docs/EditDocumentApi.md#edit_document_docx_set_header) | **POST** /convert/edit/docx/set-header | Set the header in a Word DOCX document
|
236
240
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_update_table_cell**](docs/EditDocumentApi.md#edit_document_docx_update_table_cell) | **POST** /convert/edit/docx/update-table-cell | Update, set contents of a table cell in an existing table in a Word DOCX document
|
237
241
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_update_table_row**](docs/EditDocumentApi.md#edit_document_docx_update_table_row) | **POST** /convert/edit/docx/update-table-row | Update, set contents of a table row in an existing table in a Word DOCX document
|
@@ -328,9 +332,12 @@ Class | Method | HTTP request | Description
|
|
328
332
|
*CloudmersiveConvertApiClient::SplitDocumentApi* | [**split_document_txt_by_line**](docs/SplitDocumentApi.md#split_document_txt_by_line) | **POST** /convert/split/txt/by-line | Split a single Text file (txt) into lines
|
329
333
|
*CloudmersiveConvertApiClient::SplitDocumentApi* | [**split_document_txt_by_string**](docs/SplitDocumentApi.md#split_document_txt_by_string) | **POST** /convert/split/txt/by-string | Split a single Text file (txt) by a string delimiter
|
330
334
|
*CloudmersiveConvertApiClient::SplitDocumentApi* | [**split_document_xlsx**](docs/SplitDocumentApi.md#split_document_xlsx) | **POST** /convert/split/xlsx | Split a single Excel XLSX into Separate Worksheets
|
331
|
-
*CloudmersiveConvertApiClient::TransformDocumentApi* | [**transform_document_docx_replace**](docs/TransformDocumentApi.md#transform_document_docx_replace) | **POST** /convert/transform/docx/replace-all | Replace string in Word DOCX document
|
332
|
-
*CloudmersiveConvertApiClient::TransformDocumentApi* | [**
|
333
|
-
*CloudmersiveConvertApiClient::TransformDocumentApi* | [**
|
335
|
+
*CloudmersiveConvertApiClient::TransformDocumentApi* | [**transform_document_docx_replace**](docs/TransformDocumentApi.md#transform_document_docx_replace) | **POST** /convert/transform/docx/replace-all | Replace string in Word DOCX document, return result
|
336
|
+
*CloudmersiveConvertApiClient::TransformDocumentApi* | [**transform_document_docx_replace_edit_session**](docs/TransformDocumentApi.md#transform_document_docx_replace_edit_session) | **POST** /convert/transform/docx/replace-all/edit-session | Replace string in Word DOCX document, return edit session
|
337
|
+
*CloudmersiveConvertApiClient::TransformDocumentApi* | [**transform_document_docx_table_fill_in**](docs/TransformDocumentApi.md#transform_document_docx_table_fill_in) | **POST** /convert/transform/docx/table/fill/data | Fill in data in a table in a Word DOCX document, return result
|
338
|
+
*CloudmersiveConvertApiClient::TransformDocumentApi* | [**transform_document_docx_table_fill_in_edit_session**](docs/TransformDocumentApi.md#transform_document_docx_table_fill_in_edit_session) | **POST** /convert/transform/docx/table/fill/data/edit-session | Fill in data in a table in a Word DOCX document, return edit session
|
339
|
+
*CloudmersiveConvertApiClient::TransformDocumentApi* | [**transform_document_docx_table_fill_in_multi**](docs/TransformDocumentApi.md#transform_document_docx_table_fill_in_multi) | **POST** /convert/transform/docx/table/fill/data/multi | Fill in data in multiple tables in a Word DOCX document, return result
|
340
|
+
*CloudmersiveConvertApiClient::TransformDocumentApi* | [**transform_document_pptx_replace**](docs/TransformDocumentApi.md#transform_document_pptx_replace) | **POST** /convert/transform/pptx/replace-all | Replace string in PowerPoint PPTX presentation, return result
|
334
341
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_autodetect_validation**](docs/ValidateDocumentApi.md#validate_document_autodetect_validation) | **POST** /convert/validate/autodetect | Autodetect content type and validate
|
335
342
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_csv_validation**](docs/ValidateDocumentApi.md#validate_document_csv_validation) | **POST** /convert/validate/csv | Validate a CSV file document (CSV)
|
336
343
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_docx_validation**](docs/ValidateDocumentApi.md#validate_document_docx_validation) | **POST** /convert/validate/docx | Validate a Word document (DOCX)
|
@@ -403,11 +410,14 @@ Class | Method | HTTP request | Description
|
|
403
410
|
- [CloudmersiveConvertApiClient::DetectLineEndingsResponse](docs/DetectLineEndingsResponse.md)
|
404
411
|
- [CloudmersiveConvertApiClient::DisableSharedWorkbookRequest](docs/DisableSharedWorkbookRequest.md)
|
405
412
|
- [CloudmersiveConvertApiClient::DisableSharedWorkbookResponse](docs/DisableSharedWorkbookResponse.md)
|
413
|
+
- [CloudmersiveConvertApiClient::DocumentEditingEditSession](docs/DocumentEditingEditSession.md)
|
414
|
+
- [CloudmersiveConvertApiClient::DocumentTransformEditSession](docs/DocumentTransformEditSession.md)
|
406
415
|
- [CloudmersiveConvertApiClient::DocumentValidationError](docs/DocumentValidationError.md)
|
407
416
|
- [CloudmersiveConvertApiClient::DocumentValidationResult](docs/DocumentValidationResult.md)
|
408
417
|
- [CloudmersiveConvertApiClient::DocxBody](docs/DocxBody.md)
|
409
418
|
- [CloudmersiveConvertApiClient::DocxCellStyle](docs/DocxCellStyle.md)
|
410
419
|
- [CloudmersiveConvertApiClient::DocxComment](docs/DocxComment.md)
|
420
|
+
- [CloudmersiveConvertApiClient::DocxContentControl](docs/DocxContentControl.md)
|
411
421
|
- [CloudmersiveConvertApiClient::DocxFooter](docs/DocxFooter.md)
|
412
422
|
- [CloudmersiveConvertApiClient::DocxHeader](docs/DocxHeader.md)
|
413
423
|
- [CloudmersiveConvertApiClient::DocxImage](docs/DocxImage.md)
|
@@ -425,12 +435,15 @@ Class | Method | HTTP request | Description
|
|
425
435
|
- [CloudmersiveConvertApiClient::DocxSetFooterAddPageNumberRequest](docs/DocxSetFooterAddPageNumberRequest.md)
|
426
436
|
- [CloudmersiveConvertApiClient::DocxSetFooterRequest](docs/DocxSetFooterRequest.md)
|
427
437
|
- [CloudmersiveConvertApiClient::DocxSetFooterResponse](docs/DocxSetFooterResponse.md)
|
438
|
+
- [CloudmersiveConvertApiClient::DocxSetFormFieldsRequest](docs/DocxSetFormFieldsRequest.md)
|
428
439
|
- [CloudmersiveConvertApiClient::DocxSetHeaderRequest](docs/DocxSetHeaderRequest.md)
|
429
440
|
- [CloudmersiveConvertApiClient::DocxSetHeaderResponse](docs/DocxSetHeaderResponse.md)
|
430
441
|
- [CloudmersiveConvertApiClient::DocxStyle](docs/DocxStyle.md)
|
431
442
|
- [CloudmersiveConvertApiClient::DocxTable](docs/DocxTable.md)
|
432
443
|
- [CloudmersiveConvertApiClient::DocxTableCell](docs/DocxTableCell.md)
|
433
444
|
- [CloudmersiveConvertApiClient::DocxTableRow](docs/DocxTableRow.md)
|
445
|
+
- [CloudmersiveConvertApiClient::DocxTableSingleTableFill](docs/DocxTableSingleTableFill.md)
|
446
|
+
- [CloudmersiveConvertApiClient::DocxTableTableFillMultiRequest](docs/DocxTableTableFillMultiRequest.md)
|
434
447
|
- [CloudmersiveConvertApiClient::DocxTableTableFillRequest](docs/DocxTableTableFillRequest.md)
|
435
448
|
- [CloudmersiveConvertApiClient::DocxTableTableFillTableCell](docs/DocxTableTableFillTableCell.md)
|
436
449
|
- [CloudmersiveConvertApiClient::DocxTableTableFillTableRow](docs/DocxTableTableFillTableRow.md)
|
@@ -447,6 +460,7 @@ Class | Method | HTTP request | Description
|
|
447
460
|
- [CloudmersiveConvertApiClient::EnableSharedWorkbookRequest](docs/EnableSharedWorkbookRequest.md)
|
448
461
|
- [CloudmersiveConvertApiClient::EnableSharedWorkbookResponse](docs/EnableSharedWorkbookResponse.md)
|
449
462
|
- [CloudmersiveConvertApiClient::ExifValue](docs/ExifValue.md)
|
463
|
+
- [CloudmersiveConvertApiClient::FillHandlebarFormField](docs/FillHandlebarFormField.md)
|
450
464
|
- [CloudmersiveConvertApiClient::FindDocxParagraphRequest](docs/FindDocxParagraphRequest.md)
|
451
465
|
- [CloudmersiveConvertApiClient::FindDocxParagraphResponse](docs/FindDocxParagraphResponse.md)
|
452
466
|
- [CloudmersiveConvertApiClient::FindRegexMatch](docs/FindRegexMatch.md)
|
@@ -460,8 +474,10 @@ Class | Method | HTTP request | Description
|
|
460
474
|
- [CloudmersiveConvertApiClient::GetDocxBodyResponse](docs/GetDocxBodyResponse.md)
|
461
475
|
- [CloudmersiveConvertApiClient::GetDocxCommentsHierarchicalResponse](docs/GetDocxCommentsHierarchicalResponse.md)
|
462
476
|
- [CloudmersiveConvertApiClient::GetDocxCommentsResponse](docs/GetDocxCommentsResponse.md)
|
477
|
+
- [CloudmersiveConvertApiClient::GetDocxContentControlsResponse](docs/GetDocxContentControlsResponse.md)
|
463
478
|
- [CloudmersiveConvertApiClient::GetDocxGetCommentsHierarchicalRequest](docs/GetDocxGetCommentsHierarchicalRequest.md)
|
464
479
|
- [CloudmersiveConvertApiClient::GetDocxGetCommentsRequest](docs/GetDocxGetCommentsRequest.md)
|
480
|
+
- [CloudmersiveConvertApiClient::GetDocxGetFormFieldsResponse](docs/GetDocxGetFormFieldsResponse.md)
|
465
481
|
- [CloudmersiveConvertApiClient::GetDocxHeadersAndFootersRequest](docs/GetDocxHeadersAndFootersRequest.md)
|
466
482
|
- [CloudmersiveConvertApiClient::GetDocxHeadersAndFootersResponse](docs/GetDocxHeadersAndFootersResponse.md)
|
467
483
|
- [CloudmersiveConvertApiClient::GetDocxImagesRequest](docs/GetDocxImagesRequest.md)
|
@@ -499,6 +515,7 @@ Class | Method | HTTP request | Description
|
|
499
515
|
- [CloudmersiveConvertApiClient::GetXlsxStylesResponse](docs/GetXlsxStylesResponse.md)
|
500
516
|
- [CloudmersiveConvertApiClient::GetXlsxWorksheetsRequest](docs/GetXlsxWorksheetsRequest.md)
|
501
517
|
- [CloudmersiveConvertApiClient::GetXlsxWorksheetsResponse](docs/GetXlsxWorksheetsResponse.md)
|
518
|
+
- [CloudmersiveConvertApiClient::HandlebarFormField](docs/HandlebarFormField.md)
|
502
519
|
- [CloudmersiveConvertApiClient::HtmlGetLanguageResult](docs/HtmlGetLanguageResult.md)
|
503
520
|
- [CloudmersiveConvertApiClient::HtmlGetLinksResponse](docs/HtmlGetLinksResponse.md)
|
504
521
|
- [CloudmersiveConvertApiClient::HtmlGetRelCanonicalUrlResult](docs/HtmlGetRelCanonicalUrlResult.md)
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocumentEditingEditSession
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
7
|
+
**edit_session_url** | **String** | Document editing session URL; in-memory temporary cache link with TTL (Time-to-Live expiration) of 30 minutes. To retrieve the document, use the Finish Editing API. | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocumentTransformEditSession
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
7
|
+
**edit_session_url** | **String** | Document editing session URL; in-memory temporary cache link with TTL (Time-to-Live expiration) of 30 minutes. To retrieve the document, use the Finish Editing API. | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxContentControl
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**value** | **String** | Text content value in the content control; text entered into the control | [optional]
|
7
|
+
|
8
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxSetFormFieldsRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**input_file_bytes** | **String** | Optional: Bytes of the input file to operate on | [optional]
|
7
|
+
**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]
|
8
|
+
**handlebar_fields_to_fill** | [**Array<FillHandlebarFormField>**](FillHandlebarFormField.md) | Handlebar style form fields to fill in; form field that is handlebar style, such as \"{{FieldName}}\" | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxTableSingleTableFill
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**table_start_tag** | **String** | Start tag that delineates the beginning of the table | [optional]
|
7
|
+
**table_end_tag** | **String** | End tag that delineates the end of the table | [optional]
|
8
|
+
**data_to_fill_in** | [**Array<DocxTableTableFillTableRow>**](DocxTableTableFillTableRow.md) | Data set to populate the table with | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxTableTableFillMultiRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**input_file_url** | **String** | Optional; Input URL of the document; use BeginEditing to create this | [optional]
|
7
|
+
**input_file_data** | **String** | Optional; Input Word Document file content for the operation | [optional]
|
8
|
+
**tables_to_fill** | [**Array<DocxTableSingleTableFill>**](DocxTableSingleTableFill.md) | Tables and datasets to fill into the document | [optional]
|
9
|
+
|
10
|
+
|
data/docs/EditDocumentApi.md
CHANGED
@@ -16,6 +16,8 @@ Method | HTTP request | Description
|
|
16
16
|
[**edit_document_docx_find_paragraph**](EditDocumentApi.md#edit_document_docx_find_paragraph) | **POST** /convert/edit/docx/find/paragraph | Find matching paragraphs in a Word DOCX document
|
17
17
|
[**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
|
18
18
|
[**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
|
19
|
+
[**edit_document_docx_get_content_controls**](EditDocumentApi.md#edit_document_docx_get_content_controls) | **POST** /convert/edit/docx/get-content-controls | Get all content controls (form fields) and values in a Word DOCX document
|
20
|
+
[**edit_document_docx_get_form_fields**](EditDocumentApi.md#edit_document_docx_get_form_fields) | **POST** /convert/edit/docx/get-form-fields | Get all form fields in a Word DOCX document
|
19
21
|
[**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
|
20
22
|
[**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
|
21
23
|
[**edit_document_docx_get_macro_information**](EditDocumentApi.md#edit_document_docx_get_macro_information) | **POST** /convert/edit/docx/get-macros | Get macro information from a Word DOCX/DOCM document
|
@@ -35,11 +37,13 @@ Method | HTTP request | Description
|
|
35
37
|
[**edit_document_docx_remove_headers_and_footers**](EditDocumentApi.md#edit_document_docx_remove_headers_and_footers) | **POST** /convert/edit/docx/remove-headers-and-footers | Remove headers and footers from Word DOCX document
|
36
38
|
[**edit_document_docx_remove_object**](EditDocumentApi.md#edit_document_docx_remove_object) | **POST** /convert/edit/docx/remove-object | Delete any object in a Word DOCX document
|
37
39
|
[**edit_document_docx_replace**](EditDocumentApi.md#edit_document_docx_replace) | **POST** /convert/edit/docx/replace-all | Replace string in Word DOCX document
|
38
|
-
[**edit_document_docx_replace_multi**](EditDocumentApi.md#edit_document_docx_replace_multi) | **POST** /convert/edit/docx/replace-all/multi | Replace multiple strings in Word DOCX document
|
40
|
+
[**edit_document_docx_replace_multi**](EditDocumentApi.md#edit_document_docx_replace_multi) | **POST** /convert/edit/docx/replace-all/multi | Replace multiple strings in Word DOCX document, return result
|
41
|
+
[**edit_document_docx_replace_multi_edit_session**](EditDocumentApi.md#edit_document_docx_replace_multi_edit_session) | **POST** /convert/edit/docx/replace-all/multi/edit-session | Replace multiple strings in Word DOCX document, return edit session
|
39
42
|
[**edit_document_docx_replace_paragraph**](EditDocumentApi.md#edit_document_docx_replace_paragraph) | **POST** /convert/edit/docx/replace/paragraph | Replace matching paragraphs in a Word DOCX document
|
40
43
|
[**edit_document_docx_set_custom_metadata_properties**](EditDocumentApi.md#edit_document_docx_set_custom_metadata_properties) | **POST** /convert/edit/docx/set-metadata/custom-property | Set custom property metadata properties in Word DOCX document
|
41
44
|
[**edit_document_docx_set_footer**](EditDocumentApi.md#edit_document_docx_set_footer) | **POST** /convert/edit/docx/set-footer | Set the footer in a Word DOCX document
|
42
45
|
[**edit_document_docx_set_footer_add_page_number**](EditDocumentApi.md#edit_document_docx_set_footer_add_page_number) | **POST** /convert/edit/docx/set-footer/add-page-number | Add page number to footer in a Word DOCX document
|
46
|
+
[**edit_document_docx_set_form_fields**](EditDocumentApi.md#edit_document_docx_set_form_fields) | **POST** /convert/edit/docx/set-form-fields | Set and fill values for form fields in a Word DOCX document
|
43
47
|
[**edit_document_docx_set_header**](EditDocumentApi.md#edit_document_docx_set_header) | **POST** /convert/edit/docx/set-header | Set the header in a Word DOCX document
|
44
48
|
[**edit_document_docx_update_table_cell**](EditDocumentApi.md#edit_document_docx_update_table_cell) | **POST** /convert/edit/docx/update-table-cell | Update, set contents of a table cell in an existing table in a Word DOCX document
|
45
49
|
[**edit_document_docx_update_table_row**](EditDocumentApi.md#edit_document_docx_update_table_row) | **POST** /convert/edit/docx/update-table-row | Update, set contents of a table row in an existing table in a Word DOCX document
|
@@ -718,6 +722,114 @@ Name | Type | Description | Notes
|
|
718
722
|
|
719
723
|
|
720
724
|
|
725
|
+
# **edit_document_docx_get_content_controls**
|
726
|
+
> GetDocxContentControlsResponse edit_document_docx_get_content_controls(input_file)
|
727
|
+
|
728
|
+
Get all content controls (form fields) and values in a Word DOCX document
|
729
|
+
|
730
|
+
Returns all the content controls, used for creating form fields, in a Office Word Document (docx)
|
731
|
+
|
732
|
+
### Example
|
733
|
+
```ruby
|
734
|
+
# load the gem
|
735
|
+
require 'cloudmersive-convert-api-client'
|
736
|
+
# setup authorization
|
737
|
+
CloudmersiveConvertApiClient.configure do |config|
|
738
|
+
# Configure API key authorization: Apikey
|
739
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
740
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
741
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
742
|
+
end
|
743
|
+
|
744
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
745
|
+
|
746
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
747
|
+
|
748
|
+
|
749
|
+
begin
|
750
|
+
#Get all content controls (form fields) and values in a Word DOCX document
|
751
|
+
result = api_instance.edit_document_docx_get_content_controls(input_file)
|
752
|
+
p result
|
753
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
754
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_get_content_controls: #{e}"
|
755
|
+
end
|
756
|
+
```
|
757
|
+
|
758
|
+
### Parameters
|
759
|
+
|
760
|
+
Name | Type | Description | Notes
|
761
|
+
------------- | ------------- | ------------- | -------------
|
762
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
763
|
+
|
764
|
+
### Return type
|
765
|
+
|
766
|
+
[**GetDocxContentControlsResponse**](GetDocxContentControlsResponse.md)
|
767
|
+
|
768
|
+
### Authorization
|
769
|
+
|
770
|
+
[Apikey](../README.md#Apikey)
|
771
|
+
|
772
|
+
### HTTP request headers
|
773
|
+
|
774
|
+
- **Content-Type**: multipart/form-data
|
775
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
776
|
+
|
777
|
+
|
778
|
+
|
779
|
+
# **edit_document_docx_get_form_fields**
|
780
|
+
> GetDocxGetFormFieldsResponse edit_document_docx_get_form_fields(input_file)
|
781
|
+
|
782
|
+
Get all form fields in a Word DOCX document
|
783
|
+
|
784
|
+
Returns all the content controls, used for creating form fields, as well as handlebar style text-based form fields such as \"{{FieldName}}\", in a Office Word Document (docx)
|
785
|
+
|
786
|
+
### Example
|
787
|
+
```ruby
|
788
|
+
# load the gem
|
789
|
+
require 'cloudmersive-convert-api-client'
|
790
|
+
# setup authorization
|
791
|
+
CloudmersiveConvertApiClient.configure do |config|
|
792
|
+
# Configure API key authorization: Apikey
|
793
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
794
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
795
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
796
|
+
end
|
797
|
+
|
798
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
799
|
+
|
800
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
801
|
+
|
802
|
+
|
803
|
+
begin
|
804
|
+
#Get all form fields in a Word DOCX document
|
805
|
+
result = api_instance.edit_document_docx_get_form_fields(input_file)
|
806
|
+
p result
|
807
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
808
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_get_form_fields: #{e}"
|
809
|
+
end
|
810
|
+
```
|
811
|
+
|
812
|
+
### Parameters
|
813
|
+
|
814
|
+
Name | Type | Description | Notes
|
815
|
+
------------- | ------------- | ------------- | -------------
|
816
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
817
|
+
|
818
|
+
### Return type
|
819
|
+
|
820
|
+
[**GetDocxGetFormFieldsResponse**](GetDocxGetFormFieldsResponse.md)
|
821
|
+
|
822
|
+
### Authorization
|
823
|
+
|
824
|
+
[Apikey](../README.md#Apikey)
|
825
|
+
|
826
|
+
### HTTP request headers
|
827
|
+
|
828
|
+
- **Content-Type**: multipart/form-data
|
829
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
830
|
+
|
831
|
+
|
832
|
+
|
721
833
|
# **edit_document_docx_get_headers_and_footers**
|
722
834
|
> GetDocxHeadersAndFootersResponse edit_document_docx_get_headers_and_footers(req_config)
|
723
835
|
|
@@ -1747,7 +1859,7 @@ Name | Type | Description | Notes
|
|
1747
1859
|
# **edit_document_docx_replace_multi**
|
1748
1860
|
> String edit_document_docx_replace_multi(req_config)
|
1749
1861
|
|
1750
|
-
Replace multiple strings in Word DOCX document
|
1862
|
+
Replace multiple strings in Word DOCX document, return result
|
1751
1863
|
|
1752
1864
|
Replace all instances of multiple strings in an Office Word Document (docx)
|
1753
1865
|
|
@@ -1769,7 +1881,7 @@ req_config = CloudmersiveConvertApiClient::MultiReplaceStringRequest.new # Multi
|
|
1769
1881
|
|
1770
1882
|
|
1771
1883
|
begin
|
1772
|
-
#Replace multiple strings in Word DOCX document
|
1884
|
+
#Replace multiple strings in Word DOCX document, return result
|
1773
1885
|
result = api_instance.edit_document_docx_replace_multi(req_config)
|
1774
1886
|
p result
|
1775
1887
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -1798,6 +1910,60 @@ Name | Type | Description | Notes
|
|
1798
1910
|
|
1799
1911
|
|
1800
1912
|
|
1913
|
+
# **edit_document_docx_replace_multi_edit_session**
|
1914
|
+
> DocumentEditingEditSession edit_document_docx_replace_multi_edit_session(req_config)
|
1915
|
+
|
1916
|
+
Replace multiple strings in Word DOCX document, return edit session
|
1917
|
+
|
1918
|
+
Replace all instances of multiple strings in an Office Word Document (docx). Returns an edit session URL so that you can chain together multiple edit operations without having to send the entire document contents back and forth multiple times. Call the Finish Editing API to retrieve the final document once editing is complete.
|
1919
|
+
|
1920
|
+
### Example
|
1921
|
+
```ruby
|
1922
|
+
# load the gem
|
1923
|
+
require 'cloudmersive-convert-api-client'
|
1924
|
+
# setup authorization
|
1925
|
+
CloudmersiveConvertApiClient.configure do |config|
|
1926
|
+
# Configure API key authorization: Apikey
|
1927
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
1928
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1929
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
1930
|
+
end
|
1931
|
+
|
1932
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
1933
|
+
|
1934
|
+
req_config = CloudmersiveConvertApiClient::MultiReplaceStringRequest.new # MultiReplaceStringRequest | Document string replacement configuration input
|
1935
|
+
|
1936
|
+
|
1937
|
+
begin
|
1938
|
+
#Replace multiple strings in Word DOCX document, return edit session
|
1939
|
+
result = api_instance.edit_document_docx_replace_multi_edit_session(req_config)
|
1940
|
+
p result
|
1941
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
1942
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_replace_multi_edit_session: #{e}"
|
1943
|
+
end
|
1944
|
+
```
|
1945
|
+
|
1946
|
+
### Parameters
|
1947
|
+
|
1948
|
+
Name | Type | Description | Notes
|
1949
|
+
------------- | ------------- | ------------- | -------------
|
1950
|
+
**req_config** | [**MultiReplaceStringRequest**](MultiReplaceStringRequest.md)| Document string replacement configuration input |
|
1951
|
+
|
1952
|
+
### Return type
|
1953
|
+
|
1954
|
+
[**DocumentEditingEditSession**](DocumentEditingEditSession.md)
|
1955
|
+
|
1956
|
+
### Authorization
|
1957
|
+
|
1958
|
+
[Apikey](../README.md#Apikey)
|
1959
|
+
|
1960
|
+
### HTTP request headers
|
1961
|
+
|
1962
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
1963
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
1964
|
+
|
1965
|
+
|
1966
|
+
|
1801
1967
|
# **edit_document_docx_replace_paragraph**
|
1802
1968
|
> ReplaceDocxParagraphResponse edit_document_docx_replace_paragraph(req_config)
|
1803
1969
|
|
@@ -2014,6 +2180,60 @@ Name | Type | Description | Notes
|
|
2014
2180
|
|
2015
2181
|
|
2016
2182
|
|
2183
|
+
# **edit_document_docx_set_form_fields**
|
2184
|
+
> String edit_document_docx_set_form_fields(req_config)
|
2185
|
+
|
2186
|
+
Set and fill values for form fields in a Word DOCX document
|
2187
|
+
|
2188
|
+
Modifies a Office Word Document (docx) by filling in form fields using the provided values.
|
2189
|
+
|
2190
|
+
### Example
|
2191
|
+
```ruby
|
2192
|
+
# load the gem
|
2193
|
+
require 'cloudmersive-convert-api-client'
|
2194
|
+
# setup authorization
|
2195
|
+
CloudmersiveConvertApiClient.configure do |config|
|
2196
|
+
# Configure API key authorization: Apikey
|
2197
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
2198
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2199
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
2200
|
+
end
|
2201
|
+
|
2202
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
2203
|
+
|
2204
|
+
req_config = CloudmersiveConvertApiClient::DocxSetFormFieldsRequest.new # DocxSetFormFieldsRequest |
|
2205
|
+
|
2206
|
+
|
2207
|
+
begin
|
2208
|
+
#Set and fill values for form fields in a Word DOCX document
|
2209
|
+
result = api_instance.edit_document_docx_set_form_fields(req_config)
|
2210
|
+
p result
|
2211
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
2212
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_set_form_fields: #{e}"
|
2213
|
+
end
|
2214
|
+
```
|
2215
|
+
|
2216
|
+
### Parameters
|
2217
|
+
|
2218
|
+
Name | Type | Description | Notes
|
2219
|
+
------------- | ------------- | ------------- | -------------
|
2220
|
+
**req_config** | [**DocxSetFormFieldsRequest**](DocxSetFormFieldsRequest.md)| |
|
2221
|
+
|
2222
|
+
### Return type
|
2223
|
+
|
2224
|
+
**String**
|
2225
|
+
|
2226
|
+
### Authorization
|
2227
|
+
|
2228
|
+
[Apikey](../README.md#Apikey)
|
2229
|
+
|
2230
|
+
### HTTP request headers
|
2231
|
+
|
2232
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
2233
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
2234
|
+
|
2235
|
+
|
2236
|
+
|
2017
2237
|
# **edit_document_docx_set_header**
|
2018
2238
|
> DocxSetHeaderResponse edit_document_docx_set_header(req_config)
|
2019
2239
|
|