cloudmersive-convert-api-client 2.1.3 → 2.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f7db0bb57bc00519878b15baba8a5effec28137e35eaf2ed250d3acfc92300cb
|
4
|
+
data.tar.gz: 18356a24c6f553344190b383a06b4bc3c9acf5979b26fcb5f2a30aa57e815320
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0caf135911d7917065fa838284342e496317e7f55dbaff03613cf06874369cb96babea057d32d2dadb96b01404c649a080846db1db4c3f86f9ae2aad9125a4be
|
7
|
+
data.tar.gz: ffb84ad739d35a197f52ac982f3953e7ec88aa090734dcf3c7496c870daaf133b44303fd882e98450953652822b6d578c576d0cdcbe2b24c44fabda267813852
|
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: 2.1.
|
10
|
+
- Package version: 2.1.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-2.1.
|
26
|
+
gem install ./cloudmersive-convert-api-client-2.1.4.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-convert-api-client-2.1.
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-convert-api-client-2.1.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', '~> 2.1.
|
34
|
+
gem 'cloudmersive-convert-api-client', '~> 2.1.4'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -325,9 +325,11 @@ Class | Method | HTTP request | Description
|
|
325
325
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_g_zip_validation**](docs/ValidateDocumentApi.md#validate_document_g_zip_validation) | **POST** /convert/validate/gzip | Validate a GZip Archive file (gzip or gz)
|
326
326
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_html_validation**](docs/ValidateDocumentApi.md#validate_document_html_validation) | **POST** /convert/validate/html | Validate an HTML file
|
327
327
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_image_validation**](docs/ValidateDocumentApi.md#validate_document_image_validation) | **POST** /convert/validate/image | Validate an Image File
|
328
|
+
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_jpg_validation**](docs/ValidateDocumentApi.md#validate_document_jpg_validation) | **POST** /convert/validate/jpg | Validate a JPG File
|
328
329
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_json_validation**](docs/ValidateDocumentApi.md#validate_document_json_validation) | **POST** /convert/validate/json | Validate a JSON file
|
329
330
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_msg_validation**](docs/ValidateDocumentApi.md#validate_document_msg_validation) | **POST** /convert/validate/msg | Validate if an MSG file is executable
|
330
331
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_pdf_validation**](docs/ValidateDocumentApi.md#validate_document_pdf_validation) | **POST** /convert/validate/pdf | Validate a PDF document file
|
332
|
+
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_png_validation**](docs/ValidateDocumentApi.md#validate_document_png_validation) | **POST** /convert/validate/png | Validate a PNG File
|
331
333
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_pptx_validation**](docs/ValidateDocumentApi.md#validate_document_pptx_validation) | **POST** /convert/validate/pptx | Validate a PowerPoint presentation (PPTX)
|
332
334
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_rar_validation**](docs/ValidateDocumentApi.md#validate_document_rar_validation) | **POST** /convert/validate/rar | Validate a RAR Archive file (RAR)
|
333
335
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_tar_validation**](docs/ValidateDocumentApi.md#validate_document_tar_validation) | **POST** /convert/validate/tar | Validate a TAR Tarball Archive file (TAR)
|
data/docs/ValidateDocumentApi.md
CHANGED
@@ -12,9 +12,11 @@ Method | HTTP request | Description
|
|
12
12
|
[**validate_document_g_zip_validation**](ValidateDocumentApi.md#validate_document_g_zip_validation) | **POST** /convert/validate/gzip | Validate a GZip Archive file (gzip or gz)
|
13
13
|
[**validate_document_html_validation**](ValidateDocumentApi.md#validate_document_html_validation) | **POST** /convert/validate/html | Validate an HTML file
|
14
14
|
[**validate_document_image_validation**](ValidateDocumentApi.md#validate_document_image_validation) | **POST** /convert/validate/image | Validate an Image File
|
15
|
+
[**validate_document_jpg_validation**](ValidateDocumentApi.md#validate_document_jpg_validation) | **POST** /convert/validate/jpg | Validate a JPG File
|
15
16
|
[**validate_document_json_validation**](ValidateDocumentApi.md#validate_document_json_validation) | **POST** /convert/validate/json | Validate a JSON file
|
16
17
|
[**validate_document_msg_validation**](ValidateDocumentApi.md#validate_document_msg_validation) | **POST** /convert/validate/msg | Validate if an MSG file is executable
|
17
18
|
[**validate_document_pdf_validation**](ValidateDocumentApi.md#validate_document_pdf_validation) | **POST** /convert/validate/pdf | Validate a PDF document file
|
19
|
+
[**validate_document_png_validation**](ValidateDocumentApi.md#validate_document_png_validation) | **POST** /convert/validate/png | Validate a PNG File
|
18
20
|
[**validate_document_pptx_validation**](ValidateDocumentApi.md#validate_document_pptx_validation) | **POST** /convert/validate/pptx | Validate a PowerPoint presentation (PPTX)
|
19
21
|
[**validate_document_rar_validation**](ValidateDocumentApi.md#validate_document_rar_validation) | **POST** /convert/validate/rar | Validate a RAR Archive file (RAR)
|
20
22
|
[**validate_document_tar_validation**](ValidateDocumentApi.md#validate_document_tar_validation) | **POST** /convert/validate/tar | Validate a TAR Tarball Archive file (TAR)
|
@@ -456,6 +458,60 @@ Name | Type | Description | Notes
|
|
456
458
|
|
457
459
|
|
458
460
|
|
461
|
+
# **validate_document_jpg_validation**
|
462
|
+
> DocumentValidationResult validate_document_jpg_validation(input_file)
|
463
|
+
|
464
|
+
Validate a JPG File
|
465
|
+
|
466
|
+
Validate a JPEG image file; if the document is not valid, identifies the errors in the document..
|
467
|
+
|
468
|
+
### Example
|
469
|
+
```ruby
|
470
|
+
# load the gem
|
471
|
+
require 'cloudmersive-convert-api-client'
|
472
|
+
# setup authorization
|
473
|
+
CloudmersiveConvertApiClient.configure do |config|
|
474
|
+
# Configure API key authorization: Apikey
|
475
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
476
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
477
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
478
|
+
end
|
479
|
+
|
480
|
+
api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
|
481
|
+
|
482
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
483
|
+
|
484
|
+
|
485
|
+
begin
|
486
|
+
#Validate a JPG File
|
487
|
+
result = api_instance.validate_document_jpg_validation(input_file)
|
488
|
+
p result
|
489
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
490
|
+
puts "Exception when calling ValidateDocumentApi->validate_document_jpg_validation: #{e}"
|
491
|
+
end
|
492
|
+
```
|
493
|
+
|
494
|
+
### Parameters
|
495
|
+
|
496
|
+
Name | Type | Description | Notes
|
497
|
+
------------- | ------------- | ------------- | -------------
|
498
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
499
|
+
|
500
|
+
### Return type
|
501
|
+
|
502
|
+
[**DocumentValidationResult**](DocumentValidationResult.md)
|
503
|
+
|
504
|
+
### Authorization
|
505
|
+
|
506
|
+
[Apikey](../README.md#Apikey)
|
507
|
+
|
508
|
+
### HTTP request headers
|
509
|
+
|
510
|
+
- **Content-Type**: multipart/form-data
|
511
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
512
|
+
|
513
|
+
|
514
|
+
|
459
515
|
# **validate_document_json_validation**
|
460
516
|
> DocumentValidationResult validate_document_json_validation(input_file)
|
461
517
|
|
@@ -618,6 +674,60 @@ Name | Type | Description | Notes
|
|
618
674
|
|
619
675
|
|
620
676
|
|
677
|
+
# **validate_document_png_validation**
|
678
|
+
> DocumentValidationResult validate_document_png_validation(input_file)
|
679
|
+
|
680
|
+
Validate a PNG File
|
681
|
+
|
682
|
+
Validate a PNG image file; if the document is not valid, identifies the errors in the document.
|
683
|
+
|
684
|
+
### Example
|
685
|
+
```ruby
|
686
|
+
# load the gem
|
687
|
+
require 'cloudmersive-convert-api-client'
|
688
|
+
# setup authorization
|
689
|
+
CloudmersiveConvertApiClient.configure do |config|
|
690
|
+
# Configure API key authorization: Apikey
|
691
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
692
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
693
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
694
|
+
end
|
695
|
+
|
696
|
+
api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
|
697
|
+
|
698
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
699
|
+
|
700
|
+
|
701
|
+
begin
|
702
|
+
#Validate a PNG File
|
703
|
+
result = api_instance.validate_document_png_validation(input_file)
|
704
|
+
p result
|
705
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
706
|
+
puts "Exception when calling ValidateDocumentApi->validate_document_png_validation: #{e}"
|
707
|
+
end
|
708
|
+
```
|
709
|
+
|
710
|
+
### Parameters
|
711
|
+
|
712
|
+
Name | Type | Description | Notes
|
713
|
+
------------- | ------------- | ------------- | -------------
|
714
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
715
|
+
|
716
|
+
### Return type
|
717
|
+
|
718
|
+
[**DocumentValidationResult**](DocumentValidationResult.md)
|
719
|
+
|
720
|
+
### Authorization
|
721
|
+
|
722
|
+
[Apikey](../README.md#Apikey)
|
723
|
+
|
724
|
+
### HTTP request headers
|
725
|
+
|
726
|
+
- **Content-Type**: multipart/form-data
|
727
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
728
|
+
|
729
|
+
|
730
|
+
|
621
731
|
# **validate_document_pptx_validation**
|
622
732
|
> DocumentValidationResult validate_document_pptx_validation(input_file)
|
623
733
|
|
@@ -459,6 +459,61 @@ module CloudmersiveConvertApiClient
|
|
459
459
|
end
|
460
460
|
return data, status_code, headers
|
461
461
|
end
|
462
|
+
# Validate a JPG File
|
463
|
+
# Validate a JPEG image file; if the document is not valid, identifies the errors in the document..
|
464
|
+
# @param input_file Input file to perform the operation on.
|
465
|
+
# @param [Hash] opts the optional parameters
|
466
|
+
# @return [DocumentValidationResult]
|
467
|
+
def validate_document_jpg_validation(input_file, opts = {})
|
468
|
+
data, _status_code, _headers = validate_document_jpg_validation_with_http_info(input_file, opts)
|
469
|
+
data
|
470
|
+
end
|
471
|
+
|
472
|
+
# Validate a JPG File
|
473
|
+
# Validate a JPEG image file; if the document is not valid, identifies the errors in the document..
|
474
|
+
# @param input_file Input file to perform the operation on.
|
475
|
+
# @param [Hash] opts the optional parameters
|
476
|
+
# @return [Array<(DocumentValidationResult, Fixnum, Hash)>] DocumentValidationResult data, response status code and response headers
|
477
|
+
def validate_document_jpg_validation_with_http_info(input_file, opts = {})
|
478
|
+
if @api_client.config.debugging
|
479
|
+
@api_client.config.logger.debug 'Calling API: ValidateDocumentApi.validate_document_jpg_validation ...'
|
480
|
+
end
|
481
|
+
# verify the required parameter 'input_file' is set
|
482
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
483
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling ValidateDocumentApi.validate_document_jpg_validation"
|
484
|
+
end
|
485
|
+
# resource path
|
486
|
+
local_var_path = '/convert/validate/jpg'
|
487
|
+
|
488
|
+
# query parameters
|
489
|
+
query_params = {}
|
490
|
+
|
491
|
+
# header parameters
|
492
|
+
header_params = {}
|
493
|
+
# HTTP header 'Accept' (if needed)
|
494
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
495
|
+
# HTTP header 'Content-Type'
|
496
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
497
|
+
|
498
|
+
# form parameters
|
499
|
+
form_params = {}
|
500
|
+
form_params['inputFile'] = input_file
|
501
|
+
|
502
|
+
# http body (model)
|
503
|
+
post_body = nil
|
504
|
+
auth_names = ['Apikey']
|
505
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
506
|
+
:header_params => header_params,
|
507
|
+
:query_params => query_params,
|
508
|
+
:form_params => form_params,
|
509
|
+
:body => post_body,
|
510
|
+
:auth_names => auth_names,
|
511
|
+
:return_type => 'DocumentValidationResult')
|
512
|
+
if @api_client.config.debugging
|
513
|
+
@api_client.config.logger.debug "API called: ValidateDocumentApi#validate_document_jpg_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
514
|
+
end
|
515
|
+
return data, status_code, headers
|
516
|
+
end
|
462
517
|
# Validate a JSON file
|
463
518
|
# Validate a JSON (JavaScript Object Notation) document file; if the document is not valid, identifies the errors in the document
|
464
519
|
# @param input_file Input file to perform the operation on.
|
@@ -624,6 +679,61 @@ module CloudmersiveConvertApiClient
|
|
624
679
|
end
|
625
680
|
return data, status_code, headers
|
626
681
|
end
|
682
|
+
# Validate a PNG File
|
683
|
+
# Validate a PNG image file; if the document is not valid, identifies the errors in the document.
|
684
|
+
# @param input_file Input file to perform the operation on.
|
685
|
+
# @param [Hash] opts the optional parameters
|
686
|
+
# @return [DocumentValidationResult]
|
687
|
+
def validate_document_png_validation(input_file, opts = {})
|
688
|
+
data, _status_code, _headers = validate_document_png_validation_with_http_info(input_file, opts)
|
689
|
+
data
|
690
|
+
end
|
691
|
+
|
692
|
+
# Validate a PNG File
|
693
|
+
# Validate a PNG image file; if the document is not valid, identifies the errors in the document.
|
694
|
+
# @param input_file Input file to perform the operation on.
|
695
|
+
# @param [Hash] opts the optional parameters
|
696
|
+
# @return [Array<(DocumentValidationResult, Fixnum, Hash)>] DocumentValidationResult data, response status code and response headers
|
697
|
+
def validate_document_png_validation_with_http_info(input_file, opts = {})
|
698
|
+
if @api_client.config.debugging
|
699
|
+
@api_client.config.logger.debug 'Calling API: ValidateDocumentApi.validate_document_png_validation ...'
|
700
|
+
end
|
701
|
+
# verify the required parameter 'input_file' is set
|
702
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
703
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling ValidateDocumentApi.validate_document_png_validation"
|
704
|
+
end
|
705
|
+
# resource path
|
706
|
+
local_var_path = '/convert/validate/png'
|
707
|
+
|
708
|
+
# query parameters
|
709
|
+
query_params = {}
|
710
|
+
|
711
|
+
# header parameters
|
712
|
+
header_params = {}
|
713
|
+
# HTTP header 'Accept' (if needed)
|
714
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
715
|
+
# HTTP header 'Content-Type'
|
716
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
717
|
+
|
718
|
+
# form parameters
|
719
|
+
form_params = {}
|
720
|
+
form_params['inputFile'] = input_file
|
721
|
+
|
722
|
+
# http body (model)
|
723
|
+
post_body = nil
|
724
|
+
auth_names = ['Apikey']
|
725
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
726
|
+
:header_params => header_params,
|
727
|
+
:query_params => query_params,
|
728
|
+
:form_params => form_params,
|
729
|
+
:body => post_body,
|
730
|
+
:auth_names => auth_names,
|
731
|
+
:return_type => 'DocumentValidationResult')
|
732
|
+
if @api_client.config.debugging
|
733
|
+
@api_client.config.logger.debug "API called: ValidateDocumentApi#validate_document_png_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
734
|
+
end
|
735
|
+
return data, status_code, headers
|
736
|
+
end
|
627
737
|
# Validate a PowerPoint presentation (PPTX)
|
628
738
|
# Validate a PowerPoint presentation (PPTX); if the document is not valid, identifies the errors in the document
|
629
739
|
# @param input_file Input file to perform the operation on.
|
@@ -128,6 +128,18 @@ describe 'ValidateDocumentApi' do
|
|
128
128
|
end
|
129
129
|
end
|
130
130
|
|
131
|
+
# unit tests for validate_document_jpg_validation
|
132
|
+
# Validate a JPG File
|
133
|
+
# Validate a JPEG image file; if the document is not valid, identifies the errors in the document..
|
134
|
+
# @param input_file Input file to perform the operation on.
|
135
|
+
# @param [Hash] opts the optional parameters
|
136
|
+
# @return [DocumentValidationResult]
|
137
|
+
describe 'validate_document_jpg_validation 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
|
+
|
131
143
|
# unit tests for validate_document_json_validation
|
132
144
|
# Validate a JSON file
|
133
145
|
# Validate a JSON (JavaScript Object Notation) document file; if the document is not valid, identifies the errors in the document
|
@@ -164,6 +176,18 @@ describe 'ValidateDocumentApi' do
|
|
164
176
|
end
|
165
177
|
end
|
166
178
|
|
179
|
+
# unit tests for validate_document_png_validation
|
180
|
+
# Validate a PNG File
|
181
|
+
# Validate a PNG image file; if the document is not valid, identifies the errors in the document.
|
182
|
+
# @param input_file Input file to perform the operation on.
|
183
|
+
# @param [Hash] opts the optional parameters
|
184
|
+
# @return [DocumentValidationResult]
|
185
|
+
describe 'validate_document_png_validation test' do
|
186
|
+
it 'should work' do
|
187
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
188
|
+
end
|
189
|
+
end
|
190
|
+
|
167
191
|
# unit tests for validate_document_pptx_validation
|
168
192
|
# Validate a PowerPoint presentation (PPTX)
|
169
193
|
# Validate a PowerPoint presentation (PPTX); if the document is not valid, identifies the errors in the document
|
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: 2.1.
|
4
|
+
version: 2.1.4
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Cloudmersive
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2021-01-08 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|