cloudmersive-convert-api-client 1.2.3 → 1.2.8
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/LICENSE +201 -0
- data/build.ps1 +12 -0
- data/client/Gemfile +7 -0
- data/client/README.md +184 -0
- data/client/Rakefile +8 -0
- data/client/cloudmersive-convert-api-client.gemspec +45 -0
- data/client/docs/CompareDocumentApi.md +66 -0
- data/client/docs/ConvertDataApi.md +118 -0
- data/client/docs/ConvertDocumentApi.md +723 -0
- data/client/docs/ConvertImageApi.md +69 -0
- data/client/docs/ConvertTemplateApi.md +63 -0
- data/client/docs/ConvertWebApi.md +283 -0
- data/client/docs/ConvertedPngPage.md +9 -0
- data/client/docs/DocumentValidationError.md +11 -0
- data/client/docs/DocumentValidationResult.md +11 -0
- data/client/docs/DocxFooter.md +9 -0
- data/client/docs/DocxHeader.md +9 -0
- data/client/docs/DocxInsertImageRequest.md +13 -0
- data/client/docs/DocxInsertImageResponse.md +9 -0
- data/client/docs/DocxParagraph.md +10 -0
- data/client/docs/DocxRun.md +14 -0
- data/client/docs/DocxSection.md +8 -0
- data/client/docs/DocxSetFooterRequest.md +10 -0
- data/client/docs/DocxSetFooterResponse.md +9 -0
- data/client/docs/DocxSetHeaderRequest.md +10 -0
- data/client/docs/DocxSetHeaderResponse.md +9 -0
- data/client/docs/DocxStyle.md +13 -0
- data/client/docs/DocxTable.md +45 -0
- data/client/docs/DocxTableCell.md +14 -0
- data/client/docs/DocxTableRow.md +9 -0
- data/client/docs/DocxText.md +9 -0
- data/client/docs/EditDocumentApi.md +668 -0
- data/client/docs/FinishEditingRequest.md +8 -0
- data/client/docs/GetDocxHeadersAndFootersRequest.md +9 -0
- data/client/docs/GetDocxHeadersAndFootersResponse.md +10 -0
- data/client/docs/GetDocxStylesRequest.md +9 -0
- data/client/docs/GetDocxStylesResponse.md +9 -0
- data/client/docs/GetDocxTablesRequest.md +9 -0
- data/client/docs/GetDocxTablesResponse.md +9 -0
- data/client/docs/HtmlMdResult.md +9 -0
- data/client/docs/HtmlTemplateApplicationRequest.md +10 -0
- data/client/docs/HtmlTemplateApplicationResponse.md +9 -0
- data/client/docs/HtmlTemplateOperation.md +10 -0
- data/client/docs/HtmlToOfficeRequest.md +8 -0
- data/client/docs/HtmlToPdfRequest.md +9 -0
- data/client/docs/InsertDocxTablesRequest.md +10 -0
- data/client/docs/InsertDocxTablesResponse.md +9 -0
- data/client/docs/MergeDocumentApi.md +182 -0
- data/client/docs/PdfToPngResult.md +9 -0
- data/client/docs/RemoveDocxHeadersAndFootersRequest.md +11 -0
- data/client/docs/RemoveDocxHeadersAndFootersResponse.md +9 -0
- data/client/docs/ReplaceStringRequest.md +12 -0
- data/client/docs/ScreenshotRequest.md +9 -0
- data/client/docs/ValidateDocumentApi.md +173 -0
- data/client/docs/ViewerResponse.md +9 -0
- data/client/docs/ViewerToolsApi.md +63 -0
- data/client/git_push.sh +55 -0
- data/client/lib/cloudmersive-convert-api-client.rb +89 -0
- data/client/lib/cloudmersive-convert-api-client/api/compare_document_api.rb +86 -0
- data/client/lib/cloudmersive-convert-api-client/api/convert_data_api.rb +135 -0
- data/client/lib/cloudmersive-convert-api-client/api/convert_document_api.rb +751 -0
- data/client/lib/cloudmersive-convert-api-client/api/convert_image_api.rb +91 -0
- data/client/lib/cloudmersive-convert-api-client/api/convert_template_api.rb +78 -0
- data/client/lib/cloudmersive-convert-api-client/api/convert_web_api.rb +299 -0
- data/client/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +684 -0
- data/client/lib/cloudmersive-convert-api-client/api/merge_document_api.rb +212 -0
- data/client/lib/cloudmersive-convert-api-client/api/validate_document_api.rb +191 -0
- data/client/lib/cloudmersive-convert-api-client/api/viewer_tools_api.rb +79 -0
- data/client/lib/cloudmersive-convert-api-client/api_client.rb +389 -0
- data/client/lib/cloudmersive-convert-api-client/api_error.rb +38 -0
- data/client/lib/cloudmersive-convert-api-client/configuration.rb +209 -0
- data/client/lib/cloudmersive-convert-api-client/models/converted_png_page.rb +199 -0
- data/client/lib/cloudmersive-convert-api-client/models/document_validation_error.rb +219 -0
- data/client/lib/cloudmersive-convert-api-client/models/document_validation_result.rb +221 -0
- data/client/lib/cloudmersive-convert-api-client/models/docx_footer.rb +203 -0
- data/client/lib/cloudmersive-convert-api-client/models/docx_header.rb +203 -0
- data/client/lib/cloudmersive-convert-api-client/models/docx_insert_image_request.rb +271 -0
- data/client/lib/cloudmersive-convert-api-client/models/docx_insert_image_response.rb +199 -0
- data/client/lib/cloudmersive-convert-api-client/models/docx_paragraph.rb +211 -0
- data/client/lib/cloudmersive-convert-api-client/models/docx_run.rb +251 -0
- data/client/lib/cloudmersive-convert-api-client/models/docx_section.rb +191 -0
- data/client/lib/cloudmersive-convert-api-client/models/docx_set_footer_request.rb +225 -0
- data/client/lib/cloudmersive-convert-api-client/models/docx_set_footer_response.rb +199 -0
- data/client/lib/cloudmersive-convert-api-client/models/docx_set_header_request.rb +225 -0
- data/client/lib/cloudmersive-convert-api-client/models/docx_set_header_response.rb +199 -0
- data/client/lib/cloudmersive-convert-api-client/models/docx_style.rb +239 -0
- data/client/lib/cloudmersive-convert-api-client/models/docx_table.rb +561 -0
- data/client/lib/cloudmersive-convert-api-client/models/docx_table_cell.rb +251 -0
- data/client/lib/cloudmersive-convert-api-client/models/docx_table_row.rb +201 -0
- data/client/lib/cloudmersive-convert-api-client/models/docx_text.rb +199 -0
- data/client/lib/cloudmersive-convert-api-client/models/finish_editing_request.rb +189 -0
- data/client/lib/cloudmersive-convert-api-client/models/get_docx_headers_and_footers_request.rb +215 -0
- data/client/lib/cloudmersive-convert-api-client/models/get_docx_headers_and_footers_response.rb +211 -0
- data/client/lib/cloudmersive-convert-api-client/models/get_docx_styles_request.rb +215 -0
- data/client/lib/cloudmersive-convert-api-client/models/get_docx_styles_response.rb +201 -0
- data/client/lib/cloudmersive-convert-api-client/models/get_docx_tables_request.rb +215 -0
- data/client/lib/cloudmersive-convert-api-client/models/get_docx_tables_response.rb +201 -0
- data/client/lib/cloudmersive-convert-api-client/models/html_md_result.rb +199 -0
- data/client/lib/cloudmersive-convert-api-client/models/html_template_application_request.rb +208 -0
- data/client/lib/cloudmersive-convert-api-client/models/html_template_application_response.rb +197 -0
- data/client/lib/cloudmersive-convert-api-client/models/html_template_operation.rb +239 -0
- data/client/lib/cloudmersive-convert-api-client/models/html_to_office_request.rb +188 -0
- data/client/lib/cloudmersive-convert-api-client/models/html_to_pdf_request.rb +197 -0
- data/client/lib/cloudmersive-convert-api-client/models/insert_docx_tables_request.rb +225 -0
- data/client/lib/cloudmersive-convert-api-client/models/insert_docx_tables_response.rb +199 -0
- data/client/lib/cloudmersive-convert-api-client/models/pdf_to_png_result.rb +201 -0
- data/client/lib/cloudmersive-convert-api-client/models/remove_docx_headers_and_footers_request.rb +235 -0
- data/client/lib/cloudmersive-convert-api-client/models/remove_docx_headers_and_footers_response.rb +199 -0
- data/client/lib/cloudmersive-convert-api-client/models/replace_string_request.rb +245 -0
- data/client/lib/cloudmersive-convert-api-client/models/screenshot_request.rb +197 -0
- data/client/lib/cloudmersive-convert-api-client/models/viewer_response.rb +197 -0
- data/client/lib/cloudmersive-convert-api-client/version.rb +15 -0
- data/client/spec/api/compare_document_api_spec.rb +48 -0
- data/client/spec/api/convert_data_api_spec.rb +59 -0
- data/client/spec/api/convert_document_api_spec.rb +191 -0
- data/client/spec/api/convert_image_api_spec.rb +49 -0
- data/client/spec/api/convert_template_api_spec.rb +47 -0
- data/client/spec/api/convert_web_api_spec.rb +95 -0
- data/client/spec/api/edit_document_api_spec.rb +179 -0
- data/client/spec/api/merge_document_api_spec.rb +74 -0
- data/client/spec/api/validate_document_api_spec.rb +71 -0
- data/client/spec/api/viewer_tools_api_spec.rb +47 -0
- data/client/spec/api_client_spec.rb +226 -0
- data/client/spec/configuration_spec.rb +42 -0
- data/client/spec/models/converted_png_page_spec.rb +48 -0
- data/client/spec/models/document_validation_error_spec.rb +60 -0
- data/client/spec/models/document_validation_result_spec.rb +60 -0
- data/client/spec/models/docx_footer_spec.rb +48 -0
- data/client/spec/models/docx_header_spec.rb +48 -0
- data/client/spec/models/docx_insert_image_request_spec.rb +72 -0
- data/client/spec/models/docx_insert_image_response_spec.rb +48 -0
- data/client/spec/models/docx_paragraph_spec.rb +54 -0
- data/client/spec/models/docx_run_spec.rb +78 -0
- data/client/spec/models/docx_section_spec.rb +42 -0
- data/client/spec/models/docx_set_footer_request_spec.rb +54 -0
- data/client/spec/models/docx_set_footer_response_spec.rb +48 -0
- data/client/spec/models/docx_set_header_request_spec.rb +54 -0
- data/client/spec/models/docx_set_header_response_spec.rb +48 -0
- data/client/spec/models/docx_style_spec.rb +72 -0
- data/client/spec/models/docx_table_cell_spec.rb +78 -0
- data/client/spec/models/docx_table_row_spec.rb +48 -0
- data/client/spec/models/docx_table_spec.rb +264 -0
- data/client/spec/models/docx_text_spec.rb +48 -0
- data/client/spec/models/finish_editing_request_spec.rb +42 -0
- data/client/spec/models/get_docx_headers_and_footers_request_spec.rb +48 -0
- data/client/spec/models/get_docx_headers_and_footers_response_spec.rb +54 -0
- data/client/spec/models/get_docx_styles_request_spec.rb +48 -0
- data/client/spec/models/get_docx_styles_response_spec.rb +48 -0
- data/client/spec/models/get_docx_tables_request_spec.rb +48 -0
- data/client/spec/models/get_docx_tables_response_spec.rb +48 -0
- data/client/spec/models/html_md_result_spec.rb +48 -0
- data/client/spec/models/html_template_application_request_spec.rb +54 -0
- data/client/spec/models/html_template_application_response_spec.rb +48 -0
- data/client/spec/models/html_template_operation_spec.rb +58 -0
- data/client/spec/models/html_to_office_request_spec.rb +42 -0
- data/client/spec/models/html_to_pdf_request_spec.rb +48 -0
- data/client/spec/models/insert_docx_tables_request_spec.rb +54 -0
- data/client/spec/models/insert_docx_tables_response_spec.rb +48 -0
- data/client/spec/models/pdf_to_png_result_spec.rb +48 -0
- data/client/spec/models/remove_docx_headers_and_footers_request_spec.rb +60 -0
- data/client/spec/models/remove_docx_headers_and_footers_response_spec.rb +48 -0
- data/client/spec/models/replace_string_request_spec.rb +66 -0
- data/client/spec/models/screenshot_request_spec.rb +48 -0
- data/client/spec/models/viewer_response_spec.rb +48 -0
- data/client/spec/spec_helper.rb +111 -0
- data/cloudmersiveConvertApiClient-1.2.6.gem +0 -0
- data/cloudmersiveConvertApiClient-1.2.7.gem +0 -0
- data/packageconfig.json +11 -0
- data/swagger-codegen-cli.jar +0 -0
- metadata +173 -3
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxFooter
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**paragraphs** | [**Array<DocxParagraph>**](DocxParagraph.md) | Paragraphs in this footer | [optional]
|
7
|
+
**sections_with_footer** | [**Array<DocxSection>**](DocxSection.md) | Sections that the footer is applied to | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxHeader
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**paragraphs** | [**Array<DocxParagraph>**](DocxParagraph.md) | Paragraphs in this header | [optional]
|
7
|
+
**sections_with_header** | [**Array<DocxSection>**](DocxSection.md) | Sections that the header is applied to | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxInsertImageRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**input_document_file_bytes** | **String** | Optional: Bytes of the input file to operate on | [optional]
|
7
|
+
**input_document_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
|
+
**input_image_file_bytes** | **String** | Optional: Bytes of the input image file to operate on | [optional]
|
9
|
+
**input_image_file_url** | **String** | Optional: URL of an image 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]
|
10
|
+
**image_width** | **Integer** | Width in points of the image, set to 0 for default | [optional]
|
11
|
+
**image_height** | **Integer** | Height in point of the image, set to 0 for default | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxInsertImageResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
|
7
|
+
**edited_document_url** | **String** | URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxParagraph
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**paragraph_index** | **Integer** | The index of the paragraph; 0-based | [optional]
|
7
|
+
**content_runs** | [**Array<DocxRun>**](DocxRun.md) | The content runs in the paragraph - this is where text is stored; similar to a span in HTML | [optional]
|
8
|
+
**style_id** | **String** | Style ID of the style applied to the paragraph; null if no style is applied | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxRun
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**run_index** | **Integer** | Index of the run, 0-based | [optional]
|
7
|
+
**text_items** | [**Array<DocxText>**](DocxText.md) | Text items inside the run; this is where the actual text content is stored | [optional]
|
8
|
+
**bold** | **BOOLEAN** | True to make the text bold, false otherwise | [optional]
|
9
|
+
**italic** | **BOOLEAN** | True to make the text italic, false otherwise | [optional]
|
10
|
+
**underline** | **String** | Underline mode for the text; possible values are: Words, Double, Thick, Dotted, DottedHeavy, Dash, DashedHeavy, DashLong, DashLongHeavy, DotDash, DashDotHeavy, DotDotDash, DashDotDotHeavy, Wave, WavyHeavy, WavyDouble, None | [optional]
|
11
|
+
**font_family** | **String** | Font Family name for the text, e.g. \"Arial\" or \"Times New Roman\" | [optional]
|
12
|
+
**font_size** | **String** | Font size in font points (e.g. \"24\") | [optional]
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxSection
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**starting_page_numbers** | **Array<Integer>** | Page numbers that the section starts at, typically just one | [optional]
|
7
|
+
|
8
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxSetFooterRequest
|
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
|
+
**footer_to_apply** | [**DocxFooter**](DocxFooter.md) | Footer to apply | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxSetFooterResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
|
7
|
+
**edited_document_url** | **String** | URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxSetHeaderRequest
|
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
|
+
**header_to_apply** | [**DocxHeader**](DocxHeader.md) | Header to apply | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxSetHeaderResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
|
7
|
+
**edited_document_url** | **String** | URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxStyle
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**style_id** | **String** | ID of the style | [optional]
|
7
|
+
**bold** | **BOOLEAN** | Style applies bold formatting | [optional]
|
8
|
+
**italic** | **BOOLEAN** | Style applies italic formatting | [optional]
|
9
|
+
**underline** | **BOOLEAN** | Style applies underline formatting | [optional]
|
10
|
+
**font_size** | **String** | Font size | [optional]
|
11
|
+
**font_family** | **String** | Font family | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,45 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxTable
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**table_id** | **String** | The ID of the table | [optional]
|
7
|
+
**width** | **String** | The Width of the table, or 0 if not specified | [optional]
|
8
|
+
**width_type** | **String** | The Width configuration type of the table | [optional]
|
9
|
+
**table_rows** | [**Array<DocxTableRow>**](DocxTableRow.md) | Rows in the table; this is where the contents is located | [optional]
|
10
|
+
**top_border_type** | **String** | Type for the top border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave | [optional]
|
11
|
+
**top_border_size** | **Integer** | Width of the border in points (1/72nd of an inch) | [optional]
|
12
|
+
**top_border_space** | **Integer** | Spacing around the border in points (1/72nd of an inch) | [optional]
|
13
|
+
**top_border_color** | **String** | HTML-style color hex value (do not include a #) | [optional]
|
14
|
+
**bottom_border_type** | **String** | Type for the bottom border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave | [optional]
|
15
|
+
**bottom_border_size** | **Integer** | Width of the border in points (1/72nd of an inch) | [optional]
|
16
|
+
**bottom_border_space** | **Integer** | Spacing around the border in points (1/72nd of an inch) | [optional]
|
17
|
+
**bottom_border_color** | **String** | HTML-style color hex value (do not include a #) | [optional]
|
18
|
+
**left_border_type** | **String** | Type for the left border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave | [optional]
|
19
|
+
**left_border_size** | **Integer** | Width of the border in points (1/72nd of an inch) | [optional]
|
20
|
+
**left_border_space** | **Integer** | Spacing around the border in points (1/72nd of an inch) | [optional]
|
21
|
+
**left_border_color** | **String** | HTML-style color hex value (do not include a #) | [optional]
|
22
|
+
**right_border_type** | **String** | Type for the right border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave | [optional]
|
23
|
+
**right_border_size** | **Integer** | Width of the border in points (1/72nd of an inch) | [optional]
|
24
|
+
**right_border_space** | **Integer** | Spacing around the border in points (1/72nd of an inch) | [optional]
|
25
|
+
**right_border_color** | **String** | HTML-style color hex value (do not include a #) | [optional]
|
26
|
+
**cell_horizontal_border_type** | **String** | Type for the cell horizontal border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave | [optional]
|
27
|
+
**cell_horizontal_border_size** | **Integer** | Width of the border in points (1/72nd of an inch) | [optional]
|
28
|
+
**cell_horizontal_border_space** | **Integer** | Spacing around the border in points (1/72nd of an inch) | [optional]
|
29
|
+
**cell_horizontal_border_color** | **String** | HTML-style color hex value (do not include a #) | [optional]
|
30
|
+
**cell_vertical_border_type** | **String** | Type for the cell vertical border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave | [optional]
|
31
|
+
**cell_vertical_border_size** | **Integer** | Width of the border in points (1/72nd of an inch) | [optional]
|
32
|
+
**cell_vertical_border_space** | **Integer** | Spacing around the border in points (1/72nd of an inch) | [optional]
|
33
|
+
**cell_vertical_border_color** | **String** | HTML-style color hex value (do not include a #) | [optional]
|
34
|
+
**start_border_type** | **String** | Type for the start border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave | [optional]
|
35
|
+
**start_border_size** | **Integer** | Width of the border in points (1/72nd of an inch) | [optional]
|
36
|
+
**start_border_space** | **Integer** | Spacing around the border in points (1/72nd of an inch) | [optional]
|
37
|
+
**start_border_color** | **String** | HTML-style color hex value (do not include a #) | [optional]
|
38
|
+
**end_border_type** | **String** | Type for the end border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave | [optional]
|
39
|
+
**end_border_size** | **Integer** | Width of the border in points (1/72nd of an inch) | [optional]
|
40
|
+
**end_border_space** | **Integer** | Spacing around the border in points (1/72nd of an inch) | [optional]
|
41
|
+
**end_border_color** | **String** | HTML-style color hex value (do not include a #) | [optional]
|
42
|
+
**table_indentation_mode** | **String** | Table indentation type | [optional]
|
43
|
+
**table_indentation_width** | **Integer** | Table indentation width | [optional]
|
44
|
+
|
45
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxTableCell
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**cell_index** | **Integer** | The index of the cell, 0-based | [optional]
|
7
|
+
**paragraphs** | [**Array<DocxParagraph>**](DocxParagraph.md) | Paragraphs inside the cell; this is where the contents of the cell are stored | [optional]
|
8
|
+
**cell_shading_color** | **String** | Color of the cell shading | [optional]
|
9
|
+
**cell_shading_fill** | **String** | Fill of the cell shading | [optional]
|
10
|
+
**cell_shading_pattern** | **String** | Pattern of the cell shading | [optional]
|
11
|
+
**cell_width_mode** | **String** | Width mode of the cell; can be auto (for automatic) or manual | [optional]
|
12
|
+
**cell_width** | **String** | Width of the cell | [optional]
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxTableRow
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**row_index** | **Integer** | Index of the row, 0-based | [optional]
|
7
|
+
**row_cells** | [**Array<DocxTableCell>**](DocxTableCell.md) | Cells in the row; this is where the contents of the row is stored | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxText
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**text_index** | **Integer** | Index of the text content in the run; 0-based | [optional]
|
7
|
+
**text_content** | **String** | Text string containing the text content of this text content item | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,668 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::EditDocumentApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.cloudmersive.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**edit_document_begin_editing**](EditDocumentApi.md#edit_document_begin_editing) | **POST** /convert/edit/begin-editing | Begin editing a document
|
8
|
+
[**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 DOCX
|
9
|
+
[**edit_document_docx_get_styles**](EditDocumentApi.md#edit_document_docx_get_styles) | **POST** /convert/edit/docx/get-styles | Get styles from a DOCX
|
10
|
+
[**edit_document_docx_get_tables**](EditDocumentApi.md#edit_document_docx_get_tables) | **POST** /convert/edit/docx/get-tables | Get tables in DOCX
|
11
|
+
[**edit_document_docx_insert_image**](EditDocumentApi.md#edit_document_docx_insert_image) | **POST** /convert/edit/docx/insert-image | Insert image into a DOCX
|
12
|
+
[**edit_document_docx_insert_table**](EditDocumentApi.md#edit_document_docx_insert_table) | **POST** /convert/edit/docx/insert-table | Insert a new table into a DOCX
|
13
|
+
[**edit_document_docx_remove_headers_and_footers**](EditDocumentApi.md#edit_document_docx_remove_headers_and_footers) | **POST** /convert/edit/docx/remove-headers-and-footers | Remove headers and footers from DOCX
|
14
|
+
[**edit_document_docx_replace**](EditDocumentApi.md#edit_document_docx_replace) | **POST** /convert/edit/docx/replace-all | Replace string in DOCX
|
15
|
+
[**edit_document_docx_set_footer**](EditDocumentApi.md#edit_document_docx_set_footer) | **POST** /convert/edit/docx/set-footer | Set the footer in a DOCX
|
16
|
+
[**edit_document_docx_set_header**](EditDocumentApi.md#edit_document_docx_set_header) | **POST** /convert/edit/docx/set-header | Set the header in a DOCX
|
17
|
+
[**edit_document_finish_editing**](EditDocumentApi.md#edit_document_finish_editing) | **POST** /convert/edit/finish-editing | Download result from document editing
|
18
|
+
[**edit_document_pptx_replace**](EditDocumentApi.md#edit_document_pptx_replace) | **POST** /convert/edit/pptx/replace-all | Replace string in PPTX
|
19
|
+
|
20
|
+
|
21
|
+
# **edit_document_begin_editing**
|
22
|
+
> String edit_document_begin_editing(input_file)
|
23
|
+
|
24
|
+
Begin editing a document
|
25
|
+
|
26
|
+
Uploads a document to Cloudmersive to begin a series of one or more editing operations
|
27
|
+
|
28
|
+
### Example
|
29
|
+
```ruby
|
30
|
+
# load the gem
|
31
|
+
require 'cloudmersive-convert-api-client'
|
32
|
+
# setup authorization
|
33
|
+
CloudmersiveConvertApiClient.configure do |config|
|
34
|
+
# Configure API key authorization: Apikey
|
35
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
36
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
37
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
38
|
+
end
|
39
|
+
|
40
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
41
|
+
|
42
|
+
input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
|
43
|
+
|
44
|
+
|
45
|
+
begin
|
46
|
+
#Begin editing a document
|
47
|
+
result = api_instance.edit_document_begin_editing(input_file)
|
48
|
+
p result
|
49
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
50
|
+
puts "Exception when calling EditDocumentApi->edit_document_begin_editing: #{e}"
|
51
|
+
end
|
52
|
+
```
|
53
|
+
|
54
|
+
### Parameters
|
55
|
+
|
56
|
+
Name | Type | Description | Notes
|
57
|
+
------------- | ------------- | ------------- | -------------
|
58
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
59
|
+
|
60
|
+
### Return type
|
61
|
+
|
62
|
+
**String**
|
63
|
+
|
64
|
+
### Authorization
|
65
|
+
|
66
|
+
[Apikey](../README.md#Apikey)
|
67
|
+
|
68
|
+
### HTTP request headers
|
69
|
+
|
70
|
+
- **Content-Type**: multipart/form-data
|
71
|
+
- **Accept**: application/octet-stream
|
72
|
+
|
73
|
+
|
74
|
+
|
75
|
+
# **edit_document_docx_get_headers_and_footers**
|
76
|
+
> GetDocxHeadersAndFootersResponse edit_document_docx_get_headers_and_footers(req_config)
|
77
|
+
|
78
|
+
Get content of a footer from a DOCX
|
79
|
+
|
80
|
+
Returns the footer content from a Word Document (DOCX) format file
|
81
|
+
|
82
|
+
### Example
|
83
|
+
```ruby
|
84
|
+
# load the gem
|
85
|
+
require 'cloudmersive-convert-api-client'
|
86
|
+
# setup authorization
|
87
|
+
CloudmersiveConvertApiClient.configure do |config|
|
88
|
+
# Configure API key authorization: Apikey
|
89
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
90
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
91
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
92
|
+
end
|
93
|
+
|
94
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
95
|
+
|
96
|
+
req_config = CloudmersiveConvertApiClient::GetDocxHeadersAndFootersRequest.new # GetDocxHeadersAndFootersRequest |
|
97
|
+
|
98
|
+
|
99
|
+
begin
|
100
|
+
#Get content of a footer from a DOCX
|
101
|
+
result = api_instance.edit_document_docx_get_headers_and_footers(req_config)
|
102
|
+
p result
|
103
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
104
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_get_headers_and_footers: #{e}"
|
105
|
+
end
|
106
|
+
```
|
107
|
+
|
108
|
+
### Parameters
|
109
|
+
|
110
|
+
Name | Type | Description | Notes
|
111
|
+
------------- | ------------- | ------------- | -------------
|
112
|
+
**req_config** | [**GetDocxHeadersAndFootersRequest**](GetDocxHeadersAndFootersRequest.md)| |
|
113
|
+
|
114
|
+
### Return type
|
115
|
+
|
116
|
+
[**GetDocxHeadersAndFootersResponse**](GetDocxHeadersAndFootersResponse.md)
|
117
|
+
|
118
|
+
### Authorization
|
119
|
+
|
120
|
+
[Apikey](../README.md#Apikey)
|
121
|
+
|
122
|
+
### HTTP request headers
|
123
|
+
|
124
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
125
|
+
- **Accept**: application/octet-stream
|
126
|
+
|
127
|
+
|
128
|
+
|
129
|
+
# **edit_document_docx_get_styles**
|
130
|
+
> GetDocxStylesResponse edit_document_docx_get_styles(req_config)
|
131
|
+
|
132
|
+
Get styles from a DOCX
|
133
|
+
|
134
|
+
Returns the styles defined in the Word Document (DOCX) format file
|
135
|
+
|
136
|
+
### Example
|
137
|
+
```ruby
|
138
|
+
# load the gem
|
139
|
+
require 'cloudmersive-convert-api-client'
|
140
|
+
# setup authorization
|
141
|
+
CloudmersiveConvertApiClient.configure do |config|
|
142
|
+
# Configure API key authorization: Apikey
|
143
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
144
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
145
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
146
|
+
end
|
147
|
+
|
148
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
149
|
+
|
150
|
+
req_config = CloudmersiveConvertApiClient::GetDocxStylesRequest.new # GetDocxStylesRequest |
|
151
|
+
|
152
|
+
|
153
|
+
begin
|
154
|
+
#Get styles from a DOCX
|
155
|
+
result = api_instance.edit_document_docx_get_styles(req_config)
|
156
|
+
p result
|
157
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
158
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_get_styles: #{e}"
|
159
|
+
end
|
160
|
+
```
|
161
|
+
|
162
|
+
### Parameters
|
163
|
+
|
164
|
+
Name | Type | Description | Notes
|
165
|
+
------------- | ------------- | ------------- | -------------
|
166
|
+
**req_config** | [**GetDocxStylesRequest**](GetDocxStylesRequest.md)| |
|
167
|
+
|
168
|
+
### Return type
|
169
|
+
|
170
|
+
[**GetDocxStylesResponse**](GetDocxStylesResponse.md)
|
171
|
+
|
172
|
+
### Authorization
|
173
|
+
|
174
|
+
[Apikey](../README.md#Apikey)
|
175
|
+
|
176
|
+
### HTTP request headers
|
177
|
+
|
178
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
179
|
+
- **Accept**: application/octet-stream
|
180
|
+
|
181
|
+
|
182
|
+
|
183
|
+
# **edit_document_docx_get_tables**
|
184
|
+
> GetDocxTablesResponse edit_document_docx_get_tables(req_config)
|
185
|
+
|
186
|
+
Get tables in DOCX
|
187
|
+
|
188
|
+
Returns all the table objects in an Office Word Document (docx)
|
189
|
+
|
190
|
+
### Example
|
191
|
+
```ruby
|
192
|
+
# load the gem
|
193
|
+
require 'cloudmersive-convert-api-client'
|
194
|
+
# setup authorization
|
195
|
+
CloudmersiveConvertApiClient.configure do |config|
|
196
|
+
# Configure API key authorization: Apikey
|
197
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
198
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
199
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
200
|
+
end
|
201
|
+
|
202
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
203
|
+
|
204
|
+
req_config = CloudmersiveConvertApiClient::GetDocxTablesRequest.new # GetDocxTablesRequest |
|
205
|
+
|
206
|
+
|
207
|
+
begin
|
208
|
+
#Get tables in DOCX
|
209
|
+
result = api_instance.edit_document_docx_get_tables(req_config)
|
210
|
+
p result
|
211
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
212
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_get_tables: #{e}"
|
213
|
+
end
|
214
|
+
```
|
215
|
+
|
216
|
+
### Parameters
|
217
|
+
|
218
|
+
Name | Type | Description | Notes
|
219
|
+
------------- | ------------- | ------------- | -------------
|
220
|
+
**req_config** | [**GetDocxTablesRequest**](GetDocxTablesRequest.md)| |
|
221
|
+
|
222
|
+
### Return type
|
223
|
+
|
224
|
+
[**GetDocxTablesResponse**](GetDocxTablesResponse.md)
|
225
|
+
|
226
|
+
### Authorization
|
227
|
+
|
228
|
+
[Apikey](../README.md#Apikey)
|
229
|
+
|
230
|
+
### HTTP request headers
|
231
|
+
|
232
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
233
|
+
- **Accept**: application/octet-stream
|
234
|
+
|
235
|
+
|
236
|
+
|
237
|
+
# **edit_document_docx_insert_image**
|
238
|
+
> DocxInsertImageResponse edit_document_docx_insert_image(req_config)
|
239
|
+
|
240
|
+
Insert image into a DOCX
|
241
|
+
|
242
|
+
Set the footer in a Word Document (DOCX)
|
243
|
+
|
244
|
+
### Example
|
245
|
+
```ruby
|
246
|
+
# load the gem
|
247
|
+
require 'cloudmersive-convert-api-client'
|
248
|
+
# setup authorization
|
249
|
+
CloudmersiveConvertApiClient.configure do |config|
|
250
|
+
# Configure API key authorization: Apikey
|
251
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
252
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
253
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
254
|
+
end
|
255
|
+
|
256
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
257
|
+
|
258
|
+
req_config = CloudmersiveConvertApiClient::DocxInsertImageRequest.new # DocxInsertImageRequest |
|
259
|
+
|
260
|
+
|
261
|
+
begin
|
262
|
+
#Insert image into a DOCX
|
263
|
+
result = api_instance.edit_document_docx_insert_image(req_config)
|
264
|
+
p result
|
265
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
266
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_insert_image: #{e}"
|
267
|
+
end
|
268
|
+
```
|
269
|
+
|
270
|
+
### Parameters
|
271
|
+
|
272
|
+
Name | Type | Description | Notes
|
273
|
+
------------- | ------------- | ------------- | -------------
|
274
|
+
**req_config** | [**DocxInsertImageRequest**](DocxInsertImageRequest.md)| |
|
275
|
+
|
276
|
+
### Return type
|
277
|
+
|
278
|
+
[**DocxInsertImageResponse**](DocxInsertImageResponse.md)
|
279
|
+
|
280
|
+
### Authorization
|
281
|
+
|
282
|
+
[Apikey](../README.md#Apikey)
|
283
|
+
|
284
|
+
### HTTP request headers
|
285
|
+
|
286
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
287
|
+
- **Accept**: application/octet-stream
|
288
|
+
|
289
|
+
|
290
|
+
|
291
|
+
# **edit_document_docx_insert_table**
|
292
|
+
> InsertDocxTablesResponse edit_document_docx_insert_table(req_config)
|
293
|
+
|
294
|
+
Insert a new table into a DOCX
|
295
|
+
|
296
|
+
Adds a new table into a DOCX and returns the result
|
297
|
+
|
298
|
+
### Example
|
299
|
+
```ruby
|
300
|
+
# load the gem
|
301
|
+
require 'cloudmersive-convert-api-client'
|
302
|
+
# setup authorization
|
303
|
+
CloudmersiveConvertApiClient.configure do |config|
|
304
|
+
# Configure API key authorization: Apikey
|
305
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
306
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
307
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
308
|
+
end
|
309
|
+
|
310
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
311
|
+
|
312
|
+
req_config = CloudmersiveConvertApiClient::InsertDocxTablesRequest.new # InsertDocxTablesRequest |
|
313
|
+
|
314
|
+
|
315
|
+
begin
|
316
|
+
#Insert a new table into a DOCX
|
317
|
+
result = api_instance.edit_document_docx_insert_table(req_config)
|
318
|
+
p result
|
319
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
320
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_insert_table: #{e}"
|
321
|
+
end
|
322
|
+
```
|
323
|
+
|
324
|
+
### Parameters
|
325
|
+
|
326
|
+
Name | Type | Description | Notes
|
327
|
+
------------- | ------------- | ------------- | -------------
|
328
|
+
**req_config** | [**InsertDocxTablesRequest**](InsertDocxTablesRequest.md)| |
|
329
|
+
|
330
|
+
### Return type
|
331
|
+
|
332
|
+
[**InsertDocxTablesResponse**](InsertDocxTablesResponse.md)
|
333
|
+
|
334
|
+
### Authorization
|
335
|
+
|
336
|
+
[Apikey](../README.md#Apikey)
|
337
|
+
|
338
|
+
### HTTP request headers
|
339
|
+
|
340
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
341
|
+
- **Accept**: application/octet-stream
|
342
|
+
|
343
|
+
|
344
|
+
|
345
|
+
# **edit_document_docx_remove_headers_and_footers**
|
346
|
+
> RemoveDocxHeadersAndFootersResponse edit_document_docx_remove_headers_and_footers(req_config)
|
347
|
+
|
348
|
+
Remove headers and footers from DOCX
|
349
|
+
|
350
|
+
Remove all headers, or footers, or both from a Word Document (DOCX)
|
351
|
+
|
352
|
+
### Example
|
353
|
+
```ruby
|
354
|
+
# load the gem
|
355
|
+
require 'cloudmersive-convert-api-client'
|
356
|
+
# setup authorization
|
357
|
+
CloudmersiveConvertApiClient.configure do |config|
|
358
|
+
# Configure API key authorization: Apikey
|
359
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
360
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
361
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
362
|
+
end
|
363
|
+
|
364
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
365
|
+
|
366
|
+
req_config = CloudmersiveConvertApiClient::RemoveDocxHeadersAndFootersRequest.new # RemoveDocxHeadersAndFootersRequest |
|
367
|
+
|
368
|
+
|
369
|
+
begin
|
370
|
+
#Remove headers and footers from DOCX
|
371
|
+
result = api_instance.edit_document_docx_remove_headers_and_footers(req_config)
|
372
|
+
p result
|
373
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
374
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_remove_headers_and_footers: #{e}"
|
375
|
+
end
|
376
|
+
```
|
377
|
+
|
378
|
+
### Parameters
|
379
|
+
|
380
|
+
Name | Type | Description | Notes
|
381
|
+
------------- | ------------- | ------------- | -------------
|
382
|
+
**req_config** | [**RemoveDocxHeadersAndFootersRequest**](RemoveDocxHeadersAndFootersRequest.md)| |
|
383
|
+
|
384
|
+
### Return type
|
385
|
+
|
386
|
+
[**RemoveDocxHeadersAndFootersResponse**](RemoveDocxHeadersAndFootersResponse.md)
|
387
|
+
|
388
|
+
### Authorization
|
389
|
+
|
390
|
+
[Apikey](../README.md#Apikey)
|
391
|
+
|
392
|
+
### HTTP request headers
|
393
|
+
|
394
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
395
|
+
- **Accept**: application/octet-stream
|
396
|
+
|
397
|
+
|
398
|
+
|
399
|
+
# **edit_document_docx_replace**
|
400
|
+
> String edit_document_docx_replace(req_config)
|
401
|
+
|
402
|
+
Replace string in DOCX
|
403
|
+
|
404
|
+
Replace all instances of a string in an Office Word Document (docx)
|
405
|
+
|
406
|
+
### Example
|
407
|
+
```ruby
|
408
|
+
# load the gem
|
409
|
+
require 'cloudmersive-convert-api-client'
|
410
|
+
# setup authorization
|
411
|
+
CloudmersiveConvertApiClient.configure do |config|
|
412
|
+
# Configure API key authorization: Apikey
|
413
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
414
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
415
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
416
|
+
end
|
417
|
+
|
418
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
419
|
+
|
420
|
+
req_config = CloudmersiveConvertApiClient::ReplaceStringRequest.new # ReplaceStringRequest |
|
421
|
+
|
422
|
+
|
423
|
+
begin
|
424
|
+
#Replace string in DOCX
|
425
|
+
result = api_instance.edit_document_docx_replace(req_config)
|
426
|
+
p result
|
427
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
428
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_replace: #{e}"
|
429
|
+
end
|
430
|
+
```
|
431
|
+
|
432
|
+
### Parameters
|
433
|
+
|
434
|
+
Name | Type | Description | Notes
|
435
|
+
------------- | ------------- | ------------- | -------------
|
436
|
+
**req_config** | [**ReplaceStringRequest**](ReplaceStringRequest.md)| |
|
437
|
+
|
438
|
+
### Return type
|
439
|
+
|
440
|
+
**String**
|
441
|
+
|
442
|
+
### Authorization
|
443
|
+
|
444
|
+
[Apikey](../README.md#Apikey)
|
445
|
+
|
446
|
+
### HTTP request headers
|
447
|
+
|
448
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
449
|
+
- **Accept**: application/octet-stream
|
450
|
+
|
451
|
+
|
452
|
+
|
453
|
+
# **edit_document_docx_set_footer**
|
454
|
+
> DocxSetFooterResponse edit_document_docx_set_footer(req_config)
|
455
|
+
|
456
|
+
Set the footer in a DOCX
|
457
|
+
|
458
|
+
Set the footer in a Word Document (DOCX)
|
459
|
+
|
460
|
+
### Example
|
461
|
+
```ruby
|
462
|
+
# load the gem
|
463
|
+
require 'cloudmersive-convert-api-client'
|
464
|
+
# setup authorization
|
465
|
+
CloudmersiveConvertApiClient.configure do |config|
|
466
|
+
# Configure API key authorization: Apikey
|
467
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
468
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
469
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
470
|
+
end
|
471
|
+
|
472
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
473
|
+
|
474
|
+
req_config = CloudmersiveConvertApiClient::DocxSetFooterRequest.new # DocxSetFooterRequest |
|
475
|
+
|
476
|
+
|
477
|
+
begin
|
478
|
+
#Set the footer in a DOCX
|
479
|
+
result = api_instance.edit_document_docx_set_footer(req_config)
|
480
|
+
p result
|
481
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
482
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_set_footer: #{e}"
|
483
|
+
end
|
484
|
+
```
|
485
|
+
|
486
|
+
### Parameters
|
487
|
+
|
488
|
+
Name | Type | Description | Notes
|
489
|
+
------------- | ------------- | ------------- | -------------
|
490
|
+
**req_config** | [**DocxSetFooterRequest**](DocxSetFooterRequest.md)| |
|
491
|
+
|
492
|
+
### Return type
|
493
|
+
|
494
|
+
[**DocxSetFooterResponse**](DocxSetFooterResponse.md)
|
495
|
+
|
496
|
+
### Authorization
|
497
|
+
|
498
|
+
[Apikey](../README.md#Apikey)
|
499
|
+
|
500
|
+
### HTTP request headers
|
501
|
+
|
502
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
503
|
+
- **Accept**: application/octet-stream
|
504
|
+
|
505
|
+
|
506
|
+
|
507
|
+
# **edit_document_docx_set_header**
|
508
|
+
> DocxSetHeaderResponse edit_document_docx_set_header(req_config)
|
509
|
+
|
510
|
+
Set the header in a DOCX
|
511
|
+
|
512
|
+
Set the header in a Word Document (DOCX)
|
513
|
+
|
514
|
+
### Example
|
515
|
+
```ruby
|
516
|
+
# load the gem
|
517
|
+
require 'cloudmersive-convert-api-client'
|
518
|
+
# setup authorization
|
519
|
+
CloudmersiveConvertApiClient.configure do |config|
|
520
|
+
# Configure API key authorization: Apikey
|
521
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
522
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
523
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
524
|
+
end
|
525
|
+
|
526
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
527
|
+
|
528
|
+
req_config = CloudmersiveConvertApiClient::DocxSetHeaderRequest.new # DocxSetHeaderRequest |
|
529
|
+
|
530
|
+
|
531
|
+
begin
|
532
|
+
#Set the header in a DOCX
|
533
|
+
result = api_instance.edit_document_docx_set_header(req_config)
|
534
|
+
p result
|
535
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
536
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_set_header: #{e}"
|
537
|
+
end
|
538
|
+
```
|
539
|
+
|
540
|
+
### Parameters
|
541
|
+
|
542
|
+
Name | Type | Description | Notes
|
543
|
+
------------- | ------------- | ------------- | -------------
|
544
|
+
**req_config** | [**DocxSetHeaderRequest**](DocxSetHeaderRequest.md)| |
|
545
|
+
|
546
|
+
### Return type
|
547
|
+
|
548
|
+
[**DocxSetHeaderResponse**](DocxSetHeaderResponse.md)
|
549
|
+
|
550
|
+
### Authorization
|
551
|
+
|
552
|
+
[Apikey](../README.md#Apikey)
|
553
|
+
|
554
|
+
### HTTP request headers
|
555
|
+
|
556
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
557
|
+
- **Accept**: application/octet-stream
|
558
|
+
|
559
|
+
|
560
|
+
|
561
|
+
# **edit_document_finish_editing**
|
562
|
+
> String edit_document_finish_editing(req_config)
|
563
|
+
|
564
|
+
Download result from document editing
|
565
|
+
|
566
|
+
Once done editing a document, download the result. Begin editing a document by calling begin-editing, then perform operations, then call finish-editing to get the result.
|
567
|
+
|
568
|
+
### Example
|
569
|
+
```ruby
|
570
|
+
# load the gem
|
571
|
+
require 'cloudmersive-convert-api-client'
|
572
|
+
# setup authorization
|
573
|
+
CloudmersiveConvertApiClient.configure do |config|
|
574
|
+
# Configure API key authorization: Apikey
|
575
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
576
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
577
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
578
|
+
end
|
579
|
+
|
580
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
581
|
+
|
582
|
+
req_config = CloudmersiveConvertApiClient::FinishEditingRequest.new # FinishEditingRequest |
|
583
|
+
|
584
|
+
|
585
|
+
begin
|
586
|
+
#Download result from document editing
|
587
|
+
result = api_instance.edit_document_finish_editing(req_config)
|
588
|
+
p result
|
589
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
590
|
+
puts "Exception when calling EditDocumentApi->edit_document_finish_editing: #{e}"
|
591
|
+
end
|
592
|
+
```
|
593
|
+
|
594
|
+
### Parameters
|
595
|
+
|
596
|
+
Name | Type | Description | Notes
|
597
|
+
------------- | ------------- | ------------- | -------------
|
598
|
+
**req_config** | [**FinishEditingRequest**](FinishEditingRequest.md)| |
|
599
|
+
|
600
|
+
### Return type
|
601
|
+
|
602
|
+
**String**
|
603
|
+
|
604
|
+
### Authorization
|
605
|
+
|
606
|
+
[Apikey](../README.md#Apikey)
|
607
|
+
|
608
|
+
### HTTP request headers
|
609
|
+
|
610
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
611
|
+
- **Accept**: application/octet-stream
|
612
|
+
|
613
|
+
|
614
|
+
|
615
|
+
# **edit_document_pptx_replace**
|
616
|
+
> String edit_document_pptx_replace(req_config)
|
617
|
+
|
618
|
+
Replace string in PPTX
|
619
|
+
|
620
|
+
Replace all instances of a string in an Office PowerPoint Document (pptx)
|
621
|
+
|
622
|
+
### Example
|
623
|
+
```ruby
|
624
|
+
# load the gem
|
625
|
+
require 'cloudmersive-convert-api-client'
|
626
|
+
# setup authorization
|
627
|
+
CloudmersiveConvertApiClient.configure do |config|
|
628
|
+
# Configure API key authorization: Apikey
|
629
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
630
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
631
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
632
|
+
end
|
633
|
+
|
634
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
635
|
+
|
636
|
+
req_config = CloudmersiveConvertApiClient::ReplaceStringRequest.new # ReplaceStringRequest |
|
637
|
+
|
638
|
+
|
639
|
+
begin
|
640
|
+
#Replace string in PPTX
|
641
|
+
result = api_instance.edit_document_pptx_replace(req_config)
|
642
|
+
p result
|
643
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
644
|
+
puts "Exception when calling EditDocumentApi->edit_document_pptx_replace: #{e}"
|
645
|
+
end
|
646
|
+
```
|
647
|
+
|
648
|
+
### Parameters
|
649
|
+
|
650
|
+
Name | Type | Description | Notes
|
651
|
+
------------- | ------------- | ------------- | -------------
|
652
|
+
**req_config** | [**ReplaceStringRequest**](ReplaceStringRequest.md)| |
|
653
|
+
|
654
|
+
### Return type
|
655
|
+
|
656
|
+
**String**
|
657
|
+
|
658
|
+
### Authorization
|
659
|
+
|
660
|
+
[Apikey](../README.md#Apikey)
|
661
|
+
|
662
|
+
### HTTP request headers
|
663
|
+
|
664
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
665
|
+
- **Accept**: application/octet-stream
|
666
|
+
|
667
|
+
|
668
|
+
|