aspose_html 1.0.0

data/docs/storage/FileDetail.md

@@ -0,0 +1,13 @@
+# AsposeStorage::File
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**is_folder** | **BOOLEAN** |  | 
+**modified_date** | **String** |  | 
+**size** | **Integer** |  | 
+**path** | **String** |  | [optional] 
+**is_directory** | **BOOLEAN** |  | 
+
+

data/docs/storage/FileDetailsResponse.md

@@ -0,0 +1,10 @@
+# AsposeStorage::FileDetailsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** |  | 
+**status** | **String** |  | [optional] 
+**file_details** | [**Array<FileDetail>**](FileDetail.md) |  | [optional] 
+
+

data/docs/storage/FileExist.md

@@ -0,0 +1,9 @@
+# AsposeStorage::FileExist
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**is_exist** | **BOOLEAN** |  | 
+**is_folder** | **BOOLEAN** |  | 
+
+

data/docs/storage/FileExistResponse.md

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

data/docs/storage/FileVersion.md

@@ -0,0 +1,15 @@
+# AsposeStorage::FileVersion
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**is_folder** | **BOOLEAN** |  | 
+**modified_date** | **String** |  | 
+**size** | **Integer** |  | 
+**path** | **String** |  | [optional] 
+**is_directory** | **BOOLEAN** |  | 
+**version_id** | **String** |  | [optional] 
+**is_latest** | **BOOLEAN** |  | [optional] 
+
+

data/docs/storage/FileVersionsResponse.md

@@ -0,0 +1,10 @@
+# AsposeStorage::FileVersionsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** |  | 
+**status** | **String** |  | [optional] 
+**file_versions** | [**Array<FileVersion>**](FileVersion.md) |  | [optional] 
+
+

data/docs/storage/FolderApi.md

@@ -0,0 +1,229 @@
+# Folder API
+
+All URIs are relative to *https://api.aspose.cloud/v1.1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_folder**](FolderApi.md#delete_folder) | **DELETE** /storage/folder | Remove a specific folder 
+[**get_list_files**](FolderApi.md#get_list_files) | **GET** /storage/folder | Get the file listing of a specific folder 
+[**post_move_folder**](FolderApi.md#post_move_folder) | **POST** /storage/folder | Move a specific folder 
+[**put_create_folder**](FolderApi.md#put_create_folder) | **PUT** /storage/folder | Create the folder 
+
+
+# **delete_folder**
+> RemoveFolderResponse delete_folder(path, opts)
+
+Remove a specific folder 
+
+### 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 | Folder path e.g. /Folder1
+
+opts = { 
+  storage: "storage_example", # String | User's storage name
+  recursive: false # BOOLEAN | Remove recursivelly inner folder/files. If false and folder contains data than exception is raised.
+}
+
+begin
+  #Remove a specific folder 
+  result = api_instance.delete_folder(path, opts)
+  p result
+rescue AsposeStorage::ApiError => e
+  puts "Exception when calling FolderApi->delete_folder: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **path** | **String**| Folder path e.g. /Folder1 | 
+ **storage** | **String**| User's storage name | [optional] 
+ **recursive** | **BOOLEAN**| Remove recursivelly inner folder/files. If false and folder contains data than exception is raised. | [optional] [default to false]
+
+### Return type
+
+[**RemoveFolderResponse**](RemoveFolderResponse.md)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_list_files**
+> File get_list_files(opts)
+
+Get the file listing of a specific folder 
+
+### 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
+
+opts = { 
+  path: "/", # String | Start with name of storage e.g. root folder '/'or some folder '/folder1/..'
+  storage: "storage_example" # String | User's storage name
+}
+
+begin
+  #Get the file listing of a specific folder 
+  result = api_instance.get_list_files(opts)
+  p result
+rescue AsposeStorage::ApiError => e
+  puts "Exception when calling FolderApi->get_list_files: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **path** | **String**| Start with name of storage e.g. root folder '/'or some folder '/folder1/..' | [optional] [default to /]
+ **storage** | **String**| User's storage name | [optional] 
+
+### Return type
+
+[**FileDetailsResponse**](FileDetailsResponse.md)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **post_move_folder**
+> MoveFolderResponse post_move_folder(src, dest, opts)
+
+Move a specific folder 
+
+### 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 folder path e.g. /Folder1
+
+dest = "dest_example" # String | Destination folder path e.g. /Folder2
+
+opts = { 
+  storage: "storage_example", # String | User's source storage name
+  dest_storage: "dest_storage_example" # String | User's destination storage name
+}
+
+begin
+  #Move a specific folder 
+  result = api_instance.post_move_folder(src, dest, opts)
+  p result
+rescue AsposeStorage::ApiError => e
+  puts "Exception when calling FolderApi->post_move_folder: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **src** | **String**| Source folder path e.g. /Folder1 | 
+ **dest** | **String**| Destination folder path e.g. /Folder2 | 
+ **storage** | **String**| User's source storage name | [optional] 
+ **dest_storage** | **String**| User's destination storage name | [optional] 
+
+### Return type
+
+[**MoveFolderResponse**](MoveFolderResponse.md)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **put_create_folder**
+> File put_create_folder(path, opts)
+
+Create the folder 
+
+### 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 | Target folder's path e.g. Folder1/Folder2/. The folders will be created recursively
+
+opts = { 
+  storage: "storage_example", # String | User's source storage name
+  dest_storage: "dest_storage_example" # String | User's destination storage name
+}
+
+begin
+  #Create the folder 
+  result = api_instance.put_create_folder(path, opts)
+  p result
+rescue AsposeStorage::ApiError => e
+  puts "Exception when calling FolderApi->put_create_folder: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **path** | **String**| Target folder's path e.g. Folder1/Folder2/. The folders will be created recursively | 
+ **storage** | **String**| User's source storage name | [optional] 
+ **dest_storage** | **String**| User's destination storage name | [optional] 
+
+### Return type
+
+[**MessageResponse**](MessageResponse.md)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json

data/docs/storage/MessageResponse.md

@@ -0,0 +1,9 @@
+# AsposeStorage::SaaSposeResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** |  | 
+**status** | **String** |  | [optional] 
+
+

data/docs/storage/MoveFileResponse.md

@@ -0,0 +1,9 @@
+# AsposeStorage::MoveFileResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** |  | 
+**status** | **String** |  | [optional] 
+
+

data/docs/storage/MoveFolderResponse.md

@@ -0,0 +1,9 @@
+# AsposeStorage::MoveFolderResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** |  | 
+**status** | **String** |  | [optional] 
+
+

data/docs/storage/RemoveFileResponse.md

@@ -0,0 +1,9 @@
+# AsposeStorage::RemoveFileResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** |  | 
+**status** | **String** |  | [optional] 
+
+

data/docs/storage/RemoveFolderResponse.md

@@ -0,0 +1,9 @@
+# AsposeStorage::RemoveFolderResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** |  | 
+**status** | **String** |  | [optional] 
+
+

data/docs/storage/StorageApi.md

@@ -0,0 +1,217 @@
+# Storage API
+
+All URIs are relative to *https://api.aspose.cloud/v1.1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_disc_usage**](StorageApi.md#get_disc_usage) | **GET** /storage/disc | Check the disk usage of the current account 
+[**get_is_exist**](StorageApi.md#get_is_exist) | **GET** /storage/exist | Check if a specific file or folder exists
+[**get_is_storage_exist**](StorageApi.md#get_is_storage_exist) | **GET** /storage/{name}/exist | Check if storage exists 
+[**get_list_file_versions**](StorageApi.md#get_list_file_versions) | **GET** /storage/version | Get the file's versions list 
+
+
+# **get_disc_usage**
+> DiscUsageResponse get_disc_usage(opts)
+
+Check the disk usage of the current account 
+
+### 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
+
+opts = { 
+  storage: "storage_example" # String | User's storage name
+}
+
+begin
+  #Check the disk usage of the current account 
+  result = api_instance.get_disc_usage(opts)
+  p result
+rescue AsposeStorage::ApiError => e
+  puts "Exception when calling StorageApi->get_disc_usage: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **storage** | **String**| User's storage name | [optional] 
+
+### Return type
+
+[**DiscUsageResponse**](DiscUsageResponse.md)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+# **get_is_exist**
+> FileExistResponse get_is_exist(path, opts)
+
+Check if a specific file or folder exists
+
+### 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 | File or folder path e.g. /file.ext or /Folder1
+
+opts = { 
+  version_id: "version_id_example", # String | File's version
+  storage: "storage_example" # String | User's storage name
+}
+
+begin
+  #Check if a specific file or folder exists
+  result = api_instance.get_is_exist(path, opts)
+  p result
+rescue AsposeStorage::ApiError => e
+  puts "Exception when calling StorageApi->get_is_exist: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **path** | **String**| File or folder path e.g. /file.ext or /Folder1 | 
+ **version_id** | **String**| File's version | [optional] 
+ **storage** | **String**| User's storage name | [optional] 
+
+### Return type
+
+[**FileExistResponse**](FileExistResponse.md)
+
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_is_storage_exist**
+> StorageExistResponse get_is_storage_exist(name)
+
+Check if storage exists 
+
+### 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
+
+name = "name_example" # String | Storage name
+
+
+begin
+  #Check if storage exists 
+  result = api_instance.get_is_storage_exist(name)
+  p result
+rescue AsposeStorage::ApiError => e
+  puts "Exception when calling StorageApi->get_is_storage_exist: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| Storage name | 
+
+### Return type
+
+[**StorageExistResponse**](StorageExistResponse.md)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_list_file_versions**
+> FileVersionsResponse get_list_file_versions(path, opts)
+
+Get the file's versions list 
+
+### 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 | File path e.g. /file.ext or /Folder1/file.ext
+
+opts = { 
+  storage: "storage_example" # String | User's storage name
+}
+
+begin
+  #Get the file's versions list 
+  result = api_instance.get_list_file_versions(path, opts)
+  p result
+rescue AsposeStorage::ApiError => e
+  puts "Exception when calling StorageApi->get_list_file_versions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **path** | **String**| File path e.g. /file.ext or /Folder1/file.ext | 
+ **storage** | **String**| User's storage name | [optional] 
+
+### Return type
+
+[**FileVersionsResponse**](FileVersionsResponse.md)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+