cloudmersive-convert-api-client 2.1.9 → 2.2.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +19 -7
- data/docs/DocumentEditingEditSession.md +9 -0
- data/docs/DocumentTransformEditSession.md +9 -0
- data/docs/DocxTableSingleTableFill.md +10 -0
- data/docs/DocxTableTableFillMultiRequest.md +10 -0
- data/docs/DocxTableTableFillRequest.md +12 -0
- data/docs/DocxTableTableFillTableCell.md +9 -0
- data/docs/DocxTableTableFillTableRow.md +8 -0
- data/docs/EditDocumentApi.md +58 -3
- data/docs/TransformDocumentApi.md +237 -6
- data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +56 -2
- data/lib/cloudmersive-convert-api-client/api/transform_document_api.rb +235 -4
- data/lib/cloudmersive-convert-api-client/models/document_editing_edit_session.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/document_transform_edit_session.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/docx_table_single_table_fill.rb +208 -0
- data/lib/cloudmersive-convert-api-client/models/docx_table_table_fill_multi_request.rb +223 -0
- data/lib/cloudmersive-convert-api-client/models/docx_table_table_fill_request.rb +243 -0
- data/lib/cloudmersive-convert-api-client/models/docx_table_table_fill_table_cell.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/docx_table_table_fill_table_row.rb +188 -0
- data/lib/cloudmersive-convert-api-client/version.rb +1 -1
- data/lib/cloudmersive-convert-api-client.rb +7 -0
- data/spec/api/edit_document_api_spec.rb +13 -1
- data/spec/api/transform_document_api_spec.rb +54 -2
- data/spec/models/document_editing_edit_session_spec.rb +47 -0
- data/spec/models/document_transform_edit_session_spec.rb +47 -0
- data/spec/models/docx_table_single_table_fill_spec.rb +53 -0
- data/spec/models/docx_table_table_fill_multi_request_spec.rb +53 -0
- data/spec/models/docx_table_table_fill_request_spec.rb +65 -0
- data/spec/models/docx_table_table_fill_table_cell_spec.rb +47 -0
- data/spec/models/docx_table_table_fill_table_row_spec.rb +41 -0
- metadata +23 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3d04663be07d2325db820df2f804191d40cc98142b7911d5b9fe38cdc839b444
|
4
|
+
data.tar.gz: 38ff522b6e239465685988cac35a6fe4389130823509c8372a00e3d37d9ee7f2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a65439264897bcf13b4659cd1954523989ce9ab71f97a1686b8df598920645d70f0980b6230d472fa1644008e76c90ba51a3ff2b46e2735780ad3b2a5f3c34fb
|
7
|
+
data.tar.gz: 3a5f66ddd154cd36e884a8cd946a3325426a8719ecf82b772091d208774809f2f3626560df867e1cf2d99433b052846c8ffbcee853bbf42ce113f4cda40f74b0
|
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.
|
10
|
+
- Package version: 2.2.3
|
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.
|
26
|
+
gem install ./cloudmersive-convert-api-client-2.2.3.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-convert-api-client-2.
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-convert-api-client-2.2.3.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.
|
34
|
+
gem 'cloudmersive-convert-api-client', '~> 2.2.3'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -227,7 +227,8 @@ Class | Method | HTTP request | Description
|
|
227
227
|
*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
|
228
228
|
*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
|
229
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
|
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
|
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, return result
|
231
|
+
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_replace_multi_edit_session**](docs/EditDocumentApi.md#edit_document_docx_replace_multi_edit_session) | **POST** /convert/edit/docx/replace-all/multi/edit-session | Replace multiple strings in Word DOCX document, return edit session
|
231
232
|
*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
233
|
*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
|
233
234
|
*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
|
@@ -328,8 +329,12 @@ Class | Method | HTTP request | Description
|
|
328
329
|
*CloudmersiveConvertApiClient::SplitDocumentApi* | [**split_document_txt_by_line**](docs/SplitDocumentApi.md#split_document_txt_by_line) | **POST** /convert/split/txt/by-line | Split a single Text file (txt) into lines
|
329
330
|
*CloudmersiveConvertApiClient::SplitDocumentApi* | [**split_document_txt_by_string**](docs/SplitDocumentApi.md#split_document_txt_by_string) | **POST** /convert/split/txt/by-string | Split a single Text file (txt) by a string delimiter
|
330
331
|
*CloudmersiveConvertApiClient::SplitDocumentApi* | [**split_document_xlsx**](docs/SplitDocumentApi.md#split_document_xlsx) | **POST** /convert/split/xlsx | Split a single Excel XLSX into Separate Worksheets
|
331
|
-
*CloudmersiveConvertApiClient::TransformDocumentApi* | [**transform_document_docx_replace**](docs/TransformDocumentApi.md#transform_document_docx_replace) | **POST** /convert/transform/docx/replace-all | Replace string in Word DOCX document
|
332
|
-
*CloudmersiveConvertApiClient::TransformDocumentApi* | [**
|
332
|
+
*CloudmersiveConvertApiClient::TransformDocumentApi* | [**transform_document_docx_replace**](docs/TransformDocumentApi.md#transform_document_docx_replace) | **POST** /convert/transform/docx/replace-all | Replace string in Word DOCX document, return result
|
333
|
+
*CloudmersiveConvertApiClient::TransformDocumentApi* | [**transform_document_docx_replace_edit_session**](docs/TransformDocumentApi.md#transform_document_docx_replace_edit_session) | **POST** /convert/transform/docx/replace-all/edit-session | Replace string in Word DOCX document, return edit session
|
334
|
+
*CloudmersiveConvertApiClient::TransformDocumentApi* | [**transform_document_docx_table_fill_in**](docs/TransformDocumentApi.md#transform_document_docx_table_fill_in) | **POST** /convert/transform/docx/table/fill/data | Fill in data in a table in a Word DOCX document, return result
|
335
|
+
*CloudmersiveConvertApiClient::TransformDocumentApi* | [**transform_document_docx_table_fill_in_edit_session**](docs/TransformDocumentApi.md#transform_document_docx_table_fill_in_edit_session) | **POST** /convert/transform/docx/table/fill/data/edit-session | Fill in data in a table in a Word DOCX document, return edit session
|
336
|
+
*CloudmersiveConvertApiClient::TransformDocumentApi* | [**transform_document_docx_table_fill_in_multi**](docs/TransformDocumentApi.md#transform_document_docx_table_fill_in_multi) | **POST** /convert/transform/docx/table/fill/data/multi | Fill in data in multiple tables in a Word DOCX document, return result
|
337
|
+
*CloudmersiveConvertApiClient::TransformDocumentApi* | [**transform_document_pptx_replace**](docs/TransformDocumentApi.md#transform_document_pptx_replace) | **POST** /convert/transform/pptx/replace-all | Replace string in PowerPoint PPTX presentation, return result
|
333
338
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_autodetect_validation**](docs/ValidateDocumentApi.md#validate_document_autodetect_validation) | **POST** /convert/validate/autodetect | Autodetect content type and validate
|
334
339
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_csv_validation**](docs/ValidateDocumentApi.md#validate_document_csv_validation) | **POST** /convert/validate/csv | Validate a CSV file document (CSV)
|
335
340
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_docx_validation**](docs/ValidateDocumentApi.md#validate_document_docx_validation) | **POST** /convert/validate/docx | Validate a Word document (DOCX)
|
@@ -402,6 +407,8 @@ Class | Method | HTTP request | Description
|
|
402
407
|
- [CloudmersiveConvertApiClient::DetectLineEndingsResponse](docs/DetectLineEndingsResponse.md)
|
403
408
|
- [CloudmersiveConvertApiClient::DisableSharedWorkbookRequest](docs/DisableSharedWorkbookRequest.md)
|
404
409
|
- [CloudmersiveConvertApiClient::DisableSharedWorkbookResponse](docs/DisableSharedWorkbookResponse.md)
|
410
|
+
- [CloudmersiveConvertApiClient::DocumentEditingEditSession](docs/DocumentEditingEditSession.md)
|
411
|
+
- [CloudmersiveConvertApiClient::DocumentTransformEditSession](docs/DocumentTransformEditSession.md)
|
405
412
|
- [CloudmersiveConvertApiClient::DocumentValidationError](docs/DocumentValidationError.md)
|
406
413
|
- [CloudmersiveConvertApiClient::DocumentValidationResult](docs/DocumentValidationResult.md)
|
407
414
|
- [CloudmersiveConvertApiClient::DocxBody](docs/DocxBody.md)
|
@@ -430,6 +437,11 @@ Class | Method | HTTP request | Description
|
|
430
437
|
- [CloudmersiveConvertApiClient::DocxTable](docs/DocxTable.md)
|
431
438
|
- [CloudmersiveConvertApiClient::DocxTableCell](docs/DocxTableCell.md)
|
432
439
|
- [CloudmersiveConvertApiClient::DocxTableRow](docs/DocxTableRow.md)
|
440
|
+
- [CloudmersiveConvertApiClient::DocxTableSingleTableFill](docs/DocxTableSingleTableFill.md)
|
441
|
+
- [CloudmersiveConvertApiClient::DocxTableTableFillMultiRequest](docs/DocxTableTableFillMultiRequest.md)
|
442
|
+
- [CloudmersiveConvertApiClient::DocxTableTableFillRequest](docs/DocxTableTableFillRequest.md)
|
443
|
+
- [CloudmersiveConvertApiClient::DocxTableTableFillTableCell](docs/DocxTableTableFillTableCell.md)
|
444
|
+
- [CloudmersiveConvertApiClient::DocxTableTableFillTableRow](docs/DocxTableTableFillTableRow.md)
|
433
445
|
- [CloudmersiveConvertApiClient::DocxTemplateApplicationRequest](docs/DocxTemplateApplicationRequest.md)
|
434
446
|
- [CloudmersiveConvertApiClient::DocxTemplateOperation](docs/DocxTemplateOperation.md)
|
435
447
|
- [CloudmersiveConvertApiClient::DocxText](docs/DocxText.md)
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocumentEditingEditSession
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
7
|
+
**edit_session_url** | **String** | Document editing session URL; in-memory temporary cache link with TTL (Time-to-Live expiration) of 30 minutes. To retrieve the document, use the Finish Editing API. | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocumentTransformEditSession
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
7
|
+
**edit_session_url** | **String** | Document editing session URL; in-memory temporary cache link with TTL (Time-to-Live expiration) of 30 minutes. To retrieve the document, use the Finish Editing API. | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxTableSingleTableFill
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**table_start_tag** | **String** | Start tag that delineates the beginning of the table | [optional]
|
7
|
+
**table_end_tag** | **String** | End tag that delineates the end of the table | [optional]
|
8
|
+
**data_to_fill_in** | [**Array<DocxTableTableFillTableRow>**](DocxTableTableFillTableRow.md) | Data set to populate the table with | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxTableTableFillMultiRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**input_file_url** | **String** | Optional; Input URL of the document; use BeginEditing to create this | [optional]
|
7
|
+
**input_file_data** | **String** | Optional; Input Word Document file content for the operation | [optional]
|
8
|
+
**tables_to_fill** | [**Array<DocxTableSingleTableFill>**](DocxTableSingleTableFill.md) | Tables and datasets to fill into the document | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxTableTableFillRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**input_file_url** | **String** | Optional; Input URL of the document; use BeginEditing to create this | [optional]
|
7
|
+
**input_file_data** | **String** | Optional; Input Word Document file content for the operation | [optional]
|
8
|
+
**table_start_tag** | **String** | Start tag that delineates the beginning of the table | [optional]
|
9
|
+
**table_end_tag** | **String** | End tag that delineates the end of the table | [optional]
|
10
|
+
**data_to_fill_in** | [**Array<DocxTableTableFillTableRow>**](DocxTableTableFillTableRow.md) | Data set to populate the table with | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxTableTableFillTableCell
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**target_tag** | **String** | Target tag to replace | [optional]
|
7
|
+
**replacement_value** | **String** | Replacement value for the target tag | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DocxTableTableFillTableRow
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**cells** | [**Array<DocxTableTableFillTableCell>**](DocxTableTableFillTableCell.md) | Cells in the row to fill in | [optional]
|
7
|
+
|
8
|
+
|
data/docs/EditDocumentApi.md
CHANGED
@@ -35,7 +35,8 @@ Method | HTTP request | Description
|
|
35
35
|
[**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
|
36
36
|
[**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
|
37
37
|
[**edit_document_docx_replace**](EditDocumentApi.md#edit_document_docx_replace) | **POST** /convert/edit/docx/replace-all | Replace string in Word DOCX document
|
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
|
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, return result
|
39
|
+
[**edit_document_docx_replace_multi_edit_session**](EditDocumentApi.md#edit_document_docx_replace_multi_edit_session) | **POST** /convert/edit/docx/replace-all/multi/edit-session | Replace multiple strings in Word DOCX document, return edit session
|
39
40
|
[**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
41
|
[**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
|
41
42
|
[**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
|
@@ -1747,7 +1748,7 @@ Name | Type | Description | Notes
|
|
1747
1748
|
# **edit_document_docx_replace_multi**
|
1748
1749
|
> String edit_document_docx_replace_multi(req_config)
|
1749
1750
|
|
1750
|
-
Replace multiple strings in Word DOCX document
|
1751
|
+
Replace multiple strings in Word DOCX document, return result
|
1751
1752
|
|
1752
1753
|
Replace all instances of multiple strings in an Office Word Document (docx)
|
1753
1754
|
|
@@ -1769,7 +1770,7 @@ req_config = CloudmersiveConvertApiClient::MultiReplaceStringRequest.new # Multi
|
|
1769
1770
|
|
1770
1771
|
|
1771
1772
|
begin
|
1772
|
-
#Replace multiple strings in Word DOCX document
|
1773
|
+
#Replace multiple strings in Word DOCX document, return result
|
1773
1774
|
result = api_instance.edit_document_docx_replace_multi(req_config)
|
1774
1775
|
p result
|
1775
1776
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -1798,6 +1799,60 @@ Name | Type | Description | Notes
|
|
1798
1799
|
|
1799
1800
|
|
1800
1801
|
|
1802
|
+
# **edit_document_docx_replace_multi_edit_session**
|
1803
|
+
> DocumentEditingEditSession edit_document_docx_replace_multi_edit_session(req_config)
|
1804
|
+
|
1805
|
+
Replace multiple strings in Word DOCX document, return edit session
|
1806
|
+
|
1807
|
+
Replace all instances of multiple strings in an Office Word Document (docx). Returns an edit session URL so that you can chain together multiple edit operations without having to send the entire document contents back and forth multiple times. Call the Finish Editing API to retrieve the final document once editing is complete.
|
1808
|
+
|
1809
|
+
### Example
|
1810
|
+
```ruby
|
1811
|
+
# load the gem
|
1812
|
+
require 'cloudmersive-convert-api-client'
|
1813
|
+
# setup authorization
|
1814
|
+
CloudmersiveConvertApiClient.configure do |config|
|
1815
|
+
# Configure API key authorization: Apikey
|
1816
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
1817
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1818
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
1819
|
+
end
|
1820
|
+
|
1821
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
1822
|
+
|
1823
|
+
req_config = CloudmersiveConvertApiClient::MultiReplaceStringRequest.new # MultiReplaceStringRequest | Document string replacement configuration input
|
1824
|
+
|
1825
|
+
|
1826
|
+
begin
|
1827
|
+
#Replace multiple strings in Word DOCX document, return edit session
|
1828
|
+
result = api_instance.edit_document_docx_replace_multi_edit_session(req_config)
|
1829
|
+
p result
|
1830
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
1831
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_replace_multi_edit_session: #{e}"
|
1832
|
+
end
|
1833
|
+
```
|
1834
|
+
|
1835
|
+
### Parameters
|
1836
|
+
|
1837
|
+
Name | Type | Description | Notes
|
1838
|
+
------------- | ------------- | ------------- | -------------
|
1839
|
+
**req_config** | [**MultiReplaceStringRequest**](MultiReplaceStringRequest.md)| Document string replacement configuration input |
|
1840
|
+
|
1841
|
+
### Return type
|
1842
|
+
|
1843
|
+
[**DocumentEditingEditSession**](DocumentEditingEditSession.md)
|
1844
|
+
|
1845
|
+
### Authorization
|
1846
|
+
|
1847
|
+
[Apikey](../README.md#Apikey)
|
1848
|
+
|
1849
|
+
### HTTP request headers
|
1850
|
+
|
1851
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
1852
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
1853
|
+
|
1854
|
+
|
1855
|
+
|
1801
1856
|
# **edit_document_docx_replace_paragraph**
|
1802
1857
|
> ReplaceDocxParagraphResponse edit_document_docx_replace_paragraph(req_config)
|
1803
1858
|
|
@@ -4,14 +4,18 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**transform_document_docx_replace**](TransformDocumentApi.md#transform_document_docx_replace) | **POST** /convert/transform/docx/replace-all | Replace string in Word DOCX document
|
8
|
-
[**
|
7
|
+
[**transform_document_docx_replace**](TransformDocumentApi.md#transform_document_docx_replace) | **POST** /convert/transform/docx/replace-all | Replace string in Word DOCX document, return result
|
8
|
+
[**transform_document_docx_replace_edit_session**](TransformDocumentApi.md#transform_document_docx_replace_edit_session) | **POST** /convert/transform/docx/replace-all/edit-session | Replace string in Word DOCX document, return edit session
|
9
|
+
[**transform_document_docx_table_fill_in**](TransformDocumentApi.md#transform_document_docx_table_fill_in) | **POST** /convert/transform/docx/table/fill/data | Fill in data in a table in a Word DOCX document, return result
|
10
|
+
[**transform_document_docx_table_fill_in_edit_session**](TransformDocumentApi.md#transform_document_docx_table_fill_in_edit_session) | **POST** /convert/transform/docx/table/fill/data/edit-session | Fill in data in a table in a Word DOCX document, return edit session
|
11
|
+
[**transform_document_docx_table_fill_in_multi**](TransformDocumentApi.md#transform_document_docx_table_fill_in_multi) | **POST** /convert/transform/docx/table/fill/data/multi | Fill in data in multiple tables in a Word DOCX document, return result
|
12
|
+
[**transform_document_pptx_replace**](TransformDocumentApi.md#transform_document_pptx_replace) | **POST** /convert/transform/pptx/replace-all | Replace string in PowerPoint PPTX presentation, return result
|
9
13
|
|
10
14
|
|
11
15
|
# **transform_document_docx_replace**
|
12
16
|
> String transform_document_docx_replace(match_string, replace_string, opts)
|
13
17
|
|
14
|
-
Replace string in Word DOCX document
|
18
|
+
Replace string in Word DOCX document, return result
|
15
19
|
|
16
20
|
Replace all instances of a string in an Office Word Document (docx)
|
17
21
|
|
@@ -40,7 +44,7 @@ opts = {
|
|
40
44
|
}
|
41
45
|
|
42
46
|
begin
|
43
|
-
#Replace string in Word DOCX document
|
47
|
+
#Replace string in Word DOCX document, return result
|
44
48
|
result = api_instance.transform_document_docx_replace(match_string, replace_string, opts)
|
45
49
|
p result
|
46
50
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -73,10 +77,237 @@ Name | Type | Description | Notes
|
|
73
77
|
|
74
78
|
|
75
79
|
|
80
|
+
# **transform_document_docx_replace_edit_session**
|
81
|
+
> DocumentTransformEditSession transform_document_docx_replace_edit_session(match_string, replace_string, opts)
|
82
|
+
|
83
|
+
Replace string in Word DOCX document, return edit session
|
84
|
+
|
85
|
+
Replace all instances of a string in an Office Word Document (docx). Returns an edit session URL so that you can chain together multiple edit operations without having to send the entire document contents back and forth multiple times. Call the Finish Editing API to retrieve the final document once editing is complete.
|
86
|
+
|
87
|
+
### Example
|
88
|
+
```ruby
|
89
|
+
# load the gem
|
90
|
+
require 'cloudmersive-convert-api-client'
|
91
|
+
# setup authorization
|
92
|
+
CloudmersiveConvertApiClient.configure do |config|
|
93
|
+
# Configure API key authorization: Apikey
|
94
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
95
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
96
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
97
|
+
end
|
98
|
+
|
99
|
+
api_instance = CloudmersiveConvertApiClient::TransformDocumentApi.new
|
100
|
+
|
101
|
+
match_string = 'match_string_example' # String | String to search for and match against, to be replaced
|
102
|
+
|
103
|
+
replace_string = 'replace_string_example' # String | String to replace the matched values with
|
104
|
+
|
105
|
+
opts = {
|
106
|
+
input_file: File.new('/path/to/file.txt'), # File | Optional: Input file to perform the operation on.
|
107
|
+
input_file_url: 'input_file_url_example', # String | Optional: URL of a file to operate on as input. This can be a public URL, or you can also use the begin-editing API (part of EditDocumentApi) to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
|
108
|
+
match_case: true # BOOLEAN | Optional: True if the case should be matched, false for case insensitive match. Default is false.
|
109
|
+
}
|
110
|
+
|
111
|
+
begin
|
112
|
+
#Replace string in Word DOCX document, return edit session
|
113
|
+
result = api_instance.transform_document_docx_replace_edit_session(match_string, replace_string, opts)
|
114
|
+
p result
|
115
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
116
|
+
puts "Exception when calling TransformDocumentApi->transform_document_docx_replace_edit_session: #{e}"
|
117
|
+
end
|
118
|
+
```
|
119
|
+
|
120
|
+
### Parameters
|
121
|
+
|
122
|
+
Name | Type | Description | Notes
|
123
|
+
------------- | ------------- | ------------- | -------------
|
124
|
+
**match_string** | **String**| String to search for and match against, to be replaced |
|
125
|
+
**replace_string** | **String**| String to replace the matched values with |
|
126
|
+
**input_file** | **File**| Optional: Input file to perform the operation on. | [optional]
|
127
|
+
**input_file_url** | **String**| Optional: URL of a file to operate on as input. This can be a public URL, or you can also use the begin-editing API (part of EditDocumentApi) to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public). | [optional]
|
128
|
+
**match_case** | **BOOLEAN**| Optional: True if the case should be matched, false for case insensitive match. Default is false. | [optional]
|
129
|
+
|
130
|
+
### Return type
|
131
|
+
|
132
|
+
[**DocumentTransformEditSession**](DocumentTransformEditSession.md)
|
133
|
+
|
134
|
+
### Authorization
|
135
|
+
|
136
|
+
[Apikey](../README.md#Apikey)
|
137
|
+
|
138
|
+
### HTTP request headers
|
139
|
+
|
140
|
+
- **Content-Type**: Not defined
|
141
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
142
|
+
|
143
|
+
|
144
|
+
|
145
|
+
# **transform_document_docx_table_fill_in**
|
146
|
+
> String transform_document_docx_table_fill_in(request)
|
147
|
+
|
148
|
+
Fill in data in a table in a Word DOCX document, return result
|
149
|
+
|
150
|
+
Replace placeholder rows ina table in an Office Word Document (docx) using one or more templates
|
151
|
+
|
152
|
+
### Example
|
153
|
+
```ruby
|
154
|
+
# load the gem
|
155
|
+
require 'cloudmersive-convert-api-client'
|
156
|
+
# setup authorization
|
157
|
+
CloudmersiveConvertApiClient.configure do |config|
|
158
|
+
# Configure API key authorization: Apikey
|
159
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
160
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
161
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
162
|
+
end
|
163
|
+
|
164
|
+
api_instance = CloudmersiveConvertApiClient::TransformDocumentApi.new
|
165
|
+
|
166
|
+
request = CloudmersiveConvertApiClient::DocxTableTableFillRequest.new # DocxTableTableFillRequest |
|
167
|
+
|
168
|
+
|
169
|
+
begin
|
170
|
+
#Fill in data in a table in a Word DOCX document, return result
|
171
|
+
result = api_instance.transform_document_docx_table_fill_in(request)
|
172
|
+
p result
|
173
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
174
|
+
puts "Exception when calling TransformDocumentApi->transform_document_docx_table_fill_in: #{e}"
|
175
|
+
end
|
176
|
+
```
|
177
|
+
|
178
|
+
### Parameters
|
179
|
+
|
180
|
+
Name | Type | Description | Notes
|
181
|
+
------------- | ------------- | ------------- | -------------
|
182
|
+
**request** | [**DocxTableTableFillRequest**](DocxTableTableFillRequest.md)| |
|
183
|
+
|
184
|
+
### Return type
|
185
|
+
|
186
|
+
**String**
|
187
|
+
|
188
|
+
### Authorization
|
189
|
+
|
190
|
+
[Apikey](../README.md#Apikey)
|
191
|
+
|
192
|
+
### HTTP request headers
|
193
|
+
|
194
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
195
|
+
- **Accept**: application/octet-stream
|
196
|
+
|
197
|
+
|
198
|
+
|
199
|
+
# **transform_document_docx_table_fill_in_edit_session**
|
200
|
+
> DocumentTransformEditSession transform_document_docx_table_fill_in_edit_session(request)
|
201
|
+
|
202
|
+
Fill in data in a table in a Word DOCX document, return edit session
|
203
|
+
|
204
|
+
Replace placeholder rows ina table in an Office Word Document (docx) using one or more templates. Returns an edit session URL so that you can chain together multiple edit operations without having to send the entire document contents back and forth multiple times. Call the Finish Editing API to retrieve the final document once editing is complete.
|
205
|
+
|
206
|
+
### Example
|
207
|
+
```ruby
|
208
|
+
# load the gem
|
209
|
+
require 'cloudmersive-convert-api-client'
|
210
|
+
# setup authorization
|
211
|
+
CloudmersiveConvertApiClient.configure do |config|
|
212
|
+
# Configure API key authorization: Apikey
|
213
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
214
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
215
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
216
|
+
end
|
217
|
+
|
218
|
+
api_instance = CloudmersiveConvertApiClient::TransformDocumentApi.new
|
219
|
+
|
220
|
+
request = CloudmersiveConvertApiClient::DocxTableTableFillRequest.new # DocxTableTableFillRequest |
|
221
|
+
|
222
|
+
|
223
|
+
begin
|
224
|
+
#Fill in data in a table in a Word DOCX document, return edit session
|
225
|
+
result = api_instance.transform_document_docx_table_fill_in_edit_session(request)
|
226
|
+
p result
|
227
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
228
|
+
puts "Exception when calling TransformDocumentApi->transform_document_docx_table_fill_in_edit_session: #{e}"
|
229
|
+
end
|
230
|
+
```
|
231
|
+
|
232
|
+
### Parameters
|
233
|
+
|
234
|
+
Name | Type | Description | Notes
|
235
|
+
------------- | ------------- | ------------- | -------------
|
236
|
+
**request** | [**DocxTableTableFillRequest**](DocxTableTableFillRequest.md)| |
|
237
|
+
|
238
|
+
### Return type
|
239
|
+
|
240
|
+
[**DocumentTransformEditSession**](DocumentTransformEditSession.md)
|
241
|
+
|
242
|
+
### Authorization
|
243
|
+
|
244
|
+
[Apikey](../README.md#Apikey)
|
245
|
+
|
246
|
+
### HTTP request headers
|
247
|
+
|
248
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
249
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
250
|
+
|
251
|
+
|
252
|
+
|
253
|
+
# **transform_document_docx_table_fill_in_multi**
|
254
|
+
> Object transform_document_docx_table_fill_in_multi(request)
|
255
|
+
|
256
|
+
Fill in data in multiple tables in a Word DOCX document, return result
|
257
|
+
|
258
|
+
Replace placeholder rows in multiple tables in an Office Word Document (docx) using one or more templates
|
259
|
+
|
260
|
+
### Example
|
261
|
+
```ruby
|
262
|
+
# load the gem
|
263
|
+
require 'cloudmersive-convert-api-client'
|
264
|
+
# setup authorization
|
265
|
+
CloudmersiveConvertApiClient.configure do |config|
|
266
|
+
# Configure API key authorization: Apikey
|
267
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
268
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
269
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
270
|
+
end
|
271
|
+
|
272
|
+
api_instance = CloudmersiveConvertApiClient::TransformDocumentApi.new
|
273
|
+
|
274
|
+
request = CloudmersiveConvertApiClient::DocxTableTableFillMultiRequest.new # DocxTableTableFillMultiRequest |
|
275
|
+
|
276
|
+
|
277
|
+
begin
|
278
|
+
#Fill in data in multiple tables in a Word DOCX document, return result
|
279
|
+
result = api_instance.transform_document_docx_table_fill_in_multi(request)
|
280
|
+
p result
|
281
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
282
|
+
puts "Exception when calling TransformDocumentApi->transform_document_docx_table_fill_in_multi: #{e}"
|
283
|
+
end
|
284
|
+
```
|
285
|
+
|
286
|
+
### Parameters
|
287
|
+
|
288
|
+
Name | Type | Description | Notes
|
289
|
+
------------- | ------------- | ------------- | -------------
|
290
|
+
**request** | [**DocxTableTableFillMultiRequest**](DocxTableTableFillMultiRequest.md)| |
|
291
|
+
|
292
|
+
### Return type
|
293
|
+
|
294
|
+
**Object**
|
295
|
+
|
296
|
+
### Authorization
|
297
|
+
|
298
|
+
[Apikey](../README.md#Apikey)
|
299
|
+
|
300
|
+
### HTTP request headers
|
301
|
+
|
302
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
303
|
+
- **Accept**: application/octet-stream
|
304
|
+
|
305
|
+
|
306
|
+
|
76
307
|
# **transform_document_pptx_replace**
|
77
308
|
> String transform_document_pptx_replace(match_string, replace_string, opts)
|
78
309
|
|
79
|
-
Replace string in PowerPoint PPTX presentation
|
310
|
+
Replace string in PowerPoint PPTX presentation, return result
|
80
311
|
|
81
312
|
Replace all instances of a string in an Office PowerPoint Document (pptx)
|
82
313
|
|
@@ -105,7 +336,7 @@ opts = {
|
|
105
336
|
}
|
106
337
|
|
107
338
|
begin
|
108
|
-
#Replace string in PowerPoint PPTX presentation
|
339
|
+
#Replace string in PowerPoint PPTX presentation, return result
|
109
340
|
result = api_instance.transform_document_pptx_replace(match_string, replace_string, opts)
|
110
341
|
p result
|
111
342
|
rescue CloudmersiveConvertApiClient::ApiError => e
|