cloudmersive-convert-api-client 2.2.2 → 2.2.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (38) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +20 -4
  3. data/docs/DocxContentControl.md +8 -0
  4. data/docs/DocxSetFormFieldsRequest.md +10 -0
  5. data/docs/DocxTableSingleTableFill.md +10 -0
  6. data/docs/DocxTableTableFillMultiRequest.md +10 -0
  7. data/docs/EditDocumentApi.md +165 -0
  8. data/docs/FillHandlebarFormField.md +9 -0
  9. data/docs/GetDocxContentControlsResponse.md +9 -0
  10. data/docs/GetDocxGetFormFieldsResponse.md +10 -0
  11. data/docs/HandlebarFormField.md +8 -0
  12. data/docs/TransformDocumentApi.md +55 -0
  13. data/docs/ValidateDocumentApi.md +220 -0
  14. data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +164 -0
  15. data/lib/cloudmersive-convert-api-client/api/transform_document_api.rb +54 -0
  16. data/lib/cloudmersive-convert-api-client/api/validate_document_api.rb +220 -0
  17. data/lib/cloudmersive-convert-api-client/models/docx_content_control.rb +186 -0
  18. data/lib/cloudmersive-convert-api-client/models/docx_set_form_fields_request.rb +223 -0
  19. data/lib/cloudmersive-convert-api-client/models/docx_table_single_table_fill.rb +208 -0
  20. data/lib/cloudmersive-convert-api-client/models/docx_table_table_fill_multi_request.rb +223 -0
  21. data/lib/cloudmersive-convert-api-client/models/fill_handlebar_form_field.rb +196 -0
  22. data/lib/cloudmersive-convert-api-client/models/get_docx_content_controls_response.rb +198 -0
  23. data/lib/cloudmersive-convert-api-client/models/get_docx_get_form_fields_response.rb +210 -0
  24. data/lib/cloudmersive-convert-api-client/models/handlebar_form_field.rb +186 -0
  25. data/lib/cloudmersive-convert-api-client/version.rb +1 -1
  26. data/lib/cloudmersive-convert-api-client.rb +8 -0
  27. data/spec/api/edit_document_api_spec.rb +36 -0
  28. data/spec/api/transform_document_api_spec.rb +12 -0
  29. data/spec/api/validate_document_api_spec.rb +48 -0
  30. data/spec/models/docx_content_control_spec.rb +41 -0
  31. data/spec/models/docx_set_form_fields_request_spec.rb +53 -0
  32. data/spec/models/docx_table_single_table_fill_spec.rb +53 -0
  33. data/spec/models/docx_table_table_fill_multi_request_spec.rb +53 -0
  34. data/spec/models/fill_handlebar_form_field_spec.rb +47 -0
  35. data/spec/models/get_docx_content_controls_response_spec.rb +47 -0
  36. data/spec/models/get_docx_get_form_fields_response_spec.rb +53 -0
  37. data/spec/models/handlebar_form_field_spec.rb +41 -0
  38. metadata +26 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2d210214a3f253a594bc803767092acf71aae425d7024c6a896f7f6dbf4a0ed8
4
- data.tar.gz: f7ec216cd18558660e9c20acb0eeec9e8cd2d651e9756e7c8e5bfaf35ee84817
3
+ metadata.gz: aabaa1e2ce9972df803288c696954a0effd34c4e88aa499056783cb1aeed4100
4
+ data.tar.gz: b74b4ab236f9b7f26a4a812c663eaeb8bcd11d8de5f741d12153f5d7cbb4da9e
5
5
  SHA512:
6
- metadata.gz: b31cbaaa49b829afdd8981c7c09e7335d44ab103bac8af01ef82c57892ce137e1b94b5cbdbbd0067ed99a15fabf5a0f0859dd651733dc8a3d73675c558312fa3
7
- data.tar.gz: 31e545ead88a6c6862f1abe4232df95413ac4fe69c075a57739b3f85c0ff51a5ff1f1e3d79a075ac5d999a40b4a380cec91bdaacdc21af5bcf150b1a0b4c0d0a
6
+ metadata.gz: '050068f0b54b771d9807a1796fd465c148300865f2e5ee348db6f8f52ed143caae41a17585e85e8a8de16d08a810ff1cf3afe71d14ee1a7efcca2b114ee48c69'
7
+ data.tar.gz: c7e750d4475a41e93778fe3521539d1c1b9d9a370eac4a07f62420d9ae2d27103a62db0684ede7343170dfbd38d556b521f4124f6e91e67b5ba594eab91030d2
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.2
10
+ - Package version: 2.2.6
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.2.gem
26
+ gem install ./cloudmersive-convert-api-client-2.2.6.gem
27
27
  ```
28
- (for development, run `gem install --dev ./cloudmersive-convert-api-client-2.2.2.gem` to install the development dependencies)
28
+ (for development, run `gem install --dev ./cloudmersive-convert-api-client-2.2.6.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.2'
34
+ gem 'cloudmersive-convert-api-client', '~> 2.2.6'
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
@@ -233,6 +235,7 @@ Class | Method | HTTP request | Description
233
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
234
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
235
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
236
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
237
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
238
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
@@ -333,9 +336,11 @@ Class | Method | HTTP request | Description
333
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
334
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
335
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
336
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
337
341
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_autodetect_validation**](docs/ValidateDocumentApi.md#validate_document_autodetect_validation) | **POST** /convert/validate/autodetect | Autodetect content type and validate
338
342
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_csv_validation**](docs/ValidateDocumentApi.md#validate_document_csv_validation) | **POST** /convert/validate/csv | Validate a CSV file document (CSV)
343
+ *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_doc_validation**](docs/ValidateDocumentApi.md#validate_document_doc_validation) | **POST** /convert/validate/doc | Validate a Word 97-2003 Legacy document (DOC)
339
344
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_docx_validation**](docs/ValidateDocumentApi.md#validate_document_docx_validation) | **POST** /convert/validate/docx | Validate a Word document (DOCX)
340
345
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_eml_validation**](docs/ValidateDocumentApi.md#validate_document_eml_validation) | **POST** /convert/validate/eml | Validate if an EML file is executable
341
346
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_executable_validation**](docs/ValidateDocumentApi.md#validate_document_executable_validation) | **POST** /convert/validate/executable | Validate if a file is executable
@@ -348,10 +353,13 @@ Class | Method | HTTP request | Description
348
353
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_msg_validation**](docs/ValidateDocumentApi.md#validate_document_msg_validation) | **POST** /convert/validate/msg | Validate if an MSG file is executable
349
354
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_pdf_validation**](docs/ValidateDocumentApi.md#validate_document_pdf_validation) | **POST** /convert/validate/pdf | Validate a PDF document file
350
355
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_png_validation**](docs/ValidateDocumentApi.md#validate_document_png_validation) | **POST** /convert/validate/png | Validate a PNG File
356
+ *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_ppt_validation**](docs/ValidateDocumentApi.md#validate_document_ppt_validation) | **POST** /convert/validate/ppt | Validate a PowerPoint 97-2003 Legacy presentation (PPT)
351
357
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_pptx_validation**](docs/ValidateDocumentApi.md#validate_document_pptx_validation) | **POST** /convert/validate/pptx | Validate a PowerPoint presentation (PPTX)
352
358
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_rar_validation**](docs/ValidateDocumentApi.md#validate_document_rar_validation) | **POST** /convert/validate/rar | Validate a RAR Archive file (RAR)
359
+ *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_rtf_validation**](docs/ValidateDocumentApi.md#validate_document_rtf_validation) | **POST** /convert/validate/rtf | Validate a Rich Text Format document (RTF)
353
360
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_tar_validation**](docs/ValidateDocumentApi.md#validate_document_tar_validation) | **POST** /convert/validate/tar | Validate a TAR Tarball Archive file (TAR)
354
361
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_txt_validation**](docs/ValidateDocumentApi.md#validate_document_txt_validation) | **POST** /convert/validate/txt | Validate an TXT file
362
+ *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_xls_validation**](docs/ValidateDocumentApi.md#validate_document_xls_validation) | **POST** /convert/validate/xls | Validate a Excel 97-2003 Legacy spreadsheet (XLS)
355
363
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_xlsx_validation**](docs/ValidateDocumentApi.md#validate_document_xlsx_validation) | **POST** /convert/validate/xlsx | Validate a Excel document (XLSX)
356
364
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_xml_validation**](docs/ValidateDocumentApi.md#validate_document_xml_validation) | **POST** /convert/validate/xml | Validate an XML file
357
365
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_xml_xxe_threat_validation**](docs/ValidateDocumentApi.md#validate_document_xml_xxe_threat_validation) | **POST** /convert/validate/xml/xxe-threats | Validate an XML file for XML External Entity (XXE) threats
@@ -413,6 +421,7 @@ Class | Method | HTTP request | Description
413
421
  - [CloudmersiveConvertApiClient::DocxBody](docs/DocxBody.md)
414
422
  - [CloudmersiveConvertApiClient::DocxCellStyle](docs/DocxCellStyle.md)
415
423
  - [CloudmersiveConvertApiClient::DocxComment](docs/DocxComment.md)
424
+ - [CloudmersiveConvertApiClient::DocxContentControl](docs/DocxContentControl.md)
416
425
  - [CloudmersiveConvertApiClient::DocxFooter](docs/DocxFooter.md)
417
426
  - [CloudmersiveConvertApiClient::DocxHeader](docs/DocxHeader.md)
418
427
  - [CloudmersiveConvertApiClient::DocxImage](docs/DocxImage.md)
@@ -430,12 +439,15 @@ Class | Method | HTTP request | Description
430
439
  - [CloudmersiveConvertApiClient::DocxSetFooterAddPageNumberRequest](docs/DocxSetFooterAddPageNumberRequest.md)
431
440
  - [CloudmersiveConvertApiClient::DocxSetFooterRequest](docs/DocxSetFooterRequest.md)
432
441
  - [CloudmersiveConvertApiClient::DocxSetFooterResponse](docs/DocxSetFooterResponse.md)
442
+ - [CloudmersiveConvertApiClient::DocxSetFormFieldsRequest](docs/DocxSetFormFieldsRequest.md)
433
443
  - [CloudmersiveConvertApiClient::DocxSetHeaderRequest](docs/DocxSetHeaderRequest.md)
434
444
  - [CloudmersiveConvertApiClient::DocxSetHeaderResponse](docs/DocxSetHeaderResponse.md)
435
445
  - [CloudmersiveConvertApiClient::DocxStyle](docs/DocxStyle.md)
436
446
  - [CloudmersiveConvertApiClient::DocxTable](docs/DocxTable.md)
437
447
  - [CloudmersiveConvertApiClient::DocxTableCell](docs/DocxTableCell.md)
438
448
  - [CloudmersiveConvertApiClient::DocxTableRow](docs/DocxTableRow.md)
449
+ - [CloudmersiveConvertApiClient::DocxTableSingleTableFill](docs/DocxTableSingleTableFill.md)
450
+ - [CloudmersiveConvertApiClient::DocxTableTableFillMultiRequest](docs/DocxTableTableFillMultiRequest.md)
439
451
  - [CloudmersiveConvertApiClient::DocxTableTableFillRequest](docs/DocxTableTableFillRequest.md)
440
452
  - [CloudmersiveConvertApiClient::DocxTableTableFillTableCell](docs/DocxTableTableFillTableCell.md)
441
453
  - [CloudmersiveConvertApiClient::DocxTableTableFillTableRow](docs/DocxTableTableFillTableRow.md)
@@ -452,6 +464,7 @@ Class | Method | HTTP request | Description
452
464
  - [CloudmersiveConvertApiClient::EnableSharedWorkbookRequest](docs/EnableSharedWorkbookRequest.md)
453
465
  - [CloudmersiveConvertApiClient::EnableSharedWorkbookResponse](docs/EnableSharedWorkbookResponse.md)
454
466
  - [CloudmersiveConvertApiClient::ExifValue](docs/ExifValue.md)
467
+ - [CloudmersiveConvertApiClient::FillHandlebarFormField](docs/FillHandlebarFormField.md)
455
468
  - [CloudmersiveConvertApiClient::FindDocxParagraphRequest](docs/FindDocxParagraphRequest.md)
456
469
  - [CloudmersiveConvertApiClient::FindDocxParagraphResponse](docs/FindDocxParagraphResponse.md)
457
470
  - [CloudmersiveConvertApiClient::FindRegexMatch](docs/FindRegexMatch.md)
@@ -465,8 +478,10 @@ Class | Method | HTTP request | Description
465
478
  - [CloudmersiveConvertApiClient::GetDocxBodyResponse](docs/GetDocxBodyResponse.md)
466
479
  - [CloudmersiveConvertApiClient::GetDocxCommentsHierarchicalResponse](docs/GetDocxCommentsHierarchicalResponse.md)
467
480
  - [CloudmersiveConvertApiClient::GetDocxCommentsResponse](docs/GetDocxCommentsResponse.md)
481
+ - [CloudmersiveConvertApiClient::GetDocxContentControlsResponse](docs/GetDocxContentControlsResponse.md)
468
482
  - [CloudmersiveConvertApiClient::GetDocxGetCommentsHierarchicalRequest](docs/GetDocxGetCommentsHierarchicalRequest.md)
469
483
  - [CloudmersiveConvertApiClient::GetDocxGetCommentsRequest](docs/GetDocxGetCommentsRequest.md)
484
+ - [CloudmersiveConvertApiClient::GetDocxGetFormFieldsResponse](docs/GetDocxGetFormFieldsResponse.md)
470
485
  - [CloudmersiveConvertApiClient::GetDocxHeadersAndFootersRequest](docs/GetDocxHeadersAndFootersRequest.md)
471
486
  - [CloudmersiveConvertApiClient::GetDocxHeadersAndFootersResponse](docs/GetDocxHeadersAndFootersResponse.md)
472
487
  - [CloudmersiveConvertApiClient::GetDocxImagesRequest](docs/GetDocxImagesRequest.md)
@@ -504,6 +519,7 @@ Class | Method | HTTP request | Description
504
519
  - [CloudmersiveConvertApiClient::GetXlsxStylesResponse](docs/GetXlsxStylesResponse.md)
505
520
  - [CloudmersiveConvertApiClient::GetXlsxWorksheetsRequest](docs/GetXlsxWorksheetsRequest.md)
506
521
  - [CloudmersiveConvertApiClient::GetXlsxWorksheetsResponse](docs/GetXlsxWorksheetsResponse.md)
522
+ - [CloudmersiveConvertApiClient::HandlebarFormField](docs/HandlebarFormField.md)
507
523
  - [CloudmersiveConvertApiClient::HtmlGetLanguageResult](docs/HtmlGetLanguageResult.md)
508
524
  - [CloudmersiveConvertApiClient::HtmlGetLinksResponse](docs/HtmlGetLinksResponse.md)
509
525
  - [CloudmersiveConvertApiClient::HtmlGetRelCanonicalUrlResult](docs/HtmlGetRelCanonicalUrlResult.md)
@@ -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
+
@@ -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
@@ -41,6 +43,7 @@ Method | HTTP request | Description
41
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
42
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
43
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
44
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
45
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
46
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
@@ -719,6 +722,114 @@ Name | Type | Description | Notes
719
722
 
720
723
 
721
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
+
722
833
  # **edit_document_docx_get_headers_and_footers**
723
834
  > GetDocxHeadersAndFootersResponse edit_document_docx_get_headers_and_footers(req_config)
724
835
 
@@ -2069,6 +2180,60 @@ Name | Type | Description | Notes
2069
2180
 
2070
2181
 
2071
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
+
2072
2237
  # **edit_document_docx_set_header**
2073
2238
  > DocxSetHeaderResponse edit_document_docx_set_header(req_config)
2074
2239
 
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::FillHandlebarFormField
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **field_name** | **String** | Name of the field without the curly braces, e.g. \"FieldName\" for a field that is included in the text of the DOCX as \"{{FieldName}}\" | [optional]
7
+ **value_to_fill** | **String** | Text value to fill in for the field in the resulting document | [optional]
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::GetDocxContentControlsResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
7
+ **content_controls** | [**Array<DocxContentControl>**](DocxContentControl.md) | Content controls in the DOCX | [optional]
8
+
9
+
@@ -0,0 +1,10 @@
1
+ # CloudmersiveConvertApiClient::GetDocxGetFormFieldsResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
7
+ **content_controls** | [**Array<DocxContentControl>**](DocxContentControl.md) | Content controls in the DOCX | [optional]
8
+ **handlebar_form_fields** | [**Array<HandlebarFormField>**](HandlebarFormField.md) | Form fields that comply with the Handlebar style, that is they are surrounded by two curly braces on either side such as \"{{FieldName}}\", in the DOCX | [optional]
9
+
10
+
@@ -0,0 +1,8 @@
1
+ # CloudmersiveConvertApiClient::HandlebarFormField
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **form_field_title** | **String** | Title of the handlebar style form field, such as \"FieldName\" in the case of \"{{FieldName}}\" | [optional]
7
+
8
+
@@ -8,6 +8,7 @@ Method | HTTP request | Description
8
8
  [**transform_document_docx_replace_edit_session**](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
9
9
  [**transform_document_docx_table_fill_in**](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
10
10
  [**transform_document_docx_table_fill_in_edit_session**](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
11
+ [**transform_document_docx_table_fill_in_multi**](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
11
12
  [**transform_document_pptx_replace**](TransformDocumentApi.md#transform_document_pptx_replace) | **POST** /convert/transform/pptx/replace-all | Replace string in PowerPoint PPTX presentation, return result
12
13
 
13
14
 
@@ -249,6 +250,60 @@ Name | Type | Description | Notes
249
250
 
250
251
 
251
252
 
253
+ # **transform_document_docx_table_fill_in_multi**
254
+ > String transform_document_docx_table_fill_in_multi(request)
255
+
256
+ Fill in data in multiple tables in a Word DOCX document, return result
257
+
258
+ Replace placeholder rows in multiple tables in an Office Word Document (docx) using one or more templates
259
+
260
+ ### Example
261
+ ```ruby
262
+ # load the gem
263
+ require 'cloudmersive-convert-api-client'
264
+ # setup authorization
265
+ CloudmersiveConvertApiClient.configure do |config|
266
+ # Configure API key authorization: Apikey
267
+ config.api_key['Apikey'] = 'YOUR API KEY'
268
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
269
+ #config.api_key_prefix['Apikey'] = 'Bearer'
270
+ end
271
+
272
+ api_instance = CloudmersiveConvertApiClient::TransformDocumentApi.new
273
+
274
+ request = CloudmersiveConvertApiClient::DocxTableTableFillMultiRequest.new # DocxTableTableFillMultiRequest |
275
+
276
+
277
+ begin
278
+ #Fill in data in multiple tables in a Word DOCX document, return result
279
+ result = api_instance.transform_document_docx_table_fill_in_multi(request)
280
+ p result
281
+ rescue CloudmersiveConvertApiClient::ApiError => e
282
+ puts "Exception when calling TransformDocumentApi->transform_document_docx_table_fill_in_multi: #{e}"
283
+ end
284
+ ```
285
+
286
+ ### Parameters
287
+
288
+ Name | Type | Description | Notes
289
+ ------------- | ------------- | ------------- | -------------
290
+ **request** | [**DocxTableTableFillMultiRequest**](DocxTableTableFillMultiRequest.md)| |
291
+
292
+ ### Return type
293
+
294
+ **String**
295
+
296
+ ### Authorization
297
+
298
+ [Apikey](../README.md#Apikey)
299
+
300
+ ### HTTP request headers
301
+
302
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
303
+ - **Accept**: application/json, text/json, application/xml, text/xml
304
+
305
+
306
+
252
307
  # **transform_document_pptx_replace**
253
308
  > String transform_document_pptx_replace(match_string, replace_string, opts)
254
309