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
@@ -66,12 +66,14 @@ require 'cloudmersive-convert-api-client/models/docx_image'
66
66
  require 'cloudmersive-convert-api-client/models/docx_insert_comment_on_paragraph_request'
67
67
  require 'cloudmersive-convert-api-client/models/docx_insert_image_request'
68
68
  require 'cloudmersive-convert-api-client/models/docx_insert_image_response'
69
+ require 'cloudmersive-convert-api-client/models/docx_metadata_custom_property'
69
70
  require 'cloudmersive-convert-api-client/models/docx_page'
70
71
  require 'cloudmersive-convert-api-client/models/docx_paragraph'
71
72
  require 'cloudmersive-convert-api-client/models/docx_remove_object_request'
72
73
  require 'cloudmersive-convert-api-client/models/docx_remove_object_response'
73
74
  require 'cloudmersive-convert-api-client/models/docx_run'
74
75
  require 'cloudmersive-convert-api-client/models/docx_section'
76
+ require 'cloudmersive-convert-api-client/models/docx_set_custom_metadata_properties_request'
75
77
  require 'cloudmersive-convert-api-client/models/docx_set_footer_add_page_number_request'
76
78
  require 'cloudmersive-convert-api-client/models/docx_set_footer_request'
77
79
  require 'cloudmersive-convert-api-client/models/docx_set_footer_response'
@@ -113,6 +115,7 @@ require 'cloudmersive-convert-api-client/models/get_docx_headers_and_footers_req
113
115
  require 'cloudmersive-convert-api-client/models/get_docx_headers_and_footers_response'
114
116
  require 'cloudmersive-convert-api-client/models/get_docx_images_request'
115
117
  require 'cloudmersive-convert-api-client/models/get_docx_images_response'
118
+ require 'cloudmersive-convert-api-client/models/get_docx_metadata_properties_response'
116
119
  require 'cloudmersive-convert-api-client/models/get_docx_pages_request'
117
120
  require 'cloudmersive-convert-api-client/models/get_docx_pages_response'
118
121
  require 'cloudmersive-convert-api-client/models/get_docx_sections_request'
@@ -77,6 +77,64 @@ module CloudmersiveConvertApiClient
77
77
  end
78
78
  return data, status_code, headers
79
79
  end
80
+ # Convert CSV to XML conversion
81
+ # Convert a CSV file to a XML file
82
+ # @param input_file Input file to perform the operation on.
83
+ # @param [Hash] opts the optional parameters
84
+ # @option opts [BOOLEAN] :column_names_from_first_row Optional; If true, the first row will be used as the labels for the columns; if false, columns will be named Column0, Column1, etc. Default is true. Set to false if you are not using column headings, or have an irregular column structure.
85
+ # @return [String]
86
+ def convert_data_csv_to_xml(input_file, opts = {})
87
+ data, _status_code, _headers = convert_data_csv_to_xml_with_http_info(input_file, opts)
88
+ data
89
+ end
90
+
91
+ # Convert CSV to XML conversion
92
+ # Convert a CSV file to a XML file
93
+ # @param input_file Input file to perform the operation on.
94
+ # @param [Hash] opts the optional parameters
95
+ # @option opts [BOOLEAN] :column_names_from_first_row Optional; If true, the first row will be used as the labels for the columns; if false, columns will be named Column0, Column1, etc. Default is true. Set to false if you are not using column headings, or have an irregular column structure.
96
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
97
+ def convert_data_csv_to_xml_with_http_info(input_file, opts = {})
98
+ if @api_client.config.debugging
99
+ @api_client.config.logger.debug 'Calling API: ConvertDataApi.convert_data_csv_to_xml ...'
100
+ end
101
+ # verify the required parameter 'input_file' is set
102
+ if @api_client.config.client_side_validation && input_file.nil?
103
+ fail ArgumentError, "Missing the required parameter 'input_file' when calling ConvertDataApi.convert_data_csv_to_xml"
104
+ end
105
+ # resource path
106
+ local_var_path = '/convert/csv/to/xml'
107
+
108
+ # query parameters
109
+ query_params = {}
110
+
111
+ # header parameters
112
+ header_params = {}
113
+ # HTTP header 'Accept' (if needed)
114
+ header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
115
+ # HTTP header 'Content-Type'
116
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
117
+ header_params[:'columnNamesFromFirstRow'] = opts[:'column_names_from_first_row'] if !opts[:'column_names_from_first_row'].nil?
118
+
119
+ # form parameters
120
+ form_params = {}
121
+ form_params['inputFile'] = input_file
122
+
123
+ # http body (model)
124
+ post_body = nil
125
+ auth_names = ['Apikey']
126
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
127
+ :header_params => header_params,
128
+ :query_params => query_params,
129
+ :form_params => form_params,
130
+ :body => post_body,
131
+ :auth_names => auth_names,
132
+ :return_type => 'String')
133
+ if @api_client.config.debugging
134
+ @api_client.config.logger.debug "API called: ConvertDataApi#convert_data_csv_to_xml\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
135
+ end
136
+ return data, status_code, headers
137
+ end
80
138
  # Convert JSON to XML conversion
81
139
  # Convert a JSON object into XML
82
140
  # @param json_object Input JSON to convert to XML
@@ -190,7 +248,7 @@ module CloudmersiveConvertApiClient
190
248
  # Convert an Excel XLSX file to a JSON object array
191
249
  # @param input_file Input file to perform the operation on.
192
250
  # @param [Hash] opts the optional parameters
193
- # @return [Object]
251
+ # @return [String]
194
252
  def convert_data_xlsx_to_json(input_file, opts = {})
195
253
  data, _status_code, _headers = convert_data_xlsx_to_json_with_http_info(input_file, opts)
196
254
  data
@@ -200,7 +258,7 @@ module CloudmersiveConvertApiClient
200
258
  # Convert an Excel XLSX file to a JSON object array
201
259
  # @param input_file Input file to perform the operation on.
202
260
  # @param [Hash] opts the optional parameters
203
- # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
261
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
204
262
  def convert_data_xlsx_to_json_with_http_info(input_file, opts = {})
205
263
  if @api_client.config.debugging
206
264
  @api_client.config.logger.debug 'Calling API: ConvertDataApi.convert_data_xlsx_to_json ...'
@@ -218,7 +276,7 @@ module CloudmersiveConvertApiClient
218
276
  # header parameters
219
277
  header_params = {}
220
278
  # HTTP header 'Accept' (if needed)
221
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
279
+ header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
222
280
  # HTTP header 'Content-Type'
223
281
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
224
282
 
@@ -235,12 +293,67 @@ module CloudmersiveConvertApiClient
235
293
  :form_params => form_params,
236
294
  :body => post_body,
237
295
  :auth_names => auth_names,
238
- :return_type => 'Object')
296
+ :return_type => 'String')
239
297
  if @api_client.config.debugging
240
298
  @api_client.config.logger.debug "API called: ConvertDataApi#convert_data_xlsx_to_json\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
241
299
  end
242
300
  return data, status_code, headers
243
301
  end
302
+ # Convert Excel XLSX to XML conversion
303
+ # Convert an Excel XLSX file to a XML file
304
+ # @param input_file Input file to perform the operation on.
305
+ # @param [Hash] opts the optional parameters
306
+ # @return [String]
307
+ def convert_data_xlsx_to_xml(input_file, opts = {})
308
+ data, _status_code, _headers = convert_data_xlsx_to_xml_with_http_info(input_file, opts)
309
+ data
310
+ end
311
+
312
+ # Convert Excel XLSX to XML conversion
313
+ # Convert an Excel XLSX file to a XML file
314
+ # @param input_file Input file to perform the operation on.
315
+ # @param [Hash] opts the optional parameters
316
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
317
+ def convert_data_xlsx_to_xml_with_http_info(input_file, opts = {})
318
+ if @api_client.config.debugging
319
+ @api_client.config.logger.debug 'Calling API: ConvertDataApi.convert_data_xlsx_to_xml ...'
320
+ end
321
+ # verify the required parameter 'input_file' is set
322
+ if @api_client.config.client_side_validation && input_file.nil?
323
+ fail ArgumentError, "Missing the required parameter 'input_file' when calling ConvertDataApi.convert_data_xlsx_to_xml"
324
+ end
325
+ # resource path
326
+ local_var_path = '/convert/xlsx/to/xml'
327
+
328
+ # query parameters
329
+ query_params = {}
330
+
331
+ # header parameters
332
+ header_params = {}
333
+ # HTTP header 'Accept' (if needed)
334
+ header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
335
+ # HTTP header 'Content-Type'
336
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
337
+
338
+ # form parameters
339
+ form_params = {}
340
+ form_params['inputFile'] = input_file
341
+
342
+ # http body (model)
343
+ post_body = nil
344
+ auth_names = ['Apikey']
345
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
346
+ :header_params => header_params,
347
+ :query_params => query_params,
348
+ :form_params => form_params,
349
+ :body => post_body,
350
+ :auth_names => auth_names,
351
+ :return_type => 'String')
352
+ if @api_client.config.debugging
353
+ @api_client.config.logger.debug "API called: ConvertDataApi#convert_data_xlsx_to_xml\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
354
+ end
355
+ return data, status_code, headers
356
+ end
244
357
  # Adds an attribute to all XML nodes matching XPath expression
245
358
  # Return the reuslts of editing an XML document by adding an attribute to all of the nodes that match an input XPath expression.
246
359
  # @param input_file Input XML file to perform the operation on.
@@ -850,6 +850,61 @@ module CloudmersiveConvertApiClient
850
850
  end
851
851
  return data, status_code, headers
852
852
  end
853
+ # Convert Word DOCX Document to Legacy Word DOC (97-03)
854
+ # Convert/downgrade modern Office Word DOCX Documents (DOCX) to the legacy Word DOC (97-2003 Format) format
855
+ # @param input_file Input file to perform the operation on.
856
+ # @param [Hash] opts the optional parameters
857
+ # @return [String]
858
+ def convert_document_docx_to_doc(input_file, opts = {})
859
+ data, _status_code, _headers = convert_document_docx_to_doc_with_http_info(input_file, opts)
860
+ data
861
+ end
862
+
863
+ # Convert Word DOCX Document to Legacy Word DOC (97-03)
864
+ # Convert/downgrade modern Office Word DOCX Documents (DOCX) to the legacy Word DOC (97-2003 Format) format
865
+ # @param input_file Input file to perform the operation on.
866
+ # @param [Hash] opts the optional parameters
867
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
868
+ def convert_document_docx_to_doc_with_http_info(input_file, opts = {})
869
+ if @api_client.config.debugging
870
+ @api_client.config.logger.debug 'Calling API: ConvertDocumentApi.convert_document_docx_to_doc ...'
871
+ end
872
+ # verify the required parameter 'input_file' is set
873
+ if @api_client.config.client_side_validation && input_file.nil?
874
+ fail ArgumentError, "Missing the required parameter 'input_file' when calling ConvertDocumentApi.convert_document_docx_to_doc"
875
+ end
876
+ # resource path
877
+ local_var_path = '/convert/docx/to/doc'
878
+
879
+ # query parameters
880
+ query_params = {}
881
+
882
+ # header parameters
883
+ header_params = {}
884
+ # HTTP header 'Accept' (if needed)
885
+ header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
886
+ # HTTP header 'Content-Type'
887
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
888
+
889
+ # form parameters
890
+ form_params = {}
891
+ form_params['inputFile'] = input_file
892
+
893
+ # http body (model)
894
+ post_body = nil
895
+ auth_names = ['Apikey']
896
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
897
+ :header_params => header_params,
898
+ :query_params => query_params,
899
+ :form_params => form_params,
900
+ :body => post_body,
901
+ :auth_names => auth_names,
902
+ :return_type => 'String')
903
+ if @api_client.config.debugging
904
+ @api_client.config.logger.debug "API called: ConvertDocumentApi#convert_document_docx_to_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
905
+ end
906
+ return data, status_code, headers
907
+ end
853
908
  # Convert Word DOCX Document to HTML Document
854
909
  # Convert Office Word Document (DOCX) to HTML Document
855
910
  # @param input_file Input file to perform the operation on.
@@ -3522,6 +3577,52 @@ module CloudmersiveConvertApiClient
3522
3577
  end
3523
3578
  return data, status_code, headers
3524
3579
  end
3580
+ # Convert PowerPoint PPTX presentation to Legacy PowerPoint PPT (97-03)
3581
+ # Convert/downgrade modern Office PowerPoint PPTX Presentation to the legacy PowerPoint PPT (97-2003 Format) format
3582
+ # @param [Hash] opts the optional parameters
3583
+ # @return [Object]
3584
+ def convert_document_pptx_to_ppt(opts = {})
3585
+ data, _status_code, _headers = convert_document_pptx_to_ppt_with_http_info(opts)
3586
+ data
3587
+ end
3588
+
3589
+ # Convert PowerPoint PPTX presentation to Legacy PowerPoint PPT (97-03)
3590
+ # Convert/downgrade modern Office PowerPoint PPTX Presentation to the legacy PowerPoint PPT (97-2003 Format) format
3591
+ # @param [Hash] opts the optional parameters
3592
+ # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
3593
+ def convert_document_pptx_to_ppt_with_http_info(opts = {})
3594
+ if @api_client.config.debugging
3595
+ @api_client.config.logger.debug 'Calling API: ConvertDocumentApi.convert_document_pptx_to_ppt ...'
3596
+ end
3597
+ # resource path
3598
+ local_var_path = '/convert/pptx/to/ppt'
3599
+
3600
+ # query parameters
3601
+ query_params = {}
3602
+
3603
+ # header parameters
3604
+ header_params = {}
3605
+ # HTTP header 'Accept' (if needed)
3606
+ header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
3607
+
3608
+ # form parameters
3609
+ form_params = {}
3610
+
3611
+ # http body (model)
3612
+ post_body = nil
3613
+ auth_names = ['Apikey']
3614
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
3615
+ :header_params => header_params,
3616
+ :query_params => query_params,
3617
+ :form_params => form_params,
3618
+ :body => post_body,
3619
+ :auth_names => auth_names,
3620
+ :return_type => 'Object')
3621
+ if @api_client.config.debugging
3622
+ @api_client.config.logger.debug "API called: ConvertDocumentApi#convert_document_pptx_to_ppt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3623
+ end
3624
+ return data, status_code, headers
3625
+ end
3525
3626
  # Convert PowerPoint PPTX Presentation to Text (txt)
3526
3627
  # Convert Office PowerPoint Documents (pptx) to standard Text
3527
3628
  # @param input_file Input file to perform the operation on.
@@ -4356,5 +4457,60 @@ module CloudmersiveConvertApiClient
4356
4457
  end
4357
4458
  return data, status_code, headers
4358
4459
  end
4460
+ # Convert Excel XLSX Spreadsheet to Legacy Excel XLS (97-03)
4461
+ # Convert/downgrade modern Office Excel XLSX Spreadsheet to the legacy Excel XLS (97-2003 Format) format
4462
+ # @param input_file Input file to perform the operation on.
4463
+ # @param [Hash] opts the optional parameters
4464
+ # @return [String]
4465
+ def convert_document_xlsx_to_xls(input_file, opts = {})
4466
+ data, _status_code, _headers = convert_document_xlsx_to_xls_with_http_info(input_file, opts)
4467
+ data
4468
+ end
4469
+
4470
+ # Convert Excel XLSX Spreadsheet to Legacy Excel XLS (97-03)
4471
+ # Convert/downgrade modern Office Excel XLSX Spreadsheet to the legacy Excel XLS (97-2003 Format) format
4472
+ # @param input_file Input file to perform the operation on.
4473
+ # @param [Hash] opts the optional parameters
4474
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
4475
+ def convert_document_xlsx_to_xls_with_http_info(input_file, opts = {})
4476
+ if @api_client.config.debugging
4477
+ @api_client.config.logger.debug 'Calling API: ConvertDocumentApi.convert_document_xlsx_to_xls ...'
4478
+ end
4479
+ # verify the required parameter 'input_file' is set
4480
+ if @api_client.config.client_side_validation && input_file.nil?
4481
+ fail ArgumentError, "Missing the required parameter 'input_file' when calling ConvertDocumentApi.convert_document_xlsx_to_xls"
4482
+ end
4483
+ # resource path
4484
+ local_var_path = '/convert/xlsx/to/xls'
4485
+
4486
+ # query parameters
4487
+ query_params = {}
4488
+
4489
+ # header parameters
4490
+ header_params = {}
4491
+ # HTTP header 'Accept' (if needed)
4492
+ header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
4493
+ # HTTP header 'Content-Type'
4494
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
4495
+
4496
+ # form parameters
4497
+ form_params = {}
4498
+ form_params['inputFile'] = input_file
4499
+
4500
+ # http body (model)
4501
+ post_body = nil
4502
+ auth_names = ['Apikey']
4503
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
4504
+ :header_params => header_params,
4505
+ :query_params => query_params,
4506
+ :form_params => form_params,
4507
+ :body => post_body,
4508
+ :auth_names => auth_names,
4509
+ :return_type => 'String')
4510
+ if @api_client.config.debugging
4511
+ @api_client.config.logger.debug "API called: ConvertDocumentApi#convert_document_xlsx_to_xls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4512
+ end
4513
+ return data, status_code, headers
4514
+ end
4359
4515
  end
4360
4516
  end
@@ -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