cloudmersive-convert-api-client 1.5.3 → 1.5.4
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 +13 -4
- data/docs/CreateBlankDocxRequest.md +8 -0
- data/docs/CreateBlankDocxResponse.md +9 -0
- data/docs/CreateBlankSpreadsheetRequest.md +8 -0
- data/docs/CreateBlankSpreadsheetResponse.md +9 -0
- data/docs/EditDocumentApi.md +165 -0
- data/docs/GetXlsxWorksheetsResponse.md +1 -1
- data/docs/UpdateDocxTableCellRequest.md +13 -0
- data/docs/UpdateDocxTableCellResponse.md +9 -0
- data/docs/UpdateDocxTableRowRequest.md +1 -1
- data/lib/cloudmersive-convert-api-client.rb +6 -0
- data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +165 -0
- data/lib/cloudmersive-convert-api-client/models/create_blank_docx_request.rb +189 -0
- data/lib/cloudmersive-convert-api-client/models/create_blank_docx_response.rb +199 -0
- data/lib/cloudmersive-convert-api-client/models/create_blank_spreadsheet_request.rb +189 -0
- data/lib/cloudmersive-convert-api-client/models/create_blank_spreadsheet_response.rb +199 -0
- data/lib/cloudmersive-convert-api-client/models/get_xlsx_worksheets_response.rb +1 -1
- data/lib/cloudmersive-convert-api-client/models/update_docx_table_cell_request.rb +255 -0
- data/lib/cloudmersive-convert-api-client/models/update_docx_table_cell_response.rb +199 -0
- data/lib/cloudmersive-convert-api-client/models/update_docx_table_row_request.rb +7 -7
- data/lib/cloudmersive-convert-api-client/version.rb +1 -1
- data/spec/api/edit_document_api_spec.rb +36 -0
- data/spec/models/create_blank_docx_request_spec.rb +42 -0
- data/spec/models/create_blank_docx_response_spec.rb +48 -0
- data/spec/models/create_blank_spreadsheet_request_spec.rb +42 -0
- data/spec/models/create_blank_spreadsheet_response_spec.rb +48 -0
- data/spec/models/update_docx_table_cell_request_spec.rb +72 -0
- data/spec/models/update_docx_table_cell_response_spec.rb +48 -0
- data/spec/models/update_docx_table_row_request_spec.rb +1 -1
- metadata +19 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e2774f56f3d48a9cc8e8c3c47cb570439bcc6b44acf821a9e964e7cb99416a49
|
4
|
+
data.tar.gz: 99204d0fbfcc4c73062b0d7ff71270903727dd3f029b422cb49e25d4dad4a7f7
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6553da0a592acfa402f745d9c651873957cee81d5e5689db339a188ad851b3ed03f922c49984d19d009807828fea6c41e10cf6b8f0f279f7c559748e58f41f83
|
7
|
+
data.tar.gz: 698e659e7f1ea6eee179bd8079be24d4c3026f36a4f3aad4ec449d9c4e9bfb9e058e8dbd206ab1bff1ea197d3ed03e513da4d8a6ba8182ca2eea40178597ddba
|
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.4
|
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.4.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.4.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.4'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -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_create_blank_document**](docs/EditDocumentApi.md#edit_document_docx_create_blank_document) | **POST** /convert/edit/docx/create/blank | Create a blank Word DOCX document
|
134
135
|
*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
|
135
136
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_delete_table_row**](docs/EditDocumentApi.md#edit_document_docx_delete_table_row) | **POST** /convert/edit/docx/delete-table-row | Deletes a table row in an existing table in a Word DOCX document
|
136
137
|
*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
|
@@ -151,9 +152,11 @@ Class | Method | HTTP request | Description
|
|
151
152
|
*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
|
152
153
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_set_footer_add_page_number**](docs/EditDocumentApi.md#edit_document_docx_set_footer_add_page_number) | **POST** /convert/edit/docx/set-footer/add-page-number | Add page number to footer in a Word DOCX document
|
153
154
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_set_header**](docs/EditDocumentApi.md#edit_document_docx_set_header) | **POST** /convert/edit/docx/set-header | Set the header in a Word DOCX document
|
155
|
+
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_update_table_cell**](docs/EditDocumentApi.md#edit_document_docx_update_table_cell) | **POST** /convert/edit/docx/update-table-cell | Update, set contents of a table cell in an existing table in a Word DOCX document
|
154
156
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_update_table_row**](docs/EditDocumentApi.md#edit_document_docx_update_table_row) | **POST** /convert/edit/docx/update-table-row | Update, set contents of a table row in an existing table in a Word DOCX document
|
155
157
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_finish_editing**](docs/EditDocumentApi.md#edit_document_finish_editing) | **POST** /convert/edit/finish-editing | Download result from document editing
|
156
158
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_pptx_replace**](docs/EditDocumentApi.md#edit_document_pptx_replace) | **POST** /convert/edit/pptx/replace-all | Replace string in PowerPoint PPTX presentation
|
159
|
+
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_create_blank_spreadsheet**](docs/EditDocumentApi.md#edit_document_xlsx_create_blank_spreadsheet) | **POST** /convert/edit/xlsx/create/blank | Create a blank Excel XLSX spreadsheet
|
157
160
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_columns**](docs/EditDocumentApi.md#edit_document_xlsx_get_columns) | **POST** /convert/edit/xlsx/get-columns | Get rows and cells from a Excel XLSX spreadsheet, worksheet
|
158
161
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_images**](docs/EditDocumentApi.md#edit_document_xlsx_get_images) | **POST** /convert/edit/xlsx/get-images | Get images from a Excel XLSX spreadsheet, worksheet
|
159
162
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_rows_and_cells**](docs/EditDocumentApi.md#edit_document_xlsx_get_rows_and_cells) | **POST** /convert/edit/xlsx/get-rows-and-cells | Get rows and cells from a Word XLSX spreadsheet, worksheet
|
@@ -201,6 +204,10 @@ Class | Method | HTTP request | Description
|
|
201
204
|
- [CloudmersiveConvertApiClient::AutodetectGetInfoResult](docs/AutodetectGetInfoResult.md)
|
202
205
|
- [CloudmersiveConvertApiClient::AutodetectToPngResult](docs/AutodetectToPngResult.md)
|
203
206
|
- [CloudmersiveConvertApiClient::ConvertedPngPage](docs/ConvertedPngPage.md)
|
207
|
+
- [CloudmersiveConvertApiClient::CreateBlankDocxRequest](docs/CreateBlankDocxRequest.md)
|
208
|
+
- [CloudmersiveConvertApiClient::CreateBlankDocxResponse](docs/CreateBlankDocxResponse.md)
|
209
|
+
- [CloudmersiveConvertApiClient::CreateBlankSpreadsheetRequest](docs/CreateBlankSpreadsheetRequest.md)
|
210
|
+
- [CloudmersiveConvertApiClient::CreateBlankSpreadsheetResponse](docs/CreateBlankSpreadsheetResponse.md)
|
204
211
|
- [CloudmersiveConvertApiClient::DeleteDocxTableRowRequest](docs/DeleteDocxTableRowRequest.md)
|
205
212
|
- [CloudmersiveConvertApiClient::DeleteDocxTableRowResponse](docs/DeleteDocxTableRowResponse.md)
|
206
213
|
- [CloudmersiveConvertApiClient::DocumentValidationError](docs/DocumentValidationError.md)
|
@@ -296,6 +303,8 @@ Class | Method | HTTP request | Description
|
|
296
303
|
- [CloudmersiveConvertApiClient::SplitPdfResult](docs/SplitPdfResult.md)
|
297
304
|
- [CloudmersiveConvertApiClient::SplitXlsxWorksheetResult](docs/SplitXlsxWorksheetResult.md)
|
298
305
|
- [CloudmersiveConvertApiClient::TextConversionResult](docs/TextConversionResult.md)
|
306
|
+
- [CloudmersiveConvertApiClient::UpdateDocxTableCellRequest](docs/UpdateDocxTableCellRequest.md)
|
307
|
+
- [CloudmersiveConvertApiClient::UpdateDocxTableCellResponse](docs/UpdateDocxTableCellResponse.md)
|
299
308
|
- [CloudmersiveConvertApiClient::UpdateDocxTableRowRequest](docs/UpdateDocxTableRowRequest.md)
|
300
309
|
- [CloudmersiveConvertApiClient::UpdateDocxTableRowResponse](docs/UpdateDocxTableRowResponse.md)
|
301
310
|
- [CloudmersiveConvertApiClient::ViewerResponse](docs/ViewerResponse.md)
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::CreateBlankDocxRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**initial_text** | **String** | Optional; initial text to include in the document | [optional]
|
7
|
+
|
8
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::CreateBlankDocxResponse
|
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 XLSX 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,8 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::CreateBlankSpreadsheetRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**worksheet_name** | **String** | The blank Spreadsheet will have a default Worksheet in it; supply a name, or if left empty, will default to Worksheet1 | [optional]
|
7
|
+
|
8
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::CreateBlankSpreadsheetResponse
|
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 XLSX 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
|
+
|
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_create_blank_document**](EditDocumentApi.md#edit_document_docx_create_blank_document) | **POST** /convert/edit/docx/create/blank | Create a blank Word DOCX document
|
9
10
|
[**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
|
10
11
|
[**edit_document_docx_delete_table_row**](EditDocumentApi.md#edit_document_docx_delete_table_row) | **POST** /convert/edit/docx/delete-table-row | Deletes a table row in an existing table in a Word DOCX document
|
11
12
|
[**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
|
@@ -26,9 +27,11 @@ Method | HTTP request | Description
|
|
26
27
|
[**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
|
27
28
|
[**edit_document_docx_set_footer_add_page_number**](EditDocumentApi.md#edit_document_docx_set_footer_add_page_number) | **POST** /convert/edit/docx/set-footer/add-page-number | Add page number to footer in a Word DOCX document
|
28
29
|
[**edit_document_docx_set_header**](EditDocumentApi.md#edit_document_docx_set_header) | **POST** /convert/edit/docx/set-header | Set the header in a Word DOCX document
|
30
|
+
[**edit_document_docx_update_table_cell**](EditDocumentApi.md#edit_document_docx_update_table_cell) | **POST** /convert/edit/docx/update-table-cell | Update, set contents of a table cell in an existing table in a Word DOCX document
|
29
31
|
[**edit_document_docx_update_table_row**](EditDocumentApi.md#edit_document_docx_update_table_row) | **POST** /convert/edit/docx/update-table-row | Update, set contents of a table row in an existing table in a Word DOCX document
|
30
32
|
[**edit_document_finish_editing**](EditDocumentApi.md#edit_document_finish_editing) | **POST** /convert/edit/finish-editing | Download result from document editing
|
31
33
|
[**edit_document_pptx_replace**](EditDocumentApi.md#edit_document_pptx_replace) | **POST** /convert/edit/pptx/replace-all | Replace string in PowerPoint PPTX presentation
|
34
|
+
[**edit_document_xlsx_create_blank_spreadsheet**](EditDocumentApi.md#edit_document_xlsx_create_blank_spreadsheet) | **POST** /convert/edit/xlsx/create/blank | Create a blank Excel XLSX spreadsheet
|
32
35
|
[**edit_document_xlsx_get_columns**](EditDocumentApi.md#edit_document_xlsx_get_columns) | **POST** /convert/edit/xlsx/get-columns | Get rows and cells from a Excel XLSX spreadsheet, worksheet
|
33
36
|
[**edit_document_xlsx_get_images**](EditDocumentApi.md#edit_document_xlsx_get_images) | **POST** /convert/edit/xlsx/get-images | Get images from a Excel XLSX spreadsheet, worksheet
|
34
37
|
[**edit_document_xlsx_get_rows_and_cells**](EditDocumentApi.md#edit_document_xlsx_get_rows_and_cells) | **POST** /convert/edit/xlsx/get-rows-and-cells | Get rows and cells from a Word XLSX spreadsheet, worksheet
|
@@ -145,6 +148,60 @@ Name | Type | Description | Notes
|
|
145
148
|
|
146
149
|
|
147
150
|
|
151
|
+
# **edit_document_docx_create_blank_document**
|
152
|
+
> CreateBlankDocxResponse edit_document_docx_create_blank_document(input)
|
153
|
+
|
154
|
+
Create a blank Word DOCX document
|
155
|
+
|
156
|
+
Returns a blank Word DOCX Document format file
|
157
|
+
|
158
|
+
### Example
|
159
|
+
```ruby
|
160
|
+
# load the gem
|
161
|
+
require 'cloudmersive-convert-api-client'
|
162
|
+
# setup authorization
|
163
|
+
CloudmersiveConvertApiClient.configure do |config|
|
164
|
+
# Configure API key authorization: Apikey
|
165
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
166
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
167
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
168
|
+
end
|
169
|
+
|
170
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
171
|
+
|
172
|
+
input = CloudmersiveConvertApiClient::CreateBlankDocxRequest.new # CreateBlankDocxRequest | Document input request
|
173
|
+
|
174
|
+
|
175
|
+
begin
|
176
|
+
#Create a blank Word DOCX document
|
177
|
+
result = api_instance.edit_document_docx_create_blank_document(input)
|
178
|
+
p result
|
179
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
180
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_create_blank_document: #{e}"
|
181
|
+
end
|
182
|
+
```
|
183
|
+
|
184
|
+
### Parameters
|
185
|
+
|
186
|
+
Name | Type | Description | Notes
|
187
|
+
------------- | ------------- | ------------- | -------------
|
188
|
+
**input** | [**CreateBlankDocxRequest**](CreateBlankDocxRequest.md)| Document input request |
|
189
|
+
|
190
|
+
### Return type
|
191
|
+
|
192
|
+
[**CreateBlankDocxResponse**](CreateBlankDocxResponse.md)
|
193
|
+
|
194
|
+
### Authorization
|
195
|
+
|
196
|
+
[Apikey](../README.md#Apikey)
|
197
|
+
|
198
|
+
### HTTP request headers
|
199
|
+
|
200
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
201
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
202
|
+
|
203
|
+
|
204
|
+
|
148
205
|
# **edit_document_docx_delete_pages**
|
149
206
|
> String edit_document_docx_delete_pages(req_config)
|
150
207
|
|
@@ -1225,6 +1282,60 @@ Name | Type | Description | Notes
|
|
1225
1282
|
|
1226
1283
|
|
1227
1284
|
|
1285
|
+
# **edit_document_docx_update_table_cell**
|
1286
|
+
> UpdateDocxTableCellResponse edit_document_docx_update_table_cell(req_config)
|
1287
|
+
|
1288
|
+
Update, set contents of a table cell in an existing table in a Word DOCX document
|
1289
|
+
|
1290
|
+
Sets the contents of a table cell into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation.
|
1291
|
+
|
1292
|
+
### Example
|
1293
|
+
```ruby
|
1294
|
+
# load the gem
|
1295
|
+
require 'cloudmersive-convert-api-client'
|
1296
|
+
# setup authorization
|
1297
|
+
CloudmersiveConvertApiClient.configure do |config|
|
1298
|
+
# Configure API key authorization: Apikey
|
1299
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
1300
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1301
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
1302
|
+
end
|
1303
|
+
|
1304
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
1305
|
+
|
1306
|
+
req_config = CloudmersiveConvertApiClient::UpdateDocxTableCellRequest.new # UpdateDocxTableCellRequest | Document input request
|
1307
|
+
|
1308
|
+
|
1309
|
+
begin
|
1310
|
+
#Update, set contents of a table cell in an existing table in a Word DOCX document
|
1311
|
+
result = api_instance.edit_document_docx_update_table_cell(req_config)
|
1312
|
+
p result
|
1313
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
1314
|
+
puts "Exception when calling EditDocumentApi->edit_document_docx_update_table_cell: #{e}"
|
1315
|
+
end
|
1316
|
+
```
|
1317
|
+
|
1318
|
+
### Parameters
|
1319
|
+
|
1320
|
+
Name | Type | Description | Notes
|
1321
|
+
------------- | ------------- | ------------- | -------------
|
1322
|
+
**req_config** | [**UpdateDocxTableCellRequest**](UpdateDocxTableCellRequest.md)| Document input request |
|
1323
|
+
|
1324
|
+
### Return type
|
1325
|
+
|
1326
|
+
[**UpdateDocxTableCellResponse**](UpdateDocxTableCellResponse.md)
|
1327
|
+
|
1328
|
+
### Authorization
|
1329
|
+
|
1330
|
+
[Apikey](../README.md#Apikey)
|
1331
|
+
|
1332
|
+
### HTTP request headers
|
1333
|
+
|
1334
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
1335
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
1336
|
+
|
1337
|
+
|
1338
|
+
|
1228
1339
|
# **edit_document_docx_update_table_row**
|
1229
1340
|
> UpdateDocxTableRowResponse edit_document_docx_update_table_row(req_config)
|
1230
1341
|
|
@@ -1387,6 +1498,60 @@ Name | Type | Description | Notes
|
|
1387
1498
|
|
1388
1499
|
|
1389
1500
|
|
1501
|
+
# **edit_document_xlsx_create_blank_spreadsheet**
|
1502
|
+
> CreateBlankSpreadsheetResponse edit_document_xlsx_create_blank_spreadsheet(input)
|
1503
|
+
|
1504
|
+
Create a blank Excel XLSX spreadsheet
|
1505
|
+
|
1506
|
+
Returns a blank Excel XLSX Spreadsheet (XLSX) format file
|
1507
|
+
|
1508
|
+
### Example
|
1509
|
+
```ruby
|
1510
|
+
# load the gem
|
1511
|
+
require 'cloudmersive-convert-api-client'
|
1512
|
+
# setup authorization
|
1513
|
+
CloudmersiveConvertApiClient.configure do |config|
|
1514
|
+
# Configure API key authorization: Apikey
|
1515
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
1516
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1517
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
1518
|
+
end
|
1519
|
+
|
1520
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
1521
|
+
|
1522
|
+
input = CloudmersiveConvertApiClient::CreateBlankSpreadsheetRequest.new # CreateBlankSpreadsheetRequest | Document input request
|
1523
|
+
|
1524
|
+
|
1525
|
+
begin
|
1526
|
+
#Create a blank Excel XLSX spreadsheet
|
1527
|
+
result = api_instance.edit_document_xlsx_create_blank_spreadsheet(input)
|
1528
|
+
p result
|
1529
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
1530
|
+
puts "Exception when calling EditDocumentApi->edit_document_xlsx_create_blank_spreadsheet: #{e}"
|
1531
|
+
end
|
1532
|
+
```
|
1533
|
+
|
1534
|
+
### Parameters
|
1535
|
+
|
1536
|
+
Name | Type | Description | Notes
|
1537
|
+
------------- | ------------- | ------------- | -------------
|
1538
|
+
**input** | [**CreateBlankSpreadsheetRequest**](CreateBlankSpreadsheetRequest.md)| Document input request |
|
1539
|
+
|
1540
|
+
### Return type
|
1541
|
+
|
1542
|
+
[**CreateBlankSpreadsheetResponse**](CreateBlankSpreadsheetResponse.md)
|
1543
|
+
|
1544
|
+
### Authorization
|
1545
|
+
|
1546
|
+
[Apikey](../README.md#Apikey)
|
1547
|
+
|
1548
|
+
### HTTP request headers
|
1549
|
+
|
1550
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
1551
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
1552
|
+
|
1553
|
+
|
1554
|
+
|
1390
1555
|
# **edit_document_xlsx_get_columns**
|
1391
1556
|
> GetXlsxColumnsResponse edit_document_xlsx_get_columns(input)
|
1392
1557
|
|
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
|
7
|
-
**worksheets** | [**Array<XlsxWorksheet>**](XlsxWorksheet.md) |
|
7
|
+
**worksheets** | [**Array<XlsxWorksheet>**](XlsxWorksheet.md) | Worksheets in the Excel XLSX spreadsheet | [optional]
|
8
8
|
|
9
9
|
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::UpdateDocxTableCellRequest
|
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
|
+
**cell_to_update** | [**DocxTableCell**](DocxTableCell.md) | Table cell contents you would like to update the cell with | [optional]
|
9
|
+
**table_row_index** | **Integer** | 0-based index of the Table Row to update | [optional]
|
10
|
+
**table_cell_index** | **Integer** | 0-based index of the Table Cell (within the row) to update | [optional]
|
11
|
+
**existing_table_path** | **String** | Required; the path to the existing table to modify | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::UpdateDocxTableCellResponse
|
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
|
+
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
**input_file_bytes** | **String** | Optional: Bytes of the input file to operate on | [optional]
|
7
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
8
|
**row_to_update** | [**DocxTableRow**](DocxTableRow.md) | Table row contents you would like to update the row with | [optional]
|
9
|
-
**
|
9
|
+
**table_row_index** | **Integer** | 0-based index of the Table Row to update | [optional]
|
10
10
|
**existing_table_path** | **String** | Required; the path to the existing table to modify | [optional]
|
11
11
|
|
12
12
|
|
@@ -22,6 +22,10 @@ require 'cloudmersive-convert-api-client/models/autodetect_document_validation_r
|
|
22
22
|
require 'cloudmersive-convert-api-client/models/autodetect_get_info_result'
|
23
23
|
require 'cloudmersive-convert-api-client/models/autodetect_to_png_result'
|
24
24
|
require 'cloudmersive-convert-api-client/models/converted_png_page'
|
25
|
+
require 'cloudmersive-convert-api-client/models/create_blank_docx_request'
|
26
|
+
require 'cloudmersive-convert-api-client/models/create_blank_docx_response'
|
27
|
+
require 'cloudmersive-convert-api-client/models/create_blank_spreadsheet_request'
|
28
|
+
require 'cloudmersive-convert-api-client/models/create_blank_spreadsheet_response'
|
25
29
|
require 'cloudmersive-convert-api-client/models/delete_docx_table_row_request'
|
26
30
|
require 'cloudmersive-convert-api-client/models/delete_docx_table_row_response'
|
27
31
|
require 'cloudmersive-convert-api-client/models/document_validation_error'
|
@@ -117,6 +121,8 @@ require 'cloudmersive-convert-api-client/models/set_pdf_metadata_request'
|
|
117
121
|
require 'cloudmersive-convert-api-client/models/split_pdf_result'
|
118
122
|
require 'cloudmersive-convert-api-client/models/split_xlsx_worksheet_result'
|
119
123
|
require 'cloudmersive-convert-api-client/models/text_conversion_result'
|
124
|
+
require 'cloudmersive-convert-api-client/models/update_docx_table_cell_request'
|
125
|
+
require 'cloudmersive-convert-api-client/models/update_docx_table_cell_response'
|
120
126
|
require 'cloudmersive-convert-api-client/models/update_docx_table_row_request'
|
121
127
|
require 'cloudmersive-convert-api-client/models/update_docx_table_row_response'
|
122
128
|
require 'cloudmersive-convert-api-client/models/viewer_response'
|
@@ -131,6 +131,61 @@ module CloudmersiveConvertApiClient
|
|
131
131
|
return data, status_code, headers
|
132
132
|
end
|
133
133
|
|
134
|
+
# Create a blank Word DOCX document
|
135
|
+
# Returns a blank Word DOCX Document format file
|
136
|
+
# @param input Document input request
|
137
|
+
# @param [Hash] opts the optional parameters
|
138
|
+
# @return [CreateBlankDocxResponse]
|
139
|
+
def edit_document_docx_create_blank_document(input, opts = {})
|
140
|
+
data, _status_code, _headers = edit_document_docx_create_blank_document_with_http_info(input, opts)
|
141
|
+
return data
|
142
|
+
end
|
143
|
+
|
144
|
+
# Create a blank Word DOCX document
|
145
|
+
# Returns a blank Word DOCX Document format file
|
146
|
+
# @param input Document input request
|
147
|
+
# @param [Hash] opts the optional parameters
|
148
|
+
# @return [Array<(CreateBlankDocxResponse, Fixnum, Hash)>] CreateBlankDocxResponse data, response status code and response headers
|
149
|
+
def edit_document_docx_create_blank_document_with_http_info(input, opts = {})
|
150
|
+
if @api_client.config.debugging
|
151
|
+
@api_client.config.logger.debug "Calling API: EditDocumentApi.edit_document_docx_create_blank_document ..."
|
152
|
+
end
|
153
|
+
# verify the required parameter 'input' is set
|
154
|
+
if @api_client.config.client_side_validation && input.nil?
|
155
|
+
fail ArgumentError, "Missing the required parameter 'input' when calling EditDocumentApi.edit_document_docx_create_blank_document"
|
156
|
+
end
|
157
|
+
# resource path
|
158
|
+
local_var_path = "/convert/edit/docx/create/blank"
|
159
|
+
|
160
|
+
# query parameters
|
161
|
+
query_params = {}
|
162
|
+
|
163
|
+
# header parameters
|
164
|
+
header_params = {}
|
165
|
+
# HTTP header 'Accept' (if needed)
|
166
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
167
|
+
# HTTP header 'Content-Type'
|
168
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
169
|
+
|
170
|
+
# form parameters
|
171
|
+
form_params = {}
|
172
|
+
|
173
|
+
# http body (model)
|
174
|
+
post_body = @api_client.object_to_http_body(input)
|
175
|
+
auth_names = ['Apikey']
|
176
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
177
|
+
:header_params => header_params,
|
178
|
+
:query_params => query_params,
|
179
|
+
:form_params => form_params,
|
180
|
+
:body => post_body,
|
181
|
+
:auth_names => auth_names,
|
182
|
+
:return_type => 'CreateBlankDocxResponse')
|
183
|
+
if @api_client.config.debugging
|
184
|
+
@api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_create_blank_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
185
|
+
end
|
186
|
+
return data, status_code, headers
|
187
|
+
end
|
188
|
+
|
134
189
|
# Delete, remove pages from a Word DOCX document
|
135
190
|
# Returns the pages and contents of each page defined in the Word Document (DOCX) format file
|
136
191
|
# @param req_config Document input request
|
@@ -1231,6 +1286,61 @@ module CloudmersiveConvertApiClient
|
|
1231
1286
|
return data, status_code, headers
|
1232
1287
|
end
|
1233
1288
|
|
1289
|
+
# Update, set contents of a table cell in an existing table in a Word DOCX document
|
1290
|
+
# Sets the contents of a table cell into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation.
|
1291
|
+
# @param req_config Document input request
|
1292
|
+
# @param [Hash] opts the optional parameters
|
1293
|
+
# @return [UpdateDocxTableCellResponse]
|
1294
|
+
def edit_document_docx_update_table_cell(req_config, opts = {})
|
1295
|
+
data, _status_code, _headers = edit_document_docx_update_table_cell_with_http_info(req_config, opts)
|
1296
|
+
return data
|
1297
|
+
end
|
1298
|
+
|
1299
|
+
# Update, set contents of a table cell in an existing table in a Word DOCX document
|
1300
|
+
# Sets the contents of a table cell into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation.
|
1301
|
+
# @param req_config Document input request
|
1302
|
+
# @param [Hash] opts the optional parameters
|
1303
|
+
# @return [Array<(UpdateDocxTableCellResponse, Fixnum, Hash)>] UpdateDocxTableCellResponse data, response status code and response headers
|
1304
|
+
def edit_document_docx_update_table_cell_with_http_info(req_config, opts = {})
|
1305
|
+
if @api_client.config.debugging
|
1306
|
+
@api_client.config.logger.debug "Calling API: EditDocumentApi.edit_document_docx_update_table_cell ..."
|
1307
|
+
end
|
1308
|
+
# verify the required parameter 'req_config' is set
|
1309
|
+
if @api_client.config.client_side_validation && req_config.nil?
|
1310
|
+
fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_update_table_cell"
|
1311
|
+
end
|
1312
|
+
# resource path
|
1313
|
+
local_var_path = "/convert/edit/docx/update-table-cell"
|
1314
|
+
|
1315
|
+
# query parameters
|
1316
|
+
query_params = {}
|
1317
|
+
|
1318
|
+
# header parameters
|
1319
|
+
header_params = {}
|
1320
|
+
# HTTP header 'Accept' (if needed)
|
1321
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
1322
|
+
# HTTP header 'Content-Type'
|
1323
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
1324
|
+
|
1325
|
+
# form parameters
|
1326
|
+
form_params = {}
|
1327
|
+
|
1328
|
+
# http body (model)
|
1329
|
+
post_body = @api_client.object_to_http_body(req_config)
|
1330
|
+
auth_names = ['Apikey']
|
1331
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1332
|
+
:header_params => header_params,
|
1333
|
+
:query_params => query_params,
|
1334
|
+
:form_params => form_params,
|
1335
|
+
:body => post_body,
|
1336
|
+
:auth_names => auth_names,
|
1337
|
+
:return_type => 'UpdateDocxTableCellResponse')
|
1338
|
+
if @api_client.config.debugging
|
1339
|
+
@api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_update_table_cell\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1340
|
+
end
|
1341
|
+
return data, status_code, headers
|
1342
|
+
end
|
1343
|
+
|
1234
1344
|
# Update, set contents of a table row in an existing table in a Word DOCX document
|
1235
1345
|
# Sets the contents of a table row into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation.
|
1236
1346
|
# @param req_config Document input request
|
@@ -1396,6 +1506,61 @@ module CloudmersiveConvertApiClient
|
|
1396
1506
|
return data, status_code, headers
|
1397
1507
|
end
|
1398
1508
|
|
1509
|
+
# Create a blank Excel XLSX spreadsheet
|
1510
|
+
# Returns a blank Excel XLSX Spreadsheet (XLSX) format file
|
1511
|
+
# @param input Document input request
|
1512
|
+
# @param [Hash] opts the optional parameters
|
1513
|
+
# @return [CreateBlankSpreadsheetResponse]
|
1514
|
+
def edit_document_xlsx_create_blank_spreadsheet(input, opts = {})
|
1515
|
+
data, _status_code, _headers = edit_document_xlsx_create_blank_spreadsheet_with_http_info(input, opts)
|
1516
|
+
return data
|
1517
|
+
end
|
1518
|
+
|
1519
|
+
# Create a blank Excel XLSX spreadsheet
|
1520
|
+
# Returns a blank Excel XLSX Spreadsheet (XLSX) format file
|
1521
|
+
# @param input Document input request
|
1522
|
+
# @param [Hash] opts the optional parameters
|
1523
|
+
# @return [Array<(CreateBlankSpreadsheetResponse, Fixnum, Hash)>] CreateBlankSpreadsheetResponse data, response status code and response headers
|
1524
|
+
def edit_document_xlsx_create_blank_spreadsheet_with_http_info(input, opts = {})
|
1525
|
+
if @api_client.config.debugging
|
1526
|
+
@api_client.config.logger.debug "Calling API: EditDocumentApi.edit_document_xlsx_create_blank_spreadsheet ..."
|
1527
|
+
end
|
1528
|
+
# verify the required parameter 'input' is set
|
1529
|
+
if @api_client.config.client_side_validation && input.nil?
|
1530
|
+
fail ArgumentError, "Missing the required parameter 'input' when calling EditDocumentApi.edit_document_xlsx_create_blank_spreadsheet"
|
1531
|
+
end
|
1532
|
+
# resource path
|
1533
|
+
local_var_path = "/convert/edit/xlsx/create/blank"
|
1534
|
+
|
1535
|
+
# query parameters
|
1536
|
+
query_params = {}
|
1537
|
+
|
1538
|
+
# header parameters
|
1539
|
+
header_params = {}
|
1540
|
+
# HTTP header 'Accept' (if needed)
|
1541
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
1542
|
+
# HTTP header 'Content-Type'
|
1543
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
1544
|
+
|
1545
|
+
# form parameters
|
1546
|
+
form_params = {}
|
1547
|
+
|
1548
|
+
# http body (model)
|
1549
|
+
post_body = @api_client.object_to_http_body(input)
|
1550
|
+
auth_names = ['Apikey']
|
1551
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1552
|
+
:header_params => header_params,
|
1553
|
+
:query_params => query_params,
|
1554
|
+
:form_params => form_params,
|
1555
|
+
:body => post_body,
|
1556
|
+
:auth_names => auth_names,
|
1557
|
+
:return_type => 'CreateBlankSpreadsheetResponse')
|
1558
|
+
if @api_client.config.debugging
|
1559
|
+
@api_client.config.logger.debug "API called: EditDocumentApi#edit_document_xlsx_create_blank_spreadsheet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1560
|
+
end
|
1561
|
+
return data, status_code, headers
|
1562
|
+
end
|
1563
|
+
|
1399
1564
|
# Get rows and cells from a Excel XLSX spreadsheet, worksheet
|
1400
1565
|
# Returns the rows and cells defined in the Excel Spreadsheet worksheet
|
1401
1566
|
# @param input Document input request
|