cloudmersive-convert-api-client 2.1.2 → 2.1.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (47) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +26 -4
  3. data/docs/DocxMetadataCustomProperty.md +13 -0
  4. data/docs/DocxSetCustomMetadataPropertiesRequest.md +10 -0
  5. data/docs/EditDocumentApi.md +275 -0
  6. data/docs/EditHtmlApi.md +60 -0
  7. data/docs/GetDocxMetadataPropertiesResponse.md +16 -0
  8. data/docs/GetMacrosResponse.md +9 -0
  9. data/docs/HtmlGetLinksResponse.md +9 -0
  10. data/docs/HtmlHyperlink.md +9 -0
  11. data/docs/HtmlSsrfThreatCheckResult.md +10 -0
  12. data/docs/HtmlThreatLink.md +9 -0
  13. data/docs/MergeDocumentApi.md +134 -0
  14. data/docs/ValidateDocumentApi.md +220 -0
  15. data/docs/XxeThreatDetectionResult.md +9 -0
  16. data/docs/ZipArchiveApi.md +49 -0
  17. data/lib/cloudmersive-convert-api-client.rb +9 -0
  18. data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +274 -0
  19. data/lib/cloudmersive-convert-api-client/api/edit_html_api.rb +55 -0
  20. data/lib/cloudmersive-convert-api-client/api/merge_document_api.rb +148 -0
  21. data/lib/cloudmersive-convert-api-client/api/validate_document_api.rb +220 -0
  22. data/lib/cloudmersive-convert-api-client/api/zip_archive_api.rb +46 -0
  23. data/lib/cloudmersive-convert-api-client/models/docx_metadata_custom_property.rb +236 -0
  24. data/lib/cloudmersive-convert-api-client/models/docx_set_custom_metadata_properties_request.rb +223 -0
  25. data/lib/cloudmersive-convert-api-client/models/get_docx_metadata_properties_response.rb +268 -0
  26. data/lib/cloudmersive-convert-api-client/models/get_macros_response.rb +196 -0
  27. data/lib/cloudmersive-convert-api-client/models/html_get_links_response.rb +198 -0
  28. data/lib/cloudmersive-convert-api-client/models/html_hyperlink.rb +196 -0
  29. data/lib/cloudmersive-convert-api-client/models/html_ssrf_threat_check_result.rb +208 -0
  30. data/lib/cloudmersive-convert-api-client/models/html_threat_link.rb +196 -0
  31. data/lib/cloudmersive-convert-api-client/models/xxe_threat_detection_result.rb +196 -0
  32. data/lib/cloudmersive-convert-api-client/version.rb +1 -1
  33. data/spec/api/edit_document_api_spec.rb +60 -0
  34. data/spec/api/edit_html_api_spec.rb +14 -0
  35. data/spec/api/merge_document_api_spec.rb +34 -0
  36. data/spec/api/validate_document_api_spec.rb +48 -0
  37. data/spec/api/zip_archive_api_spec.rb +11 -0
  38. data/spec/models/docx_metadata_custom_property_spec.rb +71 -0
  39. data/spec/models/docx_set_custom_metadata_properties_request_spec.rb +53 -0
  40. data/spec/models/get_docx_metadata_properties_response_spec.rb +89 -0
  41. data/spec/models/get_macros_response_spec.rb +47 -0
  42. data/spec/models/html_get_links_response_spec.rb +47 -0
  43. data/spec/models/html_hyperlink_spec.rb +47 -0
  44. data/spec/models/html_ssrf_threat_check_result_spec.rb +53 -0
  45. data/spec/models/html_threat_link_spec.rb +47 -0
  46. data/spec/models/xxe_threat_detection_result_spec.rb +47 -0
  47. metadata +29 -2
@@ -111,4 +111,18 @@ describe 'EditHtmlApi' do
111
111
  end
112
112
  end
113
113
 
114
+ # unit tests for edit_html_html_get_links
115
+ # Extract resolved link URLs from HTML File
116
+ # Extracts the resolved link URLs, fully-qualified if possible, from an input HTML file.
117
+ # @param [Hash] opts the optional parameters
118
+ # @option opts [File] :input_file Optional: Input file to perform the operation on.
119
+ # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
120
+ # @option opts [String] :base_url Optional: Base URL of the page, such as https://mydomain.com
121
+ # @return [HtmlGetLinksResponse]
122
+ describe 'edit_html_html_get_links test' do
123
+ it 'should work' do
124
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
125
+ end
126
+ end
127
+
114
128
  end
@@ -66,6 +66,40 @@ describe 'MergeDocumentApi' do
66
66
  end
67
67
  end
68
68
 
69
+ # unit tests for merge_document_html
70
+ # Merge Two HTML (HTM) Files Together
71
+ # Combine two HTML (.HTM) files into a single text document, preserving the order of the input documents in the combined document by stacking them vertically. The title will be taken from the first document.
72
+ # @param input_file1 First input file to perform the operation on.
73
+ # @param input_file2 Second input file to perform the operation on (more than 2 can be supplied).
74
+ # @param [Hash] opts the optional parameters
75
+ # @return [Object]
76
+ describe 'merge_document_html test' do
77
+ it 'should work' do
78
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
79
+ end
80
+ end
81
+
82
+ # unit tests for merge_document_html_multi
83
+ # Merge Multple HTML (HTM) Files Together
84
+ # Combine multiple HTML (.HTM) files into a single text document, preserving the order of the input documents in the combined document by stacking them vertically. The title will be taken from the first document.
85
+ # @param input_file1 First input file to perform the operation on.
86
+ # @param input_file2 Second input file to perform the operation on.
87
+ # @param [Hash] opts the optional parameters
88
+ # @option opts [File] :input_file3 Third input file to perform the operation on.
89
+ # @option opts [File] :input_file4 Fourth input file to perform the operation on.
90
+ # @option opts [File] :input_file5 Fifth input file to perform the operation on.
91
+ # @option opts [File] :input_file6 Sixth input file to perform the operation on.
92
+ # @option opts [File] :input_file7 Seventh input file to perform the operation on.
93
+ # @option opts [File] :input_file8 Eighth input file to perform the operation on.
94
+ # @option opts [File] :input_file9 Ninth input file to perform the operation on.
95
+ # @option opts [File] :input_file10 Tenth input file to perform the operation on.
96
+ # @return [String]
97
+ describe 'merge_document_html_multi test' do
98
+ it 'should work' do
99
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
100
+ end
101
+ end
102
+
69
103
  # unit tests for merge_document_pdf
70
104
  # Merge Two PDF Files Together
71
105
  # Combine two PDF files (pdf) into a single PDF document, preserving the order of the input documents in the combined document
@@ -104,6 +104,18 @@ describe 'ValidateDocumentApi' do
104
104
  end
105
105
  end
106
106
 
107
+ # unit tests for validate_document_html_ssrf_validation
108
+ # Validate an HTML file and checks for SSRF threats
109
+ # Validate an HTML document file and checks for SSRF (Server-side Request Forgery) threats in the file; if the document is not valid, identifies the errors in the document
110
+ # @param input_file Input file to perform the operation on.
111
+ # @param [Hash] opts the optional parameters
112
+ # @return [HtmlSsrfThreatCheckResult]
113
+ describe 'validate_document_html_ssrf_validation test' do
114
+ it 'should work' do
115
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
116
+ end
117
+ end
118
+
107
119
  # unit tests for validate_document_html_validation
108
120
  # Validate an HTML file
109
121
  # Validate an HTML document file; if the document is not valid, identifies the errors in the document
@@ -128,6 +140,18 @@ describe 'ValidateDocumentApi' do
128
140
  end
129
141
  end
130
142
 
143
+ # unit tests for validate_document_jpg_validation
144
+ # Validate a JPG File
145
+ # Validate a JPEG image file; if the document is not valid, identifies the errors in the document..
146
+ # @param input_file Input file to perform the operation on.
147
+ # @param [Hash] opts the optional parameters
148
+ # @return [DocumentValidationResult]
149
+ describe 'validate_document_jpg_validation test' do
150
+ it 'should work' do
151
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
152
+ end
153
+ end
154
+
131
155
  # unit tests for validate_document_json_validation
132
156
  # Validate a JSON file
133
157
  # Validate a JSON (JavaScript Object Notation) document file; if the document is not valid, identifies the errors in the document
@@ -164,6 +188,18 @@ describe 'ValidateDocumentApi' do
164
188
  end
165
189
  end
166
190
 
191
+ # unit tests for validate_document_png_validation
192
+ # Validate a PNG File
193
+ # Validate a PNG image file; if the document is not valid, identifies the errors in the document.
194
+ # @param input_file Input file to perform the operation on.
195
+ # @param [Hash] opts the optional parameters
196
+ # @return [DocumentValidationResult]
197
+ describe 'validate_document_png_validation test' do
198
+ it 'should work' do
199
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
200
+ end
201
+ end
202
+
167
203
  # unit tests for validate_document_pptx_validation
168
204
  # Validate a PowerPoint presentation (PPTX)
169
205
  # Validate a PowerPoint presentation (PPTX); if the document is not valid, identifies the errors in the document
@@ -236,6 +272,18 @@ describe 'ValidateDocumentApi' do
236
272
  end
237
273
  end
238
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
+
239
287
  # unit tests for validate_document_zip_validation
240
288
  # Validate a Zip Archive file (zip)
241
289
  # Validate a Zip archive file (ZIP)
@@ -88,6 +88,17 @@ 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 [Hash] opts the optional parameters
95
+ # @return [Object]
96
+ describe 'zip_archive_zip_create_quarantine test' do
97
+ it 'should work' do
98
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
99
+ end
100
+ end
101
+
91
102
  # unit tests for zip_archive_zip_decrypt
92
103
  # Decrypt and remove password protection on a zip file
93
104
  # Decrypts and removes password protection from an encrypted zip file with the specified password
@@ -0,0 +1,71 @@
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::DocxMetadataCustomProperty
18
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
19
+ # Please update as you see appropriate
20
+ describe 'DocxMetadataCustomProperty' do
21
+ before do
22
+ # run before each test
23
+ @instance = CloudmersiveConvertApiClient::DocxMetadataCustomProperty.new
24
+ end
25
+
26
+ after do
27
+ # run after each test
28
+ end
29
+
30
+ describe 'test an instance of DocxMetadataCustomProperty' do
31
+ it 'should create an instance of DocxMetadataCustomProperty' do
32
+ expect(@instance).to be_instance_of(CloudmersiveConvertApiClient::DocxMetadataCustomProperty)
33
+ end
34
+ end
35
+ describe 'test attribute "property_name"' 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 "property_data_type"' do
42
+ it 'should work' do
43
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
44
+ end
45
+ end
46
+
47
+ describe 'test attribute "string_value"' do
48
+ it 'should work' do
49
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
50
+ end
51
+ end
52
+
53
+ describe 'test attribute "integer_value"' do
54
+ it 'should work' do
55
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
56
+ end
57
+ end
58
+
59
+ describe 'test attribute "double_value"' do
60
+ it 'should work' do
61
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
62
+ end
63
+ end
64
+
65
+ describe 'test attribute "date_value"' do
66
+ it 'should work' do
67
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
68
+ end
69
+ end
70
+
71
+ end
@@ -0,0 +1,53 @@
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::DocxSetCustomMetadataPropertiesRequest
18
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
19
+ # Please update as you see appropriate
20
+ describe 'DocxSetCustomMetadataPropertiesRequest' do
21
+ before do
22
+ # run before each test
23
+ @instance = CloudmersiveConvertApiClient::DocxSetCustomMetadataPropertiesRequest.new
24
+ end
25
+
26
+ after do
27
+ # run after each test
28
+ end
29
+
30
+ describe 'test an instance of DocxSetCustomMetadataPropertiesRequest' do
31
+ it 'should create an instance of DocxSetCustomMetadataPropertiesRequest' do
32
+ expect(@instance).to be_instance_of(CloudmersiveConvertApiClient::DocxSetCustomMetadataPropertiesRequest)
33
+ end
34
+ end
35
+ describe 'test attribute "input_file_bytes"' 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 "input_file_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
+ describe 'test attribute "properties_to_set"' do
48
+ it 'should work' do
49
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
50
+ end
51
+ end
52
+
53
+ end
@@ -0,0 +1,89 @@
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::GetDocxMetadataPropertiesResponse
18
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
19
+ # Please update as you see appropriate
20
+ describe 'GetDocxMetadataPropertiesResponse' do
21
+ before do
22
+ # run before each test
23
+ @instance = CloudmersiveConvertApiClient::GetDocxMetadataPropertiesResponse.new
24
+ end
25
+
26
+ after do
27
+ # run after each test
28
+ end
29
+
30
+ describe 'test an instance of GetDocxMetadataPropertiesResponse' do
31
+ it 'should create an instance of GetDocxMetadataPropertiesResponse' do
32
+ expect(@instance).to be_instance_of(CloudmersiveConvertApiClient::GetDocxMetadataPropertiesResponse)
33
+ end
34
+ end
35
+ describe 'test attribute "company"' 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 "manager"' do
42
+ it 'should work' do
43
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
44
+ end
45
+ end
46
+
47
+ describe 'test attribute "application_version"' do
48
+ it 'should work' do
49
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
50
+ end
51
+ end
52
+
53
+ describe 'test attribute "word_count"' do
54
+ it 'should work' do
55
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
56
+ end
57
+ end
58
+
59
+ describe 'test attribute "line_count"' do
60
+ it 'should work' do
61
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
62
+ end
63
+ end
64
+
65
+ describe 'test attribute "paragraph_count"' do
66
+ it 'should work' do
67
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
68
+ end
69
+ end
70
+
71
+ describe 'test attribute "page_count"' do
72
+ it 'should work' do
73
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
74
+ end
75
+ end
76
+
77
+ describe 'test attribute "custom_properties"' 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
+
83
+ describe 'test attribute "successful"' do
84
+ it 'should work' do
85
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
86
+ end
87
+ end
88
+
89
+ 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::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::HtmlGetLinksResponse
18
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
19
+ # Please update as you see appropriate
20
+ describe 'HtmlGetLinksResponse' do
21
+ before do
22
+ # run before each test
23
+ @instance = CloudmersiveConvertApiClient::HtmlGetLinksResponse.new
24
+ end
25
+
26
+ after do
27
+ # run after each test
28
+ end
29
+
30
+ describe 'test an instance of HtmlGetLinksResponse' do
31
+ it 'should create an instance of HtmlGetLinksResponse' do
32
+ expect(@instance).to be_instance_of(CloudmersiveConvertApiClient::HtmlGetLinksResponse)
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 "links"' 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