cloudmersive-convert-api-client 1.3.8 → 1.3.9

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: 3972e7ff307a895a1c8f4538a28a8b18b1bac6d4524cc7dd2090b53eb27286c8
4
- data.tar.gz: a2cb514fd1065b06d89eb9e02050753cba10d8ec1afd53b2b5380b1dca9e3923
3
+ metadata.gz: 5bf41bc6a8d9b3cd3d377fbca541c6ac0334db382ec480958e060b3cb8dffa01
4
+ data.tar.gz: 00d98891c634853431c966966f062fdf8b1f5cef5ab9e21ec4d8c838dd07098a
5
5
  SHA512:
6
- metadata.gz: 3c52ced3b4dc5d2665b13cda6b3f85e349d87231ad02faa8c691b3be29a2365c12ee88b45586adeb65fcb0b49ec71452312abee0b02b008fe44725a25df95468
7
- data.tar.gz: 72d69476c5deecdc5b5e2e7532b69273664e9b3f62e9e7fb046e6d534a51180a4d5011c54a7358ee79938bfaf3b7a43b7e8170b554be505112c7bfc304dbd94b
6
+ metadata.gz: bcf8c79c7d93eb840f66347108632d5e0ec4ae7e008116ed38a7c468d274ae21f5e01c2a40f82ce602f970c7b3849d776e806f0fcdf7c77c3dfaaeea57c8078a
7
+ data.tar.gz: e28c4aeedde1376eb949a908fa1c64c2f3c300b472ea878621bbf747c1cbf616591f8e40c983c924147c7aeca66d84a2acbea1b06e61c2e4b00a7b4287f3c47b
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.3.8
10
+ - Package version: 1.3.9
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.3.8.gem
26
+ gem install ./cloudmersive-convert-api-client-1.3.9.gem
27
27
  ```
28
- (for development, run `gem install --dev ./cloudmersive-convert-api-client-1.3.8.gem` to install the development dependencies)
28
+ (for development, run `gem install --dev ./cloudmersive-convert-api-client-1.3.9.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.3.8'
34
+ gem 'cloudmersive-convert-api-client', '~> 1.3.9'
35
35
 
36
36
  ### Install from Git
37
37
 
@@ -93,22 +93,27 @@ Class | Method | HTTP request | Description
93
93
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_autodetect_get_info**](docs/ConvertDocumentApi.md#convert_document_autodetect_get_info) | **POST** /convert/autodetect/get-info | Get document type information
94
94
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_autodetect_to_pdf**](docs/ConvertDocumentApi.md#convert_document_autodetect_to_pdf) | **POST** /convert/autodetect/to/pdf | Convert Document to PDF
95
95
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_autodetect_to_png_array**](docs/ConvertDocumentApi.md#convert_document_autodetect_to_png_array) | **POST** /convert/autodetect/to/png | Convert Document to PNG array
96
+ *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_autodetect_to_txt**](docs/ConvertDocumentApi.md#convert_document_autodetect_to_txt) | **POST** /convert/autodetect/to/txt | Convert Document to Text
96
97
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_csv_to_xlsx**](docs/ConvertDocumentApi.md#convert_document_csv_to_xlsx) | **POST** /convert/csv/to/xlsx | CSV to Excel XLSX
97
98
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_doc_to_docx**](docs/ConvertDocumentApi.md#convert_document_doc_to_docx) | **POST** /convert/doc/to/docx | Word DOC (97-03) to DOCX
98
99
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_doc_to_pdf**](docs/ConvertDocumentApi.md#convert_document_doc_to_pdf) | **POST** /convert/doc/to/pdf | Word DOC (97-03) to PDF
99
100
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_docx_to_pdf**](docs/ConvertDocumentApi.md#convert_document_docx_to_pdf) | **POST** /convert/docx/to/pdf | Word DOCX to PDF
101
+ *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_docx_to_txt**](docs/ConvertDocumentApi.md#convert_document_docx_to_txt) | **POST** /convert/docx/to/txt | Word DOCX to Text
100
102
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_html_to_pdf**](docs/ConvertDocumentApi.md#convert_document_html_to_pdf) | **POST** /convert/html/to/pdf | HTML to PDF
101
103
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_html_to_png**](docs/ConvertDocumentApi.md#convert_document_html_to_png) | **POST** /convert/html/to/png | HTML to PNG array
102
104
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_pdf_to_docx**](docs/ConvertDocumentApi.md#convert_document_pdf_to_docx) | **POST** /convert/pdf/to/docx | PDF to Word DOCX
103
105
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_pdf_to_png_array**](docs/ConvertDocumentApi.md#convert_document_pdf_to_png_array) | **POST** /convert/pdf/to/png | PDF to PNG Array
104
106
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_pdf_to_pptx**](docs/ConvertDocumentApi.md#convert_document_pdf_to_pptx) | **POST** /convert/pdf/to/pptx | PDF to PowerPoint PPTX
107
+ *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_pdf_to_txt**](docs/ConvertDocumentApi.md#convert_document_pdf_to_txt) | **POST** /convert/pdf/to/txt | PDF to Text
105
108
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_ppt_to_pdf**](docs/ConvertDocumentApi.md#convert_document_ppt_to_pdf) | **POST** /convert/ppt/to/pdf | PowerPoint PPT (97-03) to PDF
106
109
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_ppt_to_pptx**](docs/ConvertDocumentApi.md#convert_document_ppt_to_pptx) | **POST** /convert/ppt/to/pptx | PowerPoint PPT (97-03) to PPTX
107
110
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_pptx_to_pdf**](docs/ConvertDocumentApi.md#convert_document_pptx_to_pdf) | **POST** /convert/pptx/to/pdf | PowerPoint PPTX to PDF
111
+ *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_pptx_to_txt**](docs/ConvertDocumentApi.md#convert_document_pptx_to_txt) | **POST** /convert/pptx/to/txt | PowerPoint PPTX to Text
108
112
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_xls_to_pdf**](docs/ConvertDocumentApi.md#convert_document_xls_to_pdf) | **POST** /convert/xls/to/pdf | Excel XLS (97-03) to PDF
109
113
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_xls_to_xlsx**](docs/ConvertDocumentApi.md#convert_document_xls_to_xlsx) | **POST** /convert/xls/to/xlsx | Excel XLS (97-03) to XLSX
110
114
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_xlsx_to_csv**](docs/ConvertDocumentApi.md#convert_document_xlsx_to_csv) | **POST** /convert/xlsx/to/csv | Excel XLSX to CSV
111
115
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_xlsx_to_pdf**](docs/ConvertDocumentApi.md#convert_document_xlsx_to_pdf) | **POST** /convert/xlsx/to/pdf | Excel XLSX to PDF
116
+ *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_xlsx_to_txt**](docs/ConvertDocumentApi.md#convert_document_xlsx_to_txt) | **POST** /convert/xlsx/to/txt | Excel XLSX to Text
112
117
  *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
113
118
  *CloudmersiveConvertApiClient::ConvertImageApi* | [**convert_image_image_format_convert**](docs/ConvertImageApi.md#convert_image_image_format_convert) | **POST** /convert/image/{format1}/to/{format2} | Image format conversion
114
119
  *CloudmersiveConvertApiClient::ConvertImageApi* | [**convert_image_image_set_dpi**](docs/ConvertImageApi.md#convert_image_image_set_dpi) | **POST** /convert/image/set-dpi/{dpi} | Change image DPI
@@ -228,6 +233,7 @@ Class | Method | HTTP request | Description
228
233
  - [CloudmersiveConvertApiClient::RemoveDocxHeadersAndFootersResponse](docs/RemoveDocxHeadersAndFootersResponse.md)
229
234
  - [CloudmersiveConvertApiClient::ReplaceStringRequest](docs/ReplaceStringRequest.md)
230
235
  - [CloudmersiveConvertApiClient::ScreenshotRequest](docs/ScreenshotRequest.md)
236
+ - [CloudmersiveConvertApiClient::TextConversionResult](docs/TextConversionResult.md)
231
237
  - [CloudmersiveConvertApiClient::ViewerResponse](docs/ViewerResponse.md)
232
238
  - [CloudmersiveConvertApiClient::XlsxImage](docs/XlsxImage.md)
233
239
  - [CloudmersiveConvertApiClient::XlsxSpreadsheetCell](docs/XlsxSpreadsheetCell.md)
@@ -7,22 +7,27 @@ Method | HTTP request | Description
7
7
  [**convert_document_autodetect_get_info**](ConvertDocumentApi.md#convert_document_autodetect_get_info) | **POST** /convert/autodetect/get-info | Get document type information
8
8
  [**convert_document_autodetect_to_pdf**](ConvertDocumentApi.md#convert_document_autodetect_to_pdf) | **POST** /convert/autodetect/to/pdf | Convert Document to PDF
9
9
  [**convert_document_autodetect_to_png_array**](ConvertDocumentApi.md#convert_document_autodetect_to_png_array) | **POST** /convert/autodetect/to/png | Convert Document to PNG array
10
+ [**convert_document_autodetect_to_txt**](ConvertDocumentApi.md#convert_document_autodetect_to_txt) | **POST** /convert/autodetect/to/txt | Convert Document to Text
10
11
  [**convert_document_csv_to_xlsx**](ConvertDocumentApi.md#convert_document_csv_to_xlsx) | **POST** /convert/csv/to/xlsx | CSV to Excel XLSX
11
12
  [**convert_document_doc_to_docx**](ConvertDocumentApi.md#convert_document_doc_to_docx) | **POST** /convert/doc/to/docx | Word DOC (97-03) to DOCX
12
13
  [**convert_document_doc_to_pdf**](ConvertDocumentApi.md#convert_document_doc_to_pdf) | **POST** /convert/doc/to/pdf | Word DOC (97-03) to PDF
13
14
  [**convert_document_docx_to_pdf**](ConvertDocumentApi.md#convert_document_docx_to_pdf) | **POST** /convert/docx/to/pdf | Word DOCX to PDF
15
+ [**convert_document_docx_to_txt**](ConvertDocumentApi.md#convert_document_docx_to_txt) | **POST** /convert/docx/to/txt | Word DOCX to Text
14
16
  [**convert_document_html_to_pdf**](ConvertDocumentApi.md#convert_document_html_to_pdf) | **POST** /convert/html/to/pdf | HTML to PDF
15
17
  [**convert_document_html_to_png**](ConvertDocumentApi.md#convert_document_html_to_png) | **POST** /convert/html/to/png | HTML to PNG array
16
18
  [**convert_document_pdf_to_docx**](ConvertDocumentApi.md#convert_document_pdf_to_docx) | **POST** /convert/pdf/to/docx | PDF to Word DOCX
17
19
  [**convert_document_pdf_to_png_array**](ConvertDocumentApi.md#convert_document_pdf_to_png_array) | **POST** /convert/pdf/to/png | PDF to PNG Array
18
20
  [**convert_document_pdf_to_pptx**](ConvertDocumentApi.md#convert_document_pdf_to_pptx) | **POST** /convert/pdf/to/pptx | PDF to PowerPoint PPTX
21
+ [**convert_document_pdf_to_txt**](ConvertDocumentApi.md#convert_document_pdf_to_txt) | **POST** /convert/pdf/to/txt | PDF to Text
19
22
  [**convert_document_ppt_to_pdf**](ConvertDocumentApi.md#convert_document_ppt_to_pdf) | **POST** /convert/ppt/to/pdf | PowerPoint PPT (97-03) to PDF
20
23
  [**convert_document_ppt_to_pptx**](ConvertDocumentApi.md#convert_document_ppt_to_pptx) | **POST** /convert/ppt/to/pptx | PowerPoint PPT (97-03) to PPTX
21
24
  [**convert_document_pptx_to_pdf**](ConvertDocumentApi.md#convert_document_pptx_to_pdf) | **POST** /convert/pptx/to/pdf | PowerPoint PPTX to PDF
25
+ [**convert_document_pptx_to_txt**](ConvertDocumentApi.md#convert_document_pptx_to_txt) | **POST** /convert/pptx/to/txt | PowerPoint PPTX to Text
22
26
  [**convert_document_xls_to_pdf**](ConvertDocumentApi.md#convert_document_xls_to_pdf) | **POST** /convert/xls/to/pdf | Excel XLS (97-03) to PDF
23
27
  [**convert_document_xls_to_xlsx**](ConvertDocumentApi.md#convert_document_xls_to_xlsx) | **POST** /convert/xls/to/xlsx | Excel XLS (97-03) to XLSX
24
28
  [**convert_document_xlsx_to_csv**](ConvertDocumentApi.md#convert_document_xlsx_to_csv) | **POST** /convert/xlsx/to/csv | Excel XLSX to CSV
25
29
  [**convert_document_xlsx_to_pdf**](ConvertDocumentApi.md#convert_document_xlsx_to_pdf) | **POST** /convert/xlsx/to/pdf | Excel XLSX to PDF
30
+ [**convert_document_xlsx_to_txt**](ConvertDocumentApi.md#convert_document_xlsx_to_txt) | **POST** /convert/xlsx/to/txt | Excel XLSX to Text
26
31
 
27
32
 
28
33
  # **convert_document_autodetect_get_info**
@@ -187,6 +192,60 @@ Name | Type | Description | Notes
187
192
 
188
193
 
189
194
 
195
+ # **convert_document_autodetect_to_txt**
196
+ > TextConversionResult convert_document_autodetect_to_txt(input_file)
197
+
198
+ Convert Document to Text
199
+
200
+ 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.
201
+
202
+ ### Example
203
+ ```ruby
204
+ # load the gem
205
+ require 'cloudmersive-convert-api-client'
206
+ # setup authorization
207
+ CloudmersiveConvertApiClient.configure do |config|
208
+ # Configure API key authorization: Apikey
209
+ config.api_key['Apikey'] = 'YOUR API KEY'
210
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
211
+ #config.api_key_prefix['Apikey'] = 'Bearer'
212
+ end
213
+
214
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
215
+
216
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
217
+
218
+
219
+ begin
220
+ #Convert Document to Text
221
+ result = api_instance.convert_document_autodetect_to_txt(input_file)
222
+ p result
223
+ rescue CloudmersiveConvertApiClient::ApiError => e
224
+ puts "Exception when calling ConvertDocumentApi->convert_document_autodetect_to_txt: #{e}"
225
+ end
226
+ ```
227
+
228
+ ### Parameters
229
+
230
+ Name | Type | Description | Notes
231
+ ------------- | ------------- | ------------- | -------------
232
+ **input_file** | **File**| Input file to perform the operation on. |
233
+
234
+ ### Return type
235
+
236
+ [**TextConversionResult**](TextConversionResult.md)
237
+
238
+ ### Authorization
239
+
240
+ [Apikey](../README.md#Apikey)
241
+
242
+ ### HTTP request headers
243
+
244
+ - **Content-Type**: multipart/form-data
245
+ - **Accept**: application/octet-stream
246
+
247
+
248
+
190
249
  # **convert_document_csv_to_xlsx**
191
250
  > String convert_document_csv_to_xlsx(input_file)
192
251
 
@@ -403,6 +462,60 @@ Name | Type | Description | Notes
403
462
 
404
463
 
405
464
 
465
+ # **convert_document_docx_to_txt**
466
+ > TextConversionResult convert_document_docx_to_txt(input_file)
467
+
468
+ Word DOCX to Text
469
+
470
+ Convert Office Word Documents (docx) to text
471
+
472
+ ### Example
473
+ ```ruby
474
+ # load the gem
475
+ require 'cloudmersive-convert-api-client'
476
+ # setup authorization
477
+ CloudmersiveConvertApiClient.configure do |config|
478
+ # Configure API key authorization: Apikey
479
+ config.api_key['Apikey'] = 'YOUR API KEY'
480
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
481
+ #config.api_key_prefix['Apikey'] = 'Bearer'
482
+ end
483
+
484
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
485
+
486
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
487
+
488
+
489
+ begin
490
+ #Word DOCX to Text
491
+ result = api_instance.convert_document_docx_to_txt(input_file)
492
+ p result
493
+ rescue CloudmersiveConvertApiClient::ApiError => e
494
+ puts "Exception when calling ConvertDocumentApi->convert_document_docx_to_txt: #{e}"
495
+ end
496
+ ```
497
+
498
+ ### Parameters
499
+
500
+ Name | Type | Description | Notes
501
+ ------------- | ------------- | ------------- | -------------
502
+ **input_file** | **File**| Input file to perform the operation on. |
503
+
504
+ ### Return type
505
+
506
+ [**TextConversionResult**](TextConversionResult.md)
507
+
508
+ ### Authorization
509
+
510
+ [Apikey](../README.md#Apikey)
511
+
512
+ ### HTTP request headers
513
+
514
+ - **Content-Type**: multipart/form-data
515
+ - **Accept**: application/octet-stream
516
+
517
+
518
+
406
519
  # **convert_document_html_to_pdf**
407
520
  > String convert_document_html_to_pdf(input_file)
408
521
 
@@ -673,6 +786,60 @@ Name | Type | Description | Notes
673
786
 
674
787
 
675
788
 
789
+ # **convert_document_pdf_to_txt**
790
+ > TextConversionResult convert_document_pdf_to_txt(input_file)
791
+
792
+ PDF to Text
793
+
794
+ PDF document to text
795
+
796
+ ### Example
797
+ ```ruby
798
+ # load the gem
799
+ require 'cloudmersive-convert-api-client'
800
+ # setup authorization
801
+ CloudmersiveConvertApiClient.configure do |config|
802
+ # Configure API key authorization: Apikey
803
+ config.api_key['Apikey'] = 'YOUR API KEY'
804
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
805
+ #config.api_key_prefix['Apikey'] = 'Bearer'
806
+ end
807
+
808
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
809
+
810
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
811
+
812
+
813
+ begin
814
+ #PDF to Text
815
+ result = api_instance.convert_document_pdf_to_txt(input_file)
816
+ p result
817
+ rescue CloudmersiveConvertApiClient::ApiError => e
818
+ puts "Exception when calling ConvertDocumentApi->convert_document_pdf_to_txt: #{e}"
819
+ end
820
+ ```
821
+
822
+ ### Parameters
823
+
824
+ Name | Type | Description | Notes
825
+ ------------- | ------------- | ------------- | -------------
826
+ **input_file** | **File**| Input file to perform the operation on. |
827
+
828
+ ### Return type
829
+
830
+ [**TextConversionResult**](TextConversionResult.md)
831
+
832
+ ### Authorization
833
+
834
+ [Apikey](../README.md#Apikey)
835
+
836
+ ### HTTP request headers
837
+
838
+ - **Content-Type**: multipart/form-data
839
+ - **Accept**: application/octet-stream
840
+
841
+
842
+
676
843
  # **convert_document_ppt_to_pdf**
677
844
  > String convert_document_ppt_to_pdf(input_file)
678
845
 
@@ -835,6 +1002,60 @@ Name | Type | Description | Notes
835
1002
 
836
1003
 
837
1004
 
1005
+ # **convert_document_pptx_to_txt**
1006
+ > TextConversionResult convert_document_pptx_to_txt(input_file)
1007
+
1008
+ PowerPoint PPTX to Text
1009
+
1010
+ Convert Office PowerPoint Documents (pptx) to standard Text
1011
+
1012
+ ### Example
1013
+ ```ruby
1014
+ # load the gem
1015
+ require 'cloudmersive-convert-api-client'
1016
+ # setup authorization
1017
+ CloudmersiveConvertApiClient.configure do |config|
1018
+ # Configure API key authorization: Apikey
1019
+ config.api_key['Apikey'] = 'YOUR API KEY'
1020
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1021
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1022
+ end
1023
+
1024
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
1025
+
1026
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
1027
+
1028
+
1029
+ begin
1030
+ #PowerPoint PPTX to Text
1031
+ result = api_instance.convert_document_pptx_to_txt(input_file)
1032
+ p result
1033
+ rescue CloudmersiveConvertApiClient::ApiError => e
1034
+ puts "Exception when calling ConvertDocumentApi->convert_document_pptx_to_txt: #{e}"
1035
+ end
1036
+ ```
1037
+
1038
+ ### Parameters
1039
+
1040
+ Name | Type | Description | Notes
1041
+ ------------- | ------------- | ------------- | -------------
1042
+ **input_file** | **File**| Input file to perform the operation on. |
1043
+
1044
+ ### Return type
1045
+
1046
+ [**TextConversionResult**](TextConversionResult.md)
1047
+
1048
+ ### Authorization
1049
+
1050
+ [Apikey](../README.md#Apikey)
1051
+
1052
+ ### HTTP request headers
1053
+
1054
+ - **Content-Type**: multipart/form-data
1055
+ - **Accept**: application/octet-stream
1056
+
1057
+
1058
+
838
1059
  # **convert_document_xls_to_pdf**
839
1060
  > String convert_document_xls_to_pdf(input_file)
840
1061
 
@@ -1051,3 +1272,57 @@ Name | Type | Description | Notes
1051
1272
 
1052
1273
 
1053
1274
 
1275
+ # **convert_document_xlsx_to_txt**
1276
+ > TextConversionResult convert_document_xlsx_to_txt(input_file)
1277
+
1278
+ Excel XLSX to Text
1279
+
1280
+ Convert Office Excel Workbooks (xlsx) to standard Text. Converts all worksheets in the workbook to Text.
1281
+
1282
+ ### Example
1283
+ ```ruby
1284
+ # load the gem
1285
+ require 'cloudmersive-convert-api-client'
1286
+ # setup authorization
1287
+ CloudmersiveConvertApiClient.configure do |config|
1288
+ # Configure API key authorization: Apikey
1289
+ config.api_key['Apikey'] = 'YOUR API KEY'
1290
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1291
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1292
+ end
1293
+
1294
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
1295
+
1296
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
1297
+
1298
+
1299
+ begin
1300
+ #Excel XLSX to Text
1301
+ result = api_instance.convert_document_xlsx_to_txt(input_file)
1302
+ p result
1303
+ rescue CloudmersiveConvertApiClient::ApiError => e
1304
+ puts "Exception when calling ConvertDocumentApi->convert_document_xlsx_to_txt: #{e}"
1305
+ end
1306
+ ```
1307
+
1308
+ ### Parameters
1309
+
1310
+ Name | Type | Description | Notes
1311
+ ------------- | ------------- | ------------- | -------------
1312
+ **input_file** | **File**| Input file to perform the operation on. |
1313
+
1314
+ ### Return type
1315
+
1316
+ [**TextConversionResult**](TextConversionResult.md)
1317
+
1318
+ ### Authorization
1319
+
1320
+ [Apikey](../README.md#Apikey)
1321
+
1322
+ ### HTTP request headers
1323
+
1324
+ - **Content-Type**: multipart/form-data
1325
+ - **Accept**: application/octet-stream
1326
+
1327
+
1328
+
@@ -3,8 +3,8 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **tag** | **String** | | [optional]
7
- **data_type** | **String** | | [optional]
8
- **data_value** | **String** | | [optional]
6
+ **tag** | **String** | Tag name for the EXIF value | [optional]
7
+ **data_type** | **String** | Date type of the EXIF value | [optional]
8
+ **data_value** | **String** | Value, formatted as a string of the EXIF value | [optional]
9
9
 
10
10
 
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **successful** | **BOOLEAN** | | [optional]
7
- **final_html** | **String** | | [optional]
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **final_html** | **String** | Final HTML result of all operations on input | [optional]
8
8
 
9
9
 
@@ -3,6 +3,6 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **html** | **String** | | [optional]
6
+ **html** | **String** | HTML to render to Office format | [optional]
7
7
 
8
8
 
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **html** | **String** | | [optional]
7
- **extra_loading_wait** | **Integer** | | [optional]
6
+ **html** | **String** | HTML to render to PDF | [optional]
7
+ **extra_loading_wait** | **Integer** | Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot. Can be helpful for highly asynchronous websites. | [optional]
8
8
 
9
9
 
@@ -3,9 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **url** | **String** | | [optional]
7
- **extra_loading_wait** | **Integer** | | [optional]
8
- **screenshot_width** | **Integer** | | [optional]
9
- **screenshot_height** | **Integer** | | [optional]
6
+ **url** | **String** | URL address of the website to screenshot. HTTP and HTTPS are both supported, as are custom ports. | [optional]
7
+ **extra_loading_wait** | **Integer** | Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot. Can be helpful for highly asynchronous websites. Provide a value of 0 for the default of 5000 milliseconds (5 seconds) | [optional]
8
+ **screenshot_width** | **Integer** | Optional: Width of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot | [optional]
9
+ **screenshot_height** | **Integer** | Optional: Height of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot | [optional]
10
10
 
11
11
 
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::TextConversionResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **text_result** | **String** | Plain Text (TXT) format conversion result of the input document. The text result is returned as a string. | [optional]
8
+
9
+
@@ -90,6 +90,7 @@ require 'cloudmersive-convert-api-client/models/remove_docx_headers_and_footers_
90
90
  require 'cloudmersive-convert-api-client/models/remove_docx_headers_and_footers_response'
91
91
  require 'cloudmersive-convert-api-client/models/replace_string_request'
92
92
  require 'cloudmersive-convert-api-client/models/screenshot_request'
93
+ require 'cloudmersive-convert-api-client/models/text_conversion_result'
93
94
  require 'cloudmersive-convert-api-client/models/viewer_response'
94
95
  require 'cloudmersive-convert-api-client/models/xlsx_image'
95
96
  require 'cloudmersive-convert-api-client/models/xlsx_spreadsheet_cell'
@@ -188,6 +188,62 @@ module CloudmersiveConvertApiClient
188
188
  return data, status_code, headers
189
189
  end
190
190
 
191
+ # Convert Document to Text
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.
193
+ # @param input_file Input file to perform the operation on.
194
+ # @param [Hash] opts the optional parameters
195
+ # @return [TextConversionResult]
196
+ def convert_document_autodetect_to_txt(input_file, opts = {})
197
+ data, _status_code, _headers = convert_document_autodetect_to_txt_with_http_info(input_file, opts)
198
+ return data
199
+ end
200
+
201
+ # Convert Document to Text
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.
203
+ # @param input_file Input file to perform the operation on.
204
+ # @param [Hash] opts the optional parameters
205
+ # @return [Array<(TextConversionResult, Fixnum, Hash)>] TextConversionResult data, response status code and response headers
206
+ def convert_document_autodetect_to_txt_with_http_info(input_file, opts = {})
207
+ if @api_client.config.debugging
208
+ @api_client.config.logger.debug "Calling API: ConvertDocumentApi.convert_document_autodetect_to_txt ..."
209
+ end
210
+ # verify the required parameter 'input_file' is set
211
+ if @api_client.config.client_side_validation && input_file.nil?
212
+ fail ArgumentError, "Missing the required parameter 'input_file' when calling ConvertDocumentApi.convert_document_autodetect_to_txt"
213
+ end
214
+ # resource path
215
+ local_var_path = "/convert/autodetect/to/txt"
216
+
217
+ # query parameters
218
+ query_params = {}
219
+
220
+ # header parameters
221
+ header_params = {}
222
+ # HTTP header 'Accept' (if needed)
223
+ header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
224
+ # HTTP header 'Content-Type'
225
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
226
+
227
+ # form parameters
228
+ form_params = {}
229
+ form_params["inputFile"] = input_file
230
+
231
+ # http body (model)
232
+ post_body = nil
233
+ auth_names = ['Apikey']
234
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
235
+ :header_params => header_params,
236
+ :query_params => query_params,
237
+ :form_params => form_params,
238
+ :body => post_body,
239
+ :auth_names => auth_names,
240
+ :return_type => 'TextConversionResult')
241
+ if @api_client.config.debugging
242
+ @api_client.config.logger.debug "API called: ConvertDocumentApi#convert_document_autodetect_to_txt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
243
+ end
244
+ return data, status_code, headers
245
+ end
246
+
191
247
  # CSV to Excel XLSX
192
248
  # Convert CSV file to Office Excel XLSX Workbooks file format.
193
249
  # @param input_file Input file to perform the operation on.
@@ -412,6 +468,62 @@ module CloudmersiveConvertApiClient
412
468
  return data, status_code, headers
413
469
  end
414
470
 
471
+ # Word DOCX to Text
472
+ # Convert Office Word Documents (docx) to text
473
+ # @param input_file Input file to perform the operation on.
474
+ # @param [Hash] opts the optional parameters
475
+ # @return [TextConversionResult]
476
+ def convert_document_docx_to_txt(input_file, opts = {})
477
+ data, _status_code, _headers = convert_document_docx_to_txt_with_http_info(input_file, opts)
478
+ return data
479
+ end
480
+
481
+ # Word DOCX to Text
482
+ # Convert Office Word Documents (docx) to text
483
+ # @param input_file Input file to perform the operation on.
484
+ # @param [Hash] opts the optional parameters
485
+ # @return [Array<(TextConversionResult, Fixnum, Hash)>] TextConversionResult data, response status code and response headers
486
+ def convert_document_docx_to_txt_with_http_info(input_file, opts = {})
487
+ if @api_client.config.debugging
488
+ @api_client.config.logger.debug "Calling API: ConvertDocumentApi.convert_document_docx_to_txt ..."
489
+ end
490
+ # verify the required parameter 'input_file' is set
491
+ if @api_client.config.client_side_validation && input_file.nil?
492
+ fail ArgumentError, "Missing the required parameter 'input_file' when calling ConvertDocumentApi.convert_document_docx_to_txt"
493
+ end
494
+ # resource path
495
+ local_var_path = "/convert/docx/to/txt"
496
+
497
+ # query parameters
498
+ query_params = {}
499
+
500
+ # header parameters
501
+ header_params = {}
502
+ # HTTP header 'Accept' (if needed)
503
+ header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
504
+ # HTTP header 'Content-Type'
505
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
506
+
507
+ # form parameters
508
+ form_params = {}
509
+ form_params["inputFile"] = input_file
510
+
511
+ # http body (model)
512
+ post_body = nil
513
+ auth_names = ['Apikey']
514
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
515
+ :header_params => header_params,
516
+ :query_params => query_params,
517
+ :form_params => form_params,
518
+ :body => post_body,
519
+ :auth_names => auth_names,
520
+ :return_type => 'TextConversionResult')
521
+ if @api_client.config.debugging
522
+ @api_client.config.logger.debug "API called: ConvertDocumentApi#convert_document_docx_to_txt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
523
+ end
524
+ return data, status_code, headers
525
+ end
526
+
415
527
  # HTML to PDF
416
528
  # Convert standard HTML, with full support for CSS, JavaScript, Images, and other complex behavior to PDF. To use external files such as images, use an absolute URL to the file.
417
529
  # @param input_file Input file to perform the operation on.
@@ -692,6 +804,62 @@ module CloudmersiveConvertApiClient
692
804
  return data, status_code, headers
693
805
  end
694
806
 
807
+ # PDF to Text
808
+ # PDF document to text
809
+ # @param input_file Input file to perform the operation on.
810
+ # @param [Hash] opts the optional parameters
811
+ # @return [TextConversionResult]
812
+ def convert_document_pdf_to_txt(input_file, opts = {})
813
+ data, _status_code, _headers = convert_document_pdf_to_txt_with_http_info(input_file, opts)
814
+ return data
815
+ end
816
+
817
+ # PDF to Text
818
+ # PDF document to text
819
+ # @param input_file Input file to perform the operation on.
820
+ # @param [Hash] opts the optional parameters
821
+ # @return [Array<(TextConversionResult, Fixnum, Hash)>] TextConversionResult data, response status code and response headers
822
+ def convert_document_pdf_to_txt_with_http_info(input_file, opts = {})
823
+ if @api_client.config.debugging
824
+ @api_client.config.logger.debug "Calling API: ConvertDocumentApi.convert_document_pdf_to_txt ..."
825
+ end
826
+ # verify the required parameter 'input_file' is set
827
+ if @api_client.config.client_side_validation && input_file.nil?
828
+ fail ArgumentError, "Missing the required parameter 'input_file' when calling ConvertDocumentApi.convert_document_pdf_to_txt"
829
+ end
830
+ # resource path
831
+ local_var_path = "/convert/pdf/to/txt"
832
+
833
+ # query parameters
834
+ query_params = {}
835
+
836
+ # header parameters
837
+ header_params = {}
838
+ # HTTP header 'Accept' (if needed)
839
+ header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
840
+ # HTTP header 'Content-Type'
841
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
842
+
843
+ # form parameters
844
+ form_params = {}
845
+ form_params["inputFile"] = input_file
846
+
847
+ # http body (model)
848
+ post_body = nil
849
+ auth_names = ['Apikey']
850
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
851
+ :header_params => header_params,
852
+ :query_params => query_params,
853
+ :form_params => form_params,
854
+ :body => post_body,
855
+ :auth_names => auth_names,
856
+ :return_type => 'TextConversionResult')
857
+ if @api_client.config.debugging
858
+ @api_client.config.logger.debug "API called: ConvertDocumentApi#convert_document_pdf_to_txt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
859
+ end
860
+ return data, status_code, headers
861
+ end
862
+
695
863
  # PowerPoint PPT (97-03) to PDF
696
864
  # Convert Office PowerPoint (97-2003) Documents (ppt) to standard PDF
697
865
  # @param input_file Input file to perform the operation on.
@@ -860,6 +1028,62 @@ module CloudmersiveConvertApiClient
860
1028
  return data, status_code, headers
861
1029
  end
862
1030
 
1031
+ # PowerPoint PPTX to Text
1032
+ # Convert Office PowerPoint Documents (pptx) to standard Text
1033
+ # @param input_file Input file to perform the operation on.
1034
+ # @param [Hash] opts the optional parameters
1035
+ # @return [TextConversionResult]
1036
+ def convert_document_pptx_to_txt(input_file, opts = {})
1037
+ data, _status_code, _headers = convert_document_pptx_to_txt_with_http_info(input_file, opts)
1038
+ return data
1039
+ end
1040
+
1041
+ # PowerPoint PPTX to Text
1042
+ # Convert Office PowerPoint Documents (pptx) to standard Text
1043
+ # @param input_file Input file to perform the operation on.
1044
+ # @param [Hash] opts the optional parameters
1045
+ # @return [Array<(TextConversionResult, Fixnum, Hash)>] TextConversionResult data, response status code and response headers
1046
+ def convert_document_pptx_to_txt_with_http_info(input_file, opts = {})
1047
+ if @api_client.config.debugging
1048
+ @api_client.config.logger.debug "Calling API: ConvertDocumentApi.convert_document_pptx_to_txt ..."
1049
+ end
1050
+ # verify the required parameter 'input_file' is set
1051
+ if @api_client.config.client_side_validation && input_file.nil?
1052
+ fail ArgumentError, "Missing the required parameter 'input_file' when calling ConvertDocumentApi.convert_document_pptx_to_txt"
1053
+ end
1054
+ # resource path
1055
+ local_var_path = "/convert/pptx/to/txt"
1056
+
1057
+ # query parameters
1058
+ query_params = {}
1059
+
1060
+ # header parameters
1061
+ header_params = {}
1062
+ # HTTP header 'Accept' (if needed)
1063
+ header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
1064
+ # HTTP header 'Content-Type'
1065
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
1066
+
1067
+ # form parameters
1068
+ form_params = {}
1069
+ form_params["inputFile"] = input_file
1070
+
1071
+ # http body (model)
1072
+ post_body = nil
1073
+ auth_names = ['Apikey']
1074
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1075
+ :header_params => header_params,
1076
+ :query_params => query_params,
1077
+ :form_params => form_params,
1078
+ :body => post_body,
1079
+ :auth_names => auth_names,
1080
+ :return_type => 'TextConversionResult')
1081
+ if @api_client.config.debugging
1082
+ @api_client.config.logger.debug "API called: ConvertDocumentApi#convert_document_pptx_to_txt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1083
+ end
1084
+ return data, status_code, headers
1085
+ end
1086
+
863
1087
  # Excel XLS (97-03) to PDF
864
1088
  # Convert Office Excel (97-2003) Workbooks (xls) to standard PDF. Converts all worksheets in the workbook to PDF.
865
1089
  # @param input_file Input file to perform the operation on.
@@ -1083,5 +1307,61 @@ module CloudmersiveConvertApiClient
1083
1307
  end
1084
1308
  return data, status_code, headers
1085
1309
  end
1310
+
1311
+ # Excel XLSX to Text
1312
+ # Convert Office Excel Workbooks (xlsx) to standard Text. Converts all worksheets in the workbook to Text.
1313
+ # @param input_file Input file to perform the operation on.
1314
+ # @param [Hash] opts the optional parameters
1315
+ # @return [TextConversionResult]
1316
+ def convert_document_xlsx_to_txt(input_file, opts = {})
1317
+ data, _status_code, _headers = convert_document_xlsx_to_txt_with_http_info(input_file, opts)
1318
+ return data
1319
+ end
1320
+
1321
+ # Excel XLSX to Text
1322
+ # Convert Office Excel Workbooks (xlsx) to standard Text. Converts all worksheets in the workbook to Text.
1323
+ # @param input_file Input file to perform the operation on.
1324
+ # @param [Hash] opts the optional parameters
1325
+ # @return [Array<(TextConversionResult, Fixnum, Hash)>] TextConversionResult data, response status code and response headers
1326
+ def convert_document_xlsx_to_txt_with_http_info(input_file, opts = {})
1327
+ if @api_client.config.debugging
1328
+ @api_client.config.logger.debug "Calling API: ConvertDocumentApi.convert_document_xlsx_to_txt ..."
1329
+ end
1330
+ # verify the required parameter 'input_file' is set
1331
+ if @api_client.config.client_side_validation && input_file.nil?
1332
+ fail ArgumentError, "Missing the required parameter 'input_file' when calling ConvertDocumentApi.convert_document_xlsx_to_txt"
1333
+ end
1334
+ # resource path
1335
+ local_var_path = "/convert/xlsx/to/txt"
1336
+
1337
+ # query parameters
1338
+ query_params = {}
1339
+
1340
+ # header parameters
1341
+ header_params = {}
1342
+ # HTTP header 'Accept' (if needed)
1343
+ header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
1344
+ # HTTP header 'Content-Type'
1345
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
1346
+
1347
+ # form parameters
1348
+ form_params = {}
1349
+ form_params["inputFile"] = input_file
1350
+
1351
+ # http body (model)
1352
+ post_body = nil
1353
+ auth_names = ['Apikey']
1354
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1355
+ :header_params => header_params,
1356
+ :query_params => query_params,
1357
+ :form_params => form_params,
1358
+ :body => post_body,
1359
+ :auth_names => auth_names,
1360
+ :return_type => 'TextConversionResult')
1361
+ if @api_client.config.debugging
1362
+ @api_client.config.logger.debug "API called: ConvertDocumentApi#convert_document_xlsx_to_txt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1363
+ end
1364
+ return data, status_code, headers
1365
+ end
1086
1366
  end
1087
1367
  end
@@ -15,10 +15,13 @@ require 'date'
15
15
  module CloudmersiveConvertApiClient
16
16
  # EXIF tag and value
17
17
  class ExifValue
18
+ # Tag name for the EXIF value
18
19
  attr_accessor :tag
19
20
 
21
+ # Date type of the EXIF value
20
22
  attr_accessor :data_type
21
23
 
24
+ # Value, formatted as a string of the EXIF value
22
25
  attr_accessor :data_value
23
26
 
24
27
 
@@ -15,8 +15,10 @@ require 'date'
15
15
  module CloudmersiveConvertApiClient
16
16
  # Response from an HTML template application
17
17
  class HtmlTemplateApplicationResponse
18
+ # True if the operation was successful, false otherwise
18
19
  attr_accessor :successful
19
20
 
21
+ # Final HTML result of all operations on input
20
22
  attr_accessor :final_html
21
23
 
22
24
 
@@ -15,6 +15,7 @@ require 'date'
15
15
  module CloudmersiveConvertApiClient
16
16
  # Details of the HTML to Office request
17
17
  class HtmlToOfficeRequest
18
+ # HTML to render to Office format
18
19
  attr_accessor :html
19
20
 
20
21
 
@@ -15,8 +15,10 @@ require 'date'
15
15
  module CloudmersiveConvertApiClient
16
16
  # Details of the HTML to PDF request
17
17
  class HtmlToPdfRequest
18
+ # HTML to render to PDF
18
19
  attr_accessor :html
19
20
 
21
+ # Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot. Can be helpful for highly asynchronous websites.
20
22
  attr_accessor :extra_loading_wait
21
23
 
22
24
 
@@ -15,12 +15,16 @@ require 'date'
15
15
  module CloudmersiveConvertApiClient
16
16
  # Details of the screenshot request
17
17
  class ScreenshotRequest
18
+ # URL address of the website to screenshot. HTTP and HTTPS are both supported, as are custom ports.
18
19
  attr_accessor :url
19
20
 
21
+ # Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot. Can be helpful for highly asynchronous websites. Provide a value of 0 for the default of 5000 milliseconds (5 seconds)
20
22
  attr_accessor :extra_loading_wait
21
23
 
24
+ # Optional: Width of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot
22
25
  attr_accessor :screenshot_width
23
26
 
27
+ # Optional: Height of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot
24
28
  attr_accessor :screenshot_height
25
29
 
26
30
 
@@ -0,0 +1,199 @@
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: unset
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module CloudmersiveConvertApiClient
16
+ # Text conversion result from converting a document to Plain Text (TXT) format
17
+ class TextConversionResult
18
+ # True if the operation was successful, false otherwise
19
+ attr_accessor :successful
20
+
21
+ # Plain Text (TXT) format conversion result of the input document. The text result is returned as a string.
22
+ attr_accessor :text_result
23
+
24
+
25
+ # Attribute mapping from ruby-style variable name to JSON key.
26
+ def self.attribute_map
27
+ {
28
+ :'successful' => :'Successful',
29
+ :'text_result' => :'TextResult'
30
+ }
31
+ end
32
+
33
+ # Attribute type mapping.
34
+ def self.swagger_types
35
+ {
36
+ :'successful' => :'BOOLEAN',
37
+ :'text_result' => :'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?(:'Successful')
50
+ self.successful = attributes[:'Successful']
51
+ end
52
+
53
+ if attributes.has_key?(:'TextResult')
54
+ self.text_result = attributes[:'TextResult']
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
+ return invalid_properties
64
+ end
65
+
66
+ # Check to see if the all the properties in the model are valid
67
+ # @return true if the model is valid
68
+ def valid?
69
+ return true
70
+ end
71
+
72
+ # Checks equality by comparing each attribute.
73
+ # @param [Object] Object to be compared
74
+ def ==(o)
75
+ return true if self.equal?(o)
76
+ self.class == o.class &&
77
+ successful == o.successful &&
78
+ text_result == o.text_result
79
+ end
80
+
81
+ # @see the `==` method
82
+ # @param [Object] Object to be compared
83
+ def eql?(o)
84
+ self == o
85
+ end
86
+
87
+ # Calculates hash code according to all attributes.
88
+ # @return [Fixnum] Hash code
89
+ def hash
90
+ [successful, text_result].hash
91
+ end
92
+
93
+ # Builds the object from hash
94
+ # @param [Hash] attributes Model attributes in the form of hash
95
+ # @return [Object] Returns the model itself
96
+ def build_from_hash(attributes)
97
+ return nil unless attributes.is_a?(Hash)
98
+ self.class.swagger_types.each_pair do |key, type|
99
+ if type =~ /\AArray<(.*)>/i
100
+ # check to ensure the input is an array given that the the attribute
101
+ # is documented as an array but the input is not
102
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
103
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
104
+ end
105
+ elsif !attributes[self.class.attribute_map[key]].nil?
106
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
107
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
108
+ end
109
+
110
+ self
111
+ end
112
+
113
+ # Deserializes the data based on type
114
+ # @param string type Data type
115
+ # @param string value Value to be deserialized
116
+ # @return [Object] Deserialized data
117
+ def _deserialize(type, value)
118
+ case type.to_sym
119
+ when :DateTime
120
+ DateTime.parse(value)
121
+ when :Date
122
+ Date.parse(value)
123
+ when :String
124
+ value.to_s
125
+ when :Integer
126
+ value.to_i
127
+ when :Float
128
+ value.to_f
129
+ when :BOOLEAN
130
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
131
+ true
132
+ else
133
+ false
134
+ end
135
+ when :Object
136
+ # generic object (usually a Hash), return directly
137
+ value
138
+ when /\AArray<(?<inner_type>.+)>\z/
139
+ inner_type = Regexp.last_match[:inner_type]
140
+ value.map { |v| _deserialize(inner_type, v) }
141
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
142
+ k_type = Regexp.last_match[:k_type]
143
+ v_type = Regexp.last_match[:v_type]
144
+ {}.tap do |hash|
145
+ value.each do |k, v|
146
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
147
+ end
148
+ end
149
+ else # model
150
+ temp_model = CloudmersiveConvertApiClient.const_get(type).new
151
+ temp_model.build_from_hash(value)
152
+ end
153
+ end
154
+
155
+ # Returns the string representation of the object
156
+ # @return [String] String presentation of the object
157
+ def to_s
158
+ to_hash.to_s
159
+ end
160
+
161
+ # to_body is an alias to to_hash (backward compatibility)
162
+ # @return [Hash] Returns the object in the form of hash
163
+ def to_body
164
+ to_hash
165
+ end
166
+
167
+ # Returns the object in the form of hash
168
+ # @return [Hash] Returns the object in the form of hash
169
+ def to_hash
170
+ hash = {}
171
+ self.class.attribute_map.each_pair do |attr, param|
172
+ value = self.send(attr)
173
+ next if value.nil?
174
+ hash[param] = _to_hash(value)
175
+ end
176
+ hash
177
+ end
178
+
179
+ # Outputs non-array value in the form of hash
180
+ # For object, use to_hash. Otherwise, just return the value
181
+ # @param [Object] value Any valid value
182
+ # @return [Hash] Returns the value in the form of hash
183
+ def _to_hash(value)
184
+ if value.is_a?(Array)
185
+ value.compact.map{ |v| _to_hash(v) }
186
+ elsif value.is_a?(Hash)
187
+ {}.tap do |hash|
188
+ value.each { |k, v| hash[k] = _to_hash(v) }
189
+ end
190
+ elsif value.respond_to? :to_hash
191
+ value.to_hash
192
+ else
193
+ value
194
+ end
195
+ end
196
+
197
+ end
198
+
199
+ end
@@ -11,5 +11,5 @@ Swagger Codegen version: unset
11
11
  =end
12
12
 
13
13
  module CloudmersiveConvertApiClient
14
- VERSION = "1.3.8"
14
+ VERSION = "1.3.9"
15
15
  end
@@ -68,6 +68,18 @@ describe 'ConvertDocumentApi' do
68
68
  end
69
69
  end
70
70
 
71
+ # unit tests for convert_document_autodetect_to_txt
72
+ # Convert Document to Text
73
+ # 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.
74
+ # @param input_file Input file to perform the operation on.
75
+ # @param [Hash] opts the optional parameters
76
+ # @return [TextConversionResult]
77
+ describe 'convert_document_autodetect_to_txt test' do
78
+ it "should work" do
79
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
80
+ end
81
+ end
82
+
71
83
  # unit tests for convert_document_csv_to_xlsx
72
84
  # CSV to Excel XLSX
73
85
  # Convert CSV file to Office Excel XLSX Workbooks file format.
@@ -116,6 +128,18 @@ describe 'ConvertDocumentApi' do
116
128
  end
117
129
  end
118
130
 
131
+ # unit tests for convert_document_docx_to_txt
132
+ # Word DOCX to Text
133
+ # Convert Office Word Documents (docx) to text
134
+ # @param input_file Input file to perform the operation on.
135
+ # @param [Hash] opts the optional parameters
136
+ # @return [TextConversionResult]
137
+ describe 'convert_document_docx_to_txt test' do
138
+ it "should work" do
139
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
140
+ end
141
+ end
142
+
119
143
  # unit tests for convert_document_html_to_pdf
120
144
  # HTML to PDF
121
145
  # Convert standard HTML, with full support for CSS, JavaScript, Images, and other complex behavior to PDF. To use external files such as images, use an absolute URL to the file.
@@ -176,6 +200,18 @@ describe 'ConvertDocumentApi' do
176
200
  end
177
201
  end
178
202
 
203
+ # unit tests for convert_document_pdf_to_txt
204
+ # PDF to Text
205
+ # PDF document to text
206
+ # @param input_file Input file to perform the operation on.
207
+ # @param [Hash] opts the optional parameters
208
+ # @return [TextConversionResult]
209
+ describe 'convert_document_pdf_to_txt test' do
210
+ it "should work" do
211
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
212
+ end
213
+ end
214
+
179
215
  # unit tests for convert_document_ppt_to_pdf
180
216
  # PowerPoint PPT (97-03) to PDF
181
217
  # Convert Office PowerPoint (97-2003) Documents (ppt) to standard PDF
@@ -212,6 +248,18 @@ describe 'ConvertDocumentApi' do
212
248
  end
213
249
  end
214
250
 
251
+ # unit tests for convert_document_pptx_to_txt
252
+ # PowerPoint PPTX to Text
253
+ # Convert Office PowerPoint Documents (pptx) to standard Text
254
+ # @param input_file Input file to perform the operation on.
255
+ # @param [Hash] opts the optional parameters
256
+ # @return [TextConversionResult]
257
+ describe 'convert_document_pptx_to_txt test' do
258
+ it "should work" do
259
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
260
+ end
261
+ end
262
+
215
263
  # unit tests for convert_document_xls_to_pdf
216
264
  # Excel XLS (97-03) to PDF
217
265
  # Convert Office Excel (97-2003) Workbooks (xls) to standard PDF. Converts all worksheets in the workbook to PDF.
@@ -260,4 +308,16 @@ describe 'ConvertDocumentApi' do
260
308
  end
261
309
  end
262
310
 
311
+ # unit tests for convert_document_xlsx_to_txt
312
+ # Excel XLSX to Text
313
+ # Convert Office Excel Workbooks (xlsx) to standard Text. Converts all worksheets in the workbook to Text.
314
+ # @param input_file Input file to perform the operation on.
315
+ # @param [Hash] opts the optional parameters
316
+ # @return [TextConversionResult]
317
+ describe 'convert_document_xlsx_to_txt test' do
318
+ it "should work" do
319
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
320
+ end
321
+ end
322
+
263
323
  end
@@ -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: unset
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for CloudmersiveConvertApiClient::TextConversionResult
18
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
19
+ # Please update as you see appropriate
20
+ describe 'TextConversionResult' do
21
+ before do
22
+ # run before each test
23
+ @instance = CloudmersiveConvertApiClient::TextConversionResult.new
24
+ end
25
+
26
+ after do
27
+ # run after each test
28
+ end
29
+
30
+ describe 'test an instance of TextConversionResult' do
31
+ it 'should create an instance of TextConversionResult' do
32
+ expect(@instance).to be_instance_of(CloudmersiveConvertApiClient::TextConversionResult)
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 "text_result"' 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
+
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.3.8
4
+ version: 1.3.9
5
5
  platform: ruby
6
6
  authors:
7
7
  - Cloudmersive
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-09-09 00:00:00.000000000 Z
11
+ date: 2019-09-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -283,6 +283,7 @@ files:
283
283
  - "./docs/RemoveDocxHeadersAndFootersResponse.md"
284
284
  - "./docs/ReplaceStringRequest.md"
285
285
  - "./docs/ScreenshotRequest.md"
286
+ - "./docs/TextConversionResult.md"
286
287
  - "./docs/ValidateDocumentApi.md"
287
288
  - "./docs/ViewerResponse.md"
288
289
  - "./docs/ViewerToolsApi.md"
@@ -379,6 +380,7 @@ files:
379
380
  - "./lib/cloudmersive-convert-api-client/models/remove_docx_headers_and_footers_response.rb"
380
381
  - "./lib/cloudmersive-convert-api-client/models/replace_string_request.rb"
381
382
  - "./lib/cloudmersive-convert-api-client/models/screenshot_request.rb"
383
+ - "./lib/cloudmersive-convert-api-client/models/text_conversion_result.rb"
382
384
  - "./lib/cloudmersive-convert-api-client/models/viewer_response.rb"
383
385
  - "./lib/cloudmersive-convert-api-client/models/xlsx_image.rb"
384
386
  - "./lib/cloudmersive-convert-api-client/models/xlsx_spreadsheet_cell.rb"
@@ -471,6 +473,7 @@ files:
471
473
  - "./spec/models/remove_docx_headers_and_footers_response_spec.rb"
472
474
  - "./spec/models/replace_string_request_spec.rb"
473
475
  - "./spec/models/screenshot_request_spec.rb"
476
+ - "./spec/models/text_conversion_result_spec.rb"
474
477
  - "./spec/models/viewer_response_spec.rb"
475
478
  - "./spec/models/xlsx_image_spec.rb"
476
479
  - "./spec/models/xlsx_spreadsheet_cell_spec.rb"