view release on metacpan or  search on metacpan

docs/ThreeDCloudApi.md  view on Meta::CPAN

# AsposeThreeDCloud::ThreeDCloudApi

## Load the API package
```perl
use AsposeThreeDCloud::Object::ThreeDCloudApi;
```

All URIs are relative to *https://api.aspose.cloud/v3.0*

Method | HTTP request | Description
------------- | ------------- | -------------
[**copy_file**](ThreeDCloudApi.md#copy_file) | **PUT** /3d/storage/file/copy/{srcPath} | Copy file
[**copy_folder**](ThreeDCloudApi.md#copy_folder) | **PUT** /3d/storage/folder/copy/{srcPath} | Copy folder
[**create_folder**](ThreeDCloudApi.md#create_folder) | **PUT** /3d/storage/folder/{path} | Create the folder
[**delete_file**](ThreeDCloudApi.md#delete_file) | **DELETE** /3d/storage/file/{path} | Delete file
[**delete_folder**](ThreeDCloudApi.md#delete_folder) | **DELETE** /3d/storage/folder/{path} | Delete folder
[**delete_nodes**](ThreeDCloudApi.md#delete_nodes) | **DELETE** /3d/nodes | Delete nodes from scene,nodes are addressed by Object Addressing Path
[**download_file**](ThreeDCloudApi.md#download_file) | **GET** /3d/storage/file/{path} | Download file
[**get_disc_usage**](ThreeDCloudApi.md#get_disc_usage) | **GET** /3d/storage/disc | Get disc usage
[**get_file_versions**](ThreeDCloudApi.md#get_file_versions) | **GET** /3d/storage/version/{path} | Get file versions
[**get_files_list**](ThreeDCloudApi.md#get_files_list) | **GET** /3d/storage/folder/{path} | Get all files and folders within a folder
[**move_file**](ThreeDCloudApi.md#move_file) | **PUT** /3d/storage/file/move/{srcPath} | Move file
[**move_folder**](ThreeDCloudApi.md#move_folder) | **PUT** /3d/storage/folder/move/{srcPath} | Move folder
[**o_auth_post**](ThreeDCloudApi.md#o_auth_post) | **POST** /connect/token | Get Access token
[**object_exists**](ThreeDCloudApi.md#object_exists) | **GET** /3d/storage/exist/{path} | Check if file or folder exists
[**post_convert_by_format**](ThreeDCloudApi.md#post_convert_by_format) | **POST** /3d/saveas/newformat | Convert file on server to other formats with fileformat parameter             
[**post_convert_by_opt**](ThreeDCloudApi.md#post_convert_by_opt) | **POST** /3d/saveas/saveoption | Convert file on server to other formats with saveOption parameter             
[**post_create**](ThreeDCloudApi.md#post_create) | **POST** /3d/new | Create new file with specified format.             
[**post_model**](ThreeDCloudApi.md#post_model) | **POST** /3d/root | Parametric Modeling, Create a Entity with size and located in ...
[**post_pdf_raw_data**](ThreeDCloudApi.md#post_pdf_raw_data) | **POST** /3d/extract/rawdata | Extract raw data(without any modification) from a password protected PDF file             
[**post_save_as_part**](ThreeDCloudApi.md#post_save_as_part) | **POST** /3d/saveas/part | Convert part of the file into different format
[**post_scene_to_file**](ThreeDCloudApi.md#post_scene_to_file) | **POST** /3d/extract/scene | Extract and save in different format             
[**post_triangulate_new**](ThreeDCloudApi.md#post_triangulate_new) | **POST** /3d/triangulate/new | Triangulate whole file and save to the different file
[**post_triangulate_original**](ThreeDCloudApi.md#post_triangulate_original) | **POST** /3d/triangulate/original | Triangulate whole file and save to original file
[**post_triangulate_part**](ThreeDCloudApi.md#post_triangulate_part) | **POST** /3d/triangulate/part | Triangulate part of the scene(Specified by OAP) and save the scene to different file 
[**storage_exists**](ThreeDCloudApi.md#storage_exists) | **GET** /3d/storage/{storageName}/exist | Check if storage exists
[**upload_file**](ThreeDCloudApi.md#upload_file) | **PUT** /3d/storage/file/{path} | Upload file


# **copy_file**
> copy_file(src_path => $src_path, dest_path => $dest_path, src_storage_name => $src_storage_name, dest_storage_name => $dest_storage_name, version_id => $version_id)

Copy file

### Example 
```perl
use Data::Dumper;
use AsposeThreeDCloud::ThreeDCloudApi;
my $api_instance = AsposeThreeDCloud::ThreeDCloudApi->new(

    # Configure OAuth2 access token for authorization: JWT
    access_token => 'YOUR_ACCESS_TOKEN',
);

my $src_path = 'src_path_example'; # string | Source file path e.g. '/folder/file.ext'
my $dest_path = 'dest_path_example'; # string | Destination file path
my $src_storage_name = 'src_storage_name_example'; # string | Source storage name
my $dest_storage_name = 'dest_storage_name_example'; # string | Destination storage name
my $version_id = 'version_id_example'; # string | File version ID to copy

eval { 
    $api_instance->copy_file(src_path => $src_path, dest_path => $dest_path, src_storage_name => $src_storage_name, dest_storage_name => $dest_storage_name, version_id => $version_id);
};
if ($@) {
    warn "Exception when calling ThreeDCloudApi->copy_file: $@\n";
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **src_path** | **string**| Source file path e.g. '/folder/file.ext' | 
 **dest_path** | **string**| Destination file path | 
 **src_storage_name** | **string**| Source storage name | [optional] 
 **dest_storage_name** | **string**| Destination storage name | [optional] 
 **version_id** | **string**| File version ID to copy | [optional] 

### Return type

void (empty response body)

### Authorization

[JWT](../README.md#JWT)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **copy_folder**
> copy_folder(src_path => $src_path, dest_path => $dest_path, src_storage_name => $src_storage_name, dest_storage_name => $dest_storage_name)

Copy folder

docs/ThreeDCloudApi.md  view on Meta::CPAN

[**File**](File.md)

### Authorization

[JWT](../README.md#JWT)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **storage_exists**
> StorageExist storage_exists(storage_name => $storage_name)

Check if storage exists

### Example 
```perl
use Data::Dumper;
use AsposeThreeDCloud::ThreeDCloudApi;
my $api_instance = AsposeThreeDCloud::ThreeDCloudApi->new(

    # Configure OAuth2 access token for authorization: JWT
    access_token => 'YOUR_ACCESS_TOKEN',
);

my $storage_name = 'storage_name_example'; # string | Storage name

eval { 
    my $result = $api_instance->storage_exists(storage_name => $storage_name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ThreeDCloudApi->storage_exists: $@\n";
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **storage_name** | **string**| Storage name | 

### Return type

[**StorageExist**](StorageExist.md)

### Authorization

[JWT](../README.md#JWT)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **upload_file**
> FilesUploadResult upload_file(path => $path, file => $file, storage_name => $storage_name)

Upload file

### Example 
```perl
use Data::Dumper;
use AsposeThreeDCloud::ThreeDCloudApi;
my $api_instance = AsposeThreeDCloud::ThreeDCloudApi->new(

    # Configure OAuth2 access token for authorization: JWT
    access_token => 'YOUR_ACCESS_TOKEN',
);

my $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 param...
my $file = '/path/to/file.txt'; # File | File to upload
my $storage_name = 'storage_name_example'; # string | Storage name

eval { 
    my $result = $api_instance->upload_file(path => $path, file => $file, storage_name => $storage_name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ThreeDCloudApi->upload_file: $@\n";
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **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          ...
 **file** | **File**| File to upload | 
 **storage_name** | **string**| Storage name | [optional] 

### Return type

[**FilesUploadResult**](FilesUploadResult.md)

### Authorization

[JWT](../README.md#JWT)

### HTTP request headers

 - **Content-Type**: multipart/form-data
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)