cloudmersive-convert-api-client 1.5.4 → 1.5.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +10 -5
- data/docs/ConvertDataApi.md +59 -4
- data/docs/ConvertDocumentApi.md +55 -0
- data/docs/DocxInsertImageRequest.md +2 -0
- data/docs/EditDocumentApi.md +58 -3
- data/docs/GetXlsxCellRequest.md +12 -0
- data/docs/GetXlsxCellResponse.md +9 -0
- data/docs/GetXlsxColumnsResponse.md +1 -1
- data/docs/GetXlsxImagesResponse.md +1 -1
- data/docs/GetXlsxRowsAndCellsResponse.md +1 -1
- data/lib/cloudmersive-convert-api-client.rb +2 -0
- data/lib/cloudmersive-convert-api-client/api/convert_data_api.rb +59 -4
- data/lib/cloudmersive-convert-api-client/api/convert_document_api.rb +56 -0
- data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +57 -2
- data/lib/cloudmersive-convert-api-client/models/docx_insert_image_request.rb +24 -4
- data/lib/cloudmersive-convert-api-client/models/get_xlsx_cell_request.rb +245 -0
- data/lib/cloudmersive-convert-api-client/models/get_xlsx_cell_response.rb +199 -0
- data/lib/cloudmersive-convert-api-client/models/get_xlsx_columns_response.rb +1 -1
- data/lib/cloudmersive-convert-api-client/models/get_xlsx_images_response.rb +1 -1
- data/lib/cloudmersive-convert-api-client/models/get_xlsx_rows_and_cells_response.rb +1 -1
- data/lib/cloudmersive-convert-api-client/version.rb +1 -1
- data/spec/api/convert_data_api_spec.rb +12 -0
- data/spec/api/convert_document_api_spec.rb +12 -0
- data/spec/api/edit_document_api_spec.rb +13 -1
- data/spec/models/docx_insert_image_request_spec.rb +12 -0
- data/spec/models/get_xlsx_cell_request_spec.rb +66 -0
- data/spec/models/get_xlsx_cell_response_spec.rb +48 -0
- metadata +8 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b5915d5559e6fbded7afba20ea5cf90f631379fa0c946456a68bb5c221f6c2a3
|
4
|
+
data.tar.gz: 1897473e28d5798e48b029a82838eae24a122cac3e74e55d85f9a2dca0bf5bd0
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 70d790870901cc6846ce063440a6f9b277f64a387b07757723de5c01ad7f810b567b34f88fc3f632fbd17810ca0f31921a3df3df6e6ae14744246bc331518124
|
7
|
+
data.tar.gz: 7e066b6c92c080c3c75e6b1127f7a57eca85fef70be6a7a93120099691240e63b51531f0e672c42fe79b553679b8526b8e2e70f39c6176524f7946e08a3d36e2
|
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.5
|
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.5.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.5.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.5'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -87,6 +87,7 @@ Class | Method | HTTP request | Description
|
|
87
87
|
------------ | ------------- | ------------- | -------------
|
88
88
|
*CloudmersiveConvertApiClient::CompareDocumentApi* | [**compare_document_docx**](docs/CompareDocumentApi.md#compare_document_docx) | **POST** /convert/compare/docx | Compare Two Word DOCX
|
89
89
|
*CloudmersiveConvertApiClient::ConvertDataApi* | [**convert_data_csv_to_json**](docs/ConvertDataApi.md#convert_data_csv_to_json) | **POST** /convert/csv/to/json | Convert CSV to JSON conversion
|
90
|
+
*CloudmersiveConvertApiClient::ConvertDataApi* | [**convert_data_json_to_xml**](docs/ConvertDataApi.md#convert_data_json_to_xml) | **POST** /convert/json/to/xml | Convert JSON to XML conversion
|
90
91
|
*CloudmersiveConvertApiClient::ConvertDataApi* | [**convert_data_xls_to_json**](docs/ConvertDataApi.md#convert_data_xls_to_json) | **POST** /convert/xls/to/json | Convert Excel (97-2003) XLS to JSON conversion
|
91
92
|
*CloudmersiveConvertApiClient::ConvertDataApi* | [**convert_data_xlsx_to_json**](docs/ConvertDataApi.md#convert_data_xlsx_to_json) | **POST** /convert/xlsx/to/json | Convert Excel XLSX to JSON conversion
|
92
93
|
*CloudmersiveConvertApiClient::ConvertDataApi* | [**convert_data_xml_to_json**](docs/ConvertDataApi.md#convert_data_xml_to_json) | **POST** /convert/xml/to/json | Convert XML to JSON conversion
|
@@ -102,6 +103,7 @@ Class | Method | HTTP request | Description
|
|
102
103
|
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_html_to_pdf**](docs/ConvertDocumentApi.md#convert_document_html_to_pdf) | **POST** /convert/html/to/pdf | Convert HTML to PDF Document
|
103
104
|
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_html_to_png**](docs/ConvertDocumentApi.md#convert_document_html_to_png) | **POST** /convert/html/to/png | Convert HTML to PNG image array
|
104
105
|
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_pdf_to_docx**](docs/ConvertDocumentApi.md#convert_document_pdf_to_docx) | **POST** /convert/pdf/to/docx | Convert PDF to Word DOCX Document
|
106
|
+
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_pdf_to_docx_rasterize**](docs/ConvertDocumentApi.md#convert_document_pdf_to_docx_rasterize) | **POST** /convert/pdf/to/docx/rasterize | Convert PDF to Word DOCX Document based on rasterized version of the PDF
|
105
107
|
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_pdf_to_png_array**](docs/ConvertDocumentApi.md#convert_document_pdf_to_png_array) | **POST** /convert/pdf/to/png | Convert PDF to PNG Image Array
|
106
108
|
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_pdf_to_png_single**](docs/ConvertDocumentApi.md#convert_document_pdf_to_png_single) | **POST** /convert/pdf/to/png/merge-single | Convert PDF to Single PNG image
|
107
109
|
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_pdf_to_pptx**](docs/ConvertDocumentApi.md#convert_document_pdf_to_pptx) | **POST** /convert/pdf/to/pptx | Convert PDF to PowerPoint PPTX Presentation
|
@@ -157,9 +159,10 @@ Class | Method | HTTP request | Description
|
|
157
159
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_finish_editing**](docs/EditDocumentApi.md#edit_document_finish_editing) | **POST** /convert/edit/finish-editing | Download result from document editing
|
158
160
|
*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
161
|
*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
|
162
|
+
*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
|
160
163
|
*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
|
161
164
|
*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
|
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
|
165
|
+
*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 Excel XLSX spreadsheet, worksheet
|
163
166
|
*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
|
164
167
|
*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
|
165
168
|
*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
|
@@ -258,6 +261,8 @@ Class | Method | HTTP request | Description
|
|
258
261
|
- [CloudmersiveConvertApiClient::GetDocxTablesRequest](docs/GetDocxTablesRequest.md)
|
259
262
|
- [CloudmersiveConvertApiClient::GetDocxTablesResponse](docs/GetDocxTablesResponse.md)
|
260
263
|
- [CloudmersiveConvertApiClient::GetImageInfoResult](docs/GetImageInfoResult.md)
|
264
|
+
- [CloudmersiveConvertApiClient::GetXlsxCellRequest](docs/GetXlsxCellRequest.md)
|
265
|
+
- [CloudmersiveConvertApiClient::GetXlsxCellResponse](docs/GetXlsxCellResponse.md)
|
261
266
|
- [CloudmersiveConvertApiClient::GetXlsxColumnsRequest](docs/GetXlsxColumnsRequest.md)
|
262
267
|
- [CloudmersiveConvertApiClient::GetXlsxColumnsResponse](docs/GetXlsxColumnsResponse.md)
|
263
268
|
- [CloudmersiveConvertApiClient::GetXlsxImagesRequest](docs/GetXlsxImagesRequest.md)
|
data/docs/ConvertDataApi.md
CHANGED
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**convert_data_csv_to_json**](ConvertDataApi.md#convert_data_csv_to_json) | **POST** /convert/csv/to/json | Convert CSV to JSON conversion
|
8
|
+
[**convert_data_json_to_xml**](ConvertDataApi.md#convert_data_json_to_xml) | **POST** /convert/json/to/xml | Convert JSON to XML conversion
|
8
9
|
[**convert_data_xls_to_json**](ConvertDataApi.md#convert_data_xls_to_json) | **POST** /convert/xls/to/json | Convert Excel (97-2003) XLS to JSON conversion
|
9
10
|
[**convert_data_xlsx_to_json**](ConvertDataApi.md#convert_data_xlsx_to_json) | **POST** /convert/xlsx/to/json | Convert Excel XLSX to JSON conversion
|
10
11
|
[**convert_data_xml_to_json**](ConvertDataApi.md#convert_data_xml_to_json) | **POST** /convert/xml/to/json | Convert XML to JSON conversion
|
@@ -60,7 +61,61 @@ Name | Type | Description | Notes
|
|
60
61
|
### HTTP request headers
|
61
62
|
|
62
63
|
- **Content-Type**: multipart/form-data
|
63
|
-
- **Accept**: application/json
|
64
|
+
- **Accept**: application/json
|
65
|
+
|
66
|
+
|
67
|
+
|
68
|
+
# **convert_data_json_to_xml**
|
69
|
+
> Object convert_data_json_to_xml(json_object)
|
70
|
+
|
71
|
+
Convert JSON to XML conversion
|
72
|
+
|
73
|
+
Convert a JSON object into XML
|
74
|
+
|
75
|
+
### Example
|
76
|
+
```ruby
|
77
|
+
# load the gem
|
78
|
+
require 'cloudmersive-convert-api-client'
|
79
|
+
# setup authorization
|
80
|
+
CloudmersiveConvertApiClient.configure do |config|
|
81
|
+
# Configure API key authorization: Apikey
|
82
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
83
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
84
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
85
|
+
end
|
86
|
+
|
87
|
+
api_instance = CloudmersiveConvertApiClient::ConvertDataApi.new
|
88
|
+
|
89
|
+
json_object = nil # Object |
|
90
|
+
|
91
|
+
|
92
|
+
begin
|
93
|
+
#Convert JSON to XML conversion
|
94
|
+
result = api_instance.convert_data_json_to_xml(json_object)
|
95
|
+
p result
|
96
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
97
|
+
puts "Exception when calling ConvertDataApi->convert_data_json_to_xml: #{e}"
|
98
|
+
end
|
99
|
+
```
|
100
|
+
|
101
|
+
### Parameters
|
102
|
+
|
103
|
+
Name | Type | Description | Notes
|
104
|
+
------------- | ------------- | ------------- | -------------
|
105
|
+
**json_object** | **Object**| |
|
106
|
+
|
107
|
+
### Return type
|
108
|
+
|
109
|
+
**Object**
|
110
|
+
|
111
|
+
### Authorization
|
112
|
+
|
113
|
+
[Apikey](../README.md#Apikey)
|
114
|
+
|
115
|
+
### HTTP request headers
|
116
|
+
|
117
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
118
|
+
- **Accept**: application/xml
|
64
119
|
|
65
120
|
|
66
121
|
|
@@ -114,7 +169,7 @@ Name | Type | Description | Notes
|
|
114
169
|
### HTTP request headers
|
115
170
|
|
116
171
|
- **Content-Type**: multipart/form-data
|
117
|
-
- **Accept**: application/json
|
172
|
+
- **Accept**: application/json
|
118
173
|
|
119
174
|
|
120
175
|
|
@@ -168,7 +223,7 @@ Name | Type | Description | Notes
|
|
168
223
|
### HTTP request headers
|
169
224
|
|
170
225
|
- **Content-Type**: multipart/form-data
|
171
|
-
- **Accept**: application/json
|
226
|
+
- **Accept**: application/json
|
172
227
|
|
173
228
|
|
174
229
|
|
@@ -222,7 +277,7 @@ Name | Type | Description | Notes
|
|
222
277
|
### HTTP request headers
|
223
278
|
|
224
279
|
- **Content-Type**: multipart/form-data
|
225
|
-
- **Accept**: application/json
|
280
|
+
- **Accept**: application/json
|
226
281
|
|
227
282
|
|
228
283
|
|
data/docs/ConvertDocumentApi.md
CHANGED
@@ -16,6 +16,7 @@ Method | HTTP request | Description
|
|
16
16
|
[**convert_document_html_to_pdf**](ConvertDocumentApi.md#convert_document_html_to_pdf) | **POST** /convert/html/to/pdf | Convert HTML to PDF Document
|
17
17
|
[**convert_document_html_to_png**](ConvertDocumentApi.md#convert_document_html_to_png) | **POST** /convert/html/to/png | Convert HTML to PNG image array
|
18
18
|
[**convert_document_pdf_to_docx**](ConvertDocumentApi.md#convert_document_pdf_to_docx) | **POST** /convert/pdf/to/docx | Convert PDF to Word DOCX Document
|
19
|
+
[**convert_document_pdf_to_docx_rasterize**](ConvertDocumentApi.md#convert_document_pdf_to_docx_rasterize) | **POST** /convert/pdf/to/docx/rasterize | Convert PDF to Word DOCX Document based on rasterized version of the PDF
|
19
20
|
[**convert_document_pdf_to_png_array**](ConvertDocumentApi.md#convert_document_pdf_to_png_array) | **POST** /convert/pdf/to/png | Convert PDF to PNG Image Array
|
20
21
|
[**convert_document_pdf_to_png_single**](ConvertDocumentApi.md#convert_document_pdf_to_png_single) | **POST** /convert/pdf/to/png/merge-single | Convert PDF to Single PNG image
|
21
22
|
[**convert_document_pdf_to_pptx**](ConvertDocumentApi.md#convert_document_pdf_to_pptx) | **POST** /convert/pdf/to/pptx | Convert PDF to PowerPoint PPTX Presentation
|
@@ -681,6 +682,60 @@ Name | Type | Description | Notes
|
|
681
682
|
|
682
683
|
|
683
684
|
|
685
|
+
# **convert_document_pdf_to_docx_rasterize**
|
686
|
+
> String convert_document_pdf_to_docx_rasterize(input_file)
|
687
|
+
|
688
|
+
Convert PDF to Word DOCX Document based on rasterized version of the PDF
|
689
|
+
|
690
|
+
Convert standard PDF to Office Word Documents (docx), but first rasterize the PDF. Converts a PDF at high fidelity into Word format.
|
691
|
+
|
692
|
+
### Example
|
693
|
+
```ruby
|
694
|
+
# load the gem
|
695
|
+
require 'cloudmersive-convert-api-client'
|
696
|
+
# setup authorization
|
697
|
+
CloudmersiveConvertApiClient.configure do |config|
|
698
|
+
# Configure API key authorization: Apikey
|
699
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
700
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
701
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
702
|
+
end
|
703
|
+
|
704
|
+
api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
|
705
|
+
|
706
|
+
input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
|
707
|
+
|
708
|
+
|
709
|
+
begin
|
710
|
+
#Convert PDF to Word DOCX Document based on rasterized version of the PDF
|
711
|
+
result = api_instance.convert_document_pdf_to_docx_rasterize(input_file)
|
712
|
+
p result
|
713
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
714
|
+
puts "Exception when calling ConvertDocumentApi->convert_document_pdf_to_docx_rasterize: #{e}"
|
715
|
+
end
|
716
|
+
```
|
717
|
+
|
718
|
+
### Parameters
|
719
|
+
|
720
|
+
Name | Type | Description | Notes
|
721
|
+
------------- | ------------- | ------------- | -------------
|
722
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
723
|
+
|
724
|
+
### Return type
|
725
|
+
|
726
|
+
**String**
|
727
|
+
|
728
|
+
### Authorization
|
729
|
+
|
730
|
+
[Apikey](../README.md#Apikey)
|
731
|
+
|
732
|
+
### HTTP request headers
|
733
|
+
|
734
|
+
- **Content-Type**: multipart/form-data
|
735
|
+
- **Accept**: application/octet-stream
|
736
|
+
|
737
|
+
|
738
|
+
|
684
739
|
# **convert_document_pdf_to_png_array**
|
685
740
|
> PdfToPngResult convert_document_pdf_to_png_array(input_file)
|
686
741
|
|
@@ -10,5 +10,7 @@ Name | Type | Description | Notes
|
|
10
10
|
**image_to_add** | [**DocxImage**](DocxImage.md) | Optional: Image to add; if you supply in this object, do not supply InputImageFileBytes or InputImageFileUrl. | [optional]
|
11
11
|
**insert_placement** | **String** | Optional; default is DocumentEnd. Placement Type of the insert; possible values are: DocumentStart (very beginning of the document), DocumentEnd (very end of the document), BeforeExistingObject (right before an existing object - fill in the InsertPath field using the Path value from an existing object), AfterExistingObject (right after an existing object - fill in the InsertPath field using the Path value from an existing object) | [optional]
|
12
12
|
**insert_path** | **String** | Optional; location within the document to insert the object; fill in the InsertPath field using the Path value from an existing object. Used with InsertPlacement of BeforeExistingObject or AfterExistingObject | [optional]
|
13
|
+
**width_in_em_us** | **Integer** | Optional: The width of the image in EMUs | [optional]
|
14
|
+
**height_in_em_us** | **Integer** | Optional: The height of the image in EMUs | [optional]
|
13
15
|
|
14
16
|
|
data/docs/EditDocumentApi.md
CHANGED
@@ -32,9 +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_replace**](EditDocumentApi.md#edit_document_pptx_replace) | **POST** /convert/edit/pptx/replace-all | Replace string in PowerPoint PPTX presentation
|
34
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
|
35
|
+
[**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
|
35
36
|
[**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
|
36
37
|
[**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
|
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
|
38
|
+
[**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 Excel XLSX spreadsheet, worksheet
|
38
39
|
[**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
|
39
40
|
[**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
|
40
41
|
[**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
|
@@ -1552,6 +1553,60 @@ Name | Type | Description | Notes
|
|
1552
1553
|
|
1553
1554
|
|
1554
1555
|
|
1556
|
+
# **edit_document_xlsx_get_cell_by_index**
|
1557
|
+
> GetXlsxCellResponse edit_document_xlsx_get_cell_by_index(input)
|
1558
|
+
|
1559
|
+
Get cell from an Excel XLSX spreadsheet, worksheet by index
|
1560
|
+
|
1561
|
+
Returns the rows and cells defined in the Excel Spreadsheet worksheet
|
1562
|
+
|
1563
|
+
### Example
|
1564
|
+
```ruby
|
1565
|
+
# load the gem
|
1566
|
+
require 'cloudmersive-convert-api-client'
|
1567
|
+
# setup authorization
|
1568
|
+
CloudmersiveConvertApiClient.configure do |config|
|
1569
|
+
# Configure API key authorization: Apikey
|
1570
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
1571
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1572
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
1573
|
+
end
|
1574
|
+
|
1575
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
1576
|
+
|
1577
|
+
input = CloudmersiveConvertApiClient::GetXlsxCellRequest.new # GetXlsxCellRequest | Document input request
|
1578
|
+
|
1579
|
+
|
1580
|
+
begin
|
1581
|
+
#Get cell from an Excel XLSX spreadsheet, worksheet by index
|
1582
|
+
result = api_instance.edit_document_xlsx_get_cell_by_index(input)
|
1583
|
+
p result
|
1584
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
1585
|
+
puts "Exception when calling EditDocumentApi->edit_document_xlsx_get_cell_by_index: #{e}"
|
1586
|
+
end
|
1587
|
+
```
|
1588
|
+
|
1589
|
+
### Parameters
|
1590
|
+
|
1591
|
+
Name | Type | Description | Notes
|
1592
|
+
------------- | ------------- | ------------- | -------------
|
1593
|
+
**input** | [**GetXlsxCellRequest**](GetXlsxCellRequest.md)| Document input request |
|
1594
|
+
|
1595
|
+
### Return type
|
1596
|
+
|
1597
|
+
[**GetXlsxCellResponse**](GetXlsxCellResponse.md)
|
1598
|
+
|
1599
|
+
### Authorization
|
1600
|
+
|
1601
|
+
[Apikey](../README.md#Apikey)
|
1602
|
+
|
1603
|
+
### HTTP request headers
|
1604
|
+
|
1605
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
1606
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
1607
|
+
|
1608
|
+
|
1609
|
+
|
1555
1610
|
# **edit_document_xlsx_get_columns**
|
1556
1611
|
> GetXlsxColumnsResponse edit_document_xlsx_get_columns(input)
|
1557
1612
|
|
@@ -1663,7 +1718,7 @@ Name | Type | Description | Notes
|
|
1663
1718
|
# **edit_document_xlsx_get_rows_and_cells**
|
1664
1719
|
> GetXlsxRowsAndCellsResponse edit_document_xlsx_get_rows_and_cells(input)
|
1665
1720
|
|
1666
|
-
Get rows and cells from a
|
1721
|
+
Get rows and cells from a Excel XLSX spreadsheet, worksheet
|
1667
1722
|
|
1668
1723
|
Returns the rows and cells defined in the Excel Spreadsheet worksheet
|
1669
1724
|
|
@@ -1685,7 +1740,7 @@ input = CloudmersiveConvertApiClient::GetXlsxRowsAndCellsRequest.new # GetXlsxRo
|
|
1685
1740
|
|
1686
1741
|
|
1687
1742
|
begin
|
1688
|
-
#Get rows and cells from a
|
1743
|
+
#Get rows and cells from a Excel XLSX spreadsheet, worksheet
|
1689
1744
|
result = api_instance.edit_document_xlsx_get_rows_and_cells(input)
|
1690
1745
|
p result
|
1691
1746
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::GetXlsxCellRequest
|
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_query** | [**XlsxWorksheet**](XlsxWorksheet.md) | Optional; Worksheet (tab) within the spreadsheet to get the rows and cells of; leave blank to default to the first worksheet | [optional]
|
9
|
+
**row_index** | **Integer** | 0-based index of the row, 0, 1, 2, ... to retrieve | [optional]
|
10
|
+
**cell_index** | **Integer** | 0-based index of the cell, 0, 1, 2, ... in the row to retrieve | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::GetXlsxCellResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
|
7
|
+
**cell** | [**XlsxSpreadsheetCell**](XlsxSpreadsheetCell.md) | Requested Cell in the Excel XLSX document | [optional]
|
8
|
+
|
9
|
+
|
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
|
7
|
-
**columns** | [**Array<XlsxSpreadsheetColumn>**](XlsxSpreadsheetColumn.md) | Spreadsheet Columns in the
|
7
|
+
**columns** | [**Array<XlsxSpreadsheetColumn>**](XlsxSpreadsheetColumn.md) | Spreadsheet Columns in the XLSX document | [optional]
|
8
8
|
|
9
9
|
|
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
|
7
|
-
**images** | [**Array<XlsxImage>**](XlsxImage.md) | Spreadsheet
|
7
|
+
**images** | [**Array<XlsxImage>**](XlsxImage.md) | Spreadsheet Images in the XLSX document | [optional]
|
8
8
|
|
9
9
|
|
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
|
7
|
-
**rows** | [**Array<XlsxSpreadsheetRow>**](XlsxSpreadsheetRow.md) | Spreadsheet Rows in the
|
7
|
+
**rows** | [**Array<XlsxSpreadsheetRow>**](XlsxSpreadsheetRow.md) | Spreadsheet Rows in the Excel XLSX document | [optional]
|
8
8
|
|
9
9
|
|
@@ -76,6 +76,8 @@ require 'cloudmersive-convert-api-client/models/get_docx_table_row_response'
|
|
76
76
|
require 'cloudmersive-convert-api-client/models/get_docx_tables_request'
|
77
77
|
require 'cloudmersive-convert-api-client/models/get_docx_tables_response'
|
78
78
|
require 'cloudmersive-convert-api-client/models/get_image_info_result'
|
79
|
+
require 'cloudmersive-convert-api-client/models/get_xlsx_cell_request'
|
80
|
+
require 'cloudmersive-convert-api-client/models/get_xlsx_cell_response'
|
79
81
|
require 'cloudmersive-convert-api-client/models/get_xlsx_columns_request'
|
80
82
|
require 'cloudmersive-convert-api-client/models/get_xlsx_columns_response'
|
81
83
|
require 'cloudmersive-convert-api-client/models/get_xlsx_images_request'
|
@@ -52,7 +52,7 @@ module CloudmersiveConvertApiClient
|
|
52
52
|
# header parameters
|
53
53
|
header_params = {}
|
54
54
|
# HTTP header 'Accept' (if needed)
|
55
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'
|
55
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
56
56
|
# HTTP header 'Content-Type'
|
57
57
|
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
58
58
|
|
@@ -76,6 +76,61 @@ module CloudmersiveConvertApiClient
|
|
76
76
|
return data, status_code, headers
|
77
77
|
end
|
78
78
|
|
79
|
+
# Convert JSON to XML conversion
|
80
|
+
# Convert a JSON object into XML
|
81
|
+
# @param json_object
|
82
|
+
# @param [Hash] opts the optional parameters
|
83
|
+
# @return [Object]
|
84
|
+
def convert_data_json_to_xml(json_object, opts = {})
|
85
|
+
data, _status_code, _headers = convert_data_json_to_xml_with_http_info(json_object, opts)
|
86
|
+
return data
|
87
|
+
end
|
88
|
+
|
89
|
+
# Convert JSON to XML conversion
|
90
|
+
# Convert a JSON object into XML
|
91
|
+
# @param json_object
|
92
|
+
# @param [Hash] opts the optional parameters
|
93
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
94
|
+
def convert_data_json_to_xml_with_http_info(json_object, opts = {})
|
95
|
+
if @api_client.config.debugging
|
96
|
+
@api_client.config.logger.debug "Calling API: ConvertDataApi.convert_data_json_to_xml ..."
|
97
|
+
end
|
98
|
+
# verify the required parameter 'json_object' is set
|
99
|
+
if @api_client.config.client_side_validation && json_object.nil?
|
100
|
+
fail ArgumentError, "Missing the required parameter 'json_object' when calling ConvertDataApi.convert_data_json_to_xml"
|
101
|
+
end
|
102
|
+
# resource path
|
103
|
+
local_var_path = "/convert/json/to/xml"
|
104
|
+
|
105
|
+
# query parameters
|
106
|
+
query_params = {}
|
107
|
+
|
108
|
+
# header parameters
|
109
|
+
header_params = {}
|
110
|
+
# HTTP header 'Accept' (if needed)
|
111
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/xml'])
|
112
|
+
# HTTP header 'Content-Type'
|
113
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
114
|
+
|
115
|
+
# form parameters
|
116
|
+
form_params = {}
|
117
|
+
|
118
|
+
# http body (model)
|
119
|
+
post_body = @api_client.object_to_http_body(json_object)
|
120
|
+
auth_names = ['Apikey']
|
121
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
122
|
+
:header_params => header_params,
|
123
|
+
:query_params => query_params,
|
124
|
+
:form_params => form_params,
|
125
|
+
:body => post_body,
|
126
|
+
:auth_names => auth_names,
|
127
|
+
:return_type => 'Object')
|
128
|
+
if @api_client.config.debugging
|
129
|
+
@api_client.config.logger.debug "API called: ConvertDataApi#convert_data_json_to_xml\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
130
|
+
end
|
131
|
+
return data, status_code, headers
|
132
|
+
end
|
133
|
+
|
79
134
|
# Convert Excel (97-2003) XLS to JSON conversion
|
80
135
|
# Convert an Excel (97-2003) XLS file to a JSON object array
|
81
136
|
# @param input_file Input file to perform the operation on.
|
@@ -108,7 +163,7 @@ module CloudmersiveConvertApiClient
|
|
108
163
|
# header parameters
|
109
164
|
header_params = {}
|
110
165
|
# HTTP header 'Accept' (if needed)
|
111
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'
|
166
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
112
167
|
# HTTP header 'Content-Type'
|
113
168
|
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
114
169
|
|
@@ -164,7 +219,7 @@ module CloudmersiveConvertApiClient
|
|
164
219
|
# header parameters
|
165
220
|
header_params = {}
|
166
221
|
# HTTP header 'Accept' (if needed)
|
167
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'
|
222
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
168
223
|
# HTTP header 'Content-Type'
|
169
224
|
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
170
225
|
|
@@ -220,7 +275,7 @@ module CloudmersiveConvertApiClient
|
|
220
275
|
# header parameters
|
221
276
|
header_params = {}
|
222
277
|
# HTTP header 'Accept' (if needed)
|
223
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'
|
278
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
224
279
|
# HTTP header 'Content-Type'
|
225
280
|
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
226
281
|
|