cloudmersive-convert-api-client 2.1.4 → 2.1.9

Sign up to get free protection for your applications and to get access to all the features.
Files changed (50) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +29 -4
  3. data/docs/EditDocumentApi.md +165 -0
  4. data/docs/EditHtmlApi.md +478 -0
  5. data/docs/EditPdfApi.md +6 -2
  6. data/docs/GetMacrosResponse.md +9 -0
  7. data/docs/HtmlGetLanguageResult.md +9 -0
  8. data/docs/HtmlGetLinksResponse.md +9 -0
  9. data/docs/HtmlGetRelCanonicalUrlResult.md +9 -0
  10. data/docs/HtmlGetSitemapUrlResult.md +9 -0
  11. data/docs/HtmlHyperlink.md +9 -0
  12. data/docs/HtmlSsrfThreatCheckResult.md +10 -0
  13. data/docs/HtmlThreatLink.md +9 -0
  14. data/docs/MergeDocumentApi.md +134 -0
  15. data/docs/ValidateDocumentApi.md +110 -0
  16. data/docs/XxeThreatDetectionResult.md +9 -0
  17. data/docs/ZipArchiveApi.md +62 -0
  18. data/lib/cloudmersive-convert-api-client.rb +9 -0
  19. data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +165 -0
  20. data/lib/cloudmersive-convert-api-client/api/edit_html_api.rb +447 -0
  21. data/lib/cloudmersive-convert-api-client/api/edit_pdf_api.rb +3 -0
  22. data/lib/cloudmersive-convert-api-client/api/merge_document_api.rb +148 -0
  23. data/lib/cloudmersive-convert-api-client/api/validate_document_api.rb +110 -0
  24. data/lib/cloudmersive-convert-api-client/api/zip_archive_api.rb +63 -0
  25. data/lib/cloudmersive-convert-api-client/models/get_macros_response.rb +196 -0
  26. data/lib/cloudmersive-convert-api-client/models/html_get_language_result.rb +196 -0
  27. data/lib/cloudmersive-convert-api-client/models/html_get_links_response.rb +198 -0
  28. data/lib/cloudmersive-convert-api-client/models/html_get_rel_canonical_url_result.rb +196 -0
  29. data/lib/cloudmersive-convert-api-client/models/html_get_sitemap_url_result.rb +196 -0
  30. data/lib/cloudmersive-convert-api-client/models/html_hyperlink.rb +196 -0
  31. data/lib/cloudmersive-convert-api-client/models/html_ssrf_threat_check_result.rb +208 -0
  32. data/lib/cloudmersive-convert-api-client/models/html_threat_link.rb +196 -0
  33. data/lib/cloudmersive-convert-api-client/models/xxe_threat_detection_result.rb +196 -0
  34. data/lib/cloudmersive-convert-api-client/version.rb +1 -1
  35. data/spec/api/edit_document_api_spec.rb +36 -0
  36. data/spec/api/edit_html_api_spec.rb +109 -0
  37. data/spec/api/edit_pdf_api_spec.rb +1 -0
  38. data/spec/api/merge_document_api_spec.rb +34 -0
  39. data/spec/api/validate_document_api_spec.rb +24 -0
  40. data/spec/api/zip_archive_api_spec.rb +14 -0
  41. data/spec/models/get_macros_response_spec.rb +47 -0
  42. data/spec/models/html_get_language_result_spec.rb +47 -0
  43. data/spec/models/html_get_links_response_spec.rb +47 -0
  44. data/spec/models/html_get_rel_canonical_url_result_spec.rb +47 -0
  45. data/spec/models/html_get_sitemap_url_result_spec.rb +47 -0
  46. data/spec/models/html_hyperlink_spec.rb +47 -0
  47. data/spec/models/html_ssrf_threat_check_result_spec.rb +53 -0
  48. data/spec/models/html_threat_link_spec.rb +47 -0
  49. data/spec/models/xxe_threat_detection_result_spec.rb +47 -0
  50. metadata +29 -2
@@ -130,6 +130,7 @@ require 'cloudmersive-convert-api-client/models/get_docx_tables_request'
130
130
  require 'cloudmersive-convert-api-client/models/get_docx_tables_response'
131
131
  require 'cloudmersive-convert-api-client/models/get_file_type_icon_result'
132
132
  require 'cloudmersive-convert-api-client/models/get_image_info_result'
133
+ require 'cloudmersive-convert-api-client/models/get_macros_response'
133
134
  require 'cloudmersive-convert-api-client/models/get_pdf_annotations_result'
134
135
  require 'cloudmersive-convert-api-client/models/get_xlsx_cell_by_identifier_request'
135
136
  require 'cloudmersive-convert-api-client/models/get_xlsx_cell_by_identifier_response'
@@ -147,10 +148,17 @@ require 'cloudmersive-convert-api-client/models/get_xlsx_styles_request'
147
148
  require 'cloudmersive-convert-api-client/models/get_xlsx_styles_response'
148
149
  require 'cloudmersive-convert-api-client/models/get_xlsx_worksheets_request'
149
150
  require 'cloudmersive-convert-api-client/models/get_xlsx_worksheets_response'
151
+ require 'cloudmersive-convert-api-client/models/html_get_language_result'
152
+ require 'cloudmersive-convert-api-client/models/html_get_links_response'
153
+ require 'cloudmersive-convert-api-client/models/html_get_rel_canonical_url_result'
154
+ require 'cloudmersive-convert-api-client/models/html_get_sitemap_url_result'
155
+ require 'cloudmersive-convert-api-client/models/html_hyperlink'
150
156
  require 'cloudmersive-convert-api-client/models/html_md_result'
157
+ require 'cloudmersive-convert-api-client/models/html_ssrf_threat_check_result'
151
158
  require 'cloudmersive-convert-api-client/models/html_template_application_request'
152
159
  require 'cloudmersive-convert-api-client/models/html_template_application_response'
153
160
  require 'cloudmersive-convert-api-client/models/html_template_operation'
161
+ require 'cloudmersive-convert-api-client/models/html_threat_link'
154
162
  require 'cloudmersive-convert-api-client/models/html_to_office_request'
155
163
  require 'cloudmersive-convert-api-client/models/html_to_pdf_request'
156
164
  require 'cloudmersive-convert-api-client/models/html_to_png_request'
@@ -256,6 +264,7 @@ require 'cloudmersive-convert-api-client/models/xml_remove_all_children_with_x_p
256
264
  require 'cloudmersive-convert-api-client/models/xml_remove_with_x_path_result'
257
265
  require 'cloudmersive-convert-api-client/models/xml_replace_with_x_path_result'
258
266
  require 'cloudmersive-convert-api-client/models/xml_set_value_with_x_path_result'
267
+ require 'cloudmersive-convert-api-client/models/xxe_threat_detection_result'
259
268
  require 'cloudmersive-convert-api-client/models/zip_directory'
260
269
  require 'cloudmersive-convert-api-client/models/zip_encryption_advanced_request'
261
270
  require 'cloudmersive-convert-api-client/models/zip_extract_response'
@@ -779,6 +779,61 @@ module CloudmersiveConvertApiClient
779
779
  end
780
780
  return data, status_code, headers
781
781
  end
782
+ # Get macro information from a Word DOCX/DOCM document
783
+ # Returns information about the Macros (e.g. VBA) defined in the Word Document
784
+ # @param input_file Input file to perform the operation on.
785
+ # @param [Hash] opts the optional parameters
786
+ # @return [GetMacrosResponse]
787
+ def edit_document_docx_get_macro_information(input_file, opts = {})
788
+ data, _status_code, _headers = edit_document_docx_get_macro_information_with_http_info(input_file, opts)
789
+ data
790
+ end
791
+
792
+ # Get macro information from a Word DOCX/DOCM document
793
+ # Returns information about the Macros (e.g. VBA) defined in the Word Document
794
+ # @param input_file Input file to perform the operation on.
795
+ # @param [Hash] opts the optional parameters
796
+ # @return [Array<(GetMacrosResponse, Fixnum, Hash)>] GetMacrosResponse data, response status code and response headers
797
+ def edit_document_docx_get_macro_information_with_http_info(input_file, opts = {})
798
+ if @api_client.config.debugging
799
+ @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_get_macro_information ...'
800
+ end
801
+ # verify the required parameter 'input_file' is set
802
+ if @api_client.config.client_side_validation && input_file.nil?
803
+ fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_docx_get_macro_information"
804
+ end
805
+ # resource path
806
+ local_var_path = '/convert/edit/docx/get-macros'
807
+
808
+ # query parameters
809
+ query_params = {}
810
+
811
+ # header parameters
812
+ header_params = {}
813
+ # HTTP header 'Accept' (if needed)
814
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
815
+ # HTTP header 'Content-Type'
816
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
817
+
818
+ # form parameters
819
+ form_params = {}
820
+ form_params['inputFile'] = input_file
821
+
822
+ # http body (model)
823
+ post_body = nil
824
+ auth_names = ['Apikey']
825
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
826
+ :header_params => header_params,
827
+ :query_params => query_params,
828
+ :form_params => form_params,
829
+ :body => post_body,
830
+ :auth_names => auth_names,
831
+ :return_type => 'GetMacrosResponse')
832
+ if @api_client.config.debugging
833
+ @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_get_macro_information\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
834
+ end
835
+ return data, status_code, headers
836
+ end
782
837
  # Get all metadata properties in Word DOCX document
783
838
  # Returns all the metadata properties in an Office Word Document (docx)
784
839
  # @param input_file Input file to perform the operation on.
@@ -2185,6 +2240,61 @@ module CloudmersiveConvertApiClient
2185
2240
  end
2186
2241
  return data, status_code, headers
2187
2242
  end
2243
+ # Get macro information from a PowerPoint PPTX/PPTM presentation document
2244
+ # Returns information about the Macros (e.g. VBA) defined in the PowerPoint Document
2245
+ # @param input_file Input file to perform the operation on.
2246
+ # @param [Hash] opts the optional parameters
2247
+ # @return [GetMacrosResponse]
2248
+ def edit_document_pptx_get_macro_information(input_file, opts = {})
2249
+ data, _status_code, _headers = edit_document_pptx_get_macro_information_with_http_info(input_file, opts)
2250
+ data
2251
+ end
2252
+
2253
+ # Get macro information from a PowerPoint PPTX/PPTM presentation document
2254
+ # Returns information about the Macros (e.g. VBA) defined in the PowerPoint Document
2255
+ # @param input_file Input file to perform the operation on.
2256
+ # @param [Hash] opts the optional parameters
2257
+ # @return [Array<(GetMacrosResponse, Fixnum, Hash)>] GetMacrosResponse data, response status code and response headers
2258
+ def edit_document_pptx_get_macro_information_with_http_info(input_file, opts = {})
2259
+ if @api_client.config.debugging
2260
+ @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_pptx_get_macro_information ...'
2261
+ end
2262
+ # verify the required parameter 'input_file' is set
2263
+ if @api_client.config.client_side_validation && input_file.nil?
2264
+ fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_pptx_get_macro_information"
2265
+ end
2266
+ # resource path
2267
+ local_var_path = '/convert/edit/pptx/get-macros'
2268
+
2269
+ # query parameters
2270
+ query_params = {}
2271
+
2272
+ # header parameters
2273
+ header_params = {}
2274
+ # HTTP header 'Accept' (if needed)
2275
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
2276
+ # HTTP header 'Content-Type'
2277
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
2278
+
2279
+ # form parameters
2280
+ form_params = {}
2281
+ form_params['inputFile'] = input_file
2282
+
2283
+ # http body (model)
2284
+ post_body = nil
2285
+ auth_names = ['Apikey']
2286
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2287
+ :header_params => header_params,
2288
+ :query_params => query_params,
2289
+ :form_params => form_params,
2290
+ :body => post_body,
2291
+ :auth_names => auth_names,
2292
+ :return_type => 'GetMacrosResponse')
2293
+ if @api_client.config.debugging
2294
+ @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_pptx_get_macro_information\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2295
+ end
2296
+ return data, status_code, headers
2297
+ end
2188
2298
  # Replace string in PowerPoint PPTX presentation
2189
2299
  # Replace all instances of a string in an Office PowerPoint Document (pptx)
2190
2300
  # @param req_config Replacement document configuration input
@@ -2887,6 +2997,61 @@ module CloudmersiveConvertApiClient
2887
2997
  end
2888
2998
  return data, status_code, headers
2889
2999
  end
3000
+ # Get macro information from a Excel XLSX/XLSM spreadsheet, worksheet
3001
+ # Returns information about the Macros (e.g. VBA) defined in the Excel Spreadsheet
3002
+ # @param input_file Input file to perform the operation on.
3003
+ # @param [Hash] opts the optional parameters
3004
+ # @return [GetMacrosResponse]
3005
+ def edit_document_xlsx_get_macro_information(input_file, opts = {})
3006
+ data, _status_code, _headers = edit_document_xlsx_get_macro_information_with_http_info(input_file, opts)
3007
+ data
3008
+ end
3009
+
3010
+ # Get macro information from a Excel XLSX/XLSM spreadsheet, worksheet
3011
+ # Returns information about the Macros (e.g. VBA) defined in the Excel Spreadsheet
3012
+ # @param input_file Input file to perform the operation on.
3013
+ # @param [Hash] opts the optional parameters
3014
+ # @return [Array<(GetMacrosResponse, Fixnum, Hash)>] GetMacrosResponse data, response status code and response headers
3015
+ def edit_document_xlsx_get_macro_information_with_http_info(input_file, opts = {})
3016
+ if @api_client.config.debugging
3017
+ @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_xlsx_get_macro_information ...'
3018
+ end
3019
+ # verify the required parameter 'input_file' is set
3020
+ if @api_client.config.client_side_validation && input_file.nil?
3021
+ fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_xlsx_get_macro_information"
3022
+ end
3023
+ # resource path
3024
+ local_var_path = '/convert/edit/xlsx/get-macros'
3025
+
3026
+ # query parameters
3027
+ query_params = {}
3028
+
3029
+ # header parameters
3030
+ header_params = {}
3031
+ # HTTP header 'Accept' (if needed)
3032
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
3033
+ # HTTP header 'Content-Type'
3034
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
3035
+
3036
+ # form parameters
3037
+ form_params = {}
3038
+ form_params['inputFile'] = input_file
3039
+
3040
+ # http body (model)
3041
+ post_body = nil
3042
+ auth_names = ['Apikey']
3043
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
3044
+ :header_params => header_params,
3045
+ :query_params => query_params,
3046
+ :form_params => form_params,
3047
+ :body => post_body,
3048
+ :auth_names => auth_names,
3049
+ :return_type => 'GetMacrosResponse')
3050
+ if @api_client.config.debugging
3051
+ @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_xlsx_get_macro_information\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3052
+ end
3053
+ return data, status_code, headers
3054
+ end
2890
3055
  # Get rows and cells from a Excel XLSX spreadsheet, worksheet
2891
3056
  # Returns the rows and cells defined in the Excel Spreadsheet worksheet
2892
3057
  # @param input Document input request
@@ -19,6 +19,65 @@ module CloudmersiveConvertApiClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+ # Append an HTML tag to the HEAD section of an HTML Document
23
+ # Appends an HTML tag to the HEAD section of an HTML document.
24
+ # @param html_tag The HTML tag to append.
25
+ # @param [Hash] opts the optional parameters
26
+ # @option opts [File] :input_file Optional: Input file to perform the operation on.
27
+ # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
28
+ # @return [String]
29
+ def edit_html_html_append_header_tag(html_tag, opts = {})
30
+ data, _status_code, _headers = edit_html_html_append_header_tag_with_http_info(html_tag, opts)
31
+ data
32
+ end
33
+
34
+ # Append an HTML tag to the HEAD section of an HTML Document
35
+ # Appends an HTML tag to the HEAD section of an HTML document.
36
+ # @param html_tag The HTML tag to append.
37
+ # @param [Hash] opts the optional parameters
38
+ # @option opts [File] :input_file Optional: Input file to perform the operation on.
39
+ # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
40
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
41
+ def edit_html_html_append_header_tag_with_http_info(html_tag, opts = {})
42
+ if @api_client.config.debugging
43
+ @api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_append_header_tag ...'
44
+ end
45
+ # verify the required parameter 'html_tag' is set
46
+ if @api_client.config.client_side_validation && html_tag.nil?
47
+ fail ArgumentError, "Missing the required parameter 'html_tag' when calling EditHtmlApi.edit_html_html_append_header_tag"
48
+ end
49
+ # resource path
50
+ local_var_path = '/convert/edit/html/head/append/tag'
51
+
52
+ # query parameters
53
+ query_params = {}
54
+
55
+ # header parameters
56
+ header_params = {}
57
+ # HTTP header 'Accept' (if needed)
58
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
59
+ header_params[:'htmlTag'] = html_tag
60
+ header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?
61
+
62
+ # form parameters
63
+ form_params = {}
64
+ form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?
65
+
66
+ # http body (model)
67
+ post_body = nil
68
+ auth_names = ['Apikey']
69
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
70
+ :header_params => header_params,
71
+ :query_params => query_params,
72
+ :form_params => form_params,
73
+ :body => post_body,
74
+ :auth_names => auth_names,
75
+ :return_type => 'String')
76
+ if @api_client.config.debugging
77
+ @api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_append_header_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
78
+ end
79
+ return data, status_code, headers
80
+ end
22
81
  # Append a Heading to an HTML Document
23
82
  # Appends a heading to the end of an HTML document.
24
83
  # @param heading_text The text content to be used in the header.
@@ -335,5 +394,393 @@ module CloudmersiveConvertApiClient
335
394
  end
336
395
  return data, status_code, headers
337
396
  end
397
+ # Gets the language for the HTML document
398
+ # Retrieves the language code (e.g. \"en\" or \"de\") of an HTML document.
399
+ # @param [Hash] opts the optional parameters
400
+ # @option opts [File] :input_file Optional: Input file to perform the operation on.
401
+ # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
402
+ # @return [HtmlGetLanguageResult]
403
+ def edit_html_html_get_language(opts = {})
404
+ data, _status_code, _headers = edit_html_html_get_language_with_http_info(opts)
405
+ data
406
+ end
407
+
408
+ # Gets the language for the HTML document
409
+ # Retrieves the language code (e.g. \&quot;en\&quot; or \&quot;de\&quot;) of an HTML document.
410
+ # @param [Hash] opts the optional parameters
411
+ # @option opts [File] :input_file Optional: Input file to perform the operation on.
412
+ # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
413
+ # @return [Array<(HtmlGetLanguageResult, Fixnum, Hash)>] HtmlGetLanguageResult data, response status code and response headers
414
+ def edit_html_html_get_language_with_http_info(opts = {})
415
+ if @api_client.config.debugging
416
+ @api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_get_language ...'
417
+ end
418
+ # resource path
419
+ local_var_path = '/convert/edit/html/head/get/language'
420
+
421
+ # query parameters
422
+ query_params = {}
423
+
424
+ # header parameters
425
+ header_params = {}
426
+ # HTTP header 'Accept' (if needed)
427
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
428
+ header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?
429
+
430
+ # form parameters
431
+ form_params = {}
432
+ form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?
433
+
434
+ # http body (model)
435
+ post_body = nil
436
+ auth_names = ['Apikey']
437
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
438
+ :header_params => header_params,
439
+ :query_params => query_params,
440
+ :form_params => form_params,
441
+ :body => post_body,
442
+ :auth_names => auth_names,
443
+ :return_type => 'HtmlGetLanguageResult')
444
+ if @api_client.config.debugging
445
+ @api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_get_language\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
446
+ end
447
+ return data, status_code, headers
448
+ end
449
+ # Extract resolved link URLs from HTML File
450
+ # Extracts the resolved link URLs, fully-qualified if possible, from an input HTML file.
451
+ # @param [Hash] opts the optional parameters
452
+ # @option opts [File] :input_file Optional: Input file to perform the operation on.
453
+ # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
454
+ # @option opts [String] :base_url Optional: Base URL of the page, such as https://mydomain.com
455
+ # @return [HtmlGetLinksResponse]
456
+ def edit_html_html_get_links(opts = {})
457
+ data, _status_code, _headers = edit_html_html_get_links_with_http_info(opts)
458
+ data
459
+ end
460
+
461
+ # Extract resolved link URLs from HTML File
462
+ # Extracts the resolved link URLs, fully-qualified if possible, from an input HTML file.
463
+ # @param [Hash] opts the optional parameters
464
+ # @option opts [File] :input_file Optional: Input file to perform the operation on.
465
+ # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
466
+ # @option opts [String] :base_url Optional: Base URL of the page, such as https://mydomain.com
467
+ # @return [Array<(HtmlGetLinksResponse, Fixnum, Hash)>] HtmlGetLinksResponse data, response status code and response headers
468
+ def edit_html_html_get_links_with_http_info(opts = {})
469
+ if @api_client.config.debugging
470
+ @api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_get_links ...'
471
+ end
472
+ # resource path
473
+ local_var_path = '/convert/edit/html/extract/links'
474
+
475
+ # query parameters
476
+ query_params = {}
477
+
478
+ # header parameters
479
+ header_params = {}
480
+ # HTTP header 'Accept' (if needed)
481
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
482
+ header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?
483
+ header_params[:'baseUrl'] = opts[:'base_url'] if !opts[:'base_url'].nil?
484
+
485
+ # form parameters
486
+ form_params = {}
487
+ form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?
488
+
489
+ # http body (model)
490
+ post_body = nil
491
+ auth_names = ['Apikey']
492
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
493
+ :header_params => header_params,
494
+ :query_params => query_params,
495
+ :form_params => form_params,
496
+ :body => post_body,
497
+ :auth_names => auth_names,
498
+ :return_type => 'HtmlGetLinksResponse')
499
+ if @api_client.config.debugging
500
+ @api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_get_links\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
501
+ end
502
+ return data, status_code, headers
503
+ end
504
+ # Gets the rel canonical URL for the HTML document
505
+ # Gets the rel canonical URL of an HTML document.
506
+ # @param [Hash] opts the optional parameters
507
+ # @option opts [File] :input_file Optional: Input file to perform the operation on.
508
+ # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
509
+ # @return [HtmlGetRelCanonicalUrlResult]
510
+ def edit_html_html_get_rel_canonical(opts = {})
511
+ data, _status_code, _headers = edit_html_html_get_rel_canonical_with_http_info(opts)
512
+ data
513
+ end
514
+
515
+ # Gets the rel canonical URL for the HTML document
516
+ # Gets the rel canonical URL of an HTML document.
517
+ # @param [Hash] opts the optional parameters
518
+ # @option opts [File] :input_file Optional: Input file to perform the operation on.
519
+ # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
520
+ # @return [Array<(HtmlGetRelCanonicalUrlResult, Fixnum, Hash)>] HtmlGetRelCanonicalUrlResult data, response status code and response headers
521
+ def edit_html_html_get_rel_canonical_with_http_info(opts = {})
522
+ if @api_client.config.debugging
523
+ @api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_get_rel_canonical ...'
524
+ end
525
+ # resource path
526
+ local_var_path = '/convert/edit/html/head/get/rel-canonical-url'
527
+
528
+ # query parameters
529
+ query_params = {}
530
+
531
+ # header parameters
532
+ header_params = {}
533
+ # HTTP header 'Accept' (if needed)
534
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
535
+ header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?
536
+
537
+ # form parameters
538
+ form_params = {}
539
+ form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?
540
+
541
+ # http body (model)
542
+ post_body = nil
543
+ auth_names = ['Apikey']
544
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
545
+ :header_params => header_params,
546
+ :query_params => query_params,
547
+ :form_params => form_params,
548
+ :body => post_body,
549
+ :auth_names => auth_names,
550
+ :return_type => 'HtmlGetRelCanonicalUrlResult')
551
+ if @api_client.config.debugging
552
+ @api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_get_rel_canonical\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
553
+ end
554
+ return data, status_code, headers
555
+ end
556
+ # Gets the sitemap URL for the HTML document
557
+ # Gets the sitemap link URL of an HTML document.
558
+ # @param [Hash] opts the optional parameters
559
+ # @option opts [File] :input_file Optional: Input file to perform the operation on.
560
+ # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
561
+ # @return [HtmlGetSitemapUrlResult]
562
+ def edit_html_html_get_sitemap(opts = {})
563
+ data, _status_code, _headers = edit_html_html_get_sitemap_with_http_info(opts)
564
+ data
565
+ end
566
+
567
+ # Gets the sitemap URL for the HTML document
568
+ # Gets the sitemap link URL of an HTML document.
569
+ # @param [Hash] opts the optional parameters
570
+ # @option opts [File] :input_file Optional: Input file to perform the operation on.
571
+ # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
572
+ # @return [Array<(HtmlGetSitemapUrlResult, Fixnum, Hash)>] HtmlGetSitemapUrlResult data, response status code and response headers
573
+ def edit_html_html_get_sitemap_with_http_info(opts = {})
574
+ if @api_client.config.debugging
575
+ @api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_get_sitemap ...'
576
+ end
577
+ # resource path
578
+ local_var_path = '/convert/edit/html/head/get/sitemap-url'
579
+
580
+ # query parameters
581
+ query_params = {}
582
+
583
+ # header parameters
584
+ header_params = {}
585
+ # HTTP header 'Accept' (if needed)
586
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
587
+ header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?
588
+
589
+ # form parameters
590
+ form_params = {}
591
+ form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?
592
+
593
+ # http body (model)
594
+ post_body = nil
595
+ auth_names = ['Apikey']
596
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
597
+ :header_params => header_params,
598
+ :query_params => query_params,
599
+ :form_params => form_params,
600
+ :body => post_body,
601
+ :auth_names => auth_names,
602
+ :return_type => 'HtmlGetSitemapUrlResult')
603
+ if @api_client.config.debugging
604
+ @api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_get_sitemap\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
605
+ end
606
+ return data, status_code, headers
607
+ end
608
+ # Sets the language for the HTML document
609
+ # Sets the language code of an HTML document.
610
+ # @param language_code The HTML langauge code to set.
611
+ # @param [Hash] opts the optional parameters
612
+ # @option opts [File] :input_file Optional: Input file to perform the operation on.
613
+ # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
614
+ # @return [String]
615
+ def edit_html_html_set_language(language_code, opts = {})
616
+ data, _status_code, _headers = edit_html_html_set_language_with_http_info(language_code, opts)
617
+ data
618
+ end
619
+
620
+ # Sets the language for the HTML document
621
+ # Sets the language code of an HTML document.
622
+ # @param language_code The HTML langauge code to set.
623
+ # @param [Hash] opts the optional parameters
624
+ # @option opts [File] :input_file Optional: Input file to perform the operation on.
625
+ # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
626
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
627
+ def edit_html_html_set_language_with_http_info(language_code, opts = {})
628
+ if @api_client.config.debugging
629
+ @api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_set_language ...'
630
+ end
631
+ # verify the required parameter 'language_code' is set
632
+ if @api_client.config.client_side_validation && language_code.nil?
633
+ fail ArgumentError, "Missing the required parameter 'language_code' when calling EditHtmlApi.edit_html_html_set_language"
634
+ end
635
+ # resource path
636
+ local_var_path = '/convert/edit/html/head/set/language'
637
+
638
+ # query parameters
639
+ query_params = {}
640
+
641
+ # header parameters
642
+ header_params = {}
643
+ # HTTP header 'Accept' (if needed)
644
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
645
+ header_params[:'languageCode'] = language_code
646
+ header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?
647
+
648
+ # form parameters
649
+ form_params = {}
650
+ form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?
651
+
652
+ # http body (model)
653
+ post_body = nil
654
+ auth_names = ['Apikey']
655
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
656
+ :header_params => header_params,
657
+ :query_params => query_params,
658
+ :form_params => form_params,
659
+ :body => post_body,
660
+ :auth_names => auth_names,
661
+ :return_type => 'String')
662
+ if @api_client.config.debugging
663
+ @api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_set_language\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
664
+ end
665
+ return data, status_code, headers
666
+ end
667
+ # Sets the rel canonical URL for the HTML document
668
+ # Sets the rel canonical URL of an HTML document. This is useful for telling search engines and other indexers which pages are duplicates of eachother; any pages with the rel=canonical tag will be treated as duplicates of the canonical URL.
669
+ # @param canonical_url The HTML canonical URL to set.
670
+ # @param [Hash] opts the optional parameters
671
+ # @option opts [File] :input_file Optional: Input file to perform the operation on.
672
+ # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
673
+ # @return [String]
674
+ def edit_html_html_set_rel_canonical(canonical_url, opts = {})
675
+ data, _status_code, _headers = edit_html_html_set_rel_canonical_with_http_info(canonical_url, opts)
676
+ data
677
+ end
678
+
679
+ # Sets the rel canonical URL for the HTML document
680
+ # Sets the rel canonical URL of an HTML document. This is useful for telling search engines and other indexers which pages are duplicates of eachother; any pages with the rel&#x3D;canonical tag will be treated as duplicates of the canonical URL.
681
+ # @param canonical_url The HTML canonical URL to set.
682
+ # @param [Hash] opts the optional parameters
683
+ # @option opts [File] :input_file Optional: Input file to perform the operation on.
684
+ # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
685
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
686
+ def edit_html_html_set_rel_canonical_with_http_info(canonical_url, opts = {})
687
+ if @api_client.config.debugging
688
+ @api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_set_rel_canonical ...'
689
+ end
690
+ # verify the required parameter 'canonical_url' is set
691
+ if @api_client.config.client_side_validation && canonical_url.nil?
692
+ fail ArgumentError, "Missing the required parameter 'canonical_url' when calling EditHtmlApi.edit_html_html_set_rel_canonical"
693
+ end
694
+ # resource path
695
+ local_var_path = '/convert/edit/html/head/set/rel-canonical-url'
696
+
697
+ # query parameters
698
+ query_params = {}
699
+
700
+ # header parameters
701
+ header_params = {}
702
+ # HTTP header 'Accept' (if needed)
703
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
704
+ header_params[:'canonicalUrl'] = canonical_url
705
+ header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?
706
+
707
+ # form parameters
708
+ form_params = {}
709
+ form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?
710
+
711
+ # http body (model)
712
+ post_body = nil
713
+ auth_names = ['Apikey']
714
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
715
+ :header_params => header_params,
716
+ :query_params => query_params,
717
+ :form_params => form_params,
718
+ :body => post_body,
719
+ :auth_names => auth_names,
720
+ :return_type => 'String')
721
+ if @api_client.config.debugging
722
+ @api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_set_rel_canonical\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
723
+ end
724
+ return data, status_code, headers
725
+ end
726
+ # Sets the sitemap URL for the HTML document
727
+ # Sets the sitemap URL of an HTML document.
728
+ # @param sitemap_url The HTML sitemap URL to set.
729
+ # @param [Hash] opts the optional parameters
730
+ # @option opts [File] :input_file Optional: Input file to perform the operation on.
731
+ # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
732
+ # @return [String]
733
+ def edit_html_html_set_sitemap_url(sitemap_url, opts = {})
734
+ data, _status_code, _headers = edit_html_html_set_sitemap_url_with_http_info(sitemap_url, opts)
735
+ data
736
+ end
737
+
738
+ # Sets the sitemap URL for the HTML document
739
+ # Sets the sitemap URL of an HTML document.
740
+ # @param sitemap_url The HTML sitemap URL to set.
741
+ # @param [Hash] opts the optional parameters
742
+ # @option opts [File] :input_file Optional: Input file to perform the operation on.
743
+ # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
744
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
745
+ def edit_html_html_set_sitemap_url_with_http_info(sitemap_url, opts = {})
746
+ if @api_client.config.debugging
747
+ @api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_set_sitemap_url ...'
748
+ end
749
+ # verify the required parameter 'sitemap_url' is set
750
+ if @api_client.config.client_side_validation && sitemap_url.nil?
751
+ fail ArgumentError, "Missing the required parameter 'sitemap_url' when calling EditHtmlApi.edit_html_html_set_sitemap_url"
752
+ end
753
+ # resource path
754
+ local_var_path = '/convert/edit/html/head/set/sitemap-url'
755
+
756
+ # query parameters
757
+ query_params = {}
758
+
759
+ # header parameters
760
+ header_params = {}
761
+ # HTTP header 'Accept' (if needed)
762
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
763
+ header_params[:'sitemapUrl'] = sitemap_url
764
+ header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?
765
+
766
+ # form parameters
767
+ form_params = {}
768
+ form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?
769
+
770
+ # http body (model)
771
+ post_body = nil
772
+ auth_names = ['Apikey']
773
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
774
+ :header_params => header_params,
775
+ :query_params => query_params,
776
+ :form_params => form_params,
777
+ :body => post_body,
778
+ :auth_names => auth_names,
779
+ :return_type => 'String')
780
+ if @api_client.config.debugging
781
+ @api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_set_sitemap_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
782
+ end
783
+ return data, status_code, headers
784
+ end
338
785
  end
339
786
  end