cloudmersive-convert-api-client 2.0.8 → 2.1.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (35) 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/EditPdfApi.md +169 -0
  9. data/docs/GetDocxMetadataPropertiesResponse.md +16 -0
  10. data/docs/ValidateDocumentApi.md +275 -0
  11. data/docs/ViewerToolsApi.md +8 -2
  12. data/docs/ZipArchiveApi.md +80 -0
  13. data/lib/cloudmersive-convert-api-client.rb +3 -0
  14. data/lib/cloudmersive-convert-api-client/api/convert_data_api.rb +117 -4
  15. data/lib/cloudmersive-convert-api-client/api/convert_document_api.rb +156 -0
  16. data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +329 -0
  17. data/lib/cloudmersive-convert-api-client/api/edit_pdf_api.rb +168 -0
  18. data/lib/cloudmersive-convert-api-client/api/validate_document_api.rb +275 -0
  19. data/lib/cloudmersive-convert-api-client/api/viewer_tools_api.rb +6 -0
  20. data/lib/cloudmersive-convert-api-client/api/zip_archive_api.rb +92 -0
  21. data/lib/cloudmersive-convert-api-client/models/docx_metadata_custom_property.rb +236 -0
  22. data/lib/cloudmersive-convert-api-client/models/docx_set_custom_metadata_properties_request.rb +223 -0
  23. data/lib/cloudmersive-convert-api-client/models/get_docx_metadata_properties_response.rb +268 -0
  24. data/lib/cloudmersive-convert-api-client/version.rb +1 -1
  25. data/spec/api/convert_data_api_spec.rb +26 -1
  26. data/spec/api/convert_document_api_spec.rb +35 -0
  27. data/spec/api/edit_document_api_spec.rb +72 -0
  28. data/spec/api/edit_pdf_api_spec.rb +37 -0
  29. data/spec/api/validate_document_api_spec.rb +60 -0
  30. data/spec/api/viewer_tools_api_spec.rb +2 -0
  31. data/spec/api/zip_archive_api_spec.rb +23 -0
  32. data/spec/models/docx_metadata_custom_property_spec.rb +71 -0
  33. data/spec/models/docx_set_custom_metadata_properties_request_spec.rb +53 -0
  34. data/spec/models/get_docx_metadata_properties_response_spec.rb +89 -0
  35. 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
 
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.cloudmersive.com*
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**edit_pdf_add_annotations**](EditPdfApi.md#edit_pdf_add_annotations) | **POST** /convert/edit/pdf/annotations/add-item | Add one or more PDF annotations, comments in the PDF document
8
+ [**edit_pdf_convert_to_pdf_a**](EditPdfApi.md#edit_pdf_convert_to_pdf_a) | **POST** /convert/edit/pdf/optimize/pdf-a | Convert a PDF file to PDF/A
8
9
  [**edit_pdf_decrypt**](EditPdfApi.md#edit_pdf_decrypt) | **POST** /convert/edit/pdf/decrypt | Decrypt and password-protect a PDF
9
10
  [**edit_pdf_delete_pages**](EditPdfApi.md#edit_pdf_delete_pages) | **POST** /convert/edit/pdf/pages/delete | Remove, delete pages from a PDF document
10
11
  [**edit_pdf_encrypt**](EditPdfApi.md#edit_pdf_encrypt) | **POST** /convert/edit/pdf/encrypt | Encrypt and password-protect a PDF
@@ -13,7 +14,9 @@ Method | HTTP request | Description
13
14
  [**edit_pdf_get_metadata**](EditPdfApi.md#edit_pdf_get_metadata) | **POST** /convert/edit/pdf/get-metadata | Get PDF document metadata
14
15
  [**edit_pdf_get_pdf_text_by_pages**](EditPdfApi.md#edit_pdf_get_pdf_text_by_pages) | **POST** /convert/edit/pdf/pages/get-text | Get text in a PDF document by page
15
16
  [**edit_pdf_insert_pages**](EditPdfApi.md#edit_pdf_insert_pages) | **POST** /convert/edit/pdf/pages/insert | Insert, copy pages from one PDF document into another
17
+ [**edit_pdf_linearize**](EditPdfApi.md#edit_pdf_linearize) | **POST** /convert/edit/pdf/optimize/linearize | Linearize and optimize a PDF for streaming download
16
18
  [**edit_pdf_rasterize**](EditPdfApi.md#edit_pdf_rasterize) | **POST** /convert/edit/pdf/rasterize | Rasterize a PDF to an image-based PDF
19
+ [**edit_pdf_reduce_file_size**](EditPdfApi.md#edit_pdf_reduce_file_size) | **POST** /convert/edit/pdf/optimize/reduce-file-size | Reduce the file size and optimize a PDF
17
20
  [**edit_pdf_remove_all_annotations**](EditPdfApi.md#edit_pdf_remove_all_annotations) | **POST** /convert/edit/pdf/annotations/remove-all | Remove all PDF annotations, including comments in the document
18
21
  [**edit_pdf_remove_annotation_item**](EditPdfApi.md#edit_pdf_remove_annotation_item) | **POST** /convert/edit/pdf/annotations/remove-item | Remove a specific PDF annotation, comment in the document
19
22
  [**edit_pdf_resize**](EditPdfApi.md#edit_pdf_resize) | **POST** /convert/edit/pdf/resize | Change PDF Document's Paper Size
@@ -79,6 +82,64 @@ Name | Type | Description | Notes
79
82
 
80
83
 
81
84
 
85
+ # **edit_pdf_convert_to_pdf_a**
86
+ > String edit_pdf_convert_to_pdf_a(input_file, opts)
87
+
88
+ Convert a PDF file to PDF/A
89
+
90
+ Converts the input PDF file to a PDF/A-1b or PDF/A-2b standardized PDF.
91
+
92
+ ### Example
93
+ ```ruby
94
+ # load the gem
95
+ require 'cloudmersive-convert-api-client'
96
+ # setup authorization
97
+ CloudmersiveConvertApiClient.configure do |config|
98
+ # Configure API key authorization: Apikey
99
+ config.api_key['Apikey'] = 'YOUR API KEY'
100
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
101
+ #config.api_key_prefix['Apikey'] = 'Bearer'
102
+ end
103
+
104
+ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
105
+
106
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
107
+
108
+ opts = {
109
+ conformance_level: 'conformance_level_example' # String | Optional: Select the conformance level for PDF/A - specify '1b' for PDF/A-1b or specify '2b' for PDF/A-2b; default is PDF/A-1b
110
+ }
111
+
112
+ begin
113
+ #Convert a PDF file to PDF/A
114
+ result = api_instance.edit_pdf_convert_to_pdf_a(input_file, opts)
115
+ p result
116
+ rescue CloudmersiveConvertApiClient::ApiError => e
117
+ puts "Exception when calling EditPdfApi->edit_pdf_convert_to_pdf_a: #{e}"
118
+ end
119
+ ```
120
+
121
+ ### Parameters
122
+
123
+ Name | Type | Description | Notes
124
+ ------------- | ------------- | ------------- | -------------
125
+ **input_file** | **File**| Input file to perform the operation on. |
126
+ **conformance_level** | **String**| Optional: Select the conformance level for PDF/A - specify '1b' for PDF/A-1b or specify '2b' for PDF/A-2b; default is PDF/A-1b | [optional]
127
+
128
+ ### Return type
129
+
130
+ **String**
131
+
132
+ ### Authorization
133
+
134
+ [Apikey](../README.md#Apikey)
135
+
136
+ ### HTTP request headers
137
+
138
+ - **Content-Type**: multipart/form-data
139
+ - **Accept**: application/octet-stream
140
+
141
+
142
+
82
143
  # **edit_pdf_decrypt**
83
144
  > String edit_pdf_decrypt(password, input_file)
84
145
 
@@ -544,6 +605,60 @@ Name | Type | Description | Notes
544
605
 
545
606
 
546
607
 
608
+ # **edit_pdf_linearize**
609
+ > String edit_pdf_linearize(input_file)
610
+
611
+ Linearize and optimize a PDF for streaming download
612
+
613
+ Linearizes the content of a PDF to optimize it for streaming download, particularly over web streaming.
614
+
615
+ ### Example
616
+ ```ruby
617
+ # load the gem
618
+ require 'cloudmersive-convert-api-client'
619
+ # setup authorization
620
+ CloudmersiveConvertApiClient.configure do |config|
621
+ # Configure API key authorization: Apikey
622
+ config.api_key['Apikey'] = 'YOUR API KEY'
623
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
624
+ #config.api_key_prefix['Apikey'] = 'Bearer'
625
+ end
626
+
627
+ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
628
+
629
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
630
+
631
+
632
+ begin
633
+ #Linearize and optimize a PDF for streaming download
634
+ result = api_instance.edit_pdf_linearize(input_file)
635
+ p result
636
+ rescue CloudmersiveConvertApiClient::ApiError => e
637
+ puts "Exception when calling EditPdfApi->edit_pdf_linearize: #{e}"
638
+ end
639
+ ```
640
+
641
+ ### Parameters
642
+
643
+ Name | Type | Description | Notes
644
+ ------------- | ------------- | ------------- | -------------
645
+ **input_file** | **File**| Input file to perform the operation on. |
646
+
647
+ ### Return type
648
+
649
+ **String**
650
+
651
+ ### Authorization
652
+
653
+ [Apikey](../README.md#Apikey)
654
+
655
+ ### HTTP request headers
656
+
657
+ - **Content-Type**: multipart/form-data
658
+ - **Accept**: application/octet-stream
659
+
660
+
661
+
547
662
  # **edit_pdf_rasterize**
548
663
  > String edit_pdf_rasterize(input_file)
549
664
 
@@ -598,6 +713,60 @@ Name | Type | Description | Notes
598
713
 
599
714
 
600
715
 
716
+ # **edit_pdf_reduce_file_size**
717
+ > String edit_pdf_reduce_file_size(input_file)
718
+
719
+ Reduce the file size and optimize a PDF
720
+
721
+ Reduces the file size and optimizes the content of a PDF to minimize its file size.
722
+
723
+ ### Example
724
+ ```ruby
725
+ # load the gem
726
+ require 'cloudmersive-convert-api-client'
727
+ # setup authorization
728
+ CloudmersiveConvertApiClient.configure do |config|
729
+ # Configure API key authorization: Apikey
730
+ config.api_key['Apikey'] = 'YOUR API KEY'
731
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
732
+ #config.api_key_prefix['Apikey'] = 'Bearer'
733
+ end
734
+
735
+ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
736
+
737
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
738
+
739
+
740
+ begin
741
+ #Reduce the file size and optimize a PDF
742
+ result = api_instance.edit_pdf_reduce_file_size(input_file)
743
+ p result
744
+ rescue CloudmersiveConvertApiClient::ApiError => e
745
+ puts "Exception when calling EditPdfApi->edit_pdf_reduce_file_size: #{e}"
746
+ end
747
+ ```
748
+
749
+ ### Parameters
750
+
751
+ Name | Type | Description | Notes
752
+ ------------- | ------------- | ------------- | -------------
753
+ **input_file** | **File**| Input file to perform the operation on. |
754
+
755
+ ### Return type
756
+
757
+ **String**
758
+
759
+ ### Authorization
760
+
761
+ [Apikey](../README.md#Apikey)
762
+
763
+ ### HTTP request headers
764
+
765
+ - **Content-Type**: multipart/form-data
766
+ - **Accept**: application/octet-stream
767
+
768
+
769
+
601
770
  # **edit_pdf_remove_all_annotations**
602
771
  > String edit_pdf_remove_all_annotations(input_file)
603
772