Class: CloudmersiveConvertApiClient::ConvertWebApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-convert-api-client/api/convert_web_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

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

Parameters:

  • input_request —

    HTL input to convert to DOCX

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


28
29
30
31
 
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 28

def convert_web_html_to_docx(input_request, opts = {})
  data, _status_code, _headers = convert_web_html_to_docx_with_http_info(input_request, opts)
  return 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

Parameters:

  • input_request —

    HTL input to convert to DOCX

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



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
76
 
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 38

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.

Parameters:

  • input —

    HTML to PDF request parameters

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


83
84
85
86
 
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 83

def convert_web_html_to_pdf(input, opts = {})
  data, _status_code, _headers = convert_web_html_to_pdf_with_http_info(input, opts)
  return 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.

Parameters:

  • input —

    HTML to PDF request parameters

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



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
130
131
 
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 93

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 = {}) ⇒ Object

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.

Parameters:

  • input —

    HTML to PNG request parameters

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


138
139
140
141
 
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 138

def convert_web_html_to_png(input, opts = {})
  data, _status_code, _headers = convert_web_html_to_png_with_http_info(input, opts)
  return data
end

#convert_web_html_to_png_with_http_info(input, opts = {}) ⇒ Array<(Object, 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.

Parameters:

  • input —

    HTML to PNG request parameters

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Fixnum, Hash)>) —

    Object data, response status code and response headers



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
184
185
186
 
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 148

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 => 'Object')
  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

Parameters:

  • input —

    HTML to Text request parameters

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



193
194
195
196
 
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 193

def convert_web_html_to_txt(input, opts = {})
  data, _status_code, _headers = convert_web_html_to_txt_with_http_info(input, opts)
  return 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

Parameters:

  • input —

    HTML to Text request parameters

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HtmlToTextResponse, Fixnum, Hash)>) —

    HtmlToTextResponse data, response status code and response headers



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
238
239
240
241
 
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 203

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

Parameters:

  • input_file —

    Input file to perform the operation on.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



248
249
250
251
 
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 248

def convert_web_md_to_html(input_file, opts = {})
  data, _status_code, _headers = convert_web_md_to_html_with_http_info(input_file, opts)
  return 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

Parameters:

  • input_file —

    Input file to perform the operation on.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HtmlMdResult, Fixnum, Hash)>) —

    HtmlMdResult data, response status code and response headers



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
293
294
295
296
297
 
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 258

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.

Parameters:

  • input —

    URL to PDF request parameters

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


304
305
306
307
 
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 304

def convert_web_url_to_pdf(input, opts = {})
  data, _status_code, _headers = convert_web_url_to_pdf_with_http_info(input, opts)
  return 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.

Parameters:

  • input —

    URL to PDF request parameters

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



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
347
348
349
350
351
352
 
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 314

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.

Parameters:

  • input —

    Screenshot request parameters

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


359
360
361
362
 
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 359

def convert_web_url_to_screenshot(input, opts = {})
  data, _status_code, _headers = convert_web_url_to_screenshot_with_http_info(input, opts)
  return 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.

Parameters:

  • input —

    Screenshot request parameters

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



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
401
402
403
404
405
406
407
 
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 369

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

Parameters:

  • input —

    HTML to Text request parameters

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



414
415
416
417
 
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 414

def convert_web_url_to_txt(input, opts = {})
  data, _status_code, _headers = convert_web_url_to_txt_with_http_info(input, opts)
  return 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

Parameters:

  • input —

    HTML to Text request parameters

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(UrlToTextResponse, Fixnum, Hash)>) —

    UrlToTextResponse data, response status code and response headers



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
455
456
457
458
459
460
461
462
 
# File 'lib/cloudmersive-convert-api-client/api/convert_web_api.rb', line 424

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