cloudmersive-convert-api-client 1.6.1 → 1.6.2

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6df52bbc6ee4997168e1d878f87585ce521423c676e1cffe8884a58357230db8
4
- data.tar.gz: '039cbb039e9a565d3f172c9700e2d39a8a4d6fa1be0c52b71233bbd09d2b8e5f'
3
+ metadata.gz: b30c48f88af80c84d8893c402e548b8a519596278dc44878576468d46379cc8d
4
+ data.tar.gz: 0203e72091ab09cb590f8b3cfc4d2c6a7efe96182c7e4aabf0a00457fc5a0f66
5
5
  SHA512:
6
- metadata.gz: fff288045314be9ffde4b796f7521589f5838eef7586dc539a29827df999497dc4e27f4620f433e6c6968daf5f533d0224f49f6080f2dc59040898e055a2fb62
7
- data.tar.gz: 57a07834e9ab99bf8e0cadc7f4f5aaa0c92660ca823159ad116b1714f29abf5ff5fd18e05b548490dd801f15be94163e95b9c0d39f3c813df299e872951977e4
6
+ metadata.gz: 4da37c1b5ef1e2993504ad04016fe7b2257c77ea64cbe8527d0f49b7bf9d73b2376eb6eca17a6a25efb975a49135b8f9a10656475dbdaada50e8ed1e543acdab
7
+ data.tar.gz: 2337e002e016087c30681da6a015ec4c34c056eec53cd8a678af64dc309ba71f83711c97782eab52d08a41bb503648b6cdd43dc1ce2416ffb7a25b5ea98009ea
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.6.1
10
+ - Package version: 1.6.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.6.1.gem
26
+ gem install ./cloudmersive-convert-api-client-1.6.2.gem
27
27
  ```
28
- (for development, run `gem install --dev ./cloudmersive-convert-api-client-1.6.1.gem` to install the development dependencies)
28
+ (for development, run `gem install --dev ./cloudmersive-convert-api-client-1.6.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.6.1'
34
+ gem 'cloudmersive-convert-api-client', '~> 1.6.2'
35
35
 
36
36
  ### Install from Git
37
37
 
@@ -172,8 +172,10 @@ Class | Method | HTTP request | Description
172
172
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_finish_editing**](docs/EditDocumentApi.md#edit_document_finish_editing) | **POST** /convert/edit/finish-editing | Download result from document editing
173
173
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_pptx_delete_slides**](docs/EditDocumentApi.md#edit_document_pptx_delete_slides) | **POST** /convert/edit/pptx/delete-slides | Delete, remove slides from a PowerPoint PPTX presentation document
174
174
  *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
175
+ *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_clear_cell_by_index**](docs/EditDocumentApi.md#edit_document_xlsx_clear_cell_by_index) | **POST** /convert/edit/xlsx/clear-cell/by-index | Clear cell contents in an Excel XLSX spreadsheet, worksheet by index
175
176
  *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
176
177
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_create_spreadsheet_from_data**](docs/EditDocumentApi.md#edit_document_xlsx_create_spreadsheet_from_data) | **POST** /convert/edit/xlsx/create/from/data | Create a new Excel XLSX spreadsheet from column and row data
178
+ *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_delete_worksheet**](docs/EditDocumentApi.md#edit_document_xlsx_delete_worksheet) | **POST** /convert/edit/xlsx/delete-worksheet | Delete, remove worksheet from an Excel XLSX spreadsheet document
177
179
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_cell_by_index**](docs/EditDocumentApi.md#edit_document_xlsx_get_cell_by_index) | **POST** /convert/edit/xlsx/get-cell/by-index | Get cell from an Excel XLSX spreadsheet, worksheet by index
178
180
  *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
179
181
  *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
@@ -181,6 +183,7 @@ Class | Method | HTTP request | Description
181
183
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_styles**](docs/EditDocumentApi.md#edit_document_xlsx_get_styles) | **POST** /convert/edit/xlsx/get-styles | Get styles from a Excel XLSX spreadsheet, worksheet
182
184
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_worksheets**](docs/EditDocumentApi.md#edit_document_xlsx_get_worksheets) | **POST** /convert/edit/xlsx/get-worksheets | Get worksheets from a Excel XLSX spreadsheet
183
185
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_insert_worksheet**](docs/EditDocumentApi.md#edit_document_xlsx_insert_worksheet) | **POST** /convert/edit/xlsx/insert-worksheet | Insert a new worksheet into an Excel XLSX spreadsheet
186
+ *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_set_cell_by_index**](docs/EditDocumentApi.md#edit_document_xlsx_set_cell_by_index) | **POST** /convert/edit/xlsx/set-cell/by-index | Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index
184
187
  *CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_add_annotations**](docs/EditPdfApi.md#edit_pdf_add_annotations) | **POST** /convert/edit/pdf/annotations/add-item | Add one or more PDF annotations, comments in the PDF document
185
188
  *CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_decrypt**](docs/EditPdfApi.md#edit_pdf_decrypt) | **POST** /convert/edit/pdf/decrypt | Decrypt and password-protect a PDF
186
189
  *CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_delete_pages**](docs/EditPdfApi.md#edit_pdf_delete_pages) | **POST** /convert/edit/pdf/pages/delete | Remove / delete pages from a PDF document
@@ -230,6 +233,8 @@ Class | Method | HTTP request | Description
230
233
  - [CloudmersiveConvertApiClient::AutodetectDocumentValidationResult](docs/AutodetectDocumentValidationResult.md)
231
234
  - [CloudmersiveConvertApiClient::AutodetectGetInfoResult](docs/AutodetectGetInfoResult.md)
232
235
  - [CloudmersiveConvertApiClient::AutodetectToPngResult](docs/AutodetectToPngResult.md)
236
+ - [CloudmersiveConvertApiClient::ClearXlsxCellRequest](docs/ClearXlsxCellRequest.md)
237
+ - [CloudmersiveConvertApiClient::ClearXlsxCellResponse](docs/ClearXlsxCellResponse.md)
233
238
  - [CloudmersiveConvertApiClient::ConvertedPngPage](docs/ConvertedPngPage.md)
234
239
  - [CloudmersiveConvertApiClient::CreateBlankDocxRequest](docs/CreateBlankDocxRequest.md)
235
240
  - [CloudmersiveConvertApiClient::CreateBlankDocxResponse](docs/CreateBlankDocxResponse.md)
@@ -332,11 +337,14 @@ Class | Method | HTTP request | Description
332
337
  - [CloudmersiveConvertApiClient::RemoveDocxHeadersAndFootersResponse](docs/RemoveDocxHeadersAndFootersResponse.md)
333
338
  - [CloudmersiveConvertApiClient::RemoveDocxPagesRequest](docs/RemoveDocxPagesRequest.md)
334
339
  - [CloudmersiveConvertApiClient::RemovePptxSlidesRequest](docs/RemovePptxSlidesRequest.md)
340
+ - [CloudmersiveConvertApiClient::RemoveXlsxWorksheetRequest](docs/RemoveXlsxWorksheetRequest.md)
335
341
  - [CloudmersiveConvertApiClient::ReplaceStringRequest](docs/ReplaceStringRequest.md)
336
342
  - [CloudmersiveConvertApiClient::ScreenshotRequest](docs/ScreenshotRequest.md)
337
343
  - [CloudmersiveConvertApiClient::SetFormFieldValue](docs/SetFormFieldValue.md)
338
344
  - [CloudmersiveConvertApiClient::SetPdfFormFieldsRequest](docs/SetPdfFormFieldsRequest.md)
339
345
  - [CloudmersiveConvertApiClient::SetPdfMetadataRequest](docs/SetPdfMetadataRequest.md)
346
+ - [CloudmersiveConvertApiClient::SetXlsxCellRequest](docs/SetXlsxCellRequest.md)
347
+ - [CloudmersiveConvertApiClient::SetXlsxCellResponse](docs/SetXlsxCellResponse.md)
340
348
  - [CloudmersiveConvertApiClient::SplitDocumentResult](docs/SplitDocumentResult.md)
341
349
  - [CloudmersiveConvertApiClient::SplitDocxDocumentResult](docs/SplitDocxDocumentResult.md)
342
350
  - [CloudmersiveConvertApiClient::SplitPdfResult](docs/SplitPdfResult.md)
@@ -0,0 +1,12 @@
1
+ # CloudmersiveConvertApiClient::ClearXlsxCellRequest
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
+ **worksheet_to_update** | [**XlsxWorksheet**](XlsxWorksheet.md) | Optional; Worksheet (tab) within the spreadsheet to update; leave blank to default to the first worksheet | [optional]
9
+ **row_index** | **Integer** | 0-based index of the row, 0, 1, 2, ... to clear | [optional]
10
+ **cell_index** | **Integer** | 0-based index of the cell, 0, 1, 2, ... in the row to clear | [optional]
11
+
12
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::ClearXlsxCellResponse
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
+
@@ -202,7 +202,7 @@ Name | Type | Description | Notes
202
202
 
203
203
  Convert Document to Text (txt)
204
204
 
205
- Automatically detect file type and convert it to Text. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT) and PDF files.
205
+ Automatically detect file type and convert it to Text. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT) and PDF files. For spreadsheets, all worksheets will be included. If you wish to exclude certain pages, worksheets, slides, etc. use the Split document API first, or the delete pages/slides/worksheet APIs first to adjust the document to the target state prior to converting to text.
206
206
 
207
207
  ### Example
208
208
  ```ruby
@@ -1577,7 +1577,7 @@ Name | Type | Description | Notes
1577
1577
 
1578
1578
  Convert Excel XLSX Spreadsheet to Text (txt)
1579
1579
 
1580
- Convert Office Excel Workbooks (XLSX) to standard Text. Converts all worksheets in the workbook to Text. Supports both XLSX and XLSB file formats.
1580
+ Convert Office Excel Workbooks (XLSX) to standard Text. Converts all worksheets in the workbook to Text. Supports both XLSX and XLSB file formats. When a spreadsheet contains multiple worksheets, will export all of the text from all of the worksheets. If you wish to export the text from only one worksheet, try using the Split XLSX API to split the spreadsheet into multiple worksheet files, and then run XLSX to Text on the individual worksheet file that you need to extract the text from.
1581
1581
 
1582
1582
  ### Example
1583
1583
  ```ruby
@@ -32,8 +32,10 @@ Method | HTTP request | Description
32
32
  [**edit_document_finish_editing**](EditDocumentApi.md#edit_document_finish_editing) | **POST** /convert/edit/finish-editing | Download result from document editing
33
33
  [**edit_document_pptx_delete_slides**](EditDocumentApi.md#edit_document_pptx_delete_slides) | **POST** /convert/edit/pptx/delete-slides | Delete, remove slides from a PowerPoint PPTX presentation document
34
34
  [**edit_document_pptx_replace**](EditDocumentApi.md#edit_document_pptx_replace) | **POST** /convert/edit/pptx/replace-all | Replace string in PowerPoint PPTX presentation
35
+ [**edit_document_xlsx_clear_cell_by_index**](EditDocumentApi.md#edit_document_xlsx_clear_cell_by_index) | **POST** /convert/edit/xlsx/clear-cell/by-index | Clear cell contents in an Excel XLSX spreadsheet, worksheet by index
35
36
  [**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
36
37
  [**edit_document_xlsx_create_spreadsheet_from_data**](EditDocumentApi.md#edit_document_xlsx_create_spreadsheet_from_data) | **POST** /convert/edit/xlsx/create/from/data | Create a new Excel XLSX spreadsheet from column and row data
38
+ [**edit_document_xlsx_delete_worksheet**](EditDocumentApi.md#edit_document_xlsx_delete_worksheet) | **POST** /convert/edit/xlsx/delete-worksheet | Delete, remove worksheet from an Excel XLSX spreadsheet document
37
39
  [**edit_document_xlsx_get_cell_by_index**](EditDocumentApi.md#edit_document_xlsx_get_cell_by_index) | **POST** /convert/edit/xlsx/get-cell/by-index | Get cell from an Excel XLSX spreadsheet, worksheet by index
38
40
  [**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
39
41
  [**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
@@ -41,6 +43,7 @@ Method | HTTP request | Description
41
43
  [**edit_document_xlsx_get_styles**](EditDocumentApi.md#edit_document_xlsx_get_styles) | **POST** /convert/edit/xlsx/get-styles | Get styles from a Excel XLSX spreadsheet, worksheet
42
44
  [**edit_document_xlsx_get_worksheets**](EditDocumentApi.md#edit_document_xlsx_get_worksheets) | **POST** /convert/edit/xlsx/get-worksheets | Get worksheets from a Excel XLSX spreadsheet
43
45
  [**edit_document_xlsx_insert_worksheet**](EditDocumentApi.md#edit_document_xlsx_insert_worksheet) | **POST** /convert/edit/xlsx/insert-worksheet | Insert a new worksheet into an Excel XLSX spreadsheet
46
+ [**edit_document_xlsx_set_cell_by_index**](EditDocumentApi.md#edit_document_xlsx_set_cell_by_index) | **POST** /convert/edit/xlsx/set-cell/by-index | Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index
44
47
 
45
48
 
46
49
  # **edit_document_begin_editing**
@@ -1555,6 +1558,60 @@ Name | Type | Description | Notes
1555
1558
 
1556
1559
 
1557
1560
 
1561
+ # **edit_document_xlsx_clear_cell_by_index**
1562
+ > ClearXlsxCellResponse edit_document_xlsx_clear_cell_by_index(input)
1563
+
1564
+ Clear cell contents in an Excel XLSX spreadsheet, worksheet by index
1565
+
1566
+ Clears, sets to blank, the contents of a specific cell in an Excel XLSX spreadsheet, worksheet
1567
+
1568
+ ### Example
1569
+ ```ruby
1570
+ # load the gem
1571
+ require 'cloudmersive-convert-api-client'
1572
+ # setup authorization
1573
+ CloudmersiveConvertApiClient.configure do |config|
1574
+ # Configure API key authorization: Apikey
1575
+ config.api_key['Apikey'] = 'YOUR API KEY'
1576
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1577
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1578
+ end
1579
+
1580
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
1581
+
1582
+ input = CloudmersiveConvertApiClient::ClearXlsxCellRequest.new # ClearXlsxCellRequest | Document input request
1583
+
1584
+
1585
+ begin
1586
+ #Clear cell contents in an Excel XLSX spreadsheet, worksheet by index
1587
+ result = api_instance.edit_document_xlsx_clear_cell_by_index(input)
1588
+ p result
1589
+ rescue CloudmersiveConvertApiClient::ApiError => e
1590
+ puts "Exception when calling EditDocumentApi->edit_document_xlsx_clear_cell_by_index: #{e}"
1591
+ end
1592
+ ```
1593
+
1594
+ ### Parameters
1595
+
1596
+ Name | Type | Description | Notes
1597
+ ------------- | ------------- | ------------- | -------------
1598
+ **input** | [**ClearXlsxCellRequest**](ClearXlsxCellRequest.md)| Document input request |
1599
+
1600
+ ### Return type
1601
+
1602
+ [**ClearXlsxCellResponse**](ClearXlsxCellResponse.md)
1603
+
1604
+ ### Authorization
1605
+
1606
+ [Apikey](../README.md#Apikey)
1607
+
1608
+ ### HTTP request headers
1609
+
1610
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
1611
+ - **Accept**: application/json, text/json, application/xml, text/xml
1612
+
1613
+
1614
+
1558
1615
  # **edit_document_xlsx_create_blank_spreadsheet**
1559
1616
  > CreateBlankSpreadsheetResponse edit_document_xlsx_create_blank_spreadsheet(input)
1560
1617
 
@@ -1663,6 +1720,60 @@ Name | Type | Description | Notes
1663
1720
 
1664
1721
 
1665
1722
 
1723
+ # **edit_document_xlsx_delete_worksheet**
1724
+ > Object edit_document_xlsx_delete_worksheet(req_config)
1725
+
1726
+ Delete, remove worksheet from an Excel XLSX spreadsheet document
1727
+
1728
+ Edits the input Excel XLSX spreadsheet document to remove the specified worksheet (tab). Use the Get Worksheets API to enumerate available worksheets in a spreadsheet.
1729
+
1730
+ ### Example
1731
+ ```ruby
1732
+ # load the gem
1733
+ require 'cloudmersive-convert-api-client'
1734
+ # setup authorization
1735
+ CloudmersiveConvertApiClient.configure do |config|
1736
+ # Configure API key authorization: Apikey
1737
+ config.api_key['Apikey'] = 'YOUR API KEY'
1738
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1739
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1740
+ end
1741
+
1742
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
1743
+
1744
+ req_config = CloudmersiveConvertApiClient::RemoveXlsxWorksheetRequest.new # RemoveXlsxWorksheetRequest | Spreadsheet input request
1745
+
1746
+
1747
+ begin
1748
+ #Delete, remove worksheet from an Excel XLSX spreadsheet document
1749
+ result = api_instance.edit_document_xlsx_delete_worksheet(req_config)
1750
+ p result
1751
+ rescue CloudmersiveConvertApiClient::ApiError => e
1752
+ puts "Exception when calling EditDocumentApi->edit_document_xlsx_delete_worksheet: #{e}"
1753
+ end
1754
+ ```
1755
+
1756
+ ### Parameters
1757
+
1758
+ Name | Type | Description | Notes
1759
+ ------------- | ------------- | ------------- | -------------
1760
+ **req_config** | [**RemoveXlsxWorksheetRequest**](RemoveXlsxWorksheetRequest.md)| Spreadsheet input request |
1761
+
1762
+ ### Return type
1763
+
1764
+ **Object**
1765
+
1766
+ ### Authorization
1767
+
1768
+ [Apikey](../README.md#Apikey)
1769
+
1770
+ ### HTTP request headers
1771
+
1772
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
1773
+ - **Accept**: application/octet-stream
1774
+
1775
+
1776
+
1666
1777
  # **edit_document_xlsx_get_cell_by_index**
1667
1778
  > GetXlsxCellResponse edit_document_xlsx_get_cell_by_index(input)
1668
1779
 
@@ -2041,3 +2152,57 @@ Name | Type | Description | Notes
2041
2152
 
2042
2153
 
2043
2154
 
2155
+ # **edit_document_xlsx_set_cell_by_index**
2156
+ > SetXlsxCellResponse edit_document_xlsx_set_cell_by_index(input)
2157
+
2158
+ Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index
2159
+
2160
+ Sets, updates the contents of a specific cell in an Excel XLSX spreadsheet, worksheet
2161
+
2162
+ ### Example
2163
+ ```ruby
2164
+ # load the gem
2165
+ require 'cloudmersive-convert-api-client'
2166
+ # setup authorization
2167
+ CloudmersiveConvertApiClient.configure do |config|
2168
+ # Configure API key authorization: Apikey
2169
+ config.api_key['Apikey'] = 'YOUR API KEY'
2170
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2171
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2172
+ end
2173
+
2174
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
2175
+
2176
+ input = CloudmersiveConvertApiClient::SetXlsxCellRequest.new # SetXlsxCellRequest | Document input request
2177
+
2178
+
2179
+ begin
2180
+ #Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index
2181
+ result = api_instance.edit_document_xlsx_set_cell_by_index(input)
2182
+ p result
2183
+ rescue CloudmersiveConvertApiClient::ApiError => e
2184
+ puts "Exception when calling EditDocumentApi->edit_document_xlsx_set_cell_by_index: #{e}"
2185
+ end
2186
+ ```
2187
+
2188
+ ### Parameters
2189
+
2190
+ Name | Type | Description | Notes
2191
+ ------------- | ------------- | ------------- | -------------
2192
+ **input** | [**SetXlsxCellRequest**](SetXlsxCellRequest.md)| Document input request |
2193
+
2194
+ ### Return type
2195
+
2196
+ [**SetXlsxCellResponse**](SetXlsxCellResponse.md)
2197
+
2198
+ ### Authorization
2199
+
2200
+ [Apikey](../README.md#Apikey)
2201
+
2202
+ ### HTTP request headers
2203
+
2204
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
2205
+ - **Accept**: application/json, text/json, application/xml, text/xml
2206
+
2207
+
2208
+
@@ -0,0 +1,10 @@
1
+ # CloudmersiveConvertApiClient::RemoveXlsxWorksheetRequest
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
+ **worksheet_to_remove** | [**XlsxWorksheet**](XlsxWorksheet.md) | Required; Worksheet (tab) within the spreadsheet to delete; leave blank to default to the first worksheet. Use the Get Worksheets API to enumerate available worksheets in a spreadsheet. | [optional]
9
+
10
+
@@ -0,0 +1,13 @@
1
+ # CloudmersiveConvertApiClient::SetXlsxCellRequest
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
+ **worksheet_to_update** | [**XlsxWorksheet**](XlsxWorksheet.md) | Optional; Worksheet (tab) within the spreadsheet to update; leave blank to default to the first worksheet | [optional]
9
+ **row_index** | **Integer** | 0-based index of the row, 0, 1, 2, ... to set | [optional]
10
+ **cell_index** | **Integer** | 0-based index of the cell, 0, 1, 2, ... in the row to set | [optional]
11
+ **cell_value** | [**XlsxSpreadsheetCell**](XlsxSpreadsheetCell.md) | New Cell value to update/overwrite into the Excel XLSX spreadsheet | [optional]
12
+
13
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::SetXlsxCellResponse
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
+
@@ -22,6 +22,8 @@ require 'cloudmersive-convert-api-client/models/alternate_file_format_candidate'
22
22
  require 'cloudmersive-convert-api-client/models/autodetect_document_validation_result'
23
23
  require 'cloudmersive-convert-api-client/models/autodetect_get_info_result'
24
24
  require 'cloudmersive-convert-api-client/models/autodetect_to_png_result'
25
+ require 'cloudmersive-convert-api-client/models/clear_xlsx_cell_request'
26
+ require 'cloudmersive-convert-api-client/models/clear_xlsx_cell_response'
25
27
  require 'cloudmersive-convert-api-client/models/converted_png_page'
26
28
  require 'cloudmersive-convert-api-client/models/create_blank_docx_request'
27
29
  require 'cloudmersive-convert-api-client/models/create_blank_docx_response'
@@ -124,11 +126,14 @@ require 'cloudmersive-convert-api-client/models/remove_docx_headers_and_footers_
124
126
  require 'cloudmersive-convert-api-client/models/remove_docx_headers_and_footers_response'
125
127
  require 'cloudmersive-convert-api-client/models/remove_docx_pages_request'
126
128
  require 'cloudmersive-convert-api-client/models/remove_pptx_slides_request'
129
+ require 'cloudmersive-convert-api-client/models/remove_xlsx_worksheet_request'
127
130
  require 'cloudmersive-convert-api-client/models/replace_string_request'
128
131
  require 'cloudmersive-convert-api-client/models/screenshot_request'
129
132
  require 'cloudmersive-convert-api-client/models/set_form_field_value'
130
133
  require 'cloudmersive-convert-api-client/models/set_pdf_form_fields_request'
131
134
  require 'cloudmersive-convert-api-client/models/set_pdf_metadata_request'
135
+ require 'cloudmersive-convert-api-client/models/set_xlsx_cell_request'
136
+ require 'cloudmersive-convert-api-client/models/set_xlsx_cell_response'
132
137
  require 'cloudmersive-convert-api-client/models/split_document_result'
133
138
  require 'cloudmersive-convert-api-client/models/split_docx_document_result'
134
139
  require 'cloudmersive-convert-api-client/models/split_pdf_result'
@@ -189,7 +189,7 @@ module CloudmersiveConvertApiClient
189
189
  end
190
190
 
191
191
  # Convert Document to Text (txt)
192
- # Automatically detect file type and convert it to Text. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT) and PDF files.
192
+ # Automatically detect file type and convert it to Text. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT) and PDF files. For spreadsheets, all worksheets will be included. If you wish to exclude certain pages, worksheets, slides, etc. use the Split document API first, or the delete pages/slides/worksheet APIs first to adjust the document to the target state prior to converting to text.
193
193
  # @param input_file Input file to perform the operation on.
194
194
  # @param [Hash] opts the optional parameters
195
195
  # @return [TextConversionResult]
@@ -199,7 +199,7 @@ module CloudmersiveConvertApiClient
199
199
  end
200
200
 
201
201
  # Convert Document to Text (txt)
202
- # Automatically detect file type and convert it to Text. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT) and PDF files.
202
+ # Automatically detect file type and convert it to Text. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT) and PDF files. For spreadsheets, all worksheets will be included. If you wish to exclude certain pages, worksheets, slides, etc. use the Split document API first, or the delete pages/slides/worksheet APIs first to adjust the document to the target state prior to converting to text.
203
203
  # @param input_file Input file to perform the operation on.
204
204
  # @param [Hash] opts the optional parameters
205
205
  # @return [Array<(TextConversionResult, Fixnum, Hash)>] TextConversionResult data, response status code and response headers
@@ -1623,7 +1623,7 @@ module CloudmersiveConvertApiClient
1623
1623
  end
1624
1624
 
1625
1625
  # Convert Excel XLSX Spreadsheet to Text (txt)
1626
- # Convert Office Excel Workbooks (XLSX) to standard Text. Converts all worksheets in the workbook to Text. Supports both XLSX and XLSB file formats.
1626
+ # Convert Office Excel Workbooks (XLSX) to standard Text. Converts all worksheets in the workbook to Text. Supports both XLSX and XLSB file formats. When a spreadsheet contains multiple worksheets, will export all of the text from all of the worksheets. If you wish to export the text from only one worksheet, try using the Split XLSX API to split the spreadsheet into multiple worksheet files, and then run XLSX to Text on the individual worksheet file that you need to extract the text from.
1627
1627
  # @param input_file Input file to perform the operation on.
1628
1628
  # @param [Hash] opts the optional parameters
1629
1629
  # @return [TextConversionResult]
@@ -1633,7 +1633,7 @@ module CloudmersiveConvertApiClient
1633
1633
  end
1634
1634
 
1635
1635
  # Convert Excel XLSX Spreadsheet to Text (txt)
1636
- # Convert Office Excel Workbooks (XLSX) to standard Text. Converts all worksheets in the workbook to Text. Supports both XLSX and XLSB file formats.
1636
+ # Convert Office Excel Workbooks (XLSX) to standard Text. Converts all worksheets in the workbook to Text. Supports both XLSX and XLSB file formats. When a spreadsheet contains multiple worksheets, will export all of the text from all of the worksheets. If you wish to export the text from only one worksheet, try using the Split XLSX API to split the spreadsheet into multiple worksheet files, and then run XLSX to Text on the individual worksheet file that you need to extract the text from.
1637
1637
  # @param input_file Input file to perform the operation on.
1638
1638
  # @param [Hash] opts the optional parameters
1639
1639
  # @return [Array<(TextConversionResult, Fixnum, Hash)>] TextConversionResult data, response status code and response headers
@@ -1561,6 +1561,61 @@ module CloudmersiveConvertApiClient
1561
1561
  return data, status_code, headers
1562
1562
  end
1563
1563
 
1564
+ # Clear cell contents in an Excel XLSX spreadsheet, worksheet by index
1565
+ # Clears, sets to blank, the contents of a specific cell in an Excel XLSX spreadsheet, worksheet
1566
+ # @param input Document input request
1567
+ # @param [Hash] opts the optional parameters
1568
+ # @return [ClearXlsxCellResponse]
1569
+ def edit_document_xlsx_clear_cell_by_index(input, opts = {})
1570
+ data, _status_code, _headers = edit_document_xlsx_clear_cell_by_index_with_http_info(input, opts)
1571
+ return data
1572
+ end
1573
+
1574
+ # Clear cell contents in an Excel XLSX spreadsheet, worksheet by index
1575
+ # Clears, sets to blank, the contents of a specific cell in an Excel XLSX spreadsheet, worksheet
1576
+ # @param input Document input request
1577
+ # @param [Hash] opts the optional parameters
1578
+ # @return [Array<(ClearXlsxCellResponse, Fixnum, Hash)>] ClearXlsxCellResponse data, response status code and response headers
1579
+ def edit_document_xlsx_clear_cell_by_index_with_http_info(input, opts = {})
1580
+ if @api_client.config.debugging
1581
+ @api_client.config.logger.debug "Calling API: EditDocumentApi.edit_document_xlsx_clear_cell_by_index ..."
1582
+ end
1583
+ # verify the required parameter 'input' is set
1584
+ if @api_client.config.client_side_validation && input.nil?
1585
+ fail ArgumentError, "Missing the required parameter 'input' when calling EditDocumentApi.edit_document_xlsx_clear_cell_by_index"
1586
+ end
1587
+ # resource path
1588
+ local_var_path = "/convert/edit/xlsx/clear-cell/by-index"
1589
+
1590
+ # query parameters
1591
+ query_params = {}
1592
+
1593
+ # header parameters
1594
+ header_params = {}
1595
+ # HTTP header 'Accept' (if needed)
1596
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
1597
+ # HTTP header 'Content-Type'
1598
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
1599
+
1600
+ # form parameters
1601
+ form_params = {}
1602
+
1603
+ # http body (model)
1604
+ post_body = @api_client.object_to_http_body(input)
1605
+ auth_names = ['Apikey']
1606
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1607
+ :header_params => header_params,
1608
+ :query_params => query_params,
1609
+ :form_params => form_params,
1610
+ :body => post_body,
1611
+ :auth_names => auth_names,
1612
+ :return_type => 'ClearXlsxCellResponse')
1613
+ if @api_client.config.debugging
1614
+ @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_xlsx_clear_cell_by_index\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1615
+ end
1616
+ return data, status_code, headers
1617
+ end
1618
+
1564
1619
  # Create a blank Excel XLSX spreadsheet
1565
1620
  # Returns a blank Excel XLSX Spreadsheet (XLSX) format file
1566
1621
  # @param input Document input request
@@ -1671,6 +1726,61 @@ module CloudmersiveConvertApiClient
1671
1726
  return data, status_code, headers
1672
1727
  end
1673
1728
 
1729
+ # Delete, remove worksheet from an Excel XLSX spreadsheet document
1730
+ # Edits the input Excel XLSX spreadsheet document to remove the specified worksheet (tab). Use the Get Worksheets API to enumerate available worksheets in a spreadsheet.
1731
+ # @param req_config Spreadsheet input request
1732
+ # @param [Hash] opts the optional parameters
1733
+ # @return [Object]
1734
+ def edit_document_xlsx_delete_worksheet(req_config, opts = {})
1735
+ data, _status_code, _headers = edit_document_xlsx_delete_worksheet_with_http_info(req_config, opts)
1736
+ return data
1737
+ end
1738
+
1739
+ # Delete, remove worksheet from an Excel XLSX spreadsheet document
1740
+ # Edits the input Excel XLSX spreadsheet document to remove the specified worksheet (tab). Use the Get Worksheets API to enumerate available worksheets in a spreadsheet.
1741
+ # @param req_config Spreadsheet input request
1742
+ # @param [Hash] opts the optional parameters
1743
+ # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
1744
+ def edit_document_xlsx_delete_worksheet_with_http_info(req_config, opts = {})
1745
+ if @api_client.config.debugging
1746
+ @api_client.config.logger.debug "Calling API: EditDocumentApi.edit_document_xlsx_delete_worksheet ..."
1747
+ end
1748
+ # verify the required parameter 'req_config' is set
1749
+ if @api_client.config.client_side_validation && req_config.nil?
1750
+ fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_xlsx_delete_worksheet"
1751
+ end
1752
+ # resource path
1753
+ local_var_path = "/convert/edit/xlsx/delete-worksheet"
1754
+
1755
+ # query parameters
1756
+ query_params = {}
1757
+
1758
+ # header parameters
1759
+ header_params = {}
1760
+ # HTTP header 'Accept' (if needed)
1761
+ header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
1762
+ # HTTP header 'Content-Type'
1763
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
1764
+
1765
+ # form parameters
1766
+ form_params = {}
1767
+
1768
+ # http body (model)
1769
+ post_body = @api_client.object_to_http_body(req_config)
1770
+ auth_names = ['Apikey']
1771
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1772
+ :header_params => header_params,
1773
+ :query_params => query_params,
1774
+ :form_params => form_params,
1775
+ :body => post_body,
1776
+ :auth_names => auth_names,
1777
+ :return_type => 'Object')
1778
+ if @api_client.config.debugging
1779
+ @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_xlsx_delete_worksheet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1780
+ end
1781
+ return data, status_code, headers
1782
+ end
1783
+
1674
1784
  # Get cell from an Excel XLSX spreadsheet, worksheet by index
1675
1785
  # Returns the rows and cells defined in the Excel Spreadsheet worksheet
1676
1786
  # @param input Document input request
@@ -2055,5 +2165,60 @@ module CloudmersiveConvertApiClient
2055
2165
  end
2056
2166
  return data, status_code, headers
2057
2167
  end
2168
+
2169
+ # Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index
2170
+ # Sets, updates the contents of a specific cell in an Excel XLSX spreadsheet, worksheet
2171
+ # @param input Document input request
2172
+ # @param [Hash] opts the optional parameters
2173
+ # @return [SetXlsxCellResponse]
2174
+ def edit_document_xlsx_set_cell_by_index(input, opts = {})
2175
+ data, _status_code, _headers = edit_document_xlsx_set_cell_by_index_with_http_info(input, opts)
2176
+ return data
2177
+ end
2178
+
2179
+ # Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index
2180
+ # Sets, updates the contents of a specific cell in an Excel XLSX spreadsheet, worksheet
2181
+ # @param input Document input request
2182
+ # @param [Hash] opts the optional parameters
2183
+ # @return [Array<(SetXlsxCellResponse, Fixnum, Hash)>] SetXlsxCellResponse data, response status code and response headers
2184
+ def edit_document_xlsx_set_cell_by_index_with_http_info(input, opts = {})
2185
+ if @api_client.config.debugging
2186
+ @api_client.config.logger.debug "Calling API: EditDocumentApi.edit_document_xlsx_set_cell_by_index ..."
2187
+ end
2188
+ # verify the required parameter 'input' is set
2189
+ if @api_client.config.client_side_validation && input.nil?
2190
+ fail ArgumentError, "Missing the required parameter 'input' when calling EditDocumentApi.edit_document_xlsx_set_cell_by_index"
2191
+ end
2192
+ # resource path
2193
+ local_var_path = "/convert/edit/xlsx/set-cell/by-index"
2194
+
2195
+ # query parameters
2196
+ query_params = {}
2197
+
2198
+ # header parameters
2199
+ header_params = {}
2200
+ # HTTP header 'Accept' (if needed)
2201
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
2202
+ # HTTP header 'Content-Type'
2203
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
2204
+
2205
+ # form parameters
2206
+ form_params = {}
2207
+
2208
+ # http body (model)
2209
+ post_body = @api_client.object_to_http_body(input)
2210
+ auth_names = ['Apikey']
2211
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2212
+ :header_params => header_params,
2213
+ :query_params => query_params,
2214
+ :form_params => form_params,
2215
+ :body => post_body,
2216
+ :auth_names => auth_names,
2217
+ :return_type => 'SetXlsxCellResponse')
2218
+ if @api_client.config.debugging
2219
+ @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_xlsx_set_cell_by_index\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2220
+ end
2221
+ return data, status_code, headers
2222
+ end
2058
2223
  end
2059
2224
  end