mirror of
https://github.com/immich-app/immich.git
synced 2024-12-23 02:06:15 +02:00
171 lines
5.6 KiB
Markdown
171 lines
5.6 KiB
Markdown
|
# openapi.api.TrashApi
|
||
|
|
||
|
## Load the API package
|
||
|
```dart
|
||
|
import 'package:openapi/api.dart';
|
||
|
```
|
||
|
|
||
|
All URIs are relative to */api*
|
||
|
|
||
|
Method | HTTP request | Description
|
||
|
------------- | ------------- | -------------
|
||
|
[**emptyTrash**](TrashApi.md#emptytrash) | **POST** /trash/empty |
|
||
|
[**restoreAssets**](TrashApi.md#restoreassets) | **POST** /trash/restore/assets |
|
||
|
[**restoreTrash**](TrashApi.md#restoretrash) | **POST** /trash/restore |
|
||
|
|
||
|
|
||
|
# **emptyTrash**
|
||
|
> emptyTrash()
|
||
|
|
||
|
|
||
|
|
||
|
### Example
|
||
|
```dart
|
||
|
import 'package:openapi/api.dart';
|
||
|
// TODO Configure API key authorization: cookie
|
||
|
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
|
||
|
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
|
||
|
// TODO Configure API key authorization: api_key
|
||
|
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
|
||
|
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
|
||
|
// TODO Configure HTTP Bearer authorization: bearer
|
||
|
// Case 1. Use String Token
|
||
|
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
|
||
|
// Case 2. Use Function which generate token.
|
||
|
// String yourTokenGeneratorFunction() { ... }
|
||
|
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);
|
||
|
|
||
|
final api_instance = TrashApi();
|
||
|
|
||
|
try {
|
||
|
api_instance.emptyTrash();
|
||
|
} catch (e) {
|
||
|
print('Exception when calling TrashApi->emptyTrash: $e\n');
|
||
|
}
|
||
|
```
|
||
|
|
||
|
### Parameters
|
||
|
This endpoint does not need any parameter.
|
||
|
|
||
|
### Return type
|
||
|
|
||
|
void (empty response body)
|
||
|
|
||
|
### Authorization
|
||
|
|
||
|
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
|
||
|
|
||
|
### HTTP request headers
|
||
|
|
||
|
- **Content-Type**: Not defined
|
||
|
- **Accept**: Not defined
|
||
|
|
||
|
[[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)
|
||
|
|
||
|
# **restoreAssets**
|
||
|
> restoreAssets(bulkIdsDto)
|
||
|
|
||
|
|
||
|
|
||
|
### Example
|
||
|
```dart
|
||
|
import 'package:openapi/api.dart';
|
||
|
// TODO Configure API key authorization: cookie
|
||
|
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
|
||
|
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
|
||
|
// TODO Configure API key authorization: api_key
|
||
|
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
|
||
|
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
|
||
|
// TODO Configure HTTP Bearer authorization: bearer
|
||
|
// Case 1. Use String Token
|
||
|
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
|
||
|
// Case 2. Use Function which generate token.
|
||
|
// String yourTokenGeneratorFunction() { ... }
|
||
|
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);
|
||
|
|
||
|
final api_instance = TrashApi();
|
||
|
final bulkIdsDto = BulkIdsDto(); // BulkIdsDto |
|
||
|
|
||
|
try {
|
||
|
api_instance.restoreAssets(bulkIdsDto);
|
||
|
} catch (e) {
|
||
|
print('Exception when calling TrashApi->restoreAssets: $e\n');
|
||
|
}
|
||
|
```
|
||
|
|
||
|
### Parameters
|
||
|
|
||
|
Name | Type | Description | Notes
|
||
|
------------- | ------------- | ------------- | -------------
|
||
|
**bulkIdsDto** | [**BulkIdsDto**](BulkIdsDto.md)| |
|
||
|
|
||
|
### Return type
|
||
|
|
||
|
void (empty response body)
|
||
|
|
||
|
### Authorization
|
||
|
|
||
|
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
|
||
|
|
||
|
### HTTP request headers
|
||
|
|
||
|
- **Content-Type**: application/json
|
||
|
- **Accept**: Not defined
|
||
|
|
||
|
[[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)
|
||
|
|
||
|
# **restoreTrash**
|
||
|
> restoreTrash()
|
||
|
|
||
|
|
||
|
|
||
|
### Example
|
||
|
```dart
|
||
|
import 'package:openapi/api.dart';
|
||
|
// TODO Configure API key authorization: cookie
|
||
|
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
|
||
|
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
|
||
|
// TODO Configure API key authorization: api_key
|
||
|
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
|
||
|
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
|
||
|
// TODO Configure HTTP Bearer authorization: bearer
|
||
|
// Case 1. Use String Token
|
||
|
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
|
||
|
// Case 2. Use Function which generate token.
|
||
|
// String yourTokenGeneratorFunction() { ... }
|
||
|
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);
|
||
|
|
||
|
final api_instance = TrashApi();
|
||
|
|
||
|
try {
|
||
|
api_instance.restoreTrash();
|
||
|
} catch (e) {
|
||
|
print('Exception when calling TrashApi->restoreTrash: $e\n');
|
||
|
}
|
||
|
```
|
||
|
|
||
|
### Parameters
|
||
|
This endpoint does not need any parameter.
|
||
|
|
||
|
### Return type
|
||
|
|
||
|
void (empty response body)
|
||
|
|
||
|
### Authorization
|
||
|
|
||
|
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
|
||
|
|
||
|
### HTTP request headers
|
||
|
|
||
|
- **Content-Type**: Not defined
|
||
|
- **Accept**: Not defined
|
||
|
|
||
|
[[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)
|
||
|
|