cloudmersive-convert-api-client 2.0.7 → 2.1.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +27 -4
- data/docs/ConvertDataApi.md +117 -3
- data/docs/ConvertDocumentApi.md +159 -0
- data/docs/DocxMetadataCustomProperty.md +13 -0
- data/docs/DocxSetCustomMetadataPropertiesRequest.md +10 -0
- data/docs/EditDocumentApi.md +330 -0
- data/docs/EditHtmlApi.md +81 -13
- data/docs/EditPdfApi.md +227 -0
- data/docs/GetDocxMetadataPropertiesResponse.md +16 -0
- data/docs/ValidateDocumentApi.md +165 -0
- data/docs/ViewerToolsApi.md +8 -2
- data/docs/ZipArchiveApi.md +80 -0
- data/lib/cloudmersive-convert-api-client.rb +3 -0
- data/lib/cloudmersive-convert-api-client/api/convert_data_api.rb +117 -4
- data/lib/cloudmersive-convert-api-client/api/convert_document_api.rb +156 -0
- data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +329 -0
- data/lib/cloudmersive-convert-api-client/api/edit_html_api.rb +81 -12
- data/lib/cloudmersive-convert-api-client/api/edit_pdf_api.rb +230 -0
- data/lib/cloudmersive-convert-api-client/api/validate_document_api.rb +165 -0
- data/lib/cloudmersive-convert-api-client/api/viewer_tools_api.rb +6 -0
- data/lib/cloudmersive-convert-api-client/api/zip_archive_api.rb +92 -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/version.rb +1 -1
- data/spec/api/convert_data_api_spec.rb +26 -1
- data/spec/api/convert_document_api_spec.rb +35 -0
- data/spec/api/edit_document_api_spec.rb +72 -0
- data/spec/api/edit_html_api_spec.rb +24 -6
- data/spec/api/edit_pdf_api_spec.rb +50 -0
- data/spec/api/validate_document_api_spec.rb +36 -0
- data/spec/api/viewer_tools_api_spec.rb +2 -0
- data/spec/api/zip_archive_api_spec.rb +23 -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
- metadata +11 -2
@@ -74,6 +74,61 @@ module CloudmersiveConvertApiClient
|
|
74
74
|
end
|
75
75
|
return data, status_code, headers
|
76
76
|
end
|
77
|
+
# Accept all tracked changes, revisions in a Word DOCX document
|
78
|
+
# Accepts all tracked changes and revisions in a Word DOCX document. This will accept all pending changes in the document when tracked changes is turned on. Track changes will remain on (if it is on) after this oepration is completed.
|
79
|
+
# @param input_file Input file to perform the operation on.
|
80
|
+
# @param [Hash] opts the optional parameters
|
81
|
+
# @return [String]
|
82
|
+
def edit_document_docx_accept_all_track_changes(input_file, opts = {})
|
83
|
+
data, _status_code, _headers = edit_document_docx_accept_all_track_changes_with_http_info(input_file, opts)
|
84
|
+
data
|
85
|
+
end
|
86
|
+
|
87
|
+
# Accept all tracked changes, revisions in a Word DOCX document
|
88
|
+
# Accepts all tracked changes and revisions in a Word DOCX document. This will accept all pending changes in the document when tracked changes is turned on. Track changes will remain on (if it is on) after this oepration is completed.
|
89
|
+
# @param input_file Input file to perform the operation on.
|
90
|
+
# @param [Hash] opts the optional parameters
|
91
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
92
|
+
def edit_document_docx_accept_all_track_changes_with_http_info(input_file, opts = {})
|
93
|
+
if @api_client.config.debugging
|
94
|
+
@api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_accept_all_track_changes ...'
|
95
|
+
end
|
96
|
+
# verify the required parameter 'input_file' is set
|
97
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
98
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_docx_accept_all_track_changes"
|
99
|
+
end
|
100
|
+
# resource path
|
101
|
+
local_var_path = '/convert/edit/docx/track-changes/accept-all'
|
102
|
+
|
103
|
+
# query parameters
|
104
|
+
query_params = {}
|
105
|
+
|
106
|
+
# header parameters
|
107
|
+
header_params = {}
|
108
|
+
# HTTP header 'Accept' (if needed)
|
109
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
110
|
+
# HTTP header 'Content-Type'
|
111
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
112
|
+
|
113
|
+
# form parameters
|
114
|
+
form_params = {}
|
115
|
+
form_params['inputFile'] = input_file
|
116
|
+
|
117
|
+
# http body (model)
|
118
|
+
post_body = nil
|
119
|
+
auth_names = ['Apikey']
|
120
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
121
|
+
:header_params => header_params,
|
122
|
+
:query_params => query_params,
|
123
|
+
:form_params => form_params,
|
124
|
+
:body => post_body,
|
125
|
+
:auth_names => auth_names,
|
126
|
+
:return_type => 'String')
|
127
|
+
if @api_client.config.debugging
|
128
|
+
@api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_accept_all_track_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
129
|
+
end
|
130
|
+
return data, status_code, headers
|
131
|
+
end
|
77
132
|
# Get body from a Word DOCX document
|
78
133
|
# Returns the body defined in the Word Document (DOCX) format file; this is the main content part of a DOCX document
|
79
134
|
# @param req_config Document input request
|
@@ -344,6 +399,116 @@ module CloudmersiveConvertApiClient
|
|
344
399
|
end
|
345
400
|
return data, status_code, headers
|
346
401
|
end
|
402
|
+
# Disable track changes, revisions in a Word DOCX document
|
403
|
+
# Diables tracking of changes and revisions in a Word DOCX document, and accepts any pending changes. Users editing the document will no longer see changes tracked automatically.
|
404
|
+
# @param input_file Input file to perform the operation on.
|
405
|
+
# @param [Hash] opts the optional parameters
|
406
|
+
# @return [String]
|
407
|
+
def edit_document_docx_disable_track_changes(input_file, opts = {})
|
408
|
+
data, _status_code, _headers = edit_document_docx_disable_track_changes_with_http_info(input_file, opts)
|
409
|
+
data
|
410
|
+
end
|
411
|
+
|
412
|
+
# Disable track changes, revisions in a Word DOCX document
|
413
|
+
# Diables tracking of changes and revisions in a Word DOCX document, and accepts any pending changes. Users editing the document will no longer see changes tracked automatically.
|
414
|
+
# @param input_file Input file to perform the operation on.
|
415
|
+
# @param [Hash] opts the optional parameters
|
416
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
417
|
+
def edit_document_docx_disable_track_changes_with_http_info(input_file, opts = {})
|
418
|
+
if @api_client.config.debugging
|
419
|
+
@api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_disable_track_changes ...'
|
420
|
+
end
|
421
|
+
# verify the required parameter 'input_file' is set
|
422
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
423
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_docx_disable_track_changes"
|
424
|
+
end
|
425
|
+
# resource path
|
426
|
+
local_var_path = '/convert/edit/docx/track-changes/disable'
|
427
|
+
|
428
|
+
# query parameters
|
429
|
+
query_params = {}
|
430
|
+
|
431
|
+
# header parameters
|
432
|
+
header_params = {}
|
433
|
+
# HTTP header 'Accept' (if needed)
|
434
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
435
|
+
# HTTP header 'Content-Type'
|
436
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
437
|
+
|
438
|
+
# form parameters
|
439
|
+
form_params = {}
|
440
|
+
form_params['inputFile'] = input_file
|
441
|
+
|
442
|
+
# http body (model)
|
443
|
+
post_body = nil
|
444
|
+
auth_names = ['Apikey']
|
445
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
446
|
+
:header_params => header_params,
|
447
|
+
:query_params => query_params,
|
448
|
+
:form_params => form_params,
|
449
|
+
:body => post_body,
|
450
|
+
:auth_names => auth_names,
|
451
|
+
:return_type => 'String')
|
452
|
+
if @api_client.config.debugging
|
453
|
+
@api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_disable_track_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
454
|
+
end
|
455
|
+
return data, status_code, headers
|
456
|
+
end
|
457
|
+
# Enable track changes, revisions in a Word DOCX document
|
458
|
+
# Enables tracking of changes and revisions in a Word DOCX document. Users editing the document will see changes tracked automatically, with edits highlighted, and the ability to accept or reject changes made to the document.
|
459
|
+
# @param input_file Input file to perform the operation on.
|
460
|
+
# @param [Hash] opts the optional parameters
|
461
|
+
# @return [String]
|
462
|
+
def edit_document_docx_enable_track_changes(input_file, opts = {})
|
463
|
+
data, _status_code, _headers = edit_document_docx_enable_track_changes_with_http_info(input_file, opts)
|
464
|
+
data
|
465
|
+
end
|
466
|
+
|
467
|
+
# Enable track changes, revisions in a Word DOCX document
|
468
|
+
# Enables tracking of changes and revisions in a Word DOCX document. Users editing the document will see changes tracked automatically, with edits highlighted, and the ability to accept or reject changes made to the document.
|
469
|
+
# @param input_file Input file to perform the operation on.
|
470
|
+
# @param [Hash] opts the optional parameters
|
471
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
472
|
+
def edit_document_docx_enable_track_changes_with_http_info(input_file, opts = {})
|
473
|
+
if @api_client.config.debugging
|
474
|
+
@api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_enable_track_changes ...'
|
475
|
+
end
|
476
|
+
# verify the required parameter 'input_file' is set
|
477
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
478
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_docx_enable_track_changes"
|
479
|
+
end
|
480
|
+
# resource path
|
481
|
+
local_var_path = '/convert/edit/docx/track-changes/enable'
|
482
|
+
|
483
|
+
# query parameters
|
484
|
+
query_params = {}
|
485
|
+
|
486
|
+
# header parameters
|
487
|
+
header_params = {}
|
488
|
+
# HTTP header 'Accept' (if needed)
|
489
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
490
|
+
# HTTP header 'Content-Type'
|
491
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
492
|
+
|
493
|
+
# form parameters
|
494
|
+
form_params = {}
|
495
|
+
form_params['inputFile'] = input_file
|
496
|
+
|
497
|
+
# http body (model)
|
498
|
+
post_body = nil
|
499
|
+
auth_names = ['Apikey']
|
500
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
501
|
+
:header_params => header_params,
|
502
|
+
:query_params => query_params,
|
503
|
+
:form_params => form_params,
|
504
|
+
:body => post_body,
|
505
|
+
:auth_names => auth_names,
|
506
|
+
:return_type => 'String')
|
507
|
+
if @api_client.config.debugging
|
508
|
+
@api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_enable_track_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
509
|
+
end
|
510
|
+
return data, status_code, headers
|
511
|
+
end
|
347
512
|
# Find matching paragraphs in a Word DOCX document
|
348
513
|
# Returns the paragraphs defined in the Word Document (DOCX) format file that match the input criteria
|
349
514
|
# @param req_config Document input request
|
@@ -614,6 +779,61 @@ module CloudmersiveConvertApiClient
|
|
614
779
|
end
|
615
780
|
return data, status_code, headers
|
616
781
|
end
|
782
|
+
# Get all metadata properties in Word DOCX document
|
783
|
+
# Returns all the metadata properties in an Office Word Document (docx)
|
784
|
+
# @param input_file Input file to perform the operation on.
|
785
|
+
# @param [Hash] opts the optional parameters
|
786
|
+
# @return [GetDocxMetadataPropertiesResponse]
|
787
|
+
def edit_document_docx_get_metadata_properties(input_file, opts = {})
|
788
|
+
data, _status_code, _headers = edit_document_docx_get_metadata_properties_with_http_info(input_file, opts)
|
789
|
+
data
|
790
|
+
end
|
791
|
+
|
792
|
+
# Get all metadata properties in Word DOCX document
|
793
|
+
# Returns all the metadata properties in an Office Word Document (docx)
|
794
|
+
# @param input_file Input file to perform the operation on.
|
795
|
+
# @param [Hash] opts the optional parameters
|
796
|
+
# @return [Array<(GetDocxMetadataPropertiesResponse, Fixnum, Hash)>] GetDocxMetadataPropertiesResponse data, response status code and response headers
|
797
|
+
def edit_document_docx_get_metadata_properties_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_metadata_properties ...'
|
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_metadata_properties"
|
804
|
+
end
|
805
|
+
# resource path
|
806
|
+
local_var_path = '/convert/edit/docx/get-metadata'
|
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 => 'GetDocxMetadataPropertiesResponse')
|
832
|
+
if @api_client.config.debugging
|
833
|
+
@api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_get_metadata_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
834
|
+
end
|
835
|
+
return data, status_code, headers
|
836
|
+
end
|
617
837
|
# Get sections from a Word DOCX document
|
618
838
|
# Returns the sections defined in the Word Document (DOCX) format file
|
619
839
|
# @param req_config Document input request
|
@@ -1208,6 +1428,61 @@ module CloudmersiveConvertApiClient
|
|
1208
1428
|
end
|
1209
1429
|
return data, status_code, headers
|
1210
1430
|
end
|
1431
|
+
# Remove all comments from a Word DOCX document
|
1432
|
+
# Removes all of the comments from a Word Document.
|
1433
|
+
# @param input_file Input file to perform the operation on.
|
1434
|
+
# @param [Hash] opts the optional parameters
|
1435
|
+
# @return [String]
|
1436
|
+
def edit_document_docx_remove_all_comments(input_file, opts = {})
|
1437
|
+
data, _status_code, _headers = edit_document_docx_remove_all_comments_with_http_info(input_file, opts)
|
1438
|
+
data
|
1439
|
+
end
|
1440
|
+
|
1441
|
+
# Remove all comments from a Word DOCX document
|
1442
|
+
# Removes all of the comments from a Word Document.
|
1443
|
+
# @param input_file Input file to perform the operation on.
|
1444
|
+
# @param [Hash] opts the optional parameters
|
1445
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
1446
|
+
def edit_document_docx_remove_all_comments_with_http_info(input_file, opts = {})
|
1447
|
+
if @api_client.config.debugging
|
1448
|
+
@api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_remove_all_comments ...'
|
1449
|
+
end
|
1450
|
+
# verify the required parameter 'input_file' is set
|
1451
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
1452
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_docx_remove_all_comments"
|
1453
|
+
end
|
1454
|
+
# resource path
|
1455
|
+
local_var_path = '/convert/edit/docx/comments/remove-all'
|
1456
|
+
|
1457
|
+
# query parameters
|
1458
|
+
query_params = {}
|
1459
|
+
|
1460
|
+
# header parameters
|
1461
|
+
header_params = {}
|
1462
|
+
# HTTP header 'Accept' (if needed)
|
1463
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
1464
|
+
# HTTP header 'Content-Type'
|
1465
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
1466
|
+
|
1467
|
+
# form parameters
|
1468
|
+
form_params = {}
|
1469
|
+
form_params['inputFile'] = input_file
|
1470
|
+
|
1471
|
+
# http body (model)
|
1472
|
+
post_body = nil
|
1473
|
+
auth_names = ['Apikey']
|
1474
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1475
|
+
:header_params => header_params,
|
1476
|
+
:query_params => query_params,
|
1477
|
+
:form_params => form_params,
|
1478
|
+
:body => post_body,
|
1479
|
+
:auth_names => auth_names,
|
1480
|
+
:return_type => 'String')
|
1481
|
+
if @api_client.config.debugging
|
1482
|
+
@api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_remove_all_comments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1483
|
+
end
|
1484
|
+
return data, status_code, headers
|
1485
|
+
end
|
1211
1486
|
# Remove headers and footers from Word DOCX document
|
1212
1487
|
# Remove all headers, or footers, or both from a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
|
1213
1488
|
# @param req_config Document input request
|
@@ -1478,6 +1753,60 @@ module CloudmersiveConvertApiClient
|
|
1478
1753
|
end
|
1479
1754
|
return data, status_code, headers
|
1480
1755
|
end
|
1756
|
+
# Set custom property metadata properties in Word DOCX document
|
1757
|
+
# Sets the custom property metadata for the metadata properties in an Office Word Document (docx)
|
1758
|
+
# @param input
|
1759
|
+
# @param [Hash] opts the optional parameters
|
1760
|
+
# @return [String]
|
1761
|
+
def edit_document_docx_set_custom_metadata_properties(input, opts = {})
|
1762
|
+
data, _status_code, _headers = edit_document_docx_set_custom_metadata_properties_with_http_info(input, opts)
|
1763
|
+
data
|
1764
|
+
end
|
1765
|
+
|
1766
|
+
# Set custom property metadata properties in Word DOCX document
|
1767
|
+
# Sets the custom property metadata for the metadata properties in an Office Word Document (docx)
|
1768
|
+
# @param input
|
1769
|
+
# @param [Hash] opts the optional parameters
|
1770
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
1771
|
+
def edit_document_docx_set_custom_metadata_properties_with_http_info(input, opts = {})
|
1772
|
+
if @api_client.config.debugging
|
1773
|
+
@api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_set_custom_metadata_properties ...'
|
1774
|
+
end
|
1775
|
+
# verify the required parameter 'input' is set
|
1776
|
+
if @api_client.config.client_side_validation && input.nil?
|
1777
|
+
fail ArgumentError, "Missing the required parameter 'input' when calling EditDocumentApi.edit_document_docx_set_custom_metadata_properties"
|
1778
|
+
end
|
1779
|
+
# resource path
|
1780
|
+
local_var_path = '/convert/edit/docx/set-metadata/custom-property'
|
1781
|
+
|
1782
|
+
# query parameters
|
1783
|
+
query_params = {}
|
1784
|
+
|
1785
|
+
# header parameters
|
1786
|
+
header_params = {}
|
1787
|
+
# HTTP header 'Accept' (if needed)
|
1788
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
1789
|
+
# HTTP header 'Content-Type'
|
1790
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
1791
|
+
|
1792
|
+
# form parameters
|
1793
|
+
form_params = {}
|
1794
|
+
|
1795
|
+
# http body (model)
|
1796
|
+
post_body = @api_client.object_to_http_body(input)
|
1797
|
+
auth_names = ['Apikey']
|
1798
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1799
|
+
:header_params => header_params,
|
1800
|
+
:query_params => query_params,
|
1801
|
+
:form_params => form_params,
|
1802
|
+
:body => post_body,
|
1803
|
+
:auth_names => auth_names,
|
1804
|
+
:return_type => 'String')
|
1805
|
+
if @api_client.config.debugging
|
1806
|
+
@api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_set_custom_metadata_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1807
|
+
end
|
1808
|
+
return data, status_code, headers
|
1809
|
+
end
|
1481
1810
|
# Set the footer in a Word DOCX document
|
1482
1811
|
# Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
|
1483
1812
|
# @param req_config Document input request
|
@@ -24,8 +24,9 @@ module CloudmersiveConvertApiClient
|
|
24
24
|
# @param heading_text The text content to be used in the header.
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @option opts [File] :input_file Optional: Input file to perform the operation on.
|
27
|
-
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
28
|
-
# @option opts [Integer] :heading_size Optional: The heading size number. Default is 1.
|
27
|
+
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
28
|
+
# @option opts [Integer] :heading_size Optional: The heading size number. Default is 1. Accepts values between 1 and 6.
|
29
|
+
# @option opts [String] :css_style Optional: The CSS style for the heading.
|
29
30
|
# @return [String]
|
30
31
|
def edit_html_html_append_heading(heading_text, opts = {})
|
31
32
|
data, _status_code, _headers = edit_html_html_append_heading_with_http_info(heading_text, opts)
|
@@ -37,8 +38,9 @@ module CloudmersiveConvertApiClient
|
|
37
38
|
# @param heading_text The text content to be used in the header.
|
38
39
|
# @param [Hash] opts the optional parameters
|
39
40
|
# @option opts [File] :input_file Optional: Input file to perform the operation on.
|
40
|
-
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
41
|
-
# @option opts [Integer] :heading_size Optional: The heading size number. Default is 1.
|
41
|
+
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
42
|
+
# @option opts [Integer] :heading_size Optional: The heading size number. Default is 1. Accepts values between 1 and 6.
|
43
|
+
# @option opts [String] :css_style Optional: The CSS style for the heading.
|
42
44
|
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
43
45
|
def edit_html_html_append_heading_with_http_info(heading_text, opts = {})
|
44
46
|
if @api_client.config.debugging
|
@@ -61,6 +63,7 @@ module CloudmersiveConvertApiClient
|
|
61
63
|
header_params[:'headingText'] = heading_text
|
62
64
|
header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?
|
63
65
|
header_params[:'headingSize'] = opts[:'heading_size'] if !opts[:'heading_size'].nil?
|
66
|
+
header_params[:'cssStyle'] = opts[:'css_style'] if !opts[:'css_style'].nil?
|
64
67
|
|
65
68
|
# form parameters
|
66
69
|
form_params = {}
|
@@ -86,7 +89,7 @@ module CloudmersiveConvertApiClient
|
|
86
89
|
# @param image_url The URL for the image.
|
87
90
|
# @param [Hash] opts the optional parameters
|
88
91
|
# @option opts [File] :input_file Optional: Input file to perform the operation on.
|
89
|
-
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
92
|
+
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
90
93
|
# @option opts [String] :css_style Optional: CSS style for the image.
|
91
94
|
# @return [String]
|
92
95
|
def edit_html_html_append_image_from_url(image_url, opts = {})
|
@@ -99,7 +102,7 @@ module CloudmersiveConvertApiClient
|
|
99
102
|
# @param image_url The URL for the image.
|
100
103
|
# @param [Hash] opts the optional parameters
|
101
104
|
# @option opts [File] :input_file Optional: Input file to perform the operation on.
|
102
|
-
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
105
|
+
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
103
106
|
# @option opts [String] :css_style Optional: CSS style for the image.
|
104
107
|
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
105
108
|
def edit_html_html_append_image_from_url_with_http_info(image_url, opts = {})
|
@@ -147,11 +150,11 @@ module CloudmersiveConvertApiClient
|
|
147
150
|
# Appends a base64 inline image to the end of an HTML document from an input file or URL.
|
148
151
|
# @param [Hash] opts the optional parameters
|
149
152
|
# @option opts [File] :input_file Optional: Input file to perform the operation on.
|
150
|
-
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
153
|
+
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
151
154
|
# @option opts [File] :image_file Optional: Image file to be appended as base64 inline image.
|
152
155
|
# @option opts [String] :image_url Optional: Image URL to be appended as base64 inline image.
|
153
156
|
# @option opts [String] :css_style Optional: CSS style for the image.
|
154
|
-
# @option opts [String] :image_extension Optional: The extension (JPG, PNG, GIF, etc.) of the image file. Recommended if uploading
|
157
|
+
# @option opts [String] :image_extension Optional: The extension (JPG, PNG, GIF, etc.) of the image file. Recommended if uploading an imageFile directly, instead of using imageUrl. If no extension can be determined, will default to JPG.
|
155
158
|
# @return [String]
|
156
159
|
def edit_html_html_append_image_inline(opts = {})
|
157
160
|
data, _status_code, _headers = edit_html_html_append_image_inline_with_http_info(opts)
|
@@ -162,11 +165,11 @@ module CloudmersiveConvertApiClient
|
|
162
165
|
# Appends a base64 inline image to the end of an HTML document from an input file or URL.
|
163
166
|
# @param [Hash] opts the optional parameters
|
164
167
|
# @option opts [File] :input_file Optional: Input file to perform the operation on.
|
165
|
-
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
168
|
+
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
166
169
|
# @option opts [File] :image_file Optional: Image file to be appended as base64 inline image.
|
167
170
|
# @option opts [String] :image_url Optional: Image URL to be appended as base64 inline image.
|
168
171
|
# @option opts [String] :css_style Optional: CSS style for the image.
|
169
|
-
# @option opts [String] :image_extension Optional: The extension (JPG, PNG, GIF, etc.) of the image file. Recommended if uploading
|
172
|
+
# @option opts [String] :image_extension Optional: The extension (JPG, PNG, GIF, etc.) of the image file. Recommended if uploading an imageFile directly, instead of using imageUrl. If no extension can be determined, will default to JPG.
|
170
173
|
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
171
174
|
def edit_html_html_append_image_inline_with_http_info(opts = {})
|
172
175
|
if @api_client.config.debugging
|
@@ -182,6 +185,8 @@ module CloudmersiveConvertApiClient
|
|
182
185
|
header_params = {}
|
183
186
|
# HTTP header 'Accept' (if needed)
|
184
187
|
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
188
|
+
# HTTP header 'Content-Type'
|
189
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
185
190
|
header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?
|
186
191
|
header_params[:'imageUrl'] = opts[:'image_url'] if !opts[:'image_url'].nil?
|
187
192
|
header_params[:'cssStyle'] = opts[:'css_style'] if !opts[:'css_style'].nil?
|
@@ -212,7 +217,8 @@ module CloudmersiveConvertApiClient
|
|
212
217
|
# @param paragraph_text The text content to be used in the paragraph.
|
213
218
|
# @param [Hash] opts the optional parameters
|
214
219
|
# @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.
|
220
|
+
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
221
|
+
# @option opts [String] :css_style Optional: The CSS style for the paragraph.
|
216
222
|
# @return [String]
|
217
223
|
def edit_html_html_append_paragraph(paragraph_text, opts = {})
|
218
224
|
data, _status_code, _headers = edit_html_html_append_paragraph_with_http_info(paragraph_text, opts)
|
@@ -224,7 +230,8 @@ module CloudmersiveConvertApiClient
|
|
224
230
|
# @param paragraph_text The text content to be used in the paragraph.
|
225
231
|
# @param [Hash] opts the optional parameters
|
226
232
|
# @option opts [File] :input_file Optional: Input file to perform the operation on.
|
227
|
-
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
233
|
+
# @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
|
234
|
+
# @option opts [String] :css_style Optional: The CSS style for the paragraph.
|
228
235
|
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
229
236
|
def edit_html_html_append_paragraph_with_http_info(paragraph_text, opts = {})
|
230
237
|
if @api_client.config.debugging
|
@@ -246,6 +253,7 @@ module CloudmersiveConvertApiClient
|
|
246
253
|
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
247
254
|
header_params[:'paragraphText'] = paragraph_text
|
248
255
|
header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?
|
256
|
+
header_params[:'cssStyle'] = opts[:'css_style'] if !opts[:'css_style'].nil?
|
249
257
|
|
250
258
|
# form parameters
|
251
259
|
form_params = {}
|
@@ -266,5 +274,66 @@ module CloudmersiveConvertApiClient
|
|
266
274
|
end
|
267
275
|
return data, status_code, headers
|
268
276
|
end
|
277
|
+
# Create a Blank HTML Document
|
278
|
+
# Returns a blank HTML Document format file. The file is blank, with no contents by default. Use the optional input parameters to add various starting elements. Use additional editing commands such as Append Header, Append Paragraph or Append Image from URL to populate the document.
|
279
|
+
# @param [Hash] opts the optional parameters
|
280
|
+
# @option opts [String] :title Optional: The title of the HTML document
|
281
|
+
# @option opts [String] :css_url Optional: A CSS style URL to be added to the document.
|
282
|
+
# @option opts [String] :css_inline Optional: An inline CSS style to be added to the document.
|
283
|
+
# @option opts [String] :javascript_url Optional: Javascript URL to be added to the document.
|
284
|
+
# @option opts [String] :javascript_inline Optional: Inline Javascript to be added to the document.
|
285
|
+
# @return [String]
|
286
|
+
def edit_html_html_create_blank_document(opts = {})
|
287
|
+
data, _status_code, _headers = edit_html_html_create_blank_document_with_http_info(opts)
|
288
|
+
data
|
289
|
+
end
|
290
|
+
|
291
|
+
# Create a Blank HTML Document
|
292
|
+
# Returns a blank HTML Document format file. The file is blank, with no contents by default. Use the optional input parameters to add various starting elements. Use additional editing commands such as Append Header, Append Paragraph or Append Image from URL to populate the document.
|
293
|
+
# @param [Hash] opts the optional parameters
|
294
|
+
# @option opts [String] :title Optional: The title of the HTML document
|
295
|
+
# @option opts [String] :css_url Optional: A CSS style URL to be added to the document.
|
296
|
+
# @option opts [String] :css_inline Optional: An inline CSS style to be added to the document.
|
297
|
+
# @option opts [String] :javascript_url Optional: Javascript URL to be added to the document.
|
298
|
+
# @option opts [String] :javascript_inline Optional: Inline Javascript to be added to the document.
|
299
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
300
|
+
def edit_html_html_create_blank_document_with_http_info(opts = {})
|
301
|
+
if @api_client.config.debugging
|
302
|
+
@api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_create_blank_document ...'
|
303
|
+
end
|
304
|
+
# resource path
|
305
|
+
local_var_path = '/convert/edit/html/create/blank'
|
306
|
+
|
307
|
+
# query parameters
|
308
|
+
query_params = {}
|
309
|
+
|
310
|
+
# header parameters
|
311
|
+
header_params = {}
|
312
|
+
# HTTP header 'Accept' (if needed)
|
313
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
314
|
+
header_params[:'title'] = opts[:'title'] if !opts[:'title'].nil?
|
315
|
+
header_params[:'cssUrl'] = opts[:'css_url'] if !opts[:'css_url'].nil?
|
316
|
+
header_params[:'cssInline'] = opts[:'css_inline'] if !opts[:'css_inline'].nil?
|
317
|
+
header_params[:'javascriptUrl'] = opts[:'javascript_url'] if !opts[:'javascript_url'].nil?
|
318
|
+
header_params[:'javascriptInline'] = opts[:'javascript_inline'] if !opts[:'javascript_inline'].nil?
|
319
|
+
|
320
|
+
# form parameters
|
321
|
+
form_params = {}
|
322
|
+
|
323
|
+
# http body (model)
|
324
|
+
post_body = nil
|
325
|
+
auth_names = ['Apikey']
|
326
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
327
|
+
:header_params => header_params,
|
328
|
+
:query_params => query_params,
|
329
|
+
:form_params => form_params,
|
330
|
+
:body => post_body,
|
331
|
+
:auth_names => auth_names,
|
332
|
+
:return_type => 'String')
|
333
|
+
if @api_client.config.debugging
|
334
|
+
@api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_create_blank_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
335
|
+
end
|
336
|
+
return data, status_code, headers
|
337
|
+
end
|
269
338
|
end
|
270
339
|
end
|