cloudmersive-convert-api-client 1.7.3 → 1.7.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +8 -5
- data/docs/ConvertDocumentApi.md +65 -6
- data/docs/CsvCollection.md +10 -0
- data/docs/CsvFileResult.md +9 -0
- data/docs/DocumentValidationResult.md +1 -0
- data/docs/ValidateDocumentApi.md +1 -1
- data/lib/cloudmersive-convert-api-client.rb +2 -0
- data/lib/cloudmersive-convert-api-client/api/convert_document_api.rb +65 -6
- data/lib/cloudmersive-convert-api-client/api/validate_document_api.rb +2 -2
- data/lib/cloudmersive-convert-api-client/models/csv_collection.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/csv_file_result.rb +215 -0
- data/lib/cloudmersive-convert-api-client/models/document_validation_result.rb +11 -1
- data/lib/cloudmersive-convert-api-client/version.rb +1 -1
- data/spec/api/convert_document_api_spec.rb +16 -3
- data/spec/api/validate_document_api_spec.rb +1 -1
- data/spec/models/csv_collection_spec.rb +54 -0
- data/spec/models/csv_file_result_spec.rb +48 -0
- data/spec/models/document_validation_result_spec.rb +6 -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: 2d75ce766690c505454afacec20fb89f7672b3cfc13813703eb35ad9801f1cc6
|
4
|
+
data.tar.gz: 7eac89d54269fbb3f2ab53aefbaf9339f5bce46ea865e967c0bdfe4dc293ad95
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c1f574fdaef9c6a74f07794117a6f0f5ba0109a8796362257ba3ecefea0a5cf8d88c513000d2475792a748966b541d7854c0cdeaf34251b3ac357975e0b014f9
|
7
|
+
data.tar.gz: b8b823a6fcbc8d7a519e909aacd0b628928fafa4fc797ca469df0e18a8da69ca684c1cbb9f450a717ce2ffb01cfbc143e50e5528cc95cc2d0f620222ad3e5f68
|
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.7.
|
10
|
+
- Package version: 1.7.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.7.
|
26
|
+
gem install ./cloudmersive-convert-api-client-1.7.4.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-convert-api-client-1.7.
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-convert-api-client-1.7.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.7.
|
34
|
+
gem 'cloudmersive-convert-api-client', '~> 1.7.4'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -128,7 +128,8 @@ Class | Method | HTTP request | Description
|
|
128
128
|
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_xls_to_csv**](docs/ConvertDocumentApi.md#convert_document_xls_to_csv) | **POST** /convert/xls/to/csv | Convert Excel XLS (97-03) Spreadsheet to CSV
|
129
129
|
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_xls_to_pdf**](docs/ConvertDocumentApi.md#convert_document_xls_to_pdf) | **POST** /convert/xls/to/pdf | Convert Excel XLS (97-03) Spreadsheet to PDF
|
130
130
|
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_xls_to_xlsx**](docs/ConvertDocumentApi.md#convert_document_xls_to_xlsx) | **POST** /convert/xls/to/xlsx | Convert Excel XLS (97-03) Spreadsheet to XLSX
|
131
|
-
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_xlsx_to_csv**](docs/ConvertDocumentApi.md#convert_document_xlsx_to_csv) | **POST** /convert/xlsx/to/csv | Convert Excel XLSX Spreadsheet to CSV
|
131
|
+
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_xlsx_to_csv**](docs/ConvertDocumentApi.md#convert_document_xlsx_to_csv) | **POST** /convert/xlsx/to/csv | Convert Excel XLSX Spreadsheet to CSV, Single Worksheet
|
132
|
+
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_xlsx_to_csv_multi**](docs/ConvertDocumentApi.md#convert_document_xlsx_to_csv_multi) | **POST** /convert/xlsx/to/csv/multi | Convert Excel XLSX Spreadsheet to CSV, Multiple Worksheets
|
132
133
|
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_xlsx_to_pdf**](docs/ConvertDocumentApi.md#convert_document_xlsx_to_pdf) | **POST** /convert/xlsx/to/pdf | Convert Excel XLSX Spreadsheet to PDF
|
133
134
|
*CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_xlsx_to_txt**](docs/ConvertDocumentApi.md#convert_document_xlsx_to_txt) | **POST** /convert/xlsx/to/txt | Convert Excel XLSX Spreadsheet to Text (txt)
|
134
135
|
*CloudmersiveConvertApiClient::ConvertImageApi* | [**convert_image_get_image_info**](docs/ConvertImageApi.md#convert_image_get_image_info) | **POST** /convert/image/get-info | Get information about an image
|
@@ -280,6 +281,8 @@ Class | Method | HTTP request | Description
|
|
280
281
|
- [CloudmersiveConvertApiClient::CreateSpreadsheetFromDataRequest](docs/CreateSpreadsheetFromDataRequest.md)
|
281
282
|
- [CloudmersiveConvertApiClient::CreateSpreadsheetFromDataResponse](docs/CreateSpreadsheetFromDataResponse.md)
|
282
283
|
- [CloudmersiveConvertApiClient::CreateZipArchiveRequest](docs/CreateZipArchiveRequest.md)
|
284
|
+
- [CloudmersiveConvertApiClient::CsvCollection](docs/CsvCollection.md)
|
285
|
+
- [CloudmersiveConvertApiClient::CsvFileResult](docs/CsvFileResult.md)
|
283
286
|
- [CloudmersiveConvertApiClient::DeleteDocxTableRowRangeRequest](docs/DeleteDocxTableRowRangeRequest.md)
|
284
287
|
- [CloudmersiveConvertApiClient::DeleteDocxTableRowRangeResponse](docs/DeleteDocxTableRowRangeResponse.md)
|
285
288
|
- [CloudmersiveConvertApiClient::DeleteDocxTableRowRequest](docs/DeleteDocxTableRowRequest.md)
|
data/docs/ConvertDocumentApi.md
CHANGED
@@ -31,7 +31,8 @@ Method | HTTP request | Description
|
|
31
31
|
[**convert_document_xls_to_csv**](ConvertDocumentApi.md#convert_document_xls_to_csv) | **POST** /convert/xls/to/csv | Convert Excel XLS (97-03) Spreadsheet to CSV
|
32
32
|
[**convert_document_xls_to_pdf**](ConvertDocumentApi.md#convert_document_xls_to_pdf) | **POST** /convert/xls/to/pdf | Convert Excel XLS (97-03) Spreadsheet to PDF
|
33
33
|
[**convert_document_xls_to_xlsx**](ConvertDocumentApi.md#convert_document_xls_to_xlsx) | **POST** /convert/xls/to/xlsx | Convert Excel XLS (97-03) Spreadsheet to XLSX
|
34
|
-
[**convert_document_xlsx_to_csv**](ConvertDocumentApi.md#convert_document_xlsx_to_csv) | **POST** /convert/xlsx/to/csv | Convert Excel XLSX Spreadsheet to CSV
|
34
|
+
[**convert_document_xlsx_to_csv**](ConvertDocumentApi.md#convert_document_xlsx_to_csv) | **POST** /convert/xlsx/to/csv | Convert Excel XLSX Spreadsheet to CSV, Single Worksheet
|
35
|
+
[**convert_document_xlsx_to_csv_multi**](ConvertDocumentApi.md#convert_document_xlsx_to_csv_multi) | **POST** /convert/xlsx/to/csv/multi | Convert Excel XLSX Spreadsheet to CSV, Multiple Worksheets
|
35
36
|
[**convert_document_xlsx_to_pdf**](ConvertDocumentApi.md#convert_document_xlsx_to_pdf) | **POST** /convert/xlsx/to/pdf | Convert Excel XLSX Spreadsheet to PDF
|
36
37
|
[**convert_document_xlsx_to_txt**](ConvertDocumentApi.md#convert_document_xlsx_to_txt) | **POST** /convert/xlsx/to/txt | Convert Excel XLSX Spreadsheet to Text (txt)
|
37
38
|
|
@@ -1530,9 +1531,9 @@ Name | Type | Description | Notes
|
|
1530
1531
|
# **convert_document_xlsx_to_csv**
|
1531
1532
|
> String convert_document_xlsx_to_csv(input_file, opts)
|
1532
1533
|
|
1533
|
-
Convert Excel XLSX Spreadsheet to CSV
|
1534
|
+
Convert Excel XLSX Spreadsheet to CSV, Single Worksheet
|
1534
1535
|
|
1535
|
-
Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format. Supports both XLSX and XLSB file Excel formats.
|
1536
|
+
Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format. Supports both XLSX and XLSB file Excel formats. If the input file contains multiple worksheets, the first one is used. If you wish to convert all of the worksheets (not just the first one), be sure to use the xlsx/to/csv/multi API.
|
1536
1537
|
|
1537
1538
|
### Example
|
1538
1539
|
```ruby
|
@@ -1551,11 +1552,11 @@ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
|
|
1551
1552
|
input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
|
1552
1553
|
|
1553
1554
|
opts = {
|
1554
|
-
output_encoding: "output_encoding_example" # String | Optional, set the output text encoding for the result; possible values are UTF-8 and UTF-32. Default is UTF-
|
1555
|
+
output_encoding: "output_encoding_example" # String | Optional, set the output text encoding for the result; possible values are UTF-8, ASCII and UTF-32. Default is UTF-8.
|
1555
1556
|
}
|
1556
1557
|
|
1557
1558
|
begin
|
1558
|
-
#Convert Excel XLSX Spreadsheet to CSV
|
1559
|
+
#Convert Excel XLSX Spreadsheet to CSV, Single Worksheet
|
1559
1560
|
result = api_instance.convert_document_xlsx_to_csv(input_file, opts)
|
1560
1561
|
p result
|
1561
1562
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -1568,7 +1569,7 @@ end
|
|
1568
1569
|
Name | Type | Description | Notes
|
1569
1570
|
------------- | ------------- | ------------- | -------------
|
1570
1571
|
**input_file** | **File**| Input file to perform the operation on. |
|
1571
|
-
**output_encoding** | **String**| Optional, set the output text encoding for the result; possible values are UTF-8 and UTF-32. Default is UTF-
|
1572
|
+
**output_encoding** | **String**| Optional, set the output text encoding for the result; possible values are UTF-8, ASCII and UTF-32. Default is UTF-8. | [optional]
|
1572
1573
|
|
1573
1574
|
### Return type
|
1574
1575
|
|
@@ -1585,6 +1586,64 @@ Name | Type | Description | Notes
|
|
1585
1586
|
|
1586
1587
|
|
1587
1588
|
|
1589
|
+
# **convert_document_xlsx_to_csv_multi**
|
1590
|
+
> CsvCollection convert_document_xlsx_to_csv_multi(input_file, opts)
|
1591
|
+
|
1592
|
+
Convert Excel XLSX Spreadsheet to CSV, Multiple Worksheets
|
1593
|
+
|
1594
|
+
Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format, with support for multiple worksheets. Supports both XLSX and XLSB file Excel formats. Returns multiple CSV files, one for each worksheet (tab) in the spreadsheet.
|
1595
|
+
|
1596
|
+
### Example
|
1597
|
+
```ruby
|
1598
|
+
# load the gem
|
1599
|
+
require 'cloudmersive-convert-api-client'
|
1600
|
+
# setup authorization
|
1601
|
+
CloudmersiveConvertApiClient.configure do |config|
|
1602
|
+
# Configure API key authorization: Apikey
|
1603
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
1604
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1605
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
1606
|
+
end
|
1607
|
+
|
1608
|
+
api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
|
1609
|
+
|
1610
|
+
input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
|
1611
|
+
|
1612
|
+
opts = {
|
1613
|
+
output_encoding: "output_encoding_example" # String | Optional, set the output text encoding for the result; possible values are UTF-8, ASCII and UTF-32. Default is UTF-8.
|
1614
|
+
}
|
1615
|
+
|
1616
|
+
begin
|
1617
|
+
#Convert Excel XLSX Spreadsheet to CSV, Multiple Worksheets
|
1618
|
+
result = api_instance.convert_document_xlsx_to_csv_multi(input_file, opts)
|
1619
|
+
p result
|
1620
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
1621
|
+
puts "Exception when calling ConvertDocumentApi->convert_document_xlsx_to_csv_multi: #{e}"
|
1622
|
+
end
|
1623
|
+
```
|
1624
|
+
|
1625
|
+
### Parameters
|
1626
|
+
|
1627
|
+
Name | Type | Description | Notes
|
1628
|
+
------------- | ------------- | ------------- | -------------
|
1629
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
1630
|
+
**output_encoding** | **String**| Optional, set the output text encoding for the result; possible values are UTF-8, ASCII and UTF-32. Default is UTF-8. | [optional]
|
1631
|
+
|
1632
|
+
### Return type
|
1633
|
+
|
1634
|
+
[**CsvCollection**](CsvCollection.md)
|
1635
|
+
|
1636
|
+
### Authorization
|
1637
|
+
|
1638
|
+
[Apikey](../README.md#Apikey)
|
1639
|
+
|
1640
|
+
### HTTP request headers
|
1641
|
+
|
1642
|
+
- **Content-Type**: multipart/form-data
|
1643
|
+
- **Accept**: application/octet-stream
|
1644
|
+
|
1645
|
+
|
1646
|
+
|
1588
1647
|
# **convert_document_xlsx_to_pdf**
|
1589
1648
|
> String convert_document_xlsx_to_pdf(input_file)
|
1590
1649
|
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::CsvCollection
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
7
|
+
**csv_files** | [**Array<CsvFileResult>**](CsvFileResult.md) | Array of CSV File results | [optional]
|
8
|
+
**file_count** | **Integer** | Count of the number of CSV files produced | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::CsvFileResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**title** | **String** | Title of the CSV file | [optional]
|
7
|
+
**file_contents** | **String** | Contents of the CSV file | [optional]
|
8
|
+
|
9
|
+
|
@@ -4,6 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**document_is_valid** | **BOOLEAN** | True if the document is valid and has no errors, false otherwise | [optional]
|
7
|
+
**password_protected** | **BOOLEAN** | True if the document is password protected, false otherwise | [optional]
|
7
8
|
**error_count** | **Integer** | Number of validation errors found in the document | [optional]
|
8
9
|
**warning_count** | **Integer** | Number of validation warnings found in the document | [optional]
|
9
10
|
**errors_and_warnings** | [**Array<DocumentValidationError>**](DocumentValidationError.md) | Details of errors and warnings found | [optional]
|
data/docs/ValidateDocumentApi.md
CHANGED
@@ -235,7 +235,7 @@ Name | Type | Description | Notes
|
|
235
235
|
|
236
236
|
Validate a PDF document file
|
237
237
|
|
238
|
-
Validate a PDF document; if the document is not valid, identifies the errors in the document
|
238
|
+
Validate a PDF document; if the document is not valid, identifies the errors in the document. Also checks if the PDF is password protected.
|
239
239
|
|
240
240
|
### Example
|
241
241
|
```ruby
|
@@ -39,6 +39,8 @@ require 'cloudmersive-convert-api-client/models/create_blank_spreadsheet_respons
|
|
39
39
|
require 'cloudmersive-convert-api-client/models/create_spreadsheet_from_data_request'
|
40
40
|
require 'cloudmersive-convert-api-client/models/create_spreadsheet_from_data_response'
|
41
41
|
require 'cloudmersive-convert-api-client/models/create_zip_archive_request'
|
42
|
+
require 'cloudmersive-convert-api-client/models/csv_collection'
|
43
|
+
require 'cloudmersive-convert-api-client/models/csv_file_result'
|
42
44
|
require 'cloudmersive-convert-api-client/models/delete_docx_table_row_range_request'
|
43
45
|
require 'cloudmersive-convert-api-client/models/delete_docx_table_row_range_response'
|
44
46
|
require 'cloudmersive-convert-api-client/models/delete_docx_table_row_request'
|
@@ -1572,22 +1572,22 @@ module CloudmersiveConvertApiClient
|
|
1572
1572
|
return data, status_code, headers
|
1573
1573
|
end
|
1574
1574
|
|
1575
|
-
# Convert Excel XLSX Spreadsheet to CSV
|
1576
|
-
# Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format. Supports both XLSX and XLSB file Excel formats.
|
1575
|
+
# Convert Excel XLSX Spreadsheet to CSV, Single Worksheet
|
1576
|
+
# Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format. Supports both XLSX and XLSB file Excel formats. If the input file contains multiple worksheets, the first one is used. If you wish to convert all of the worksheets (not just the first one), be sure to use the xlsx/to/csv/multi API.
|
1577
1577
|
# @param input_file Input file to perform the operation on.
|
1578
1578
|
# @param [Hash] opts the optional parameters
|
1579
|
-
# @option opts [String] :output_encoding Optional, set the output text encoding for the result; possible values are UTF-8 and UTF-32. Default is UTF-
|
1579
|
+
# @option opts [String] :output_encoding Optional, set the output text encoding for the result; possible values are UTF-8, ASCII and UTF-32. Default is UTF-8.
|
1580
1580
|
# @return [String]
|
1581
1581
|
def convert_document_xlsx_to_csv(input_file, opts = {})
|
1582
1582
|
data, _status_code, _headers = convert_document_xlsx_to_csv_with_http_info(input_file, opts)
|
1583
1583
|
return data
|
1584
1584
|
end
|
1585
1585
|
|
1586
|
-
# Convert Excel XLSX Spreadsheet to CSV
|
1587
|
-
# Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format. Supports both XLSX and XLSB file Excel formats.
|
1586
|
+
# Convert Excel XLSX Spreadsheet to CSV, Single Worksheet
|
1587
|
+
# Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format. Supports both XLSX and XLSB file Excel formats. If the input file contains multiple worksheets, the first one is used. If you wish to convert all of the worksheets (not just the first one), be sure to use the xlsx/to/csv/multi API.
|
1588
1588
|
# @param input_file Input file to perform the operation on.
|
1589
1589
|
# @param [Hash] opts the optional parameters
|
1590
|
-
# @option opts [String] :output_encoding Optional, set the output text encoding for the result; possible values are UTF-8 and UTF-32. Default is UTF-
|
1590
|
+
# @option opts [String] :output_encoding Optional, set the output text encoding for the result; possible values are UTF-8, ASCII and UTF-32. Default is UTF-8.
|
1591
1591
|
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
1592
1592
|
def convert_document_xlsx_to_csv_with_http_info(input_file, opts = {})
|
1593
1593
|
if @api_client.config.debugging
|
@@ -1631,6 +1631,65 @@ module CloudmersiveConvertApiClient
|
|
1631
1631
|
return data, status_code, headers
|
1632
1632
|
end
|
1633
1633
|
|
1634
|
+
# Convert Excel XLSX Spreadsheet to CSV, Multiple Worksheets
|
1635
|
+
# Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format, with support for multiple worksheets. Supports both XLSX and XLSB file Excel formats. Returns multiple CSV files, one for each worksheet (tab) in the spreadsheet.
|
1636
|
+
# @param input_file Input file to perform the operation on.
|
1637
|
+
# @param [Hash] opts the optional parameters
|
1638
|
+
# @option opts [String] :output_encoding Optional, set the output text encoding for the result; possible values are UTF-8, ASCII and UTF-32. Default is UTF-8.
|
1639
|
+
# @return [CsvCollection]
|
1640
|
+
def convert_document_xlsx_to_csv_multi(input_file, opts = {})
|
1641
|
+
data, _status_code, _headers = convert_document_xlsx_to_csv_multi_with_http_info(input_file, opts)
|
1642
|
+
return data
|
1643
|
+
end
|
1644
|
+
|
1645
|
+
# Convert Excel XLSX Spreadsheet to CSV, Multiple Worksheets
|
1646
|
+
# Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format, with support for multiple worksheets. Supports both XLSX and XLSB file Excel formats. Returns multiple CSV files, one for each worksheet (tab) in the spreadsheet.
|
1647
|
+
# @param input_file Input file to perform the operation on.
|
1648
|
+
# @param [Hash] opts the optional parameters
|
1649
|
+
# @option opts [String] :output_encoding Optional, set the output text encoding for the result; possible values are UTF-8, ASCII and UTF-32. Default is UTF-8.
|
1650
|
+
# @return [Array<(CsvCollection, Fixnum, Hash)>] CsvCollection data, response status code and response headers
|
1651
|
+
def convert_document_xlsx_to_csv_multi_with_http_info(input_file, opts = {})
|
1652
|
+
if @api_client.config.debugging
|
1653
|
+
@api_client.config.logger.debug "Calling API: ConvertDocumentApi.convert_document_xlsx_to_csv_multi ..."
|
1654
|
+
end
|
1655
|
+
# verify the required parameter 'input_file' is set
|
1656
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
1657
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling ConvertDocumentApi.convert_document_xlsx_to_csv_multi"
|
1658
|
+
end
|
1659
|
+
# resource path
|
1660
|
+
local_var_path = "/convert/xlsx/to/csv/multi"
|
1661
|
+
|
1662
|
+
# query parameters
|
1663
|
+
query_params = {}
|
1664
|
+
|
1665
|
+
# header parameters
|
1666
|
+
header_params = {}
|
1667
|
+
# HTTP header 'Accept' (if needed)
|
1668
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
|
1669
|
+
# HTTP header 'Content-Type'
|
1670
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
1671
|
+
header_params[:'outputEncoding'] = opts[:'output_encoding'] if !opts[:'output_encoding'].nil?
|
1672
|
+
|
1673
|
+
# form parameters
|
1674
|
+
form_params = {}
|
1675
|
+
form_params["inputFile"] = input_file
|
1676
|
+
|
1677
|
+
# http body (model)
|
1678
|
+
post_body = nil
|
1679
|
+
auth_names = ['Apikey']
|
1680
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1681
|
+
:header_params => header_params,
|
1682
|
+
:query_params => query_params,
|
1683
|
+
:form_params => form_params,
|
1684
|
+
:body => post_body,
|
1685
|
+
:auth_names => auth_names,
|
1686
|
+
:return_type => 'CsvCollection')
|
1687
|
+
if @api_client.config.debugging
|
1688
|
+
@api_client.config.logger.debug "API called: ConvertDocumentApi#convert_document_xlsx_to_csv_multi\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1689
|
+
end
|
1690
|
+
return data, status_code, headers
|
1691
|
+
end
|
1692
|
+
|
1634
1693
|
# Convert Excel XLSX Spreadsheet to PDF
|
1635
1694
|
# Convert Office Excel Workbooks (XLSX) to standard PDF. Converts all worksheets in the workbook to PDF. Supports both XLSX and XLSB Excel file formats.
|
1636
1695
|
# @param input_file Input file to perform the operation on.
|
@@ -245,7 +245,7 @@ module CloudmersiveConvertApiClient
|
|
245
245
|
end
|
246
246
|
|
247
247
|
# Validate a PDF document file
|
248
|
-
# Validate a PDF document; if the document is not valid, identifies the errors in the document
|
248
|
+
# Validate a PDF document; if the document is not valid, identifies the errors in the document. Also checks if the PDF is password protected.
|
249
249
|
# @param input_file Input file to perform the operation on.
|
250
250
|
# @param [Hash] opts the optional parameters
|
251
251
|
# @return [DocumentValidationResult]
|
@@ -255,7 +255,7 @@ module CloudmersiveConvertApiClient
|
|
255
255
|
end
|
256
256
|
|
257
257
|
# Validate a PDF document file
|
258
|
-
# Validate a PDF document; if the document is not valid, identifies the errors in the document
|
258
|
+
# Validate a PDF document; if the document is not valid, identifies the errors in the document. Also checks if the PDF is password protected.
|
259
259
|
# @param input_file Input file to perform the operation on.
|
260
260
|
# @param [Hash] opts the optional parameters
|
261
261
|
# @return [Array<(DocumentValidationResult, Fixnum, Hash)>] DocumentValidationResult data, response status code and response headers
|
@@ -0,0 +1,211 @@
|
|
1
|
+
=begin
|
2
|
+
#convertapi
|
3
|
+
|
4
|
+
#Convert API lets you effortlessly convert file formats and types.
|
5
|
+
|
6
|
+
OpenAPI spec version: v1
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.3.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
|
15
|
+
module CloudmersiveConvertApiClient
|
16
|
+
# Collection of CSV Files
|
17
|
+
class CsvCollection
|
18
|
+
# True if the operation was successful, false otherwise
|
19
|
+
attr_accessor :successful
|
20
|
+
|
21
|
+
# Array of CSV File results
|
22
|
+
attr_accessor :csv_files
|
23
|
+
|
24
|
+
# Count of the number of CSV files produced
|
25
|
+
attr_accessor :file_count
|
26
|
+
|
27
|
+
|
28
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
29
|
+
def self.attribute_map
|
30
|
+
{
|
31
|
+
:'successful' => :'Successful',
|
32
|
+
:'csv_files' => :'CsvFiles',
|
33
|
+
:'file_count' => :'FileCount'
|
34
|
+
}
|
35
|
+
end
|
36
|
+
|
37
|
+
# Attribute type mapping.
|
38
|
+
def self.swagger_types
|
39
|
+
{
|
40
|
+
:'successful' => :'BOOLEAN',
|
41
|
+
:'csv_files' => :'Array<CsvFileResult>',
|
42
|
+
:'file_count' => :'Integer'
|
43
|
+
}
|
44
|
+
end
|
45
|
+
|
46
|
+
# Initializes the object
|
47
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
48
|
+
def initialize(attributes = {})
|
49
|
+
return unless attributes.is_a?(Hash)
|
50
|
+
|
51
|
+
# convert string to symbol for hash key
|
52
|
+
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
53
|
+
|
54
|
+
if attributes.has_key?(:'Successful')
|
55
|
+
self.successful = attributes[:'Successful']
|
56
|
+
end
|
57
|
+
|
58
|
+
if attributes.has_key?(:'CsvFiles')
|
59
|
+
if (value = attributes[:'CsvFiles']).is_a?(Array)
|
60
|
+
self.csv_files = value
|
61
|
+
end
|
62
|
+
end
|
63
|
+
|
64
|
+
if attributes.has_key?(:'FileCount')
|
65
|
+
self.file_count = attributes[:'FileCount']
|
66
|
+
end
|
67
|
+
|
68
|
+
end
|
69
|
+
|
70
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
71
|
+
# @return Array for valid properties with the reasons
|
72
|
+
def list_invalid_properties
|
73
|
+
invalid_properties = Array.new
|
74
|
+
return invalid_properties
|
75
|
+
end
|
76
|
+
|
77
|
+
# Check to see if the all the properties in the model are valid
|
78
|
+
# @return true if the model is valid
|
79
|
+
def valid?
|
80
|
+
return true
|
81
|
+
end
|
82
|
+
|
83
|
+
# Checks equality by comparing each attribute.
|
84
|
+
# @param [Object] Object to be compared
|
85
|
+
def ==(o)
|
86
|
+
return true if self.equal?(o)
|
87
|
+
self.class == o.class &&
|
88
|
+
successful == o.successful &&
|
89
|
+
csv_files == o.csv_files &&
|
90
|
+
file_count == o.file_count
|
91
|
+
end
|
92
|
+
|
93
|
+
# @see the `==` method
|
94
|
+
# @param [Object] Object to be compared
|
95
|
+
def eql?(o)
|
96
|
+
self == o
|
97
|
+
end
|
98
|
+
|
99
|
+
# Calculates hash code according to all attributes.
|
100
|
+
# @return [Fixnum] Hash code
|
101
|
+
def hash
|
102
|
+
[successful, csv_files, file_count].hash
|
103
|
+
end
|
104
|
+
|
105
|
+
# Builds the object from hash
|
106
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
107
|
+
# @return [Object] Returns the model itself
|
108
|
+
def build_from_hash(attributes)
|
109
|
+
return nil unless attributes.is_a?(Hash)
|
110
|
+
self.class.swagger_types.each_pair do |key, type|
|
111
|
+
if type =~ /\AArray<(.*)>/i
|
112
|
+
# check to ensure the input is an array given that the the attribute
|
113
|
+
# is documented as an array but the input is not
|
114
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
115
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
|
116
|
+
end
|
117
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
118
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
119
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
120
|
+
end
|
121
|
+
|
122
|
+
self
|
123
|
+
end
|
124
|
+
|
125
|
+
# Deserializes the data based on type
|
126
|
+
# @param string type Data type
|
127
|
+
# @param string value Value to be deserialized
|
128
|
+
# @return [Object] Deserialized data
|
129
|
+
def _deserialize(type, value)
|
130
|
+
case type.to_sym
|
131
|
+
when :DateTime
|
132
|
+
DateTime.parse(value)
|
133
|
+
when :Date
|
134
|
+
Date.parse(value)
|
135
|
+
when :String
|
136
|
+
value.to_s
|
137
|
+
when :Integer
|
138
|
+
value.to_i
|
139
|
+
when :Float
|
140
|
+
value.to_f
|
141
|
+
when :BOOLEAN
|
142
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
143
|
+
true
|
144
|
+
else
|
145
|
+
false
|
146
|
+
end
|
147
|
+
when :Object
|
148
|
+
# generic object (usually a Hash), return directly
|
149
|
+
value
|
150
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
151
|
+
inner_type = Regexp.last_match[:inner_type]
|
152
|
+
value.map { |v| _deserialize(inner_type, v) }
|
153
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
154
|
+
k_type = Regexp.last_match[:k_type]
|
155
|
+
v_type = Regexp.last_match[:v_type]
|
156
|
+
{}.tap do |hash|
|
157
|
+
value.each do |k, v|
|
158
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
159
|
+
end
|
160
|
+
end
|
161
|
+
else # model
|
162
|
+
temp_model = CloudmersiveConvertApiClient.const_get(type).new
|
163
|
+
temp_model.build_from_hash(value)
|
164
|
+
end
|
165
|
+
end
|
166
|
+
|
167
|
+
# Returns the string representation of the object
|
168
|
+
# @return [String] String presentation of the object
|
169
|
+
def to_s
|
170
|
+
to_hash.to_s
|
171
|
+
end
|
172
|
+
|
173
|
+
# to_body is an alias to to_hash (backward compatibility)
|
174
|
+
# @return [Hash] Returns the object in the form of hash
|
175
|
+
def to_body
|
176
|
+
to_hash
|
177
|
+
end
|
178
|
+
|
179
|
+
# Returns the object in the form of hash
|
180
|
+
# @return [Hash] Returns the object in the form of hash
|
181
|
+
def to_hash
|
182
|
+
hash = {}
|
183
|
+
self.class.attribute_map.each_pair do |attr, param|
|
184
|
+
value = self.send(attr)
|
185
|
+
next if value.nil?
|
186
|
+
hash[param] = _to_hash(value)
|
187
|
+
end
|
188
|
+
hash
|
189
|
+
end
|
190
|
+
|
191
|
+
# Outputs non-array value in the form of hash
|
192
|
+
# For object, use to_hash. Otherwise, just return the value
|
193
|
+
# @param [Object] value Any valid value
|
194
|
+
# @return [Hash] Returns the value in the form of hash
|
195
|
+
def _to_hash(value)
|
196
|
+
if value.is_a?(Array)
|
197
|
+
value.compact.map{ |v| _to_hash(v) }
|
198
|
+
elsif value.is_a?(Hash)
|
199
|
+
{}.tap do |hash|
|
200
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
201
|
+
end
|
202
|
+
elsif value.respond_to? :to_hash
|
203
|
+
value.to_hash
|
204
|
+
else
|
205
|
+
value
|
206
|
+
end
|
207
|
+
end
|
208
|
+
|
209
|
+
end
|
210
|
+
|
211
|
+
end
|
@@ -0,0 +1,215 @@
|
|
1
|
+
=begin
|
2
|
+
#convertapi
|
3
|
+
|
4
|
+
#Convert API lets you effortlessly convert file formats and types.
|
5
|
+
|
6
|
+
OpenAPI spec version: v1
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.3.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
|
15
|
+
module CloudmersiveConvertApiClient
|
16
|
+
# CSV file result
|
17
|
+
class CsvFileResult
|
18
|
+
# Title of the CSV file
|
19
|
+
attr_accessor :title
|
20
|
+
|
21
|
+
# Contents of the CSV file
|
22
|
+
attr_accessor :file_contents
|
23
|
+
|
24
|
+
|
25
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
26
|
+
def self.attribute_map
|
27
|
+
{
|
28
|
+
:'title' => :'Title',
|
29
|
+
:'file_contents' => :'FileContents'
|
30
|
+
}
|
31
|
+
end
|
32
|
+
|
33
|
+
# Attribute type mapping.
|
34
|
+
def self.swagger_types
|
35
|
+
{
|
36
|
+
:'title' => :'String',
|
37
|
+
:'file_contents' => :'String'
|
38
|
+
}
|
39
|
+
end
|
40
|
+
|
41
|
+
# Initializes the object
|
42
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
43
|
+
def initialize(attributes = {})
|
44
|
+
return unless attributes.is_a?(Hash)
|
45
|
+
|
46
|
+
# convert string to symbol for hash key
|
47
|
+
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
48
|
+
|
49
|
+
if attributes.has_key?(:'Title')
|
50
|
+
self.title = attributes[:'Title']
|
51
|
+
end
|
52
|
+
|
53
|
+
if attributes.has_key?(:'FileContents')
|
54
|
+
self.file_contents = attributes[:'FileContents']
|
55
|
+
end
|
56
|
+
|
57
|
+
end
|
58
|
+
|
59
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
60
|
+
# @return Array for valid properties with the reasons
|
61
|
+
def list_invalid_properties
|
62
|
+
invalid_properties = Array.new
|
63
|
+
if !@file_contents.nil? && @file_contents !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
|
64
|
+
invalid_properties.push("invalid value for 'file_contents', must conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/.")
|
65
|
+
end
|
66
|
+
|
67
|
+
return invalid_properties
|
68
|
+
end
|
69
|
+
|
70
|
+
# Check to see if the all the properties in the model are valid
|
71
|
+
# @return true if the model is valid
|
72
|
+
def valid?
|
73
|
+
return false if !@file_contents.nil? && @file_contents !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
|
74
|
+
return true
|
75
|
+
end
|
76
|
+
|
77
|
+
# Custom attribute writer method with validation
|
78
|
+
# @param [Object] file_contents Value to be assigned
|
79
|
+
def file_contents=(file_contents)
|
80
|
+
|
81
|
+
if !file_contents.nil? && file_contents !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
|
82
|
+
fail ArgumentError, "invalid value for 'file_contents', must conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/."
|
83
|
+
end
|
84
|
+
|
85
|
+
@file_contents = file_contents
|
86
|
+
end
|
87
|
+
|
88
|
+
# Checks equality by comparing each attribute.
|
89
|
+
# @param [Object] Object to be compared
|
90
|
+
def ==(o)
|
91
|
+
return true if self.equal?(o)
|
92
|
+
self.class == o.class &&
|
93
|
+
title == o.title &&
|
94
|
+
file_contents == o.file_contents
|
95
|
+
end
|
96
|
+
|
97
|
+
# @see the `==` method
|
98
|
+
# @param [Object] Object to be compared
|
99
|
+
def eql?(o)
|
100
|
+
self == o
|
101
|
+
end
|
102
|
+
|
103
|
+
# Calculates hash code according to all attributes.
|
104
|
+
# @return [Fixnum] Hash code
|
105
|
+
def hash
|
106
|
+
[title, file_contents].hash
|
107
|
+
end
|
108
|
+
|
109
|
+
# Builds the object from hash
|
110
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
111
|
+
# @return [Object] Returns the model itself
|
112
|
+
def build_from_hash(attributes)
|
113
|
+
return nil unless attributes.is_a?(Hash)
|
114
|
+
self.class.swagger_types.each_pair do |key, type|
|
115
|
+
if type =~ /\AArray<(.*)>/i
|
116
|
+
# check to ensure the input is an array given that the the attribute
|
117
|
+
# is documented as an array but the input is not
|
118
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
119
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
|
120
|
+
end
|
121
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
122
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
123
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
124
|
+
end
|
125
|
+
|
126
|
+
self
|
127
|
+
end
|
128
|
+
|
129
|
+
# Deserializes the data based on type
|
130
|
+
# @param string type Data type
|
131
|
+
# @param string value Value to be deserialized
|
132
|
+
# @return [Object] Deserialized data
|
133
|
+
def _deserialize(type, value)
|
134
|
+
case type.to_sym
|
135
|
+
when :DateTime
|
136
|
+
DateTime.parse(value)
|
137
|
+
when :Date
|
138
|
+
Date.parse(value)
|
139
|
+
when :String
|
140
|
+
value.to_s
|
141
|
+
when :Integer
|
142
|
+
value.to_i
|
143
|
+
when :Float
|
144
|
+
value.to_f
|
145
|
+
when :BOOLEAN
|
146
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
147
|
+
true
|
148
|
+
else
|
149
|
+
false
|
150
|
+
end
|
151
|
+
when :Object
|
152
|
+
# generic object (usually a Hash), return directly
|
153
|
+
value
|
154
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
155
|
+
inner_type = Regexp.last_match[:inner_type]
|
156
|
+
value.map { |v| _deserialize(inner_type, v) }
|
157
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
158
|
+
k_type = Regexp.last_match[:k_type]
|
159
|
+
v_type = Regexp.last_match[:v_type]
|
160
|
+
{}.tap do |hash|
|
161
|
+
value.each do |k, v|
|
162
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
163
|
+
end
|
164
|
+
end
|
165
|
+
else # model
|
166
|
+
temp_model = CloudmersiveConvertApiClient.const_get(type).new
|
167
|
+
temp_model.build_from_hash(value)
|
168
|
+
end
|
169
|
+
end
|
170
|
+
|
171
|
+
# Returns the string representation of the object
|
172
|
+
# @return [String] String presentation of the object
|
173
|
+
def to_s
|
174
|
+
to_hash.to_s
|
175
|
+
end
|
176
|
+
|
177
|
+
# to_body is an alias to to_hash (backward compatibility)
|
178
|
+
# @return [Hash] Returns the object in the form of hash
|
179
|
+
def to_body
|
180
|
+
to_hash
|
181
|
+
end
|
182
|
+
|
183
|
+
# Returns the object in the form of hash
|
184
|
+
# @return [Hash] Returns the object in the form of hash
|
185
|
+
def to_hash
|
186
|
+
hash = {}
|
187
|
+
self.class.attribute_map.each_pair do |attr, param|
|
188
|
+
value = self.send(attr)
|
189
|
+
next if value.nil?
|
190
|
+
hash[param] = _to_hash(value)
|
191
|
+
end
|
192
|
+
hash
|
193
|
+
end
|
194
|
+
|
195
|
+
# Outputs non-array value in the form of hash
|
196
|
+
# For object, use to_hash. Otherwise, just return the value
|
197
|
+
# @param [Object] value Any valid value
|
198
|
+
# @return [Hash] Returns the value in the form of hash
|
199
|
+
def _to_hash(value)
|
200
|
+
if value.is_a?(Array)
|
201
|
+
value.compact.map{ |v| _to_hash(v) }
|
202
|
+
elsif value.is_a?(Hash)
|
203
|
+
{}.tap do |hash|
|
204
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
205
|
+
end
|
206
|
+
elsif value.respond_to? :to_hash
|
207
|
+
value.to_hash
|
208
|
+
else
|
209
|
+
value
|
210
|
+
end
|
211
|
+
end
|
212
|
+
|
213
|
+
end
|
214
|
+
|
215
|
+
end
|
@@ -18,6 +18,9 @@ module CloudmersiveConvertApiClient
|
|
18
18
|
# True if the document is valid and has no errors, false otherwise
|
19
19
|
attr_accessor :document_is_valid
|
20
20
|
|
21
|
+
# True if the document is password protected, false otherwise
|
22
|
+
attr_accessor :password_protected
|
23
|
+
|
21
24
|
# Number of validation errors found in the document
|
22
25
|
attr_accessor :error_count
|
23
26
|
|
@@ -32,6 +35,7 @@ module CloudmersiveConvertApiClient
|
|
32
35
|
def self.attribute_map
|
33
36
|
{
|
34
37
|
:'document_is_valid' => :'DocumentIsValid',
|
38
|
+
:'password_protected' => :'PasswordProtected',
|
35
39
|
:'error_count' => :'ErrorCount',
|
36
40
|
:'warning_count' => :'WarningCount',
|
37
41
|
:'errors_and_warnings' => :'ErrorsAndWarnings'
|
@@ -42,6 +46,7 @@ module CloudmersiveConvertApiClient
|
|
42
46
|
def self.swagger_types
|
43
47
|
{
|
44
48
|
:'document_is_valid' => :'BOOLEAN',
|
49
|
+
:'password_protected' => :'BOOLEAN',
|
45
50
|
:'error_count' => :'Integer',
|
46
51
|
:'warning_count' => :'Integer',
|
47
52
|
:'errors_and_warnings' => :'Array<DocumentValidationError>'
|
@@ -60,6 +65,10 @@ module CloudmersiveConvertApiClient
|
|
60
65
|
self.document_is_valid = attributes[:'DocumentIsValid']
|
61
66
|
end
|
62
67
|
|
68
|
+
if attributes.has_key?(:'PasswordProtected')
|
69
|
+
self.password_protected = attributes[:'PasswordProtected']
|
70
|
+
end
|
71
|
+
|
63
72
|
if attributes.has_key?(:'ErrorCount')
|
64
73
|
self.error_count = attributes[:'ErrorCount']
|
65
74
|
end
|
@@ -95,6 +104,7 @@ module CloudmersiveConvertApiClient
|
|
95
104
|
return true if self.equal?(o)
|
96
105
|
self.class == o.class &&
|
97
106
|
document_is_valid == o.document_is_valid &&
|
107
|
+
password_protected == o.password_protected &&
|
98
108
|
error_count == o.error_count &&
|
99
109
|
warning_count == o.warning_count &&
|
100
110
|
errors_and_warnings == o.errors_and_warnings
|
@@ -109,7 +119,7 @@ module CloudmersiveConvertApiClient
|
|
109
119
|
# Calculates hash code according to all attributes.
|
110
120
|
# @return [Fixnum] Hash code
|
111
121
|
def hash
|
112
|
-
[document_is_valid, error_count, warning_count, errors_and_warnings].hash
|
122
|
+
[document_is_valid, password_protected, error_count, warning_count, errors_and_warnings].hash
|
113
123
|
end
|
114
124
|
|
115
125
|
# Builds the object from hash
|
@@ -369,11 +369,11 @@ describe 'ConvertDocumentApi' do
|
|
369
369
|
end
|
370
370
|
|
371
371
|
# unit tests for convert_document_xlsx_to_csv
|
372
|
-
# Convert Excel XLSX Spreadsheet to CSV
|
373
|
-
# Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format. Supports both XLSX and XLSB file Excel formats.
|
372
|
+
# Convert Excel XLSX Spreadsheet to CSV, Single Worksheet
|
373
|
+
# Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format. Supports both XLSX and XLSB file Excel formats. If the input file contains multiple worksheets, the first one is used. If you wish to convert all of the worksheets (not just the first one), be sure to use the xlsx/to/csv/multi API.
|
374
374
|
# @param input_file Input file to perform the operation on.
|
375
375
|
# @param [Hash] opts the optional parameters
|
376
|
-
# @option opts [String] :output_encoding Optional, set the output text encoding for the result; possible values are UTF-8 and UTF-32. Default is UTF-
|
376
|
+
# @option opts [String] :output_encoding Optional, set the output text encoding for the result; possible values are UTF-8, ASCII and UTF-32. Default is UTF-8.
|
377
377
|
# @return [String]
|
378
378
|
describe 'convert_document_xlsx_to_csv test' do
|
379
379
|
it "should work" do
|
@@ -381,6 +381,19 @@ describe 'ConvertDocumentApi' do
|
|
381
381
|
end
|
382
382
|
end
|
383
383
|
|
384
|
+
# unit tests for convert_document_xlsx_to_csv_multi
|
385
|
+
# Convert Excel XLSX Spreadsheet to CSV, Multiple Worksheets
|
386
|
+
# Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format, with support for multiple worksheets. Supports both XLSX and XLSB file Excel formats. Returns multiple CSV files, one for each worksheet (tab) in the spreadsheet.
|
387
|
+
# @param input_file Input file to perform the operation on.
|
388
|
+
# @param [Hash] opts the optional parameters
|
389
|
+
# @option opts [String] :output_encoding Optional, set the output text encoding for the result; possible values are UTF-8, ASCII and UTF-32. Default is UTF-8.
|
390
|
+
# @return [CsvCollection]
|
391
|
+
describe 'convert_document_xlsx_to_csv_multi test' do
|
392
|
+
it "should work" do
|
393
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
394
|
+
end
|
395
|
+
end
|
396
|
+
|
384
397
|
# unit tests for convert_document_xlsx_to_pdf
|
385
398
|
# Convert Excel XLSX Spreadsheet to PDF
|
386
399
|
# Convert Office Excel Workbooks (XLSX) to standard PDF. Converts all worksheets in the workbook to PDF. Supports both XLSX and XLSB Excel file formats.
|
@@ -82,7 +82,7 @@ describe 'ValidateDocumentApi' do
|
|
82
82
|
|
83
83
|
# unit tests for validate_document_pdf_validation
|
84
84
|
# Validate a PDF document file
|
85
|
-
# Validate a PDF document; if the document is not valid, identifies the errors in the document
|
85
|
+
# Validate a PDF document; if the document is not valid, identifies the errors in the document. Also checks if the PDF is password protected.
|
86
86
|
# @param input_file Input file to perform the operation on.
|
87
87
|
# @param [Hash] opts the optional parameters
|
88
88
|
# @return [DocumentValidationResult]
|
@@ -0,0 +1,54 @@
|
|
1
|
+
=begin
|
2
|
+
#convertapi
|
3
|
+
|
4
|
+
#Convert API lets you effortlessly convert file formats and types.
|
5
|
+
|
6
|
+
OpenAPI spec version: v1
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.3.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
require 'date'
|
16
|
+
|
17
|
+
# Unit tests for CloudmersiveConvertApiClient::CsvCollection
|
18
|
+
# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
|
19
|
+
# Please update as you see appropriate
|
20
|
+
describe 'CsvCollection' do
|
21
|
+
before do
|
22
|
+
# run before each test
|
23
|
+
@instance = CloudmersiveConvertApiClient::CsvCollection.new
|
24
|
+
end
|
25
|
+
|
26
|
+
after do
|
27
|
+
# run after each test
|
28
|
+
end
|
29
|
+
|
30
|
+
describe 'test an instance of CsvCollection' do
|
31
|
+
it 'should create an instance of CsvCollection' do
|
32
|
+
expect(@instance).to be_instance_of(CloudmersiveConvertApiClient::CsvCollection)
|
33
|
+
end
|
34
|
+
end
|
35
|
+
describe 'test attribute "successful"' do
|
36
|
+
it 'should work' do
|
37
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
describe 'test attribute "csv_files"' do
|
42
|
+
it 'should work' do
|
43
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
44
|
+
end
|
45
|
+
end
|
46
|
+
|
47
|
+
describe 'test attribute "file_count"' do
|
48
|
+
it 'should work' do
|
49
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
50
|
+
end
|
51
|
+
end
|
52
|
+
|
53
|
+
end
|
54
|
+
|
@@ -0,0 +1,48 @@
|
|
1
|
+
=begin
|
2
|
+
#convertapi
|
3
|
+
|
4
|
+
#Convert API lets you effortlessly convert file formats and types.
|
5
|
+
|
6
|
+
OpenAPI spec version: v1
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.3.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
require 'date'
|
16
|
+
|
17
|
+
# Unit tests for CloudmersiveConvertApiClient::CsvFileResult
|
18
|
+
# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
|
19
|
+
# Please update as you see appropriate
|
20
|
+
describe 'CsvFileResult' do
|
21
|
+
before do
|
22
|
+
# run before each test
|
23
|
+
@instance = CloudmersiveConvertApiClient::CsvFileResult.new
|
24
|
+
end
|
25
|
+
|
26
|
+
after do
|
27
|
+
# run after each test
|
28
|
+
end
|
29
|
+
|
30
|
+
describe 'test an instance of CsvFileResult' do
|
31
|
+
it 'should create an instance of CsvFileResult' do
|
32
|
+
expect(@instance).to be_instance_of(CloudmersiveConvertApiClient::CsvFileResult)
|
33
|
+
end
|
34
|
+
end
|
35
|
+
describe 'test attribute "title"' do
|
36
|
+
it 'should work' do
|
37
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
describe 'test attribute "file_contents"' do
|
42
|
+
it 'should work' do
|
43
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
44
|
+
end
|
45
|
+
end
|
46
|
+
|
47
|
+
end
|
48
|
+
|
@@ -38,6 +38,12 @@ describe 'DocumentValidationResult' do
|
|
38
38
|
end
|
39
39
|
end
|
40
40
|
|
41
|
+
describe 'test attribute "password_protected"' do
|
42
|
+
it 'should work' do
|
43
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
44
|
+
end
|
45
|
+
end
|
46
|
+
|
41
47
|
describe 'test attribute "error_count"' do
|
42
48
|
it 'should work' do
|
43
49
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: cloudmersive-convert-api-client
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.7.
|
4
|
+
version: 1.7.4
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Cloudmersive
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-
|
11
|
+
date: 2020-04-19 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|
@@ -230,6 +230,8 @@ files:
|
|
230
230
|
- "./docs/CreateSpreadsheetFromDataRequest.md"
|
231
231
|
- "./docs/CreateSpreadsheetFromDataResponse.md"
|
232
232
|
- "./docs/CreateZipArchiveRequest.md"
|
233
|
+
- "./docs/CsvCollection.md"
|
234
|
+
- "./docs/CsvFileResult.md"
|
233
235
|
- "./docs/DeleteDocxTableRowRangeRequest.md"
|
234
236
|
- "./docs/DeleteDocxTableRowRangeResponse.md"
|
235
237
|
- "./docs/DeleteDocxTableRowRequest.md"
|
@@ -452,6 +454,8 @@ files:
|
|
452
454
|
- "./lib/cloudmersive-convert-api-client/models/create_spreadsheet_from_data_request.rb"
|
453
455
|
- "./lib/cloudmersive-convert-api-client/models/create_spreadsheet_from_data_response.rb"
|
454
456
|
- "./lib/cloudmersive-convert-api-client/models/create_zip_archive_request.rb"
|
457
|
+
- "./lib/cloudmersive-convert-api-client/models/csv_collection.rb"
|
458
|
+
- "./lib/cloudmersive-convert-api-client/models/csv_file_result.rb"
|
455
459
|
- "./lib/cloudmersive-convert-api-client/models/delete_docx_table_row_range_request.rb"
|
456
460
|
- "./lib/cloudmersive-convert-api-client/models/delete_docx_table_row_range_response.rb"
|
457
461
|
- "./lib/cloudmersive-convert-api-client/models/delete_docx_table_row_request.rb"
|
@@ -664,6 +668,8 @@ files:
|
|
664
668
|
- "./spec/models/create_spreadsheet_from_data_request_spec.rb"
|
665
669
|
- "./spec/models/create_spreadsheet_from_data_response_spec.rb"
|
666
670
|
- "./spec/models/create_zip_archive_request_spec.rb"
|
671
|
+
- "./spec/models/csv_collection_spec.rb"
|
672
|
+
- "./spec/models/csv_file_result_spec.rb"
|
667
673
|
- "./spec/models/delete_docx_table_row_range_request_spec.rb"
|
668
674
|
- "./spec/models/delete_docx_table_row_range_response_spec.rb"
|
669
675
|
- "./spec/models/delete_docx_table_row_request_spec.rb"
|