aspose_html 1.0.0

data/docs/DocumentApi.md

@@ -0,0 +1,386 @@
+# Document API
+
+All URIs are relative to *https://api.aspose.cloud/v1.1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_document**](DocumentApi.md#get_document) | **GET** /html/{name} | Return the HTML document by the name from default or specified storage.
+[**get_document_fragment_by_x_path**](DocumentApi.md#get_document_fragment_by_x_path) | **GET** /html/{name}/fragments/{outFormat} | Return list of HTML fragments matching the specified XPath query. 
+[**get_document_fragment_by_x_path_by_url**](DocumentApi.md#get_document_fragment_by_x_path_by_url) | **GET** /html/fragments/{outFormat} | Return list of HTML fragments matching the specified XPath query by the source page URL.
+[**get_document_fragments_by_css_selector**](DocumentApi.md#get_document_fragments_by_css_selector) | **GET** /html/{name}/fragments/css/{outFormat} | Return list of HTML fragments matching the specified CSS selector.
+[**get_document_fragments_by_css_selector_by_url**](DocumentApi.md#get_document_fragments_by_css_selector_by_url) | **GET** /html/fragments/css/{outFormat} | Return list of HTML fragments matching the specified CSS selector by the source page URL.
+[**get_document_images**](DocumentApi.md#get_document_images) | **GET** /html/{name}/images/all | Return all HTML document images packaged as a ZIP archive.
+[**get_document_images_by_url**](DocumentApi.md#get_document_images_by_url) | **GET** /html/images/all | Return all HTML page images packaged as a ZIP archive by the source page URL.
+
+
+# **get_document**
+> Hash get_document(name, opts)
+
+Return the HTML document 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.html" # String | The document name.
+
+opts = { 
+  storage: "storage_example", # String | The document folder
+  folder: "folder_example" # String | The document folder.
+}
+
+begin
+  #Return the HTML document by the name from default or specified storage.
+  result = api_instance.get_document(name, opts)
+  p result
+rescue AsposeHtml::ApiError => e
+  puts "Exception when calling HtmlApi->get_document: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| The document name. | 
+ **storage** | **String**| The document folder | [optional] 
+ **folder** | **String**| The document folder. | [optional] 
+
+### Return type
+
+**[Hash] {file: data, status: _status_code, headers: _headers}**
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: multipart/form-data, application/zip
+
+
+# **get_document_fragment_by_x_path**
+> Hash get_document_fragment_by_x_path(name, x_path, out_format, opts)
+
+Return list of HTML fragments matching the specified XPath query. 
+
+### 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 = "test2.html.zip" # String | The document name.
+
+x_path = ".//p" # String | XPath query string.
+
+out_format = "plain" # String | Output format. Possible values: 'plain' and 'json'.
+
+opts = { 
+  storage: "storage_example", # String | The document storage.
+  folder: "folder_example" # String | The document folder.
+}
+
+begin
+  #Return list of HTML fragments matching the specified XPath query. 
+  result = api_instance.get_document_fragment_by_x_path(name, x_path, out_format, opts)
+  p result
+rescue AsposeHtml::ApiError => e
+  puts "Exception when calling HtmlApi->get_document_fragment_by_x_path: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| The document name. | 
+ **x_path** | **String**| XPath query string. | 
+ **out_format** | **String**| Output format. Possible values: 'plain' and 'json'. | 
+ **storage** | **String**| The document storage. | [optional] 
+ **folder** | **String**| The 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_document_fragment_by_x_path_by_url**
+> Hash get_document_fragment_by_x_path_by_url(source_url, x_path, out_format)
+
+Return list of HTML fragments matching the specified XPath query by the source page 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://stallman.org/articles/anonymous-payments-thru-phones.html"
+x_path = ".//p"
+out_format = "plain"
+
+begin
+  #Return list of HTML fragments matching the specified XPath query. 
+  result = api_instance.get_document_fragment_by_x_path_by_url(source_url, x_path, out_format)
+  p result
+rescue AsposeHtml::ApiError => e
+  puts "Exception when calling HtmlApi->get_document_fragment_by_x_path_by_url: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **source_url** | **String**| Source page URL. | 
+ **x_path** | **String**| XPath query string. | 
+ **out_format** | **String**| Output format. Possible values: 'plain' and 'json'. | 
+
+### Return type
+
+**[Hash] {file: data, status: _status_code, headers: _headers}**
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/zip
+
+
+# **get_document_fragments_by_css_selector**
+> Hash document_get_document_fragments_by_css_selector(name, selector, out_format, opts)
+
+Return list of HTML fragments matching the specified CSS selector.
+
+### 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 = "test2.html.zip"
+selector = "div p"
+out_format = "plain"
+opts = {folder: "HtmlTestDoc", storage: nil}
+
+begin
+  #Return list of HTML fragments matching the specified CSS selector.
+  result = api_instance.document_get_document_fragments_by_css_selector(name, selector, out_format, opts)
+  p result
+rescue AsposeHtml::ApiError => e
+  puts "Exception when calling HtmlApi->document_get_document_fragments_by_css_selector: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| The document name. | 
+ **selector** | **String**| CSS selector string. | 
+ **out_format** | **String**| Output format. Possible values: 'plain' and 'json'. | 
+ **folder** | **String**| The document folder. | [optional] 
+ **storage** | **String**| The document storage. | [optional] 
+
+### Return type
+
+**[Hash] {file: data, status: _status_code, headers: _headers}**
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: multipart/form-data
+
+
+# **get_document_fragments_by_css_selector_by_url**
+> Hash document_get_document_fragments_by_css_selector_by_url(source_url, selector, out_format)
+
+Return list of HTML fragments matching the specified CSS selector by the source page 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 = "source_url_example" # String | Source page URL.
+
+selector = "selector_example" # String | CSS selector string.
+
+out_format = "out_format_example" # String | Output format. Possible values: 'plain' and 'json'.
+
+
+begin
+  #Return list of HTML fragments matching the specified CSS selector by the source page URL.
+  result = api_instance.document_get_document_fragments_by_css_selector_by_url(source_url, selector, out_format)
+  p result
+rescue AsposeHtml::ApiError => e
+  puts "Exception when calling HtmlApi->document_get_document_fragments_by_css_selector_by_url: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **source_url** | **String**| Source page URL. | 
+ **selector** | **String**| CSS selector string. | 
+ **out_format** | **String**| Output format. Possible values: 'plain' and 'json'. | 
+
+### Return type
+
+**[Hash] {file: data, status: _status_code, headers: _headers}**
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: multipart/form-data
+
+
+# **get_document_images**
+> Hash get_document_images(name, opts)
+
+Return all HTML document images packaged as a ZIP archive.
+
+### 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 = "test3.html.zip" # String | The document name.
+
+opts = { 
+  folder: "folder_example", # String | The document folder.
+  storage: "storage_example" # String | The document storage.
+}
+
+begin
+  #Return all HTML document images packaged as a ZIP archive.
+  result = api_instance.get_document_images(name, opts)
+  p result
+rescue AsposeHtml::ApiError => e
+  puts "Exception when calling HtmlApi->get_document_images: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| The document name. | 
+ **folder** | **String**| The document folder. | [optional] 
+ **storage** | **String**| The document storage. | [optional] 
+
+### Return type
+
+**[Hash] {file: data, status: _status_code, headers: _headers}**
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/zip
+
+
+# **get_document_images_by_url**
+> Hash get_document_images_by_url(source_url)
+
+Return all HTML page images packaged as a ZIP archive by the source page 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
+
+
+begin
+  #Return all HTML document images packaged as a ZIP archive.
+  result = api_instance.get_document_images_by_url(source_url)
+  p result
+rescue AsposeHtml::ApiError => e
+  puts "Exception when calling HtmlApi->get_document_images_by_url: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **source_url** | **String**| Source page URL. | 
+
+### Return type
+
+**[Hash] {file: data, status: _status_code, headers: _headers}**
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/zip

data/docs/OcrApi.md

@@ -0,0 +1,128 @@
+#  OCR API
+
+All URIs are relative to *https://api.aspose.cloud/v1.1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_recognize_and_import_to_html**](OcrApi.md#get_recognize_and_import_to_html) | **GET** /html/{name}/ocr/import | Recognize text from the image file in the storage and import it to HTML format.
+[**get_recognize_and_translate_to_html**](OcrApi.md#get_recognize_and_translate_to_html) | **GET** /html/{name}/ocr/translate/{srcLang}/{resLang} | Recognize text from the image file in the storage, import it to HTML format and translate to specified language.
+
+
+# **get_recognize_and_import_to_html**
+> Hash get_recognize_and_import_to_html(name, opts)
+
+Recognize text from the image file in the storage and import it to HTML format.
+
+### 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_ocr.png" # String | The image file name.
+
+opts = { 
+  ocr_engine_lang: "en", # String | OCR engine language - language 
+  folder: "folder_example", # String | The source image folder.
+  storage: "storage_example" # String | The source image storage.
+}
+
+begin
+  #Recognize text from the image file in the storage and import it to HTML format.
+  result = api_instance.get_recognize_and_import_to_html(name, opts)
+  p result
+rescue AsposeHtml::ApiError => e
+  puts "Exception when calling HtmlApi->get_recognize_and_import_to_html: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| The image file name. | 
+ **ocr_engine_lang** | **String**| OCR engine language - language  | [optional] [default to en]
+ **folder** | **String**| The source image folder. | [optional] 
+ **storage** | **String**| The source image storage. | [optional] 
+
+### Return type
+
+**[Hash] {file: data, status: _status_code, headers: _headers}**
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: multipart/form-data
+
+
+
+# **get_recognize_and_translate_to_html**
+> Hash get_recognize_and_translate_to_html(name, src_lang, res_lang, opts)
+
+Recognize text from the image file in the storage, import it to HTML format and translate to specified language.
+
+### 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_ocr.jpg" # String | The image file name.
+
+src_lang = "en" # String | Source language - also supposed as the OCR engine language.
+
+res_lang = "de" # String | Result language.
+
+opts = { 
+  folder: "folder_example", # String | The source image folder.
+  storage: "storage_example" # String | The source image storage.
+}
+
+begin
+  #Recognize text from the image file in the storage, import it to HTML format and translate to specified language.
+  result = api_instance.get_recognize_and_translate_to_html(name, src_lang, res_lang, opts)
+  p result
+rescue AsposeHtml::ApiError => e
+  puts "Exception when calling HtmlApi->get_recognize_and_translate_to_html: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| The image file name. | 
+ **src_lang** | **String**| Source language - also supposed as the OCR engine language. | 
+ **res_lang** | **String**| Result language. | 
+ **folder** | **String**| The source image folder. | [optional] 
+ **storage** | **String**| The source image storage. | [optional] 
+
+### Return type
+
+**[Hash] {file: data, status: _status_code, headers: _headers}**
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: multipart/form-data
+
+
+