# \FolderApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**add_owner_to_folder**](FolderApi.md#add_owner_to_folder) | **POST** /w/{workspace}/folders/addowner/{name} | add owner to folder
[**create_folder**](FolderApi.md#create_folder) | **POST** /w/{workspace}/folders/create | create folder
[**delete_folder**](FolderApi.md#delete_folder) | **DELETE** /w/{workspace}/folders/delete/{name} | delete folder
[**exists_folder**](FolderApi.md#exists_folder) | **GET** /w/{workspace}/folders/exists/{name} | exists folder
[**get_folder**](FolderApi.md#get_folder) | **GET** /w/{workspace}/folders/get/{name} | get folder
[**get_folder_permission_history**](FolderApi.md#get_folder_permission_history) | **GET** /w/{workspace}/folders_history/get/{name} | get folder permission history
[**get_folder_usage**](FolderApi.md#get_folder_usage) | **GET** /w/{workspace}/folders/getusage/{name} | get folder usage
[**list_folder_names**](FolderApi.md#list_folder_names) | **GET** /w/{workspace}/folders/listnames | list folder names
[**list_folders**](FolderApi.md#list_folders) | **GET** /w/{workspace}/folders/list | list folders
[**remove_owner_to_folder**](FolderApi.md#remove_owner_to_folder) | **POST** /w/{workspace}/folders/removeowner/{name} | remove owner to folder
[**update_folder**](FolderApi.md#update_folder) | **POST** /w/{workspace}/folders/update/{name} | update folder



## add_owner_to_folder

> String add_owner_to_folder(workspace, name, add_owner_to_folder_request)
add owner to folder

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**name** | **String** |  | [required] |
**add_owner_to_folder_request** | [**AddOwnerToFolderRequest**](AddOwnerToFolderRequest.md) | owner user to folder | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

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

[[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)


## create_folder

> String create_folder(workspace, create_folder_request)
create folder

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**create_folder_request** | [**CreateFolderRequest**](CreateFolderRequest.md) | create folder | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

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

[[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)


## delete_folder

> String delete_folder(workspace, name)
delete folder

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**name** | **String** |  | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

[[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)


## exists_folder

> bool exists_folder(workspace, name)
exists folder

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**name** | **String** |  | [required] |

### Return type

**bool**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **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)


## get_folder

> models::Folder get_folder(workspace, name)
get folder

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**name** | **String** |  | [required] |

### Return type

[**models::Folder**](Folder.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **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)


## get_folder_permission_history

> Vec<models::GetFolderPermissionHistory200ResponseInner> get_folder_permission_history(workspace, name, page, per_page)
get folder permission history

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**name** | **String** |  | [required] |
**page** | Option<**i32**> | which page to return (start at 1, default 1) |  |
**per_page** | Option<**i32**> | number of items to return for a given page (default 30, max 100) |  |

### Return type

[**Vec<models::GetFolderPermissionHistory200ResponseInner>**](getFolderPermissionHistory_200_response_inner.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **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)


## get_folder_usage

> models::GetFolderUsage200Response get_folder_usage(workspace, name)
get folder usage

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**name** | **String** |  | [required] |

### Return type

[**models::GetFolderUsage200Response**](getFolderUsage_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **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)


## list_folder_names

> Vec<String> list_folder_names(workspace, only_member_of)
list folder names

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**only_member_of** | Option<**bool**> | only list the folders the user is member of (default false) |  |

### Return type

**Vec<String>**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **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)


## list_folders

> Vec<models::Folder> list_folders(workspace, page, per_page)
list folders

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**page** | Option<**i32**> | which page to return (start at 1, default 1) |  |
**per_page** | Option<**i32**> | number of items to return for a given page (default 30, max 100) |  |

### Return type

[**Vec<models::Folder>**](Folder.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **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)


## remove_owner_to_folder

> String remove_owner_to_folder(workspace, name, remove_owner_to_folder_request)
remove owner to folder

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**name** | **String** |  | [required] |
**remove_owner_to_folder_request** | [**RemoveOwnerToFolderRequest**](RemoveOwnerToFolderRequest.md) | added owner to folder | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

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

[[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)


## update_folder

> String update_folder(workspace, name, update_folder_request)
update folder

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**name** | **String** |  | [required] |
**update_folder_request** | [**UpdateFolderRequest**](UpdateFolderRequest.md) | update folder | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

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

[[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)

