cloudmersive-convert-api-client 2.1.1 → 2.1.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +24 -4
- data/docs/DocxMetadataCustomProperty.md +13 -0
- data/docs/DocxSetCustomMetadataPropertiesRequest.md +10 -0
- data/docs/EditDocumentApi.md +275 -0
- data/docs/EditHtmlApi.md +60 -0
- data/docs/GetDocxMetadataPropertiesResponse.md +16 -0
- data/docs/GetMacrosResponse.md +9 -0
- data/docs/HtmlGetLinksResponse.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 +220 -0
- data/docs/ViewerToolsApi.md +8 -2
- data/lib/cloudmersive-convert-api-client.rb +8 -0
- data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +274 -0
- data/lib/cloudmersive-convert-api-client/api/edit_html_api.rb +55 -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 +220 -0
- data/lib/cloudmersive-convert-api-client/api/viewer_tools_api.rb +6 -0
- data/lib/cloudmersive-convert-api-client/models/docx_metadata_custom_property.rb +236 -0
- data/lib/cloudmersive-convert-api-client/models/docx_set_custom_metadata_properties_request.rb +223 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_metadata_properties_response.rb +268 -0
- data/lib/cloudmersive-convert-api-client/models/get_macros_response.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_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/version.rb +1 -1
- data/spec/api/edit_document_api_spec.rb +60 -0
- data/spec/api/edit_html_api_spec.rb +14 -0
- data/spec/api/merge_document_api_spec.rb +34 -0
- data/spec/api/validate_document_api_spec.rb +48 -0
- data/spec/api/viewer_tools_api_spec.rb +2 -0
- data/spec/models/docx_metadata_custom_property_spec.rb +71 -0
- data/spec/models/docx_set_custom_metadata_properties_request_spec.rb +53 -0
- data/spec/models/get_docx_metadata_properties_response_spec.rb +89 -0
- data/spec/models/get_macros_response_spec.rb +47 -0
- data/spec/models/html_get_links_response_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
- metadata +26 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ff9ffb546ea02d639338b712f6303c8d5be21843a39b66d6fd3c77f198fad29d
|
4
|
+
data.tar.gz: 33e8154c9155c9278a6aaddbe69bf2286681aa4d1b59180f7ed90bffbfa3e287
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5d06f1431223769adf83181ab97d2dbbc0c6f045e37456dfebc1918a6ded4c201d2f24843e76e63c6e44fb0ed9f67eb4175f22927ee445f021be42e6281d4bee
|
7
|
+
data.tar.gz: 33a4556b551b8247e66cbc667cff26135ec095bf9e43f1485ebed6d5b3128befdb9fd317f29dc312b9804b8b05bd60935e58ca38f91986e38c25d52a97fdf848
|
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.6
|
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.6.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.6.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.6'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -210,6 +210,8 @@ 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
|
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
|
213
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
|
214
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
|
215
217
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_table_by_index**](docs/EditDocumentApi.md#edit_document_docx_get_table_by_index) | **POST** /convert/edit/docx/get-table/by-index | Get a specific table by index in a Word DOCX document
|
@@ -227,6 +229,7 @@ Class | Method | HTTP request | Description
|
|
227
229
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_replace**](docs/EditDocumentApi.md#edit_document_docx_replace) | **POST** /convert/edit/docx/replace-all | Replace string in Word DOCX document
|
228
230
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_replace_multi**](docs/EditDocumentApi.md#edit_document_docx_replace_multi) | **POST** /convert/edit/docx/replace-all/multi | Replace multiple strings in Word DOCX document
|
229
231
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_replace_paragraph**](docs/EditDocumentApi.md#edit_document_docx_replace_paragraph) | **POST** /convert/edit/docx/replace/paragraph | Replace matching paragraphs in a Word DOCX document
|
232
|
+
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_set_custom_metadata_properties**](docs/EditDocumentApi.md#edit_document_docx_set_custom_metadata_properties) | **POST** /convert/edit/docx/set-metadata/custom-property | Set custom property metadata properties in Word DOCX document
|
230
233
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_set_footer**](docs/EditDocumentApi.md#edit_document_docx_set_footer) | **POST** /convert/edit/docx/set-footer | Set the footer in a Word DOCX document
|
231
234
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_set_footer_add_page_number**](docs/EditDocumentApi.md#edit_document_docx_set_footer_add_page_number) | **POST** /convert/edit/docx/set-footer/add-page-number | Add page number to footer in a Word DOCX document
|
232
235
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_set_header**](docs/EditDocumentApi.md#edit_document_docx_set_header) | **POST** /convert/edit/docx/set-header | Set the header in a Word DOCX document
|
@@ -234,6 +237,7 @@ Class | Method | HTTP request | Description
|
|
234
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
|
235
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
|
236
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
|
237
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
|
238
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
|
239
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
|
@@ -247,6 +251,7 @@ Class | Method | HTTP request | Description
|
|
247
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
|
248
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
|
249
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
|
250
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
|
251
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
|
252
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
|
@@ -260,6 +265,7 @@ Class | Method | HTTP request | Description
|
|
260
265
|
*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
|
261
266
|
*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
|
262
267
|
*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
|
268
|
+
*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
|
263
269
|
*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
|
264
270
|
*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
|
265
271
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_decrypt**](docs/EditPdfApi.md#edit_pdf_decrypt) | **POST** /convert/edit/pdf/decrypt | Decrypt and password-protect a PDF
|
@@ -297,6 +303,8 @@ Class | Method | HTTP request | Description
|
|
297
303
|
*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
|
298
304
|
*CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_docx**](docs/MergeDocumentApi.md#merge_document_docx) | **POST** /convert/merge/docx | Merge Two Word DOCX Together
|
299
305
|
*CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_docx_multi**](docs/MergeDocumentApi.md#merge_document_docx_multi) | **POST** /convert/merge/docx/multi | Merge Multple Word DOCX Together
|
306
|
+
*CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_html**](docs/MergeDocumentApi.md#merge_document_html) | **POST** /convert/merge/html | Merge Two HTML (HTM) Files Together
|
307
|
+
*CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_html_multi**](docs/MergeDocumentApi.md#merge_document_html_multi) | **POST** /convert/merge/html/multi | Merge Multple HTML (HTM) Files Together
|
300
308
|
*CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_pdf**](docs/MergeDocumentApi.md#merge_document_pdf) | **POST** /convert/merge/pdf | Merge Two PDF Files Together
|
301
309
|
*CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_pdf_multi**](docs/MergeDocumentApi.md#merge_document_pdf_multi) | **POST** /convert/merge/pdf/multi | Merge Multple PDF Files Together
|
302
310
|
*CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_png**](docs/MergeDocumentApi.md#merge_document_png) | **POST** /convert/merge/png/vertical | Merge Two PNG Files Together
|
@@ -321,14 +329,18 @@ Class | Method | HTTP request | Description
|
|
321
329
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_eml_validation**](docs/ValidateDocumentApi.md#validate_document_eml_validation) | **POST** /convert/validate/eml | Validate if an EML file is executable
|
322
330
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_executable_validation**](docs/ValidateDocumentApi.md#validate_document_executable_validation) | **POST** /convert/validate/executable | Validate if a file is executable
|
323
331
|
*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)
|
332
|
+
*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
|
324
333
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_html_validation**](docs/ValidateDocumentApi.md#validate_document_html_validation) | **POST** /convert/validate/html | Validate an HTML file
|
325
334
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_image_validation**](docs/ValidateDocumentApi.md#validate_document_image_validation) | **POST** /convert/validate/image | Validate an Image File
|
335
|
+
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_jpg_validation**](docs/ValidateDocumentApi.md#validate_document_jpg_validation) | **POST** /convert/validate/jpg | Validate a JPG File
|
326
336
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_json_validation**](docs/ValidateDocumentApi.md#validate_document_json_validation) | **POST** /convert/validate/json | Validate a JSON file
|
327
337
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_msg_validation**](docs/ValidateDocumentApi.md#validate_document_msg_validation) | **POST** /convert/validate/msg | Validate if an MSG file is executable
|
328
338
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_pdf_validation**](docs/ValidateDocumentApi.md#validate_document_pdf_validation) | **POST** /convert/validate/pdf | Validate a PDF document file
|
339
|
+
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_png_validation**](docs/ValidateDocumentApi.md#validate_document_png_validation) | **POST** /convert/validate/png | Validate a PNG File
|
329
340
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_pptx_validation**](docs/ValidateDocumentApi.md#validate_document_pptx_validation) | **POST** /convert/validate/pptx | Validate a PowerPoint presentation (PPTX)
|
330
341
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_rar_validation**](docs/ValidateDocumentApi.md#validate_document_rar_validation) | **POST** /convert/validate/rar | Validate a RAR Archive file (RAR)
|
331
342
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_tar_validation**](docs/ValidateDocumentApi.md#validate_document_tar_validation) | **POST** /convert/validate/tar | Validate a TAR Tarball Archive file (TAR)
|
343
|
+
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_txt_validation**](docs/ValidateDocumentApi.md#validate_document_txt_validation) | **POST** /convert/validate/txt | Validate an TXT file
|
332
344
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_xlsx_validation**](docs/ValidateDocumentApi.md#validate_document_xlsx_validation) | **POST** /convert/validate/xlsx | Validate a Excel document (XLSX)
|
333
345
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_xml_validation**](docs/ValidateDocumentApi.md#validate_document_xml_validation) | **POST** /convert/validate/xml | Validate an XML file
|
334
346
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_zip_validation**](docs/ValidateDocumentApi.md#validate_document_zip_validation) | **POST** /convert/validate/zip | Validate a Zip Archive file (zip)
|
@@ -392,12 +404,14 @@ Class | Method | HTTP request | Description
|
|
392
404
|
- [CloudmersiveConvertApiClient::DocxInsertCommentOnParagraphRequest](docs/DocxInsertCommentOnParagraphRequest.md)
|
393
405
|
- [CloudmersiveConvertApiClient::DocxInsertImageRequest](docs/DocxInsertImageRequest.md)
|
394
406
|
- [CloudmersiveConvertApiClient::DocxInsertImageResponse](docs/DocxInsertImageResponse.md)
|
407
|
+
- [CloudmersiveConvertApiClient::DocxMetadataCustomProperty](docs/DocxMetadataCustomProperty.md)
|
395
408
|
- [CloudmersiveConvertApiClient::DocxPage](docs/DocxPage.md)
|
396
409
|
- [CloudmersiveConvertApiClient::DocxParagraph](docs/DocxParagraph.md)
|
397
410
|
- [CloudmersiveConvertApiClient::DocxRemoveObjectRequest](docs/DocxRemoveObjectRequest.md)
|
398
411
|
- [CloudmersiveConvertApiClient::DocxRemoveObjectResponse](docs/DocxRemoveObjectResponse.md)
|
399
412
|
- [CloudmersiveConvertApiClient::DocxRun](docs/DocxRun.md)
|
400
413
|
- [CloudmersiveConvertApiClient::DocxSection](docs/DocxSection.md)
|
414
|
+
- [CloudmersiveConvertApiClient::DocxSetCustomMetadataPropertiesRequest](docs/DocxSetCustomMetadataPropertiesRequest.md)
|
401
415
|
- [CloudmersiveConvertApiClient::DocxSetFooterAddPageNumberRequest](docs/DocxSetFooterAddPageNumberRequest.md)
|
402
416
|
- [CloudmersiveConvertApiClient::DocxSetFooterRequest](docs/DocxSetFooterRequest.md)
|
403
417
|
- [CloudmersiveConvertApiClient::DocxSetFooterResponse](docs/DocxSetFooterResponse.md)
|
@@ -439,6 +453,7 @@ Class | Method | HTTP request | Description
|
|
439
453
|
- [CloudmersiveConvertApiClient::GetDocxHeadersAndFootersResponse](docs/GetDocxHeadersAndFootersResponse.md)
|
440
454
|
- [CloudmersiveConvertApiClient::GetDocxImagesRequest](docs/GetDocxImagesRequest.md)
|
441
455
|
- [CloudmersiveConvertApiClient::GetDocxImagesResponse](docs/GetDocxImagesResponse.md)
|
456
|
+
- [CloudmersiveConvertApiClient::GetDocxMetadataPropertiesResponse](docs/GetDocxMetadataPropertiesResponse.md)
|
442
457
|
- [CloudmersiveConvertApiClient::GetDocxPagesRequest](docs/GetDocxPagesRequest.md)
|
443
458
|
- [CloudmersiveConvertApiClient::GetDocxPagesResponse](docs/GetDocxPagesResponse.md)
|
444
459
|
- [CloudmersiveConvertApiClient::GetDocxSectionsRequest](docs/GetDocxSectionsRequest.md)
|
@@ -453,6 +468,7 @@ Class | Method | HTTP request | Description
|
|
453
468
|
- [CloudmersiveConvertApiClient::GetDocxTablesResponse](docs/GetDocxTablesResponse.md)
|
454
469
|
- [CloudmersiveConvertApiClient::GetFileTypeIconResult](docs/GetFileTypeIconResult.md)
|
455
470
|
- [CloudmersiveConvertApiClient::GetImageInfoResult](docs/GetImageInfoResult.md)
|
471
|
+
- [CloudmersiveConvertApiClient::GetMacrosResponse](docs/GetMacrosResponse.md)
|
456
472
|
- [CloudmersiveConvertApiClient::GetPdfAnnotationsResult](docs/GetPdfAnnotationsResult.md)
|
457
473
|
- [CloudmersiveConvertApiClient::GetXlsxCellByIdentifierRequest](docs/GetXlsxCellByIdentifierRequest.md)
|
458
474
|
- [CloudmersiveConvertApiClient::GetXlsxCellByIdentifierResponse](docs/GetXlsxCellByIdentifierResponse.md)
|
@@ -470,10 +486,14 @@ Class | Method | HTTP request | Description
|
|
470
486
|
- [CloudmersiveConvertApiClient::GetXlsxStylesResponse](docs/GetXlsxStylesResponse.md)
|
471
487
|
- [CloudmersiveConvertApiClient::GetXlsxWorksheetsRequest](docs/GetXlsxWorksheetsRequest.md)
|
472
488
|
- [CloudmersiveConvertApiClient::GetXlsxWorksheetsResponse](docs/GetXlsxWorksheetsResponse.md)
|
489
|
+
- [CloudmersiveConvertApiClient::HtmlGetLinksResponse](docs/HtmlGetLinksResponse.md)
|
490
|
+
- [CloudmersiveConvertApiClient::HtmlHyperlink](docs/HtmlHyperlink.md)
|
473
491
|
- [CloudmersiveConvertApiClient::HtmlMdResult](docs/HtmlMdResult.md)
|
492
|
+
- [CloudmersiveConvertApiClient::HtmlSsrfThreatCheckResult](docs/HtmlSsrfThreatCheckResult.md)
|
474
493
|
- [CloudmersiveConvertApiClient::HtmlTemplateApplicationRequest](docs/HtmlTemplateApplicationRequest.md)
|
475
494
|
- [CloudmersiveConvertApiClient::HtmlTemplateApplicationResponse](docs/HtmlTemplateApplicationResponse.md)
|
476
495
|
- [CloudmersiveConvertApiClient::HtmlTemplateOperation](docs/HtmlTemplateOperation.md)
|
496
|
+
- [CloudmersiveConvertApiClient::HtmlThreatLink](docs/HtmlThreatLink.md)
|
477
497
|
- [CloudmersiveConvertApiClient::HtmlToOfficeRequest](docs/HtmlToOfficeRequest.md)
|
478
498
|
- [CloudmersiveConvertApiClient::HtmlToPdfRequest](docs/HtmlToPdfRequest.md)
|
479
499
|
- [CloudmersiveConvertApiClient::HtmlToPngRequest](docs/HtmlToPngRequest.md)
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxMetadataCustomProperty
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**property_name** | **String** | Name of the property | [optional]
|
7
|
+
**property_data_type** | **String** | Data type of the property; possible values are \"string\", \"integer\", \"double\" or \"date\" | [optional]
|
8
|
+
**string_value** | **String** | If the property is of a string data type, then provides the string value if available | [optional]
|
9
|
+
**integer_value** | **Integer** | If the property is of a integer data type, then provides the integer value if available | [optional]
|
10
|
+
**double_value** | **Float** | If the property is of a double floating point data type, then provides the double value if available | [optional]
|
11
|
+
**date_value** | **DateTime** | If the property is of a date time data type, then provides the date time value if available | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxSetCustomMetadataPropertiesRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**input_file_bytes** | **String** | Optional: Bytes of the input file to operate on | [optional]
|
7
|
+
**input_file_url** | **String** | Optional: URL of a file to operate on as input. This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public). | [optional]
|
8
|
+
**properties_to_set** | [**Array<DocxMetadataCustomProperty>**](DocxMetadataCustomProperty.md) | Required: properties to set in the Word Document; provide one or more property definitions to set - be sure to specify the data type and value, together with the property name | [optional]
|
9
|
+
|
10
|
+
|
data/docs/EditDocumentApi.md
CHANGED
@@ -18,6 +18,8 @@ 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
|
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
|
21
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
|
22
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
|
23
25
|
[**edit_document_docx_get_table_by_index**](EditDocumentApi.md#edit_document_docx_get_table_by_index) | **POST** /convert/edit/docx/get-table/by-index | Get a specific table by index in a Word DOCX document
|
@@ -35,6 +37,7 @@ Method | HTTP request | Description
|
|
35
37
|
[**edit_document_docx_replace**](EditDocumentApi.md#edit_document_docx_replace) | **POST** /convert/edit/docx/replace-all | Replace string in Word DOCX document
|
36
38
|
[**edit_document_docx_replace_multi**](EditDocumentApi.md#edit_document_docx_replace_multi) | **POST** /convert/edit/docx/replace-all/multi | Replace multiple strings in Word DOCX document
|
37
39
|
[**edit_document_docx_replace_paragraph**](EditDocumentApi.md#edit_document_docx_replace_paragraph) | **POST** /convert/edit/docx/replace/paragraph | Replace matching paragraphs in a Word DOCX document
|
40
|
+
[**edit_document_docx_set_custom_metadata_properties**](EditDocumentApi.md#edit_document_docx_set_custom_metadata_properties) | **POST** /convert/edit/docx/set-metadata/custom-property | Set custom property metadata properties in Word DOCX document
|
38
41
|
[**edit_document_docx_set_footer**](EditDocumentApi.md#edit_document_docx_set_footer) | **POST** /convert/edit/docx/set-footer | Set the footer in a Word DOCX document
|
39
42
|
[**edit_document_docx_set_footer_add_page_number**](EditDocumentApi.md#edit_document_docx_set_footer_add_page_number) | **POST** /convert/edit/docx/set-footer/add-page-number | Add page number to footer in a Word DOCX document
|
40
43
|
[**edit_document_docx_set_header**](EditDocumentApi.md#edit_document_docx_set_header) | **POST** /convert/edit/docx/set-header | Set the header in a Word DOCX document
|
@@ -42,6 +45,7 @@ Method | HTTP request | Description
|
|
42
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
|
43
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
|
44
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
|
45
49
|
[**edit_document_pptx_replace**](EditDocumentApi.md#edit_document_pptx_replace) | **POST** /convert/edit/pptx/replace-all | Replace string in PowerPoint PPTX presentation
|
46
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
|
47
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
|
@@ -55,6 +59,7 @@ Method | HTTP request | Description
|
|
55
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
|
56
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
|
57
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
|
58
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
|
59
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
|
60
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
|
@@ -821,6 +826,114 @@ Name | Type | Description | Notes
|
|
821
826
|
|
822
827
|
|
823
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
|
+
|
883
|
+
# **edit_document_docx_get_metadata_properties**
|
884
|
+
> GetDocxMetadataPropertiesResponse edit_document_docx_get_metadata_properties(input_file)
|
885
|
+
|
886
|
+
Get all metadata properties in Word DOCX document
|
887
|
+
|
888
|
+
Returns all the metadata properties in an Office Word Document (docx)
|
889
|
+
|
890
|
+
### Example
|
891
|
+
```ruby
|
892
|
+
# load the gem
|
893
|
+
require 'cloudmersive-convert-api-client'
|
894
|
+
# setup authorization
|
895
|
+
CloudmersiveConvertApiClient.configure do |config|
|
896
|
+
# Configure API key authorization: Apikey
|
897
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
898
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
899
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
900
|
+
end
|
901
|
+
|
902
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
903
|
+
|
904
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
905
|
+
|
906
|
+
|
907
|
+
begin
|
908
|
+
#Get all metadata properties in Word DOCX document
|
909
|
+
result = api_instance.edit_document_docx_get_metadata_properties(input_file)
|
910
|
+
p result
|
911
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
912
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_get_metadata_properties: #{e}"
|
913
|
+
end
|
914
|
+
```
|
915
|
+
|
916
|
+
### Parameters
|
917
|
+
|
918
|
+
Name | Type | Description | Notes
|
919
|
+
------------- | ------------- | ------------- | -------------
|
920
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
921
|
+
|
922
|
+
### Return type
|
923
|
+
|
924
|
+
[**GetDocxMetadataPropertiesResponse**](GetDocxMetadataPropertiesResponse.md)
|
925
|
+
|
926
|
+
### Authorization
|
927
|
+
|
928
|
+
[Apikey](../README.md#Apikey)
|
929
|
+
|
930
|
+
### HTTP request headers
|
931
|
+
|
932
|
+
- **Content-Type**: multipart/form-data
|
933
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
934
|
+
|
935
|
+
|
936
|
+
|
824
937
|
# **edit_document_docx_get_sections**
|
825
938
|
> GetDocxSectionsResponse edit_document_docx_get_sections(req_config)
|
826
939
|
|
@@ -1739,6 +1852,60 @@ Name | Type | Description | Notes
|
|
1739
1852
|
|
1740
1853
|
|
1741
1854
|
|
1855
|
+
# **edit_document_docx_set_custom_metadata_properties**
|
1856
|
+
> String edit_document_docx_set_custom_metadata_properties(input)
|
1857
|
+
|
1858
|
+
Set custom property metadata properties in Word DOCX document
|
1859
|
+
|
1860
|
+
Sets the custom property metadata for the metadata properties in an Office Word Document (docx)
|
1861
|
+
|
1862
|
+
### Example
|
1863
|
+
```ruby
|
1864
|
+
# load the gem
|
1865
|
+
require 'cloudmersive-convert-api-client'
|
1866
|
+
# setup authorization
|
1867
|
+
CloudmersiveConvertApiClient.configure do |config|
|
1868
|
+
# Configure API key authorization: Apikey
|
1869
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
1870
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1871
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
1872
|
+
end
|
1873
|
+
|
1874
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
1875
|
+
|
1876
|
+
input = CloudmersiveConvertApiClient::DocxSetCustomMetadataPropertiesRequest.new # DocxSetCustomMetadataPropertiesRequest |
|
1877
|
+
|
1878
|
+
|
1879
|
+
begin
|
1880
|
+
#Set custom property metadata properties in Word DOCX document
|
1881
|
+
result = api_instance.edit_document_docx_set_custom_metadata_properties(input)
|
1882
|
+
p result
|
1883
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
1884
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_set_custom_metadata_properties: #{e}"
|
1885
|
+
end
|
1886
|
+
```
|
1887
|
+
|
1888
|
+
### Parameters
|
1889
|
+
|
1890
|
+
Name | Type | Description | Notes
|
1891
|
+
------------- | ------------- | ------------- | -------------
|
1892
|
+
**input** | [**DocxSetCustomMetadataPropertiesRequest**](DocxSetCustomMetadataPropertiesRequest.md)| |
|
1893
|
+
|
1894
|
+
### Return type
|
1895
|
+
|
1896
|
+
**String**
|
1897
|
+
|
1898
|
+
### Authorization
|
1899
|
+
|
1900
|
+
[Apikey](../README.md#Apikey)
|
1901
|
+
|
1902
|
+
### HTTP request headers
|
1903
|
+
|
1904
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
1905
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
1906
|
+
|
1907
|
+
|
1908
|
+
|
1742
1909
|
# **edit_document_docx_set_footer**
|
1743
1910
|
> DocxSetFooterResponse edit_document_docx_set_footer(req_config)
|
1744
1911
|
|
@@ -2117,6 +2284,60 @@ Name | Type | Description | Notes
|
|
2117
2284
|
|
2118
2285
|
|
2119
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
|
+
|
2120
2341
|
# **edit_document_pptx_replace**
|
2121
2342
|
> String edit_document_pptx_replace(req_config)
|
2122
2343
|
|
@@ -2819,6 +3040,60 @@ Name | Type | Description | Notes
|
|
2819
3040
|
|
2820
3041
|
|
2821
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
|
+
|
2822
3097
|
# **edit_document_xlsx_get_rows_and_cells**
|
2823
3098
|
> GetXlsxRowsAndCellsResponse edit_document_xlsx_get_rows_and_cells(input)
|
2824
3099
|
|