cloudmersive-convert-api-client 2.1.5 → 2.2.0

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.
Files changed (38) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +21 -4
  3. data/docs/EditDocumentApi.md +165 -0
  4. data/docs/EditHtmlApi.md +418 -0
  5. data/docs/EditPdfApi.md +6 -2
  6. data/docs/GetMacrosResponse.md +9 -0
  7. data/docs/HtmlGetLanguageResult.md +9 -0
  8. data/docs/HtmlGetRelCanonicalUrlResult.md +9 -0
  9. data/docs/HtmlGetSitemapUrlResult.md +9 -0
  10. data/docs/MergeDocumentApi.md +2 -2
  11. data/docs/ValidateDocumentApi.md +55 -0
  12. data/docs/XxeThreatDetectionResult.md +9 -0
  13. data/docs/ZipArchiveApi.md +62 -0
  14. data/lib/cloudmersive-convert-api-client.rb +5 -0
  15. data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +165 -0
  16. data/lib/cloudmersive-convert-api-client/api/edit_html_api.rb +392 -0
  17. data/lib/cloudmersive-convert-api-client/api/edit_pdf_api.rb +3 -0
  18. data/lib/cloudmersive-convert-api-client/api/merge_document_api.rb +3 -3
  19. data/lib/cloudmersive-convert-api-client/api/validate_document_api.rb +55 -0
  20. data/lib/cloudmersive-convert-api-client/api/zip_archive_api.rb +63 -0
  21. data/lib/cloudmersive-convert-api-client/models/get_macros_response.rb +196 -0
  22. data/lib/cloudmersive-convert-api-client/models/html_get_language_result.rb +196 -0
  23. data/lib/cloudmersive-convert-api-client/models/html_get_rel_canonical_url_result.rb +196 -0
  24. data/lib/cloudmersive-convert-api-client/models/html_get_sitemap_url_result.rb +196 -0
  25. data/lib/cloudmersive-convert-api-client/models/xxe_threat_detection_result.rb +196 -0
  26. data/lib/cloudmersive-convert-api-client/version.rb +1 -1
  27. data/spec/api/edit_document_api_spec.rb +36 -0
  28. data/spec/api/edit_html_api_spec.rb +95 -0
  29. data/spec/api/edit_pdf_api_spec.rb +1 -0
  30. data/spec/api/merge_document_api_spec.rb +1 -1
  31. data/spec/api/validate_document_api_spec.rb +12 -0
  32. data/spec/api/zip_archive_api_spec.rb +14 -0
  33. data/spec/models/get_macros_response_spec.rb +47 -0
  34. data/spec/models/html_get_language_result_spec.rb +47 -0
  35. data/spec/models/html_get_rel_canonical_url_result_spec.rb +47 -0
  36. data/spec/models/html_get_sitemap_url_result_spec.rb +47 -0
  37. data/spec/models/xxe_threat_detection_result_spec.rb +47 -0
  38. metadata +17 -2
@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.14
11
11
  =end
12
12
 
13
13
  module CloudmersiveConvertApiClient
14
- VERSION = '2.1.5'
14
+ VERSION = '2.2.0'
15
15
  end
@@ -200,6 +200,18 @@ describe 'EditDocumentApi' do
200
200
  end
201
201
  end
202
202
 
203
+ # unit tests for edit_document_docx_get_macro_information
204
+ # Get macro information from a Word DOCX/DOCM document
205
+ # Returns information about the Macros (e.g. VBA) defined in the Word Document
206
+ # @param input_file Input file to perform the operation on.
207
+ # @param [Hash] opts the optional parameters
208
+ # @return [GetMacrosResponse]
209
+ describe 'edit_document_docx_get_macro_information 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 edit_document_docx_get_metadata_properties
204
216
  # Get all metadata properties in Word DOCX document
205
217
  # Returns all the metadata properties in an Office Word Document (docx)
@@ -512,6 +524,18 @@ describe 'EditDocumentApi' do
512
524
  end
513
525
  end
514
526
 
527
+ # unit tests for edit_document_pptx_get_macro_information
528
+ # Get macro information from a PowerPoint PPTX/PPTM presentation document
529
+ # Returns information about the Macros (e.g. VBA) defined in the PowerPoint Document
530
+ # @param input_file Input file to perform the operation on.
531
+ # @param [Hash] opts the optional parameters
532
+ # @return [GetMacrosResponse]
533
+ describe 'edit_document_pptx_get_macro_information test' do
534
+ it 'should work' do
535
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
536
+ end
537
+ end
538
+
515
539
  # unit tests for edit_document_pptx_replace
516
540
  # Replace string in PowerPoint PPTX presentation
517
541
  # Replace all instances of a string in an Office PowerPoint Document (pptx)
@@ -668,6 +692,18 @@ describe 'EditDocumentApi' do
668
692
  end
669
693
  end
670
694
 
695
+ # unit tests for edit_document_xlsx_get_macro_information
696
+ # Get macro information from a Excel XLSX/XLSM spreadsheet, worksheet
697
+ # Returns information about the Macros (e.g. VBA) defined in the Excel Spreadsheet
698
+ # @param input_file Input file to perform the operation on.
699
+ # @param [Hash] opts the optional parameters
700
+ # @return [GetMacrosResponse]
701
+ describe 'edit_document_xlsx_get_macro_information test' do
702
+ it 'should work' do
703
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
704
+ end
705
+ end
706
+
671
707
  # unit tests for edit_document_xlsx_get_rows_and_cells
672
708
  # Get rows and cells from a Excel XLSX spreadsheet, worksheet
673
709
  # Returns the rows and cells defined in the Excel Spreadsheet worksheet
@@ -32,6 +32,20 @@ describe 'EditHtmlApi' do
32
32
  end
33
33
  end
34
34
 
35
+ # unit tests for edit_html_html_append_header_tag
36
+ # Append an HTML tag to the HEAD section of an HTML Document
37
+ # Appends an HTML tag to the HEAD section of an HTML document.
38
+ # @param html_tag The HTML tag to append.
39
+ # @param [Hash] opts the optional parameters
40
+ # @option opts [File] :input_file Optional: Input file to perform the operation on.
41
+ # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
42
+ # @return [String]
43
+ describe 'edit_html_html_append_header_tag test' do
44
+ it 'should work' do
45
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
46
+ end
47
+ end
48
+
35
49
  # unit tests for edit_html_html_append_heading
36
50
  # Append a Heading to an HTML Document
37
51
  # Appends a heading to the end of an HTML document.
@@ -111,6 +125,19 @@ describe 'EditHtmlApi' do
111
125
  end
112
126
  end
113
127
 
128
+ # unit tests for edit_html_html_get_language
129
+ # Gets the language for the HTML document
130
+ # Retrieves the language code (e.g. \"en\" or \"de\") of an HTML document.
131
+ # @param [Hash] opts the optional parameters
132
+ # @option opts [File] :input_file Optional: Input file to perform the operation on.
133
+ # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
134
+ # @return [HtmlGetLanguageResult]
135
+ describe 'edit_html_html_get_language test' do
136
+ it 'should work' do
137
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
138
+ end
139
+ end
140
+
114
141
  # unit tests for edit_html_html_get_links
115
142
  # Extract resolved link URLs from HTML File
116
143
  # Extracts the resolved link URLs, fully-qualified if possible, from an input HTML file.
@@ -125,4 +152,72 @@ describe 'EditHtmlApi' do
125
152
  end
126
153
  end
127
154
 
155
+ # unit tests for edit_html_html_get_rel_canonical
156
+ # Gets the rel canonical URL for the HTML document
157
+ # Gets the rel canonical URL of an HTML document.
158
+ # @param [Hash] opts the optional parameters
159
+ # @option opts [File] :input_file Optional: Input file to perform the operation on.
160
+ # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
161
+ # @return [HtmlGetRelCanonicalUrlResult]
162
+ describe 'edit_html_html_get_rel_canonical test' do
163
+ it 'should work' do
164
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
165
+ end
166
+ end
167
+
168
+ # unit tests for edit_html_html_get_sitemap
169
+ # Gets the sitemap URL for the HTML document
170
+ # Gets the sitemap link URL of an HTML document.
171
+ # @param [Hash] opts the optional parameters
172
+ # @option opts [File] :input_file Optional: Input file to perform the operation on.
173
+ # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
174
+ # @return [HtmlGetSitemapUrlResult]
175
+ describe 'edit_html_html_get_sitemap test' do
176
+ it 'should work' do
177
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
178
+ end
179
+ end
180
+
181
+ # unit tests for edit_html_html_set_language
182
+ # Sets the language for the HTML document
183
+ # Sets the language code of an HTML document.
184
+ # @param language_code The HTML langauge code to set.
185
+ # @param [Hash] opts the optional parameters
186
+ # @option opts [File] :input_file Optional: Input file to perform the operation on.
187
+ # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
188
+ # @return [String]
189
+ describe 'edit_html_html_set_language test' do
190
+ it 'should work' do
191
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
192
+ end
193
+ end
194
+
195
+ # unit tests for edit_html_html_set_rel_canonical
196
+ # Sets the rel canonical URL for the HTML document
197
+ # Sets the rel canonical URL of an HTML document. This is useful for telling search engines and other indexers which pages are duplicates of eachother; any pages with the rel=canonical tag will be treated as duplicates of the canonical URL.
198
+ # @param canonical_url The HTML canonical URL to set.
199
+ # @param [Hash] opts the optional parameters
200
+ # @option opts [File] :input_file Optional: Input file to perform the operation on.
201
+ # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
202
+ # @return [String]
203
+ describe 'edit_html_html_set_rel_canonical test' do
204
+ it 'should work' do
205
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
206
+ end
207
+ end
208
+
209
+ # unit tests for edit_html_html_set_sitemap_url
210
+ # Sets the sitemap URL for the HTML document
211
+ # Sets the sitemap URL of an HTML document.
212
+ # @param sitemap_url The HTML sitemap URL to set.
213
+ # @param [Hash] opts the optional parameters
214
+ # @option opts [File] :input_file Optional: Input file to perform the operation on.
215
+ # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
216
+ # @return [String]
217
+ describe 'edit_html_html_set_sitemap_url test' do
218
+ it 'should work' do
219
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
220
+ end
221
+ end
222
+
128
223
  end
@@ -193,6 +193,7 @@ describe 'EditPdfApi' do
193
193
  # Reduces the file size and optimizes the content of a PDF to minimize its file size.
194
194
  # @param input_file Input file to perform the operation on.
195
195
  # @param [Hash] opts the optional parameters
196
+ # @option opts [Float] :quality Quality level for the images in the PDF, ranging from 0.0 (low quality) to 1.0 (high quality); default is 0.3
196
197
  # @return [String]
197
198
  describe 'edit_pdf_reduce_file_size test' do
198
199
  it 'should work' do
@@ -72,7 +72,7 @@ describe 'MergeDocumentApi' do
72
72
  # @param input_file1 First input file to perform the operation on.
73
73
  # @param input_file2 Second input file to perform the operation on (more than 2 can be supplied).
74
74
  # @param [Hash] opts the optional parameters
75
- # @return [Object]
75
+ # @return [String]
76
76
  describe 'merge_document_html test' do
77
77
  it 'should work' do
78
78
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -272,6 +272,18 @@ describe 'ValidateDocumentApi' do
272
272
  end
273
273
  end
274
274
 
275
+ # unit tests for validate_document_xml_xxe_threat_validation
276
+ # Validate an XML file for XML External Entity (XXE) threats
277
+ # Validate an XML document file for XML External Entity (XXE) threats; if the document is not valid, identifies the errors in the document. XXE threats are a type of threat that exploits vulnerabilities in the XML standard relating to external or local entity URIs in XML documents.
278
+ # @param input_file Input file to perform the operation on.
279
+ # @param [Hash] opts the optional parameters
280
+ # @return [XxeThreatDetectionResult]
281
+ describe 'validate_document_xml_xxe_threat_validation test' do
282
+ it 'should work' do
283
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
284
+ end
285
+ end
286
+
275
287
  # unit tests for validate_document_zip_validation
276
288
  # Validate a Zip Archive file (zip)
277
289
  # Validate a Zip archive file (ZIP)
@@ -88,6 +88,20 @@ describe 'ZipArchiveApi' do
88
88
  end
89
89
  end
90
90
 
91
+ # unit tests for zip_archive_zip_create_quarantine
92
+ # Create an encrypted zip file to quarantine a dangerous file
93
+ # Create a new zip archive by compressing input files, and also applies encryption and password protection to the zip, for the purposes of quarantining the underlyikng file.
94
+ # @param password Password to place on the Zip file; the longer the password, the more secure
95
+ # @param input_file1 First input file to perform the operation on.
96
+ # @param [Hash] opts the optional parameters
97
+ # @option opts [String] :encryption_algorithm Encryption algorithm to use; possible values are AES-256 (recommended), AES-128, and PK-Zip (not recommended; legacy, weak encryption algorithm). Default is AES-256.
98
+ # @return [Object]
99
+ describe 'zip_archive_zip_create_quarantine test' do
100
+ it 'should work' do
101
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
102
+ end
103
+ end
104
+
91
105
  # unit tests for zip_archive_zip_decrypt
92
106
  # Decrypt and remove password protection on a zip file
93
107
  # Decrypts and removes password protection from an encrypted zip file with the specified password
@@ -0,0 +1,47 @@
1
+ =begin
2
+ #convertapi
3
+
4
+ #Convert API lets you effortlessly convert file formats and types.
5
+
6
+ OpenAPI spec version: v1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.14
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for CloudmersiveConvertApiClient::GetMacrosResponse
18
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
19
+ # Please update as you see appropriate
20
+ describe 'GetMacrosResponse' do
21
+ before do
22
+ # run before each test
23
+ @instance = CloudmersiveConvertApiClient::GetMacrosResponse.new
24
+ end
25
+
26
+ after do
27
+ # run after each test
28
+ end
29
+
30
+ describe 'test an instance of GetMacrosResponse' do
31
+ it 'should create an instance of GetMacrosResponse' do
32
+ expect(@instance).to be_instance_of(CloudmersiveConvertApiClient::GetMacrosResponse)
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 "contains_vba_macros"' 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
@@ -0,0 +1,47 @@
1
+ =begin
2
+ #convertapi
3
+
4
+ #Convert API lets you effortlessly convert file formats and types.
5
+
6
+ OpenAPI spec version: v1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.14
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for CloudmersiveConvertApiClient::HtmlGetLanguageResult
18
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
19
+ # Please update as you see appropriate
20
+ describe 'HtmlGetLanguageResult' do
21
+ before do
22
+ # run before each test
23
+ @instance = CloudmersiveConvertApiClient::HtmlGetLanguageResult.new
24
+ end
25
+
26
+ after do
27
+ # run after each test
28
+ end
29
+
30
+ describe 'test an instance of HtmlGetLanguageResult' do
31
+ it 'should create an instance of HtmlGetLanguageResult' do
32
+ expect(@instance).to be_instance_of(CloudmersiveConvertApiClient::HtmlGetLanguageResult)
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 "language_code"' 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
@@ -0,0 +1,47 @@
1
+ =begin
2
+ #convertapi
3
+
4
+ #Convert API lets you effortlessly convert file formats and types.
5
+
6
+ OpenAPI spec version: v1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.14
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for CloudmersiveConvertApiClient::HtmlGetRelCanonicalUrlResult
18
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
19
+ # Please update as you see appropriate
20
+ describe 'HtmlGetRelCanonicalUrlResult' do
21
+ before do
22
+ # run before each test
23
+ @instance = CloudmersiveConvertApiClient::HtmlGetRelCanonicalUrlResult.new
24
+ end
25
+
26
+ after do
27
+ # run after each test
28
+ end
29
+
30
+ describe 'test an instance of HtmlGetRelCanonicalUrlResult' do
31
+ it 'should create an instance of HtmlGetRelCanonicalUrlResult' do
32
+ expect(@instance).to be_instance_of(CloudmersiveConvertApiClient::HtmlGetRelCanonicalUrlResult)
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 "canonical_url"' 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
@@ -0,0 +1,47 @@
1
+ =begin
2
+ #convertapi
3
+
4
+ #Convert API lets you effortlessly convert file formats and types.
5
+
6
+ OpenAPI spec version: v1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.14
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for CloudmersiveConvertApiClient::HtmlGetSitemapUrlResult
18
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
19
+ # Please update as you see appropriate
20
+ describe 'HtmlGetSitemapUrlResult' do
21
+ before do
22
+ # run before each test
23
+ @instance = CloudmersiveConvertApiClient::HtmlGetSitemapUrlResult.new
24
+ end
25
+
26
+ after do
27
+ # run after each test
28
+ end
29
+
30
+ describe 'test an instance of HtmlGetSitemapUrlResult' do
31
+ it 'should create an instance of HtmlGetSitemapUrlResult' do
32
+ expect(@instance).to be_instance_of(CloudmersiveConvertApiClient::HtmlGetSitemapUrlResult)
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 "canonical_url"' 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
@@ -0,0 +1,47 @@
1
+ =begin
2
+ #convertapi
3
+
4
+ #Convert API lets you effortlessly convert file formats and types.
5
+
6
+ OpenAPI spec version: v1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.14
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for CloudmersiveConvertApiClient::XxeThreatDetectionResult
18
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
19
+ # Please update as you see appropriate
20
+ describe 'XxeThreatDetectionResult' do
21
+ before do
22
+ # run before each test
23
+ @instance = CloudmersiveConvertApiClient::XxeThreatDetectionResult.new
24
+ end
25
+
26
+ after do
27
+ # run after each test
28
+ end
29
+
30
+ describe 'test an instance of XxeThreatDetectionResult' do
31
+ it 'should create an instance of XxeThreatDetectionResult' do
32
+ expect(@instance).to be_instance_of(CloudmersiveConvertApiClient::XxeThreatDetectionResult)
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 "contains_xxe_threat"' 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