Class: CloudmersiveConvertApiClient::EditHtmlApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EditHtmlApi

Returns a new instance of EditHtmlApi.



19
20
21
 
# File 'lib/cloudmersive-convert-api-client/api/edit_html_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/edit_html_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#edit_html_html_append_header_tag(html_tag, opts = {}) ⇒ String

Append an HTML tag to the HEAD section of an HTML Document Appends an HTML tag to the HEAD section of an HTML document.

Parameters:

  • html_tag —

    The HTML tag to append.

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

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input.

Returns:

  • (String) 


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

def edit_html_html_append_header_tag(html_tag, opts = {})
  data, _status_code, _headers = edit_html_html_append_header_tag_with_http_info(html_tag, opts)
  data
end

#edit_html_html_append_header_tag_with_http_info(html_tag, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Append an HTML tag to the HEAD section of an HTML Document Appends an HTML tag to the HEAD section of an HTML document.

Parameters:

  • html_tag —

    The HTML tag to append.

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

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input.

Returns:

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

    String data, response status code and response headers



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
77
78
79
80
 
# File 'lib/cloudmersive-convert-api-client/api/edit_html_api.rb', line 41

def edit_html_html_append_header_tag_with_http_info(html_tag, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_append_header_tag ...'
  end
  # verify the required parameter 'html_tag' is set
  if @api_client.config.client_side_validation && html_tag.nil?
    fail ArgumentError, "Missing the required parameter 'html_tag' when calling EditHtmlApi.edit_html_html_append_header_tag"
  end
  # resource path
  local_var_path = '/convert/edit/html/head/append/tag'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  header_params[:'htmlTag'] = html_tag
  header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?

  # form parameters
  form_params = {}
  form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?

  # 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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_append_header_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_html_html_append_heading(heading_text, opts = {}) ⇒ String

Append a Heading to an HTML Document Appends a heading to the end of an HTML document.

Parameters:

  • heading_text —

    The text content to be used in the header.

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

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input.

  • :heading_size (Integer) —

    Optional: The heading size number. Default is 1. Accepts values between 1 and 6.

  • :css_style (String) —

    Optional: The CSS style for the heading.

Returns:

  • (String) 


90
91
92
93
 
# File 'lib/cloudmersive-convert-api-client/api/edit_html_api.rb', line 90

def edit_html_html_append_heading(heading_text, opts = {})
  data, _status_code, _headers = edit_html_html_append_heading_with_http_info(heading_text, opts)
  data
end

#edit_html_html_append_heading_with_http_info(heading_text, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Append a Heading to an HTML Document Appends a heading to the end of an HTML document.

Parameters:

  • heading_text —

    The text content to be used in the header.

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

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input.

  • :heading_size (Integer) —

    Optional: The heading size number. Default is 1. Accepts values between 1 and 6.

  • :css_style (String) —

    Optional: The CSS style for the heading.

Returns:

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

    String data, response status code and response headers



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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/cloudmersive-convert-api-client/api/edit_html_api.rb', line 104

def edit_html_html_append_heading_with_http_info(heading_text, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_append_heading ...'
  end
  # verify the required parameter 'heading_text' is set
  if @api_client.config.client_side_validation && heading_text.nil?
    fail ArgumentError, "Missing the required parameter 'heading_text' when calling EditHtmlApi.edit_html_html_append_heading"
  end
  # resource path
  local_var_path = '/convert/edit/html/append/heading'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  header_params[:'headingText'] = heading_text
  header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?
  header_params[:'headingSize'] = opts[:'heading_size'] if !opts[:'heading_size'].nil?
  header_params[:'cssStyle'] = opts[:'css_style'] if !opts[:'css_style'].nil?

  # form parameters
  form_params = {}
  form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?

  # 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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_append_heading\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_html_html_append_image_from_url(image_url, opts = {}) ⇒ String

Append an Image to an HTML Document from a URL Appends an image to the end of an HTML document using a URL.

Parameters:

  • image_url —

    The URL for the image.

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

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input.

  • :css_style (String) —

    Optional: CSS style for the image.

Returns:

  • (String) 


154
155
156
157
 
# File 'lib/cloudmersive-convert-api-client/api/edit_html_api.rb', line 154

def edit_html_html_append_image_from_url(image_url, opts = {})
  data, _status_code, _headers = edit_html_html_append_image_from_url_with_http_info(image_url, opts)
  data
end

#edit_html_html_append_image_from_url_with_http_info(image_url, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Append an Image to an HTML Document from a URL Appends an image to the end of an HTML document using a URL.

Parameters:

  • image_url —

    The URL for the image.

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

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input.

  • :css_style (String) —

    Optional: CSS style for the image.

Returns:

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

    String data, response status code and response headers



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/cloudmersive-convert-api-client/api/edit_html_api.rb', line 167

def edit_html_html_append_image_from_url_with_http_info(image_url, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_append_image_from_url ...'
  end
  # verify the required parameter 'image_url' is set
  if @api_client.config.client_side_validation && image_url.nil?
    fail ArgumentError, "Missing the required parameter 'image_url' when calling EditHtmlApi.edit_html_html_append_image_from_url"
  end
  # resource path
  local_var_path = '/convert/edit/html/append/image/from-url'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  header_params[:'imageUrl'] = image_url
  header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?
  header_params[:'cssStyle'] = opts[:'css_style'] if !opts[:'css_style'].nil?

  # form parameters
  form_params = {}
  form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?

  # 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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_append_image_from_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_html_html_append_image_inline(opts = {}) ⇒ String

Append a Base64 Inline Image to an HTML Document Appends a base64 inline image to the end of an HTML document from an input file or URL.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input.

  • :image_file (File) —

    Optional: Image file to be appended as base64 inline image.

  • :image_url (String) —

    Optional: Image URL to be appended as base64 inline image.

  • :css_style (String) —

    Optional: CSS style for the image.

  • :image_extension (String) —

    Optional: The extension (JPG, PNG, GIF, etc.) of the image file. Recommended if uploading an imageFile directly, instead of using imageUrl. If no extension can be determined, will default to JPG.

Returns:

  • (String) 


218
219
220
221
 
# File 'lib/cloudmersive-convert-api-client/api/edit_html_api.rb', line 218

def edit_html_html_append_image_inline(opts = {})
  data, _status_code, _headers = edit_html_html_append_image_inline_with_http_info(opts)
  data
end

#edit_html_html_append_image_inline_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Append a Base64 Inline Image to an HTML Document Appends a base64 inline image to the end of an HTML document from an input file or URL.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input.

  • :image_file (File) —

    Optional: Image file to be appended as base64 inline image.

  • :image_url (String) —

    Optional: Image URL to be appended as base64 inline image.

  • :css_style (String) —

    Optional: CSS style for the image.

  • :image_extension (String) —

    Optional: The extension (JPG, PNG, GIF, etc.) of the image file. Recommended if uploading an imageFile directly, instead of using imageUrl. If no extension can be determined, will default to JPG.

Returns:

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

    String data, response status code and response headers



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/cloudmersive-convert-api-client/api/edit_html_api.rb', line 233

def edit_html_html_append_image_inline_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_append_image_inline ...'
  end
  # resource path
  local_var_path = '/convert/edit/html/append/image/inline'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
  header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?
  header_params[:'imageUrl'] = opts[:'image_url'] if !opts[:'image_url'].nil?
  header_params[:'cssStyle'] = opts[:'css_style'] if !opts[:'css_style'].nil?
  header_params[:'imageExtension'] = opts[:'image_extension'] if !opts[:'image_extension'].nil?

  # form parameters
  form_params = {}
  form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?
  form_params['imageFile'] = opts[:'image_file'] if !opts[:'image_file'].nil?

  # 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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_append_image_inline\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_html_html_append_paragraph(paragraph_text, opts = {}) ⇒ String

Append a Paragraph to an HTML Document Appends a paragraph to the end of an HTML document.

Parameters:

  • paragraph_text —

    The text content to be used in the paragraph.

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

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input.

  • :css_style (String) —

    Optional: The CSS style for the paragraph.

Returns:

  • (String) 


282
283
284
285
 
# File 'lib/cloudmersive-convert-api-client/api/edit_html_api.rb', line 282

def edit_html_html_append_paragraph(paragraph_text, opts = {})
  data, _status_code, _headers = edit_html_html_append_paragraph_with_http_info(paragraph_text, opts)
  data
end

#edit_html_html_append_paragraph_with_http_info(paragraph_text, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Append a Paragraph to an HTML Document Appends a paragraph to the end of an HTML document.

Parameters:

  • paragraph_text —

    The text content to be used in the paragraph.

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

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input.

  • :css_style (String) —

    Optional: The CSS style for the paragraph.

Returns:

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

    String data, response status code and response headers



295
296
297
298
299
300
301
302
303
304
305
306
307
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
 
# File 'lib/cloudmersive-convert-api-client/api/edit_html_api.rb', line 295

def edit_html_html_append_paragraph_with_http_info(paragraph_text, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_append_paragraph ...'
  end
  # verify the required parameter 'paragraph_text' is set
  if @api_client.config.client_side_validation && paragraph_text.nil?
    fail ArgumentError, "Missing the required parameter 'paragraph_text' when calling EditHtmlApi.edit_html_html_append_paragraph"
  end
  # resource path
  local_var_path = '/convert/edit/html/append/paragraph'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  header_params[:'paragraphText'] = paragraph_text
  header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?
  header_params[:'cssStyle'] = opts[:'css_style'] if !opts[:'css_style'].nil?

  # form parameters
  form_params = {}
  form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?

  # 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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_append_paragraph\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_html_html_create_blank_document(opts = {}) ⇒ String

Create a Blank HTML Document Returns a blank HTML Document format file. The file is blank, with no contents by default. Use the optional input parameters to add various starting elements. Use additional editing commands such as Append Header, Append Paragraph or Append Image from URL to populate the document.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :title (String) —

    Optional: The title of the HTML document

  • :css_url (String) —

    Optional: A CSS style URL to be added to the document.

  • :css_inline (String) —

    Optional: An inline CSS style to be added to the document.

  • :javascript_url (String) —

    Optional: Javascript URL to be added to the document.

  • :javascript_inline (String) —

    Optional: Inline Javascript to be added to the document.

Returns:

  • (String) 


345
346
347
348
 
# File 'lib/cloudmersive-convert-api-client/api/edit_html_api.rb', line 345

def edit_html_html_create_blank_document(opts = {})
  data, _status_code, _headers = edit_html_html_create_blank_document_with_http_info(opts)
  data
end

#edit_html_html_create_blank_document_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Create a Blank HTML Document Returns a blank HTML Document format file. The file is blank, with no contents by default. Use the optional input parameters to add various starting elements. Use additional editing commands such as Append Header, Append Paragraph or Append Image from URL to populate the document.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :title (String) —

    Optional: The title of the HTML document

  • :css_url (String) —

    Optional: A CSS style URL to be added to the document.

  • :css_inline (String) —

    Optional: An inline CSS style to be added to the document.

  • :javascript_url (String) —

    Optional: Javascript URL to be added to the document.

  • :javascript_inline (String) —

    Optional: Inline Javascript to be added to the document.

Returns:

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

    String data, response status code and response headers



359
360
361
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
 
# File 'lib/cloudmersive-convert-api-client/api/edit_html_api.rb', line 359

def edit_html_html_create_blank_document_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_create_blank_document ...'
  end
  # resource path
  local_var_path = '/convert/edit/html/create/blank'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  header_params[:'title'] = opts[:'title'] if !opts[:'title'].nil?
  header_params[:'cssUrl'] = opts[:'css_url'] if !opts[:'css_url'].nil?
  header_params[:'cssInline'] = opts[:'css_inline'] if !opts[:'css_inline'].nil?
  header_params[:'javascriptUrl'] = opts[:'javascript_url'] if !opts[:'javascript_url'].nil?
  header_params[:'javascriptInline'] = opts[:'javascript_inline'] if !opts[:'javascript_inline'].nil?

  # form parameters
  form_params = {}

  # 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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_create_blank_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_html_html_get_language(opts = {}) ⇒ HtmlGetLanguageResult

Gets the language for the HTML document Retrieves the language code (e.g. "en" or "de") of an HTML document.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input.

Returns:



403
404
405
406
 
# File 'lib/cloudmersive-convert-api-client/api/edit_html_api.rb', line 403

def edit_html_html_get_language(opts = {})
  data, _status_code, _headers = edit_html_html_get_language_with_http_info(opts)
  data
end

#edit_html_html_get_language_with_http_info(opts = {}) ⇒ Array<(HtmlGetLanguageResult, Fixnum, Hash)>

Gets the language for the HTML document Retrieves the language code (e.g. &quot;en&quot; or &quot;de&quot;) of an HTML document.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input.

Returns:

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

    HtmlGetLanguageResult data, response status code and response headers



414
415
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
 
# File 'lib/cloudmersive-convert-api-client/api/edit_html_api.rb', line 414

def edit_html_html_get_language_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_get_language ...'
  end
  # resource path
  local_var_path = '/convert/edit/html/head/get/language'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?

  # form parameters
  form_params = {}
  form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?

  # 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 => 'HtmlGetLanguageResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_get_language\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_html_html_get_links(opts = {}) ⇒ HtmlGetLinksResponse

Extract resolved link URLs from HTML File Extracts the resolved link URLs, fully-qualified if possible, from an input HTML file.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input.

  • :base_url (String) —

    Optional: Base URL of the page, such as mydomain.com

Returns:



456
457
458
459
 
# File 'lib/cloudmersive-convert-api-client/api/edit_html_api.rb', line 456

def edit_html_html_get_links(opts = {})
  data, _status_code, _headers = edit_html_html_get_links_with_http_info(opts)
  data
end

#edit_html_html_get_links_with_http_info(opts = {}) ⇒ Array<(HtmlGetLinksResponse, Fixnum, Hash)>

Extract resolved link URLs from HTML File Extracts the resolved link URLs, fully-qualified if possible, from an input HTML file.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input.

  • :base_url (String) —

    Optional: Base URL of the page, such as mydomain.com

Returns:

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

    HtmlGetLinksResponse data, response status code and response headers



468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/cloudmersive-convert-api-client/api/edit_html_api.rb', line 468

def edit_html_html_get_links_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_get_links ...'
  end
  # resource path
  local_var_path = '/convert/edit/html/extract/links'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?
  header_params[:'baseUrl'] = opts[:'base_url'] if !opts[:'base_url'].nil?

  # form parameters
  form_params = {}
  form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?

  # 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 => 'HtmlGetLinksResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_get_links\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_html_html_get_rel_canonical(opts = {}) ⇒ HtmlGetRelCanonicalUrlResult

Gets the rel canonical URL for the HTML document Gets the rel canonical URL of an HTML document.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input.

Returns:



510
511
512
513
 
# File 'lib/cloudmersive-convert-api-client/api/edit_html_api.rb', line 510

def edit_html_html_get_rel_canonical(opts = {})
  data, _status_code, _headers = edit_html_html_get_rel_canonical_with_http_info(opts)
  data
end

#edit_html_html_get_rel_canonical_with_http_info(opts = {}) ⇒ Array<(HtmlGetRelCanonicalUrlResult, Fixnum, Hash)>

Gets the rel canonical URL for the HTML document Gets the rel canonical URL of an HTML document.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input.

Returns:



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
 
# File 'lib/cloudmersive-convert-api-client/api/edit_html_api.rb', line 521

def edit_html_html_get_rel_canonical_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_get_rel_canonical ...'
  end
  # resource path
  local_var_path = '/convert/edit/html/head/get/rel-canonical-url'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?

  # form parameters
  form_params = {}
  form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?

  # 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 => 'HtmlGetRelCanonicalUrlResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_get_rel_canonical\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_html_html_get_sitemap(opts = {}) ⇒ HtmlGetSitemapUrlResult

Gets the sitemap URL for the HTML document Gets the sitemap link URL of an HTML document.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input.

Returns:



562
563
564
565
 
# File 'lib/cloudmersive-convert-api-client/api/edit_html_api.rb', line 562

def edit_html_html_get_sitemap(opts = {})
  data, _status_code, _headers = edit_html_html_get_sitemap_with_http_info(opts)
  data
end

#edit_html_html_get_sitemap_with_http_info(opts = {}) ⇒ Array<(HtmlGetSitemapUrlResult, Fixnum, Hash)>

Gets the sitemap URL for the HTML document Gets the sitemap link URL of an HTML document.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input.

Returns:

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

    HtmlGetSitemapUrlResult data, response status code and response headers



573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
 
# File 'lib/cloudmersive-convert-api-client/api/edit_html_api.rb', line 573

def edit_html_html_get_sitemap_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_get_sitemap ...'
  end
  # resource path
  local_var_path = '/convert/edit/html/head/get/sitemap-url'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?

  # form parameters
  form_params = {}
  form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?

  # 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 => 'HtmlGetSitemapUrlResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_get_sitemap\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_html_html_set_language(language_code, opts = {}) ⇒ String

Sets the language for the HTML document Sets the language code of an HTML document.

Parameters:

  • language_code —

    The HTML langauge code to set.

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

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input.

Returns:

  • (String) 


615
616
617
618
 
# File 'lib/cloudmersive-convert-api-client/api/edit_html_api.rb', line 615

def edit_html_html_set_language(language_code, opts = {})
  data, _status_code, _headers = edit_html_html_set_language_with_http_info(language_code, opts)
  data
end

#edit_html_html_set_language_with_http_info(language_code, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Sets the language for the HTML document Sets the language code of an HTML document.

Parameters:

  • language_code —

    The HTML langauge code to set.

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

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input.

Returns:

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

    String data, response status code and response headers



627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
 
# File 'lib/cloudmersive-convert-api-client/api/edit_html_api.rb', line 627

def edit_html_html_set_language_with_http_info(language_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_set_language ...'
  end
  # verify the required parameter 'language_code' is set
  if @api_client.config.client_side_validation && language_code.nil?
    fail ArgumentError, "Missing the required parameter 'language_code' when calling EditHtmlApi.edit_html_html_set_language"
  end
  # resource path
  local_var_path = '/convert/edit/html/head/set/language'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  header_params[:'languageCode'] = language_code
  header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?

  # form parameters
  form_params = {}
  form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?

  # 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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_set_language\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_html_html_set_rel_canonical(canonical_url, opts = {}) ⇒ String

Sets the rel canonical URL for the HTML document 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.

Parameters:

  • canonical_url —

    The HTML canonical URL to set.

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

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input.

Returns:

  • (String) 


674
675
676
677
 
# File 'lib/cloudmersive-convert-api-client/api/edit_html_api.rb', line 674

def edit_html_html_set_rel_canonical(canonical_url, opts = {})
  data, _status_code, _headers = edit_html_html_set_rel_canonical_with_http_info(canonical_url, opts)
  data
end

#edit_html_html_set_rel_canonical_with_http_info(canonical_url, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Sets the rel canonical URL for the HTML document 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.

Parameters:

  • canonical_url —

    The HTML canonical URL to set.

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

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input.

Returns:

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

    String data, response status code and response headers



686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
 
# File 'lib/cloudmersive-convert-api-client/api/edit_html_api.rb', line 686

def edit_html_html_set_rel_canonical_with_http_info(canonical_url, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_set_rel_canonical ...'
  end
  # verify the required parameter 'canonical_url' is set
  if @api_client.config.client_side_validation && canonical_url.nil?
    fail ArgumentError, "Missing the required parameter 'canonical_url' when calling EditHtmlApi.edit_html_html_set_rel_canonical"
  end
  # resource path
  local_var_path = '/convert/edit/html/head/set/rel-canonical-url'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  header_params[:'canonicalUrl'] = canonical_url
  header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?

  # form parameters
  form_params = {}
  form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?

  # 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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_set_rel_canonical\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_html_html_set_sitemap_url(sitemap_url, opts = {}) ⇒ String

Sets the sitemap URL for the HTML document Sets the sitemap URL of an HTML document.

Parameters:

  • sitemap_url —

    The HTML sitemap URL to set.

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

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input.

Returns:

  • (String) 


733
734
735
736
 
# File 'lib/cloudmersive-convert-api-client/api/edit_html_api.rb', line 733

def edit_html_html_set_sitemap_url(sitemap_url, opts = {})
  data, _status_code, _headers = edit_html_html_set_sitemap_url_with_http_info(sitemap_url, opts)
  data
end

#edit_html_html_set_sitemap_url_with_http_info(sitemap_url, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Sets the sitemap URL for the HTML document Sets the sitemap URL of an HTML document.

Parameters:

  • sitemap_url —

    The HTML sitemap URL to set.

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

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input.

Returns:

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

    String data, response status code and response headers



745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
 
# File 'lib/cloudmersive-convert-api-client/api/edit_html_api.rb', line 745

def edit_html_html_set_sitemap_url_with_http_info(sitemap_url, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditHtmlApi.edit_html_html_set_sitemap_url ...'
  end
  # verify the required parameter 'sitemap_url' is set
  if @api_client.config.client_side_validation && sitemap_url.nil?
    fail ArgumentError, "Missing the required parameter 'sitemap_url' when calling EditHtmlApi.edit_html_html_set_sitemap_url"
  end
  # resource path
  local_var_path = '/convert/edit/html/head/set/sitemap-url'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  header_params[:'sitemapUrl'] = sitemap_url
  header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?

  # form parameters
  form_params = {}
  form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?

  # 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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditHtmlApi#edit_html_html_set_sitemap_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end