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.
Files changed (38) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +27 -4
  3. data/docs/ConvertDataApi.md +117 -3
  4. data/docs/ConvertDocumentApi.md +159 -0
  5. data/docs/DocxMetadataCustomProperty.md +13 -0
  6. data/docs/DocxSetCustomMetadataPropertiesRequest.md +10 -0
  7. data/docs/EditDocumentApi.md +330 -0
  8. data/docs/EditHtmlApi.md +81 -13
  9. data/docs/EditPdfApi.md +227 -0
  10. data/docs/GetDocxMetadataPropertiesResponse.md +16 -0
  11. data/docs/ValidateDocumentApi.md +165 -0
  12. data/docs/ViewerToolsApi.md +8 -2
  13. data/docs/ZipArchiveApi.md +80 -0
  14. data/lib/cloudmersive-convert-api-client.rb +3 -0
  15. data/lib/cloudmersive-convert-api-client/api/convert_data_api.rb +117 -4
  16. data/lib/cloudmersive-convert-api-client/api/convert_document_api.rb +156 -0
  17. data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +329 -0
  18. data/lib/cloudmersive-convert-api-client/api/edit_html_api.rb +81 -12
  19. data/lib/cloudmersive-convert-api-client/api/edit_pdf_api.rb +230 -0
  20. data/lib/cloudmersive-convert-api-client/api/validate_document_api.rb +165 -0
  21. data/lib/cloudmersive-convert-api-client/api/viewer_tools_api.rb +6 -0
  22. data/lib/cloudmersive-convert-api-client/api/zip_archive_api.rb +92 -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/version.rb +1 -1
  27. data/spec/api/convert_data_api_spec.rb +26 -1
  28. data/spec/api/convert_document_api_spec.rb +35 -0
  29. data/spec/api/edit_document_api_spec.rb +72 -0
  30. data/spec/api/edit_html_api_spec.rb +24 -6
  31. data/spec/api/edit_pdf_api_spec.rb +50 -0
  32. data/spec/api/validate_document_api_spec.rb +36 -0
  33. data/spec/api/viewer_tools_api_spec.rb +2 -0
  34. data/spec/api/zip_archive_api_spec.rb +23 -0
  35. data/spec/models/docx_metadata_custom_property_spec.rb +71 -0
  36. data/spec/models/docx_set_custom_metadata_properties_request_spec.rb +53 -0
  37. data/spec/models/get_docx_metadata_properties_response_spec.rb +89 -0
  38. metadata +11 -2
@@ -0,0 +1,13 @@
1
+ # CloudmersiveConvertApiClient::DocxMetadataCustomProperty
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **property_name** | **String** | Name of the property | [optional]
7
+ **property_data_type** | **String** | Data type of the property; possible values are \"string\", \"integer\", \"double\" or \"date\" | [optional]
8
+ **string_value** | **String** | If the property is of a string data type, then provides the string value if available | [optional]
9
+ **integer_value** | **Integer** | If the property is of a integer data type, then provides the integer value if available | [optional]
10
+ **double_value** | **Float** | If the property is of a double floating point data type, then provides the double value if available | [optional]
11
+ **date_value** | **DateTime** | If the property is of a date time data type, then provides the date time value if available | [optional]
12
+
13
+
@@ -0,0 +1,10 @@
1
+ # CloudmersiveConvertApiClient::DocxSetCustomMetadataPropertiesRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **input_file_bytes** | **String** | Optional: Bytes of the input file to operate on | [optional]
7
+ **input_file_url** | **String** | Optional: URL of a file to operate on as input. This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public). | [optional]
8
+ **properties_to_set** | [**Array<DocxMetadataCustomProperty>**](DocxMetadataCustomProperty.md) | Required: properties to set in the Word Document; provide one or more property definitions to set - be sure to specify the data type and value, together with the property name | [optional]
9
+
10
+
@@ -5,16 +5,20 @@ All URIs are relative to *https://api.cloudmersive.com*
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**edit_document_begin_editing**](EditDocumentApi.md#edit_document_begin_editing) | **POST** /convert/edit/begin-editing | Begin editing a document
8
+ [**edit_document_docx_accept_all_track_changes**](EditDocumentApi.md#edit_document_docx_accept_all_track_changes) | **POST** /convert/edit/docx/track-changes/accept-all | Accept all tracked changes, revisions in a Word DOCX document
8
9
  [**edit_document_docx_body**](EditDocumentApi.md#edit_document_docx_body) | **POST** /convert/edit/docx/get-body | Get body from a Word DOCX document
9
10
  [**edit_document_docx_create_blank_document**](EditDocumentApi.md#edit_document_docx_create_blank_document) | **POST** /convert/edit/docx/create/blank | Create a blank Word DOCX document
10
11
  [**edit_document_docx_delete_pages**](EditDocumentApi.md#edit_document_docx_delete_pages) | **POST** /convert/edit/docx/delete-pages | Delete, remove pages from a Word DOCX document
11
12
  [**edit_document_docx_delete_table_row**](EditDocumentApi.md#edit_document_docx_delete_table_row) | **POST** /convert/edit/docx/delete-table-row | Deletes a table row in an existing table in a Word DOCX document
12
13
  [**edit_document_docx_delete_table_row_range**](EditDocumentApi.md#edit_document_docx_delete_table_row_range) | **POST** /convert/edit/docx/delete-table-row/range | Deletes a range of multiple table rows in an existing table in a Word DOCX document
14
+ [**edit_document_docx_disable_track_changes**](EditDocumentApi.md#edit_document_docx_disable_track_changes) | **POST** /convert/edit/docx/track-changes/disable | Disable track changes, revisions in a Word DOCX document
15
+ [**edit_document_docx_enable_track_changes**](EditDocumentApi.md#edit_document_docx_enable_track_changes) | **POST** /convert/edit/docx/track-changes/enable | Enable track changes, revisions in a Word DOCX document
13
16
  [**edit_document_docx_find_paragraph**](EditDocumentApi.md#edit_document_docx_find_paragraph) | **POST** /convert/edit/docx/find/paragraph | Find matching paragraphs in a Word DOCX document
14
17
  [**edit_document_docx_get_comments**](EditDocumentApi.md#edit_document_docx_get_comments) | **POST** /convert/edit/docx/get-comments/flat-list | Get comments from a Word DOCX document as a flat list
15
18
  [**edit_document_docx_get_comments_hierarchical**](EditDocumentApi.md#edit_document_docx_get_comments_hierarchical) | **POST** /convert/edit/docx/get-comments/hierarchical | Get comments from a Word DOCX document hierarchically
16
19
  [**edit_document_docx_get_headers_and_footers**](EditDocumentApi.md#edit_document_docx_get_headers_and_footers) | **POST** /convert/edit/docx/get-headers-and-footers | Get content of a footer from a Word DOCX document
17
20
  [**edit_document_docx_get_images**](EditDocumentApi.md#edit_document_docx_get_images) | **POST** /convert/edit/docx/get-images | Get images from a Word DOCX document
21
+ [**edit_document_docx_get_metadata_properties**](EditDocumentApi.md#edit_document_docx_get_metadata_properties) | **POST** /convert/edit/docx/get-metadata | Get all metadata properties in Word DOCX document
18
22
  [**edit_document_docx_get_sections**](EditDocumentApi.md#edit_document_docx_get_sections) | **POST** /convert/edit/docx/get-sections | Get sections from a Word DOCX document
19
23
  [**edit_document_docx_get_styles**](EditDocumentApi.md#edit_document_docx_get_styles) | **POST** /convert/edit/docx/get-styles | Get styles from a Word DOCX document
20
24
  [**edit_document_docx_get_table_by_index**](EditDocumentApi.md#edit_document_docx_get_table_by_index) | **POST** /convert/edit/docx/get-table/by-index | Get a specific table by index in a Word DOCX document
@@ -26,11 +30,13 @@ Method | HTTP request | Description
26
30
  [**edit_document_docx_insert_table**](EditDocumentApi.md#edit_document_docx_insert_table) | **POST** /convert/edit/docx/insert-table | Insert a new table into a Word DOCX document
27
31
  [**edit_document_docx_insert_table_row**](EditDocumentApi.md#edit_document_docx_insert_table_row) | **POST** /convert/edit/docx/insert-table-row | Insert a new row into an existing table in a Word DOCX document
28
32
  [**edit_document_docx_pages**](EditDocumentApi.md#edit_document_docx_pages) | **POST** /convert/edit/docx/get-pages | Get pages and content from a Word DOCX document
33
+ [**edit_document_docx_remove_all_comments**](EditDocumentApi.md#edit_document_docx_remove_all_comments) | **POST** /convert/edit/docx/comments/remove-all | Remove all comments from a Word DOCX document
29
34
  [**edit_document_docx_remove_headers_and_footers**](EditDocumentApi.md#edit_document_docx_remove_headers_and_footers) | **POST** /convert/edit/docx/remove-headers-and-footers | Remove headers and footers from Word DOCX document
30
35
  [**edit_document_docx_remove_object**](EditDocumentApi.md#edit_document_docx_remove_object) | **POST** /convert/edit/docx/remove-object | Delete any object in a Word DOCX document
31
36
  [**edit_document_docx_replace**](EditDocumentApi.md#edit_document_docx_replace) | **POST** /convert/edit/docx/replace-all | Replace string in Word DOCX document
32
37
  [**edit_document_docx_replace_multi**](EditDocumentApi.md#edit_document_docx_replace_multi) | **POST** /convert/edit/docx/replace-all/multi | Replace multiple strings in Word DOCX document
33
38
  [**edit_document_docx_replace_paragraph**](EditDocumentApi.md#edit_document_docx_replace_paragraph) | **POST** /convert/edit/docx/replace/paragraph | Replace matching paragraphs in a Word DOCX document
39
+ [**edit_document_docx_set_custom_metadata_properties**](EditDocumentApi.md#edit_document_docx_set_custom_metadata_properties) | **POST** /convert/edit/docx/set-metadata/custom-property | Set custom property metadata properties in Word DOCX document
34
40
  [**edit_document_docx_set_footer**](EditDocumentApi.md#edit_document_docx_set_footer) | **POST** /convert/edit/docx/set-footer | Set the footer in a Word DOCX document
35
41
  [**edit_document_docx_set_footer_add_page_number**](EditDocumentApi.md#edit_document_docx_set_footer_add_page_number) | **POST** /convert/edit/docx/set-footer/add-page-number | Add page number to footer in a Word DOCX document
36
42
  [**edit_document_docx_set_header**](EditDocumentApi.md#edit_document_docx_set_header) | **POST** /convert/edit/docx/set-header | Set the header in a Word DOCX document
@@ -115,6 +121,60 @@ Name | Type | Description | Notes
115
121
 
116
122
 
117
123
 
124
+ # **edit_document_docx_accept_all_track_changes**
125
+ > String edit_document_docx_accept_all_track_changes(input_file)
126
+
127
+ Accept all tracked changes, revisions in a Word DOCX document
128
+
129
+ 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.
130
+
131
+ ### Example
132
+ ```ruby
133
+ # load the gem
134
+ require 'cloudmersive-convert-api-client'
135
+ # setup authorization
136
+ CloudmersiveConvertApiClient.configure do |config|
137
+ # Configure API key authorization: Apikey
138
+ config.api_key['Apikey'] = 'YOUR API KEY'
139
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
140
+ #config.api_key_prefix['Apikey'] = 'Bearer'
141
+ end
142
+
143
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
144
+
145
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
146
+
147
+
148
+ begin
149
+ #Accept all tracked changes, revisions in a Word DOCX document
150
+ result = api_instance.edit_document_docx_accept_all_track_changes(input_file)
151
+ p result
152
+ rescue CloudmersiveConvertApiClient::ApiError => e
153
+ puts "Exception when calling EditDocumentApi->edit_document_docx_accept_all_track_changes: #{e}"
154
+ end
155
+ ```
156
+
157
+ ### Parameters
158
+
159
+ Name | Type | Description | Notes
160
+ ------------- | ------------- | ------------- | -------------
161
+ **input_file** | **File**| Input file to perform the operation on. |
162
+
163
+ ### Return type
164
+
165
+ **String**
166
+
167
+ ### Authorization
168
+
169
+ [Apikey](../README.md#Apikey)
170
+
171
+ ### HTTP request headers
172
+
173
+ - **Content-Type**: multipart/form-data
174
+ - **Accept**: application/json, text/json, application/xml, text/xml
175
+
176
+
177
+
118
178
  # **edit_document_docx_body**
119
179
  > GetDocxBodyResponse edit_document_docx_body(req_config)
120
180
 
@@ -385,6 +445,114 @@ Name | Type | Description | Notes
385
445
 
386
446
 
387
447
 
448
+ # **edit_document_docx_disable_track_changes**
449
+ > String edit_document_docx_disable_track_changes(input_file)
450
+
451
+ Disable track changes, revisions in a Word DOCX document
452
+
453
+ 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.
454
+
455
+ ### Example
456
+ ```ruby
457
+ # load the gem
458
+ require 'cloudmersive-convert-api-client'
459
+ # setup authorization
460
+ CloudmersiveConvertApiClient.configure do |config|
461
+ # Configure API key authorization: Apikey
462
+ config.api_key['Apikey'] = 'YOUR API KEY'
463
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
464
+ #config.api_key_prefix['Apikey'] = 'Bearer'
465
+ end
466
+
467
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
468
+
469
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
470
+
471
+
472
+ begin
473
+ #Disable track changes, revisions in a Word DOCX document
474
+ result = api_instance.edit_document_docx_disable_track_changes(input_file)
475
+ p result
476
+ rescue CloudmersiveConvertApiClient::ApiError => e
477
+ puts "Exception when calling EditDocumentApi->edit_document_docx_disable_track_changes: #{e}"
478
+ end
479
+ ```
480
+
481
+ ### Parameters
482
+
483
+ Name | Type | Description | Notes
484
+ ------------- | ------------- | ------------- | -------------
485
+ **input_file** | **File**| Input file to perform the operation on. |
486
+
487
+ ### Return type
488
+
489
+ **String**
490
+
491
+ ### Authorization
492
+
493
+ [Apikey](../README.md#Apikey)
494
+
495
+ ### HTTP request headers
496
+
497
+ - **Content-Type**: multipart/form-data
498
+ - **Accept**: application/json, text/json, application/xml, text/xml
499
+
500
+
501
+
502
+ # **edit_document_docx_enable_track_changes**
503
+ > String edit_document_docx_enable_track_changes(input_file)
504
+
505
+ Enable track changes, revisions in a Word DOCX document
506
+
507
+ 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.
508
+
509
+ ### Example
510
+ ```ruby
511
+ # load the gem
512
+ require 'cloudmersive-convert-api-client'
513
+ # setup authorization
514
+ CloudmersiveConvertApiClient.configure do |config|
515
+ # Configure API key authorization: Apikey
516
+ config.api_key['Apikey'] = 'YOUR API KEY'
517
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
518
+ #config.api_key_prefix['Apikey'] = 'Bearer'
519
+ end
520
+
521
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
522
+
523
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
524
+
525
+
526
+ begin
527
+ #Enable track changes, revisions in a Word DOCX document
528
+ result = api_instance.edit_document_docx_enable_track_changes(input_file)
529
+ p result
530
+ rescue CloudmersiveConvertApiClient::ApiError => e
531
+ puts "Exception when calling EditDocumentApi->edit_document_docx_enable_track_changes: #{e}"
532
+ end
533
+ ```
534
+
535
+ ### Parameters
536
+
537
+ Name | Type | Description | Notes
538
+ ------------- | ------------- | ------------- | -------------
539
+ **input_file** | **File**| Input file to perform the operation on. |
540
+
541
+ ### Return type
542
+
543
+ **String**
544
+
545
+ ### Authorization
546
+
547
+ [Apikey](../README.md#Apikey)
548
+
549
+ ### HTTP request headers
550
+
551
+ - **Content-Type**: multipart/form-data
552
+ - **Accept**: application/json, text/json, application/xml, text/xml
553
+
554
+
555
+
388
556
  # **edit_document_docx_find_paragraph**
389
557
  > FindDocxParagraphResponse edit_document_docx_find_paragraph(req_config)
390
558
 
@@ -655,6 +823,60 @@ Name | Type | Description | Notes
655
823
 
656
824
 
657
825
 
826
+ # **edit_document_docx_get_metadata_properties**
827
+ > GetDocxMetadataPropertiesResponse edit_document_docx_get_metadata_properties(input_file)
828
+
829
+ Get all metadata properties in Word DOCX document
830
+
831
+ Returns all the metadata properties in an Office Word Document (docx)
832
+
833
+ ### Example
834
+ ```ruby
835
+ # load the gem
836
+ require 'cloudmersive-convert-api-client'
837
+ # setup authorization
838
+ CloudmersiveConvertApiClient.configure do |config|
839
+ # Configure API key authorization: Apikey
840
+ config.api_key['Apikey'] = 'YOUR API KEY'
841
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
842
+ #config.api_key_prefix['Apikey'] = 'Bearer'
843
+ end
844
+
845
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
846
+
847
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
848
+
849
+
850
+ begin
851
+ #Get all metadata properties in Word DOCX document
852
+ result = api_instance.edit_document_docx_get_metadata_properties(input_file)
853
+ p result
854
+ rescue CloudmersiveConvertApiClient::ApiError => e
855
+ puts "Exception when calling EditDocumentApi->edit_document_docx_get_metadata_properties: #{e}"
856
+ end
857
+ ```
858
+
859
+ ### Parameters
860
+
861
+ Name | Type | Description | Notes
862
+ ------------- | ------------- | ------------- | -------------
863
+ **input_file** | **File**| Input file to perform the operation on. |
864
+
865
+ ### Return type
866
+
867
+ [**GetDocxMetadataPropertiesResponse**](GetDocxMetadataPropertiesResponse.md)
868
+
869
+ ### Authorization
870
+
871
+ [Apikey](../README.md#Apikey)
872
+
873
+ ### HTTP request headers
874
+
875
+ - **Content-Type**: multipart/form-data
876
+ - **Accept**: application/json, text/json, application/xml, text/xml
877
+
878
+
879
+
658
880
  # **edit_document_docx_get_sections**
659
881
  > GetDocxSectionsResponse edit_document_docx_get_sections(req_config)
660
882
 
@@ -1249,6 +1471,60 @@ Name | Type | Description | Notes
1249
1471
 
1250
1472
 
1251
1473
 
1474
+ # **edit_document_docx_remove_all_comments**
1475
+ > String edit_document_docx_remove_all_comments(input_file)
1476
+
1477
+ Remove all comments from a Word DOCX document
1478
+
1479
+ Removes all of the comments from a Word Document.
1480
+
1481
+ ### Example
1482
+ ```ruby
1483
+ # load the gem
1484
+ require 'cloudmersive-convert-api-client'
1485
+ # setup authorization
1486
+ CloudmersiveConvertApiClient.configure do |config|
1487
+ # Configure API key authorization: Apikey
1488
+ config.api_key['Apikey'] = 'YOUR API KEY'
1489
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1490
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1491
+ end
1492
+
1493
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
1494
+
1495
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
1496
+
1497
+
1498
+ begin
1499
+ #Remove all comments from a Word DOCX document
1500
+ result = api_instance.edit_document_docx_remove_all_comments(input_file)
1501
+ p result
1502
+ rescue CloudmersiveConvertApiClient::ApiError => e
1503
+ puts "Exception when calling EditDocumentApi->edit_document_docx_remove_all_comments: #{e}"
1504
+ end
1505
+ ```
1506
+
1507
+ ### Parameters
1508
+
1509
+ Name | Type | Description | Notes
1510
+ ------------- | ------------- | ------------- | -------------
1511
+ **input_file** | **File**| Input file to perform the operation on. |
1512
+
1513
+ ### Return type
1514
+
1515
+ **String**
1516
+
1517
+ ### Authorization
1518
+
1519
+ [Apikey](../README.md#Apikey)
1520
+
1521
+ ### HTTP request headers
1522
+
1523
+ - **Content-Type**: multipart/form-data
1524
+ - **Accept**: application/json, text/json, application/xml, text/xml
1525
+
1526
+
1527
+
1252
1528
  # **edit_document_docx_remove_headers_and_footers**
1253
1529
  > RemoveDocxHeadersAndFootersResponse edit_document_docx_remove_headers_and_footers(req_config)
1254
1530
 
@@ -1519,6 +1795,60 @@ Name | Type | Description | Notes
1519
1795
 
1520
1796
 
1521
1797
 
1798
+ # **edit_document_docx_set_custom_metadata_properties**
1799
+ > String edit_document_docx_set_custom_metadata_properties(input)
1800
+
1801
+ Set custom property metadata properties in Word DOCX document
1802
+
1803
+ Sets the custom property metadata for the metadata properties in an Office Word Document (docx)
1804
+
1805
+ ### Example
1806
+ ```ruby
1807
+ # load the gem
1808
+ require 'cloudmersive-convert-api-client'
1809
+ # setup authorization
1810
+ CloudmersiveConvertApiClient.configure do |config|
1811
+ # Configure API key authorization: Apikey
1812
+ config.api_key['Apikey'] = 'YOUR API KEY'
1813
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1814
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1815
+ end
1816
+
1817
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
1818
+
1819
+ input = CloudmersiveConvertApiClient::DocxSetCustomMetadataPropertiesRequest.new # DocxSetCustomMetadataPropertiesRequest |
1820
+
1821
+
1822
+ begin
1823
+ #Set custom property metadata properties in Word DOCX document
1824
+ result = api_instance.edit_document_docx_set_custom_metadata_properties(input)
1825
+ p result
1826
+ rescue CloudmersiveConvertApiClient::ApiError => e
1827
+ puts "Exception when calling EditDocumentApi->edit_document_docx_set_custom_metadata_properties: #{e}"
1828
+ end
1829
+ ```
1830
+
1831
+ ### Parameters
1832
+
1833
+ Name | Type | Description | Notes
1834
+ ------------- | ------------- | ------------- | -------------
1835
+ **input** | [**DocxSetCustomMetadataPropertiesRequest**](DocxSetCustomMetadataPropertiesRequest.md)| |
1836
+
1837
+ ### Return type
1838
+
1839
+ **String**
1840
+
1841
+ ### Authorization
1842
+
1843
+ [Apikey](../README.md#Apikey)
1844
+
1845
+ ### HTTP request headers
1846
+
1847
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
1848
+ - **Accept**: application/json, text/json, application/xml, text/xml
1849
+
1850
+
1851
+
1522
1852
  # **edit_document_docx_set_footer**
1523
1853
  > DocxSetFooterResponse edit_document_docx_set_footer(req_config)
1524
1854
 
@@ -8,6 +8,7 @@ Method | HTTP request | Description
8
8
  [**edit_html_html_append_image_from_url**](EditHtmlApi.md#edit_html_html_append_image_from_url) | **POST** /convert/edit/html/append/image/from-url | Append an Image to an HTML Document from a URL
9
9
  [**edit_html_html_append_image_inline**](EditHtmlApi.md#edit_html_html_append_image_inline) | **POST** /convert/edit/html/append/image/inline | Append a Base64 Inline Image to an HTML Document
10
10
  [**edit_html_html_append_paragraph**](EditHtmlApi.md#edit_html_html_append_paragraph) | **POST** /convert/edit/html/append/paragraph | Append a Paragraph to an HTML Document
11
+ [**edit_html_html_create_blank_document**](EditHtmlApi.md#edit_html_html_create_blank_document) | **POST** /convert/edit/html/create/blank | Create a Blank HTML Document
11
12
 
12
13
 
13
14
  # **edit_html_html_append_heading**
@@ -35,8 +36,9 @@ heading_text = 'heading_text_example' # String | The text content to be used in
35
36
 
36
37
  opts = {
37
38
  input_file: File.new('/path/to/file.txt'), # File | Optional: Input file to perform the operation on.
38
- input_file_url: 'input_file_url_example', # String | Optional: URL of a file to operate on as input. This can be a public URL, or you can also use the begin-editing API (part of EditDocumentApi) to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
39
- heading_size: 56 # Integer | Optional: The heading size number. Default is 1.
39
+ input_file_url: 'input_file_url_example', # String | Optional: URL of a file to operate on as input.
40
+ heading_size: 56, # Integer | Optional: The heading size number. Default is 1. Accepts values between 1 and 6.
41
+ css_style: 'css_style_example' # String | Optional: The CSS style for the heading.
40
42
  }
41
43
 
42
44
  begin
@@ -54,8 +56,9 @@ Name | Type | Description | Notes
54
56
  ------------- | ------------- | ------------- | -------------
55
57
  **heading_text** | **String**| The text content to be used in the header. |
56
58
  **input_file** | **File**| Optional: Input file to perform the operation on. | [optional]
57
- **input_file_url** | **String**| Optional: URL of a file to operate on as input. This can be a public URL, or you can also use the begin-editing API (part of EditDocumentApi) to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public). | [optional]
58
- **heading_size** | **Integer**| Optional: The heading size number. Default is 1. | [optional]
59
+ **input_file_url** | **String**| Optional: URL of a file to operate on as input. | [optional]
60
+ **heading_size** | **Integer**| Optional: The heading size number. Default is 1. Accepts values between 1 and 6. | [optional]
61
+ **css_style** | **String**| Optional: The CSS style for the heading. | [optional]
59
62
 
60
63
  ### Return type
61
64
 
@@ -97,7 +100,7 @@ image_url = 'image_url_example' # String | The URL for the image.
97
100
 
98
101
  opts = {
99
102
  input_file: File.new('/path/to/file.txt'), # File | Optional: Input file to perform the operation on.
100
- input_file_url: 'input_file_url_example', # String | Optional: URL of a file to operate on as input. This can be a public URL, or you can also use the begin-editing API (part of EditDocumentApi) to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
103
+ input_file_url: 'input_file_url_example', # String | Optional: URL of a file to operate on as input.
101
104
  css_style: 'css_style_example' # String | Optional: CSS style for the image.
102
105
  }
103
106
 
@@ -116,7 +119,7 @@ Name | Type | Description | Notes
116
119
  ------------- | ------------- | ------------- | -------------
117
120
  **image_url** | **String**| The URL for the image. |
118
121
  **input_file** | **File**| Optional: Input file to perform the operation on. | [optional]
119
- **input_file_url** | **String**| Optional: URL of a file to operate on as input. This can be a public URL, or you can also use the begin-editing API (part of EditDocumentApi) to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public). | [optional]
122
+ **input_file_url** | **String**| Optional: URL of a file to operate on as input. | [optional]
120
123
  **css_style** | **String**| Optional: CSS style for the image. | [optional]
121
124
 
122
125
  ### Return type
@@ -157,11 +160,11 @@ api_instance = CloudmersiveConvertApiClient::EditHtmlApi.new
157
160
 
158
161
  opts = {
159
162
  input_file: File.new('/path/to/file.txt'), # File | Optional: Input file to perform the operation on.
160
- input_file_url: 'input_file_url_example', # String | Optional: URL of a file to operate on as input. This can be a public URL, or you can also use the begin-editing API (part of EditDocumentApi) to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
163
+ input_file_url: 'input_file_url_example', # String | Optional: URL of a file to operate on as input.
161
164
  image_file: File.new('/path/to/file.txt'), # File | Optional: Image file to be appended as base64 inline image.
162
165
  image_url: 'image_url_example', # String | Optional: Image URL to be appended as base64 inline image.
163
166
  css_style: 'css_style_example', # String | Optional: CSS style for the image.
164
- image_extension: 'image_extension_example' # String | Optional: The extension (JPG, PNG, GIF, etc.) of the image file. Recommended if uploading a file directly, such as with a byte array. If no extension can be determined, will default to JPG.
167
+ image_extension: 'image_extension_example' # String | 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.
165
168
  }
166
169
 
167
170
  begin
@@ -178,11 +181,11 @@ end
178
181
  Name | Type | Description | Notes
179
182
  ------------- | ------------- | ------------- | -------------
180
183
  **input_file** | **File**| Optional: Input file to perform the operation on. | [optional]
181
- **input_file_url** | **String**| Optional: URL of a file to operate on as input. This can be a public URL, or you can also use the begin-editing API (part of EditDocumentApi) to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public). | [optional]
184
+ **input_file_url** | **String**| Optional: URL of a file to operate on as input. | [optional]
182
185
  **image_file** | **File**| Optional: Image file to be appended as base64 inline image. | [optional]
183
186
  **image_url** | **String**| Optional: Image URL to be appended as base64 inline image. | [optional]
184
187
  **css_style** | **String**| Optional: CSS style for the image. | [optional]
185
- **image_extension** | **String**| Optional: The extension (JPG, PNG, GIF, etc.) of the image file. Recommended if uploading a file directly, such as with a byte array. If no extension can be determined, will default to JPG. | [optional]
188
+ **image_extension** | **String**| 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. | [optional]
186
189
 
187
190
  ### Return type
188
191
 
@@ -194,7 +197,7 @@ Name | Type | Description | Notes
194
197
 
195
198
  ### HTTP request headers
196
199
 
197
- - **Content-Type**: Not defined
200
+ - **Content-Type**: multipart/form-data
198
201
  - **Accept**: application/json, text/json, application/xml, text/xml
199
202
 
200
203
 
@@ -224,7 +227,8 @@ paragraph_text = 'paragraph_text_example' # String | The text content to be used
224
227
 
225
228
  opts = {
226
229
  input_file: File.new('/path/to/file.txt'), # File | Optional: Input file to perform the operation on.
227
- input_file_url: 'input_file_url_example' # String | Optional: URL of a file to operate on as input. This can be a public URL, or you can also use the begin-editing API (part of EditDocumentApi) to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
230
+ input_file_url: 'input_file_url_example', # String | Optional: URL of a file to operate on as input.
231
+ css_style: 'css_style_example' # String | Optional: The CSS style for the paragraph.
228
232
  }
229
233
 
230
234
  begin
@@ -242,7 +246,71 @@ Name | Type | Description | Notes
242
246
  ------------- | ------------- | ------------- | -------------
243
247
  **paragraph_text** | **String**| The text content to be used in the paragraph. |
244
248
  **input_file** | **File**| Optional: Input file to perform the operation on. | [optional]
245
- **input_file_url** | **String**| Optional: URL of a file to operate on as input. This can be a public URL, or you can also use the begin-editing API (part of EditDocumentApi) to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public). | [optional]
249
+ **input_file_url** | **String**| Optional: URL of a file to operate on as input. | [optional]
250
+ **css_style** | **String**| Optional: The CSS style for the paragraph. | [optional]
251
+
252
+ ### Return type
253
+
254
+ **String**
255
+
256
+ ### Authorization
257
+
258
+ [Apikey](../README.md#Apikey)
259
+
260
+ ### HTTP request headers
261
+
262
+ - **Content-Type**: Not defined
263
+ - **Accept**: application/json, text/json, application/xml, text/xml
264
+
265
+
266
+
267
+ # **edit_html_html_create_blank_document**
268
+ > String edit_html_html_create_blank_document(opts)
269
+
270
+ Create a Blank HTML Document
271
+
272
+ 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.
273
+
274
+ ### Example
275
+ ```ruby
276
+ # load the gem
277
+ require 'cloudmersive-convert-api-client'
278
+ # setup authorization
279
+ CloudmersiveConvertApiClient.configure do |config|
280
+ # Configure API key authorization: Apikey
281
+ config.api_key['Apikey'] = 'YOUR API KEY'
282
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
283
+ #config.api_key_prefix['Apikey'] = 'Bearer'
284
+ end
285
+
286
+ api_instance = CloudmersiveConvertApiClient::EditHtmlApi.new
287
+
288
+ opts = {
289
+ title: 'title_example', # String | Optional: The title of the HTML document
290
+ css_url: 'css_url_example', # String | Optional: A CSS style URL to be added to the document.
291
+ css_inline: 'css_inline_example', # String | Optional: An inline CSS style to be added to the document.
292
+ javascript_url: 'javascript_url_example', # String | Optional: Javascript URL to be added to the document.
293
+ javascript_inline: 'javascript_inline_example' # String | Optional: Inline Javascript to be added to the document.
294
+ }
295
+
296
+ begin
297
+ #Create a Blank HTML Document
298
+ result = api_instance.edit_html_html_create_blank_document(opts)
299
+ p result
300
+ rescue CloudmersiveConvertApiClient::ApiError => e
301
+ puts "Exception when calling EditHtmlApi->edit_html_html_create_blank_document: #{e}"
302
+ end
303
+ ```
304
+
305
+ ### Parameters
306
+
307
+ Name | Type | Description | Notes
308
+ ------------- | ------------- | ------------- | -------------
309
+ **title** | **String**| Optional: The title of the HTML document | [optional]
310
+ **css_url** | **String**| Optional: A CSS style URL to be added to the document. | [optional]
311
+ **css_inline** | **String**| Optional: An inline CSS style to be added to the document. | [optional]
312
+ **javascript_url** | **String**| Optional: Javascript URL to be added to the document. | [optional]
313
+ **javascript_inline** | **String**| Optional: Inline Javascript to be added to the document. | [optional]
246
314
 
247
315
  ### Return type
248
316