aspose_html 1.0.0

data/docs/SummarizationApi.md

@@ -0,0 +1,111 @@
+# Summarization Api
+
+All URIs are relative to *https://api.aspose.cloud/v1.1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**summarization_get_detect_html_keywords**](SummarizationApi.md#get_detect_html_keywords) | **GET** /html/{name}/summ/keywords | Get the HTML document keywords using the keyword detection service.
+[**summarization_get_detect_html_keywords_by_url**](SummarizationApi.md#get_detect_html_keywords_by_url) | **GET** /html/summ/keywords | Get the keywords from HTML document from Web specified by its URL using the keyword detection service
+
+
+# **get_detect_html_keywords**
+> Hash get_detect_html_keywords(name, opts)
+
+Get the HTML document keywords using the keyword detection service.
+
+### Example
+```ruby
+# load the gem
+require 'aspose_html'
+
+CONFIG = {
+    "basePath":"https://api.aspose.cloud/v1.1",
+    "authPath":"https://api.aspose.cloud/oauth2/token",
+    "apiKey":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+    "appSID":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
+    "debug":true
+}
+
+api_instance = AsposeHtml::HtmlApi.new CONFIG
+
+name = "name_example" # String | Document name.
+
+opts = { 
+  folder: "folder_example", # String | Document folder.
+  storage: "storage_example" # String | Document storage.
+}
+
+begin
+  #Get the HTML document keywords using the keyword detection service.
+  result = api_instance.get_detect_html_keywords(name, opts)
+  p result
+rescue AsposeHtml::ApiError => e
+  puts "Exception when calling HtmlApi->get_detect_html_keywords: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| Document name. | 
+ **folder** | **String**| Document folder. | [optional] 
+ **storage** | **String**| Document storage. | [optional] 
+
+### Return type
+
+**[Hash] {file: data, status: _status_code, headers: _headers}**
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_detect_html_keywords_by_url**
+> Hash get_detect_html_keywords_by_url(source_url)
+
+Get the keywords from HTML document from Web specified by its URL using the keyword detection service
+
+### Example
+```ruby
+# load the gem
+require 'aspose_html'
+
+CONFIG = {
+    "basePath":"https://api.aspose.cloud/v1.1",
+    "authPath":"https://api.aspose.cloud/oauth2/token",
+    "apiKey":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+    "appSID":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
+    "debug":true
+}
+
+api_instance = AsposeHtml::HtmlApi.new CONFIG
+
+source_url = "source_url_example" # String | Source document URL.
+
+
+begin
+  #Get the keywords from HTML document from Web specified by its URL using the keyword detection service
+  result = api_instance.get_detect_html_keywords_by_url(source_url)
+  p result
+rescue AsposeHtml::ApiError => e
+  puts "Exception when calling HtmlApi->get_detect_html_keywords_by_url: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **source_url** | **String**| Source document URL. | 
+
+### Return type
+
+**[Hash] {file: data, status: _status_code, headers: _headers}**
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json

data/docs/TranslationApi.md

@@ -0,0 +1,126 @@
+# Translation API
+
+All URIs are relative to *https://api.aspose.cloud/v1.1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_translate_document**](TranslationApi.md#get_translate_document) | **GET** /html/{name}/translate/{srcLang}/{resLang} | Translate the HTML document specified by the name from default or specified storage. 
+[**get_translate_document_by_url**](TranslationApi.md#get_translate_document_by_url) | **GET** /html/translate/{srcLang}/{resLang} | Translate the HTML document from Web specified by its URL.
+
+
+# **get_translate_document**
+> Hash get_translate_document(name, src_lang, res_lang, opts)
+
+Translate the HTML document specified by the name from default or specified storage. 
+
+### Example
+```ruby
+# load the gem
+require 'aspose_html'
+
+CONFIG = {
+    "basePath":"https://api.aspose.cloud/v1.1",
+    "authPath":"https://api.aspose.cloud/oauth2/token",
+    "apiKey":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+    "appSID":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
+    "debug":true
+}
+
+api_instance = AsposeHtml::HtmlApi.new CONFIG
+
+name = "test_en.html" # String | Document name.
+
+src_lang = "en" # String | Source language.
+
+res_lang = "fr" # String | Result language.
+
+opts = { 
+  storage: "storage_example", # String | The source document storage.
+  folder: "folder_example" # String | The source document folder.
+}
+
+begin
+  #Translate the HTML document specified by the name from default or specified storage. 
+  result = api_instance.get_translate_document(name, src_lang, res_lang, opts)
+  p result
+rescue AsposeHtml::ApiError => e
+  puts "Exception when calling HtmlApi->get_translate_document: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| Document name. | 
+ **src_lang** | **String**| Source language. | 
+ **res_lang** | **String**| Result language. | 
+ **storage** | **String**| The source document storage. | [optional] 
+ **folder** | **String**| The source document folder. | [optional] 
+
+### Return type
+
+**[Hash] {file: data, status: _status_code, headers: _headers}**
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: multipart/form-data
+
+
+
+# **get_translate_document_by_url**
+> Hash get_translate_document_by_url(source_url, src_lang, res_lang)
+
+Translate the HTML document from Web specified by its URL.
+
+### Example
+```ruby
+# load the gem
+require 'aspose_html'
+
+CONFIG = {
+    "basePath":"https://api.aspose.cloud/v1.1",
+    "authPath":"https://api.aspose.cloud/oauth2/token",
+    "apiKey":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+    "appSID":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
+    "debug":true
+}
+
+api_instance = AsposeHtml::HtmlApi.new CONFIG
+
+source_url = "https://www.le.ac.uk/oerresources/bdra/html/page_01.htm" # String | Source document URL.
+
+src_lang = "en" # String | Source language.
+
+res_lang = "de" # String | Result language.
+
+
+begin
+  #Translate the HTML document from Web specified by its URL.
+  result = api_instance.get_translate_document_by_url(source_url, src_lang, res_lang)
+  p result
+rescue AsposeHtml::ApiError => e
+  puts "Exception when calling HtmlApi->get_translate_document_by_url: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **source_url** | **String**| Source document URL. | 
+ **src_lang** | **String**| Source language. | 
+ **res_lang** | **String**| Result language. | 
+
+### Return type
+
+**[Hash] {file: data, status: _status_code, headers: _headers}**
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: multipart/form-data
+
+
+

data/docs/storage/DiscUsage.md

@@ -0,0 +1,9 @@
+# AsposeStorage::DiscUsage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**used_size** | **Integer** |  | 
+**total_size** | **Integer** |  | 
+
+

data/docs/storage/DiscUsageResponse.md

@@ -0,0 +1,10 @@
+# AsposeStorage::DiscUsageResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** |  | 
+**status** | **String** |  | [optional] 
+**disc_usage** | [**DiscUsage**](DiscUsage.md) |  | [optional] 
+
+

data/docs/storage/FileApi.md

@@ -0,0 +1,240 @@
+# File API
+
+All URIs are relative to *https://api.aspose.cloud/v1.1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_file**](FileApi.md#delete_file) | **DELETE** /storage/file | Remove a specific file 
+[**get_download**](FileApi.md#get_download) | **GET** /storage/file | Download a specific file 
+[**post_move_file**](FileApi.md#post_move_file) | **POST** /storage/file | Move a specific file 
+[**put_create**](FileApi.md#put_create) | **PUT** /storage/file | Upload a specific file 
+
+
+# **delete_file**
+> RemoveFileResponse delete_file(path, opts)
+
+Remove a specific file 
+
+### Example
+```ruby
+# load the gem
+require 'aspose_html'
+
+CONFIG = {
+    "basePath":"https://api.aspose.cloud/v1.1",
+    "authPath":"https://api.aspose.cloud/oauth2/token",
+    "apiKey":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+    "appSID":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
+    "debug":true
+}
+
+api_instance = AsposeHtml::StorageApi.new CONFIG
+
+path = "path_example" # String | Path of the file including file name and extension e.g. /Folder1/file.ext
+
+opts = { 
+  version_id: "version_id_example", # String | File's version
+  storage: "storage_example" # String | User's storage name
+}
+
+begin
+  #Remove a specific file 
+  result = api_instance.delete_file(path, opts)
+  p result
+rescue AsposeStorage::ApiError => e
+  puts "Exception when calling FileApi->delete_file: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **path** | **String**| Path of the file including file name and extension e.g. /Folder1/file.ext | 
+ **version_id** | **String**| File's version | [optional] 
+ **storage** | **String**| User's storage name | [optional] 
+
+### Return type
+
+[**RemoveFileResponse**](RemoveFileResponse.md)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_download**
+> File get_download(path, opts)
+
+Download a specific file 
+
+### Example
+```ruby
+# load the gem
+require 'aspose_html'
+
+CONFIG = {
+    "basePath":"https://api.aspose.cloud/v1.1",
+    "authPath":"https://api.aspose.cloud/oauth2/token",
+    "apiKey":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+    "appSID":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
+    "debug":true
+}
+
+api_instance = AsposeHtml::StorageApi.new CONFIG
+
+path = "path_example" # String | Path of the file including the file name and extension e.g. /file.ext
+
+opts = { 
+  version_id: "version_id_example", # String | File's version
+  storage: "storage_example" # String | User's storage name
+}
+
+begin
+  #Download a specific file 
+  result = api_instance.get_download(path, opts)
+  p result
+rescue AsposeStorage::ApiError => e
+  puts "Exception when calling FileApi->get_download: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **path** | **String**| Path of the file including the file name and extension e.g. /file.ext | 
+ **version_id** | **String**| File's version | [optional] 
+ **storage** | **String**| User's storage name | [optional] 
+
+### Return type
+
+**{file: path_to_tmp_file, code: 200, status: 'OK'}**
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: multipart/form-data
+
+
+
+# **post_move_file**
+> MoveFileResponse post_move_file(src, dest, opts)
+
+Move a specific file 
+
+### Example
+```ruby
+# load the gem
+require 'aspose_html'
+
+CONFIG = {
+    "basePath":"https://api.aspose.cloud/v1.1",
+    "authPath":"https://api.aspose.cloud/oauth2/token",
+    "apiKey":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+    "appSID":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
+    "debug":true
+}
+
+api_instance = AsposeHtml::StorageApi.new CONFIG
+
+src = "src_example" # String | Source file path e.g. /fileSource.ext
+
+dest = "dest_example" # String | Destination file path e.g. /fileDestination.ext
+
+opts = { 
+  version_id: "version_id_example", # String | Source file's version,
+  storage: "storage_example", # String | User's source storage name
+  dest_storage: "dest_storage_example" # String | User's destination storage name
+}
+
+begin
+  #Move a specific file 
+  result = api_instance.post_move_file(src, dest, opts)
+  p result
+rescue AsposeStorage::ApiError => e
+  puts "Exception when calling FileApi->post_move_file: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **src** | **String**| Source file path e.g. /fileSource.ext | 
+ **dest** | **String**| Destination file path e.g. /fileDestination.ext | 
+ **version_id** | **String**| Source file's version, | [optional] 
+ **storage** | **String**| User's source storage name | [optional] 
+ **dest_storage** | **String**| User's destination storage name | [optional] 
+
+### Return type
+
+[**MoveFileResponse**](MoveFileResponse.md)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+
+# **put_create**
+> File put_create(path, file, opts)
+
+Upload a specific file 
+
+### Example
+```ruby
+# load the gem
+require 'aspose_html'
+
+CONFIG = {
+    "basePath":"https://api.aspose.cloud/v1.1",
+    "authPath":"https://api.aspose.cloud/oauth2/token",
+    "apiKey":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+    "appSID":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
+    "debug":true
+}
+
+api_instance = AsposeHtml::StorageApi.new CONFIG
+
+path = "path_example" # String | Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext
+
+file = File.new("/path/to/file.txt") # File | File to upload
+
+opts = { 
+  version_id: "version_id_example", # String | Source file's version
+  storage: "storage_example" # String | User's storage name
+}
+
+begin
+  #Upload a specific file 
+  result = api_instance.put_create(path, file, opts)
+  p result
+rescue AsposeStorage::ApiError => e
+  puts "Exception when calling FileApi->put_create: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **path** | **String**| Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext | 
+ **file** | **File**| File to upload | 
+ **version_id** | **String**| Source file's version | [optional] 
+ **storage** | **String**| User's storage name | [optional] 
+
+### Return type
+
+[**MessageResponse**](MessageResponse.md)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+