cloudmersive-convert-api-client 2.1.8 → 2.1.9
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +14 -4
- data/docs/EditHtmlApi.md +418 -0
- data/docs/EditPdfApi.md +6 -2
- data/docs/HtmlGetLanguageResult.md +9 -0
- data/docs/HtmlGetRelCanonicalUrlResult.md +9 -0
- data/docs/HtmlGetSitemapUrlResult.md +9 -0
- data/docs/MergeDocumentApi.md +2 -2
- data/lib/cloudmersive-convert-api-client.rb +3 -0
- data/lib/cloudmersive-convert-api-client/api/edit_html_api.rb +392 -0
- data/lib/cloudmersive-convert-api-client/api/edit_pdf_api.rb +3 -0
- data/lib/cloudmersive-convert-api-client/api/merge_document_api.rb +3 -3
- data/lib/cloudmersive-convert-api-client/models/html_get_language_result.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/html_get_rel_canonical_url_result.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/html_get_sitemap_url_result.rb +196 -0
- data/lib/cloudmersive-convert-api-client/version.rb +1 -1
- data/spec/api/edit_html_api_spec.rb +95 -0
- data/spec/api/edit_pdf_api_spec.rb +1 -0
- data/spec/api/merge_document_api_spec.rb +1 -1
- data/spec/models/html_get_language_result_spec.rb +47 -0
- data/spec/models/html_get_rel_canonical_url_result_spec.rb +47 -0
- data/spec/models/html_get_sitemap_url_result_spec.rb +47 -0
- metadata +11 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 659e9f0154c2c76f66d7e7fb229f2f23b68ed143b9cd5adfde0a6569f64fd89a
|
4
|
+
data.tar.gz: 241e9b7ff13a8cf33e4395d91d25d2cb91de9e3e15cf8a04cd6a5a34e036dcc4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 003bb1287913e7a86029b377c6706d1089c655cf510c084cd8c2a2689037fb759649f2242809201af71a3f63224949c26dd96ac0b329cb28ef1f2543c5197f5b
|
7
|
+
data.tar.gz: d094f687a7fec4aa76881a258f785b7e49e5f65c9f093182b2d168d1b043bc28492ee87afa4b87969e6ce8af21655aece2699f0f13b000bcd68e664a3e9b4f33
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ Convert API lets you effortlessly convert file formats and types.
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: v1
|
10
|
-
- Package version: 2.1.
|
10
|
+
- Package version: 2.1.9
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,15 +23,15 @@ gem build cloudmersive-convert-api-client.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./cloudmersive-convert-api-client-2.1.
|
26
|
+
gem install ./cloudmersive-convert-api-client-2.1.9.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-convert-api-client-2.1.
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-convert-api-client-2.1.9.gem` to install the development dependencies)
|
29
29
|
|
30
30
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
31
|
|
32
32
|
Finally add this to the Gemfile:
|
33
33
|
|
34
|
-
gem 'cloudmersive-convert-api-client', '~> 2.1.
|
34
|
+
gem 'cloudmersive-convert-api-client', '~> 2.1.9'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -260,12 +260,19 @@ Class | Method | HTTP request | Description
|
|
260
260
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_rename_worksheet**](docs/EditDocumentApi.md#edit_document_xlsx_rename_worksheet) | **POST** /convert/edit/xlsx/rename-worksheet | Rename a specific worksheet in a Excel XLSX spreadsheet
|
261
261
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_set_cell_by_identifier**](docs/EditDocumentApi.md#edit_document_xlsx_set_cell_by_identifier) | **POST** /convert/edit/xlsx/set-cell/by-identifier | Set, update cell contents in an Excel XLSX spreadsheet, worksheet by cell identifier
|
262
262
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_set_cell_by_index**](docs/EditDocumentApi.md#edit_document_xlsx_set_cell_by_index) | **POST** /convert/edit/xlsx/set-cell/by-index | Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index
|
263
|
+
*CloudmersiveConvertApiClient::EditHtmlApi* | [**edit_html_html_append_header_tag**](docs/EditHtmlApi.md#edit_html_html_append_header_tag) | **POST** /convert/edit/html/head/append/tag | Append an HTML tag to the HEAD section of an HTML Document
|
263
264
|
*CloudmersiveConvertApiClient::EditHtmlApi* | [**edit_html_html_append_heading**](docs/EditHtmlApi.md#edit_html_html_append_heading) | **POST** /convert/edit/html/append/heading | Append a Heading to an HTML Document
|
264
265
|
*CloudmersiveConvertApiClient::EditHtmlApi* | [**edit_html_html_append_image_from_url**](docs/EditHtmlApi.md#edit_html_html_append_image_from_url) | **POST** /convert/edit/html/append/image/from-url | Append an Image to an HTML Document from a URL
|
265
266
|
*CloudmersiveConvertApiClient::EditHtmlApi* | [**edit_html_html_append_image_inline**](docs/EditHtmlApi.md#edit_html_html_append_image_inline) | **POST** /convert/edit/html/append/image/inline | Append a Base64 Inline Image to an HTML Document
|
266
267
|
*CloudmersiveConvertApiClient::EditHtmlApi* | [**edit_html_html_append_paragraph**](docs/EditHtmlApi.md#edit_html_html_append_paragraph) | **POST** /convert/edit/html/append/paragraph | Append a Paragraph to an HTML Document
|
267
268
|
*CloudmersiveConvertApiClient::EditHtmlApi* | [**edit_html_html_create_blank_document**](docs/EditHtmlApi.md#edit_html_html_create_blank_document) | **POST** /convert/edit/html/create/blank | Create a Blank HTML Document
|
269
|
+
*CloudmersiveConvertApiClient::EditHtmlApi* | [**edit_html_html_get_language**](docs/EditHtmlApi.md#edit_html_html_get_language) | **POST** /convert/edit/html/head/get/language | Gets the language for the HTML document
|
268
270
|
*CloudmersiveConvertApiClient::EditHtmlApi* | [**edit_html_html_get_links**](docs/EditHtmlApi.md#edit_html_html_get_links) | **POST** /convert/edit/html/extract/links | Extract resolved link URLs from HTML File
|
271
|
+
*CloudmersiveConvertApiClient::EditHtmlApi* | [**edit_html_html_get_rel_canonical**](docs/EditHtmlApi.md#edit_html_html_get_rel_canonical) | **POST** /convert/edit/html/head/get/rel-canonical-url | Gets the rel canonical URL for the HTML document
|
272
|
+
*CloudmersiveConvertApiClient::EditHtmlApi* | [**edit_html_html_get_sitemap**](docs/EditHtmlApi.md#edit_html_html_get_sitemap) | **POST** /convert/edit/html/head/get/sitemap-url | Gets the sitemap URL for the HTML document
|
273
|
+
*CloudmersiveConvertApiClient::EditHtmlApi* | [**edit_html_html_set_language**](docs/EditHtmlApi.md#edit_html_html_set_language) | **POST** /convert/edit/html/head/set/language | Sets the language for the HTML document
|
274
|
+
*CloudmersiveConvertApiClient::EditHtmlApi* | [**edit_html_html_set_rel_canonical**](docs/EditHtmlApi.md#edit_html_html_set_rel_canonical) | **POST** /convert/edit/html/head/set/rel-canonical-url | Sets the rel canonical URL for the HTML document
|
275
|
+
*CloudmersiveConvertApiClient::EditHtmlApi* | [**edit_html_html_set_sitemap_url**](docs/EditHtmlApi.md#edit_html_html_set_sitemap_url) | **POST** /convert/edit/html/head/set/sitemap-url | Sets the sitemap URL for the HTML document
|
269
276
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_add_annotations**](docs/EditPdfApi.md#edit_pdf_add_annotations) | **POST** /convert/edit/pdf/annotations/add-item | Add one or more PDF annotations, comments in the PDF document
|
270
277
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_convert_to_pdf_a**](docs/EditPdfApi.md#edit_pdf_convert_to_pdf_a) | **POST** /convert/edit/pdf/optimize/pdf-a | Convert a PDF file to PDF/A
|
271
278
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_decrypt**](docs/EditPdfApi.md#edit_pdf_decrypt) | **POST** /convert/edit/pdf/decrypt | Decrypt and password-protect a PDF
|
@@ -488,7 +495,10 @@ Class | Method | HTTP request | Description
|
|
488
495
|
- [CloudmersiveConvertApiClient::GetXlsxStylesResponse](docs/GetXlsxStylesResponse.md)
|
489
496
|
- [CloudmersiveConvertApiClient::GetXlsxWorksheetsRequest](docs/GetXlsxWorksheetsRequest.md)
|
490
497
|
- [CloudmersiveConvertApiClient::GetXlsxWorksheetsResponse](docs/GetXlsxWorksheetsResponse.md)
|
498
|
+
- [CloudmersiveConvertApiClient::HtmlGetLanguageResult](docs/HtmlGetLanguageResult.md)
|
491
499
|
- [CloudmersiveConvertApiClient::HtmlGetLinksResponse](docs/HtmlGetLinksResponse.md)
|
500
|
+
- [CloudmersiveConvertApiClient::HtmlGetRelCanonicalUrlResult](docs/HtmlGetRelCanonicalUrlResult.md)
|
501
|
+
- [CloudmersiveConvertApiClient::HtmlGetSitemapUrlResult](docs/HtmlGetSitemapUrlResult.md)
|
492
502
|
- [CloudmersiveConvertApiClient::HtmlHyperlink](docs/HtmlHyperlink.md)
|
493
503
|
- [CloudmersiveConvertApiClient::HtmlMdResult](docs/HtmlMdResult.md)
|
494
504
|
- [CloudmersiveConvertApiClient::HtmlSsrfThreatCheckResult](docs/HtmlSsrfThreatCheckResult.md)
|
data/docs/EditHtmlApi.md
CHANGED
@@ -4,12 +4,79 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
+
[**edit_html_html_append_header_tag**](EditHtmlApi.md#edit_html_html_append_header_tag) | **POST** /convert/edit/html/head/append/tag | Append an HTML tag to the HEAD section of an HTML Document
|
7
8
|
[**edit_html_html_append_heading**](EditHtmlApi.md#edit_html_html_append_heading) | **POST** /convert/edit/html/append/heading | Append a Heading to an HTML Document
|
8
9
|
[**edit_html_html_append_image_from_url**](EditHtmlApi.md#edit_html_html_append_image_from_url) | **POST** /convert/edit/html/append/image/from-url | Append an Image to an HTML Document from a URL
|
9
10
|
[**edit_html_html_append_image_inline**](EditHtmlApi.md#edit_html_html_append_image_inline) | **POST** /convert/edit/html/append/image/inline | Append a Base64 Inline Image to an HTML Document
|
10
11
|
[**edit_html_html_append_paragraph**](EditHtmlApi.md#edit_html_html_append_paragraph) | **POST** /convert/edit/html/append/paragraph | Append a Paragraph to an HTML Document
|
11
12
|
[**edit_html_html_create_blank_document**](EditHtmlApi.md#edit_html_html_create_blank_document) | **POST** /convert/edit/html/create/blank | Create a Blank HTML Document
|
13
|
+
[**edit_html_html_get_language**](EditHtmlApi.md#edit_html_html_get_language) | **POST** /convert/edit/html/head/get/language | Gets the language for the HTML document
|
12
14
|
[**edit_html_html_get_links**](EditHtmlApi.md#edit_html_html_get_links) | **POST** /convert/edit/html/extract/links | Extract resolved link URLs from HTML File
|
15
|
+
[**edit_html_html_get_rel_canonical**](EditHtmlApi.md#edit_html_html_get_rel_canonical) | **POST** /convert/edit/html/head/get/rel-canonical-url | Gets the rel canonical URL for the HTML document
|
16
|
+
[**edit_html_html_get_sitemap**](EditHtmlApi.md#edit_html_html_get_sitemap) | **POST** /convert/edit/html/head/get/sitemap-url | Gets the sitemap URL for the HTML document
|
17
|
+
[**edit_html_html_set_language**](EditHtmlApi.md#edit_html_html_set_language) | **POST** /convert/edit/html/head/set/language | Sets the language for the HTML document
|
18
|
+
[**edit_html_html_set_rel_canonical**](EditHtmlApi.md#edit_html_html_set_rel_canonical) | **POST** /convert/edit/html/head/set/rel-canonical-url | Sets the rel canonical URL for the HTML document
|
19
|
+
[**edit_html_html_set_sitemap_url**](EditHtmlApi.md#edit_html_html_set_sitemap_url) | **POST** /convert/edit/html/head/set/sitemap-url | Sets the sitemap URL for the HTML document
|
20
|
+
|
21
|
+
|
22
|
+
# **edit_html_html_append_header_tag**
|
23
|
+
> String edit_html_html_append_header_tag(html_tag, opts)
|
24
|
+
|
25
|
+
Append an HTML tag to the HEAD section of an HTML Document
|
26
|
+
|
27
|
+
Appends an HTML tag to the HEAD section of an HTML document.
|
28
|
+
|
29
|
+
### Example
|
30
|
+
```ruby
|
31
|
+
# load the gem
|
32
|
+
require 'cloudmersive-convert-api-client'
|
33
|
+
# setup authorization
|
34
|
+
CloudmersiveConvertApiClient.configure do |config|
|
35
|
+
# Configure API key authorization: Apikey
|
36
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
37
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
38
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
39
|
+
end
|
40
|
+
|
41
|
+
api_instance = CloudmersiveConvertApiClient::EditHtmlApi.new
|
42
|
+
|
43
|
+
html_tag = 'html_tag_example' # String | The HTML tag to append.
|
44
|
+
|
45
|
+
opts = {
|
46
|
+
input_file: File.new('/path/to/file.txt'), # File | Optional: Input file to perform the operation on.
|
47
|
+
input_file_url: 'input_file_url_example' # String | Optional: URL of a file to operate on as input.
|
48
|
+
}
|
49
|
+
|
50
|
+
begin
|
51
|
+
#Append an HTML tag to the HEAD section of an HTML Document
|
52
|
+
result = api_instance.edit_html_html_append_header_tag(html_tag, opts)
|
53
|
+
p result
|
54
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
55
|
+
puts "Exception when calling EditHtmlApi->edit_html_html_append_header_tag: #{e}"
|
56
|
+
end
|
57
|
+
```
|
58
|
+
|
59
|
+
### Parameters
|
60
|
+
|
61
|
+
Name | Type | Description | Notes
|
62
|
+
------------- | ------------- | ------------- | -------------
|
63
|
+
**html_tag** | **String**| The HTML tag to append. |
|
64
|
+
**input_file** | **File**| Optional: Input file to perform the operation on. | [optional]
|
65
|
+
**input_file_url** | **String**| Optional: URL of a file to operate on as input. | [optional]
|
66
|
+
|
67
|
+
### Return type
|
68
|
+
|
69
|
+
**String**
|
70
|
+
|
71
|
+
### Authorization
|
72
|
+
|
73
|
+
[Apikey](../README.md#Apikey)
|
74
|
+
|
75
|
+
### HTTP request headers
|
76
|
+
|
77
|
+
- **Content-Type**: Not defined
|
78
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
79
|
+
|
13
80
|
|
14
81
|
|
15
82
|
# **edit_html_html_append_heading**
|
@@ -328,6 +395,63 @@ Name | Type | Description | Notes
|
|
328
395
|
|
329
396
|
|
330
397
|
|
398
|
+
# **edit_html_html_get_language**
|
399
|
+
> HtmlGetLanguageResult edit_html_html_get_language(opts)
|
400
|
+
|
401
|
+
Gets the language for the HTML document
|
402
|
+
|
403
|
+
Retrieves the language code (e.g. \"en\" or \"de\") of an HTML document.
|
404
|
+
|
405
|
+
### Example
|
406
|
+
```ruby
|
407
|
+
# load the gem
|
408
|
+
require 'cloudmersive-convert-api-client'
|
409
|
+
# setup authorization
|
410
|
+
CloudmersiveConvertApiClient.configure do |config|
|
411
|
+
# Configure API key authorization: Apikey
|
412
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
413
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
414
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
415
|
+
end
|
416
|
+
|
417
|
+
api_instance = CloudmersiveConvertApiClient::EditHtmlApi.new
|
418
|
+
|
419
|
+
opts = {
|
420
|
+
input_file: File.new('/path/to/file.txt'), # File | Optional: Input file to perform the operation on.
|
421
|
+
input_file_url: 'input_file_url_example' # String | Optional: URL of a file to operate on as input.
|
422
|
+
}
|
423
|
+
|
424
|
+
begin
|
425
|
+
#Gets the language for the HTML document
|
426
|
+
result = api_instance.edit_html_html_get_language(opts)
|
427
|
+
p result
|
428
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
429
|
+
puts "Exception when calling EditHtmlApi->edit_html_html_get_language: #{e}"
|
430
|
+
end
|
431
|
+
```
|
432
|
+
|
433
|
+
### Parameters
|
434
|
+
|
435
|
+
Name | Type | Description | Notes
|
436
|
+
------------- | ------------- | ------------- | -------------
|
437
|
+
**input_file** | **File**| Optional: Input file to perform the operation on. | [optional]
|
438
|
+
**input_file_url** | **String**| Optional: URL of a file to operate on as input. | [optional]
|
439
|
+
|
440
|
+
### Return type
|
441
|
+
|
442
|
+
[**HtmlGetLanguageResult**](HtmlGetLanguageResult.md)
|
443
|
+
|
444
|
+
### Authorization
|
445
|
+
|
446
|
+
[Apikey](../README.md#Apikey)
|
447
|
+
|
448
|
+
### HTTP request headers
|
449
|
+
|
450
|
+
- **Content-Type**: Not defined
|
451
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
452
|
+
|
453
|
+
|
454
|
+
|
331
455
|
# **edit_html_html_get_links**
|
332
456
|
> HtmlGetLinksResponse edit_html_html_get_links(opts)
|
333
457
|
|
@@ -387,3 +511,297 @@ Name | Type | Description | Notes
|
|
387
511
|
|
388
512
|
|
389
513
|
|
514
|
+
# **edit_html_html_get_rel_canonical**
|
515
|
+
> HtmlGetRelCanonicalUrlResult edit_html_html_get_rel_canonical(opts)
|
516
|
+
|
517
|
+
Gets the rel canonical URL for the HTML document
|
518
|
+
|
519
|
+
Gets the rel canonical URL of an HTML document.
|
520
|
+
|
521
|
+
### Example
|
522
|
+
```ruby
|
523
|
+
# load the gem
|
524
|
+
require 'cloudmersive-convert-api-client'
|
525
|
+
# setup authorization
|
526
|
+
CloudmersiveConvertApiClient.configure do |config|
|
527
|
+
# Configure API key authorization: Apikey
|
528
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
529
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
530
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
531
|
+
end
|
532
|
+
|
533
|
+
api_instance = CloudmersiveConvertApiClient::EditHtmlApi.new
|
534
|
+
|
535
|
+
opts = {
|
536
|
+
input_file: File.new('/path/to/file.txt'), # File | Optional: Input file to perform the operation on.
|
537
|
+
input_file_url: 'input_file_url_example' # String | Optional: URL of a file to operate on as input.
|
538
|
+
}
|
539
|
+
|
540
|
+
begin
|
541
|
+
#Gets the rel canonical URL for the HTML document
|
542
|
+
result = api_instance.edit_html_html_get_rel_canonical(opts)
|
543
|
+
p result
|
544
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
545
|
+
puts "Exception when calling EditHtmlApi->edit_html_html_get_rel_canonical: #{e}"
|
546
|
+
end
|
547
|
+
```
|
548
|
+
|
549
|
+
### Parameters
|
550
|
+
|
551
|
+
Name | Type | Description | Notes
|
552
|
+
------------- | ------------- | ------------- | -------------
|
553
|
+
**input_file** | **File**| Optional: Input file to perform the operation on. | [optional]
|
554
|
+
**input_file_url** | **String**| Optional: URL of a file to operate on as input. | [optional]
|
555
|
+
|
556
|
+
### Return type
|
557
|
+
|
558
|
+
[**HtmlGetRelCanonicalUrlResult**](HtmlGetRelCanonicalUrlResult.md)
|
559
|
+
|
560
|
+
### Authorization
|
561
|
+
|
562
|
+
[Apikey](../README.md#Apikey)
|
563
|
+
|
564
|
+
### HTTP request headers
|
565
|
+
|
566
|
+
- **Content-Type**: Not defined
|
567
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
568
|
+
|
569
|
+
|
570
|
+
|
571
|
+
# **edit_html_html_get_sitemap**
|
572
|
+
> HtmlGetSitemapUrlResult edit_html_html_get_sitemap(opts)
|
573
|
+
|
574
|
+
Gets the sitemap URL for the HTML document
|
575
|
+
|
576
|
+
Gets the sitemap link URL of an HTML document.
|
577
|
+
|
578
|
+
### Example
|
579
|
+
```ruby
|
580
|
+
# load the gem
|
581
|
+
require 'cloudmersive-convert-api-client'
|
582
|
+
# setup authorization
|
583
|
+
CloudmersiveConvertApiClient.configure do |config|
|
584
|
+
# Configure API key authorization: Apikey
|
585
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
586
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
587
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
588
|
+
end
|
589
|
+
|
590
|
+
api_instance = CloudmersiveConvertApiClient::EditHtmlApi.new
|
591
|
+
|
592
|
+
opts = {
|
593
|
+
input_file: File.new('/path/to/file.txt'), # File | Optional: Input file to perform the operation on.
|
594
|
+
input_file_url: 'input_file_url_example' # String | Optional: URL of a file to operate on as input.
|
595
|
+
}
|
596
|
+
|
597
|
+
begin
|
598
|
+
#Gets the sitemap URL for the HTML document
|
599
|
+
result = api_instance.edit_html_html_get_sitemap(opts)
|
600
|
+
p result
|
601
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
602
|
+
puts "Exception when calling EditHtmlApi->edit_html_html_get_sitemap: #{e}"
|
603
|
+
end
|
604
|
+
```
|
605
|
+
|
606
|
+
### Parameters
|
607
|
+
|
608
|
+
Name | Type | Description | Notes
|
609
|
+
------------- | ------------- | ------------- | -------------
|
610
|
+
**input_file** | **File**| Optional: Input file to perform the operation on. | [optional]
|
611
|
+
**input_file_url** | **String**| Optional: URL of a file to operate on as input. | [optional]
|
612
|
+
|
613
|
+
### Return type
|
614
|
+
|
615
|
+
[**HtmlGetSitemapUrlResult**](HtmlGetSitemapUrlResult.md)
|
616
|
+
|
617
|
+
### Authorization
|
618
|
+
|
619
|
+
[Apikey](../README.md#Apikey)
|
620
|
+
|
621
|
+
### HTTP request headers
|
622
|
+
|
623
|
+
- **Content-Type**: Not defined
|
624
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
625
|
+
|
626
|
+
|
627
|
+
|
628
|
+
# **edit_html_html_set_language**
|
629
|
+
> String edit_html_html_set_language(language_code, opts)
|
630
|
+
|
631
|
+
Sets the language for the HTML document
|
632
|
+
|
633
|
+
Sets the language code of an HTML document.
|
634
|
+
|
635
|
+
### Example
|
636
|
+
```ruby
|
637
|
+
# load the gem
|
638
|
+
require 'cloudmersive-convert-api-client'
|
639
|
+
# setup authorization
|
640
|
+
CloudmersiveConvertApiClient.configure do |config|
|
641
|
+
# Configure API key authorization: Apikey
|
642
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
643
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
644
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
645
|
+
end
|
646
|
+
|
647
|
+
api_instance = CloudmersiveConvertApiClient::EditHtmlApi.new
|
648
|
+
|
649
|
+
language_code = 'language_code_example' # String | The HTML langauge code to set.
|
650
|
+
|
651
|
+
opts = {
|
652
|
+
input_file: File.new('/path/to/file.txt'), # File | Optional: Input file to perform the operation on.
|
653
|
+
input_file_url: 'input_file_url_example' # String | Optional: URL of a file to operate on as input.
|
654
|
+
}
|
655
|
+
|
656
|
+
begin
|
657
|
+
#Sets the language for the HTML document
|
658
|
+
result = api_instance.edit_html_html_set_language(language_code, opts)
|
659
|
+
p result
|
660
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
661
|
+
puts "Exception when calling EditHtmlApi->edit_html_html_set_language: #{e}"
|
662
|
+
end
|
663
|
+
```
|
664
|
+
|
665
|
+
### Parameters
|
666
|
+
|
667
|
+
Name | Type | Description | Notes
|
668
|
+
------------- | ------------- | ------------- | -------------
|
669
|
+
**language_code** | **String**| The HTML langauge code to set. |
|
670
|
+
**input_file** | **File**| Optional: Input file to perform the operation on. | [optional]
|
671
|
+
**input_file_url** | **String**| Optional: URL of a file to operate on as input. | [optional]
|
672
|
+
|
673
|
+
### Return type
|
674
|
+
|
675
|
+
**String**
|
676
|
+
|
677
|
+
### Authorization
|
678
|
+
|
679
|
+
[Apikey](../README.md#Apikey)
|
680
|
+
|
681
|
+
### HTTP request headers
|
682
|
+
|
683
|
+
- **Content-Type**: Not defined
|
684
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
685
|
+
|
686
|
+
|
687
|
+
|
688
|
+
# **edit_html_html_set_rel_canonical**
|
689
|
+
> String edit_html_html_set_rel_canonical(canonical_url, opts)
|
690
|
+
|
691
|
+
Sets the rel canonical URL for the HTML document
|
692
|
+
|
693
|
+
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.
|
694
|
+
|
695
|
+
### Example
|
696
|
+
```ruby
|
697
|
+
# load the gem
|
698
|
+
require 'cloudmersive-convert-api-client'
|
699
|
+
# setup authorization
|
700
|
+
CloudmersiveConvertApiClient.configure do |config|
|
701
|
+
# Configure API key authorization: Apikey
|
702
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
703
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
704
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
705
|
+
end
|
706
|
+
|
707
|
+
api_instance = CloudmersiveConvertApiClient::EditHtmlApi.new
|
708
|
+
|
709
|
+
canonical_url = 'canonical_url_example' # String | The HTML canonical URL to set.
|
710
|
+
|
711
|
+
opts = {
|
712
|
+
input_file: File.new('/path/to/file.txt'), # File | Optional: Input file to perform the operation on.
|
713
|
+
input_file_url: 'input_file_url_example' # String | Optional: URL of a file to operate on as input.
|
714
|
+
}
|
715
|
+
|
716
|
+
begin
|
717
|
+
#Sets the rel canonical URL for the HTML document
|
718
|
+
result = api_instance.edit_html_html_set_rel_canonical(canonical_url, opts)
|
719
|
+
p result
|
720
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
721
|
+
puts "Exception when calling EditHtmlApi->edit_html_html_set_rel_canonical: #{e}"
|
722
|
+
end
|
723
|
+
```
|
724
|
+
|
725
|
+
### Parameters
|
726
|
+
|
727
|
+
Name | Type | Description | Notes
|
728
|
+
------------- | ------------- | ------------- | -------------
|
729
|
+
**canonical_url** | **String**| The HTML canonical URL to set. |
|
730
|
+
**input_file** | **File**| Optional: Input file to perform the operation on. | [optional]
|
731
|
+
**input_file_url** | **String**| Optional: URL of a file to operate on as input. | [optional]
|
732
|
+
|
733
|
+
### Return type
|
734
|
+
|
735
|
+
**String**
|
736
|
+
|
737
|
+
### Authorization
|
738
|
+
|
739
|
+
[Apikey](../README.md#Apikey)
|
740
|
+
|
741
|
+
### HTTP request headers
|
742
|
+
|
743
|
+
- **Content-Type**: Not defined
|
744
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
745
|
+
|
746
|
+
|
747
|
+
|
748
|
+
# **edit_html_html_set_sitemap_url**
|
749
|
+
> String edit_html_html_set_sitemap_url(sitemap_url, opts)
|
750
|
+
|
751
|
+
Sets the sitemap URL for the HTML document
|
752
|
+
|
753
|
+
Sets the sitemap URL of an HTML document.
|
754
|
+
|
755
|
+
### Example
|
756
|
+
```ruby
|
757
|
+
# load the gem
|
758
|
+
require 'cloudmersive-convert-api-client'
|
759
|
+
# setup authorization
|
760
|
+
CloudmersiveConvertApiClient.configure do |config|
|
761
|
+
# Configure API key authorization: Apikey
|
762
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
763
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
764
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
765
|
+
end
|
766
|
+
|
767
|
+
api_instance = CloudmersiveConvertApiClient::EditHtmlApi.new
|
768
|
+
|
769
|
+
sitemap_url = 'sitemap_url_example' # String | The HTML sitemap URL to set.
|
770
|
+
|
771
|
+
opts = {
|
772
|
+
input_file: File.new('/path/to/file.txt'), # File | Optional: Input file to perform the operation on.
|
773
|
+
input_file_url: 'input_file_url_example' # String | Optional: URL of a file to operate on as input.
|
774
|
+
}
|
775
|
+
|
776
|
+
begin
|
777
|
+
#Sets the sitemap URL for the HTML document
|
778
|
+
result = api_instance.edit_html_html_set_sitemap_url(sitemap_url, opts)
|
779
|
+
p result
|
780
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
781
|
+
puts "Exception when calling EditHtmlApi->edit_html_html_set_sitemap_url: #{e}"
|
782
|
+
end
|
783
|
+
```
|
784
|
+
|
785
|
+
### Parameters
|
786
|
+
|
787
|
+
Name | Type | Description | Notes
|
788
|
+
------------- | ------------- | ------------- | -------------
|
789
|
+
**sitemap_url** | **String**| The HTML sitemap URL to set. |
|
790
|
+
**input_file** | **File**| Optional: Input file to perform the operation on. | [optional]
|
791
|
+
**input_file_url** | **String**| Optional: URL of a file to operate on as input. | [optional]
|
792
|
+
|
793
|
+
### Return type
|
794
|
+
|
795
|
+
**String**
|
796
|
+
|
797
|
+
### Authorization
|
798
|
+
|
799
|
+
[Apikey](../README.md#Apikey)
|
800
|
+
|
801
|
+
### HTTP request headers
|
802
|
+
|
803
|
+
- **Content-Type**: Not defined
|
804
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
805
|
+
|
806
|
+
|
807
|
+
|