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.
- checksums.yaml +4 -4
- data/README.md +19 -5
- data/docs/ConvertDataApi.md +60 -5
- data/docs/ConvertWebApi.md +8 -8
- data/docs/DocxContentControl.md +8 -0
- data/docs/DocxSetFormFieldsRequest.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 +3 -3
- data/docs/ValidateDocumentApi.md +220 -0
- data/lib/cloudmersive-convert-api-client/api/convert_data_api.rb +57 -4
- data/lib/cloudmersive-convert-api-client/api/convert_web_api.rb +8 -8
- data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +164 -0
- data/lib/cloudmersive-convert-api-client/api/transform_document_api.rb +4 -4
- 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/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 +6 -0
- data/spec/api/convert_data_api_spec.rb +14 -2
- data/spec/api/edit_document_api_spec.rb +36 -0
- data/spec/api/transform_document_api_spec.rb +1 -1
- 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/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 +20 -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
|
|
@@ -135,9 +135,62 @@ module CloudmersiveConvertApiClient
|
|
135
135
|
end
|
136
136
|
return data, status_code, headers
|
137
137
|
end
|
138
|
-
# Convert JSON to XML conversion
|
138
|
+
# Convert JSON String to XML conversion
|
139
139
|
# Convert a JSON object into XML
|
140
|
-
# @param
|
140
|
+
# @param json_string Input JSON String to convert to XML
|
141
|
+
# @param [Hash] opts the optional parameters
|
142
|
+
# @return [Object]
|
143
|
+
def convert_data_json_string_to_xml(json_string, opts = {})
|
144
|
+
data, _status_code, _headers = convert_data_json_string_to_xml_with_http_info(json_string, opts)
|
145
|
+
data
|
146
|
+
end
|
147
|
+
|
148
|
+
# Convert JSON String to XML conversion
|
149
|
+
# Convert a JSON object into XML
|
150
|
+
# @param json_string Input JSON String to convert to XML
|
151
|
+
# @param [Hash] opts the optional parameters
|
152
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
153
|
+
def convert_data_json_string_to_xml_with_http_info(json_string, opts = {})
|
154
|
+
if @api_client.config.debugging
|
155
|
+
@api_client.config.logger.debug 'Calling API: ConvertDataApi.convert_data_json_string_to_xml ...'
|
156
|
+
end
|
157
|
+
# verify the required parameter 'json_string' is set
|
158
|
+
if @api_client.config.client_side_validation && json_string.nil?
|
159
|
+
fail ArgumentError, "Missing the required parameter 'json_string' when calling ConvertDataApi.convert_data_json_string_to_xml"
|
160
|
+
end
|
161
|
+
# resource path
|
162
|
+
local_var_path = '/convert/json-string/to/xml'
|
163
|
+
|
164
|
+
# query parameters
|
165
|
+
query_params = {}
|
166
|
+
query_params[:'JsonString'] = json_string
|
167
|
+
|
168
|
+
# header parameters
|
169
|
+
header_params = {}
|
170
|
+
# HTTP header 'Accept' (if needed)
|
171
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/xml'])
|
172
|
+
|
173
|
+
# form parameters
|
174
|
+
form_params = {}
|
175
|
+
|
176
|
+
# http body (model)
|
177
|
+
post_body = nil
|
178
|
+
auth_names = ['Apikey']
|
179
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
180
|
+
:header_params => header_params,
|
181
|
+
:query_params => query_params,
|
182
|
+
:form_params => form_params,
|
183
|
+
:body => post_body,
|
184
|
+
:auth_names => auth_names,
|
185
|
+
:return_type => 'Object')
|
186
|
+
if @api_client.config.debugging
|
187
|
+
@api_client.config.logger.debug "API called: ConvertDataApi#convert_data_json_string_to_xml\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
188
|
+
end
|
189
|
+
return data, status_code, headers
|
190
|
+
end
|
191
|
+
# Convert JSON Object to XML conversion
|
192
|
+
# Convert a JSON object into XML
|
193
|
+
# @param json_object Input JSON Object to convert to XML
|
141
194
|
# @param [Hash] opts the optional parameters
|
142
195
|
# @return [String]
|
143
196
|
def convert_data_json_to_xml(json_object, opts = {})
|
@@ -145,9 +198,9 @@ module CloudmersiveConvertApiClient
|
|
145
198
|
data
|
146
199
|
end
|
147
200
|
|
148
|
-
# Convert JSON to XML conversion
|
201
|
+
# Convert JSON Object to XML conversion
|
149
202
|
# Convert a JSON object into XML
|
150
|
-
# @param json_object Input JSON to convert to XML
|
203
|
+
# @param json_object Input JSON Object to convert to XML
|
151
204
|
# @param [Hash] opts the optional parameters
|
152
205
|
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
153
206
|
def convert_data_json_to_xml_with_http_info(json_object, opts = {})
|
@@ -51,7 +51,7 @@ module CloudmersiveConvertApiClient
|
|
51
51
|
# header parameters
|
52
52
|
header_params = {}
|
53
53
|
# HTTP header 'Accept' (if needed)
|
54
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
55
55
|
# HTTP header 'Content-Type'
|
56
56
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
57
57
|
|
@@ -105,7 +105,7 @@ module CloudmersiveConvertApiClient
|
|
105
105
|
# header parameters
|
106
106
|
header_params = {}
|
107
107
|
# HTTP header 'Accept' (if needed)
|
108
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/
|
108
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
109
109
|
# HTTP header 'Content-Type'
|
110
110
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
111
111
|
|
@@ -159,7 +159,7 @@ module CloudmersiveConvertApiClient
|
|
159
159
|
# header parameters
|
160
160
|
header_params = {}
|
161
161
|
# HTTP header 'Accept' (if needed)
|
162
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/
|
162
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
163
163
|
# HTTP header 'Content-Type'
|
164
164
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
165
165
|
|
@@ -213,7 +213,7 @@ module CloudmersiveConvertApiClient
|
|
213
213
|
# header parameters
|
214
214
|
header_params = {}
|
215
215
|
# HTTP header 'Accept' (if needed)
|
216
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/
|
216
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
217
217
|
# HTTP header 'Content-Type'
|
218
218
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
219
219
|
|
@@ -267,7 +267,7 @@ module CloudmersiveConvertApiClient
|
|
267
267
|
# header parameters
|
268
268
|
header_params = {}
|
269
269
|
# HTTP header 'Accept' (if needed)
|
270
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/
|
270
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
271
271
|
# HTTP header 'Content-Type'
|
272
272
|
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
273
273
|
|
@@ -322,7 +322,7 @@ module CloudmersiveConvertApiClient
|
|
322
322
|
# header parameters
|
323
323
|
header_params = {}
|
324
324
|
# HTTP header 'Accept' (if needed)
|
325
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/
|
325
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
326
326
|
# HTTP header 'Content-Type'
|
327
327
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
328
328
|
|
@@ -376,7 +376,7 @@ module CloudmersiveConvertApiClient
|
|
376
376
|
# header parameters
|
377
377
|
header_params = {}
|
378
378
|
# HTTP header 'Accept' (if needed)
|
379
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/
|
379
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
380
380
|
# HTTP header 'Content-Type'
|
381
381
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
382
382
|
|
@@ -430,7 +430,7 @@ module CloudmersiveConvertApiClient
|
|
430
430
|
# header parameters
|
431
431
|
header_params = {}
|
432
432
|
# HTTP header 'Accept' (if needed)
|
433
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/
|
433
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
434
434
|
# HTTP header 'Content-Type'
|
435
435
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
436
436
|
|
@@ -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
|
@@ -269,7 +269,7 @@ module CloudmersiveConvertApiClient
|
|
269
269
|
# Replace placeholder rows in multiple tables in an Office Word Document (docx) using one or more templates
|
270
270
|
# @param request
|
271
271
|
# @param [Hash] opts the optional parameters
|
272
|
-
# @return [
|
272
|
+
# @return [String]
|
273
273
|
def transform_document_docx_table_fill_in_multi(request, opts = {})
|
274
274
|
data, _status_code, _headers = transform_document_docx_table_fill_in_multi_with_http_info(request, opts)
|
275
275
|
data
|
@@ -279,7 +279,7 @@ module CloudmersiveConvertApiClient
|
|
279
279
|
# Replace placeholder rows in multiple tables in an Office Word Document (docx) using one or more templates
|
280
280
|
# @param request
|
281
281
|
# @param [Hash] opts the optional parameters
|
282
|
-
# @return [Array<(
|
282
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
283
283
|
def transform_document_docx_table_fill_in_multi_with_http_info(request, opts = {})
|
284
284
|
if @api_client.config.debugging
|
285
285
|
@api_client.config.logger.debug 'Calling API: TransformDocumentApi.transform_document_docx_table_fill_in_multi ...'
|
@@ -297,7 +297,7 @@ module CloudmersiveConvertApiClient
|
|
297
297
|
# header parameters
|
298
298
|
header_params = {}
|
299
299
|
# HTTP header 'Accept' (if needed)
|
300
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/
|
300
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
301
301
|
# HTTP header 'Content-Type'
|
302
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
303
|
|
@@ -313,7 +313,7 @@ module CloudmersiveConvertApiClient
|
|
313
313
|
:form_params => form_params,
|
314
314
|
:body => post_body,
|
315
315
|
:auth_names => auth_names,
|
316
|
-
:return_type => '
|
316
|
+
:return_type => 'String')
|
317
317
|
if @api_client.config.debugging
|
318
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
319
|
end
|