cloudmersive-convert-api-client 2.2.2 → 2.2.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +20 -4
- data/docs/DocxContentControl.md +8 -0
- data/docs/DocxSetFormFieldsRequest.md +10 -0
- data/docs/DocxTableSingleTableFill.md +10 -0
- data/docs/DocxTableTableFillMultiRequest.md +10 -0
- data/docs/EditDocumentApi.md +165 -0
- data/docs/FillHandlebarFormField.md +9 -0
- data/docs/GetDocxContentControlsResponse.md +9 -0
- data/docs/GetDocxGetFormFieldsResponse.md +10 -0
- data/docs/HandlebarFormField.md +8 -0
- data/docs/TransformDocumentApi.md +55 -0
- data/docs/ValidateDocumentApi.md +220 -0
- data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +164 -0
- data/lib/cloudmersive-convert-api-client/api/transform_document_api.rb +54 -0
- data/lib/cloudmersive-convert-api-client/api/validate_document_api.rb +220 -0
- data/lib/cloudmersive-convert-api-client/models/docx_content_control.rb +186 -0
- data/lib/cloudmersive-convert-api-client/models/docx_set_form_fields_request.rb +223 -0
- data/lib/cloudmersive-convert-api-client/models/docx_table_single_table_fill.rb +208 -0
- data/lib/cloudmersive-convert-api-client/models/docx_table_table_fill_multi_request.rb +223 -0
- data/lib/cloudmersive-convert-api-client/models/fill_handlebar_form_field.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_content_controls_response.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_get_form_fields_response.rb +210 -0
- data/lib/cloudmersive-convert-api-client/models/handlebar_form_field.rb +186 -0
- data/lib/cloudmersive-convert-api-client/version.rb +1 -1
- data/lib/cloudmersive-convert-api-client.rb +8 -0
- data/spec/api/edit_document_api_spec.rb +36 -0
- data/spec/api/transform_document_api_spec.rb +12 -0
- data/spec/api/validate_document_api_spec.rb +48 -0
- data/spec/models/docx_content_control_spec.rb +41 -0
- data/spec/models/docx_set_form_fields_request_spec.rb +53 -0
- data/spec/models/docx_table_single_table_fill_spec.rb +53 -0
- data/spec/models/docx_table_table_fill_multi_request_spec.rb +53 -0
- data/spec/models/fill_handlebar_form_field_spec.rb +47 -0
- data/spec/models/get_docx_content_controls_response_spec.rb +47 -0
- data/spec/models/get_docx_get_form_fields_response_spec.rb +53 -0
- data/spec/models/handlebar_form_field_spec.rb +41 -0
- metadata +26 -2
data/docs/ValidateDocumentApi.md
CHANGED
@@ -6,6 +6,7 @@ Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**validate_document_autodetect_validation**](ValidateDocumentApi.md#validate_document_autodetect_validation) | **POST** /convert/validate/autodetect | Autodetect content type and validate
|
8
8
|
[**validate_document_csv_validation**](ValidateDocumentApi.md#validate_document_csv_validation) | **POST** /convert/validate/csv | Validate a CSV file document (CSV)
|
9
|
+
[**validate_document_doc_validation**](ValidateDocumentApi.md#validate_document_doc_validation) | **POST** /convert/validate/doc | Validate a Word 97-2003 Legacy document (DOC)
|
9
10
|
[**validate_document_docx_validation**](ValidateDocumentApi.md#validate_document_docx_validation) | **POST** /convert/validate/docx | Validate a Word document (DOCX)
|
10
11
|
[**validate_document_eml_validation**](ValidateDocumentApi.md#validate_document_eml_validation) | **POST** /convert/validate/eml | Validate if an EML file is executable
|
11
12
|
[**validate_document_executable_validation**](ValidateDocumentApi.md#validate_document_executable_validation) | **POST** /convert/validate/executable | Validate if a file is executable
|
@@ -18,10 +19,13 @@ Method | HTTP request | Description
|
|
18
19
|
[**validate_document_msg_validation**](ValidateDocumentApi.md#validate_document_msg_validation) | **POST** /convert/validate/msg | Validate if an MSG file is executable
|
19
20
|
[**validate_document_pdf_validation**](ValidateDocumentApi.md#validate_document_pdf_validation) | **POST** /convert/validate/pdf | Validate a PDF document file
|
20
21
|
[**validate_document_png_validation**](ValidateDocumentApi.md#validate_document_png_validation) | **POST** /convert/validate/png | Validate a PNG File
|
22
|
+
[**validate_document_ppt_validation**](ValidateDocumentApi.md#validate_document_ppt_validation) | **POST** /convert/validate/ppt | Validate a PowerPoint 97-2003 Legacy presentation (PPT)
|
21
23
|
[**validate_document_pptx_validation**](ValidateDocumentApi.md#validate_document_pptx_validation) | **POST** /convert/validate/pptx | Validate a PowerPoint presentation (PPTX)
|
22
24
|
[**validate_document_rar_validation**](ValidateDocumentApi.md#validate_document_rar_validation) | **POST** /convert/validate/rar | Validate a RAR Archive file (RAR)
|
25
|
+
[**validate_document_rtf_validation**](ValidateDocumentApi.md#validate_document_rtf_validation) | **POST** /convert/validate/rtf | Validate a Rich Text Format document (RTF)
|
23
26
|
[**validate_document_tar_validation**](ValidateDocumentApi.md#validate_document_tar_validation) | **POST** /convert/validate/tar | Validate a TAR Tarball Archive file (TAR)
|
24
27
|
[**validate_document_txt_validation**](ValidateDocumentApi.md#validate_document_txt_validation) | **POST** /convert/validate/txt | Validate an TXT file
|
28
|
+
[**validate_document_xls_validation**](ValidateDocumentApi.md#validate_document_xls_validation) | **POST** /convert/validate/xls | Validate a Excel 97-2003 Legacy spreadsheet (XLS)
|
25
29
|
[**validate_document_xlsx_validation**](ValidateDocumentApi.md#validate_document_xlsx_validation) | **POST** /convert/validate/xlsx | Validate a Excel document (XLSX)
|
26
30
|
[**validate_document_xml_validation**](ValidateDocumentApi.md#validate_document_xml_validation) | **POST** /convert/validate/xml | Validate an XML file
|
27
31
|
[**validate_document_xml_xxe_threat_validation**](ValidateDocumentApi.md#validate_document_xml_xxe_threat_validation) | **POST** /convert/validate/xml/xxe-threats | Validate an XML file for XML External Entity (XXE) threats
|
@@ -136,6 +140,60 @@ Name | Type | Description | Notes
|
|
136
140
|
|
137
141
|
|
138
142
|
|
143
|
+
# **validate_document_doc_validation**
|
144
|
+
> DocumentValidationResult validate_document_doc_validation(input_file)
|
145
|
+
|
146
|
+
Validate a Word 97-2003 Legacy document (DOC)
|
147
|
+
|
148
|
+
Validate a Word 97-2003 Legacy document (DOC)
|
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::ValidateDocumentApi.new
|
163
|
+
|
164
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
165
|
+
|
166
|
+
|
167
|
+
begin
|
168
|
+
#Validate a Word 97-2003 Legacy document (DOC)
|
169
|
+
result = api_instance.validate_document_doc_validation(input_file)
|
170
|
+
p result
|
171
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
172
|
+
puts "Exception when calling ValidateDocumentApi->validate_document_doc_validation: #{e}"
|
173
|
+
end
|
174
|
+
```
|
175
|
+
|
176
|
+
### Parameters
|
177
|
+
|
178
|
+
Name | Type | Description | Notes
|
179
|
+
------------- | ------------- | ------------- | -------------
|
180
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
181
|
+
|
182
|
+
### Return type
|
183
|
+
|
184
|
+
[**DocumentValidationResult**](DocumentValidationResult.md)
|
185
|
+
|
186
|
+
### Authorization
|
187
|
+
|
188
|
+
[Apikey](../README.md#Apikey)
|
189
|
+
|
190
|
+
### HTTP request headers
|
191
|
+
|
192
|
+
- **Content-Type**: multipart/form-data
|
193
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
194
|
+
|
195
|
+
|
196
|
+
|
139
197
|
# **validate_document_docx_validation**
|
140
198
|
> DocumentValidationResult validate_document_docx_validation(input_file)
|
141
199
|
|
@@ -784,6 +842,60 @@ Name | Type | Description | Notes
|
|
784
842
|
|
785
843
|
|
786
844
|
|
845
|
+
# **validate_document_ppt_validation**
|
846
|
+
> DocumentValidationResult validate_document_ppt_validation(input_file)
|
847
|
+
|
848
|
+
Validate a PowerPoint 97-2003 Legacy presentation (PPT)
|
849
|
+
|
850
|
+
Validate a PowerPoint 97-2003 Legacy presentation (PPT)
|
851
|
+
|
852
|
+
### Example
|
853
|
+
```ruby
|
854
|
+
# load the gem
|
855
|
+
require 'cloudmersive-convert-api-client'
|
856
|
+
# setup authorization
|
857
|
+
CloudmersiveConvertApiClient.configure do |config|
|
858
|
+
# Configure API key authorization: Apikey
|
859
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
860
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
861
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
862
|
+
end
|
863
|
+
|
864
|
+
api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
|
865
|
+
|
866
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
867
|
+
|
868
|
+
|
869
|
+
begin
|
870
|
+
#Validate a PowerPoint 97-2003 Legacy presentation (PPT)
|
871
|
+
result = api_instance.validate_document_ppt_validation(input_file)
|
872
|
+
p result
|
873
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
874
|
+
puts "Exception when calling ValidateDocumentApi->validate_document_ppt_validation: #{e}"
|
875
|
+
end
|
876
|
+
```
|
877
|
+
|
878
|
+
### Parameters
|
879
|
+
|
880
|
+
Name | Type | Description | Notes
|
881
|
+
------------- | ------------- | ------------- | -------------
|
882
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
883
|
+
|
884
|
+
### Return type
|
885
|
+
|
886
|
+
[**DocumentValidationResult**](DocumentValidationResult.md)
|
887
|
+
|
888
|
+
### Authorization
|
889
|
+
|
890
|
+
[Apikey](../README.md#Apikey)
|
891
|
+
|
892
|
+
### HTTP request headers
|
893
|
+
|
894
|
+
- **Content-Type**: multipart/form-data
|
895
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
896
|
+
|
897
|
+
|
898
|
+
|
787
899
|
# **validate_document_pptx_validation**
|
788
900
|
> DocumentValidationResult validate_document_pptx_validation(input_file)
|
789
901
|
|
@@ -892,6 +1004,60 @@ Name | Type | Description | Notes
|
|
892
1004
|
|
893
1005
|
|
894
1006
|
|
1007
|
+
# **validate_document_rtf_validation**
|
1008
|
+
> DocumentValidationResult validate_document_rtf_validation(input_file)
|
1009
|
+
|
1010
|
+
Validate a Rich Text Format document (RTF)
|
1011
|
+
|
1012
|
+
Validate a Rich Text Format document (RTF)
|
1013
|
+
|
1014
|
+
### Example
|
1015
|
+
```ruby
|
1016
|
+
# load the gem
|
1017
|
+
require 'cloudmersive-convert-api-client'
|
1018
|
+
# setup authorization
|
1019
|
+
CloudmersiveConvertApiClient.configure do |config|
|
1020
|
+
# Configure API key authorization: Apikey
|
1021
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
1022
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1023
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
1024
|
+
end
|
1025
|
+
|
1026
|
+
api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
|
1027
|
+
|
1028
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
1029
|
+
|
1030
|
+
|
1031
|
+
begin
|
1032
|
+
#Validate a Rich Text Format document (RTF)
|
1033
|
+
result = api_instance.validate_document_rtf_validation(input_file)
|
1034
|
+
p result
|
1035
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
1036
|
+
puts "Exception when calling ValidateDocumentApi->validate_document_rtf_validation: #{e}"
|
1037
|
+
end
|
1038
|
+
```
|
1039
|
+
|
1040
|
+
### Parameters
|
1041
|
+
|
1042
|
+
Name | Type | Description | Notes
|
1043
|
+
------------- | ------------- | ------------- | -------------
|
1044
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
1045
|
+
|
1046
|
+
### Return type
|
1047
|
+
|
1048
|
+
[**DocumentValidationResult**](DocumentValidationResult.md)
|
1049
|
+
|
1050
|
+
### Authorization
|
1051
|
+
|
1052
|
+
[Apikey](../README.md#Apikey)
|
1053
|
+
|
1054
|
+
### HTTP request headers
|
1055
|
+
|
1056
|
+
- **Content-Type**: multipart/form-data
|
1057
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
1058
|
+
|
1059
|
+
|
1060
|
+
|
895
1061
|
# **validate_document_tar_validation**
|
896
1062
|
> DocumentValidationResult validate_document_tar_validation(input_file)
|
897
1063
|
|
@@ -1000,6 +1166,60 @@ Name | Type | Description | Notes
|
|
1000
1166
|
|
1001
1167
|
|
1002
1168
|
|
1169
|
+
# **validate_document_xls_validation**
|
1170
|
+
> DocumentValidationResult validate_document_xls_validation(input_file)
|
1171
|
+
|
1172
|
+
Validate a Excel 97-2003 Legacy spreadsheet (XLS)
|
1173
|
+
|
1174
|
+
Validate a Excel 97-2003 Legacy spreadsheet (XLS)
|
1175
|
+
|
1176
|
+
### Example
|
1177
|
+
```ruby
|
1178
|
+
# load the gem
|
1179
|
+
require 'cloudmersive-convert-api-client'
|
1180
|
+
# setup authorization
|
1181
|
+
CloudmersiveConvertApiClient.configure do |config|
|
1182
|
+
# Configure API key authorization: Apikey
|
1183
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
1184
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1185
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
1186
|
+
end
|
1187
|
+
|
1188
|
+
api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
|
1189
|
+
|
1190
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
1191
|
+
|
1192
|
+
|
1193
|
+
begin
|
1194
|
+
#Validate a Excel 97-2003 Legacy spreadsheet (XLS)
|
1195
|
+
result = api_instance.validate_document_xls_validation(input_file)
|
1196
|
+
p result
|
1197
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
1198
|
+
puts "Exception when calling ValidateDocumentApi->validate_document_xls_validation: #{e}"
|
1199
|
+
end
|
1200
|
+
```
|
1201
|
+
|
1202
|
+
### Parameters
|
1203
|
+
|
1204
|
+
Name | Type | Description | Notes
|
1205
|
+
------------- | ------------- | ------------- | -------------
|
1206
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
1207
|
+
|
1208
|
+
### Return type
|
1209
|
+
|
1210
|
+
[**DocumentValidationResult**](DocumentValidationResult.md)
|
1211
|
+
|
1212
|
+
### Authorization
|
1213
|
+
|
1214
|
+
[Apikey](../README.md#Apikey)
|
1215
|
+
|
1216
|
+
### HTTP request headers
|
1217
|
+
|
1218
|
+
- **Content-Type**: multipart/form-data
|
1219
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
1220
|
+
|
1221
|
+
|
1222
|
+
|
1003
1223
|
# **validate_document_xlsx_validation**
|
1004
1224
|
> DocumentValidationResult validate_document_xlsx_validation(input_file)
|
1005
1225
|
|
@@ -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 \"{{FieldName}}\", 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
|
@@ -265,6 +265,60 @@ module CloudmersiveConvertApiClient
|
|
265
265
|
end
|
266
266
|
return data, status_code, headers
|
267
267
|
end
|
268
|
+
# Fill in data in multiple tables in a Word DOCX document, return result
|
269
|
+
# Replace placeholder rows in multiple tables in an Office Word Document (docx) using one or more templates
|
270
|
+
# @param request
|
271
|
+
# @param [Hash] opts the optional parameters
|
272
|
+
# @return [String]
|
273
|
+
def transform_document_docx_table_fill_in_multi(request, opts = {})
|
274
|
+
data, _status_code, _headers = transform_document_docx_table_fill_in_multi_with_http_info(request, opts)
|
275
|
+
data
|
276
|
+
end
|
277
|
+
|
278
|
+
# Fill in data in multiple tables in a Word DOCX document, return result
|
279
|
+
# Replace placeholder rows in multiple tables in an Office Word Document (docx) using one or more templates
|
280
|
+
# @param request
|
281
|
+
# @param [Hash] opts the optional parameters
|
282
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
283
|
+
def transform_document_docx_table_fill_in_multi_with_http_info(request, opts = {})
|
284
|
+
if @api_client.config.debugging
|
285
|
+
@api_client.config.logger.debug 'Calling API: TransformDocumentApi.transform_document_docx_table_fill_in_multi ...'
|
286
|
+
end
|
287
|
+
# verify the required parameter 'request' is set
|
288
|
+
if @api_client.config.client_side_validation && request.nil?
|
289
|
+
fail ArgumentError, "Missing the required parameter 'request' when calling TransformDocumentApi.transform_document_docx_table_fill_in_multi"
|
290
|
+
end
|
291
|
+
# resource path
|
292
|
+
local_var_path = '/convert/transform/docx/table/fill/data/multi'
|
293
|
+
|
294
|
+
# query parameters
|
295
|
+
query_params = {}
|
296
|
+
|
297
|
+
# header parameters
|
298
|
+
header_params = {}
|
299
|
+
# HTTP header 'Accept' (if needed)
|
300
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
301
|
+
# HTTP header 'Content-Type'
|
302
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
303
|
+
|
304
|
+
# form parameters
|
305
|
+
form_params = {}
|
306
|
+
|
307
|
+
# http body (model)
|
308
|
+
post_body = @api_client.object_to_http_body(request)
|
309
|
+
auth_names = ['Apikey']
|
310
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
311
|
+
:header_params => header_params,
|
312
|
+
:query_params => query_params,
|
313
|
+
:form_params => form_params,
|
314
|
+
:body => post_body,
|
315
|
+
:auth_names => auth_names,
|
316
|
+
:return_type => 'String')
|
317
|
+
if @api_client.config.debugging
|
318
|
+
@api_client.config.logger.debug "API called: TransformDocumentApi#transform_document_docx_table_fill_in_multi\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
319
|
+
end
|
320
|
+
return data, status_code, headers
|
321
|
+
end
|
268
322
|
# Replace string in PowerPoint PPTX presentation, return result
|
269
323
|
# Replace all instances of a string in an Office PowerPoint Document (pptx)
|
270
324
|
# @param match_string String to search for and match against, to be replaced
|