cloudmersive-convert-api-client 2.1.1 → 2.1.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +5 -4
- data/docs/ValidateDocumentApi.md +55 -0
- data/docs/ViewerToolsApi.md +8 -2
- data/lib/cloudmersive-convert-api-client/api/validate_document_api.rb +55 -0
- data/lib/cloudmersive-convert-api-client/api/viewer_tools_api.rb +6 -0
- data/lib/cloudmersive-convert-api-client/version.rb +1 -1
- data/spec/api/validate_document_api_spec.rb +12 -0
- data/spec/api/viewer_tools_api_spec.rb +2 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ca5ad2e3a95f3a2973cdc4d7ad86d4974407b81ec1b83d20f9a0cfd9f823024f
|
4
|
+
data.tar.gz: adac2475d8aa68688101397d485f8a1909000a2de990cd692cdda723bc62a8f4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8dd983dd6fa1339c6b617d01ce19376328984b0fd441b74e93f5a91dcdcbd81c7df8f408e1a296597418ee3acbdb5c9ae96ee45e408615aeb86863cb3b5879a2
|
7
|
+
data.tar.gz: b3273a40e981be1849219a87a94b3343e7208f1b1f5a88c13d91a6a4442e640d6668f69eeb96e0f6b5a3eec72892064daebd2c759cc7c1f057af28284eee9c72
|
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.2
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,15 +23,15 @@ gem build cloudmersive-convert-api-client.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./cloudmersive-convert-api-client-2.1.
|
26
|
+
gem install ./cloudmersive-convert-api-client-2.1.2.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.2.gem` to install the development dependencies)
|
29
29
|
|
30
30
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
31
|
|
32
32
|
Finally add this to the Gemfile:
|
33
33
|
|
34
|
-
gem 'cloudmersive-convert-api-client', '~> 2.1.
|
34
|
+
gem 'cloudmersive-convert-api-client', '~> 2.1.2'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -329,6 +329,7 @@ Class | Method | HTTP request | Description
|
|
329
329
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_pptx_validation**](docs/ValidateDocumentApi.md#validate_document_pptx_validation) | **POST** /convert/validate/pptx | Validate a PowerPoint presentation (PPTX)
|
330
330
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_rar_validation**](docs/ValidateDocumentApi.md#validate_document_rar_validation) | **POST** /convert/validate/rar | Validate a RAR Archive file (RAR)
|
331
331
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_tar_validation**](docs/ValidateDocumentApi.md#validate_document_tar_validation) | **POST** /convert/validate/tar | Validate a TAR Tarball Archive file (TAR)
|
332
|
+
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_txt_validation**](docs/ValidateDocumentApi.md#validate_document_txt_validation) | **POST** /convert/validate/txt | Validate an TXT file
|
332
333
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_xlsx_validation**](docs/ValidateDocumentApi.md#validate_document_xlsx_validation) | **POST** /convert/validate/xlsx | Validate a Excel document (XLSX)
|
333
334
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_xml_validation**](docs/ValidateDocumentApi.md#validate_document_xml_validation) | **POST** /convert/validate/xml | Validate an XML file
|
334
335
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_zip_validation**](docs/ValidateDocumentApi.md#validate_document_zip_validation) | **POST** /convert/validate/zip | Validate a Zip Archive file (zip)
|
data/docs/ValidateDocumentApi.md
CHANGED
@@ -18,6 +18,7 @@ Method | HTTP request | Description
|
|
18
18
|
[**validate_document_pptx_validation**](ValidateDocumentApi.md#validate_document_pptx_validation) | **POST** /convert/validate/pptx | Validate a PowerPoint presentation (PPTX)
|
19
19
|
[**validate_document_rar_validation**](ValidateDocumentApi.md#validate_document_rar_validation) | **POST** /convert/validate/rar | Validate a RAR Archive file (RAR)
|
20
20
|
[**validate_document_tar_validation**](ValidateDocumentApi.md#validate_document_tar_validation) | **POST** /convert/validate/tar | Validate a TAR Tarball Archive file (TAR)
|
21
|
+
[**validate_document_txt_validation**](ValidateDocumentApi.md#validate_document_txt_validation) | **POST** /convert/validate/txt | Validate an TXT file
|
21
22
|
[**validate_document_xlsx_validation**](ValidateDocumentApi.md#validate_document_xlsx_validation) | **POST** /convert/validate/xlsx | Validate a Excel document (XLSX)
|
22
23
|
[**validate_document_xml_validation**](ValidateDocumentApi.md#validate_document_xml_validation) | **POST** /convert/validate/xml | Validate an XML file
|
23
24
|
[**validate_document_zip_validation**](ValidateDocumentApi.md#validate_document_zip_validation) | **POST** /convert/validate/zip | Validate a Zip Archive file (zip)
|
@@ -779,6 +780,60 @@ Name | Type | Description | Notes
|
|
779
780
|
|
780
781
|
|
781
782
|
|
783
|
+
# **validate_document_txt_validation**
|
784
|
+
> DocumentValidationResult validate_document_txt_validation(input_file)
|
785
|
+
|
786
|
+
Validate an TXT file
|
787
|
+
|
788
|
+
Validate an TXT document file; if the document is not valid, identifies the errors in the document
|
789
|
+
|
790
|
+
### Example
|
791
|
+
```ruby
|
792
|
+
# load the gem
|
793
|
+
require 'cloudmersive-convert-api-client'
|
794
|
+
# setup authorization
|
795
|
+
CloudmersiveConvertApiClient.configure do |config|
|
796
|
+
# Configure API key authorization: Apikey
|
797
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
798
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
799
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
800
|
+
end
|
801
|
+
|
802
|
+
api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
|
803
|
+
|
804
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
805
|
+
|
806
|
+
|
807
|
+
begin
|
808
|
+
#Validate an TXT file
|
809
|
+
result = api_instance.validate_document_txt_validation(input_file)
|
810
|
+
p result
|
811
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
812
|
+
puts "Exception when calling ValidateDocumentApi->validate_document_txt_validation: #{e}"
|
813
|
+
end
|
814
|
+
```
|
815
|
+
|
816
|
+
### Parameters
|
817
|
+
|
818
|
+
Name | Type | Description | Notes
|
819
|
+
------------- | ------------- | ------------- | -------------
|
820
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
821
|
+
|
822
|
+
### Return type
|
823
|
+
|
824
|
+
[**DocumentValidationResult**](DocumentValidationResult.md)
|
825
|
+
|
826
|
+
### Authorization
|
827
|
+
|
828
|
+
[Apikey](../README.md#Apikey)
|
829
|
+
|
830
|
+
### HTTP request headers
|
831
|
+
|
832
|
+
- **Content-Type**: multipart/form-data
|
833
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
834
|
+
|
835
|
+
|
836
|
+
|
782
837
|
# **validate_document_xlsx_validation**
|
783
838
|
> DocumentValidationResult validate_document_xlsx_validation(input_file)
|
784
839
|
|
data/docs/ViewerToolsApi.md
CHANGED
@@ -8,7 +8,7 @@ Method | HTTP request | Description
|
|
8
8
|
|
9
9
|
|
10
10
|
# **viewer_tools_create_simple**
|
11
|
-
> ViewerResponse viewer_tools_create_simple(input_file)
|
11
|
+
> ViewerResponse viewer_tools_create_simple(input_file, opts)
|
12
12
|
|
13
13
|
Create a web-based viewer
|
14
14
|
|
@@ -30,10 +30,14 @@ api_instance = CloudmersiveConvertApiClient::ViewerToolsApi.new
|
|
30
30
|
|
31
31
|
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
32
32
|
|
33
|
+
opts = {
|
34
|
+
width: 56, # Integer | Optional; width of the output viewer in pixels
|
35
|
+
height: 56 # Integer | Optional; height of the output viewer in pixels
|
36
|
+
}
|
33
37
|
|
34
38
|
begin
|
35
39
|
#Create a web-based viewer
|
36
|
-
result = api_instance.viewer_tools_create_simple(input_file)
|
40
|
+
result = api_instance.viewer_tools_create_simple(input_file, opts)
|
37
41
|
p result
|
38
42
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
39
43
|
puts "Exception when calling ViewerToolsApi->viewer_tools_create_simple: #{e}"
|
@@ -45,6 +49,8 @@ end
|
|
45
49
|
Name | Type | Description | Notes
|
46
50
|
------------- | ------------- | ------------- | -------------
|
47
51
|
**input_file** | **File**| Input file to perform the operation on. |
|
52
|
+
**width** | **Integer**| Optional; width of the output viewer in pixels | [optional]
|
53
|
+
**height** | **Integer**| Optional; height of the output viewer in pixels | [optional]
|
48
54
|
|
49
55
|
### Return type
|
50
56
|
|
@@ -789,6 +789,61 @@ module CloudmersiveConvertApiClient
|
|
789
789
|
end
|
790
790
|
return data, status_code, headers
|
791
791
|
end
|
792
|
+
# Validate an TXT file
|
793
|
+
# Validate an TXT document file; if the document is not valid, identifies the errors in the document
|
794
|
+
# @param input_file Input file to perform the operation on.
|
795
|
+
# @param [Hash] opts the optional parameters
|
796
|
+
# @return [DocumentValidationResult]
|
797
|
+
def validate_document_txt_validation(input_file, opts = {})
|
798
|
+
data, _status_code, _headers = validate_document_txt_validation_with_http_info(input_file, opts)
|
799
|
+
data
|
800
|
+
end
|
801
|
+
|
802
|
+
# Validate an TXT file
|
803
|
+
# Validate an TXT document file; if the document is not valid, identifies the errors in the document
|
804
|
+
# @param input_file Input file to perform the operation on.
|
805
|
+
# @param [Hash] opts the optional parameters
|
806
|
+
# @return [Array<(DocumentValidationResult, Fixnum, Hash)>] DocumentValidationResult data, response status code and response headers
|
807
|
+
def validate_document_txt_validation_with_http_info(input_file, opts = {})
|
808
|
+
if @api_client.config.debugging
|
809
|
+
@api_client.config.logger.debug 'Calling API: ValidateDocumentApi.validate_document_txt_validation ...'
|
810
|
+
end
|
811
|
+
# verify the required parameter 'input_file' is set
|
812
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
813
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling ValidateDocumentApi.validate_document_txt_validation"
|
814
|
+
end
|
815
|
+
# resource path
|
816
|
+
local_var_path = '/convert/validate/txt'
|
817
|
+
|
818
|
+
# query parameters
|
819
|
+
query_params = {}
|
820
|
+
|
821
|
+
# header parameters
|
822
|
+
header_params = {}
|
823
|
+
# HTTP header 'Accept' (if needed)
|
824
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
825
|
+
# HTTP header 'Content-Type'
|
826
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
827
|
+
|
828
|
+
# form parameters
|
829
|
+
form_params = {}
|
830
|
+
form_params['inputFile'] = input_file
|
831
|
+
|
832
|
+
# http body (model)
|
833
|
+
post_body = nil
|
834
|
+
auth_names = ['Apikey']
|
835
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
836
|
+
:header_params => header_params,
|
837
|
+
:query_params => query_params,
|
838
|
+
:form_params => form_params,
|
839
|
+
:body => post_body,
|
840
|
+
:auth_names => auth_names,
|
841
|
+
:return_type => 'DocumentValidationResult')
|
842
|
+
if @api_client.config.debugging
|
843
|
+
@api_client.config.logger.debug "API called: ValidateDocumentApi#validate_document_txt_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
844
|
+
end
|
845
|
+
return data, status_code, headers
|
846
|
+
end
|
792
847
|
# Validate a Excel document (XLSX)
|
793
848
|
# Validate a Excel document (XLSX); if the document is not valid, identifies the errors in the document
|
794
849
|
# @param input_file Input file to perform the operation on.
|
@@ -23,6 +23,8 @@ module CloudmersiveConvertApiClient
|
|
23
23
|
# Creates an HTML embed code for a simple web-based viewer of a document; supports Office document types and PDF.
|
24
24
|
# @param input_file Input file to perform the operation on.
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
|
+
# @option opts [Integer] :width Optional; width of the output viewer in pixels
|
27
|
+
# @option opts [Integer] :height Optional; height of the output viewer in pixels
|
26
28
|
# @return [ViewerResponse]
|
27
29
|
def viewer_tools_create_simple(input_file, opts = {})
|
28
30
|
data, _status_code, _headers = viewer_tools_create_simple_with_http_info(input_file, opts)
|
@@ -33,6 +35,8 @@ module CloudmersiveConvertApiClient
|
|
33
35
|
# Creates an HTML embed code for a simple web-based viewer of a document; supports Office document types and PDF.
|
34
36
|
# @param input_file Input file to perform the operation on.
|
35
37
|
# @param [Hash] opts the optional parameters
|
38
|
+
# @option opts [Integer] :width Optional; width of the output viewer in pixels
|
39
|
+
# @option opts [Integer] :height Optional; height of the output viewer in pixels
|
36
40
|
# @return [Array<(ViewerResponse, Fixnum, Hash)>] ViewerResponse data, response status code and response headers
|
37
41
|
def viewer_tools_create_simple_with_http_info(input_file, opts = {})
|
38
42
|
if @api_client.config.debugging
|
@@ -54,6 +58,8 @@ module CloudmersiveConvertApiClient
|
|
54
58
|
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
55
59
|
# HTTP header 'Content-Type'
|
56
60
|
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
61
|
+
header_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
|
62
|
+
header_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
|
57
63
|
|
58
64
|
# form parameters
|
59
65
|
form_params = {}
|
@@ -200,6 +200,18 @@ describe 'ValidateDocumentApi' do
|
|
200
200
|
end
|
201
201
|
end
|
202
202
|
|
203
|
+
# unit tests for validate_document_txt_validation
|
204
|
+
# Validate an TXT file
|
205
|
+
# Validate an TXT document file; if the document is not valid, identifies the errors in the document
|
206
|
+
# @param input_file Input file to perform the operation on.
|
207
|
+
# @param [Hash] opts the optional parameters
|
208
|
+
# @return [DocumentValidationResult]
|
209
|
+
describe 'validate_document_txt_validation 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
|
+
|
203
215
|
# unit tests for validate_document_xlsx_validation
|
204
216
|
# Validate a Excel document (XLSX)
|
205
217
|
# Validate a Excel document (XLSX); if the document is not valid, identifies the errors in the document
|
@@ -37,6 +37,8 @@ describe 'ViewerToolsApi' do
|
|
37
37
|
# Creates an HTML embed code for a simple web-based viewer of a document; supports Office document types and PDF.
|
38
38
|
# @param input_file Input file to perform the operation on.
|
39
39
|
# @param [Hash] opts the optional parameters
|
40
|
+
# @option opts [Integer] :width Optional; width of the output viewer in pixels
|
41
|
+
# @option opts [Integer] :height Optional; height of the output viewer in pixels
|
40
42
|
# @return [ViewerResponse]
|
41
43
|
describe 'viewer_tools_create_simple test' do
|
42
44
|
it 'should work' do
|
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.2
|
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-12-14 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|