cloudmersive-convert-api-client 1.5.1 → 1.5.2
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 +17 -5
- data/docs/ConvertWebApi.md +3 -3
- data/docs/DocxPage.md +9 -0
- data/docs/EditDocumentApi.md +165 -0
- data/docs/EditPdfApi.md +55 -0
- data/docs/GetDocxPagesRequest.md +9 -0
- data/docs/GetDocxPagesResponse.md +10 -0
- data/docs/InsertDocxTableRowRequest.md +12 -0
- data/docs/InsertDocxTableRowResponse.md +9 -0
- data/docs/PdfPageText.md +9 -0
- data/docs/PdfTextByPageResult.md +9 -0
- data/docs/RemoveDocxPagesRequest.md +11 -0
- data/lib/cloudmersive-convert-api-client.rb +8 -0
- data/lib/cloudmersive-convert-api-client/api/convert_web_api.rb +2 -2
- data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +165 -0
- data/lib/cloudmersive-convert-api-client/api/edit_pdf_api.rb +56 -0
- data/lib/cloudmersive-convert-api-client/models/docx_page.rb +201 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_pages_request.rb +215 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_pages_response.rb +208 -0
- data/lib/cloudmersive-convert-api-client/models/insert_docx_table_row_request.rb +245 -0
- data/lib/cloudmersive-convert-api-client/models/insert_docx_table_row_response.rb +199 -0
- data/lib/cloudmersive-convert-api-client/models/pdf_page_text.rb +199 -0
- data/lib/cloudmersive-convert-api-client/models/pdf_text_by_page_result.rb +201 -0
- data/lib/cloudmersive-convert-api-client/models/remove_docx_pages_request.rb +235 -0
- data/lib/cloudmersive-convert-api-client/version.rb +1 -1
- data/spec/api/convert_web_api_spec.rb +1 -1
- data/spec/api/edit_document_api_spec.rb +36 -0
- data/spec/api/edit_pdf_api_spec.rb +12 -0
- data/spec/models/docx_page_spec.rb +48 -0
- data/spec/models/get_docx_pages_request_spec.rb +48 -0
- data/spec/models/get_docx_pages_response_spec.rb +54 -0
- data/spec/models/insert_docx_table_row_request_spec.rb +66 -0
- data/spec/models/insert_docx_table_row_response_spec.rb +48 -0
- data/spec/models/pdf_page_text_spec.rb +48 -0
- data/spec/models/pdf_text_by_page_result_spec.rb +48 -0
- data/spec/models/remove_docx_pages_request_spec.rb +60 -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: 0fac385bb07309c42044ce71ddb529cb1d0aca6971f6fd550f8e200914d0fe1e
|
4
|
+
data.tar.gz: 11ea35e402eea2c62e0fd452afd8aa9c37c63123d5da8478f849b3fa9c1436bf
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1b824b9f584c2d85375e91dd8405a897f3d4916438cd84ea095e36387d3adf91dfee48af7004641c006a434a72d2e862258c220775a794a3e8375781b7d280f1
|
7
|
+
data.tar.gz: 26511e2803682afd223d8401d9602e88a3a64425c768011c24ec409e52a0f6303414e03a300cf311861428efcdcf49a8b285a2d6d4e64e2f8e644d91109b8128
|
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: 1.5.
|
10
|
+
- Package version: 1.5.2
|
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-1.5.
|
26
|
+
gem install ./cloudmersive-convert-api-client-1.5.2.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-convert-api-client-1.5.
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-convert-api-client-1.5.2.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', '~> 1.5.
|
34
|
+
gem 'cloudmersive-convert-api-client', '~> 1.5.2'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -123,7 +123,7 @@ Class | Method | HTTP request | Description
|
|
123
123
|
*CloudmersiveConvertApiClient::ConvertImageApi* | [**convert_image_multipage_image_format_convert**](docs/ConvertImageApi.md#convert_image_multipage_image_format_convert) | **POST** /convert/image-multipage/{format1}/to/{format2} | Multi-page image format conversion
|
124
124
|
*CloudmersiveConvertApiClient::ConvertTemplateApi* | [**convert_template_apply_docx_template**](docs/ConvertTemplateApi.md#convert_template_apply_docx_template) | **POST** /convert/template/docx/apply | Apply Word DOCX template
|
125
125
|
*CloudmersiveConvertApiClient::ConvertTemplateApi* | [**convert_template_apply_html_template**](docs/ConvertTemplateApi.md#convert_template_apply_html_template) | **POST** /convert/template/html/apply | Apply HTML template
|
126
|
-
*CloudmersiveConvertApiClient::ConvertWebApi* | [**convert_web_html_to_docx**](docs/ConvertWebApi.md#convert_web_html_to_docx) | **POST** /convert/html/to/docx | Convert HTML to DOCX
|
126
|
+
*CloudmersiveConvertApiClient::ConvertWebApi* | [**convert_web_html_to_docx**](docs/ConvertWebApi.md#convert_web_html_to_docx) | **POST** /convert/html/to/docx | Convert HTML to Word DOCX Document
|
127
127
|
*CloudmersiveConvertApiClient::ConvertWebApi* | [**convert_web_html_to_pdf**](docs/ConvertWebApi.md#convert_web_html_to_pdf) | **POST** /convert/web/html/to/pdf | Convert HTML string to PDF
|
128
128
|
*CloudmersiveConvertApiClient::ConvertWebApi* | [**convert_web_html_to_png**](docs/ConvertWebApi.md#convert_web_html_to_png) | **POST** /convert/web/html/to/png | Convert HTML string to PNG
|
129
129
|
*CloudmersiveConvertApiClient::ConvertWebApi* | [**convert_web_md_to_html**](docs/ConvertWebApi.md#convert_web_md_to_html) | **POST** /convert/web/md/to/html | Convert Markdown to HTML
|
@@ -131,6 +131,7 @@ Class | Method | HTTP request | Description
|
|
131
131
|
*CloudmersiveConvertApiClient::ConvertWebApi* | [**convert_web_url_to_screenshot**](docs/ConvertWebApi.md#convert_web_url_to_screenshot) | **POST** /convert/web/url/to/screenshot | Take screenshot of URL
|
132
132
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_begin_editing**](docs/EditDocumentApi.md#edit_document_begin_editing) | **POST** /convert/edit/begin-editing | Begin editing a document
|
133
133
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_body**](docs/EditDocumentApi.md#edit_document_docx_body) | **POST** /convert/edit/docx/get-body | Get body from a Word DOCX document
|
134
|
+
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_delete_pages**](docs/EditDocumentApi.md#edit_document_docx_delete_pages) | **POST** /convert/edit/docx/delete-pages | Delete, remove pages from a Word DOCX document
|
134
135
|
*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
|
135
136
|
*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
|
136
137
|
*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
|
@@ -139,6 +140,8 @@ Class | Method | HTTP request | Description
|
|
139
140
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_insert_image**](docs/EditDocumentApi.md#edit_document_docx_insert_image) | **POST** /convert/edit/docx/insert-image | Insert image into a Word DOCX document
|
140
141
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_insert_paragraph**](docs/EditDocumentApi.md#edit_document_docx_insert_paragraph) | **POST** /convert/edit/docx/insert-paragraph | Insert a new paragraph into a Word DOCX document
|
141
142
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_insert_table**](docs/EditDocumentApi.md#edit_document_docx_insert_table) | **POST** /convert/edit/docx/insert-table | Insert a new table into a Word DOCX document
|
143
|
+
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_insert_table_row**](docs/EditDocumentApi.md#edit_document_docx_insert_table_row) | **POST** /convert/edit/docx/insert-table-row | Insert a new row into an existing table in a Word DOCX document
|
144
|
+
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_pages**](docs/EditDocumentApi.md#edit_document_docx_pages) | **POST** /convert/edit/docx/get-pages | Get pages and content from a Word DOCX document
|
142
145
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_remove_headers_and_footers**](docs/EditDocumentApi.md#edit_document_docx_remove_headers_and_footers) | **POST** /convert/edit/docx/remove-headers-and-footers | Remove headers and footers from Word DOCX document
|
143
146
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_remove_object**](docs/EditDocumentApi.md#edit_document_docx_remove_object) | **POST** /convert/edit/docx/remove-object | Delete any object in a Word DOCX document
|
144
147
|
*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
|
@@ -158,6 +161,7 @@ Class | Method | HTTP request | Description
|
|
158
161
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_encrypt**](docs/EditPdfApi.md#edit_pdf_encrypt) | **POST** /convert/edit/pdf/encrypt | Encrypt and password-protect a PDF
|
159
162
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_get_form_fields**](docs/EditPdfApi.md#edit_pdf_get_form_fields) | **POST** /convert/edit/pdf/form/get-fields | Gets PDF Form fields and values
|
160
163
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_get_metadata**](docs/EditPdfApi.md#edit_pdf_get_metadata) | **POST** /convert/edit/pdf/get-metadata | Get PDF document metadata
|
164
|
+
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_get_pdf_text_by_pages**](docs/EditPdfApi.md#edit_pdf_get_pdf_text_by_pages) | **POST** /convert/edit/pdf/pages/get-text | Get text in a PDF document by page
|
161
165
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_insert_pages**](docs/EditPdfApi.md#edit_pdf_insert_pages) | **POST** /convert/edit/pdf/pages/insert | Insert / copy pages from one PDF document into another
|
162
166
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_rasterize**](docs/EditPdfApi.md#edit_pdf_rasterize) | **POST** /convert/edit/pdf/rasterize | Rasterize a PDF to an image-based PDF
|
163
167
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_set_form_fields**](docs/EditPdfApi.md#edit_pdf_set_form_fields) | **POST** /convert/edit/pdf/form/set-fields | Sets ands fills PDF Form field values
|
@@ -202,6 +206,7 @@ Class | Method | HTTP request | Description
|
|
202
206
|
- [CloudmersiveConvertApiClient::DocxImage](docs/DocxImage.md)
|
203
207
|
- [CloudmersiveConvertApiClient::DocxInsertImageRequest](docs/DocxInsertImageRequest.md)
|
204
208
|
- [CloudmersiveConvertApiClient::DocxInsertImageResponse](docs/DocxInsertImageResponse.md)
|
209
|
+
- [CloudmersiveConvertApiClient::DocxPage](docs/DocxPage.md)
|
205
210
|
- [CloudmersiveConvertApiClient::DocxParagraph](docs/DocxParagraph.md)
|
206
211
|
- [CloudmersiveConvertApiClient::DocxRemoveObjectRequest](docs/DocxRemoveObjectRequest.md)
|
207
212
|
- [CloudmersiveConvertApiClient::DocxRemoveObjectResponse](docs/DocxRemoveObjectResponse.md)
|
@@ -227,6 +232,8 @@ Class | Method | HTTP request | Description
|
|
227
232
|
- [CloudmersiveConvertApiClient::GetDocxHeadersAndFootersResponse](docs/GetDocxHeadersAndFootersResponse.md)
|
228
233
|
- [CloudmersiveConvertApiClient::GetDocxImagesRequest](docs/GetDocxImagesRequest.md)
|
229
234
|
- [CloudmersiveConvertApiClient::GetDocxImagesResponse](docs/GetDocxImagesResponse.md)
|
235
|
+
- [CloudmersiveConvertApiClient::GetDocxPagesRequest](docs/GetDocxPagesRequest.md)
|
236
|
+
- [CloudmersiveConvertApiClient::GetDocxPagesResponse](docs/GetDocxPagesResponse.md)
|
230
237
|
- [CloudmersiveConvertApiClient::GetDocxSectionsRequest](docs/GetDocxSectionsRequest.md)
|
231
238
|
- [CloudmersiveConvertApiClient::GetDocxSectionsResponse](docs/GetDocxSectionsResponse.md)
|
232
239
|
- [CloudmersiveConvertApiClient::GetDocxStylesRequest](docs/GetDocxStylesRequest.md)
|
@@ -253,6 +260,8 @@ Class | Method | HTTP request | Description
|
|
253
260
|
- [CloudmersiveConvertApiClient::HtmlToPngRequest](docs/HtmlToPngRequest.md)
|
254
261
|
- [CloudmersiveConvertApiClient::InsertDocxInsertParagraphRequest](docs/InsertDocxInsertParagraphRequest.md)
|
255
262
|
- [CloudmersiveConvertApiClient::InsertDocxInsertParagraphResponse](docs/InsertDocxInsertParagraphResponse.md)
|
263
|
+
- [CloudmersiveConvertApiClient::InsertDocxTableRowRequest](docs/InsertDocxTableRowRequest.md)
|
264
|
+
- [CloudmersiveConvertApiClient::InsertDocxTableRowResponse](docs/InsertDocxTableRowResponse.md)
|
256
265
|
- [CloudmersiveConvertApiClient::InsertDocxTablesRequest](docs/InsertDocxTablesRequest.md)
|
257
266
|
- [CloudmersiveConvertApiClient::InsertDocxTablesResponse](docs/InsertDocxTablesResponse.md)
|
258
267
|
- [CloudmersiveConvertApiClient::InsertXlsxWorksheetRequest](docs/InsertXlsxWorksheetRequest.md)
|
@@ -263,9 +272,12 @@ Class | Method | HTTP request | Description
|
|
263
272
|
- [CloudmersiveConvertApiClient::PdfFormField](docs/PdfFormField.md)
|
264
273
|
- [CloudmersiveConvertApiClient::PdfFormFields](docs/PdfFormFields.md)
|
265
274
|
- [CloudmersiveConvertApiClient::PdfMetadata](docs/PdfMetadata.md)
|
275
|
+
- [CloudmersiveConvertApiClient::PdfPageText](docs/PdfPageText.md)
|
276
|
+
- [CloudmersiveConvertApiClient::PdfTextByPageResult](docs/PdfTextByPageResult.md)
|
266
277
|
- [CloudmersiveConvertApiClient::PdfToPngResult](docs/PdfToPngResult.md)
|
267
278
|
- [CloudmersiveConvertApiClient::RemoveDocxHeadersAndFootersRequest](docs/RemoveDocxHeadersAndFootersRequest.md)
|
268
279
|
- [CloudmersiveConvertApiClient::RemoveDocxHeadersAndFootersResponse](docs/RemoveDocxHeadersAndFootersResponse.md)
|
280
|
+
- [CloudmersiveConvertApiClient::RemoveDocxPagesRequest](docs/RemoveDocxPagesRequest.md)
|
269
281
|
- [CloudmersiveConvertApiClient::ReplaceStringRequest](docs/ReplaceStringRequest.md)
|
270
282
|
- [CloudmersiveConvertApiClient::ScreenshotRequest](docs/ScreenshotRequest.md)
|
271
283
|
- [CloudmersiveConvertApiClient::SetFormFieldValue](docs/SetFormFieldValue.md)
|
data/docs/ConvertWebApi.md
CHANGED
@@ -4,7 +4,7 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**convert_web_html_to_docx**](ConvertWebApi.md#convert_web_html_to_docx) | **POST** /convert/html/to/docx | Convert HTML to DOCX
|
7
|
+
[**convert_web_html_to_docx**](ConvertWebApi.md#convert_web_html_to_docx) | **POST** /convert/html/to/docx | Convert HTML to Word DOCX Document
|
8
8
|
[**convert_web_html_to_pdf**](ConvertWebApi.md#convert_web_html_to_pdf) | **POST** /convert/web/html/to/pdf | Convert HTML string to PDF
|
9
9
|
[**convert_web_html_to_png**](ConvertWebApi.md#convert_web_html_to_png) | **POST** /convert/web/html/to/png | Convert HTML string to PNG
|
10
10
|
[**convert_web_md_to_html**](ConvertWebApi.md#convert_web_md_to_html) | **POST** /convert/web/md/to/html | Convert Markdown to HTML
|
@@ -15,7 +15,7 @@ Method | HTTP request | Description
|
|
15
15
|
# **convert_web_html_to_docx**
|
16
16
|
> String convert_web_html_to_docx(input_request)
|
17
17
|
|
18
|
-
Convert HTML to DOCX
|
18
|
+
Convert HTML to Word DOCX Document
|
19
19
|
|
20
20
|
Convert HTML to Office Word Document (DOCX) format
|
21
21
|
|
@@ -37,7 +37,7 @@ input_request = CloudmersiveConvertApiClient::HtmlToOfficeRequest.new # HtmlToOf
|
|
37
37
|
|
38
38
|
|
39
39
|
begin
|
40
|
-
#Convert HTML to DOCX
|
40
|
+
#Convert HTML to Word DOCX Document
|
41
41
|
result = api_instance.convert_web_html_to_docx(input_request)
|
42
42
|
p result
|
43
43
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
data/docs/DocxPage.md
ADDED
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxPage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**page_number** | **Integer** | Page number of this page, 1-based | [optional]
|
7
|
+
**paragraphs** | [**Array<DocxParagraph>**](DocxParagraph.md) | All paragraphs anywhere in the document; these objects are not sequentially placed but are scatted across document | [optional]
|
8
|
+
|
9
|
+
|
data/docs/EditDocumentApi.md
CHANGED
@@ -6,6 +6,7 @@ Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**edit_document_begin_editing**](EditDocumentApi.md#edit_document_begin_editing) | **POST** /convert/edit/begin-editing | Begin editing a document
|
8
8
|
[**edit_document_docx_body**](EditDocumentApi.md#edit_document_docx_body) | **POST** /convert/edit/docx/get-body | Get body from a Word DOCX document
|
9
|
+
[**edit_document_docx_delete_pages**](EditDocumentApi.md#edit_document_docx_delete_pages) | **POST** /convert/edit/docx/delete-pages | Delete, remove pages from a Word DOCX document
|
9
10
|
[**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
|
10
11
|
[**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
|
11
12
|
[**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
|
@@ -14,6 +15,8 @@ Method | HTTP request | Description
|
|
14
15
|
[**edit_document_docx_insert_image**](EditDocumentApi.md#edit_document_docx_insert_image) | **POST** /convert/edit/docx/insert-image | Insert image into a Word DOCX document
|
15
16
|
[**edit_document_docx_insert_paragraph**](EditDocumentApi.md#edit_document_docx_insert_paragraph) | **POST** /convert/edit/docx/insert-paragraph | Insert a new paragraph into a Word DOCX document
|
16
17
|
[**edit_document_docx_insert_table**](EditDocumentApi.md#edit_document_docx_insert_table) | **POST** /convert/edit/docx/insert-table | Insert a new table into a Word DOCX document
|
18
|
+
[**edit_document_docx_insert_table_row**](EditDocumentApi.md#edit_document_docx_insert_table_row) | **POST** /convert/edit/docx/insert-table-row | Insert a new row into an existing table in a Word DOCX document
|
19
|
+
[**edit_document_docx_pages**](EditDocumentApi.md#edit_document_docx_pages) | **POST** /convert/edit/docx/get-pages | Get pages and content from a Word DOCX document
|
17
20
|
[**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 Word DOCX document
|
18
21
|
[**edit_document_docx_remove_object**](EditDocumentApi.md#edit_document_docx_remove_object) | **POST** /convert/edit/docx/remove-object | Delete any object in a Word DOCX document
|
19
22
|
[**edit_document_docx_replace**](EditDocumentApi.md#edit_document_docx_replace) | **POST** /convert/edit/docx/replace-all | Replace string in Word DOCX document
|
@@ -138,6 +141,60 @@ Name | Type | Description | Notes
|
|
138
141
|
|
139
142
|
|
140
143
|
|
144
|
+
# **edit_document_docx_delete_pages**
|
145
|
+
> String edit_document_docx_delete_pages(req_config)
|
146
|
+
|
147
|
+
Delete, remove pages from a Word DOCX document
|
148
|
+
|
149
|
+
Returns the pages and contents of each page defined in the Word Document (DOCX) format file
|
150
|
+
|
151
|
+
### Example
|
152
|
+
```ruby
|
153
|
+
# load the gem
|
154
|
+
require 'cloudmersive-convert-api-client'
|
155
|
+
# setup authorization
|
156
|
+
CloudmersiveConvertApiClient.configure do |config|
|
157
|
+
# Configure API key authorization: Apikey
|
158
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
159
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
160
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
161
|
+
end
|
162
|
+
|
163
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
164
|
+
|
165
|
+
req_config = CloudmersiveConvertApiClient::RemoveDocxPagesRequest.new # RemoveDocxPagesRequest | Document input request
|
166
|
+
|
167
|
+
|
168
|
+
begin
|
169
|
+
#Delete, remove pages from a Word DOCX document
|
170
|
+
result = api_instance.edit_document_docx_delete_pages(req_config)
|
171
|
+
p result
|
172
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
173
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_delete_pages: #{e}"
|
174
|
+
end
|
175
|
+
```
|
176
|
+
|
177
|
+
### Parameters
|
178
|
+
|
179
|
+
Name | Type | Description | Notes
|
180
|
+
------------- | ------------- | ------------- | -------------
|
181
|
+
**req_config** | [**RemoveDocxPagesRequest**](RemoveDocxPagesRequest.md)| Document input request |
|
182
|
+
|
183
|
+
### Return type
|
184
|
+
|
185
|
+
**String**
|
186
|
+
|
187
|
+
### Authorization
|
188
|
+
|
189
|
+
[Apikey](../README.md#Apikey)
|
190
|
+
|
191
|
+
### HTTP request headers
|
192
|
+
|
193
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
194
|
+
- **Accept**: application/octet-stream
|
195
|
+
|
196
|
+
|
197
|
+
|
141
198
|
# **edit_document_docx_get_headers_and_footers**
|
142
199
|
> GetDocxHeadersAndFootersResponse edit_document_docx_get_headers_and_footers(req_config)
|
143
200
|
|
@@ -570,6 +627,114 @@ Name | Type | Description | Notes
|
|
570
627
|
|
571
628
|
|
572
629
|
|
630
|
+
# **edit_document_docx_insert_table_row**
|
631
|
+
> InsertDocxTableRowResponse edit_document_docx_insert_table_row(req_config)
|
632
|
+
|
633
|
+
Insert a new row into an existing table in a Word DOCX document
|
634
|
+
|
635
|
+
Adds a new table row into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation.
|
636
|
+
|
637
|
+
### Example
|
638
|
+
```ruby
|
639
|
+
# load the gem
|
640
|
+
require 'cloudmersive-convert-api-client'
|
641
|
+
# setup authorization
|
642
|
+
CloudmersiveConvertApiClient.configure do |config|
|
643
|
+
# Configure API key authorization: Apikey
|
644
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
645
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
646
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
647
|
+
end
|
648
|
+
|
649
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
650
|
+
|
651
|
+
req_config = CloudmersiveConvertApiClient::InsertDocxTableRowRequest.new # InsertDocxTableRowRequest | Document input request
|
652
|
+
|
653
|
+
|
654
|
+
begin
|
655
|
+
#Insert a new row into an existing table in a Word DOCX document
|
656
|
+
result = api_instance.edit_document_docx_insert_table_row(req_config)
|
657
|
+
p result
|
658
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
659
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_insert_table_row: #{e}"
|
660
|
+
end
|
661
|
+
```
|
662
|
+
|
663
|
+
### Parameters
|
664
|
+
|
665
|
+
Name | Type | Description | Notes
|
666
|
+
------------- | ------------- | ------------- | -------------
|
667
|
+
**req_config** | [**InsertDocxTableRowRequest**](InsertDocxTableRowRequest.md)| Document input request |
|
668
|
+
|
669
|
+
### Return type
|
670
|
+
|
671
|
+
[**InsertDocxTableRowResponse**](InsertDocxTableRowResponse.md)
|
672
|
+
|
673
|
+
### Authorization
|
674
|
+
|
675
|
+
[Apikey](../README.md#Apikey)
|
676
|
+
|
677
|
+
### HTTP request headers
|
678
|
+
|
679
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
680
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
681
|
+
|
682
|
+
|
683
|
+
|
684
|
+
# **edit_document_docx_pages**
|
685
|
+
> GetDocxPagesResponse edit_document_docx_pages(req_config)
|
686
|
+
|
687
|
+
Get pages and content from a Word DOCX document
|
688
|
+
|
689
|
+
Returns the pages and contents of each page defined in the Word Document (DOCX) format file
|
690
|
+
|
691
|
+
### Example
|
692
|
+
```ruby
|
693
|
+
# load the gem
|
694
|
+
require 'cloudmersive-convert-api-client'
|
695
|
+
# setup authorization
|
696
|
+
CloudmersiveConvertApiClient.configure do |config|
|
697
|
+
# Configure API key authorization: Apikey
|
698
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
699
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
700
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
701
|
+
end
|
702
|
+
|
703
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
704
|
+
|
705
|
+
req_config = CloudmersiveConvertApiClient::GetDocxPagesRequest.new # GetDocxPagesRequest | Document input request
|
706
|
+
|
707
|
+
|
708
|
+
begin
|
709
|
+
#Get pages and content from a Word DOCX document
|
710
|
+
result = api_instance.edit_document_docx_pages(req_config)
|
711
|
+
p result
|
712
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
713
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_pages: #{e}"
|
714
|
+
end
|
715
|
+
```
|
716
|
+
|
717
|
+
### Parameters
|
718
|
+
|
719
|
+
Name | Type | Description | Notes
|
720
|
+
------------- | ------------- | ------------- | -------------
|
721
|
+
**req_config** | [**GetDocxPagesRequest**](GetDocxPagesRequest.md)| Document input request |
|
722
|
+
|
723
|
+
### Return type
|
724
|
+
|
725
|
+
[**GetDocxPagesResponse**](GetDocxPagesResponse.md)
|
726
|
+
|
727
|
+
### Authorization
|
728
|
+
|
729
|
+
[Apikey](../README.md#Apikey)
|
730
|
+
|
731
|
+
### HTTP request headers
|
732
|
+
|
733
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
734
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
735
|
+
|
736
|
+
|
737
|
+
|
573
738
|
# **edit_document_docx_remove_headers_and_footers**
|
574
739
|
> RemoveDocxHeadersAndFootersResponse edit_document_docx_remove_headers_and_footers(req_config)
|
575
740
|
|
data/docs/EditPdfApi.md
CHANGED
@@ -9,6 +9,7 @@ Method | HTTP request | Description
|
|
9
9
|
[**edit_pdf_encrypt**](EditPdfApi.md#edit_pdf_encrypt) | **POST** /convert/edit/pdf/encrypt | Encrypt and password-protect a PDF
|
10
10
|
[**edit_pdf_get_form_fields**](EditPdfApi.md#edit_pdf_get_form_fields) | **POST** /convert/edit/pdf/form/get-fields | Gets PDF Form fields and values
|
11
11
|
[**edit_pdf_get_metadata**](EditPdfApi.md#edit_pdf_get_metadata) | **POST** /convert/edit/pdf/get-metadata | Get PDF document metadata
|
12
|
+
[**edit_pdf_get_pdf_text_by_pages**](EditPdfApi.md#edit_pdf_get_pdf_text_by_pages) | **POST** /convert/edit/pdf/pages/get-text | Get text in a PDF document by page
|
12
13
|
[**edit_pdf_insert_pages**](EditPdfApi.md#edit_pdf_insert_pages) | **POST** /convert/edit/pdf/pages/insert | Insert / copy pages from one PDF document into another
|
13
14
|
[**edit_pdf_rasterize**](EditPdfApi.md#edit_pdf_rasterize) | **POST** /convert/edit/pdf/rasterize | Rasterize a PDF to an image-based PDF
|
14
15
|
[**edit_pdf_set_form_fields**](EditPdfApi.md#edit_pdf_set_form_fields) | **POST** /convert/edit/pdf/form/set-fields | Sets ands fills PDF Form field values
|
@@ -304,6 +305,60 @@ Name | Type | Description | Notes
|
|
304
305
|
|
305
306
|
|
306
307
|
|
308
|
+
# **edit_pdf_get_pdf_text_by_pages**
|
309
|
+
> PdfTextByPageResult edit_pdf_get_pdf_text_by_pages(input_file)
|
310
|
+
|
311
|
+
Get text in a PDF document by page
|
312
|
+
|
313
|
+
Gets the text in a PDF by page
|
314
|
+
|
315
|
+
### Example
|
316
|
+
```ruby
|
317
|
+
# load the gem
|
318
|
+
require 'cloudmersive-convert-api-client'
|
319
|
+
# setup authorization
|
320
|
+
CloudmersiveConvertApiClient.configure do |config|
|
321
|
+
# Configure API key authorization: Apikey
|
322
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
323
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
324
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
325
|
+
end
|
326
|
+
|
327
|
+
api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
|
328
|
+
|
329
|
+
input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
|
330
|
+
|
331
|
+
|
332
|
+
begin
|
333
|
+
#Get text in a PDF document by page
|
334
|
+
result = api_instance.edit_pdf_get_pdf_text_by_pages(input_file)
|
335
|
+
p result
|
336
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
337
|
+
puts "Exception when calling EditPdfApi->edit_pdf_get_pdf_text_by_pages: #{e}"
|
338
|
+
end
|
339
|
+
```
|
340
|
+
|
341
|
+
### Parameters
|
342
|
+
|
343
|
+
Name | Type | Description | Notes
|
344
|
+
------------- | ------------- | ------------- | -------------
|
345
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
346
|
+
|
347
|
+
### Return type
|
348
|
+
|
349
|
+
[**PdfTextByPageResult**](PdfTextByPageResult.md)
|
350
|
+
|
351
|
+
### Authorization
|
352
|
+
|
353
|
+
[Apikey](../README.md#Apikey)
|
354
|
+
|
355
|
+
### HTTP request headers
|
356
|
+
|
357
|
+
- **Content-Type**: multipart/form-data
|
358
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
359
|
+
|
360
|
+
|
361
|
+
|
307
362
|
# **edit_pdf_insert_pages**
|
308
363
|
> String edit_pdf_insert_pages(source_file, destination_file, page_start_source, page_end_source, page_insert_before_desitnation)
|
309
364
|
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::GetDocxPagesRequest
|
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
|
+
|
9
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::GetDocxPagesResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | | [optional]
|
7
|
+
**pages** | [**Array<DocxPage>**](DocxPage.md) | | [optional]
|
8
|
+
**page_count** | **Integer** | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::InsertDocxTableRowRequest
|
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
|
+
**row_to_insert** | [**DocxTableRow**](DocxTableRow.md) | Table you would like to insert | [optional]
|
9
|
+
**insert_placement** | **String** | Optional; default is TableEnd. Placement Type of the insert; possible values are: TableStart (very beginning of the table), TableEnd (very end of the document), or a 0-based row index number as an integer, 0 being the first row in the table, 1 being the second row in the table, 2 being the third row in the table, etc. to insert this row after | [optional]
|
10
|
+
**existing_table_path** | **String** | Required; the path to the existing table to modify | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::InsertDocxTableRowResponse
|
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
|
+
|