aspose_diagram_cloud 18.10.3 → 19.10
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/{aspose_diagram_cloud.gemspec → AsposeDiagramCloud.gemspec} +5 -5
- data/README.md +94 -124
- data/docs/{FileFormatRequest.md → CreateNewResponse.md} +2 -2
- data/docs/DiagramApi.md +241 -0
- data/docs/DiagramSaveOptions.md +10 -0
- data/docs/DiscUsage.md +9 -0
- data/docs/Error.md +11 -0
- data/docs/ErrorDetails.md +9 -0
- data/docs/FileVersion.md +14 -0
- data/docs/FileVersions.md +8 -0
- data/docs/FilesList.md +8 -0
- data/docs/FilesUploadResult.md +9 -0
- data/docs/HTMLSaveOptions.md +19 -0
- data/docs/ImageSaveOptions.md +29 -0
- data/docs/ModifyResponse.md +9 -0
- data/docs/OAuthApi.md +3 -3
- data/docs/ObjectExist.md +9 -0
- data/docs/PageSize.md +8 -0
- data/docs/PdfDigitalSignatureDetails.md +11 -0
- data/docs/PdfEncryptionDetails.md +11 -0
- data/docs/PdfSaveOptions.md +25 -0
- data/docs/PointF.md +10 -0
- data/docs/RectangleF.md +18 -0
- data/docs/RenderingSaveOptions.md +13 -0
- data/docs/SVGSaveOptions.md +18 -0
- data/docs/SWFSaveOptions.md +13 -0
- data/docs/SaaSposeResponse.md +0 -2
- data/docs/SaveAsResponse.md +10 -0
- data/docs/SaveOptionsModel.md +9 -0
- data/docs/SaveOptionsRequest.md +10 -0
- data/docs/StorageApi.md +799 -0
- data/docs/StorageExist.md +8 -0
- data/docs/StorageFile.md +12 -0
- data/docs/{SharpModel.md → UploadResponse.md} +2 -2
- data/docs/XAMLSaveOptions.md +12 -0
- data/docs/XPSSaveOptions.md +13 -0
- data/lib/AsposeDiagramCloud.rb +74 -0
- data/lib/AsposeDiagramCloud/api/diagram_api.rb +300 -0
- data/lib/{aspose_diagram_cloud → AsposeDiagramCloud}/api/o_auth_api.rb +3 -3
- data/lib/AsposeDiagramCloud/api/storage_api.rb +905 -0
- data/lib/{aspose_diagram_cloud → AsposeDiagramCloud}/api_client.rb +7 -4
- data/lib/{aspose_diagram_cloud → AsposeDiagramCloud}/api_error.rb +2 -2
- data/lib/{aspose_diagram_cloud → AsposeDiagramCloud}/configuration.rb +4 -18
- data/lib/{aspose_diagram_cloud → AsposeDiagramCloud}/models/access_token_response.rb +2 -2
- data/lib/{aspose_diagram_cloud/models/file_format_request.rb → AsposeDiagramCloud/models/create_new_response.rb} +10 -10
- data/lib/AsposeDiagramCloud/models/diagram_save_options.rb +244 -0
- data/lib/{aspose_diagram_cloud/models/link.rb → AsposeDiagramCloud/models/disc_usage.rb} +29 -35
- data/lib/AsposeDiagramCloud/models/error.rb +219 -0
- data/lib/{aspose_diagram_cloud/models/saa_spose_response.rb → AsposeDiagramCloud/models/error_details.rb} +22 -20
- data/lib/AsposeDiagramCloud/models/file_version.rb +264 -0
- data/lib/{aspose_diagram_cloud/models/page_model.rb → AsposeDiagramCloud/models/file_versions.rb} +13 -21
- data/lib/AsposeDiagramCloud/models/files_list.rb +191 -0
- data/lib/AsposeDiagramCloud/models/files_upload_result.rb +203 -0
- data/lib/AsposeDiagramCloud/models/html_save_options.rb +330 -0
- data/lib/AsposeDiagramCloud/models/image_save_options.rb +492 -0
- data/lib/AsposeDiagramCloud/models/modify_response.rb +202 -0
- data/lib/{aspose_diagram_cloud/models/diagram_response.rb → AsposeDiagramCloud/models/object_exist.rb} +27 -29
- data/lib/AsposeDiagramCloud/models/page_size.rb +221 -0
- data/lib/AsposeDiagramCloud/models/pdf_digital_signature_details.rb +248 -0
- data/lib/AsposeDiagramCloud/models/pdf_encryption_details.rb +260 -0
- data/lib/AsposeDiagramCloud/models/pdf_save_options.rb +408 -0
- data/lib/{aspose_diagram_cloud/models/save_result.rb → AsposeDiagramCloud/models/point_f.rb} +37 -24
- data/lib/AsposeDiagramCloud/models/rectangle_f.rb +333 -0
- data/lib/AsposeDiagramCloud/models/rendering_save_options.rb +276 -0
- data/lib/{aspose_diagram_cloud/models/sharp_model.rb → AsposeDiagramCloud/models/saa_spose_response.rb} +5 -14
- data/lib/{aspose_diagram_cloud/models/save_response.rb → AsposeDiagramCloud/models/save_as_response.rb} +24 -27
- data/lib/AsposeDiagramCloud/models/save_options_model.rb +235 -0
- data/lib/{aspose_diagram_cloud/models/diagram_model.rb → AsposeDiagramCloud/models/save_options_request.rb} +19 -12
- data/lib/AsposeDiagramCloud/models/storage_exist.rb +194 -0
- data/lib/AsposeDiagramCloud/models/storage_file.rb +239 -0
- data/lib/AsposeDiagramCloud/models/svg_save_options.rb +321 -0
- data/lib/AsposeDiagramCloud/models/swf_save_options.rb +271 -0
- data/lib/AsposeDiagramCloud/models/upload_response.rb +188 -0
- data/lib/AsposeDiagramCloud/models/xaml_save_options.rb +262 -0
- data/lib/AsposeDiagramCloud/models/xps_save_options.rb +271 -0
- data/lib/{aspose_diagram_cloud → AsposeDiagramCloud}/version.rb +3 -3
- data/spec/api/test_convert_spec.rb +308 -0
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +5 -5
- data/spec/spec_helper.rb +10 -6
- data/testData/FileUpload.vdx +437 -0
- metadata +80 -55
- data/docs/DiagramFileApi.md +0 -228
- data/docs/DiagramModel.md +0 -9
- data/docs/DiagramResponse.md +0 -10
- data/docs/Link.md +0 -11
- data/docs/PageModel.md +0 -9
- data/docs/SaveResponse.md +0 -10
- data/docs/SaveResult.md +0 -10
- data/lib/aspose_diagram_cloud.rb +0 -51
- data/lib/aspose_diagram_cloud/api/diagram_file_api.rb +0 -304
- data/spec/api/diagram_file_api_spec.rb +0 -118
- data/spec/api/o_auth_api_spec.rb +0 -56
- data/spec/models/access_token_response_spec.rb +0 -84
- data/spec/models/diagram_model_spec.rb +0 -48
- data/spec/models/diagram_response_spec.rb +0 -54
- data/spec/models/file_format_request_spec.rb +0 -42
- data/spec/models/link_spec.rb +0 -60
- data/spec/models/page_model_spec.rb +0 -48
- data/spec/models/saa_spose_response_spec.rb +0 -48
- data/spec/models/save_response_spec.rb +0 -54
- data/spec/models/save_result_spec.rb +0 -54
- data/spec/models/sharp_model_spec.rb +0 -42
@@ -0,0 +1,10 @@
|
|
1
|
+
# AsposeDiagramCloud::DiagramSaveOptions
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**save_format** | **String** | |
|
7
|
+
**default_font** | **String** | | [optional]
|
8
|
+
**auto_fit_page_to_drawing_content** | **BOOLEAN** | | [optional]
|
9
|
+
|
10
|
+
|
data/docs/DiscUsage.md
ADDED
@@ -0,0 +1,9 @@
|
|
1
|
+
# AsposeDiagramCloud::DiscUsage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**used_size** | **Integer** | Application used disc space. |
|
7
|
+
**total_size** | **Integer** | Total disc space. |
|
8
|
+
|
9
|
+
|
data/docs/Error.md
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
# AsposeDiagramCloud::Error
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**code** | **String** | Code | [optional]
|
7
|
+
**message** | **String** | Message | [optional]
|
8
|
+
**description** | **String** | Description | [optional]
|
9
|
+
**inner_error** | [**ErrorDetails**](ErrorDetails.md) | Inner Error | [optional]
|
10
|
+
|
11
|
+
|
data/docs/FileVersion.md
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
# AsposeDiagramCloud::FileVersion
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | File or folder name. | [optional]
|
7
|
+
**is_folder** | **BOOLEAN** | True if it is a folder. |
|
8
|
+
**modified_date** | **DateTime** | File or folder last modified DateTime. | [optional]
|
9
|
+
**size** | **Integer** | File or folder size. |
|
10
|
+
**path** | **String** | File or folder path. | [optional]
|
11
|
+
**version_id** | **String** | File Version ID. | [optional]
|
12
|
+
**is_latest** | **BOOLEAN** | Specifies whether the file is (true) or is not (false) the latest version of an file. |
|
13
|
+
|
14
|
+
|
data/docs/FilesList.md
ADDED
@@ -0,0 +1,8 @@
|
|
1
|
+
# AsposeDiagramCloud::FilesList
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**value** | [**Array<StorageFile>**](StorageFile.md) | Files and folders contained by folder StorageFile. | [optional]
|
7
|
+
|
8
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# AsposeDiagramCloud::FilesUploadResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**uploaded** | **Array<String>** | List of uploaded file names | [optional]
|
7
|
+
**errors** | [**Array<Error>**](Error.md) | List of errors. | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# AsposeDiagramCloud::HTMLSaveOptions
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**save_format** | **String** | |
|
7
|
+
**default_font** | **String** | | [optional]
|
8
|
+
**area** | [**RectangleF**](RectangleF.md) | |
|
9
|
+
**export_guide_shapes** | **BOOLEAN** | | [optional]
|
10
|
+
**page_size** | [**PageSize**](PageSize.md) | | [optional]
|
11
|
+
**is_export_comments** | **BOOLEAN** | | [optional]
|
12
|
+
**page_count** | **Integer** | | [optional]
|
13
|
+
**save_tool_bar** | **BOOLEAN** | | [optional]
|
14
|
+
**export_hidden_page** | **BOOLEAN** | | [optional]
|
15
|
+
**page_index** | **Integer** | | [optional]
|
16
|
+
**save_foreground_pages_only** | **BOOLEAN** | | [optional]
|
17
|
+
**title** | **String** | | [optional]
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,29 @@
|
|
1
|
+
# AsposeDiagramCloud::ImageSaveOptions
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**save_format** | **String** | |
|
7
|
+
**default_font** | **String** | | [optional]
|
8
|
+
**area** | [**RectangleF**](RectangleF.md) | |
|
9
|
+
**export_guide_shapes** | **BOOLEAN** | | [optional]
|
10
|
+
**page_size** | [**PageSize**](PageSize.md) | | [optional]
|
11
|
+
**is_export_comments** | **BOOLEAN** | | [optional]
|
12
|
+
**image_brightness** | **Float** | | [optional]
|
13
|
+
**image_contrast** | **Float** | | [optional]
|
14
|
+
**jpeg_quality** | **Integer** | | [optional]
|
15
|
+
**page_count** | **Integer** | | [optional]
|
16
|
+
**resolution** | **Float** | | [optional]
|
17
|
+
**scale** | **Float** | | [optional]
|
18
|
+
**tiff_compression** | **String** | | [optional]
|
19
|
+
**export_hidden_page** | **BOOLEAN** | | [optional]
|
20
|
+
**image_color_mode** | **String** | | [optional]
|
21
|
+
**page_index** | **Integer** | | [optional]
|
22
|
+
**save_foreground_pages_only** | **BOOLEAN** | | [optional]
|
23
|
+
**same_as_pdf_conversion_area** | **BOOLEAN** | | [optional]
|
24
|
+
**pixel_offset_mode** | **String** | | [optional]
|
25
|
+
**smoothing_mode** | **String** | | [optional]
|
26
|
+
**compositing_quality** | **String** | | [optional]
|
27
|
+
**interpolation_mode** | **String** | | [optional]
|
28
|
+
|
29
|
+
|
data/docs/OAuthApi.md
CHANGED
@@ -1,10 +1,10 @@
|
|
1
1
|
# AsposeDiagramCloud::OAuthApi
|
2
2
|
|
3
|
-
All URIs are relative to *https://api.aspose.cloud/
|
3
|
+
All URIs are relative to *https://api.aspose.cloud/v3.0*
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**o_auth_post**](OAuthApi.md#o_auth_post) | **POST** /
|
7
|
+
[**o_auth_post**](OAuthApi.md#o_auth_post) | **POST** /connect/token | Get Access token
|
8
8
|
|
9
9
|
|
10
10
|
# **o_auth_post**
|
@@ -15,7 +15,7 @@ Get Access token
|
|
15
15
|
### Example
|
16
16
|
```ruby
|
17
17
|
# load the gem
|
18
|
-
require '
|
18
|
+
require 'AsposeDiagramCloud'
|
19
19
|
|
20
20
|
api_instance = AsposeDiagramCloud::OAuthApi.new
|
21
21
|
|
data/docs/ObjectExist.md
ADDED
@@ -0,0 +1,9 @@
|
|
1
|
+
# AsposeDiagramCloud::ObjectExist
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**exists** | **BOOLEAN** | Indicates that the file or folder exists. |
|
7
|
+
**is_folder** | **BOOLEAN** | True if it is a folder, false if it is a file. |
|
8
|
+
|
9
|
+
|
data/docs/PageSize.md
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
# AsposeDiagramCloud::PdfDigitalSignatureDetails
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**signature_date** | **DateTime** | | [optional]
|
7
|
+
**reason** | **String** | | [optional]
|
8
|
+
**location** | **String** | | [optional]
|
9
|
+
**hash_algorithm** | **String** | | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# AsposeDiagramCloud::PdfEncryptionDetails
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**permissions** | **String** | | [optional]
|
7
|
+
**encryption_algorithm** | **String** | | [optional]
|
8
|
+
**user_password** | **String** | | [optional]
|
9
|
+
**owner_password** | **String** | | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# AsposeDiagramCloud::PdfSaveOptions
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**save_format** | **String** | |
|
7
|
+
**default_font** | **String** | | [optional]
|
8
|
+
**area** | [**RectangleF**](RectangleF.md) | |
|
9
|
+
**export_guide_shapes** | **BOOLEAN** | | [optional]
|
10
|
+
**page_size** | [**PageSize**](PageSize.md) | | [optional]
|
11
|
+
**is_export_comments** | **BOOLEAN** | | [optional]
|
12
|
+
**horizontal_resolution** | **Integer** | | [optional]
|
13
|
+
**vertical_resolution** | **Integer** | | [optional]
|
14
|
+
**page_count** | **Integer** | | [optional]
|
15
|
+
**jpeg_quality** | **Integer** | | [optional]
|
16
|
+
**export_hidden_page** | **BOOLEAN** | | [optional]
|
17
|
+
**page_index** | **Integer** | | [optional]
|
18
|
+
**save_foreground_pages_only** | **BOOLEAN** | | [optional]
|
19
|
+
**compliance** | **String** | | [optional]
|
20
|
+
**encryption_details** | [**PdfEncryptionDetails**](PdfEncryptionDetails.md) | | [optional]
|
21
|
+
**text_compression** | **String** | | [optional]
|
22
|
+
**split_multi_pages** | **BOOLEAN** | | [optional]
|
23
|
+
**digital_signature_details** | [**PdfDigitalSignatureDetails**](PdfDigitalSignatureDetails.md) | | [optional]
|
24
|
+
|
25
|
+
|
data/docs/PointF.md
ADDED
data/docs/RectangleF.md
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# AsposeDiagramCloud::RectangleF
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**location** | [**PointF**](PointF.md) | |
|
7
|
+
**size** | **String** | |
|
8
|
+
**x** | **Float** | |
|
9
|
+
**y** | **Float** | |
|
10
|
+
**width** | **Float** | |
|
11
|
+
**height** | **Float** | |
|
12
|
+
**left** | **Float** | |
|
13
|
+
**top** | **Float** | |
|
14
|
+
**right** | **Float** | |
|
15
|
+
**bottom** | **Float** | |
|
16
|
+
**is_empty** | **BOOLEAN** | |
|
17
|
+
|
18
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# AsposeDiagramCloud::RenderingSaveOptions
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**save_format** | **String** | |
|
7
|
+
**default_font** | **String** | | [optional]
|
8
|
+
**area** | [**RectangleF**](RectangleF.md) | |
|
9
|
+
**export_guide_shapes** | **BOOLEAN** | | [optional]
|
10
|
+
**page_size** | [**PageSize**](PageSize.md) | | [optional]
|
11
|
+
**is_export_comments** | **BOOLEAN** | | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# AsposeDiagramCloud::SVGSaveOptions
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**save_format** | **String** | |
|
7
|
+
**default_font** | **String** | | [optional]
|
8
|
+
**area** | [**RectangleF**](RectangleF.md) | |
|
9
|
+
**export_guide_shapes** | **BOOLEAN** | | [optional]
|
10
|
+
**page_size** | [**PageSize**](PageSize.md) | | [optional]
|
11
|
+
**is_export_comments** | **BOOLEAN** | | [optional]
|
12
|
+
**export_hidden_page** | **BOOLEAN** | | [optional]
|
13
|
+
**quality** | **Integer** | | [optional]
|
14
|
+
**page_index** | **Integer** | | [optional]
|
15
|
+
**svg_fit_to_view_port** | **BOOLEAN** | | [optional]
|
16
|
+
**export_element_as_rect_tag** | **BOOLEAN** | | [optional]
|
17
|
+
|
18
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# AsposeDiagramCloud::SWFSaveOptions
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**save_format** | **String** | |
|
7
|
+
**default_font** | **String** | | [optional]
|
8
|
+
**page_count** | **Integer** | | [optional]
|
9
|
+
**viewer_included** | **BOOLEAN** | | [optional]
|
10
|
+
**page_index** | **Integer** | | [optional]
|
11
|
+
**save_foreground_pages_only** | **BOOLEAN** | | [optional]
|
12
|
+
|
13
|
+
|
data/docs/SaaSposeResponse.md
CHANGED
@@ -0,0 +1,10 @@
|
|
1
|
+
# AsposeDiagramCloud::SaveAsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**source_file** | **String** | | [optional]
|
7
|
+
**saved_file** | **String** | | [optional]
|
8
|
+
**additionals** | **Array<String>** | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# AsposeDiagramCloud::SaveOptionsRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**file_name** | **String** | | [optional]
|
7
|
+
**folder** | **String** | | [optional]
|
8
|
+
**save_options** | [**SaveOptionsModel**](SaveOptionsModel.md) | | [optional]
|
9
|
+
|
10
|
+
|
data/docs/StorageApi.md
ADDED
@@ -0,0 +1,799 @@
|
|
1
|
+
# AsposeDiagramCloud::StorageApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.aspose.cloud/v3.0*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**copy_file**](StorageApi.md#copy_file) | **PUT** /diagram/storage/file/copy/{srcPath} | Copy file
|
8
|
+
[**copy_folder**](StorageApi.md#copy_folder) | **PUT** /diagram/storage/folder/copy/{srcPath} | Copy folder
|
9
|
+
[**create_folder**](StorageApi.md#create_folder) | **PUT** /diagram/storage/folder/{path} | Create the folder
|
10
|
+
[**delete_file**](StorageApi.md#delete_file) | **DELETE** /diagram/storage/file/{path} | Delete file
|
11
|
+
[**delete_folder**](StorageApi.md#delete_folder) | **DELETE** /diagram/storage/folder/{path} | Delete folder
|
12
|
+
[**download_file**](StorageApi.md#download_file) | **GET** /diagram/storage/file/{path} | Download file
|
13
|
+
[**get_disc_usage**](StorageApi.md#get_disc_usage) | **GET** /diagram/storage/disc | Get disc usage
|
14
|
+
[**get_file_versions**](StorageApi.md#get_file_versions) | **GET** /diagram/storage/version/{path} | Get file versions
|
15
|
+
[**get_files_list**](StorageApi.md#get_files_list) | **GET** /diagram/storage/folder/{path} | Get all files and folders within a folder
|
16
|
+
[**move_file**](StorageApi.md#move_file) | **PUT** /diagram/storage/file/move/{srcPath} | Move file
|
17
|
+
[**move_folder**](StorageApi.md#move_folder) | **PUT** /diagram/storage/folder/move/{srcPath} | Move folder
|
18
|
+
[**object_exists**](StorageApi.md#object_exists) | **GET** /diagram/storage/exist/{path} | Check if file or folder exists
|
19
|
+
[**storage_exists**](StorageApi.md#storage_exists) | **GET** /diagram/storage/{storageName}/exist | Check if storage exists
|
20
|
+
[**upload_file**](StorageApi.md#upload_file) | **PUT** /diagram/storage/file/{path} | Upload file
|
21
|
+
|
22
|
+
|
23
|
+
# **copy_file**
|
24
|
+
> copy_file(src_path, dest_path, opts)
|
25
|
+
|
26
|
+
Copy file
|
27
|
+
|
28
|
+
### Example
|
29
|
+
```ruby
|
30
|
+
# load the gem
|
31
|
+
require 'AsposeDiagramCloud'
|
32
|
+
# setup authorization
|
33
|
+
AsposeDiagramCloud.configure do |config|
|
34
|
+
# Configure OAuth2 access token for authorization: JWT
|
35
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
36
|
+
end
|
37
|
+
|
38
|
+
api_instance = AsposeDiagramCloud::StorageApi.new
|
39
|
+
|
40
|
+
src_path = "src_path_example" # String | Source file path e.g. '/folder/file.ext'
|
41
|
+
|
42
|
+
dest_path = "dest_path_example" # String | Destination file path
|
43
|
+
|
44
|
+
opts = {
|
45
|
+
src_storage_name: "src_storage_name_example", # String | Source storage name
|
46
|
+
dest_storage_name: "dest_storage_name_example", # String | Destination storage name
|
47
|
+
version_id: "version_id_example" # String | File version ID to copy
|
48
|
+
}
|
49
|
+
|
50
|
+
begin
|
51
|
+
#Copy file
|
52
|
+
api_instance.copy_file(src_path, dest_path, opts)
|
53
|
+
rescue AsposeDiagramCloud::ApiError => e
|
54
|
+
puts "Exception when calling StorageApi->copy_file: #{e}"
|
55
|
+
end
|
56
|
+
```
|
57
|
+
|
58
|
+
### Parameters
|
59
|
+
|
60
|
+
Name | Type | Description | Notes
|
61
|
+
------------- | ------------- | ------------- | -------------
|
62
|
+
**src_path** | **String**| Source file path e.g. '/folder/file.ext' |
|
63
|
+
**dest_path** | **String**| Destination file path |
|
64
|
+
**src_storage_name** | **String**| Source storage name | [optional]
|
65
|
+
**dest_storage_name** | **String**| Destination storage name | [optional]
|
66
|
+
**version_id** | **String**| File version ID to copy | [optional]
|
67
|
+
|
68
|
+
### Return type
|
69
|
+
|
70
|
+
nil (empty response body)
|
71
|
+
|
72
|
+
### Authorization
|
73
|
+
|
74
|
+
[JWT](../README.md#JWT)
|
75
|
+
|
76
|
+
### HTTP request headers
|
77
|
+
|
78
|
+
- **Content-Type**: application/json
|
79
|
+
- **Accept**: application/json
|
80
|
+
|
81
|
+
|
82
|
+
|
83
|
+
# **copy_folder**
|
84
|
+
> copy_folder(src_path, dest_path, opts)
|
85
|
+
|
86
|
+
Copy folder
|
87
|
+
|
88
|
+
### Example
|
89
|
+
```ruby
|
90
|
+
# load the gem
|
91
|
+
require 'AsposeDiagramCloud'
|
92
|
+
# setup authorization
|
93
|
+
AsposeDiagramCloud.configure do |config|
|
94
|
+
# Configure OAuth2 access token for authorization: JWT
|
95
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
96
|
+
end
|
97
|
+
|
98
|
+
api_instance = AsposeDiagramCloud::StorageApi.new
|
99
|
+
|
100
|
+
src_path = "src_path_example" # String | Source folder path e.g. '/src'
|
101
|
+
|
102
|
+
dest_path = "dest_path_example" # String | Destination folder path e.g. '/dst'
|
103
|
+
|
104
|
+
opts = {
|
105
|
+
src_storage_name: "src_storage_name_example", # String | Source storage name
|
106
|
+
dest_storage_name: "dest_storage_name_example" # String | Destination storage name
|
107
|
+
}
|
108
|
+
|
109
|
+
begin
|
110
|
+
#Copy folder
|
111
|
+
api_instance.copy_folder(src_path, dest_path, opts)
|
112
|
+
rescue AsposeDiagramCloud::ApiError => e
|
113
|
+
puts "Exception when calling StorageApi->copy_folder: #{e}"
|
114
|
+
end
|
115
|
+
```
|
116
|
+
|
117
|
+
### Parameters
|
118
|
+
|
119
|
+
Name | Type | Description | Notes
|
120
|
+
------------- | ------------- | ------------- | -------------
|
121
|
+
**src_path** | **String**| Source folder path e.g. '/src' |
|
122
|
+
**dest_path** | **String**| Destination folder path e.g. '/dst' |
|
123
|
+
**src_storage_name** | **String**| Source storage name | [optional]
|
124
|
+
**dest_storage_name** | **String**| Destination storage name | [optional]
|
125
|
+
|
126
|
+
### Return type
|
127
|
+
|
128
|
+
nil (empty response body)
|
129
|
+
|
130
|
+
### Authorization
|
131
|
+
|
132
|
+
[JWT](../README.md#JWT)
|
133
|
+
|
134
|
+
### HTTP request headers
|
135
|
+
|
136
|
+
- **Content-Type**: application/json
|
137
|
+
- **Accept**: application/json
|
138
|
+
|
139
|
+
|
140
|
+
|
141
|
+
# **create_folder**
|
142
|
+
> create_folder(path, opts)
|
143
|
+
|
144
|
+
Create the folder
|
145
|
+
|
146
|
+
### Example
|
147
|
+
```ruby
|
148
|
+
# load the gem
|
149
|
+
require 'AsposeDiagramCloud'
|
150
|
+
# setup authorization
|
151
|
+
AsposeDiagramCloud.configure do |config|
|
152
|
+
# Configure OAuth2 access token for authorization: JWT
|
153
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
154
|
+
end
|
155
|
+
|
156
|
+
api_instance = AsposeDiagramCloud::StorageApi.new
|
157
|
+
|
158
|
+
path = "path_example" # String | Folder path to create e.g. 'folder_1/folder_2/'
|
159
|
+
|
160
|
+
opts = {
|
161
|
+
storage_name: "storage_name_example" # String | Storage name
|
162
|
+
}
|
163
|
+
|
164
|
+
begin
|
165
|
+
#Create the folder
|
166
|
+
api_instance.create_folder(path, opts)
|
167
|
+
rescue AsposeDiagramCloud::ApiError => e
|
168
|
+
puts "Exception when calling StorageApi->create_folder: #{e}"
|
169
|
+
end
|
170
|
+
```
|
171
|
+
|
172
|
+
### Parameters
|
173
|
+
|
174
|
+
Name | Type | Description | Notes
|
175
|
+
------------- | ------------- | ------------- | -------------
|
176
|
+
**path** | **String**| Folder path to create e.g. 'folder_1/folder_2/' |
|
177
|
+
**storage_name** | **String**| Storage name | [optional]
|
178
|
+
|
179
|
+
### Return type
|
180
|
+
|
181
|
+
nil (empty response body)
|
182
|
+
|
183
|
+
### Authorization
|
184
|
+
|
185
|
+
[JWT](../README.md#JWT)
|
186
|
+
|
187
|
+
### HTTP request headers
|
188
|
+
|
189
|
+
- **Content-Type**: application/json
|
190
|
+
- **Accept**: application/json
|
191
|
+
|
192
|
+
|
193
|
+
|
194
|
+
# **delete_file**
|
195
|
+
> delete_file(path, opts)
|
196
|
+
|
197
|
+
Delete file
|
198
|
+
|
199
|
+
### Example
|
200
|
+
```ruby
|
201
|
+
# load the gem
|
202
|
+
require 'AsposeDiagramCloud'
|
203
|
+
# setup authorization
|
204
|
+
AsposeDiagramCloud.configure do |config|
|
205
|
+
# Configure OAuth2 access token for authorization: JWT
|
206
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
207
|
+
end
|
208
|
+
|
209
|
+
api_instance = AsposeDiagramCloud::StorageApi.new
|
210
|
+
|
211
|
+
path = "path_example" # String | File path e.g. '/folder/file.ext'
|
212
|
+
|
213
|
+
opts = {
|
214
|
+
storage_name: "storage_name_example", # String | Storage name
|
215
|
+
version_id: "version_id_example" # String | File version ID to delete
|
216
|
+
}
|
217
|
+
|
218
|
+
begin
|
219
|
+
#Delete file
|
220
|
+
api_instance.delete_file(path, opts)
|
221
|
+
rescue AsposeDiagramCloud::ApiError => e
|
222
|
+
puts "Exception when calling StorageApi->delete_file: #{e}"
|
223
|
+
end
|
224
|
+
```
|
225
|
+
|
226
|
+
### Parameters
|
227
|
+
|
228
|
+
Name | Type | Description | Notes
|
229
|
+
------------- | ------------- | ------------- | -------------
|
230
|
+
**path** | **String**| File path e.g. '/folder/file.ext' |
|
231
|
+
**storage_name** | **String**| Storage name | [optional]
|
232
|
+
**version_id** | **String**| File version ID to delete | [optional]
|
233
|
+
|
234
|
+
### Return type
|
235
|
+
|
236
|
+
nil (empty response body)
|
237
|
+
|
238
|
+
### Authorization
|
239
|
+
|
240
|
+
[JWT](../README.md#JWT)
|
241
|
+
|
242
|
+
### HTTP request headers
|
243
|
+
|
244
|
+
- **Content-Type**: application/json
|
245
|
+
- **Accept**: application/json
|
246
|
+
|
247
|
+
|
248
|
+
|
249
|
+
# **delete_folder**
|
250
|
+
> delete_folder(path, opts)
|
251
|
+
|
252
|
+
Delete folder
|
253
|
+
|
254
|
+
### Example
|
255
|
+
```ruby
|
256
|
+
# load the gem
|
257
|
+
require 'AsposeDiagramCloud'
|
258
|
+
# setup authorization
|
259
|
+
AsposeDiagramCloud.configure do |config|
|
260
|
+
# Configure OAuth2 access token for authorization: JWT
|
261
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
262
|
+
end
|
263
|
+
|
264
|
+
api_instance = AsposeDiagramCloud::StorageApi.new
|
265
|
+
|
266
|
+
path = "path_example" # String | Folder path e.g. '/folder'
|
267
|
+
|
268
|
+
opts = {
|
269
|
+
storage_name: "storage_name_example", # String | Storage name
|
270
|
+
recursive: false # BOOLEAN | Enable to delete folders, subfolders and files
|
271
|
+
}
|
272
|
+
|
273
|
+
begin
|
274
|
+
#Delete folder
|
275
|
+
api_instance.delete_folder(path, opts)
|
276
|
+
rescue AsposeDiagramCloud::ApiError => e
|
277
|
+
puts "Exception when calling StorageApi->delete_folder: #{e}"
|
278
|
+
end
|
279
|
+
```
|
280
|
+
|
281
|
+
### Parameters
|
282
|
+
|
283
|
+
Name | Type | Description | Notes
|
284
|
+
------------- | ------------- | ------------- | -------------
|
285
|
+
**path** | **String**| Folder path e.g. '/folder' |
|
286
|
+
**storage_name** | **String**| Storage name | [optional]
|
287
|
+
**recursive** | **BOOLEAN**| Enable to delete folders, subfolders and files | [optional] [default to false]
|
288
|
+
|
289
|
+
### Return type
|
290
|
+
|
291
|
+
nil (empty response body)
|
292
|
+
|
293
|
+
### Authorization
|
294
|
+
|
295
|
+
[JWT](../README.md#JWT)
|
296
|
+
|
297
|
+
### HTTP request headers
|
298
|
+
|
299
|
+
- **Content-Type**: application/json
|
300
|
+
- **Accept**: application/json
|
301
|
+
|
302
|
+
|
303
|
+
|
304
|
+
# **download_file**
|
305
|
+
> File download_file(path, opts)
|
306
|
+
|
307
|
+
Download file
|
308
|
+
|
309
|
+
### Example
|
310
|
+
```ruby
|
311
|
+
# load the gem
|
312
|
+
require 'AsposeDiagramCloud'
|
313
|
+
# setup authorization
|
314
|
+
AsposeDiagramCloud.configure do |config|
|
315
|
+
# Configure OAuth2 access token for authorization: JWT
|
316
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
317
|
+
end
|
318
|
+
|
319
|
+
api_instance = AsposeDiagramCloud::StorageApi.new
|
320
|
+
|
321
|
+
path = "path_example" # String | File path e.g. '/folder/file.ext'
|
322
|
+
|
323
|
+
opts = {
|
324
|
+
storage_name: "storage_name_example", # String | Storage name
|
325
|
+
version_id: "version_id_example" # String | File version ID to download
|
326
|
+
}
|
327
|
+
|
328
|
+
begin
|
329
|
+
#Download file
|
330
|
+
result = api_instance.download_file(path, opts)
|
331
|
+
p result
|
332
|
+
rescue AsposeDiagramCloud::ApiError => e
|
333
|
+
puts "Exception when calling StorageApi->download_file: #{e}"
|
334
|
+
end
|
335
|
+
```
|
336
|
+
|
337
|
+
### Parameters
|
338
|
+
|
339
|
+
Name | Type | Description | Notes
|
340
|
+
------------- | ------------- | ------------- | -------------
|
341
|
+
**path** | **String**| File path e.g. '/folder/file.ext' |
|
342
|
+
**storage_name** | **String**| Storage name | [optional]
|
343
|
+
**version_id** | **String**| File version ID to download | [optional]
|
344
|
+
|
345
|
+
### Return type
|
346
|
+
|
347
|
+
**File**
|
348
|
+
|
349
|
+
### Authorization
|
350
|
+
|
351
|
+
[JWT](../README.md#JWT)
|
352
|
+
|
353
|
+
### HTTP request headers
|
354
|
+
|
355
|
+
- **Content-Type**: application/json
|
356
|
+
- **Accept**: multipart/form-data
|
357
|
+
|
358
|
+
|
359
|
+
|
360
|
+
# **get_disc_usage**
|
361
|
+
> DiscUsage get_disc_usage(opts)
|
362
|
+
|
363
|
+
Get disc usage
|
364
|
+
|
365
|
+
### Example
|
366
|
+
```ruby
|
367
|
+
# load the gem
|
368
|
+
require 'AsposeDiagramCloud'
|
369
|
+
# setup authorization
|
370
|
+
AsposeDiagramCloud.configure do |config|
|
371
|
+
# Configure OAuth2 access token for authorization: JWT
|
372
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
373
|
+
end
|
374
|
+
|
375
|
+
api_instance = AsposeDiagramCloud::StorageApi.new
|
376
|
+
|
377
|
+
opts = {
|
378
|
+
storage_name: "storage_name_example" # String | Storage name
|
379
|
+
}
|
380
|
+
|
381
|
+
begin
|
382
|
+
#Get disc usage
|
383
|
+
result = api_instance.get_disc_usage(opts)
|
384
|
+
p result
|
385
|
+
rescue AsposeDiagramCloud::ApiError => e
|
386
|
+
puts "Exception when calling StorageApi->get_disc_usage: #{e}"
|
387
|
+
end
|
388
|
+
```
|
389
|
+
|
390
|
+
### Parameters
|
391
|
+
|
392
|
+
Name | Type | Description | Notes
|
393
|
+
------------- | ------------- | ------------- | -------------
|
394
|
+
**storage_name** | **String**| Storage name | [optional]
|
395
|
+
|
396
|
+
### Return type
|
397
|
+
|
398
|
+
[**DiscUsage**](DiscUsage.md)
|
399
|
+
|
400
|
+
### Authorization
|
401
|
+
|
402
|
+
[JWT](../README.md#JWT)
|
403
|
+
|
404
|
+
### HTTP request headers
|
405
|
+
|
406
|
+
- **Content-Type**: application/json
|
407
|
+
- **Accept**: application/json
|
408
|
+
|
409
|
+
|
410
|
+
|
411
|
+
# **get_file_versions**
|
412
|
+
> FileVersions get_file_versions(path, opts)
|
413
|
+
|
414
|
+
Get file versions
|
415
|
+
|
416
|
+
### Example
|
417
|
+
```ruby
|
418
|
+
# load the gem
|
419
|
+
require 'AsposeDiagramCloud'
|
420
|
+
# setup authorization
|
421
|
+
AsposeDiagramCloud.configure do |config|
|
422
|
+
# Configure OAuth2 access token for authorization: JWT
|
423
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
424
|
+
end
|
425
|
+
|
426
|
+
api_instance = AsposeDiagramCloud::StorageApi.new
|
427
|
+
|
428
|
+
path = "path_example" # String | File path e.g. '/file.ext'
|
429
|
+
|
430
|
+
opts = {
|
431
|
+
storage_name: "storage_name_example" # String | Storage name
|
432
|
+
}
|
433
|
+
|
434
|
+
begin
|
435
|
+
#Get file versions
|
436
|
+
result = api_instance.get_file_versions(path, opts)
|
437
|
+
p result
|
438
|
+
rescue AsposeDiagramCloud::ApiError => e
|
439
|
+
puts "Exception when calling StorageApi->get_file_versions: #{e}"
|
440
|
+
end
|
441
|
+
```
|
442
|
+
|
443
|
+
### Parameters
|
444
|
+
|
445
|
+
Name | Type | Description | Notes
|
446
|
+
------------- | ------------- | ------------- | -------------
|
447
|
+
**path** | **String**| File path e.g. '/file.ext' |
|
448
|
+
**storage_name** | **String**| Storage name | [optional]
|
449
|
+
|
450
|
+
### Return type
|
451
|
+
|
452
|
+
[**FileVersions**](FileVersions.md)
|
453
|
+
|
454
|
+
### Authorization
|
455
|
+
|
456
|
+
[JWT](../README.md#JWT)
|
457
|
+
|
458
|
+
### HTTP request headers
|
459
|
+
|
460
|
+
- **Content-Type**: application/json
|
461
|
+
- **Accept**: application/json
|
462
|
+
|
463
|
+
|
464
|
+
|
465
|
+
# **get_files_list**
|
466
|
+
> FilesList get_files_list(path, opts)
|
467
|
+
|
468
|
+
Get all files and folders within a folder
|
469
|
+
|
470
|
+
### Example
|
471
|
+
```ruby
|
472
|
+
# load the gem
|
473
|
+
require 'AsposeDiagramCloud'
|
474
|
+
# setup authorization
|
475
|
+
AsposeDiagramCloud.configure do |config|
|
476
|
+
# Configure OAuth2 access token for authorization: JWT
|
477
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
478
|
+
end
|
479
|
+
|
480
|
+
api_instance = AsposeDiagramCloud::StorageApi.new
|
481
|
+
|
482
|
+
path = "path_example" # String | Folder path e.g. '/folder'
|
483
|
+
|
484
|
+
opts = {
|
485
|
+
storage_name: "storage_name_example" # String | Storage name
|
486
|
+
}
|
487
|
+
|
488
|
+
begin
|
489
|
+
#Get all files and folders within a folder
|
490
|
+
result = api_instance.get_files_list(path, opts)
|
491
|
+
p result
|
492
|
+
rescue AsposeDiagramCloud::ApiError => e
|
493
|
+
puts "Exception when calling StorageApi->get_files_list: #{e}"
|
494
|
+
end
|
495
|
+
```
|
496
|
+
|
497
|
+
### Parameters
|
498
|
+
|
499
|
+
Name | Type | Description | Notes
|
500
|
+
------------- | ------------- | ------------- | -------------
|
501
|
+
**path** | **String**| Folder path e.g. '/folder' |
|
502
|
+
**storage_name** | **String**| Storage name | [optional]
|
503
|
+
|
504
|
+
### Return type
|
505
|
+
|
506
|
+
[**FilesList**](FilesList.md)
|
507
|
+
|
508
|
+
### Authorization
|
509
|
+
|
510
|
+
[JWT](../README.md#JWT)
|
511
|
+
|
512
|
+
### HTTP request headers
|
513
|
+
|
514
|
+
- **Content-Type**: application/json
|
515
|
+
- **Accept**: application/json
|
516
|
+
|
517
|
+
|
518
|
+
|
519
|
+
# **move_file**
|
520
|
+
> move_file(src_path, dest_path, opts)
|
521
|
+
|
522
|
+
Move file
|
523
|
+
|
524
|
+
### Example
|
525
|
+
```ruby
|
526
|
+
# load the gem
|
527
|
+
require 'AsposeDiagramCloud'
|
528
|
+
# setup authorization
|
529
|
+
AsposeDiagramCloud.configure do |config|
|
530
|
+
# Configure OAuth2 access token for authorization: JWT
|
531
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
532
|
+
end
|
533
|
+
|
534
|
+
api_instance = AsposeDiagramCloud::StorageApi.new
|
535
|
+
|
536
|
+
src_path = "src_path_example" # String | Source file path e.g. '/src.ext'
|
537
|
+
|
538
|
+
dest_path = "dest_path_example" # String | Destination file path e.g. '/dest.ext'
|
539
|
+
|
540
|
+
opts = {
|
541
|
+
src_storage_name: "src_storage_name_example", # String | Source storage name
|
542
|
+
dest_storage_name: "dest_storage_name_example", # String | Destination storage name
|
543
|
+
version_id: "version_id_example" # String | File version ID to move
|
544
|
+
}
|
545
|
+
|
546
|
+
begin
|
547
|
+
#Move file
|
548
|
+
api_instance.move_file(src_path, dest_path, opts)
|
549
|
+
rescue AsposeDiagramCloud::ApiError => e
|
550
|
+
puts "Exception when calling StorageApi->move_file: #{e}"
|
551
|
+
end
|
552
|
+
```
|
553
|
+
|
554
|
+
### Parameters
|
555
|
+
|
556
|
+
Name | Type | Description | Notes
|
557
|
+
------------- | ------------- | ------------- | -------------
|
558
|
+
**src_path** | **String**| Source file path e.g. '/src.ext' |
|
559
|
+
**dest_path** | **String**| Destination file path e.g. '/dest.ext' |
|
560
|
+
**src_storage_name** | **String**| Source storage name | [optional]
|
561
|
+
**dest_storage_name** | **String**| Destination storage name | [optional]
|
562
|
+
**version_id** | **String**| File version ID to move | [optional]
|
563
|
+
|
564
|
+
### Return type
|
565
|
+
|
566
|
+
nil (empty response body)
|
567
|
+
|
568
|
+
### Authorization
|
569
|
+
|
570
|
+
[JWT](../README.md#JWT)
|
571
|
+
|
572
|
+
### HTTP request headers
|
573
|
+
|
574
|
+
- **Content-Type**: application/json
|
575
|
+
- **Accept**: application/json
|
576
|
+
|
577
|
+
|
578
|
+
|
579
|
+
# **move_folder**
|
580
|
+
> move_folder(src_path, dest_path, opts)
|
581
|
+
|
582
|
+
Move folder
|
583
|
+
|
584
|
+
### Example
|
585
|
+
```ruby
|
586
|
+
# load the gem
|
587
|
+
require 'AsposeDiagramCloud'
|
588
|
+
# setup authorization
|
589
|
+
AsposeDiagramCloud.configure do |config|
|
590
|
+
# Configure OAuth2 access token for authorization: JWT
|
591
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
592
|
+
end
|
593
|
+
|
594
|
+
api_instance = AsposeDiagramCloud::StorageApi.new
|
595
|
+
|
596
|
+
src_path = "src_path_example" # String | Folder path to move e.g. '/folder'
|
597
|
+
|
598
|
+
dest_path = "dest_path_example" # String | Destination folder path to move to e.g '/dst'
|
599
|
+
|
600
|
+
opts = {
|
601
|
+
src_storage_name: "src_storage_name_example", # String | Source storage name
|
602
|
+
dest_storage_name: "dest_storage_name_example" # String | Destination storage name
|
603
|
+
}
|
604
|
+
|
605
|
+
begin
|
606
|
+
#Move folder
|
607
|
+
api_instance.move_folder(src_path, dest_path, opts)
|
608
|
+
rescue AsposeDiagramCloud::ApiError => e
|
609
|
+
puts "Exception when calling StorageApi->move_folder: #{e}"
|
610
|
+
end
|
611
|
+
```
|
612
|
+
|
613
|
+
### Parameters
|
614
|
+
|
615
|
+
Name | Type | Description | Notes
|
616
|
+
------------- | ------------- | ------------- | -------------
|
617
|
+
**src_path** | **String**| Folder path to move e.g. '/folder' |
|
618
|
+
**dest_path** | **String**| Destination folder path to move to e.g '/dst' |
|
619
|
+
**src_storage_name** | **String**| Source storage name | [optional]
|
620
|
+
**dest_storage_name** | **String**| Destination storage name | [optional]
|
621
|
+
|
622
|
+
### Return type
|
623
|
+
|
624
|
+
nil (empty response body)
|
625
|
+
|
626
|
+
### Authorization
|
627
|
+
|
628
|
+
[JWT](../README.md#JWT)
|
629
|
+
|
630
|
+
### HTTP request headers
|
631
|
+
|
632
|
+
- **Content-Type**: application/json
|
633
|
+
- **Accept**: application/json
|
634
|
+
|
635
|
+
|
636
|
+
|
637
|
+
# **object_exists**
|
638
|
+
> ObjectExist object_exists(path, opts)
|
639
|
+
|
640
|
+
Check if file or folder exists
|
641
|
+
|
642
|
+
### Example
|
643
|
+
```ruby
|
644
|
+
# load the gem
|
645
|
+
require 'AsposeDiagramCloud'
|
646
|
+
# setup authorization
|
647
|
+
AsposeDiagramCloud.configure do |config|
|
648
|
+
# Configure OAuth2 access token for authorization: JWT
|
649
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
650
|
+
end
|
651
|
+
|
652
|
+
api_instance = AsposeDiagramCloud::StorageApi.new
|
653
|
+
|
654
|
+
path = "path_example" # String | File or folder path e.g. '/file.ext' or '/folder'
|
655
|
+
|
656
|
+
opts = {
|
657
|
+
storage_name: "storage_name_example", # String | Storage name
|
658
|
+
version_id: "version_id_example" # String | File version ID
|
659
|
+
}
|
660
|
+
|
661
|
+
begin
|
662
|
+
#Check if file or folder exists
|
663
|
+
result = api_instance.object_exists(path, opts)
|
664
|
+
p result
|
665
|
+
rescue AsposeDiagramCloud::ApiError => e
|
666
|
+
puts "Exception when calling StorageApi->object_exists: #{e}"
|
667
|
+
end
|
668
|
+
```
|
669
|
+
|
670
|
+
### Parameters
|
671
|
+
|
672
|
+
Name | Type | Description | Notes
|
673
|
+
------------- | ------------- | ------------- | -------------
|
674
|
+
**path** | **String**| File or folder path e.g. '/file.ext' or '/folder' |
|
675
|
+
**storage_name** | **String**| Storage name | [optional]
|
676
|
+
**version_id** | **String**| File version ID | [optional]
|
677
|
+
|
678
|
+
### Return type
|
679
|
+
|
680
|
+
[**ObjectExist**](ObjectExist.md)
|
681
|
+
|
682
|
+
### Authorization
|
683
|
+
|
684
|
+
[JWT](../README.md#JWT)
|
685
|
+
|
686
|
+
### HTTP request headers
|
687
|
+
|
688
|
+
- **Content-Type**: application/json
|
689
|
+
- **Accept**: application/json
|
690
|
+
|
691
|
+
|
692
|
+
|
693
|
+
# **storage_exists**
|
694
|
+
> StorageExist storage_exists(storage_name)
|
695
|
+
|
696
|
+
Check if storage exists
|
697
|
+
|
698
|
+
### Example
|
699
|
+
```ruby
|
700
|
+
# load the gem
|
701
|
+
require 'AsposeDiagramCloud'
|
702
|
+
# setup authorization
|
703
|
+
AsposeDiagramCloud.configure do |config|
|
704
|
+
# Configure OAuth2 access token for authorization: JWT
|
705
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
706
|
+
end
|
707
|
+
|
708
|
+
api_instance = AsposeDiagramCloud::StorageApi.new
|
709
|
+
|
710
|
+
storage_name = "storage_name_example" # String | Storage name
|
711
|
+
|
712
|
+
|
713
|
+
begin
|
714
|
+
#Check if storage exists
|
715
|
+
result = api_instance.storage_exists(storage_name)
|
716
|
+
p result
|
717
|
+
rescue AsposeDiagramCloud::ApiError => e
|
718
|
+
puts "Exception when calling StorageApi->storage_exists: #{e}"
|
719
|
+
end
|
720
|
+
```
|
721
|
+
|
722
|
+
### Parameters
|
723
|
+
|
724
|
+
Name | Type | Description | Notes
|
725
|
+
------------- | ------------- | ------------- | -------------
|
726
|
+
**storage_name** | **String**| Storage name |
|
727
|
+
|
728
|
+
### Return type
|
729
|
+
|
730
|
+
[**StorageExist**](StorageExist.md)
|
731
|
+
|
732
|
+
### Authorization
|
733
|
+
|
734
|
+
[JWT](../README.md#JWT)
|
735
|
+
|
736
|
+
### HTTP request headers
|
737
|
+
|
738
|
+
- **Content-Type**: application/json
|
739
|
+
- **Accept**: application/json
|
740
|
+
|
741
|
+
|
742
|
+
|
743
|
+
# **upload_file**
|
744
|
+
> FilesUploadResult upload_file(path, file, opts)
|
745
|
+
|
746
|
+
Upload file
|
747
|
+
|
748
|
+
### Example
|
749
|
+
```ruby
|
750
|
+
# load the gem
|
751
|
+
require 'AsposeDiagramCloud'
|
752
|
+
# setup authorization
|
753
|
+
AsposeDiagramCloud.configure do |config|
|
754
|
+
# Configure OAuth2 access token for authorization: JWT
|
755
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
756
|
+
end
|
757
|
+
|
758
|
+
api_instance = AsposeDiagramCloud::StorageApi.new
|
759
|
+
|
760
|
+
path = "path_example" # String | Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext If the content is multipart and path does not contains the file name it tries to get them from filename parameter from Content-Disposition header.
|
761
|
+
|
762
|
+
file = File.new("/path/to/file.txt") # File | File to upload
|
763
|
+
|
764
|
+
opts = {
|
765
|
+
storage_name: "storage_name_example" # String | Storage name
|
766
|
+
}
|
767
|
+
|
768
|
+
begin
|
769
|
+
#Upload file
|
770
|
+
result = api_instance.upload_file(path, file, opts)
|
771
|
+
p result
|
772
|
+
rescue AsposeDiagramCloud::ApiError => e
|
773
|
+
puts "Exception when calling StorageApi->upload_file: #{e}"
|
774
|
+
end
|
775
|
+
```
|
776
|
+
|
777
|
+
### Parameters
|
778
|
+
|
779
|
+
Name | Type | Description | Notes
|
780
|
+
------------- | ------------- | ------------- | -------------
|
781
|
+
**path** | **String**| Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext If the content is multipart and path does not contains the file name it tries to get them from filename parameter from Content-Disposition header. |
|
782
|
+
**file** | **File**| File to upload |
|
783
|
+
**storage_name** | **String**| Storage name | [optional]
|
784
|
+
|
785
|
+
### Return type
|
786
|
+
|
787
|
+
[**FilesUploadResult**](FilesUploadResult.md)
|
788
|
+
|
789
|
+
### Authorization
|
790
|
+
|
791
|
+
[JWT](../README.md#JWT)
|
792
|
+
|
793
|
+
### HTTP request headers
|
794
|
+
|
795
|
+
- **Content-Type**: multipart/form-data
|
796
|
+
- **Accept**: application/json
|
797
|
+
|
798
|
+
|
799
|
+
|