Class: CloudmersiveConvertApiClient::ConvertWebApi
- Inherits:
-
Object
- Object
- CloudmersiveConvertApiClient::ConvertWebApi
- Defined in:
- lib/cloudmersive-convert-api-client/api/convert_web_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#convert_web_html_to_docx(input_request, opts = {}) ⇒ String
Convert HTML to Word DOCX Document Convert HTML to Office Word Document (DOCX) format.
-
#convert_web_html_to_docx_with_http_info(input_request, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Convert HTML to Word DOCX Document Convert HTML to Office Word Document (DOCX) format.
-
#convert_web_html_to_pdf(input, opts = {}) ⇒ String
Convert HTML string to PDF Fully renders a website and returns a PDF of the HTML.
-
#convert_web_html_to_pdf_with_http_info(input, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Convert HTML string to PDF Fully renders a website and returns a PDF of the HTML.
-
#convert_web_html_to_png(input, opts = {}) ⇒ String
Convert HTML string to PNG screenshot Fully renders a website and returns a PNG (screenshot) of the HTML.
-
#convert_web_html_to_png_with_http_info(input, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Convert HTML string to PNG screenshot Fully renders a website and returns a PNG (screenshot) of the HTML.
-
#convert_web_html_to_txt(input, opts = {}) ⇒ HtmlToTextResponse
Convert HTML string to text (txt) Converts an HTML string input into text (txt); extracts text from HTML.
-
#convert_web_html_to_txt_with_http_info(input, opts = {}) ⇒ Array<(HtmlToTextResponse, Fixnum, Hash)>
Convert HTML string to text (txt) Converts an HTML string input into text (txt); extracts text from HTML.
-
#convert_web_md_to_html(input_file, opts = {}) ⇒ HtmlMdResult
Convert Markdown to HTML Convert a markdown file (.md) to HTML.
-
#convert_web_md_to_html_with_http_info(input_file, opts = {}) ⇒ Array<(HtmlMdResult, Fixnum, Hash)>
Convert Markdown to HTML Convert a markdown file (.md) to HTML.
-
#convert_web_url_to_pdf(input, opts = {}) ⇒ String
Convert a URL to PDF Fully renders a website and returns a PDF of the full page.
-
#convert_web_url_to_pdf_with_http_info(input, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Convert a URL to PDF Fully renders a website and returns a PDF of the full page.
-
#convert_web_url_to_screenshot(input, opts = {}) ⇒ String
Take screenshot of URL Fully renders a website and returns a PNG screenshot of the full page image.
-
#convert_web_url_to_screenshot_with_http_info(input, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Take screenshot of URL Fully renders a website and returns a PNG screenshot of the full page image.
-
#convert_web_url_to_txt(input, opts = {}) ⇒ UrlToTextResponse
Convert website URL page to text (txt) Converts a website URL page into text (txt); extracts text from HTML.
-
#convert_web_url_to_txt_with_http_info(input, opts = {}) ⇒ Array<(UrlToTextResponse, Fixnum, Hash)>
Convert website URL page to text (txt) Converts a website URL page into text (txt); extracts text from HTML.
-
#initialize(api_client = ApiClient.default) ⇒ ConvertWebApi
constructor
A new instance of ConvertWebApi.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ ConvertWebApi
Returns a new instance of ConvertWebApi.
19 20 21 |
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#convert_web_html_to_docx(input_request, opts = {}) ⇒ String
Convert HTML to Word DOCX Document Convert HTML to Office Word Document (DOCX) format
27 28 29 30 |
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 27 def convert_web_html_to_docx(input_request, opts = {}) data, _status_code, _headers = convert_web_html_to_docx_with_http_info(input_request, opts) data end |
#convert_web_html_to_docx_with_http_info(input_request, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Convert HTML to Word DOCX Document Convert HTML to Office Word Document (DOCX) format
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 37 def convert_web_html_to_docx_with_http_info(input_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ConvertWebApi.convert_web_html_to_docx ...' end # verify the required parameter 'input_request' is set if @api_client.config.client_side_validation && input_request.nil? fail ArgumentError, "Missing the required parameter 'input_request' when calling ConvertWebApi.convert_web_html_to_docx" end # resource path local_var_path = '/convert/html/to/docx' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(input_request) auth_names = ['Apikey'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'String') if @api_client.config.debugging @api_client.config.logger.debug "API called: ConvertWebApi#convert_web_html_to_docx\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#convert_web_html_to_pdf(input, opts = {}) ⇒ String
Convert HTML string to PDF Fully renders a website and returns a PDF of the HTML. Javascript, HTML5, CSS and other advanced features are all supported.
81 82 83 84 |
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 81 def convert_web_html_to_pdf(input, opts = {}) data, _status_code, _headers = convert_web_html_to_pdf_with_http_info(input, opts) data end |
#convert_web_html_to_pdf_with_http_info(input, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Convert HTML string to PDF Fully renders a website and returns a PDF of the HTML. Javascript, HTML5, CSS and other advanced features are all supported.
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 |
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 91 def convert_web_html_to_pdf_with_http_info(input, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ConvertWebApi.convert_web_html_to_pdf ...' end # verify the required parameter 'input' is set if @api_client.config.client_side_validation && input.nil? fail ArgumentError, "Missing the required parameter 'input' when calling ConvertWebApi.convert_web_html_to_pdf" end # resource path local_var_path = '/convert/web/html/to/pdf' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(input) auth_names = ['Apikey'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'String') if @api_client.config.debugging @api_client.config.logger.debug "API called: ConvertWebApi#convert_web_html_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#convert_web_html_to_png(input, opts = {}) ⇒ String
Convert HTML string to PNG screenshot Fully renders a website and returns a PNG (screenshot) of the HTML. Javascript, HTML5, CSS and other advanced features are all supported.
135 136 137 138 |
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 135 def convert_web_html_to_png(input, opts = {}) data, _status_code, _headers = convert_web_html_to_png_with_http_info(input, opts) data end |
#convert_web_html_to_png_with_http_info(input, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Convert HTML string to PNG screenshot Fully renders a website and returns a PNG (screenshot) of the HTML. Javascript, HTML5, CSS and other advanced features are all supported.
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 |
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 145 def convert_web_html_to_png_with_http_info(input, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ConvertWebApi.convert_web_html_to_png ...' end # verify the required parameter 'input' is set if @api_client.config.client_side_validation && input.nil? fail ArgumentError, "Missing the required parameter 'input' when calling ConvertWebApi.convert_web_html_to_png" end # resource path local_var_path = '/convert/web/html/to/png' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(input) auth_names = ['Apikey'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'String') if @api_client.config.debugging @api_client.config.logger.debug "API called: ConvertWebApi#convert_web_html_to_png\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#convert_web_html_to_txt(input, opts = {}) ⇒ HtmlToTextResponse
Convert HTML string to text (txt) Converts an HTML string input into text (txt); extracts text from HTML
189 190 191 192 |
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 189 def convert_web_html_to_txt(input, opts = {}) data, _status_code, _headers = convert_web_html_to_txt_with_http_info(input, opts) data end |
#convert_web_html_to_txt_with_http_info(input, opts = {}) ⇒ Array<(HtmlToTextResponse, Fixnum, Hash)>
Convert HTML string to text (txt) Converts an HTML string input into text (txt); extracts text from HTML
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 |
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 199 def convert_web_html_to_txt_with_http_info(input, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ConvertWebApi.convert_web_html_to_txt ...' end # verify the required parameter 'input' is set if @api_client.config.client_side_validation && input.nil? fail ArgumentError, "Missing the required parameter 'input' when calling ConvertWebApi.convert_web_html_to_txt" end # resource path local_var_path = '/convert/web/html/to/txt' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(input) auth_names = ['Apikey'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'HtmlToTextResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: ConvertWebApi#convert_web_html_to_txt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#convert_web_md_to_html(input_file, opts = {}) ⇒ HtmlMdResult
Convert Markdown to HTML Convert a markdown file (.md) to HTML
243 244 245 246 |
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 243 def convert_web_md_to_html(input_file, opts = {}) data, _status_code, _headers = convert_web_md_to_html_with_http_info(input_file, opts) data end |
#convert_web_md_to_html_with_http_info(input_file, opts = {}) ⇒ Array<(HtmlMdResult, Fixnum, Hash)>
Convert Markdown to HTML Convert a markdown file (.md) to HTML
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 |
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 253 def convert_web_md_to_html_with_http_info(input_file, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ConvertWebApi.convert_web_md_to_html ...' end # verify the required parameter 'input_file' is set if @api_client.config.client_side_validation && input_file.nil? fail ArgumentError, "Missing the required parameter 'input_file' when calling ConvertWebApi.convert_web_md_to_html" end # resource path local_var_path = '/convert/web/md/to/html' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data']) # form parameters form_params = {} form_params['inputFile'] = input_file # http body (model) post_body = nil auth_names = ['Apikey'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'HtmlMdResult') if @api_client.config.debugging @api_client.config.logger.debug "API called: ConvertWebApi#convert_web_md_to_html\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#convert_web_url_to_pdf(input, opts = {}) ⇒ String
Convert a URL to PDF Fully renders a website and returns a PDF of the full page. Javascript, HTML5, CSS and other advanced features are all supported.
298 299 300 301 |
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 298 def convert_web_url_to_pdf(input, opts = {}) data, _status_code, _headers = convert_web_url_to_pdf_with_http_info(input, opts) data end |
#convert_web_url_to_pdf_with_http_info(input, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Convert a URL to PDF Fully renders a website and returns a PDF of the full page. Javascript, HTML5, CSS and other advanced features are all supported.
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 |
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 308 def convert_web_url_to_pdf_with_http_info(input, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ConvertWebApi.convert_web_url_to_pdf ...' end # verify the required parameter 'input' is set if @api_client.config.client_side_validation && input.nil? fail ArgumentError, "Missing the required parameter 'input' when calling ConvertWebApi.convert_web_url_to_pdf" end # resource path local_var_path = '/convert/web/url/to/pdf' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(input) auth_names = ['Apikey'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'String') if @api_client.config.debugging @api_client.config.logger.debug "API called: ConvertWebApi#convert_web_url_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#convert_web_url_to_screenshot(input, opts = {}) ⇒ String
Take screenshot of URL Fully renders a website and returns a PNG screenshot of the full page image. Javascript, HTML5, CSS and other advanced features are all supported.
352 353 354 355 |
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 352 def convert_web_url_to_screenshot(input, opts = {}) data, _status_code, _headers = convert_web_url_to_screenshot_with_http_info(input, opts) data end |
#convert_web_url_to_screenshot_with_http_info(input, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Take screenshot of URL Fully renders a website and returns a PNG screenshot of the full page image. Javascript, HTML5, CSS and other advanced features are all supported.
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 |
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 362 def convert_web_url_to_screenshot_with_http_info(input, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ConvertWebApi.convert_web_url_to_screenshot ...' end # verify the required parameter 'input' is set if @api_client.config.client_side_validation && input.nil? fail ArgumentError, "Missing the required parameter 'input' when calling ConvertWebApi.convert_web_url_to_screenshot" end # resource path local_var_path = '/convert/web/url/to/screenshot' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(input) auth_names = ['Apikey'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'String') if @api_client.config.debugging @api_client.config.logger.debug "API called: ConvertWebApi#convert_web_url_to_screenshot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#convert_web_url_to_txt(input, opts = {}) ⇒ UrlToTextResponse
Convert website URL page to text (txt) Converts a website URL page into text (txt); extracts text from HTML
406 407 408 409 |
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 406 def convert_web_url_to_txt(input, opts = {}) data, _status_code, _headers = convert_web_url_to_txt_with_http_info(input, opts) data end |
#convert_web_url_to_txt_with_http_info(input, opts = {}) ⇒ Array<(UrlToTextResponse, Fixnum, Hash)>
Convert website URL page to text (txt) Converts a website URL page into text (txt); extracts text from HTML
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 |
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 416 def convert_web_url_to_txt_with_http_info(input, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ConvertWebApi.convert_web_url_to_txt ...' end # verify the required parameter 'input' is set if @api_client.config.client_side_validation && input.nil? fail ArgumentError, "Missing the required parameter 'input' when calling ConvertWebApi.convert_web_url_to_txt" end # resource path local_var_path = '/convert/web/url/to/txt' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(input) auth_names = ['Apikey'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'UrlToTextResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: ConvertWebApi#convert_web_url_to_txt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |