cloudmersive-convert-api-client 2.2.3 → 2.2.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (37) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +19 -5
  3. data/docs/ConvertDataApi.md +60 -5
  4. data/docs/ConvertWebApi.md +8 -8
  5. data/docs/DocxContentControl.md +8 -0
  6. data/docs/DocxSetFormFieldsRequest.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 +3 -3
  13. data/docs/ValidateDocumentApi.md +220 -0
  14. data/lib/cloudmersive-convert-api-client/api/convert_data_api.rb +57 -4
  15. data/lib/cloudmersive-convert-api-client/api/convert_web_api.rb +8 -8
  16. data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +164 -0
  17. data/lib/cloudmersive-convert-api-client/api/transform_document_api.rb +4 -4
  18. data/lib/cloudmersive-convert-api-client/api/validate_document_api.rb +220 -0
  19. data/lib/cloudmersive-convert-api-client/models/docx_content_control.rb +186 -0
  20. data/lib/cloudmersive-convert-api-client/models/docx_set_form_fields_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 +6 -0
  27. data/spec/api/convert_data_api_spec.rb +14 -2
  28. data/spec/api/edit_document_api_spec.rb +36 -0
  29. data/spec/api/transform_document_api_spec.rb +1 -1
  30. data/spec/api/validate_document_api_spec.rb +48 -0
  31. data/spec/models/docx_content_control_spec.rb +41 -0
  32. data/spec/models/docx_set_form_fields_request_spec.rb +53 -0
  33. data/spec/models/fill_handlebar_form_field_spec.rb +47 -0
  34. data/spec/models/get_docx_content_controls_response_spec.rb +47 -0
  35. data/spec/models/get_docx_get_form_fields_response_spec.rb +53 -0
  36. data/spec/models/handlebar_form_field_spec.rb +41 -0
  37. metadata +20 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3d04663be07d2325db820df2f804191d40cc98142b7911d5b9fe38cdc839b444
4
- data.tar.gz: 38ff522b6e239465685988cac35a6fe4389130823509c8372a00e3d37d9ee7f2
3
+ metadata.gz: f936af52c5f251124e36d6cced85302479680c2efc51386811839670b4a36bb4
4
+ data.tar.gz: 7fe583dc28b8bbfba5f39de7e91e89678ec09079f5c44622915dc2943825117c
5
5
  SHA512:
6
- metadata.gz: a65439264897bcf13b4659cd1954523989ce9ab71f97a1686b8df598920645d70f0980b6230d472fa1644008e76c90ba51a3ff2b46e2735780ad3b2a5f3c34fb
7
- data.tar.gz: 3a5f66ddd154cd36e884a8cd946a3325426a8719ecf82b772091d208774809f2f3626560df867e1cf2d99433b052846c8ffbcee853bbf42ce113f4cda40f74b0
6
+ metadata.gz: 4a40fd9bd6c2d864c10ac1e69a0779d8161f7d707a3f21ad936e4f4fa854f0a2012260ef7c880d3ec1be88660de5707354f8ac6404947508828d1b67ae78eaa2
7
+ data.tar.gz: 4000387251388b975fcd9ab0ee55dd9bf79154061bcf18f73a697ac4066460ad67fd06212f48092e3149814193b5bcc5ef565be23cab10c719601f7a44a0dbd2
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.3
10
+ - Package version: 2.2.7
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.3.gem
26
+ gem install ./cloudmersive-convert-api-client-2.2.7.gem
27
27
  ```
28
- (for development, run `gem install --dev ./cloudmersive-convert-api-client-2.2.3.gem` to install the development dependencies)
28
+ (for development, run `gem install --dev ./cloudmersive-convert-api-client-2.2.7.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.3'
34
+ gem 'cloudmersive-convert-api-client', '~> 2.2.7'
35
35
 
36
36
  ### Install from Git
37
37
 
@@ -88,7 +88,8 @@ Class | Method | HTTP request | Description
88
88
  *CloudmersiveConvertApiClient::CompareDocumentApi* | [**compare_document_docx**](docs/CompareDocumentApi.md#compare_document_docx) | **POST** /convert/compare/docx | Compare Two Word DOCX
89
89
  *CloudmersiveConvertApiClient::ConvertDataApi* | [**convert_data_csv_to_json**](docs/ConvertDataApi.md#convert_data_csv_to_json) | **POST** /convert/csv/to/json | Convert CSV to JSON conversion
90
90
  *CloudmersiveConvertApiClient::ConvertDataApi* | [**convert_data_csv_to_xml**](docs/ConvertDataApi.md#convert_data_csv_to_xml) | **POST** /convert/csv/to/xml | Convert CSV to XML conversion
91
- *CloudmersiveConvertApiClient::ConvertDataApi* | [**convert_data_json_to_xml**](docs/ConvertDataApi.md#convert_data_json_to_xml) | **POST** /convert/json/to/xml | Convert JSON to XML conversion
91
+ *CloudmersiveConvertApiClient::ConvertDataApi* | [**convert_data_json_string_to_xml**](docs/ConvertDataApi.md#convert_data_json_string_to_xml) | **POST** /convert/json-string/to/xml | Convert JSON String to XML conversion
92
+ *CloudmersiveConvertApiClient::ConvertDataApi* | [**convert_data_json_to_xml**](docs/ConvertDataApi.md#convert_data_json_to_xml) | **POST** /convert/json/to/xml | Convert JSON Object to XML conversion
92
93
  *CloudmersiveConvertApiClient::ConvertDataApi* | [**convert_data_xls_to_json**](docs/ConvertDataApi.md#convert_data_xls_to_json) | **POST** /convert/xls/to/json | Convert Excel (97-2003) XLS to JSON conversion
93
94
  *CloudmersiveConvertApiClient::ConvertDataApi* | [**convert_data_xlsx_to_json**](docs/ConvertDataApi.md#convert_data_xlsx_to_json) | **POST** /convert/xlsx/to/json | Convert Excel XLSX to JSON conversion
94
95
  *CloudmersiveConvertApiClient::ConvertDataApi* | [**convert_data_xlsx_to_xml**](docs/ConvertDataApi.md#convert_data_xlsx_to_xml) | **POST** /convert/xlsx/to/xml | Convert Excel XLSX to XML conversion
@@ -208,6 +209,8 @@ Class | Method | HTTP request | Description
208
209
  *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
210
  *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
211
  *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
212
+ *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
213
+ *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
214
  *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
215
  *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
216
  *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 +236,7 @@ Class | Method | HTTP request | Description
233
236
  *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
237
  *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
238
  *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
239
+ *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
240
  *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
241
  *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
242
  *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
@@ -337,6 +341,7 @@ Class | Method | HTTP request | Description
337
341
  *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
338
342
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_autodetect_validation**](docs/ValidateDocumentApi.md#validate_document_autodetect_validation) | **POST** /convert/validate/autodetect | Autodetect content type and validate
339
343
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_csv_validation**](docs/ValidateDocumentApi.md#validate_document_csv_validation) | **POST** /convert/validate/csv | Validate a CSV file document (CSV)
344
+ *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)
340
345
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_docx_validation**](docs/ValidateDocumentApi.md#validate_document_docx_validation) | **POST** /convert/validate/docx | Validate a Word document (DOCX)
341
346
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_eml_validation**](docs/ValidateDocumentApi.md#validate_document_eml_validation) | **POST** /convert/validate/eml | Validate if an EML file is executable
342
347
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_executable_validation**](docs/ValidateDocumentApi.md#validate_document_executable_validation) | **POST** /convert/validate/executable | Validate if a file is executable
@@ -349,10 +354,13 @@ Class | Method | HTTP request | Description
349
354
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_msg_validation**](docs/ValidateDocumentApi.md#validate_document_msg_validation) | **POST** /convert/validate/msg | Validate if an MSG file is executable
350
355
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_pdf_validation**](docs/ValidateDocumentApi.md#validate_document_pdf_validation) | **POST** /convert/validate/pdf | Validate a PDF document file
351
356
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_png_validation**](docs/ValidateDocumentApi.md#validate_document_png_validation) | **POST** /convert/validate/png | Validate a PNG File
357
+ *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)
352
358
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_pptx_validation**](docs/ValidateDocumentApi.md#validate_document_pptx_validation) | **POST** /convert/validate/pptx | Validate a PowerPoint presentation (PPTX)
353
359
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_rar_validation**](docs/ValidateDocumentApi.md#validate_document_rar_validation) | **POST** /convert/validate/rar | Validate a RAR Archive file (RAR)
360
+ *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_rtf_validation**](docs/ValidateDocumentApi.md#validate_document_rtf_validation) | **POST** /convert/validate/rtf | Validate a Rich Text Format document (RTF)
354
361
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_tar_validation**](docs/ValidateDocumentApi.md#validate_document_tar_validation) | **POST** /convert/validate/tar | Validate a TAR Tarball Archive file (TAR)
355
362
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_txt_validation**](docs/ValidateDocumentApi.md#validate_document_txt_validation) | **POST** /convert/validate/txt | Validate an TXT file
363
+ *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)
356
364
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_xlsx_validation**](docs/ValidateDocumentApi.md#validate_document_xlsx_validation) | **POST** /convert/validate/xlsx | Validate a Excel document (XLSX)
357
365
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_xml_validation**](docs/ValidateDocumentApi.md#validate_document_xml_validation) | **POST** /convert/validate/xml | Validate an XML file
358
366
  *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
@@ -414,6 +422,7 @@ Class | Method | HTTP request | Description
414
422
  - [CloudmersiveConvertApiClient::DocxBody](docs/DocxBody.md)
415
423
  - [CloudmersiveConvertApiClient::DocxCellStyle](docs/DocxCellStyle.md)
416
424
  - [CloudmersiveConvertApiClient::DocxComment](docs/DocxComment.md)
425
+ - [CloudmersiveConvertApiClient::DocxContentControl](docs/DocxContentControl.md)
417
426
  - [CloudmersiveConvertApiClient::DocxFooter](docs/DocxFooter.md)
418
427
  - [CloudmersiveConvertApiClient::DocxHeader](docs/DocxHeader.md)
419
428
  - [CloudmersiveConvertApiClient::DocxImage](docs/DocxImage.md)
@@ -431,6 +440,7 @@ Class | Method | HTTP request | Description
431
440
  - [CloudmersiveConvertApiClient::DocxSetFooterAddPageNumberRequest](docs/DocxSetFooterAddPageNumberRequest.md)
432
441
  - [CloudmersiveConvertApiClient::DocxSetFooterRequest](docs/DocxSetFooterRequest.md)
433
442
  - [CloudmersiveConvertApiClient::DocxSetFooterResponse](docs/DocxSetFooterResponse.md)
443
+ - [CloudmersiveConvertApiClient::DocxSetFormFieldsRequest](docs/DocxSetFormFieldsRequest.md)
434
444
  - [CloudmersiveConvertApiClient::DocxSetHeaderRequest](docs/DocxSetHeaderRequest.md)
435
445
  - [CloudmersiveConvertApiClient::DocxSetHeaderResponse](docs/DocxSetHeaderResponse.md)
436
446
  - [CloudmersiveConvertApiClient::DocxStyle](docs/DocxStyle.md)
@@ -455,6 +465,7 @@ Class | Method | HTTP request | Description
455
465
  - [CloudmersiveConvertApiClient::EnableSharedWorkbookRequest](docs/EnableSharedWorkbookRequest.md)
456
466
  - [CloudmersiveConvertApiClient::EnableSharedWorkbookResponse](docs/EnableSharedWorkbookResponse.md)
457
467
  - [CloudmersiveConvertApiClient::ExifValue](docs/ExifValue.md)
468
+ - [CloudmersiveConvertApiClient::FillHandlebarFormField](docs/FillHandlebarFormField.md)
458
469
  - [CloudmersiveConvertApiClient::FindDocxParagraphRequest](docs/FindDocxParagraphRequest.md)
459
470
  - [CloudmersiveConvertApiClient::FindDocxParagraphResponse](docs/FindDocxParagraphResponse.md)
460
471
  - [CloudmersiveConvertApiClient::FindRegexMatch](docs/FindRegexMatch.md)
@@ -468,8 +479,10 @@ Class | Method | HTTP request | Description
468
479
  - [CloudmersiveConvertApiClient::GetDocxBodyResponse](docs/GetDocxBodyResponse.md)
469
480
  - [CloudmersiveConvertApiClient::GetDocxCommentsHierarchicalResponse](docs/GetDocxCommentsHierarchicalResponse.md)
470
481
  - [CloudmersiveConvertApiClient::GetDocxCommentsResponse](docs/GetDocxCommentsResponse.md)
482
+ - [CloudmersiveConvertApiClient::GetDocxContentControlsResponse](docs/GetDocxContentControlsResponse.md)
471
483
  - [CloudmersiveConvertApiClient::GetDocxGetCommentsHierarchicalRequest](docs/GetDocxGetCommentsHierarchicalRequest.md)
472
484
  - [CloudmersiveConvertApiClient::GetDocxGetCommentsRequest](docs/GetDocxGetCommentsRequest.md)
485
+ - [CloudmersiveConvertApiClient::GetDocxGetFormFieldsResponse](docs/GetDocxGetFormFieldsResponse.md)
473
486
  - [CloudmersiveConvertApiClient::GetDocxHeadersAndFootersRequest](docs/GetDocxHeadersAndFootersRequest.md)
474
487
  - [CloudmersiveConvertApiClient::GetDocxHeadersAndFootersResponse](docs/GetDocxHeadersAndFootersResponse.md)
475
488
  - [CloudmersiveConvertApiClient::GetDocxImagesRequest](docs/GetDocxImagesRequest.md)
@@ -507,6 +520,7 @@ Class | Method | HTTP request | Description
507
520
  - [CloudmersiveConvertApiClient::GetXlsxStylesResponse](docs/GetXlsxStylesResponse.md)
508
521
  - [CloudmersiveConvertApiClient::GetXlsxWorksheetsRequest](docs/GetXlsxWorksheetsRequest.md)
509
522
  - [CloudmersiveConvertApiClient::GetXlsxWorksheetsResponse](docs/GetXlsxWorksheetsResponse.md)
523
+ - [CloudmersiveConvertApiClient::HandlebarFormField](docs/HandlebarFormField.md)
510
524
  - [CloudmersiveConvertApiClient::HtmlGetLanguageResult](docs/HtmlGetLanguageResult.md)
511
525
  - [CloudmersiveConvertApiClient::HtmlGetLinksResponse](docs/HtmlGetLinksResponse.md)
512
526
  - [CloudmersiveConvertApiClient::HtmlGetRelCanonicalUrlResult](docs/HtmlGetRelCanonicalUrlResult.md)
@@ -6,7 +6,8 @@ Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**convert_data_csv_to_json**](ConvertDataApi.md#convert_data_csv_to_json) | **POST** /convert/csv/to/json | Convert CSV to JSON conversion
8
8
  [**convert_data_csv_to_xml**](ConvertDataApi.md#convert_data_csv_to_xml) | **POST** /convert/csv/to/xml | Convert CSV to XML conversion
9
- [**convert_data_json_to_xml**](ConvertDataApi.md#convert_data_json_to_xml) | **POST** /convert/json/to/xml | Convert JSON to XML conversion
9
+ [**convert_data_json_string_to_xml**](ConvertDataApi.md#convert_data_json_string_to_xml) | **POST** /convert/json-string/to/xml | Convert JSON String to XML conversion
10
+ [**convert_data_json_to_xml**](ConvertDataApi.md#convert_data_json_to_xml) | **POST** /convert/json/to/xml | Convert JSON Object to XML conversion
10
11
  [**convert_data_xls_to_json**](ConvertDataApi.md#convert_data_xls_to_json) | **POST** /convert/xls/to/json | Convert Excel (97-2003) XLS to JSON conversion
11
12
  [**convert_data_xlsx_to_json**](ConvertDataApi.md#convert_data_xlsx_to_json) | **POST** /convert/xlsx/to/json | Convert Excel XLSX to JSON conversion
12
13
  [**convert_data_xlsx_to_xml**](ConvertDataApi.md#convert_data_xlsx_to_xml) | **POST** /convert/xlsx/to/xml | Convert Excel XLSX to XML conversion
@@ -139,10 +140,64 @@ Name | Type | Description | Notes
139
140
 
140
141
 
141
142
 
143
+ # **convert_data_json_string_to_xml**
144
+ > Object convert_data_json_string_to_xml(json_string)
145
+
146
+ Convert JSON String to XML conversion
147
+
148
+ Convert a JSON object into XML
149
+
150
+ ### Example
151
+ ```ruby
152
+ # load the gem
153
+ require 'cloudmersive-convert-api-client'
154
+ # setup authorization
155
+ CloudmersiveConvertApiClient.configure do |config|
156
+ # Configure API key authorization: Apikey
157
+ config.api_key['Apikey'] = 'YOUR API KEY'
158
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
159
+ #config.api_key_prefix['Apikey'] = 'Bearer'
160
+ end
161
+
162
+ api_instance = CloudmersiveConvertApiClient::ConvertDataApi.new
163
+
164
+ json_string = 'json_string_example' # String | Input JSON String to convert to XML
165
+
166
+
167
+ begin
168
+ #Convert JSON String to XML conversion
169
+ result = api_instance.convert_data_json_string_to_xml(json_string)
170
+ p result
171
+ rescue CloudmersiveConvertApiClient::ApiError => e
172
+ puts "Exception when calling ConvertDataApi->convert_data_json_string_to_xml: #{e}"
173
+ end
174
+ ```
175
+
176
+ ### Parameters
177
+
178
+ Name | Type | Description | Notes
179
+ ------------- | ------------- | ------------- | -------------
180
+ **json_string** | **String**| Input JSON String to convert to XML |
181
+
182
+ ### Return type
183
+
184
+ **Object**
185
+
186
+ ### Authorization
187
+
188
+ [Apikey](../README.md#Apikey)
189
+
190
+ ### HTTP request headers
191
+
192
+ - **Content-Type**: Not defined
193
+ - **Accept**: application/xml
194
+
195
+
196
+
142
197
  # **convert_data_json_to_xml**
143
198
  > String convert_data_json_to_xml(json_object)
144
199
 
145
- Convert JSON to XML conversion
200
+ Convert JSON Object to XML conversion
146
201
 
147
202
  Convert a JSON object into XML
148
203
 
@@ -160,11 +215,11 @@ end
160
215
 
161
216
  api_instance = CloudmersiveConvertApiClient::ConvertDataApi.new
162
217
 
163
- json_object = nil # Object | Input JSON to convert to XML
218
+ json_object = nil # Object | Input JSON Object to convert to XML
164
219
 
165
220
 
166
221
  begin
167
- #Convert JSON to XML conversion
222
+ #Convert JSON Object to XML conversion
168
223
  result = api_instance.convert_data_json_to_xml(json_object)
169
224
  p result
170
225
  rescue CloudmersiveConvertApiClient::ApiError => e
@@ -176,7 +231,7 @@ end
176
231
 
177
232
  Name | Type | Description | Notes
178
233
  ------------- | ------------- | ------------- | -------------
179
- **json_object** | **Object**| Input JSON to convert to XML |
234
+ **json_object** | **Object**| Input JSON Object to convert to XML |
180
235
 
181
236
  ### Return type
182
237
 
@@ -64,7 +64,7 @@ Name | Type | Description | Notes
64
64
  ### HTTP request headers
65
65
 
66
66
  - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
67
- - **Accept**: application/octet-stream
67
+ - **Accept**: application/json, text/json, application/xml, text/xml
68
68
 
69
69
 
70
70
 
@@ -118,7 +118,7 @@ Name | Type | Description | Notes
118
118
  ### HTTP request headers
119
119
 
120
120
  - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
121
- - **Accept**: application/octet-stream
121
+ - **Accept**: application/json, text/json, application/xml, text/xml
122
122
 
123
123
 
124
124
 
@@ -172,7 +172,7 @@ Name | Type | Description | Notes
172
172
  ### HTTP request headers
173
173
 
174
174
  - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
175
- - **Accept**: application/octet-stream
175
+ - **Accept**: application/json, text/json, application/xml, text/xml
176
176
 
177
177
 
178
178
 
@@ -226,7 +226,7 @@ Name | Type | Description | Notes
226
226
  ### HTTP request headers
227
227
 
228
228
  - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
229
- - **Accept**: application/octet-stream
229
+ - **Accept**: application/json, text/json, application/xml, text/xml
230
230
 
231
231
 
232
232
 
@@ -280,7 +280,7 @@ Name | Type | Description | Notes
280
280
  ### HTTP request headers
281
281
 
282
282
  - **Content-Type**: multipart/form-data
283
- - **Accept**: application/octet-stream
283
+ - **Accept**: application/json, text/json, application/xml, text/xml
284
284
 
285
285
 
286
286
 
@@ -334,7 +334,7 @@ Name | Type | Description | Notes
334
334
  ### HTTP request headers
335
335
 
336
336
  - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
337
- - **Accept**: application/octet-stream
337
+ - **Accept**: application/json, text/json, application/xml, text/xml
338
338
 
339
339
 
340
340
 
@@ -388,7 +388,7 @@ Name | Type | Description | Notes
388
388
  ### HTTP request headers
389
389
 
390
390
  - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
391
- - **Accept**: application/octet-stream
391
+ - **Accept**: application/json, text/json, application/xml, text/xml
392
392
 
393
393
 
394
394
 
@@ -442,7 +442,7 @@ Name | Type | Description | Notes
442
442
  ### HTTP request headers
443
443
 
444
444
  - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
445
- - **Accept**: application/octet-stream
445
+ - **Accept**: application/json, text/json, application/xml, text/xml
446
446
 
447
447
 
448
448
 
@@ -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
+
@@ -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
+
@@ -251,7 +251,7 @@ Name | Type | Description | Notes
251
251
 
252
252
 
253
253
  # **transform_document_docx_table_fill_in_multi**
254
- > Object transform_document_docx_table_fill_in_multi(request)
254
+ > String transform_document_docx_table_fill_in_multi(request)
255
255
 
256
256
  Fill in data in multiple tables in a Word DOCX document, return result
257
257
 
@@ -291,7 +291,7 @@ Name | Type | Description | Notes
291
291
 
292
292
  ### Return type
293
293
 
294
- **Object**
294
+ **String**
295
295
 
296
296
  ### Authorization
297
297
 
@@ -300,7 +300,7 @@ Name | Type | Description | Notes
300
300
  ### HTTP request headers
301
301
 
302
302
  - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
303
- - **Accept**: application/octet-stream
303
+ - **Accept**: application/json, text/json, application/xml, text/xml
304
304
 
305
305
 
306
306