cloudmersive-convert-api-client 2.1.4 → 2.1.9
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +29 -4
- data/docs/EditDocumentApi.md +165 -0
- data/docs/EditHtmlApi.md +478 -0
- data/docs/EditPdfApi.md +6 -2
- data/docs/GetMacrosResponse.md +9 -0
- data/docs/HtmlGetLanguageResult.md +9 -0
- data/docs/HtmlGetLinksResponse.md +9 -0
- data/docs/HtmlGetRelCanonicalUrlResult.md +9 -0
- data/docs/HtmlGetSitemapUrlResult.md +9 -0
- data/docs/HtmlHyperlink.md +9 -0
- data/docs/HtmlSsrfThreatCheckResult.md +10 -0
- data/docs/HtmlThreatLink.md +9 -0
- data/docs/MergeDocumentApi.md +134 -0
- data/docs/ValidateDocumentApi.md +110 -0
- data/docs/XxeThreatDetectionResult.md +9 -0
- data/docs/ZipArchiveApi.md +62 -0
- data/lib/cloudmersive-convert-api-client.rb +9 -0
- data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +165 -0
- data/lib/cloudmersive-convert-api-client/api/edit_html_api.rb +447 -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 +148 -0
- data/lib/cloudmersive-convert-api-client/api/validate_document_api.rb +110 -0
- data/lib/cloudmersive-convert-api-client/api/zip_archive_api.rb +63 -0
- data/lib/cloudmersive-convert-api-client/models/get_macros_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/html_get_language_result.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/html_get_links_response.rb +198 -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/models/html_hyperlink.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/html_ssrf_threat_check_result.rb +208 -0
- data/lib/cloudmersive-convert-api-client/models/html_threat_link.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/xxe_threat_detection_result.rb +196 -0
- data/lib/cloudmersive-convert-api-client/version.rb +1 -1
- data/spec/api/edit_document_api_spec.rb +36 -0
- data/spec/api/edit_html_api_spec.rb +109 -0
- data/spec/api/edit_pdf_api_spec.rb +1 -0
- data/spec/api/merge_document_api_spec.rb +34 -0
- data/spec/api/validate_document_api_spec.rb +24 -0
- data/spec/api/zip_archive_api_spec.rb +14 -0
- data/spec/models/get_macros_response_spec.rb +47 -0
- data/spec/models/html_get_language_result_spec.rb +47 -0
- data/spec/models/html_get_links_response_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
- data/spec/models/html_hyperlink_spec.rb +47 -0
- data/spec/models/html_ssrf_threat_check_result_spec.rb +53 -0
- data/spec/models/html_threat_link_spec.rb +47 -0
- data/spec/models/xxe_threat_detection_result_spec.rb +47 -0
- metadata +29 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 659e9f0154c2c76f66d7e7fb229f2f23b68ed143b9cd5adfde0a6569f64fd89a
|
4
|
+
data.tar.gz: 241e9b7ff13a8cf33e4395d91d25d2cb91de9e3e15cf8a04cd6a5a34e036dcc4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 003bb1287913e7a86029b377c6706d1089c655cf510c084cd8c2a2689037fb759649f2242809201af71a3f63224949c26dd96ac0b329cb28ef1f2543c5197f5b
|
7
|
+
data.tar.gz: d094f687a7fec4aa76881a258f785b7e49e5f65c9f093182b2d168d1b043bc28492ee87afa4b87969e6ce8af21655aece2699f0f13b000bcd68e664a3e9b4f33
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ Convert API lets you effortlessly convert file formats and types.
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: v1
|
10
|
-
- Package version: 2.1.
|
10
|
+
- Package version: 2.1.9
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,15 +23,15 @@ gem build cloudmersive-convert-api-client.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./cloudmersive-convert-api-client-2.1.
|
26
|
+
gem install ./cloudmersive-convert-api-client-2.1.9.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-convert-api-client-2.1.
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-convert-api-client-2.1.9.gem` to install the development dependencies)
|
29
29
|
|
30
30
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
31
|
|
32
32
|
Finally add this to the Gemfile:
|
33
33
|
|
34
|
-
gem 'cloudmersive-convert-api-client', '~> 2.1.
|
34
|
+
gem 'cloudmersive-convert-api-client', '~> 2.1.9'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -210,6 +210,7 @@ Class | Method | HTTP request | Description
|
|
210
210
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_comments_hierarchical**](docs/EditDocumentApi.md#edit_document_docx_get_comments_hierarchical) | **POST** /convert/edit/docx/get-comments/hierarchical | Get comments from a Word DOCX document hierarchically
|
211
211
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_headers_and_footers**](docs/EditDocumentApi.md#edit_document_docx_get_headers_and_footers) | **POST** /convert/edit/docx/get-headers-and-footers | Get content of a footer from a Word DOCX document
|
212
212
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_images**](docs/EditDocumentApi.md#edit_document_docx_get_images) | **POST** /convert/edit/docx/get-images | Get images from a Word DOCX document
|
213
|
+
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_macro_information**](docs/EditDocumentApi.md#edit_document_docx_get_macro_information) | **POST** /convert/edit/docx/get-macros | Get macro information from a Word DOCX/DOCM document
|
213
214
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_metadata_properties**](docs/EditDocumentApi.md#edit_document_docx_get_metadata_properties) | **POST** /convert/edit/docx/get-metadata | Get all metadata properties in Word DOCX document
|
214
215
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_sections**](docs/EditDocumentApi.md#edit_document_docx_get_sections) | **POST** /convert/edit/docx/get-sections | Get sections from a Word DOCX document
|
215
216
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_styles**](docs/EditDocumentApi.md#edit_document_docx_get_styles) | **POST** /convert/edit/docx/get-styles | Get styles from a Word DOCX document
|
@@ -236,6 +237,7 @@ Class | Method | HTTP request | Description
|
|
236
237
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_update_table_row**](docs/EditDocumentApi.md#edit_document_docx_update_table_row) | **POST** /convert/edit/docx/update-table-row | Update, set contents of a table row in an existing table in a Word DOCX document
|
237
238
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_finish_editing**](docs/EditDocumentApi.md#edit_document_finish_editing) | **POST** /convert/edit/finish-editing | Finish editing document, and download result from document editing
|
238
239
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_pptx_delete_slides**](docs/EditDocumentApi.md#edit_document_pptx_delete_slides) | **POST** /convert/edit/pptx/delete-slides | Delete, remove slides from a PowerPoint PPTX presentation document
|
240
|
+
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_pptx_get_macro_information**](docs/EditDocumentApi.md#edit_document_pptx_get_macro_information) | **POST** /convert/edit/pptx/get-macros | Get macro information from a PowerPoint PPTX/PPTM presentation document
|
239
241
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_pptx_replace**](docs/EditDocumentApi.md#edit_document_pptx_replace) | **POST** /convert/edit/pptx/replace-all | Replace string in PowerPoint PPTX presentation
|
240
242
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_append_row**](docs/EditDocumentApi.md#edit_document_xlsx_append_row) | **POST** /convert/edit/xlsx/append-row | Append row to a Excel XLSX spreadsheet, worksheet
|
241
243
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_clear_cell_by_index**](docs/EditDocumentApi.md#edit_document_xlsx_clear_cell_by_index) | **POST** /convert/edit/xlsx/clear-cell/by-index | Clear cell contents in an Excel XLSX spreadsheet, worksheet by index
|
@@ -249,6 +251,7 @@ Class | Method | HTTP request | Description
|
|
249
251
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_cell_by_index**](docs/EditDocumentApi.md#edit_document_xlsx_get_cell_by_index) | **POST** /convert/edit/xlsx/get-cell/by-index | Get cell from an Excel XLSX spreadsheet, worksheet by index
|
250
252
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_columns**](docs/EditDocumentApi.md#edit_document_xlsx_get_columns) | **POST** /convert/edit/xlsx/get-columns | Get columns from a Excel XLSX spreadsheet, worksheet
|
251
253
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_images**](docs/EditDocumentApi.md#edit_document_xlsx_get_images) | **POST** /convert/edit/xlsx/get-images | Get images from a Excel XLSX spreadsheet, worksheet
|
254
|
+
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_macro_information**](docs/EditDocumentApi.md#edit_document_xlsx_get_macro_information) | **POST** /convert/edit/xlsx/get-macros | Get macro information from a Excel XLSX/XLSM spreadsheet, worksheet
|
252
255
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_rows_and_cells**](docs/EditDocumentApi.md#edit_document_xlsx_get_rows_and_cells) | **POST** /convert/edit/xlsx/get-rows-and-cells | Get rows and cells from a Excel XLSX spreadsheet, worksheet
|
253
256
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_specific_row**](docs/EditDocumentApi.md#edit_document_xlsx_get_specific_row) | **POST** /convert/edit/xlsx/get-specific-row | Get a specific row from a Excel XLSX spreadsheet, worksheet by path
|
254
257
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_styles**](docs/EditDocumentApi.md#edit_document_xlsx_get_styles) | **POST** /convert/edit/xlsx/get-styles | Get styles from a Excel XLSX spreadsheet, worksheet
|
@@ -257,11 +260,19 @@ Class | Method | HTTP request | Description
|
|
257
260
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_rename_worksheet**](docs/EditDocumentApi.md#edit_document_xlsx_rename_worksheet) | **POST** /convert/edit/xlsx/rename-worksheet | Rename a specific worksheet in a Excel XLSX spreadsheet
|
258
261
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_set_cell_by_identifier**](docs/EditDocumentApi.md#edit_document_xlsx_set_cell_by_identifier) | **POST** /convert/edit/xlsx/set-cell/by-identifier | Set, update cell contents in an Excel XLSX spreadsheet, worksheet by cell identifier
|
259
262
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_set_cell_by_index**](docs/EditDocumentApi.md#edit_document_xlsx_set_cell_by_index) | **POST** /convert/edit/xlsx/set-cell/by-index | Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index
|
263
|
+
*CloudmersiveConvertApiClient::EditHtmlApi* | [**edit_html_html_append_header_tag**](docs/EditHtmlApi.md#edit_html_html_append_header_tag) | **POST** /convert/edit/html/head/append/tag | Append an HTML tag to the HEAD section of an HTML Document
|
260
264
|
*CloudmersiveConvertApiClient::EditHtmlApi* | [**edit_html_html_append_heading**](docs/EditHtmlApi.md#edit_html_html_append_heading) | **POST** /convert/edit/html/append/heading | Append a Heading to an HTML Document
|
261
265
|
*CloudmersiveConvertApiClient::EditHtmlApi* | [**edit_html_html_append_image_from_url**](docs/EditHtmlApi.md#edit_html_html_append_image_from_url) | **POST** /convert/edit/html/append/image/from-url | Append an Image to an HTML Document from a URL
|
262
266
|
*CloudmersiveConvertApiClient::EditHtmlApi* | [**edit_html_html_append_image_inline**](docs/EditHtmlApi.md#edit_html_html_append_image_inline) | **POST** /convert/edit/html/append/image/inline | Append a Base64 Inline Image to an HTML Document
|
263
267
|
*CloudmersiveConvertApiClient::EditHtmlApi* | [**edit_html_html_append_paragraph**](docs/EditHtmlApi.md#edit_html_html_append_paragraph) | **POST** /convert/edit/html/append/paragraph | Append a Paragraph to an HTML Document
|
264
268
|
*CloudmersiveConvertApiClient::EditHtmlApi* | [**edit_html_html_create_blank_document**](docs/EditHtmlApi.md#edit_html_html_create_blank_document) | **POST** /convert/edit/html/create/blank | Create a Blank HTML Document
|
269
|
+
*CloudmersiveConvertApiClient::EditHtmlApi* | [**edit_html_html_get_language**](docs/EditHtmlApi.md#edit_html_html_get_language) | **POST** /convert/edit/html/head/get/language | Gets the language for the HTML document
|
270
|
+
*CloudmersiveConvertApiClient::EditHtmlApi* | [**edit_html_html_get_links**](docs/EditHtmlApi.md#edit_html_html_get_links) | **POST** /convert/edit/html/extract/links | Extract resolved link URLs from HTML File
|
271
|
+
*CloudmersiveConvertApiClient::EditHtmlApi* | [**edit_html_html_get_rel_canonical**](docs/EditHtmlApi.md#edit_html_html_get_rel_canonical) | **POST** /convert/edit/html/head/get/rel-canonical-url | Gets the rel canonical URL for the HTML document
|
272
|
+
*CloudmersiveConvertApiClient::EditHtmlApi* | [**edit_html_html_get_sitemap**](docs/EditHtmlApi.md#edit_html_html_get_sitemap) | **POST** /convert/edit/html/head/get/sitemap-url | Gets the sitemap URL for the HTML document
|
273
|
+
*CloudmersiveConvertApiClient::EditHtmlApi* | [**edit_html_html_set_language**](docs/EditHtmlApi.md#edit_html_html_set_language) | **POST** /convert/edit/html/head/set/language | Sets the language for the HTML document
|
274
|
+
*CloudmersiveConvertApiClient::EditHtmlApi* | [**edit_html_html_set_rel_canonical**](docs/EditHtmlApi.md#edit_html_html_set_rel_canonical) | **POST** /convert/edit/html/head/set/rel-canonical-url | Sets the rel canonical URL for the HTML document
|
275
|
+
*CloudmersiveConvertApiClient::EditHtmlApi* | [**edit_html_html_set_sitemap_url**](docs/EditHtmlApi.md#edit_html_html_set_sitemap_url) | **POST** /convert/edit/html/head/set/sitemap-url | Sets the sitemap URL for the HTML document
|
265
276
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_add_annotations**](docs/EditPdfApi.md#edit_pdf_add_annotations) | **POST** /convert/edit/pdf/annotations/add-item | Add one or more PDF annotations, comments in the PDF document
|
266
277
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_convert_to_pdf_a**](docs/EditPdfApi.md#edit_pdf_convert_to_pdf_a) | **POST** /convert/edit/pdf/optimize/pdf-a | Convert a PDF file to PDF/A
|
267
278
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_decrypt**](docs/EditPdfApi.md#edit_pdf_decrypt) | **POST** /convert/edit/pdf/decrypt | Decrypt and password-protect a PDF
|
@@ -299,6 +310,8 @@ Class | Method | HTTP request | Description
|
|
299
310
|
*CloudmersiveConvertApiClient::EditTextApi* | [**edit_text_trim_whitespace**](docs/EditTextApi.md#edit_text_trim_whitespace) | **POST** /convert/edit/text/remove/whitespace/trim | Trim leading and trailing whitespace from text string
|
300
311
|
*CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_docx**](docs/MergeDocumentApi.md#merge_document_docx) | **POST** /convert/merge/docx | Merge Two Word DOCX Together
|
301
312
|
*CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_docx_multi**](docs/MergeDocumentApi.md#merge_document_docx_multi) | **POST** /convert/merge/docx/multi | Merge Multple Word DOCX Together
|
313
|
+
*CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_html**](docs/MergeDocumentApi.md#merge_document_html) | **POST** /convert/merge/html | Merge Two HTML (HTM) Files Together
|
314
|
+
*CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_html_multi**](docs/MergeDocumentApi.md#merge_document_html_multi) | **POST** /convert/merge/html/multi | Merge Multple HTML (HTM) Files Together
|
302
315
|
*CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_pdf**](docs/MergeDocumentApi.md#merge_document_pdf) | **POST** /convert/merge/pdf | Merge Two PDF Files Together
|
303
316
|
*CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_pdf_multi**](docs/MergeDocumentApi.md#merge_document_pdf_multi) | **POST** /convert/merge/pdf/multi | Merge Multple PDF Files Together
|
304
317
|
*CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_png**](docs/MergeDocumentApi.md#merge_document_png) | **POST** /convert/merge/png/vertical | Merge Two PNG Files Together
|
@@ -323,6 +336,7 @@ Class | Method | HTTP request | Description
|
|
323
336
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_eml_validation**](docs/ValidateDocumentApi.md#validate_document_eml_validation) | **POST** /convert/validate/eml | Validate if an EML file is executable
|
324
337
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_executable_validation**](docs/ValidateDocumentApi.md#validate_document_executable_validation) | **POST** /convert/validate/executable | Validate if a file is executable
|
325
338
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_g_zip_validation**](docs/ValidateDocumentApi.md#validate_document_g_zip_validation) | **POST** /convert/validate/gzip | Validate a GZip Archive file (gzip or gz)
|
339
|
+
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_html_ssrf_validation**](docs/ValidateDocumentApi.md#validate_document_html_ssrf_validation) | **POST** /convert/validate/html/ssrf-threat-check | Validate an HTML file and checks for SSRF threats
|
326
340
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_html_validation**](docs/ValidateDocumentApi.md#validate_document_html_validation) | **POST** /convert/validate/html | Validate an HTML file
|
327
341
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_image_validation**](docs/ValidateDocumentApi.md#validate_document_image_validation) | **POST** /convert/validate/image | Validate an Image File
|
328
342
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_jpg_validation**](docs/ValidateDocumentApi.md#validate_document_jpg_validation) | **POST** /convert/validate/jpg | Validate a JPG File
|
@@ -336,11 +350,13 @@ Class | Method | HTTP request | Description
|
|
336
350
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_txt_validation**](docs/ValidateDocumentApi.md#validate_document_txt_validation) | **POST** /convert/validate/txt | Validate an TXT file
|
337
351
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_xlsx_validation**](docs/ValidateDocumentApi.md#validate_document_xlsx_validation) | **POST** /convert/validate/xlsx | Validate a Excel document (XLSX)
|
338
352
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_xml_validation**](docs/ValidateDocumentApi.md#validate_document_xml_validation) | **POST** /convert/validate/xml | Validate an XML file
|
353
|
+
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_xml_xxe_threat_validation**](docs/ValidateDocumentApi.md#validate_document_xml_xxe_threat_validation) | **POST** /convert/validate/xml/xxe-threats | Validate an XML file for XML External Entity (XXE) threats
|
339
354
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_zip_validation**](docs/ValidateDocumentApi.md#validate_document_zip_validation) | **POST** /convert/validate/zip | Validate a Zip Archive file (zip)
|
340
355
|
*CloudmersiveConvertApiClient::ViewerToolsApi* | [**viewer_tools_create_simple**](docs/ViewerToolsApi.md#viewer_tools_create_simple) | **POST** /convert/viewer/create/web/simple | Create a web-based viewer
|
341
356
|
*CloudmersiveConvertApiClient::ZipArchiveApi* | [**zip_archive_zip_create**](docs/ZipArchiveApi.md#zip_archive_zip_create) | **POST** /convert/archive/zip/create | Compress files to create a new zip archive
|
342
357
|
*CloudmersiveConvertApiClient::ZipArchiveApi* | [**zip_archive_zip_create_advanced**](docs/ZipArchiveApi.md#zip_archive_zip_create_advanced) | **POST** /convert/archive/zip/create/advanced | Compress files and folders to create a new zip archive with advanced options
|
343
358
|
*CloudmersiveConvertApiClient::ZipArchiveApi* | [**zip_archive_zip_create_encrypted**](docs/ZipArchiveApi.md#zip_archive_zip_create_encrypted) | **POST** /convert/archive/zip/create/encrypted | Compress files to create a new, encrypted and password-protected zip archive
|
359
|
+
*CloudmersiveConvertApiClient::ZipArchiveApi* | [**zip_archive_zip_create_quarantine**](docs/ZipArchiveApi.md#zip_archive_zip_create_quarantine) | **POST** /convert/archive/zip/create/quarantine | Create an encrypted zip file to quarantine a dangerous file
|
344
360
|
*CloudmersiveConvertApiClient::ZipArchiveApi* | [**zip_archive_zip_decrypt**](docs/ZipArchiveApi.md#zip_archive_zip_decrypt) | **POST** /convert/archive/zip/decrypt | Decrypt and remove password protection on a zip file
|
345
361
|
*CloudmersiveConvertApiClient::ZipArchiveApi* | [**zip_archive_zip_encrypt_advanced**](docs/ZipArchiveApi.md#zip_archive_zip_encrypt_advanced) | **POST** /convert/archive/zip/encrypt/advanced | Encrypt and password protect a zip file
|
346
362
|
*CloudmersiveConvertApiClient::ZipArchiveApi* | [**zip_archive_zip_extract**](docs/ZipArchiveApi.md#zip_archive_zip_extract) | **POST** /convert/archive/zip/extract | Extract, decompress files and folders from a zip archive
|
@@ -461,6 +477,7 @@ Class | Method | HTTP request | Description
|
|
461
477
|
- [CloudmersiveConvertApiClient::GetDocxTablesResponse](docs/GetDocxTablesResponse.md)
|
462
478
|
- [CloudmersiveConvertApiClient::GetFileTypeIconResult](docs/GetFileTypeIconResult.md)
|
463
479
|
- [CloudmersiveConvertApiClient::GetImageInfoResult](docs/GetImageInfoResult.md)
|
480
|
+
- [CloudmersiveConvertApiClient::GetMacrosResponse](docs/GetMacrosResponse.md)
|
464
481
|
- [CloudmersiveConvertApiClient::GetPdfAnnotationsResult](docs/GetPdfAnnotationsResult.md)
|
465
482
|
- [CloudmersiveConvertApiClient::GetXlsxCellByIdentifierRequest](docs/GetXlsxCellByIdentifierRequest.md)
|
466
483
|
- [CloudmersiveConvertApiClient::GetXlsxCellByIdentifierResponse](docs/GetXlsxCellByIdentifierResponse.md)
|
@@ -478,10 +495,17 @@ Class | Method | HTTP request | Description
|
|
478
495
|
- [CloudmersiveConvertApiClient::GetXlsxStylesResponse](docs/GetXlsxStylesResponse.md)
|
479
496
|
- [CloudmersiveConvertApiClient::GetXlsxWorksheetsRequest](docs/GetXlsxWorksheetsRequest.md)
|
480
497
|
- [CloudmersiveConvertApiClient::GetXlsxWorksheetsResponse](docs/GetXlsxWorksheetsResponse.md)
|
498
|
+
- [CloudmersiveConvertApiClient::HtmlGetLanguageResult](docs/HtmlGetLanguageResult.md)
|
499
|
+
- [CloudmersiveConvertApiClient::HtmlGetLinksResponse](docs/HtmlGetLinksResponse.md)
|
500
|
+
- [CloudmersiveConvertApiClient::HtmlGetRelCanonicalUrlResult](docs/HtmlGetRelCanonicalUrlResult.md)
|
501
|
+
- [CloudmersiveConvertApiClient::HtmlGetSitemapUrlResult](docs/HtmlGetSitemapUrlResult.md)
|
502
|
+
- [CloudmersiveConvertApiClient::HtmlHyperlink](docs/HtmlHyperlink.md)
|
481
503
|
- [CloudmersiveConvertApiClient::HtmlMdResult](docs/HtmlMdResult.md)
|
504
|
+
- [CloudmersiveConvertApiClient::HtmlSsrfThreatCheckResult](docs/HtmlSsrfThreatCheckResult.md)
|
482
505
|
- [CloudmersiveConvertApiClient::HtmlTemplateApplicationRequest](docs/HtmlTemplateApplicationRequest.md)
|
483
506
|
- [CloudmersiveConvertApiClient::HtmlTemplateApplicationResponse](docs/HtmlTemplateApplicationResponse.md)
|
484
507
|
- [CloudmersiveConvertApiClient::HtmlTemplateOperation](docs/HtmlTemplateOperation.md)
|
508
|
+
- [CloudmersiveConvertApiClient::HtmlThreatLink](docs/HtmlThreatLink.md)
|
485
509
|
- [CloudmersiveConvertApiClient::HtmlToOfficeRequest](docs/HtmlToOfficeRequest.md)
|
486
510
|
- [CloudmersiveConvertApiClient::HtmlToPdfRequest](docs/HtmlToPdfRequest.md)
|
487
511
|
- [CloudmersiveConvertApiClient::HtmlToPngRequest](docs/HtmlToPngRequest.md)
|
@@ -587,6 +611,7 @@ Class | Method | HTTP request | Description
|
|
587
611
|
- [CloudmersiveConvertApiClient::XmlRemoveWithXPathResult](docs/XmlRemoveWithXPathResult.md)
|
588
612
|
- [CloudmersiveConvertApiClient::XmlReplaceWithXPathResult](docs/XmlReplaceWithXPathResult.md)
|
589
613
|
- [CloudmersiveConvertApiClient::XmlSetValueWithXPathResult](docs/XmlSetValueWithXPathResult.md)
|
614
|
+
- [CloudmersiveConvertApiClient::XxeThreatDetectionResult](docs/XxeThreatDetectionResult.md)
|
590
615
|
- [CloudmersiveConvertApiClient::ZipDirectory](docs/ZipDirectory.md)
|
591
616
|
- [CloudmersiveConvertApiClient::ZipEncryptionAdvancedRequest](docs/ZipEncryptionAdvancedRequest.md)
|
592
617
|
- [CloudmersiveConvertApiClient::ZipExtractResponse](docs/ZipExtractResponse.md)
|
data/docs/EditDocumentApi.md
CHANGED
@@ -18,6 +18,7 @@ Method | HTTP request | Description
|
|
18
18
|
[**edit_document_docx_get_comments_hierarchical**](EditDocumentApi.md#edit_document_docx_get_comments_hierarchical) | **POST** /convert/edit/docx/get-comments/hierarchical | Get comments from a Word DOCX document hierarchically
|
19
19
|
[**edit_document_docx_get_headers_and_footers**](EditDocumentApi.md#edit_document_docx_get_headers_and_footers) | **POST** /convert/edit/docx/get-headers-and-footers | Get content of a footer from a Word DOCX document
|
20
20
|
[**edit_document_docx_get_images**](EditDocumentApi.md#edit_document_docx_get_images) | **POST** /convert/edit/docx/get-images | Get images from a Word DOCX document
|
21
|
+
[**edit_document_docx_get_macro_information**](EditDocumentApi.md#edit_document_docx_get_macro_information) | **POST** /convert/edit/docx/get-macros | Get macro information from a Word DOCX/DOCM document
|
21
22
|
[**edit_document_docx_get_metadata_properties**](EditDocumentApi.md#edit_document_docx_get_metadata_properties) | **POST** /convert/edit/docx/get-metadata | Get all metadata properties in Word DOCX document
|
22
23
|
[**edit_document_docx_get_sections**](EditDocumentApi.md#edit_document_docx_get_sections) | **POST** /convert/edit/docx/get-sections | Get sections from a Word DOCX document
|
23
24
|
[**edit_document_docx_get_styles**](EditDocumentApi.md#edit_document_docx_get_styles) | **POST** /convert/edit/docx/get-styles | Get styles from a Word DOCX document
|
@@ -44,6 +45,7 @@ Method | HTTP request | Description
|
|
44
45
|
[**edit_document_docx_update_table_row**](EditDocumentApi.md#edit_document_docx_update_table_row) | **POST** /convert/edit/docx/update-table-row | Update, set contents of a table row in an existing table in a Word DOCX document
|
45
46
|
[**edit_document_finish_editing**](EditDocumentApi.md#edit_document_finish_editing) | **POST** /convert/edit/finish-editing | Finish editing document, and download result from document editing
|
46
47
|
[**edit_document_pptx_delete_slides**](EditDocumentApi.md#edit_document_pptx_delete_slides) | **POST** /convert/edit/pptx/delete-slides | Delete, remove slides from a PowerPoint PPTX presentation document
|
48
|
+
[**edit_document_pptx_get_macro_information**](EditDocumentApi.md#edit_document_pptx_get_macro_information) | **POST** /convert/edit/pptx/get-macros | Get macro information from a PowerPoint PPTX/PPTM presentation document
|
47
49
|
[**edit_document_pptx_replace**](EditDocumentApi.md#edit_document_pptx_replace) | **POST** /convert/edit/pptx/replace-all | Replace string in PowerPoint PPTX presentation
|
48
50
|
[**edit_document_xlsx_append_row**](EditDocumentApi.md#edit_document_xlsx_append_row) | **POST** /convert/edit/xlsx/append-row | Append row to a Excel XLSX spreadsheet, worksheet
|
49
51
|
[**edit_document_xlsx_clear_cell_by_index**](EditDocumentApi.md#edit_document_xlsx_clear_cell_by_index) | **POST** /convert/edit/xlsx/clear-cell/by-index | Clear cell contents in an Excel XLSX spreadsheet, worksheet by index
|
@@ -57,6 +59,7 @@ Method | HTTP request | Description
|
|
57
59
|
[**edit_document_xlsx_get_cell_by_index**](EditDocumentApi.md#edit_document_xlsx_get_cell_by_index) | **POST** /convert/edit/xlsx/get-cell/by-index | Get cell from an Excel XLSX spreadsheet, worksheet by index
|
58
60
|
[**edit_document_xlsx_get_columns**](EditDocumentApi.md#edit_document_xlsx_get_columns) | **POST** /convert/edit/xlsx/get-columns | Get columns from a Excel XLSX spreadsheet, worksheet
|
59
61
|
[**edit_document_xlsx_get_images**](EditDocumentApi.md#edit_document_xlsx_get_images) | **POST** /convert/edit/xlsx/get-images | Get images from a Excel XLSX spreadsheet, worksheet
|
62
|
+
[**edit_document_xlsx_get_macro_information**](EditDocumentApi.md#edit_document_xlsx_get_macro_information) | **POST** /convert/edit/xlsx/get-macros | Get macro information from a Excel XLSX/XLSM spreadsheet, worksheet
|
60
63
|
[**edit_document_xlsx_get_rows_and_cells**](EditDocumentApi.md#edit_document_xlsx_get_rows_and_cells) | **POST** /convert/edit/xlsx/get-rows-and-cells | Get rows and cells from a Excel XLSX spreadsheet, worksheet
|
61
64
|
[**edit_document_xlsx_get_specific_row**](EditDocumentApi.md#edit_document_xlsx_get_specific_row) | **POST** /convert/edit/xlsx/get-specific-row | Get a specific row from a Excel XLSX spreadsheet, worksheet by path
|
62
65
|
[**edit_document_xlsx_get_styles**](EditDocumentApi.md#edit_document_xlsx_get_styles) | **POST** /convert/edit/xlsx/get-styles | Get styles from a Excel XLSX spreadsheet, worksheet
|
@@ -823,6 +826,60 @@ Name | Type | Description | Notes
|
|
823
826
|
|
824
827
|
|
825
828
|
|
829
|
+
# **edit_document_docx_get_macro_information**
|
830
|
+
> GetMacrosResponse edit_document_docx_get_macro_information(input_file)
|
831
|
+
|
832
|
+
Get macro information from a Word DOCX/DOCM document
|
833
|
+
|
834
|
+
Returns information about the Macros (e.g. VBA) defined in the Word Document
|
835
|
+
|
836
|
+
### Example
|
837
|
+
```ruby
|
838
|
+
# load the gem
|
839
|
+
require 'cloudmersive-convert-api-client'
|
840
|
+
# setup authorization
|
841
|
+
CloudmersiveConvertApiClient.configure do |config|
|
842
|
+
# Configure API key authorization: Apikey
|
843
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
844
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
845
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
846
|
+
end
|
847
|
+
|
848
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
849
|
+
|
850
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
851
|
+
|
852
|
+
|
853
|
+
begin
|
854
|
+
#Get macro information from a Word DOCX/DOCM document
|
855
|
+
result = api_instance.edit_document_docx_get_macro_information(input_file)
|
856
|
+
p result
|
857
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
858
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_get_macro_information: #{e}"
|
859
|
+
end
|
860
|
+
```
|
861
|
+
|
862
|
+
### Parameters
|
863
|
+
|
864
|
+
Name | Type | Description | Notes
|
865
|
+
------------- | ------------- | ------------- | -------------
|
866
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
867
|
+
|
868
|
+
### Return type
|
869
|
+
|
870
|
+
[**GetMacrosResponse**](GetMacrosResponse.md)
|
871
|
+
|
872
|
+
### Authorization
|
873
|
+
|
874
|
+
[Apikey](../README.md#Apikey)
|
875
|
+
|
876
|
+
### HTTP request headers
|
877
|
+
|
878
|
+
- **Content-Type**: multipart/form-data
|
879
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
880
|
+
|
881
|
+
|
882
|
+
|
826
883
|
# **edit_document_docx_get_metadata_properties**
|
827
884
|
> GetDocxMetadataPropertiesResponse edit_document_docx_get_metadata_properties(input_file)
|
828
885
|
|
@@ -2227,6 +2284,60 @@ Name | Type | Description | Notes
|
|
2227
2284
|
|
2228
2285
|
|
2229
2286
|
|
2287
|
+
# **edit_document_pptx_get_macro_information**
|
2288
|
+
> GetMacrosResponse edit_document_pptx_get_macro_information(input_file)
|
2289
|
+
|
2290
|
+
Get macro information from a PowerPoint PPTX/PPTM presentation document
|
2291
|
+
|
2292
|
+
Returns information about the Macros (e.g. VBA) defined in the PowerPoint Document
|
2293
|
+
|
2294
|
+
### Example
|
2295
|
+
```ruby
|
2296
|
+
# load the gem
|
2297
|
+
require 'cloudmersive-convert-api-client'
|
2298
|
+
# setup authorization
|
2299
|
+
CloudmersiveConvertApiClient.configure do |config|
|
2300
|
+
# Configure API key authorization: Apikey
|
2301
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
2302
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2303
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
2304
|
+
end
|
2305
|
+
|
2306
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
2307
|
+
|
2308
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
2309
|
+
|
2310
|
+
|
2311
|
+
begin
|
2312
|
+
#Get macro information from a PowerPoint PPTX/PPTM presentation document
|
2313
|
+
result = api_instance.edit_document_pptx_get_macro_information(input_file)
|
2314
|
+
p result
|
2315
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
2316
|
+
puts "Exception when calling EditDocumentApi->edit_document_pptx_get_macro_information: #{e}"
|
2317
|
+
end
|
2318
|
+
```
|
2319
|
+
|
2320
|
+
### Parameters
|
2321
|
+
|
2322
|
+
Name | Type | Description | Notes
|
2323
|
+
------------- | ------------- | ------------- | -------------
|
2324
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
2325
|
+
|
2326
|
+
### Return type
|
2327
|
+
|
2328
|
+
[**GetMacrosResponse**](GetMacrosResponse.md)
|
2329
|
+
|
2330
|
+
### Authorization
|
2331
|
+
|
2332
|
+
[Apikey](../README.md#Apikey)
|
2333
|
+
|
2334
|
+
### HTTP request headers
|
2335
|
+
|
2336
|
+
- **Content-Type**: multipart/form-data
|
2337
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
2338
|
+
|
2339
|
+
|
2340
|
+
|
2230
2341
|
# **edit_document_pptx_replace**
|
2231
2342
|
> String edit_document_pptx_replace(req_config)
|
2232
2343
|
|
@@ -2929,6 +3040,60 @@ Name | Type | Description | Notes
|
|
2929
3040
|
|
2930
3041
|
|
2931
3042
|
|
3043
|
+
# **edit_document_xlsx_get_macro_information**
|
3044
|
+
> GetMacrosResponse edit_document_xlsx_get_macro_information(input_file)
|
3045
|
+
|
3046
|
+
Get macro information from a Excel XLSX/XLSM spreadsheet, worksheet
|
3047
|
+
|
3048
|
+
Returns information about the Macros (e.g. VBA) defined in the Excel Spreadsheet
|
3049
|
+
|
3050
|
+
### Example
|
3051
|
+
```ruby
|
3052
|
+
# load the gem
|
3053
|
+
require 'cloudmersive-convert-api-client'
|
3054
|
+
# setup authorization
|
3055
|
+
CloudmersiveConvertApiClient.configure do |config|
|
3056
|
+
# Configure API key authorization: Apikey
|
3057
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
3058
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3059
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
3060
|
+
end
|
3061
|
+
|
3062
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
3063
|
+
|
3064
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
3065
|
+
|
3066
|
+
|
3067
|
+
begin
|
3068
|
+
#Get macro information from a Excel XLSX/XLSM spreadsheet, worksheet
|
3069
|
+
result = api_instance.edit_document_xlsx_get_macro_information(input_file)
|
3070
|
+
p result
|
3071
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
3072
|
+
puts "Exception when calling EditDocumentApi->edit_document_xlsx_get_macro_information: #{e}"
|
3073
|
+
end
|
3074
|
+
```
|
3075
|
+
|
3076
|
+
### Parameters
|
3077
|
+
|
3078
|
+
Name | Type | Description | Notes
|
3079
|
+
------------- | ------------- | ------------- | -------------
|
3080
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
3081
|
+
|
3082
|
+
### Return type
|
3083
|
+
|
3084
|
+
[**GetMacrosResponse**](GetMacrosResponse.md)
|
3085
|
+
|
3086
|
+
### Authorization
|
3087
|
+
|
3088
|
+
[Apikey](../README.md#Apikey)
|
3089
|
+
|
3090
|
+
### HTTP request headers
|
3091
|
+
|
3092
|
+
- **Content-Type**: multipart/form-data
|
3093
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
3094
|
+
|
3095
|
+
|
3096
|
+
|
2932
3097
|
# **edit_document_xlsx_get_rows_and_cells**
|
2933
3098
|
> GetXlsxRowsAndCellsResponse edit_document_xlsx_get_rows_and_cells(input)
|
2934
3099
|
|
data/docs/EditHtmlApi.md
CHANGED
@@ -4,11 +4,79 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
+
[**edit_html_html_append_header_tag**](EditHtmlApi.md#edit_html_html_append_header_tag) | **POST** /convert/edit/html/head/append/tag | Append an HTML tag to the HEAD section of an HTML Document
|
7
8
|
[**edit_html_html_append_heading**](EditHtmlApi.md#edit_html_html_append_heading) | **POST** /convert/edit/html/append/heading | Append a Heading to an HTML Document
|
8
9
|
[**edit_html_html_append_image_from_url**](EditHtmlApi.md#edit_html_html_append_image_from_url) | **POST** /convert/edit/html/append/image/from-url | Append an Image to an HTML Document from a URL
|
9
10
|
[**edit_html_html_append_image_inline**](EditHtmlApi.md#edit_html_html_append_image_inline) | **POST** /convert/edit/html/append/image/inline | Append a Base64 Inline Image to an HTML Document
|
10
11
|
[**edit_html_html_append_paragraph**](EditHtmlApi.md#edit_html_html_append_paragraph) | **POST** /convert/edit/html/append/paragraph | Append a Paragraph to an HTML Document
|
11
12
|
[**edit_html_html_create_blank_document**](EditHtmlApi.md#edit_html_html_create_blank_document) | **POST** /convert/edit/html/create/blank | Create a Blank HTML Document
|
13
|
+
[**edit_html_html_get_language**](EditHtmlApi.md#edit_html_html_get_language) | **POST** /convert/edit/html/head/get/language | Gets the language for the HTML document
|
14
|
+
[**edit_html_html_get_links**](EditHtmlApi.md#edit_html_html_get_links) | **POST** /convert/edit/html/extract/links | Extract resolved link URLs from HTML File
|
15
|
+
[**edit_html_html_get_rel_canonical**](EditHtmlApi.md#edit_html_html_get_rel_canonical) | **POST** /convert/edit/html/head/get/rel-canonical-url | Gets the rel canonical URL for the HTML document
|
16
|
+
[**edit_html_html_get_sitemap**](EditHtmlApi.md#edit_html_html_get_sitemap) | **POST** /convert/edit/html/head/get/sitemap-url | Gets the sitemap URL for the HTML document
|
17
|
+
[**edit_html_html_set_language**](EditHtmlApi.md#edit_html_html_set_language) | **POST** /convert/edit/html/head/set/language | Sets the language for the HTML document
|
18
|
+
[**edit_html_html_set_rel_canonical**](EditHtmlApi.md#edit_html_html_set_rel_canonical) | **POST** /convert/edit/html/head/set/rel-canonical-url | Sets the rel canonical URL for the HTML document
|
19
|
+
[**edit_html_html_set_sitemap_url**](EditHtmlApi.md#edit_html_html_set_sitemap_url) | **POST** /convert/edit/html/head/set/sitemap-url | Sets the sitemap URL for the HTML document
|
20
|
+
|
21
|
+
|
22
|
+
# **edit_html_html_append_header_tag**
|
23
|
+
> String edit_html_html_append_header_tag(html_tag, opts)
|
24
|
+
|
25
|
+
Append an HTML tag to the HEAD section of an HTML Document
|
26
|
+
|
27
|
+
Appends an HTML tag to the HEAD section of an HTML document.
|
28
|
+
|
29
|
+
### Example
|
30
|
+
```ruby
|
31
|
+
# load the gem
|
32
|
+
require 'cloudmersive-convert-api-client'
|
33
|
+
# setup authorization
|
34
|
+
CloudmersiveConvertApiClient.configure do |config|
|
35
|
+
# Configure API key authorization: Apikey
|
36
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
37
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
38
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
39
|
+
end
|
40
|
+
|
41
|
+
api_instance = CloudmersiveConvertApiClient::EditHtmlApi.new
|
42
|
+
|
43
|
+
html_tag = 'html_tag_example' # String | The HTML tag to append.
|
44
|
+
|
45
|
+
opts = {
|
46
|
+
input_file: File.new('/path/to/file.txt'), # File | Optional: Input file to perform the operation on.
|
47
|
+
input_file_url: 'input_file_url_example' # String | Optional: URL of a file to operate on as input.
|
48
|
+
}
|
49
|
+
|
50
|
+
begin
|
51
|
+
#Append an HTML tag to the HEAD section of an HTML Document
|
52
|
+
result = api_instance.edit_html_html_append_header_tag(html_tag, opts)
|
53
|
+
p result
|
54
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
55
|
+
puts "Exception when calling EditHtmlApi->edit_html_html_append_header_tag: #{e}"
|
56
|
+
end
|
57
|
+
```
|
58
|
+
|
59
|
+
### Parameters
|
60
|
+
|
61
|
+
Name | Type | Description | Notes
|
62
|
+
------------- | ------------- | ------------- | -------------
|
63
|
+
**html_tag** | **String**| The HTML tag to append. |
|
64
|
+
**input_file** | **File**| Optional: Input file to perform the operation on. | [optional]
|
65
|
+
**input_file_url** | **String**| Optional: URL of a file to operate on as input. | [optional]
|
66
|
+
|
67
|
+
### Return type
|
68
|
+
|
69
|
+
**String**
|
70
|
+
|
71
|
+
### Authorization
|
72
|
+
|
73
|
+
[Apikey](../README.md#Apikey)
|
74
|
+
|
75
|
+
### HTTP request headers
|
76
|
+
|
77
|
+
- **Content-Type**: Not defined
|
78
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
79
|
+
|
12
80
|
|
13
81
|
|
14
82
|
# **edit_html_html_append_heading**
|
@@ -327,3 +395,413 @@ Name | Type | Description | Notes
|
|
327
395
|
|
328
396
|
|
329
397
|
|
398
|
+
# **edit_html_html_get_language**
|
399
|
+
> HtmlGetLanguageResult edit_html_html_get_language(opts)
|
400
|
+
|
401
|
+
Gets the language for the HTML document
|
402
|
+
|
403
|
+
Retrieves the language code (e.g. \"en\" or \"de\") of an HTML document.
|
404
|
+
|
405
|
+
### Example
|
406
|
+
```ruby
|
407
|
+
# load the gem
|
408
|
+
require 'cloudmersive-convert-api-client'
|
409
|
+
# setup authorization
|
410
|
+
CloudmersiveConvertApiClient.configure do |config|
|
411
|
+
# Configure API key authorization: Apikey
|
412
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
413
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
414
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
415
|
+
end
|
416
|
+
|
417
|
+
api_instance = CloudmersiveConvertApiClient::EditHtmlApi.new
|
418
|
+
|
419
|
+
opts = {
|
420
|
+
input_file: File.new('/path/to/file.txt'), # File | Optional: Input file to perform the operation on.
|
421
|
+
input_file_url: 'input_file_url_example' # String | Optional: URL of a file to operate on as input.
|
422
|
+
}
|
423
|
+
|
424
|
+
begin
|
425
|
+
#Gets the language for the HTML document
|
426
|
+
result = api_instance.edit_html_html_get_language(opts)
|
427
|
+
p result
|
428
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
429
|
+
puts "Exception when calling EditHtmlApi->edit_html_html_get_language: #{e}"
|
430
|
+
end
|
431
|
+
```
|
432
|
+
|
433
|
+
### Parameters
|
434
|
+
|
435
|
+
Name | Type | Description | Notes
|
436
|
+
------------- | ------------- | ------------- | -------------
|
437
|
+
**input_file** | **File**| Optional: Input file to perform the operation on. | [optional]
|
438
|
+
**input_file_url** | **String**| Optional: URL of a file to operate on as input. | [optional]
|
439
|
+
|
440
|
+
### Return type
|
441
|
+
|
442
|
+
[**HtmlGetLanguageResult**](HtmlGetLanguageResult.md)
|
443
|
+
|
444
|
+
### Authorization
|
445
|
+
|
446
|
+
[Apikey](../README.md#Apikey)
|
447
|
+
|
448
|
+
### HTTP request headers
|
449
|
+
|
450
|
+
- **Content-Type**: Not defined
|
451
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
452
|
+
|
453
|
+
|
454
|
+
|
455
|
+
# **edit_html_html_get_links**
|
456
|
+
> HtmlGetLinksResponse edit_html_html_get_links(opts)
|
457
|
+
|
458
|
+
Extract resolved link URLs from HTML File
|
459
|
+
|
460
|
+
Extracts the resolved link URLs, fully-qualified if possible, from an input HTML file.
|
461
|
+
|
462
|
+
### Example
|
463
|
+
```ruby
|
464
|
+
# load the gem
|
465
|
+
require 'cloudmersive-convert-api-client'
|
466
|
+
# setup authorization
|
467
|
+
CloudmersiveConvertApiClient.configure do |config|
|
468
|
+
# Configure API key authorization: Apikey
|
469
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
470
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
471
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
472
|
+
end
|
473
|
+
|
474
|
+
api_instance = CloudmersiveConvertApiClient::EditHtmlApi.new
|
475
|
+
|
476
|
+
opts = {
|
477
|
+
input_file: File.new('/path/to/file.txt'), # File | Optional: Input file to perform the operation on.
|
478
|
+
input_file_url: 'input_file_url_example', # String | Optional: URL of a file to operate on as input.
|
479
|
+
base_url: 'base_url_example' # String | Optional: Base URL of the page, such as https://mydomain.com
|
480
|
+
}
|
481
|
+
|
482
|
+
begin
|
483
|
+
#Extract resolved link URLs from HTML File
|
484
|
+
result = api_instance.edit_html_html_get_links(opts)
|
485
|
+
p result
|
486
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
487
|
+
puts "Exception when calling EditHtmlApi->edit_html_html_get_links: #{e}"
|
488
|
+
end
|
489
|
+
```
|
490
|
+
|
491
|
+
### Parameters
|
492
|
+
|
493
|
+
Name | Type | Description | Notes
|
494
|
+
------------- | ------------- | ------------- | -------------
|
495
|
+
**input_file** | **File**| Optional: Input file to perform the operation on. | [optional]
|
496
|
+
**input_file_url** | **String**| Optional: URL of a file to operate on as input. | [optional]
|
497
|
+
**base_url** | **String**| Optional: Base URL of the page, such as https://mydomain.com | [optional]
|
498
|
+
|
499
|
+
### Return type
|
500
|
+
|
501
|
+
[**HtmlGetLinksResponse**](HtmlGetLinksResponse.md)
|
502
|
+
|
503
|
+
### Authorization
|
504
|
+
|
505
|
+
[Apikey](../README.md#Apikey)
|
506
|
+
|
507
|
+
### HTTP request headers
|
508
|
+
|
509
|
+
- **Content-Type**: Not defined
|
510
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
511
|
+
|
512
|
+
|
513
|
+
|
514
|
+
# **edit_html_html_get_rel_canonical**
|
515
|
+
> HtmlGetRelCanonicalUrlResult edit_html_html_get_rel_canonical(opts)
|
516
|
+
|
517
|
+
Gets the rel canonical URL for the HTML document
|
518
|
+
|
519
|
+
Gets the rel canonical URL of an HTML document.
|
520
|
+
|
521
|
+
### Example
|
522
|
+
```ruby
|
523
|
+
# load the gem
|
524
|
+
require 'cloudmersive-convert-api-client'
|
525
|
+
# setup authorization
|
526
|
+
CloudmersiveConvertApiClient.configure do |config|
|
527
|
+
# Configure API key authorization: Apikey
|
528
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
529
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
530
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
531
|
+
end
|
532
|
+
|
533
|
+
api_instance = CloudmersiveConvertApiClient::EditHtmlApi.new
|
534
|
+
|
535
|
+
opts = {
|
536
|
+
input_file: File.new('/path/to/file.txt'), # File | Optional: Input file to perform the operation on.
|
537
|
+
input_file_url: 'input_file_url_example' # String | Optional: URL of a file to operate on as input.
|
538
|
+
}
|
539
|
+
|
540
|
+
begin
|
541
|
+
#Gets the rel canonical URL for the HTML document
|
542
|
+
result = api_instance.edit_html_html_get_rel_canonical(opts)
|
543
|
+
p result
|
544
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
545
|
+
puts "Exception when calling EditHtmlApi->edit_html_html_get_rel_canonical: #{e}"
|
546
|
+
end
|
547
|
+
```
|
548
|
+
|
549
|
+
### Parameters
|
550
|
+
|
551
|
+
Name | Type | Description | Notes
|
552
|
+
------------- | ------------- | ------------- | -------------
|
553
|
+
**input_file** | **File**| Optional: Input file to perform the operation on. | [optional]
|
554
|
+
**input_file_url** | **String**| Optional: URL of a file to operate on as input. | [optional]
|
555
|
+
|
556
|
+
### Return type
|
557
|
+
|
558
|
+
[**HtmlGetRelCanonicalUrlResult**](HtmlGetRelCanonicalUrlResult.md)
|
559
|
+
|
560
|
+
### Authorization
|
561
|
+
|
562
|
+
[Apikey](../README.md#Apikey)
|
563
|
+
|
564
|
+
### HTTP request headers
|
565
|
+
|
566
|
+
- **Content-Type**: Not defined
|
567
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
568
|
+
|
569
|
+
|
570
|
+
|
571
|
+
# **edit_html_html_get_sitemap**
|
572
|
+
> HtmlGetSitemapUrlResult edit_html_html_get_sitemap(opts)
|
573
|
+
|
574
|
+
Gets the sitemap URL for the HTML document
|
575
|
+
|
576
|
+
Gets the sitemap link URL of an HTML document.
|
577
|
+
|
578
|
+
### Example
|
579
|
+
```ruby
|
580
|
+
# load the gem
|
581
|
+
require 'cloudmersive-convert-api-client'
|
582
|
+
# setup authorization
|
583
|
+
CloudmersiveConvertApiClient.configure do |config|
|
584
|
+
# Configure API key authorization: Apikey
|
585
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
586
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
587
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
588
|
+
end
|
589
|
+
|
590
|
+
api_instance = CloudmersiveConvertApiClient::EditHtmlApi.new
|
591
|
+
|
592
|
+
opts = {
|
593
|
+
input_file: File.new('/path/to/file.txt'), # File | Optional: Input file to perform the operation on.
|
594
|
+
input_file_url: 'input_file_url_example' # String | Optional: URL of a file to operate on as input.
|
595
|
+
}
|
596
|
+
|
597
|
+
begin
|
598
|
+
#Gets the sitemap URL for the HTML document
|
599
|
+
result = api_instance.edit_html_html_get_sitemap(opts)
|
600
|
+
p result
|
601
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
602
|
+
puts "Exception when calling EditHtmlApi->edit_html_html_get_sitemap: #{e}"
|
603
|
+
end
|
604
|
+
```
|
605
|
+
|
606
|
+
### Parameters
|
607
|
+
|
608
|
+
Name | Type | Description | Notes
|
609
|
+
------------- | ------------- | ------------- | -------------
|
610
|
+
**input_file** | **File**| Optional: Input file to perform the operation on. | [optional]
|
611
|
+
**input_file_url** | **String**| Optional: URL of a file to operate on as input. | [optional]
|
612
|
+
|
613
|
+
### Return type
|
614
|
+
|
615
|
+
[**HtmlGetSitemapUrlResult**](HtmlGetSitemapUrlResult.md)
|
616
|
+
|
617
|
+
### Authorization
|
618
|
+
|
619
|
+
[Apikey](../README.md#Apikey)
|
620
|
+
|
621
|
+
### HTTP request headers
|
622
|
+
|
623
|
+
- **Content-Type**: Not defined
|
624
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
625
|
+
|
626
|
+
|
627
|
+
|
628
|
+
# **edit_html_html_set_language**
|
629
|
+
> String edit_html_html_set_language(language_code, opts)
|
630
|
+
|
631
|
+
Sets the language for the HTML document
|
632
|
+
|
633
|
+
Sets the language code of an HTML document.
|
634
|
+
|
635
|
+
### Example
|
636
|
+
```ruby
|
637
|
+
# load the gem
|
638
|
+
require 'cloudmersive-convert-api-client'
|
639
|
+
# setup authorization
|
640
|
+
CloudmersiveConvertApiClient.configure do |config|
|
641
|
+
# Configure API key authorization: Apikey
|
642
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
643
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
644
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
645
|
+
end
|
646
|
+
|
647
|
+
api_instance = CloudmersiveConvertApiClient::EditHtmlApi.new
|
648
|
+
|
649
|
+
language_code = 'language_code_example' # String | The HTML langauge code to set.
|
650
|
+
|
651
|
+
opts = {
|
652
|
+
input_file: File.new('/path/to/file.txt'), # File | Optional: Input file to perform the operation on.
|
653
|
+
input_file_url: 'input_file_url_example' # String | Optional: URL of a file to operate on as input.
|
654
|
+
}
|
655
|
+
|
656
|
+
begin
|
657
|
+
#Sets the language for the HTML document
|
658
|
+
result = api_instance.edit_html_html_set_language(language_code, opts)
|
659
|
+
p result
|
660
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
661
|
+
puts "Exception when calling EditHtmlApi->edit_html_html_set_language: #{e}"
|
662
|
+
end
|
663
|
+
```
|
664
|
+
|
665
|
+
### Parameters
|
666
|
+
|
667
|
+
Name | Type | Description | Notes
|
668
|
+
------------- | ------------- | ------------- | -------------
|
669
|
+
**language_code** | **String**| The HTML langauge code to set. |
|
670
|
+
**input_file** | **File**| Optional: Input file to perform the operation on. | [optional]
|
671
|
+
**input_file_url** | **String**| Optional: URL of a file to operate on as input. | [optional]
|
672
|
+
|
673
|
+
### Return type
|
674
|
+
|
675
|
+
**String**
|
676
|
+
|
677
|
+
### Authorization
|
678
|
+
|
679
|
+
[Apikey](../README.md#Apikey)
|
680
|
+
|
681
|
+
### HTTP request headers
|
682
|
+
|
683
|
+
- **Content-Type**: Not defined
|
684
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
685
|
+
|
686
|
+
|
687
|
+
|
688
|
+
# **edit_html_html_set_rel_canonical**
|
689
|
+
> String edit_html_html_set_rel_canonical(canonical_url, opts)
|
690
|
+
|
691
|
+
Sets the rel canonical URL for the HTML document
|
692
|
+
|
693
|
+
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.
|
694
|
+
|
695
|
+
### Example
|
696
|
+
```ruby
|
697
|
+
# load the gem
|
698
|
+
require 'cloudmersive-convert-api-client'
|
699
|
+
# setup authorization
|
700
|
+
CloudmersiveConvertApiClient.configure do |config|
|
701
|
+
# Configure API key authorization: Apikey
|
702
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
703
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
704
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
705
|
+
end
|
706
|
+
|
707
|
+
api_instance = CloudmersiveConvertApiClient::EditHtmlApi.new
|
708
|
+
|
709
|
+
canonical_url = 'canonical_url_example' # String | The HTML canonical URL to set.
|
710
|
+
|
711
|
+
opts = {
|
712
|
+
input_file: File.new('/path/to/file.txt'), # File | Optional: Input file to perform the operation on.
|
713
|
+
input_file_url: 'input_file_url_example' # String | Optional: URL of a file to operate on as input.
|
714
|
+
}
|
715
|
+
|
716
|
+
begin
|
717
|
+
#Sets the rel canonical URL for the HTML document
|
718
|
+
result = api_instance.edit_html_html_set_rel_canonical(canonical_url, opts)
|
719
|
+
p result
|
720
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
721
|
+
puts "Exception when calling EditHtmlApi->edit_html_html_set_rel_canonical: #{e}"
|
722
|
+
end
|
723
|
+
```
|
724
|
+
|
725
|
+
### Parameters
|
726
|
+
|
727
|
+
Name | Type | Description | Notes
|
728
|
+
------------- | ------------- | ------------- | -------------
|
729
|
+
**canonical_url** | **String**| The HTML canonical URL to set. |
|
730
|
+
**input_file** | **File**| Optional: Input file to perform the operation on. | [optional]
|
731
|
+
**input_file_url** | **String**| Optional: URL of a file to operate on as input. | [optional]
|
732
|
+
|
733
|
+
### Return type
|
734
|
+
|
735
|
+
**String**
|
736
|
+
|
737
|
+
### Authorization
|
738
|
+
|
739
|
+
[Apikey](../README.md#Apikey)
|
740
|
+
|
741
|
+
### HTTP request headers
|
742
|
+
|
743
|
+
- **Content-Type**: Not defined
|
744
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
745
|
+
|
746
|
+
|
747
|
+
|
748
|
+
# **edit_html_html_set_sitemap_url**
|
749
|
+
> String edit_html_html_set_sitemap_url(sitemap_url, opts)
|
750
|
+
|
751
|
+
Sets the sitemap URL for the HTML document
|
752
|
+
|
753
|
+
Sets the sitemap URL of an HTML document.
|
754
|
+
|
755
|
+
### Example
|
756
|
+
```ruby
|
757
|
+
# load the gem
|
758
|
+
require 'cloudmersive-convert-api-client'
|
759
|
+
# setup authorization
|
760
|
+
CloudmersiveConvertApiClient.configure do |config|
|
761
|
+
# Configure API key authorization: Apikey
|
762
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
763
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
764
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
765
|
+
end
|
766
|
+
|
767
|
+
api_instance = CloudmersiveConvertApiClient::EditHtmlApi.new
|
768
|
+
|
769
|
+
sitemap_url = 'sitemap_url_example' # String | The HTML sitemap URL to set.
|
770
|
+
|
771
|
+
opts = {
|
772
|
+
input_file: File.new('/path/to/file.txt'), # File | Optional: Input file to perform the operation on.
|
773
|
+
input_file_url: 'input_file_url_example' # String | Optional: URL of a file to operate on as input.
|
774
|
+
}
|
775
|
+
|
776
|
+
begin
|
777
|
+
#Sets the sitemap URL for the HTML document
|
778
|
+
result = api_instance.edit_html_html_set_sitemap_url(sitemap_url, opts)
|
779
|
+
p result
|
780
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
781
|
+
puts "Exception when calling EditHtmlApi->edit_html_html_set_sitemap_url: #{e}"
|
782
|
+
end
|
783
|
+
```
|
784
|
+
|
785
|
+
### Parameters
|
786
|
+
|
787
|
+
Name | Type | Description | Notes
|
788
|
+
------------- | ------------- | ------------- | -------------
|
789
|
+
**sitemap_url** | **String**| The HTML sitemap URL to set. |
|
790
|
+
**input_file** | **File**| Optional: Input file to perform the operation on. | [optional]
|
791
|
+
**input_file_url** | **String**| Optional: URL of a file to operate on as input. | [optional]
|
792
|
+
|
793
|
+
### Return type
|
794
|
+
|
795
|
+
**String**
|
796
|
+
|
797
|
+
### Authorization
|
798
|
+
|
799
|
+
[Apikey](../README.md#Apikey)
|
800
|
+
|
801
|
+
### HTTP request headers
|
802
|
+
|
803
|
+
- **Content-Type**: Not defined
|
804
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
805
|
+
|
806
|
+
|
807
|
+
|