cloudmersive-convert-api-client 2.1.8 → 2.2.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +26 -7
- data/docs/DocumentEditingEditSession.md +9 -0
- data/docs/DocumentTransformEditSession.md +9 -0
- data/docs/DocxTableTableFillRequest.md +12 -0
- data/docs/DocxTableTableFillTableCell.md +9 -0
- data/docs/DocxTableTableFillTableRow.md +8 -0
- data/docs/EditDocumentApi.md +58 -3
- data/docs/EditHtmlApi.md +418 -0
- data/docs/EditPdfApi.md +6 -2
- data/docs/HtmlGetLanguageResult.md +9 -0
- data/docs/HtmlGetRelCanonicalUrlResult.md +9 -0
- data/docs/HtmlGetSitemapUrlResult.md +9 -0
- data/docs/MergeDocumentApi.md +2 -2
- data/docs/TransformDocumentApi.md +182 -6
- data/lib/cloudmersive-convert-api-client.rb +8 -0
- data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +56 -2
- data/lib/cloudmersive-convert-api-client/api/edit_html_api.rb +392 -0
- data/lib/cloudmersive-convert-api-client/api/edit_pdf_api.rb +3 -0
- data/lib/cloudmersive-convert-api-client/api/merge_document_api.rb +3 -3
- data/lib/cloudmersive-convert-api-client/api/transform_document_api.rb +181 -4
- data/lib/cloudmersive-convert-api-client/models/document_editing_edit_session.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/document_transform_edit_session.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/docx_table_table_fill_request.rb +243 -0
- data/lib/cloudmersive-convert-api-client/models/docx_table_table_fill_table_cell.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/docx_table_table_fill_table_row.rb +188 -0
- data/lib/cloudmersive-convert-api-client/models/html_get_language_result.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/html_get_rel_canonical_url_result.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/html_get_sitemap_url_result.rb +196 -0
- data/lib/cloudmersive-convert-api-client/version.rb +1 -1
- data/spec/api/edit_document_api_spec.rb +13 -1
- data/spec/api/edit_html_api_spec.rb +95 -0
- data/spec/api/edit_pdf_api_spec.rb +1 -0
- data/spec/api/merge_document_api_spec.rb +1 -1
- data/spec/api/transform_document_api_spec.rb +42 -2
- data/spec/models/document_editing_edit_session_spec.rb +47 -0
- data/spec/models/document_transform_edit_session_spec.rb +47 -0
- data/spec/models/docx_table_table_fill_request_spec.rb +65 -0
- data/spec/models/docx_table_table_fill_table_cell_spec.rb +47 -0
- data/spec/models/docx_table_table_fill_table_row_spec.rb +41 -0
- data/spec/models/html_get_language_result_spec.rb +47 -0
- data/spec/models/html_get_rel_canonical_url_result_spec.rb +47 -0
- data/spec/models/html_get_sitemap_url_result_spec.rb +47 -0
- metadata +26 -2
data/docs/EditPdfApi.md
CHANGED
@@ -714,7 +714,7 @@ Name | Type | Description | Notes
|
|
714
714
|
|
715
715
|
|
716
716
|
# **edit_pdf_reduce_file_size**
|
717
|
-
> String edit_pdf_reduce_file_size(input_file)
|
717
|
+
> String edit_pdf_reduce_file_size(input_file, opts)
|
718
718
|
|
719
719
|
Reduce the file size and optimize a PDF
|
720
720
|
|
@@ -736,10 +736,13 @@ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
|
|
736
736
|
|
737
737
|
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
738
738
|
|
739
|
+
opts = {
|
740
|
+
quality: 8.14 # Float | Quality level for the images in the PDF, ranging from 0.0 (low quality) to 1.0 (high quality); default is 0.3
|
741
|
+
}
|
739
742
|
|
740
743
|
begin
|
741
744
|
#Reduce the file size and optimize a PDF
|
742
|
-
result = api_instance.edit_pdf_reduce_file_size(input_file)
|
745
|
+
result = api_instance.edit_pdf_reduce_file_size(input_file, opts)
|
743
746
|
p result
|
744
747
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
745
748
|
puts "Exception when calling EditPdfApi->edit_pdf_reduce_file_size: #{e}"
|
@@ -751,6 +754,7 @@ end
|
|
751
754
|
Name | Type | Description | Notes
|
752
755
|
------------- | ------------- | ------------- | -------------
|
753
756
|
**input_file** | **File**| Input file to perform the operation on. |
|
757
|
+
**quality** | **Float**| Quality level for the images in the PDF, ranging from 0.0 (low quality) to 1.0 (high quality); default is 0.3 | [optional]
|
754
758
|
|
755
759
|
### Return type
|
756
760
|
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::HtmlGetLanguageResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
7
|
+
**language_code** | **String** | HTML language code of the HTML document, e.g. \"en\" or \"de\" | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::HtmlGetRelCanonicalUrlResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
7
|
+
**canonical_url** | **String** | HTML canonical URL if present | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::HtmlGetSitemapUrlResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
7
|
+
**canonical_url** | **String** | HTML sitemap URL if present | [optional]
|
8
|
+
|
9
|
+
|
data/docs/MergeDocumentApi.md
CHANGED
@@ -153,7 +153,7 @@ Name | Type | Description | Notes
|
|
153
153
|
|
154
154
|
|
155
155
|
# **merge_document_html**
|
156
|
-
>
|
156
|
+
> String merge_document_html(input_file1, input_file2)
|
157
157
|
|
158
158
|
Merge Two HTML (HTM) Files Together
|
159
159
|
|
@@ -196,7 +196,7 @@ Name | Type | Description | Notes
|
|
196
196
|
|
197
197
|
### Return type
|
198
198
|
|
199
|
-
**
|
199
|
+
**String**
|
200
200
|
|
201
201
|
### Authorization
|
202
202
|
|
@@ -4,14 +4,17 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**transform_document_docx_replace**](TransformDocumentApi.md#transform_document_docx_replace) | **POST** /convert/transform/docx/replace-all | Replace string in Word DOCX document
|
8
|
-
[**
|
7
|
+
[**transform_document_docx_replace**](TransformDocumentApi.md#transform_document_docx_replace) | **POST** /convert/transform/docx/replace-all | Replace string in Word DOCX document, return result
|
8
|
+
[**transform_document_docx_replace_edit_session**](TransformDocumentApi.md#transform_document_docx_replace_edit_session) | **POST** /convert/transform/docx/replace-all/edit-session | Replace string in Word DOCX document, return edit session
|
9
|
+
[**transform_document_docx_table_fill_in**](TransformDocumentApi.md#transform_document_docx_table_fill_in) | **POST** /convert/transform/docx/table/fill/data | Fill in data in a table in a Word DOCX document, return result
|
10
|
+
[**transform_document_docx_table_fill_in_edit_session**](TransformDocumentApi.md#transform_document_docx_table_fill_in_edit_session) | **POST** /convert/transform/docx/table/fill/data/edit-session | Fill in data in a table in a Word DOCX document, return edit session
|
11
|
+
[**transform_document_pptx_replace**](TransformDocumentApi.md#transform_document_pptx_replace) | **POST** /convert/transform/pptx/replace-all | Replace string in PowerPoint PPTX presentation, return result
|
9
12
|
|
10
13
|
|
11
14
|
# **transform_document_docx_replace**
|
12
15
|
> String transform_document_docx_replace(match_string, replace_string, opts)
|
13
16
|
|
14
|
-
Replace string in Word DOCX document
|
17
|
+
Replace string in Word DOCX document, return result
|
15
18
|
|
16
19
|
Replace all instances of a string in an Office Word Document (docx)
|
17
20
|
|
@@ -40,7 +43,7 @@ opts = {
|
|
40
43
|
}
|
41
44
|
|
42
45
|
begin
|
43
|
-
#Replace string in Word DOCX document
|
46
|
+
#Replace string in Word DOCX document, return result
|
44
47
|
result = api_instance.transform_document_docx_replace(match_string, replace_string, opts)
|
45
48
|
p result
|
46
49
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -73,10 +76,183 @@ Name | Type | Description | Notes
|
|
73
76
|
|
74
77
|
|
75
78
|
|
79
|
+
# **transform_document_docx_replace_edit_session**
|
80
|
+
> DocumentTransformEditSession transform_document_docx_replace_edit_session(match_string, replace_string, opts)
|
81
|
+
|
82
|
+
Replace string in Word DOCX document, return edit session
|
83
|
+
|
84
|
+
Replace all instances of a string in an Office Word Document (docx). Returns an edit session URL so that you can chain together multiple edit operations without having to send the entire document contents back and forth multiple times. Call the Finish Editing API to retrieve the final document once editing is complete.
|
85
|
+
|
86
|
+
### Example
|
87
|
+
```ruby
|
88
|
+
# load the gem
|
89
|
+
require 'cloudmersive-convert-api-client'
|
90
|
+
# setup authorization
|
91
|
+
CloudmersiveConvertApiClient.configure do |config|
|
92
|
+
# Configure API key authorization: Apikey
|
93
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
94
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
95
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
96
|
+
end
|
97
|
+
|
98
|
+
api_instance = CloudmersiveConvertApiClient::TransformDocumentApi.new
|
99
|
+
|
100
|
+
match_string = 'match_string_example' # String | String to search for and match against, to be replaced
|
101
|
+
|
102
|
+
replace_string = 'replace_string_example' # String | String to replace the matched values with
|
103
|
+
|
104
|
+
opts = {
|
105
|
+
input_file: File.new('/path/to/file.txt'), # File | Optional: Input file to perform the operation on.
|
106
|
+
input_file_url: 'input_file_url_example', # 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 (part of EditDocumentApi) to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
|
107
|
+
match_case: true # BOOLEAN | Optional: True if the case should be matched, false for case insensitive match. Default is false.
|
108
|
+
}
|
109
|
+
|
110
|
+
begin
|
111
|
+
#Replace string in Word DOCX document, return edit session
|
112
|
+
result = api_instance.transform_document_docx_replace_edit_session(match_string, replace_string, opts)
|
113
|
+
p result
|
114
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
115
|
+
puts "Exception when calling TransformDocumentApi->transform_document_docx_replace_edit_session: #{e}"
|
116
|
+
end
|
117
|
+
```
|
118
|
+
|
119
|
+
### Parameters
|
120
|
+
|
121
|
+
Name | Type | Description | Notes
|
122
|
+
------------- | ------------- | ------------- | -------------
|
123
|
+
**match_string** | **String**| String to search for and match against, to be replaced |
|
124
|
+
**replace_string** | **String**| String to replace the matched values with |
|
125
|
+
**input_file** | **File**| Optional: Input file to perform the operation on. | [optional]
|
126
|
+
**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 (part of EditDocumentApi) to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public). | [optional]
|
127
|
+
**match_case** | **BOOLEAN**| Optional: True if the case should be matched, false for case insensitive match. Default is false. | [optional]
|
128
|
+
|
129
|
+
### Return type
|
130
|
+
|
131
|
+
[**DocumentTransformEditSession**](DocumentTransformEditSession.md)
|
132
|
+
|
133
|
+
### Authorization
|
134
|
+
|
135
|
+
[Apikey](../README.md#Apikey)
|
136
|
+
|
137
|
+
### HTTP request headers
|
138
|
+
|
139
|
+
- **Content-Type**: Not defined
|
140
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
141
|
+
|
142
|
+
|
143
|
+
|
144
|
+
# **transform_document_docx_table_fill_in**
|
145
|
+
> String transform_document_docx_table_fill_in(request)
|
146
|
+
|
147
|
+
Fill in data in a table in a Word DOCX document, return result
|
148
|
+
|
149
|
+
Replace placeholder rows ina table in an Office Word Document (docx) using one or more templates
|
150
|
+
|
151
|
+
### Example
|
152
|
+
```ruby
|
153
|
+
# load the gem
|
154
|
+
require 'cloudmersive-convert-api-client'
|
155
|
+
# setup authorization
|
156
|
+
CloudmersiveConvertApiClient.configure do |config|
|
157
|
+
# Configure API key authorization: Apikey
|
158
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
159
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
160
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
161
|
+
end
|
162
|
+
|
163
|
+
api_instance = CloudmersiveConvertApiClient::TransformDocumentApi.new
|
164
|
+
|
165
|
+
request = CloudmersiveConvertApiClient::DocxTableTableFillRequest.new # DocxTableTableFillRequest |
|
166
|
+
|
167
|
+
|
168
|
+
begin
|
169
|
+
#Fill in data in a table in a Word DOCX document, return result
|
170
|
+
result = api_instance.transform_document_docx_table_fill_in(request)
|
171
|
+
p result
|
172
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
173
|
+
puts "Exception when calling TransformDocumentApi->transform_document_docx_table_fill_in: #{e}"
|
174
|
+
end
|
175
|
+
```
|
176
|
+
|
177
|
+
### Parameters
|
178
|
+
|
179
|
+
Name | Type | Description | Notes
|
180
|
+
------------- | ------------- | ------------- | -------------
|
181
|
+
**request** | [**DocxTableTableFillRequest**](DocxTableTableFillRequest.md)| |
|
182
|
+
|
183
|
+
### Return type
|
184
|
+
|
185
|
+
**String**
|
186
|
+
|
187
|
+
### Authorization
|
188
|
+
|
189
|
+
[Apikey](../README.md#Apikey)
|
190
|
+
|
191
|
+
### HTTP request headers
|
192
|
+
|
193
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
194
|
+
- **Accept**: application/octet-stream
|
195
|
+
|
196
|
+
|
197
|
+
|
198
|
+
# **transform_document_docx_table_fill_in_edit_session**
|
199
|
+
> DocumentTransformEditSession transform_document_docx_table_fill_in_edit_session(request)
|
200
|
+
|
201
|
+
Fill in data in a table in a Word DOCX document, return edit session
|
202
|
+
|
203
|
+
Replace placeholder rows ina table in an Office Word Document (docx) using one or more templates. Returns an edit session URL so that you can chain together multiple edit operations without having to send the entire document contents back and forth multiple times. Call the Finish Editing API to retrieve the final document once editing is complete.
|
204
|
+
|
205
|
+
### Example
|
206
|
+
```ruby
|
207
|
+
# load the gem
|
208
|
+
require 'cloudmersive-convert-api-client'
|
209
|
+
# setup authorization
|
210
|
+
CloudmersiveConvertApiClient.configure do |config|
|
211
|
+
# Configure API key authorization: Apikey
|
212
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
213
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
214
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
215
|
+
end
|
216
|
+
|
217
|
+
api_instance = CloudmersiveConvertApiClient::TransformDocumentApi.new
|
218
|
+
|
219
|
+
request = CloudmersiveConvertApiClient::DocxTableTableFillRequest.new # DocxTableTableFillRequest |
|
220
|
+
|
221
|
+
|
222
|
+
begin
|
223
|
+
#Fill in data in a table in a Word DOCX document, return edit session
|
224
|
+
result = api_instance.transform_document_docx_table_fill_in_edit_session(request)
|
225
|
+
p result
|
226
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
227
|
+
puts "Exception when calling TransformDocumentApi->transform_document_docx_table_fill_in_edit_session: #{e}"
|
228
|
+
end
|
229
|
+
```
|
230
|
+
|
231
|
+
### Parameters
|
232
|
+
|
233
|
+
Name | Type | Description | Notes
|
234
|
+
------------- | ------------- | ------------- | -------------
|
235
|
+
**request** | [**DocxTableTableFillRequest**](DocxTableTableFillRequest.md)| |
|
236
|
+
|
237
|
+
### Return type
|
238
|
+
|
239
|
+
[**DocumentTransformEditSession**](DocumentTransformEditSession.md)
|
240
|
+
|
241
|
+
### Authorization
|
242
|
+
|
243
|
+
[Apikey](../README.md#Apikey)
|
244
|
+
|
245
|
+
### HTTP request headers
|
246
|
+
|
247
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
248
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
249
|
+
|
250
|
+
|
251
|
+
|
76
252
|
# **transform_document_pptx_replace**
|
77
253
|
> String transform_document_pptx_replace(match_string, replace_string, opts)
|
78
254
|
|
79
|
-
Replace string in PowerPoint PPTX presentation
|
255
|
+
Replace string in PowerPoint PPTX presentation, return result
|
80
256
|
|
81
257
|
Replace all instances of a string in an Office PowerPoint Document (pptx)
|
82
258
|
|
@@ -105,7 +281,7 @@ opts = {
|
|
105
281
|
}
|
106
282
|
|
107
283
|
begin
|
108
|
-
#Replace string in PowerPoint PPTX presentation
|
284
|
+
#Replace string in PowerPoint PPTX presentation, return result
|
109
285
|
result = api_instance.transform_document_pptx_replace(match_string, replace_string, opts)
|
110
286
|
p result
|
111
287
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -55,6 +55,8 @@ require 'cloudmersive-convert-api-client/models/delete_docx_table_row_response'
|
|
55
55
|
require 'cloudmersive-convert-api-client/models/detect_line_endings_response'
|
56
56
|
require 'cloudmersive-convert-api-client/models/disable_shared_workbook_request'
|
57
57
|
require 'cloudmersive-convert-api-client/models/disable_shared_workbook_response'
|
58
|
+
require 'cloudmersive-convert-api-client/models/document_editing_edit_session'
|
59
|
+
require 'cloudmersive-convert-api-client/models/document_transform_edit_session'
|
58
60
|
require 'cloudmersive-convert-api-client/models/document_validation_error'
|
59
61
|
require 'cloudmersive-convert-api-client/models/document_validation_result'
|
60
62
|
require 'cloudmersive-convert-api-client/models/docx_body'
|
@@ -83,6 +85,9 @@ require 'cloudmersive-convert-api-client/models/docx_style'
|
|
83
85
|
require 'cloudmersive-convert-api-client/models/docx_table'
|
84
86
|
require 'cloudmersive-convert-api-client/models/docx_table_cell'
|
85
87
|
require 'cloudmersive-convert-api-client/models/docx_table_row'
|
88
|
+
require 'cloudmersive-convert-api-client/models/docx_table_table_fill_request'
|
89
|
+
require 'cloudmersive-convert-api-client/models/docx_table_table_fill_table_cell'
|
90
|
+
require 'cloudmersive-convert-api-client/models/docx_table_table_fill_table_row'
|
86
91
|
require 'cloudmersive-convert-api-client/models/docx_template_application_request'
|
87
92
|
require 'cloudmersive-convert-api-client/models/docx_template_operation'
|
88
93
|
require 'cloudmersive-convert-api-client/models/docx_text'
|
@@ -148,7 +153,10 @@ require 'cloudmersive-convert-api-client/models/get_xlsx_styles_request'
|
|
148
153
|
require 'cloudmersive-convert-api-client/models/get_xlsx_styles_response'
|
149
154
|
require 'cloudmersive-convert-api-client/models/get_xlsx_worksheets_request'
|
150
155
|
require 'cloudmersive-convert-api-client/models/get_xlsx_worksheets_response'
|
156
|
+
require 'cloudmersive-convert-api-client/models/html_get_language_result'
|
151
157
|
require 'cloudmersive-convert-api-client/models/html_get_links_response'
|
158
|
+
require 'cloudmersive-convert-api-client/models/html_get_rel_canonical_url_result'
|
159
|
+
require 'cloudmersive-convert-api-client/models/html_get_sitemap_url_result'
|
152
160
|
require 'cloudmersive-convert-api-client/models/html_hyperlink'
|
153
161
|
require 'cloudmersive-convert-api-client/models/html_md_result'
|
154
162
|
require 'cloudmersive-convert-api-client/models/html_ssrf_threat_check_result'
|
@@ -1700,7 +1700,7 @@ module CloudmersiveConvertApiClient
|
|
1700
1700
|
end
|
1701
1701
|
return data, status_code, headers
|
1702
1702
|
end
|
1703
|
-
# Replace multiple strings in Word DOCX document
|
1703
|
+
# Replace multiple strings in Word DOCX document, return result
|
1704
1704
|
# Replace all instances of multiple strings in an Office Word Document (docx)
|
1705
1705
|
# @param req_config Document string replacement configuration input
|
1706
1706
|
# @param [Hash] opts the optional parameters
|
@@ -1710,7 +1710,7 @@ module CloudmersiveConvertApiClient
|
|
1710
1710
|
data
|
1711
1711
|
end
|
1712
1712
|
|
1713
|
-
# Replace multiple strings in Word DOCX document
|
1713
|
+
# Replace multiple strings in Word DOCX document, return result
|
1714
1714
|
# Replace all instances of multiple strings in an Office Word Document (docx)
|
1715
1715
|
# @param req_config Document string replacement configuration input
|
1716
1716
|
# @param [Hash] opts the optional parameters
|
@@ -1754,6 +1754,60 @@ module CloudmersiveConvertApiClient
|
|
1754
1754
|
end
|
1755
1755
|
return data, status_code, headers
|
1756
1756
|
end
|
1757
|
+
# Replace multiple strings in Word DOCX document, return edit session
|
1758
|
+
# Replace all instances of multiple strings in an Office Word Document (docx). Returns an edit session URL so that you can chain together multiple edit operations without having to send the entire document contents back and forth multiple times. Call the Finish Editing API to retrieve the final document once editing is complete.
|
1759
|
+
# @param req_config Document string replacement configuration input
|
1760
|
+
# @param [Hash] opts the optional parameters
|
1761
|
+
# @return [DocumentEditingEditSession]
|
1762
|
+
def edit_document_docx_replace_multi_edit_session(req_config, opts = {})
|
1763
|
+
data, _status_code, _headers = edit_document_docx_replace_multi_edit_session_with_http_info(req_config, opts)
|
1764
|
+
data
|
1765
|
+
end
|
1766
|
+
|
1767
|
+
# Replace multiple strings in Word DOCX document, return edit session
|
1768
|
+
# Replace all instances of multiple strings in an Office Word Document (docx). Returns an edit session URL so that you can chain together multiple edit operations without having to send the entire document contents back and forth multiple times. Call the Finish Editing API to retrieve the final document once editing is complete.
|
1769
|
+
# @param req_config Document string replacement configuration input
|
1770
|
+
# @param [Hash] opts the optional parameters
|
1771
|
+
# @return [Array<(DocumentEditingEditSession, Fixnum, Hash)>] DocumentEditingEditSession data, response status code and response headers
|
1772
|
+
def edit_document_docx_replace_multi_edit_session_with_http_info(req_config, opts = {})
|
1773
|
+
if @api_client.config.debugging
|
1774
|
+
@api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_replace_multi_edit_session ...'
|
1775
|
+
end
|
1776
|
+
# verify the required parameter 'req_config' is set
|
1777
|
+
if @api_client.config.client_side_validation && req_config.nil?
|
1778
|
+
fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_replace_multi_edit_session"
|
1779
|
+
end
|
1780
|
+
# resource path
|
1781
|
+
local_var_path = '/convert/edit/docx/replace-all/multi/edit-session'
|
1782
|
+
|
1783
|
+
# query parameters
|
1784
|
+
query_params = {}
|
1785
|
+
|
1786
|
+
# header parameters
|
1787
|
+
header_params = {}
|
1788
|
+
# HTTP header 'Accept' (if needed)
|
1789
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
1790
|
+
# HTTP header 'Content-Type'
|
1791
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
1792
|
+
|
1793
|
+
# form parameters
|
1794
|
+
form_params = {}
|
1795
|
+
|
1796
|
+
# http body (model)
|
1797
|
+
post_body = @api_client.object_to_http_body(req_config)
|
1798
|
+
auth_names = ['Apikey']
|
1799
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1800
|
+
:header_params => header_params,
|
1801
|
+
:query_params => query_params,
|
1802
|
+
:form_params => form_params,
|
1803
|
+
:body => post_body,
|
1804
|
+
:auth_names => auth_names,
|
1805
|
+
:return_type => 'DocumentEditingEditSession')
|
1806
|
+
if @api_client.config.debugging
|
1807
|
+
@api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_replace_multi_edit_session\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1808
|
+
end
|
1809
|
+
return data, status_code, headers
|
1810
|
+
end
|
1757
1811
|
# Replace matching paragraphs in a Word DOCX document
|
1758
1812
|
# Returns the edited Word Document (DOCX) format file with the matching paragraphs replaced as requested. Replace a paragraph with another object such as an image. Useful for performing templating operations.
|
1759
1813
|
# @param req_config Document input request
|
@@ -19,6 +19,65 @@ module CloudmersiveConvertApiClient
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
+
# Append an HTML tag to the HEAD section of an HTML Document
|
23
|
+
# Appends an HTML tag to the HEAD section of an HTML document.
|
24
|
+
# @param html_tag The HTML tag to append.
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @option opts [File] :input_file Optional: Input file to perform the operation on.
|
27
|
+
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
28
|
+
# @return [String]
|
29
|
+
def edit_html_html_append_header_tag(html_tag, opts = {})
|
30
|
+
data, _status_code, _headers = edit_html_html_append_header_tag_with_http_info(html_tag, opts)
|
31
|
+
data
|
32
|
+
end
|
33
|
+
|
34
|
+
# Append an HTML tag to the HEAD section of an HTML Document
|
35
|
+
# Appends an HTML tag to the HEAD section of an HTML document.
|
36
|
+
# @param html_tag The HTML tag to append.
|
37
|
+
# @param [Hash] opts the optional parameters
|
38
|
+
# @option opts [File] :input_file Optional: Input file to perform the operation on.
|
39
|
+
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
40
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
41
|
+
def edit_html_html_append_header_tag_with_http_info(html_tag, opts = {})
|
42
|
+
if @api_client.config.debugging
|
43
|
+
@api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_append_header_tag ...'
|
44
|
+
end
|
45
|
+
# verify the required parameter 'html_tag' is set
|
46
|
+
if @api_client.config.client_side_validation && html_tag.nil?
|
47
|
+
fail ArgumentError, "Missing the required parameter 'html_tag' when calling EditHtmlApi.edit_html_html_append_header_tag"
|
48
|
+
end
|
49
|
+
# resource path
|
50
|
+
local_var_path = '/convert/edit/html/head/append/tag'
|
51
|
+
|
52
|
+
# query parameters
|
53
|
+
query_params = {}
|
54
|
+
|
55
|
+
# header parameters
|
56
|
+
header_params = {}
|
57
|
+
# HTTP header 'Accept' (if needed)
|
58
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
59
|
+
header_params[:'htmlTag'] = html_tag
|
60
|
+
header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?
|
61
|
+
|
62
|
+
# form parameters
|
63
|
+
form_params = {}
|
64
|
+
form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?
|
65
|
+
|
66
|
+
# http body (model)
|
67
|
+
post_body = nil
|
68
|
+
auth_names = ['Apikey']
|
69
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
70
|
+
:header_params => header_params,
|
71
|
+
:query_params => query_params,
|
72
|
+
:form_params => form_params,
|
73
|
+
:body => post_body,
|
74
|
+
:auth_names => auth_names,
|
75
|
+
:return_type => 'String')
|
76
|
+
if @api_client.config.debugging
|
77
|
+
@api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_append_header_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
78
|
+
end
|
79
|
+
return data, status_code, headers
|
80
|
+
end
|
22
81
|
# Append a Heading to an HTML Document
|
23
82
|
# Appends a heading to the end of an HTML document.
|
24
83
|
# @param heading_text The text content to be used in the header.
|
@@ -335,6 +394,58 @@ module CloudmersiveConvertApiClient
|
|
335
394
|
end
|
336
395
|
return data, status_code, headers
|
337
396
|
end
|
397
|
+
# Gets the language for the HTML document
|
398
|
+
# Retrieves the language code (e.g. \"en\" or \"de\") of an HTML document.
|
399
|
+
# @param [Hash] opts the optional parameters
|
400
|
+
# @option opts [File] :input_file Optional: Input file to perform the operation on.
|
401
|
+
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
402
|
+
# @return [HtmlGetLanguageResult]
|
403
|
+
def edit_html_html_get_language(opts = {})
|
404
|
+
data, _status_code, _headers = edit_html_html_get_language_with_http_info(opts)
|
405
|
+
data
|
406
|
+
end
|
407
|
+
|
408
|
+
# Gets the language for the HTML document
|
409
|
+
# Retrieves the language code (e.g. \"en\" or \"de\") of an HTML document.
|
410
|
+
# @param [Hash] opts the optional parameters
|
411
|
+
# @option opts [File] :input_file Optional: Input file to perform the operation on.
|
412
|
+
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
413
|
+
# @return [Array<(HtmlGetLanguageResult, Fixnum, Hash)>] HtmlGetLanguageResult data, response status code and response headers
|
414
|
+
def edit_html_html_get_language_with_http_info(opts = {})
|
415
|
+
if @api_client.config.debugging
|
416
|
+
@api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_get_language ...'
|
417
|
+
end
|
418
|
+
# resource path
|
419
|
+
local_var_path = '/convert/edit/html/head/get/language'
|
420
|
+
|
421
|
+
# query parameters
|
422
|
+
query_params = {}
|
423
|
+
|
424
|
+
# header parameters
|
425
|
+
header_params = {}
|
426
|
+
# HTTP header 'Accept' (if needed)
|
427
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
428
|
+
header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?
|
429
|
+
|
430
|
+
# form parameters
|
431
|
+
form_params = {}
|
432
|
+
form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?
|
433
|
+
|
434
|
+
# http body (model)
|
435
|
+
post_body = nil
|
436
|
+
auth_names = ['Apikey']
|
437
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
438
|
+
:header_params => header_params,
|
439
|
+
:query_params => query_params,
|
440
|
+
:form_params => form_params,
|
441
|
+
:body => post_body,
|
442
|
+
:auth_names => auth_names,
|
443
|
+
:return_type => 'HtmlGetLanguageResult')
|
444
|
+
if @api_client.config.debugging
|
445
|
+
@api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_get_language\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
446
|
+
end
|
447
|
+
return data, status_code, headers
|
448
|
+
end
|
338
449
|
# Extract resolved link URLs from HTML File
|
339
450
|
# Extracts the resolved link URLs, fully-qualified if possible, from an input HTML file.
|
340
451
|
# @param [Hash] opts the optional parameters
|
@@ -390,5 +501,286 @@ module CloudmersiveConvertApiClient
|
|
390
501
|
end
|
391
502
|
return data, status_code, headers
|
392
503
|
end
|
504
|
+
# Gets the rel canonical URL for the HTML document
|
505
|
+
# Gets the rel canonical URL of an HTML document.
|
506
|
+
# @param [Hash] opts the optional parameters
|
507
|
+
# @option opts [File] :input_file Optional: Input file to perform the operation on.
|
508
|
+
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
509
|
+
# @return [HtmlGetRelCanonicalUrlResult]
|
510
|
+
def edit_html_html_get_rel_canonical(opts = {})
|
511
|
+
data, _status_code, _headers = edit_html_html_get_rel_canonical_with_http_info(opts)
|
512
|
+
data
|
513
|
+
end
|
514
|
+
|
515
|
+
# Gets the rel canonical URL for the HTML document
|
516
|
+
# Gets the rel canonical URL of an HTML document.
|
517
|
+
# @param [Hash] opts the optional parameters
|
518
|
+
# @option opts [File] :input_file Optional: Input file to perform the operation on.
|
519
|
+
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
520
|
+
# @return [Array<(HtmlGetRelCanonicalUrlResult, Fixnum, Hash)>] HtmlGetRelCanonicalUrlResult data, response status code and response headers
|
521
|
+
def edit_html_html_get_rel_canonical_with_http_info(opts = {})
|
522
|
+
if @api_client.config.debugging
|
523
|
+
@api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_get_rel_canonical ...'
|
524
|
+
end
|
525
|
+
# resource path
|
526
|
+
local_var_path = '/convert/edit/html/head/get/rel-canonical-url'
|
527
|
+
|
528
|
+
# query parameters
|
529
|
+
query_params = {}
|
530
|
+
|
531
|
+
# header parameters
|
532
|
+
header_params = {}
|
533
|
+
# HTTP header 'Accept' (if needed)
|
534
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
535
|
+
header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?
|
536
|
+
|
537
|
+
# form parameters
|
538
|
+
form_params = {}
|
539
|
+
form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?
|
540
|
+
|
541
|
+
# http body (model)
|
542
|
+
post_body = nil
|
543
|
+
auth_names = ['Apikey']
|
544
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
545
|
+
:header_params => header_params,
|
546
|
+
:query_params => query_params,
|
547
|
+
:form_params => form_params,
|
548
|
+
:body => post_body,
|
549
|
+
:auth_names => auth_names,
|
550
|
+
:return_type => 'HtmlGetRelCanonicalUrlResult')
|
551
|
+
if @api_client.config.debugging
|
552
|
+
@api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_get_rel_canonical\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
553
|
+
end
|
554
|
+
return data, status_code, headers
|
555
|
+
end
|
556
|
+
# Gets the sitemap URL for the HTML document
|
557
|
+
# Gets the sitemap link URL of an HTML document.
|
558
|
+
# @param [Hash] opts the optional parameters
|
559
|
+
# @option opts [File] :input_file Optional: Input file to perform the operation on.
|
560
|
+
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
561
|
+
# @return [HtmlGetSitemapUrlResult]
|
562
|
+
def edit_html_html_get_sitemap(opts = {})
|
563
|
+
data, _status_code, _headers = edit_html_html_get_sitemap_with_http_info(opts)
|
564
|
+
data
|
565
|
+
end
|
566
|
+
|
567
|
+
# Gets the sitemap URL for the HTML document
|
568
|
+
# Gets the sitemap link URL of an HTML document.
|
569
|
+
# @param [Hash] opts the optional parameters
|
570
|
+
# @option opts [File] :input_file Optional: Input file to perform the operation on.
|
571
|
+
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
572
|
+
# @return [Array<(HtmlGetSitemapUrlResult, Fixnum, Hash)>] HtmlGetSitemapUrlResult data, response status code and response headers
|
573
|
+
def edit_html_html_get_sitemap_with_http_info(opts = {})
|
574
|
+
if @api_client.config.debugging
|
575
|
+
@api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_get_sitemap ...'
|
576
|
+
end
|
577
|
+
# resource path
|
578
|
+
local_var_path = '/convert/edit/html/head/get/sitemap-url'
|
579
|
+
|
580
|
+
# query parameters
|
581
|
+
query_params = {}
|
582
|
+
|
583
|
+
# header parameters
|
584
|
+
header_params = {}
|
585
|
+
# HTTP header 'Accept' (if needed)
|
586
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
587
|
+
header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?
|
588
|
+
|
589
|
+
# form parameters
|
590
|
+
form_params = {}
|
591
|
+
form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?
|
592
|
+
|
593
|
+
# http body (model)
|
594
|
+
post_body = nil
|
595
|
+
auth_names = ['Apikey']
|
596
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
597
|
+
:header_params => header_params,
|
598
|
+
:query_params => query_params,
|
599
|
+
:form_params => form_params,
|
600
|
+
:body => post_body,
|
601
|
+
:auth_names => auth_names,
|
602
|
+
:return_type => 'HtmlGetSitemapUrlResult')
|
603
|
+
if @api_client.config.debugging
|
604
|
+
@api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_get_sitemap\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
605
|
+
end
|
606
|
+
return data, status_code, headers
|
607
|
+
end
|
608
|
+
# Sets the language for the HTML document
|
609
|
+
# Sets the language code of an HTML document.
|
610
|
+
# @param language_code The HTML langauge code to set.
|
611
|
+
# @param [Hash] opts the optional parameters
|
612
|
+
# @option opts [File] :input_file Optional: Input file to perform the operation on.
|
613
|
+
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
614
|
+
# @return [String]
|
615
|
+
def edit_html_html_set_language(language_code, opts = {})
|
616
|
+
data, _status_code, _headers = edit_html_html_set_language_with_http_info(language_code, opts)
|
617
|
+
data
|
618
|
+
end
|
619
|
+
|
620
|
+
# Sets the language for the HTML document
|
621
|
+
# Sets the language code of an HTML document.
|
622
|
+
# @param language_code The HTML langauge code to set.
|
623
|
+
# @param [Hash] opts the optional parameters
|
624
|
+
# @option opts [File] :input_file Optional: Input file to perform the operation on.
|
625
|
+
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
626
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
627
|
+
def edit_html_html_set_language_with_http_info(language_code, opts = {})
|
628
|
+
if @api_client.config.debugging
|
629
|
+
@api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_set_language ...'
|
630
|
+
end
|
631
|
+
# verify the required parameter 'language_code' is set
|
632
|
+
if @api_client.config.client_side_validation && language_code.nil?
|
633
|
+
fail ArgumentError, "Missing the required parameter 'language_code' when calling EditHtmlApi.edit_html_html_set_language"
|
634
|
+
end
|
635
|
+
# resource path
|
636
|
+
local_var_path = '/convert/edit/html/head/set/language'
|
637
|
+
|
638
|
+
# query parameters
|
639
|
+
query_params = {}
|
640
|
+
|
641
|
+
# header parameters
|
642
|
+
header_params = {}
|
643
|
+
# HTTP header 'Accept' (if needed)
|
644
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
645
|
+
header_params[:'languageCode'] = language_code
|
646
|
+
header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?
|
647
|
+
|
648
|
+
# form parameters
|
649
|
+
form_params = {}
|
650
|
+
form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?
|
651
|
+
|
652
|
+
# http body (model)
|
653
|
+
post_body = nil
|
654
|
+
auth_names = ['Apikey']
|
655
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
656
|
+
:header_params => header_params,
|
657
|
+
:query_params => query_params,
|
658
|
+
:form_params => form_params,
|
659
|
+
:body => post_body,
|
660
|
+
:auth_names => auth_names,
|
661
|
+
:return_type => 'String')
|
662
|
+
if @api_client.config.debugging
|
663
|
+
@api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_set_language\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
664
|
+
end
|
665
|
+
return data, status_code, headers
|
666
|
+
end
|
667
|
+
# Sets the rel canonical URL for the HTML document
|
668
|
+
# Sets the rel canonical URL of an HTML document. This is useful for telling search engines and other indexers which pages are duplicates of eachother; any pages with the rel=canonical tag will be treated as duplicates of the canonical URL.
|
669
|
+
# @param canonical_url The HTML canonical URL to set.
|
670
|
+
# @param [Hash] opts the optional parameters
|
671
|
+
# @option opts [File] :input_file Optional: Input file to perform the operation on.
|
672
|
+
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
673
|
+
# @return [String]
|
674
|
+
def edit_html_html_set_rel_canonical(canonical_url, opts = {})
|
675
|
+
data, _status_code, _headers = edit_html_html_set_rel_canonical_with_http_info(canonical_url, opts)
|
676
|
+
data
|
677
|
+
end
|
678
|
+
|
679
|
+
# Sets the rel canonical URL for the HTML document
|
680
|
+
# Sets the rel canonical URL of an HTML document. This is useful for telling search engines and other indexers which pages are duplicates of eachother; any pages with the rel=canonical tag will be treated as duplicates of the canonical URL.
|
681
|
+
# @param canonical_url The HTML canonical URL to set.
|
682
|
+
# @param [Hash] opts the optional parameters
|
683
|
+
# @option opts [File] :input_file Optional: Input file to perform the operation on.
|
684
|
+
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
685
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
686
|
+
def edit_html_html_set_rel_canonical_with_http_info(canonical_url, opts = {})
|
687
|
+
if @api_client.config.debugging
|
688
|
+
@api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_set_rel_canonical ...'
|
689
|
+
end
|
690
|
+
# verify the required parameter 'canonical_url' is set
|
691
|
+
if @api_client.config.client_side_validation && canonical_url.nil?
|
692
|
+
fail ArgumentError, "Missing the required parameter 'canonical_url' when calling EditHtmlApi.edit_html_html_set_rel_canonical"
|
693
|
+
end
|
694
|
+
# resource path
|
695
|
+
local_var_path = '/convert/edit/html/head/set/rel-canonical-url'
|
696
|
+
|
697
|
+
# query parameters
|
698
|
+
query_params = {}
|
699
|
+
|
700
|
+
# header parameters
|
701
|
+
header_params = {}
|
702
|
+
# HTTP header 'Accept' (if needed)
|
703
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
704
|
+
header_params[:'canonicalUrl'] = canonical_url
|
705
|
+
header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?
|
706
|
+
|
707
|
+
# form parameters
|
708
|
+
form_params = {}
|
709
|
+
form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?
|
710
|
+
|
711
|
+
# http body (model)
|
712
|
+
post_body = nil
|
713
|
+
auth_names = ['Apikey']
|
714
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
715
|
+
:header_params => header_params,
|
716
|
+
:query_params => query_params,
|
717
|
+
:form_params => form_params,
|
718
|
+
:body => post_body,
|
719
|
+
:auth_names => auth_names,
|
720
|
+
:return_type => 'String')
|
721
|
+
if @api_client.config.debugging
|
722
|
+
@api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_set_rel_canonical\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
723
|
+
end
|
724
|
+
return data, status_code, headers
|
725
|
+
end
|
726
|
+
# Sets the sitemap URL for the HTML document
|
727
|
+
# Sets the sitemap URL of an HTML document.
|
728
|
+
# @param sitemap_url The HTML sitemap URL to set.
|
729
|
+
# @param [Hash] opts the optional parameters
|
730
|
+
# @option opts [File] :input_file Optional: Input file to perform the operation on.
|
731
|
+
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
732
|
+
# @return [String]
|
733
|
+
def edit_html_html_set_sitemap_url(sitemap_url, opts = {})
|
734
|
+
data, _status_code, _headers = edit_html_html_set_sitemap_url_with_http_info(sitemap_url, opts)
|
735
|
+
data
|
736
|
+
end
|
737
|
+
|
738
|
+
# Sets the sitemap URL for the HTML document
|
739
|
+
# Sets the sitemap URL of an HTML document.
|
740
|
+
# @param sitemap_url The HTML sitemap URL to set.
|
741
|
+
# @param [Hash] opts the optional parameters
|
742
|
+
# @option opts [File] :input_file Optional: Input file to perform the operation on.
|
743
|
+
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
744
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
745
|
+
def edit_html_html_set_sitemap_url_with_http_info(sitemap_url, opts = {})
|
746
|
+
if @api_client.config.debugging
|
747
|
+
@api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_set_sitemap_url ...'
|
748
|
+
end
|
749
|
+
# verify the required parameter 'sitemap_url' is set
|
750
|
+
if @api_client.config.client_side_validation && sitemap_url.nil?
|
751
|
+
fail ArgumentError, "Missing the required parameter 'sitemap_url' when calling EditHtmlApi.edit_html_html_set_sitemap_url"
|
752
|
+
end
|
753
|
+
# resource path
|
754
|
+
local_var_path = '/convert/edit/html/head/set/sitemap-url'
|
755
|
+
|
756
|
+
# query parameters
|
757
|
+
query_params = {}
|
758
|
+
|
759
|
+
# header parameters
|
760
|
+
header_params = {}
|
761
|
+
# HTTP header 'Accept' (if needed)
|
762
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
763
|
+
header_params[:'sitemapUrl'] = sitemap_url
|
764
|
+
header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?
|
765
|
+
|
766
|
+
# form parameters
|
767
|
+
form_params = {}
|
768
|
+
form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?
|
769
|
+
|
770
|
+
# http body (model)
|
771
|
+
post_body = nil
|
772
|
+
auth_names = ['Apikey']
|
773
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
774
|
+
:header_params => header_params,
|
775
|
+
:query_params => query_params,
|
776
|
+
:form_params => form_params,
|
777
|
+
:body => post_body,
|
778
|
+
:auth_names => auth_names,
|
779
|
+
:return_type => 'String')
|
780
|
+
if @api_client.config.debugging
|
781
|
+
@api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_set_sitemap_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
782
|
+
end
|
783
|
+
return data, status_code, headers
|
784
|
+
end
|
393
785
|
end
|
394
786
|
end
|