cloudmersive-convert-api-client 2.2.3 → 2.2.4

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3d04663be07d2325db820df2f804191d40cc98142b7911d5b9fe38cdc839b444
4
- data.tar.gz: 38ff522b6e239465685988cac35a6fe4389130823509c8372a00e3d37d9ee7f2
3
+ metadata.gz: d9e63d9393c7a9f6d86a416626bdde6f81741c460cd98cc68a0aac3db6ec4d98
4
+ data.tar.gz: eb071666c12849d681577930be0b22c9af7e5a3c8580cdb17871e84738d3274c
5
5
  SHA512:
6
- metadata.gz: a65439264897bcf13b4659cd1954523989ce9ab71f97a1686b8df598920645d70f0980b6230d472fa1644008e76c90ba51a3ff2b46e2735780ad3b2a5f3c34fb
7
- data.tar.gz: 3a5f66ddd154cd36e884a8cd946a3325426a8719ecf82b772091d208774809f2f3626560df867e1cf2d99433b052846c8ffbcee853bbf42ce113f4cda40f74b0
6
+ metadata.gz: fbf8f6de075705c19b518bb0dd76191d488b832c88219a2d6f8f2128e36d490ead0a998fbc5ed05b290e1daa23f2cd8eb85ea4374f39ed2b945be6305d28b35b
7
+ data.tar.gz: 6c3df2f663d5de0f6e5ca848c06e12d4e4b392ed3f2efc1a3dc8d47ab089792b9fe605e76765622ca1486356e45b550dfa439d5aa6417aa0111f6adab1b8e802
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.4
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.4.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.4.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.4'
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
@@ -414,6 +417,7 @@ Class | Method | HTTP request | Description
414
417
  - [CloudmersiveConvertApiClient::DocxBody](docs/DocxBody.md)
415
418
  - [CloudmersiveConvertApiClient::DocxCellStyle](docs/DocxCellStyle.md)
416
419
  - [CloudmersiveConvertApiClient::DocxComment](docs/DocxComment.md)
420
+ - [CloudmersiveConvertApiClient::DocxContentControl](docs/DocxContentControl.md)
417
421
  - [CloudmersiveConvertApiClient::DocxFooter](docs/DocxFooter.md)
418
422
  - [CloudmersiveConvertApiClient::DocxHeader](docs/DocxHeader.md)
419
423
  - [CloudmersiveConvertApiClient::DocxImage](docs/DocxImage.md)
@@ -431,6 +435,7 @@ Class | Method | HTTP request | Description
431
435
  - [CloudmersiveConvertApiClient::DocxSetFooterAddPageNumberRequest](docs/DocxSetFooterAddPageNumberRequest.md)
432
436
  - [CloudmersiveConvertApiClient::DocxSetFooterRequest](docs/DocxSetFooterRequest.md)
433
437
  - [CloudmersiveConvertApiClient::DocxSetFooterResponse](docs/DocxSetFooterResponse.md)
438
+ - [CloudmersiveConvertApiClient::DocxSetFormFieldsRequest](docs/DocxSetFormFieldsRequest.md)
434
439
  - [CloudmersiveConvertApiClient::DocxSetHeaderRequest](docs/DocxSetHeaderRequest.md)
435
440
  - [CloudmersiveConvertApiClient::DocxSetHeaderResponse](docs/DocxSetHeaderResponse.md)
436
441
  - [CloudmersiveConvertApiClient::DocxStyle](docs/DocxStyle.md)
@@ -455,6 +460,7 @@ Class | Method | HTTP request | Description
455
460
  - [CloudmersiveConvertApiClient::EnableSharedWorkbookRequest](docs/EnableSharedWorkbookRequest.md)
456
461
  - [CloudmersiveConvertApiClient::EnableSharedWorkbookResponse](docs/EnableSharedWorkbookResponse.md)
457
462
  - [CloudmersiveConvertApiClient::ExifValue](docs/ExifValue.md)
463
+ - [CloudmersiveConvertApiClient::FillHandlebarFormField](docs/FillHandlebarFormField.md)
458
464
  - [CloudmersiveConvertApiClient::FindDocxParagraphRequest](docs/FindDocxParagraphRequest.md)
459
465
  - [CloudmersiveConvertApiClient::FindDocxParagraphResponse](docs/FindDocxParagraphResponse.md)
460
466
  - [CloudmersiveConvertApiClient::FindRegexMatch](docs/FindRegexMatch.md)
@@ -468,8 +474,10 @@ Class | Method | HTTP request | Description
468
474
  - [CloudmersiveConvertApiClient::GetDocxBodyResponse](docs/GetDocxBodyResponse.md)
469
475
  - [CloudmersiveConvertApiClient::GetDocxCommentsHierarchicalResponse](docs/GetDocxCommentsHierarchicalResponse.md)
470
476
  - [CloudmersiveConvertApiClient::GetDocxCommentsResponse](docs/GetDocxCommentsResponse.md)
477
+ - [CloudmersiveConvertApiClient::GetDocxContentControlsResponse](docs/GetDocxContentControlsResponse.md)
471
478
  - [CloudmersiveConvertApiClient::GetDocxGetCommentsHierarchicalRequest](docs/GetDocxGetCommentsHierarchicalRequest.md)
472
479
  - [CloudmersiveConvertApiClient::GetDocxGetCommentsRequest](docs/GetDocxGetCommentsRequest.md)
480
+ - [CloudmersiveConvertApiClient::GetDocxGetFormFieldsResponse](docs/GetDocxGetFormFieldsResponse.md)
473
481
  - [CloudmersiveConvertApiClient::GetDocxHeadersAndFootersRequest](docs/GetDocxHeadersAndFootersRequest.md)
474
482
  - [CloudmersiveConvertApiClient::GetDocxHeadersAndFootersResponse](docs/GetDocxHeadersAndFootersResponse.md)
475
483
  - [CloudmersiveConvertApiClient::GetDocxImagesRequest](docs/GetDocxImagesRequest.md)
@@ -507,6 +515,7 @@ Class | Method | HTTP request | Description
507
515
  - [CloudmersiveConvertApiClient::GetXlsxStylesResponse](docs/GetXlsxStylesResponse.md)
508
516
  - [CloudmersiveConvertApiClient::GetXlsxWorksheetsRequest](docs/GetXlsxWorksheetsRequest.md)
509
517
  - [CloudmersiveConvertApiClient::GetXlsxWorksheetsResponse](docs/GetXlsxWorksheetsResponse.md)
518
+ - [CloudmersiveConvertApiClient::HandlebarFormField](docs/HandlebarFormField.md)
510
519
  - [CloudmersiveConvertApiClient::HtmlGetLanguageResult](docs/HtmlGetLanguageResult.md)
511
520
  - [CloudmersiveConvertApiClient::HtmlGetLinksResponse](docs/HtmlGetLinksResponse.md)
512
521
  - [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
+
@@ -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
+
@@ -671,6 +671,116 @@ module CloudmersiveConvertApiClient
671
671
  end
672
672
  return data, status_code, headers
673
673
  end
674
+ # Get all content controls (form fields) and values in a Word DOCX document
675
+ # Returns all the content controls, used for creating form fields, in a Office Word Document (docx)
676
+ # @param input_file Input file to perform the operation on.
677
+ # @param [Hash] opts the optional parameters
678
+ # @return [GetDocxContentControlsResponse]
679
+ def edit_document_docx_get_content_controls(input_file, opts = {})
680
+ data, _status_code, _headers = edit_document_docx_get_content_controls_with_http_info(input_file, opts)
681
+ data
682
+ end
683
+
684
+ # Get all content controls (form fields) and values in a Word DOCX document
685
+ # Returns all the content controls, used for creating form fields, in a Office Word Document (docx)
686
+ # @param input_file Input file to perform the operation on.
687
+ # @param [Hash] opts the optional parameters
688
+ # @return [Array<(GetDocxContentControlsResponse, Fixnum, Hash)>] GetDocxContentControlsResponse data, response status code and response headers
689
+ def edit_document_docx_get_content_controls_with_http_info(input_file, opts = {})
690
+ if @api_client.config.debugging
691
+ @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_get_content_controls ...'
692
+ end
693
+ # verify the required parameter 'input_file' is set
694
+ if @api_client.config.client_side_validation && input_file.nil?
695
+ fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_docx_get_content_controls"
696
+ end
697
+ # resource path
698
+ local_var_path = '/convert/edit/docx/get-content-controls'
699
+
700
+ # query parameters
701
+ query_params = {}
702
+
703
+ # header parameters
704
+ header_params = {}
705
+ # HTTP header 'Accept' (if needed)
706
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
707
+ # HTTP header 'Content-Type'
708
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
709
+
710
+ # form parameters
711
+ form_params = {}
712
+ form_params['inputFile'] = input_file
713
+
714
+ # http body (model)
715
+ post_body = nil
716
+ auth_names = ['Apikey']
717
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
718
+ :header_params => header_params,
719
+ :query_params => query_params,
720
+ :form_params => form_params,
721
+ :body => post_body,
722
+ :auth_names => auth_names,
723
+ :return_type => 'GetDocxContentControlsResponse')
724
+ if @api_client.config.debugging
725
+ @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_get_content_controls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
726
+ end
727
+ return data, status_code, headers
728
+ end
729
+ # Get all form fields in a Word DOCX document
730
+ # 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)
731
+ # @param input_file Input file to perform the operation on.
732
+ # @param [Hash] opts the optional parameters
733
+ # @return [GetDocxGetFormFieldsResponse]
734
+ def edit_document_docx_get_form_fields(input_file, opts = {})
735
+ data, _status_code, _headers = edit_document_docx_get_form_fields_with_http_info(input_file, opts)
736
+ data
737
+ end
738
+
739
+ # Get all form fields in a Word DOCX document
740
+ # Returns all the content controls, used for creating form fields, as well as handlebar style text-based form fields such as \&quot;{{FieldName}}\&quot;, in a Office Word Document (docx)
741
+ # @param input_file Input file to perform the operation on.
742
+ # @param [Hash] opts the optional parameters
743
+ # @return [Array<(GetDocxGetFormFieldsResponse, Fixnum, Hash)>] GetDocxGetFormFieldsResponse data, response status code and response headers
744
+ def edit_document_docx_get_form_fields_with_http_info(input_file, opts = {})
745
+ if @api_client.config.debugging
746
+ @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_get_form_fields ...'
747
+ end
748
+ # verify the required parameter 'input_file' is set
749
+ if @api_client.config.client_side_validation && input_file.nil?
750
+ fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_docx_get_form_fields"
751
+ end
752
+ # resource path
753
+ local_var_path = '/convert/edit/docx/get-form-fields'
754
+
755
+ # query parameters
756
+ query_params = {}
757
+
758
+ # header parameters
759
+ header_params = {}
760
+ # HTTP header 'Accept' (if needed)
761
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
762
+ # HTTP header 'Content-Type'
763
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
764
+
765
+ # form parameters
766
+ form_params = {}
767
+ form_params['inputFile'] = input_file
768
+
769
+ # http body (model)
770
+ post_body = nil
771
+ auth_names = ['Apikey']
772
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
773
+ :header_params => header_params,
774
+ :query_params => query_params,
775
+ :form_params => form_params,
776
+ :body => post_body,
777
+ :auth_names => auth_names,
778
+ :return_type => 'GetDocxGetFormFieldsResponse')
779
+ if @api_client.config.debugging
780
+ @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_get_form_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
781
+ end
782
+ return data, status_code, headers
783
+ end
674
784
  # Get content of a footer from a Word DOCX document
675
785
  # Returns the footer content from a Word Document (DOCX) format file
676
786
  # @param req_config Document input request
@@ -2024,6 +2134,60 @@ module CloudmersiveConvertApiClient
2024
2134
  end
2025
2135
  return data, status_code, headers
2026
2136
  end
2137
+ # Set and fill values for form fields in a Word DOCX document
2138
+ # Modifies a Office Word Document (docx) by filling in form fields using the provided values.
2139
+ # @param req_config
2140
+ # @param [Hash] opts the optional parameters
2141
+ # @return [String]
2142
+ def edit_document_docx_set_form_fields(req_config, opts = {})
2143
+ data, _status_code, _headers = edit_document_docx_set_form_fields_with_http_info(req_config, opts)
2144
+ data
2145
+ end
2146
+
2147
+ # Set and fill values for form fields in a Word DOCX document
2148
+ # Modifies a Office Word Document (docx) by filling in form fields using the provided values.
2149
+ # @param req_config
2150
+ # @param [Hash] opts the optional parameters
2151
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
2152
+ def edit_document_docx_set_form_fields_with_http_info(req_config, opts = {})
2153
+ if @api_client.config.debugging
2154
+ @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_set_form_fields ...'
2155
+ end
2156
+ # verify the required parameter 'req_config' is set
2157
+ if @api_client.config.client_side_validation && req_config.nil?
2158
+ fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_set_form_fields"
2159
+ end
2160
+ # resource path
2161
+ local_var_path = '/convert/edit/docx/set-form-fields'
2162
+
2163
+ # query parameters
2164
+ query_params = {}
2165
+
2166
+ # header parameters
2167
+ header_params = {}
2168
+ # HTTP header 'Accept' (if needed)
2169
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
2170
+ # HTTP header 'Content-Type'
2171
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
2172
+
2173
+ # form parameters
2174
+ form_params = {}
2175
+
2176
+ # http body (model)
2177
+ post_body = @api_client.object_to_http_body(req_config)
2178
+ auth_names = ['Apikey']
2179
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2180
+ :header_params => header_params,
2181
+ :query_params => query_params,
2182
+ :form_params => form_params,
2183
+ :body => post_body,
2184
+ :auth_names => auth_names,
2185
+ :return_type => 'String')
2186
+ if @api_client.config.debugging
2187
+ @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_set_form_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2188
+ end
2189
+ return data, status_code, headers
2190
+ end
2027
2191
  # Set the header in a Word DOCX document
2028
2192
  # Set the header in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
2029
2193
  # @param req_config Document input request