mirror of
https://github.com/immich-app/immich.git
synced 2024-12-17 12:22:31 +02:00
292 lines
10 KiB
Markdown
292 lines
10 KiB
Markdown
|
# openapi.api.PersonApi
|
||
|
|
|
||
|
|
## Load the API package
|
||
|
|
```dart
|
||
|
|
import 'package:openapi/api.dart';
|
||
|
|
```
|
||
|
|
|
||
|
|
All URIs are relative to */api*
|
||
|
|
|
||
|
|
Method | HTTP request | Description
|
||
|
|
------------- | ------------- | -------------
|
||
|
|
[**getAllPeople**](PersonApi.md#getallpeople) | **GET** /person |
|
||
|
|
[**getPerson**](PersonApi.md#getperson) | **GET** /person/{id} |
|
||
|
|
[**getPersonAssets**](PersonApi.md#getpersonassets) | **GET** /person/{id}/assets |
|
||
|
|
[**getPersonThumbnail**](PersonApi.md#getpersonthumbnail) | **GET** /person/{id}/thumbnail |
|
||
|
|
[**updatePerson**](PersonApi.md#updateperson) | **PUT** /person/{id} |
|
||
|
|
|
||
|
|
|
||
|
|
# **getAllPeople**
|
||
|
|
> List<PersonResponseDto> getAllPeople()
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### 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 = PersonApi();
|
||
|
|
|
||
|
|
try {
|
||
|
|
final result = api_instance.getAllPeople();
|
||
|
|
print(result);
|
||
|
|
} catch (e) {
|
||
|
|
print('Exception when calling PersonApi->getAllPeople: $e\n');
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
This endpoint does not need any parameter.
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[**List<PersonResponseDto>**](PersonResponseDto.md)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
|
||
|
|
|
||
|
|
### 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)
|
||
|
|
|
||
|
|
# **getPerson**
|
||
|
|
> PersonResponseDto getPerson(id)
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### 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 = PersonApi();
|
||
|
|
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
|
||
|
|
|
||
|
|
try {
|
||
|
|
final result = api_instance.getPerson(id);
|
||
|
|
print(result);
|
||
|
|
} catch (e) {
|
||
|
|
print('Exception when calling PersonApi->getPerson: $e\n');
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**id** | **String**| |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[**PersonResponseDto**](PersonResponseDto.md)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
|
||
|
|
|
||
|
|
### 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)
|
||
|
|
|
||
|
|
# **getPersonAssets**
|
||
|
|
> List<AssetResponseDto> getPersonAssets(id)
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### 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 = PersonApi();
|
||
|
|
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
|
||
|
|
|
||
|
|
try {
|
||
|
|
final result = api_instance.getPersonAssets(id);
|
||
|
|
print(result);
|
||
|
|
} catch (e) {
|
||
|
|
print('Exception when calling PersonApi->getPersonAssets: $e\n');
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**id** | **String**| |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[**List<AssetResponseDto>**](AssetResponseDto.md)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
|
||
|
|
|
||
|
|
### 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)
|
||
|
|
|
||
|
|
# **getPersonThumbnail**
|
||
|
|
> MultipartFile getPersonThumbnail(id)
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### 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 = PersonApi();
|
||
|
|
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
|
||
|
|
|
||
|
|
try {
|
||
|
|
final result = api_instance.getPersonThumbnail(id);
|
||
|
|
print(result);
|
||
|
|
} catch (e) {
|
||
|
|
print('Exception when calling PersonApi->getPersonThumbnail: $e\n');
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**id** | **String**| |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[**MultipartFile**](MultipartFile.md)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
|
||
|
|
|
||
|
|
### HTTP request headers
|
||
|
|
|
||
|
|
- **Content-Type**: Not defined
|
||
|
|
- **Accept**: application/octet-stream
|
||
|
|
|
||
|
|
[[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)
|
||
|
|
|
||
|
|
# **updatePerson**
|
||
|
|
> PersonResponseDto updatePerson(id, personUpdateDto)
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### 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 = PersonApi();
|
||
|
|
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
|
||
|
|
final personUpdateDto = PersonUpdateDto(); // PersonUpdateDto |
|
||
|
|
|
||
|
|
try {
|
||
|
|
final result = api_instance.updatePerson(id, personUpdateDto);
|
||
|
|
print(result);
|
||
|
|
} catch (e) {
|
||
|
|
print('Exception when calling PersonApi->updatePerson: $e\n');
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**id** | **String**| |
|
||
|
|
**personUpdateDto** | [**PersonUpdateDto**](PersonUpdateDto.md)| |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[**PersonResponseDto**](PersonResponseDto.md)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
|
||
|
|
|
||
|
|
### 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)
|
||
|
|
|