cloudmersive-convert-api-client 2.1.1 → 2.1.6
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 +4 -4
- data/README.md +24 -4
- data/docs/DocxMetadataCustomProperty.md +13 -0
- data/docs/DocxSetCustomMetadataPropertiesRequest.md +10 -0
- data/docs/EditDocumentApi.md +275 -0
- data/docs/EditHtmlApi.md +60 -0
- data/docs/GetDocxMetadataPropertiesResponse.md +16 -0
- data/docs/GetMacrosResponse.md +9 -0
- data/docs/HtmlGetLinksResponse.md +9 -0
- data/docs/HtmlHyperlink.md +9 -0
- data/docs/HtmlSsrfThreatCheckResult.md +10 -0
- data/docs/HtmlThreatLink.md +9 -0
- data/docs/MergeDocumentApi.md +134 -0
- data/docs/ValidateDocumentApi.md +220 -0
- data/docs/ViewerToolsApi.md +8 -2
- data/lib/cloudmersive-convert-api-client.rb +8 -0
- data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +274 -0
- data/lib/cloudmersive-convert-api-client/api/edit_html_api.rb +55 -0
- data/lib/cloudmersive-convert-api-client/api/merge_document_api.rb +148 -0
- data/lib/cloudmersive-convert-api-client/api/validate_document_api.rb +220 -0
- data/lib/cloudmersive-convert-api-client/api/viewer_tools_api.rb +6 -0
- data/lib/cloudmersive-convert-api-client/models/docx_metadata_custom_property.rb +236 -0
- data/lib/cloudmersive-convert-api-client/models/docx_set_custom_metadata_properties_request.rb +223 -0
- data/lib/cloudmersive-convert-api-client/models/get_docx_metadata_properties_response.rb +268 -0
- data/lib/cloudmersive-convert-api-client/models/get_macros_response.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/html_get_links_response.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/html_hyperlink.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/html_ssrf_threat_check_result.rb +208 -0
- data/lib/cloudmersive-convert-api-client/models/html_threat_link.rb +196 -0
- data/lib/cloudmersive-convert-api-client/version.rb +1 -1
- data/spec/api/edit_document_api_spec.rb +60 -0
- data/spec/api/edit_html_api_spec.rb +14 -0
- data/spec/api/merge_document_api_spec.rb +34 -0
- data/spec/api/validate_document_api_spec.rb +48 -0
- data/spec/api/viewer_tools_api_spec.rb +2 -0
- data/spec/models/docx_metadata_custom_property_spec.rb +71 -0
- data/spec/models/docx_set_custom_metadata_properties_request_spec.rb +53 -0
- data/spec/models/get_docx_metadata_properties_response_spec.rb +89 -0
- data/spec/models/get_macros_response_spec.rb +47 -0
- data/spec/models/html_get_links_response_spec.rb +47 -0
- data/spec/models/html_hyperlink_spec.rb +47 -0
- data/spec/models/html_ssrf_threat_check_result_spec.rb +53 -0
- data/spec/models/html_threat_link_spec.rb +47 -0
- metadata +26 -2
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
|
|
@@ -66,12 +66,14 @@ require 'cloudmersive-convert-api-client/models/docx_image'
|
|
66
66
|
require 'cloudmersive-convert-api-client/models/docx_insert_comment_on_paragraph_request'
|
67
67
|
require 'cloudmersive-convert-api-client/models/docx_insert_image_request'
|
68
68
|
require 'cloudmersive-convert-api-client/models/docx_insert_image_response'
|
69
|
+
require 'cloudmersive-convert-api-client/models/docx_metadata_custom_property'
|
69
70
|
require 'cloudmersive-convert-api-client/models/docx_page'
|
70
71
|
require 'cloudmersive-convert-api-client/models/docx_paragraph'
|
71
72
|
require 'cloudmersive-convert-api-client/models/docx_remove_object_request'
|
72
73
|
require 'cloudmersive-convert-api-client/models/docx_remove_object_response'
|
73
74
|
require 'cloudmersive-convert-api-client/models/docx_run'
|
74
75
|
require 'cloudmersive-convert-api-client/models/docx_section'
|
76
|
+
require 'cloudmersive-convert-api-client/models/docx_set_custom_metadata_properties_request'
|
75
77
|
require 'cloudmersive-convert-api-client/models/docx_set_footer_add_page_number_request'
|
76
78
|
require 'cloudmersive-convert-api-client/models/docx_set_footer_request'
|
77
79
|
require 'cloudmersive-convert-api-client/models/docx_set_footer_response'
|
@@ -113,6 +115,7 @@ require 'cloudmersive-convert-api-client/models/get_docx_headers_and_footers_req
|
|
113
115
|
require 'cloudmersive-convert-api-client/models/get_docx_headers_and_footers_response'
|
114
116
|
require 'cloudmersive-convert-api-client/models/get_docx_images_request'
|
115
117
|
require 'cloudmersive-convert-api-client/models/get_docx_images_response'
|
118
|
+
require 'cloudmersive-convert-api-client/models/get_docx_metadata_properties_response'
|
116
119
|
require 'cloudmersive-convert-api-client/models/get_docx_pages_request'
|
117
120
|
require 'cloudmersive-convert-api-client/models/get_docx_pages_response'
|
118
121
|
require 'cloudmersive-convert-api-client/models/get_docx_sections_request'
|
@@ -127,6 +130,7 @@ require 'cloudmersive-convert-api-client/models/get_docx_tables_request'
|
|
127
130
|
require 'cloudmersive-convert-api-client/models/get_docx_tables_response'
|
128
131
|
require 'cloudmersive-convert-api-client/models/get_file_type_icon_result'
|
129
132
|
require 'cloudmersive-convert-api-client/models/get_image_info_result'
|
133
|
+
require 'cloudmersive-convert-api-client/models/get_macros_response'
|
130
134
|
require 'cloudmersive-convert-api-client/models/get_pdf_annotations_result'
|
131
135
|
require 'cloudmersive-convert-api-client/models/get_xlsx_cell_by_identifier_request'
|
132
136
|
require 'cloudmersive-convert-api-client/models/get_xlsx_cell_by_identifier_response'
|
@@ -144,10 +148,14 @@ require 'cloudmersive-convert-api-client/models/get_xlsx_styles_request'
|
|
144
148
|
require 'cloudmersive-convert-api-client/models/get_xlsx_styles_response'
|
145
149
|
require 'cloudmersive-convert-api-client/models/get_xlsx_worksheets_request'
|
146
150
|
require 'cloudmersive-convert-api-client/models/get_xlsx_worksheets_response'
|
151
|
+
require 'cloudmersive-convert-api-client/models/html_get_links_response'
|
152
|
+
require 'cloudmersive-convert-api-client/models/html_hyperlink'
|
147
153
|
require 'cloudmersive-convert-api-client/models/html_md_result'
|
154
|
+
require 'cloudmersive-convert-api-client/models/html_ssrf_threat_check_result'
|
148
155
|
require 'cloudmersive-convert-api-client/models/html_template_application_request'
|
149
156
|
require 'cloudmersive-convert-api-client/models/html_template_application_response'
|
150
157
|
require 'cloudmersive-convert-api-client/models/html_template_operation'
|
158
|
+
require 'cloudmersive-convert-api-client/models/html_threat_link'
|
151
159
|
require 'cloudmersive-convert-api-client/models/html_to_office_request'
|
152
160
|
require 'cloudmersive-convert-api-client/models/html_to_pdf_request'
|
153
161
|
require 'cloudmersive-convert-api-client/models/html_to_png_request'
|
@@ -779,6 +779,116 @@ module CloudmersiveConvertApiClient
|
|
779
779
|
end
|
780
780
|
return data, status_code, headers
|
781
781
|
end
|
782
|
+
# Get macro information from a Word DOCX/DOCM document
|
783
|
+
# Returns information about the Macros (e.g. VBA) defined in the Word Document
|
784
|
+
# @param input_file Input file to perform the operation on.
|
785
|
+
# @param [Hash] opts the optional parameters
|
786
|
+
# @return [GetMacrosResponse]
|
787
|
+
def edit_document_docx_get_macro_information(input_file, opts = {})
|
788
|
+
data, _status_code, _headers = edit_document_docx_get_macro_information_with_http_info(input_file, opts)
|
789
|
+
data
|
790
|
+
end
|
791
|
+
|
792
|
+
# Get macro information from a Word DOCX/DOCM document
|
793
|
+
# Returns information about the Macros (e.g. VBA) defined in the Word Document
|
794
|
+
# @param input_file Input file to perform the operation on.
|
795
|
+
# @param [Hash] opts the optional parameters
|
796
|
+
# @return [Array<(GetMacrosResponse, Fixnum, Hash)>] GetMacrosResponse data, response status code and response headers
|
797
|
+
def edit_document_docx_get_macro_information_with_http_info(input_file, opts = {})
|
798
|
+
if @api_client.config.debugging
|
799
|
+
@api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_get_macro_information ...'
|
800
|
+
end
|
801
|
+
# verify the required parameter 'input_file' is set
|
802
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
803
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_docx_get_macro_information"
|
804
|
+
end
|
805
|
+
# resource path
|
806
|
+
local_var_path = '/convert/edit/docx/get-macros'
|
807
|
+
|
808
|
+
# query parameters
|
809
|
+
query_params = {}
|
810
|
+
|
811
|
+
# header parameters
|
812
|
+
header_params = {}
|
813
|
+
# HTTP header 'Accept' (if needed)
|
814
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
815
|
+
# HTTP header 'Content-Type'
|
816
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
817
|
+
|
818
|
+
# form parameters
|
819
|
+
form_params = {}
|
820
|
+
form_params['inputFile'] = input_file
|
821
|
+
|
822
|
+
# http body (model)
|
823
|
+
post_body = nil
|
824
|
+
auth_names = ['Apikey']
|
825
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
826
|
+
:header_params => header_params,
|
827
|
+
:query_params => query_params,
|
828
|
+
:form_params => form_params,
|
829
|
+
:body => post_body,
|
830
|
+
:auth_names => auth_names,
|
831
|
+
:return_type => 'GetMacrosResponse')
|
832
|
+
if @api_client.config.debugging
|
833
|
+
@api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_get_macro_information\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
834
|
+
end
|
835
|
+
return data, status_code, headers
|
836
|
+
end
|
837
|
+
# Get all metadata properties in Word DOCX document
|
838
|
+
# Returns all the metadata properties in an Office Word Document (docx)
|
839
|
+
# @param input_file Input file to perform the operation on.
|
840
|
+
# @param [Hash] opts the optional parameters
|
841
|
+
# @return [GetDocxMetadataPropertiesResponse]
|
842
|
+
def edit_document_docx_get_metadata_properties(input_file, opts = {})
|
843
|
+
data, _status_code, _headers = edit_document_docx_get_metadata_properties_with_http_info(input_file, opts)
|
844
|
+
data
|
845
|
+
end
|
846
|
+
|
847
|
+
# Get all metadata properties in Word DOCX document
|
848
|
+
# Returns all the metadata properties in an Office Word Document (docx)
|
849
|
+
# @param input_file Input file to perform the operation on.
|
850
|
+
# @param [Hash] opts the optional parameters
|
851
|
+
# @return [Array<(GetDocxMetadataPropertiesResponse, Fixnum, Hash)>] GetDocxMetadataPropertiesResponse data, response status code and response headers
|
852
|
+
def edit_document_docx_get_metadata_properties_with_http_info(input_file, opts = {})
|
853
|
+
if @api_client.config.debugging
|
854
|
+
@api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_get_metadata_properties ...'
|
855
|
+
end
|
856
|
+
# verify the required parameter 'input_file' is set
|
857
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
858
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_docx_get_metadata_properties"
|
859
|
+
end
|
860
|
+
# resource path
|
861
|
+
local_var_path = '/convert/edit/docx/get-metadata'
|
862
|
+
|
863
|
+
# query parameters
|
864
|
+
query_params = {}
|
865
|
+
|
866
|
+
# header parameters
|
867
|
+
header_params = {}
|
868
|
+
# HTTP header 'Accept' (if needed)
|
869
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
870
|
+
# HTTP header 'Content-Type'
|
871
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
872
|
+
|
873
|
+
# form parameters
|
874
|
+
form_params = {}
|
875
|
+
form_params['inputFile'] = input_file
|
876
|
+
|
877
|
+
# http body (model)
|
878
|
+
post_body = nil
|
879
|
+
auth_names = ['Apikey']
|
880
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
881
|
+
:header_params => header_params,
|
882
|
+
:query_params => query_params,
|
883
|
+
:form_params => form_params,
|
884
|
+
:body => post_body,
|
885
|
+
:auth_names => auth_names,
|
886
|
+
:return_type => 'GetDocxMetadataPropertiesResponse')
|
887
|
+
if @api_client.config.debugging
|
888
|
+
@api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_get_metadata_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
889
|
+
end
|
890
|
+
return data, status_code, headers
|
891
|
+
end
|
782
892
|
# Get sections from a Word DOCX document
|
783
893
|
# Returns the sections defined in the Word Document (DOCX) format file
|
784
894
|
# @param req_config Document input request
|
@@ -1698,6 +1808,60 @@ module CloudmersiveConvertApiClient
|
|
1698
1808
|
end
|
1699
1809
|
return data, status_code, headers
|
1700
1810
|
end
|
1811
|
+
# Set custom property metadata properties in Word DOCX document
|
1812
|
+
# Sets the custom property metadata for the metadata properties in an Office Word Document (docx)
|
1813
|
+
# @param input
|
1814
|
+
# @param [Hash] opts the optional parameters
|
1815
|
+
# @return [String]
|
1816
|
+
def edit_document_docx_set_custom_metadata_properties(input, opts = {})
|
1817
|
+
data, _status_code, _headers = edit_document_docx_set_custom_metadata_properties_with_http_info(input, opts)
|
1818
|
+
data
|
1819
|
+
end
|
1820
|
+
|
1821
|
+
# Set custom property metadata properties in Word DOCX document
|
1822
|
+
# Sets the custom property metadata for the metadata properties in an Office Word Document (docx)
|
1823
|
+
# @param input
|
1824
|
+
# @param [Hash] opts the optional parameters
|
1825
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
1826
|
+
def edit_document_docx_set_custom_metadata_properties_with_http_info(input, opts = {})
|
1827
|
+
if @api_client.config.debugging
|
1828
|
+
@api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_set_custom_metadata_properties ...'
|
1829
|
+
end
|
1830
|
+
# verify the required parameter 'input' is set
|
1831
|
+
if @api_client.config.client_side_validation && input.nil?
|
1832
|
+
fail ArgumentError, "Missing the required parameter 'input' when calling EditDocumentApi.edit_document_docx_set_custom_metadata_properties"
|
1833
|
+
end
|
1834
|
+
# resource path
|
1835
|
+
local_var_path = '/convert/edit/docx/set-metadata/custom-property'
|
1836
|
+
|
1837
|
+
# query parameters
|
1838
|
+
query_params = {}
|
1839
|
+
|
1840
|
+
# header parameters
|
1841
|
+
header_params = {}
|
1842
|
+
# HTTP header 'Accept' (if needed)
|
1843
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
1844
|
+
# HTTP header 'Content-Type'
|
1845
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
1846
|
+
|
1847
|
+
# form parameters
|
1848
|
+
form_params = {}
|
1849
|
+
|
1850
|
+
# http body (model)
|
1851
|
+
post_body = @api_client.object_to_http_body(input)
|
1852
|
+
auth_names = ['Apikey']
|
1853
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1854
|
+
:header_params => header_params,
|
1855
|
+
:query_params => query_params,
|
1856
|
+
:form_params => form_params,
|
1857
|
+
:body => post_body,
|
1858
|
+
:auth_names => auth_names,
|
1859
|
+
:return_type => 'String')
|
1860
|
+
if @api_client.config.debugging
|
1861
|
+
@api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_set_custom_metadata_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1862
|
+
end
|
1863
|
+
return data, status_code, headers
|
1864
|
+
end
|
1701
1865
|
# Set the footer in a Word DOCX document
|
1702
1866
|
# Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
|
1703
1867
|
# @param req_config Document input request
|
@@ -2076,6 +2240,61 @@ module CloudmersiveConvertApiClient
|
|
2076
2240
|
end
|
2077
2241
|
return data, status_code, headers
|
2078
2242
|
end
|
2243
|
+
# Get macro information from a PowerPoint PPTX/PPTM presentation document
|
2244
|
+
# Returns information about the Macros (e.g. VBA) defined in the PowerPoint Document
|
2245
|
+
# @param input_file Input file to perform the operation on.
|
2246
|
+
# @param [Hash] opts the optional parameters
|
2247
|
+
# @return [GetMacrosResponse]
|
2248
|
+
def edit_document_pptx_get_macro_information(input_file, opts = {})
|
2249
|
+
data, _status_code, _headers = edit_document_pptx_get_macro_information_with_http_info(input_file, opts)
|
2250
|
+
data
|
2251
|
+
end
|
2252
|
+
|
2253
|
+
# Get macro information from a PowerPoint PPTX/PPTM presentation document
|
2254
|
+
# Returns information about the Macros (e.g. VBA) defined in the PowerPoint Document
|
2255
|
+
# @param input_file Input file to perform the operation on.
|
2256
|
+
# @param [Hash] opts the optional parameters
|
2257
|
+
# @return [Array<(GetMacrosResponse, Fixnum, Hash)>] GetMacrosResponse data, response status code and response headers
|
2258
|
+
def edit_document_pptx_get_macro_information_with_http_info(input_file, opts = {})
|
2259
|
+
if @api_client.config.debugging
|
2260
|
+
@api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_pptx_get_macro_information ...'
|
2261
|
+
end
|
2262
|
+
# verify the required parameter 'input_file' is set
|
2263
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
2264
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_pptx_get_macro_information"
|
2265
|
+
end
|
2266
|
+
# resource path
|
2267
|
+
local_var_path = '/convert/edit/pptx/get-macros'
|
2268
|
+
|
2269
|
+
# query parameters
|
2270
|
+
query_params = {}
|
2271
|
+
|
2272
|
+
# header parameters
|
2273
|
+
header_params = {}
|
2274
|
+
# HTTP header 'Accept' (if needed)
|
2275
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
2276
|
+
# HTTP header 'Content-Type'
|
2277
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
2278
|
+
|
2279
|
+
# form parameters
|
2280
|
+
form_params = {}
|
2281
|
+
form_params['inputFile'] = input_file
|
2282
|
+
|
2283
|
+
# http body (model)
|
2284
|
+
post_body = nil
|
2285
|
+
auth_names = ['Apikey']
|
2286
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
2287
|
+
:header_params => header_params,
|
2288
|
+
:query_params => query_params,
|
2289
|
+
:form_params => form_params,
|
2290
|
+
:body => post_body,
|
2291
|
+
:auth_names => auth_names,
|
2292
|
+
:return_type => 'GetMacrosResponse')
|
2293
|
+
if @api_client.config.debugging
|
2294
|
+
@api_client.config.logger.debug "API called: EditDocumentApi#edit_document_pptx_get_macro_information\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2295
|
+
end
|
2296
|
+
return data, status_code, headers
|
2297
|
+
end
|
2079
2298
|
# Replace string in PowerPoint PPTX presentation
|
2080
2299
|
# Replace all instances of a string in an Office PowerPoint Document (pptx)
|
2081
2300
|
# @param req_config Replacement document configuration input
|
@@ -2778,6 +2997,61 @@ module CloudmersiveConvertApiClient
|
|
2778
2997
|
end
|
2779
2998
|
return data, status_code, headers
|
2780
2999
|
end
|
3000
|
+
# Get macro information from a Excel XLSX/XLSM spreadsheet, worksheet
|
3001
|
+
# Returns information about the Macros (e.g. VBA) defined in the Excel Spreadsheet
|
3002
|
+
# @param input_file Input file to perform the operation on.
|
3003
|
+
# @param [Hash] opts the optional parameters
|
3004
|
+
# @return [GetMacrosResponse]
|
3005
|
+
def edit_document_xlsx_get_macro_information(input_file, opts = {})
|
3006
|
+
data, _status_code, _headers = edit_document_xlsx_get_macro_information_with_http_info(input_file, opts)
|
3007
|
+
data
|
3008
|
+
end
|
3009
|
+
|
3010
|
+
# Get macro information from a Excel XLSX/XLSM spreadsheet, worksheet
|
3011
|
+
# Returns information about the Macros (e.g. VBA) defined in the Excel Spreadsheet
|
3012
|
+
# @param input_file Input file to perform the operation on.
|
3013
|
+
# @param [Hash] opts the optional parameters
|
3014
|
+
# @return [Array<(GetMacrosResponse, Fixnum, Hash)>] GetMacrosResponse data, response status code and response headers
|
3015
|
+
def edit_document_xlsx_get_macro_information_with_http_info(input_file, opts = {})
|
3016
|
+
if @api_client.config.debugging
|
3017
|
+
@api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_xlsx_get_macro_information ...'
|
3018
|
+
end
|
3019
|
+
# verify the required parameter 'input_file' is set
|
3020
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
3021
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_xlsx_get_macro_information"
|
3022
|
+
end
|
3023
|
+
# resource path
|
3024
|
+
local_var_path = '/convert/edit/xlsx/get-macros'
|
3025
|
+
|
3026
|
+
# query parameters
|
3027
|
+
query_params = {}
|
3028
|
+
|
3029
|
+
# header parameters
|
3030
|
+
header_params = {}
|
3031
|
+
# HTTP header 'Accept' (if needed)
|
3032
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
3033
|
+
# HTTP header 'Content-Type'
|
3034
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
3035
|
+
|
3036
|
+
# form parameters
|
3037
|
+
form_params = {}
|
3038
|
+
form_params['inputFile'] = input_file
|
3039
|
+
|
3040
|
+
# http body (model)
|
3041
|
+
post_body = nil
|
3042
|
+
auth_names = ['Apikey']
|
3043
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
3044
|
+
:header_params => header_params,
|
3045
|
+
:query_params => query_params,
|
3046
|
+
:form_params => form_params,
|
3047
|
+
:body => post_body,
|
3048
|
+
:auth_names => auth_names,
|
3049
|
+
:return_type => 'GetMacrosResponse')
|
3050
|
+
if @api_client.config.debugging
|
3051
|
+
@api_client.config.logger.debug "API called: EditDocumentApi#edit_document_xlsx_get_macro_information\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3052
|
+
end
|
3053
|
+
return data, status_code, headers
|
3054
|
+
end
|
2781
3055
|
# Get rows and cells from a Excel XLSX spreadsheet, worksheet
|
2782
3056
|
# Returns the rows and cells defined in the Excel Spreadsheet worksheet
|
2783
3057
|
# @param input Document input request
|
@@ -335,5 +335,60 @@ module CloudmersiveConvertApiClient
|
|
335
335
|
end
|
336
336
|
return data, status_code, headers
|
337
337
|
end
|
338
|
+
# Extract resolved link URLs from HTML File
|
339
|
+
# Extracts the resolved link URLs, fully-qualified if possible, from an input HTML file.
|
340
|
+
# @param [Hash] opts the optional parameters
|
341
|
+
# @option opts [File] :input_file Optional: Input file to perform the operation on.
|
342
|
+
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
343
|
+
# @option opts [String] :base_url Optional: Base URL of the page, such as https://mydomain.com
|
344
|
+
# @return [HtmlGetLinksResponse]
|
345
|
+
def edit_html_html_get_links(opts = {})
|
346
|
+
data, _status_code, _headers = edit_html_html_get_links_with_http_info(opts)
|
347
|
+
data
|
348
|
+
end
|
349
|
+
|
350
|
+
# Extract resolved link URLs from HTML File
|
351
|
+
# Extracts the resolved link URLs, fully-qualified if possible, from an input HTML file.
|
352
|
+
# @param [Hash] opts the optional parameters
|
353
|
+
# @option opts [File] :input_file Optional: Input file to perform the operation on.
|
354
|
+
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
355
|
+
# @option opts [String] :base_url Optional: Base URL of the page, such as https://mydomain.com
|
356
|
+
# @return [Array<(HtmlGetLinksResponse, Fixnum, Hash)>] HtmlGetLinksResponse data, response status code and response headers
|
357
|
+
def edit_html_html_get_links_with_http_info(opts = {})
|
358
|
+
if @api_client.config.debugging
|
359
|
+
@api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_get_links ...'
|
360
|
+
end
|
361
|
+
# resource path
|
362
|
+
local_var_path = '/convert/edit/html/extract/links'
|
363
|
+
|
364
|
+
# query parameters
|
365
|
+
query_params = {}
|
366
|
+
|
367
|
+
# header parameters
|
368
|
+
header_params = {}
|
369
|
+
# HTTP header 'Accept' (if needed)
|
370
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
371
|
+
header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?
|
372
|
+
header_params[:'baseUrl'] = opts[:'base_url'] if !opts[:'base_url'].nil?
|
373
|
+
|
374
|
+
# form parameters
|
375
|
+
form_params = {}
|
376
|
+
form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?
|
377
|
+
|
378
|
+
# http body (model)
|
379
|
+
post_body = nil
|
380
|
+
auth_names = ['Apikey']
|
381
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
382
|
+
:header_params => header_params,
|
383
|
+
:query_params => query_params,
|
384
|
+
:form_params => form_params,
|
385
|
+
:body => post_body,
|
386
|
+
:auth_names => auth_names,
|
387
|
+
:return_type => 'HtmlGetLinksResponse')
|
388
|
+
if @api_client.config.debugging
|
389
|
+
@api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_get_links\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
390
|
+
end
|
391
|
+
return data, status_code, headers
|
392
|
+
end
|
338
393
|
end
|
339
394
|
end
|
@@ -167,6 +167,154 @@ module CloudmersiveConvertApiClient
|
|
167
167
|
end
|
168
168
|
return data, status_code, headers
|
169
169
|
end
|
170
|
+
# Merge Two HTML (HTM) Files Together
|
171
|
+
# 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.
|
172
|
+
# @param input_file1 First input file to perform the operation on.
|
173
|
+
# @param input_file2 Second input file to perform the operation on (more than 2 can be supplied).
|
174
|
+
# @param [Hash] opts the optional parameters
|
175
|
+
# @return [Object]
|
176
|
+
def merge_document_html(input_file1, input_file2, opts = {})
|
177
|
+
data, _status_code, _headers = merge_document_html_with_http_info(input_file1, input_file2, opts)
|
178
|
+
data
|
179
|
+
end
|
180
|
+
|
181
|
+
# Merge Two HTML (HTM) Files Together
|
182
|
+
# 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.
|
183
|
+
# @param input_file1 First input file to perform the operation on.
|
184
|
+
# @param input_file2 Second input file to perform the operation on (more than 2 can be supplied).
|
185
|
+
# @param [Hash] opts the optional parameters
|
186
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
187
|
+
def merge_document_html_with_http_info(input_file1, input_file2, opts = {})
|
188
|
+
if @api_client.config.debugging
|
189
|
+
@api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_html ...'
|
190
|
+
end
|
191
|
+
# verify the required parameter 'input_file1' is set
|
192
|
+
if @api_client.config.client_side_validation && input_file1.nil?
|
193
|
+
fail ArgumentError, "Missing the required parameter 'input_file1' when calling MergeDocumentApi.merge_document_html"
|
194
|
+
end
|
195
|
+
# verify the required parameter 'input_file2' is set
|
196
|
+
if @api_client.config.client_side_validation && input_file2.nil?
|
197
|
+
fail ArgumentError, "Missing the required parameter 'input_file2' when calling MergeDocumentApi.merge_document_html"
|
198
|
+
end
|
199
|
+
# resource path
|
200
|
+
local_var_path = '/convert/merge/html'
|
201
|
+
|
202
|
+
# query parameters
|
203
|
+
query_params = {}
|
204
|
+
|
205
|
+
# header parameters
|
206
|
+
header_params = {}
|
207
|
+
# HTTP header 'Accept' (if needed)
|
208
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
|
209
|
+
# HTTP header 'Content-Type'
|
210
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
211
|
+
|
212
|
+
# form parameters
|
213
|
+
form_params = {}
|
214
|
+
form_params['inputFile1'] = input_file1
|
215
|
+
form_params['inputFile2'] = input_file2
|
216
|
+
|
217
|
+
# http body (model)
|
218
|
+
post_body = nil
|
219
|
+
auth_names = ['Apikey']
|
220
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
221
|
+
:header_params => header_params,
|
222
|
+
:query_params => query_params,
|
223
|
+
:form_params => form_params,
|
224
|
+
:body => post_body,
|
225
|
+
:auth_names => auth_names,
|
226
|
+
:return_type => 'Object')
|
227
|
+
if @api_client.config.debugging
|
228
|
+
@api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_html\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
229
|
+
end
|
230
|
+
return data, status_code, headers
|
231
|
+
end
|
232
|
+
# Merge Multple HTML (HTM) Files Together
|
233
|
+
# 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.
|
234
|
+
# @param input_file1 First input file to perform the operation on.
|
235
|
+
# @param input_file2 Second input file to perform the operation on.
|
236
|
+
# @param [Hash] opts the optional parameters
|
237
|
+
# @option opts [File] :input_file3 Third input file to perform the operation on.
|
238
|
+
# @option opts [File] :input_file4 Fourth input file to perform the operation on.
|
239
|
+
# @option opts [File] :input_file5 Fifth input file to perform the operation on.
|
240
|
+
# @option opts [File] :input_file6 Sixth input file to perform the operation on.
|
241
|
+
# @option opts [File] :input_file7 Seventh input file to perform the operation on.
|
242
|
+
# @option opts [File] :input_file8 Eighth input file to perform the operation on.
|
243
|
+
# @option opts [File] :input_file9 Ninth input file to perform the operation on.
|
244
|
+
# @option opts [File] :input_file10 Tenth input file to perform the operation on.
|
245
|
+
# @return [String]
|
246
|
+
def merge_document_html_multi(input_file1, input_file2, opts = {})
|
247
|
+
data, _status_code, _headers = merge_document_html_multi_with_http_info(input_file1, input_file2, opts)
|
248
|
+
data
|
249
|
+
end
|
250
|
+
|
251
|
+
# Merge Multple HTML (HTM) Files Together
|
252
|
+
# 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.
|
253
|
+
# @param input_file1 First input file to perform the operation on.
|
254
|
+
# @param input_file2 Second input file to perform the operation on.
|
255
|
+
# @param [Hash] opts the optional parameters
|
256
|
+
# @option opts [File] :input_file3 Third input file to perform the operation on.
|
257
|
+
# @option opts [File] :input_file4 Fourth input file to perform the operation on.
|
258
|
+
# @option opts [File] :input_file5 Fifth input file to perform the operation on.
|
259
|
+
# @option opts [File] :input_file6 Sixth input file to perform the operation on.
|
260
|
+
# @option opts [File] :input_file7 Seventh input file to perform the operation on.
|
261
|
+
# @option opts [File] :input_file8 Eighth input file to perform the operation on.
|
262
|
+
# @option opts [File] :input_file9 Ninth input file to perform the operation on.
|
263
|
+
# @option opts [File] :input_file10 Tenth input file to perform the operation on.
|
264
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
265
|
+
def merge_document_html_multi_with_http_info(input_file1, input_file2, opts = {})
|
266
|
+
if @api_client.config.debugging
|
267
|
+
@api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_html_multi ...'
|
268
|
+
end
|
269
|
+
# verify the required parameter 'input_file1' is set
|
270
|
+
if @api_client.config.client_side_validation && input_file1.nil?
|
271
|
+
fail ArgumentError, "Missing the required parameter 'input_file1' when calling MergeDocumentApi.merge_document_html_multi"
|
272
|
+
end
|
273
|
+
# verify the required parameter 'input_file2' is set
|
274
|
+
if @api_client.config.client_side_validation && input_file2.nil?
|
275
|
+
fail ArgumentError, "Missing the required parameter 'input_file2' when calling MergeDocumentApi.merge_document_html_multi"
|
276
|
+
end
|
277
|
+
# resource path
|
278
|
+
local_var_path = '/convert/merge/html/multi'
|
279
|
+
|
280
|
+
# query parameters
|
281
|
+
query_params = {}
|
282
|
+
|
283
|
+
# header parameters
|
284
|
+
header_params = {}
|
285
|
+
# HTTP header 'Accept' (if needed)
|
286
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
|
287
|
+
# HTTP header 'Content-Type'
|
288
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
289
|
+
|
290
|
+
# form parameters
|
291
|
+
form_params = {}
|
292
|
+
form_params['inputFile1'] = input_file1
|
293
|
+
form_params['inputFile2'] = input_file2
|
294
|
+
form_params['inputFile3'] = opts[:'input_file3'] if !opts[:'input_file3'].nil?
|
295
|
+
form_params['inputFile4'] = opts[:'input_file4'] if !opts[:'input_file4'].nil?
|
296
|
+
form_params['inputFile5'] = opts[:'input_file5'] if !opts[:'input_file5'].nil?
|
297
|
+
form_params['inputFile6'] = opts[:'input_file6'] if !opts[:'input_file6'].nil?
|
298
|
+
form_params['inputFile7'] = opts[:'input_file7'] if !opts[:'input_file7'].nil?
|
299
|
+
form_params['inputFile8'] = opts[:'input_file8'] if !opts[:'input_file8'].nil?
|
300
|
+
form_params['inputFile9'] = opts[:'input_file9'] if !opts[:'input_file9'].nil?
|
301
|
+
form_params['inputFile10'] = opts[:'input_file10'] if !opts[:'input_file10'].nil?
|
302
|
+
|
303
|
+
# http body (model)
|
304
|
+
post_body = nil
|
305
|
+
auth_names = ['Apikey']
|
306
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
307
|
+
:header_params => header_params,
|
308
|
+
:query_params => query_params,
|
309
|
+
:form_params => form_params,
|
310
|
+
:body => post_body,
|
311
|
+
:auth_names => auth_names,
|
312
|
+
:return_type => 'String')
|
313
|
+
if @api_client.config.debugging
|
314
|
+
@api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_html_multi\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
315
|
+
end
|
316
|
+
return data, status_code, headers
|
317
|
+
end
|
170
318
|
# Merge Two PDF Files Together
|
171
319
|
# Combine two PDF files (pdf) into a single PDF document, preserving the order of the input documents in the combined document
|
172
320
|
# @param input_file1 First input file to perform the operation on.
|