immortaly007/immich-to-cloud-exporter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[TASK] (untested) Updated API to work with Immich 3.0

Browse Source
This commit is contained in:
Bas Dado
2026-07-03 20:13:42 +02:00
parent 7ed8d7984c
commit d50345fc64
839 changed files with 39747 additions and 18816 deletions
Download Patch File Download Diff File Expand all files Collapse all files
generated/immich/openapi_client/docs/APIKeyCreateDto.md
-30
View File
@@ -1,30 +0,0 @@
# APIKeyCreateDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | | [optional]
**permissions** | [**List[Permission]**](Permission.md) | |
## Example
```python
from generated.immich.openapi_client.models.api_key_create_dto import APIKeyCreateDto
# TODO update the JSON string below
json = "{}"
# create an instance of APIKeyCreateDto from a JSON string
api_key_create_dto_instance = APIKeyCreateDto.from_json(json)
# print the JSON string representation of the object
print(APIKeyCreateDto.to_json())
# convert the object into a dict
api_key_create_dto_dict = api_key_create_dto_instance.to_dict()
# create an instance of APIKeyCreateDto from a dict
api_key_create_dto_from_dict = APIKeyCreateDto.from_dict(api_key_create_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
generated/immich/openapi_client/docs/APIKeyCreateResponseDto.md
-30
View File
@@ -1,30 +0,0 @@
# APIKeyCreateResponseDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**api_key** | [**APIKeyResponseDto**](APIKeyResponseDto.md) | |
**secret** | **str** | |
## Example
```python
from generated.immich.openapi_client.models.api_key_create_response_dto import APIKeyCreateResponseDto
# TODO update the JSON string below
json = "{}"
# create an instance of APIKeyCreateResponseDto from a JSON string
api_key_create_response_dto_instance = APIKeyCreateResponseDto.from_json(json)
# print the JSON string representation of the object
print(APIKeyCreateResponseDto.to_json())
# convert the object into a dict
api_key_create_response_dto_dict = api_key_create_response_dto_instance.to_dict()
# create an instance of APIKeyCreateResponseDto from a dict
api_key_create_response_dto_from_dict = APIKeyCreateResponseDto.from_dict(api_key_create_response_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
generated/immich/openapi_client/docs/APIKeyResponseDto.md
-33
View File
@@ -1,33 +0,0 @@
# APIKeyResponseDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**created_at** | **datetime** | |
**id** | **str** | |
**name** | **str** | |
**permissions** | [**List[Permission]**](Permission.md) | |
**updated_at** | **datetime** | |
## Example
```python
from generated.immich.openapi_client.models.api_key_response_dto import APIKeyResponseDto
# TODO update the JSON string below
json = "{}"
# create an instance of APIKeyResponseDto from a JSON string
api_key_response_dto_instance = APIKeyResponseDto.from_json(json)
# print the JSON string representation of the object
print(APIKeyResponseDto.to_json())
# convert the object into a dict
api_key_response_dto_dict = api_key_response_dto_instance.to_dict()
# create an instance of APIKeyResponseDto from a dict
api_key_response_dto_from_dict = APIKeyResponseDto.from_dict(api_key_response_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
generated/immich/openapi_client/docs/APIKeyUpdateDto.md
-29
View File
@@ -1,29 +0,0 @@
# APIKeyUpdateDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | |
## Example
```python
from generated.immich.openapi_client.models.api_key_update_dto import APIKeyUpdateDto
# TODO update the JSON string below
json = "{}"
# create an instance of APIKeyUpdateDto from a JSON string
api_key_update_dto_instance = APIKeyUpdateDto.from_json(json)
# print the JSON string representation of the object
print(APIKeyUpdateDto.to_json())
# convert the object into a dict
api_key_update_dto_dict = api_key_update_dto_instance.to_dict()
# create an instance of APIKeyUpdateDto from a dict
api_key_update_dto_from_dict = APIKeyUpdateDto.from_dict(api_key_update_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
generated/immich/openapi_client/docs/APIKeysApi.md
+143 -29
View File
@@ -4,15 +4,20 @@ All URIs are relative to *https://github.com/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create_api_key**](APIKeysApi.md#create_api_key) | **POST** /api-keys |
[**delete_api_key**](APIKeysApi.md#delete_api_key) | **DELETE** /api-keys/{id} |
[**get_api_key**](APIKeysApi.md#get_api_key) | **GET** /api-keys/{id} |
[**get_api_keys**](APIKeysApi.md#get_api_keys) | **GET** /api-keys |
[**update_api_key**](APIKeysApi.md#update_api_key) | **PUT** /api-keys/{id} |
[**create_api_key**](APIKeysApi.md#create_api_key) | **POST** /api-keys | Create an API key
[**delete_api_key**](APIKeysApi.md#delete_api_key) | **DELETE** /api-keys/{id} | Delete an API key
[**get_api_key**](APIKeysApi.md#get_api_key) | **GET** /api-keys/{id} | Retrieve an API key
[**get_api_keys**](APIKeysApi.md#get_api_keys) | **GET** /api-keys | List all API keys
[**get_my_api_key**](APIKeysApi.md#get_my_api_key) | **GET** /api-keys/me | Retrieve the current API key
[**update_api_key**](APIKeysApi.md#update_api_key) | **PUT** /api-keys/{id} | Update an API key
# **create_api_key**
> APIKeyCreateResponseDto create_api_key(api_key_create_dto)
> ApiKeyCreateResponseDto create_api_key(api_key_create_dto)
Create an API key
Creates a new API key. It will be limited to the permissions specified.
### Example
@@ -22,8 +27,8 @@ Method | HTTP request | Description
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.models.api_key_create_dto import APIKeyCreateDto
from generated.immich.openapi_client.models.api_key_create_response_dto import APIKeyCreateResponseDto
from generated.immich.openapi_client.models.api_key_create_dto import ApiKeyCreateDto
from generated.immich.openapi_client.models.api_key_create_response_dto import ApiKeyCreateResponseDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
@@ -59,9 +64,10 @@ configuration = generated.immich.openapi_client.Configuration(
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.APIKeysApi(api_client)
api_key_create_dto = generated.immich.openapi_client.APIKeyCreateDto() # APIKeyCreateDto |
api_key_create_dto = generated.immich.openapi_client.ApiKeyCreateDto() # ApiKeyCreateDto |
try:
# Create an API key
api_response = api_instance.create_api_key(api_key_create_dto)
print("The response of APIKeysApi->create_api_key:\n")
pprint(api_response)
@@ -76,11 +82,11 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**api_key_create_dto** | [**APIKeyCreateDto**](APIKeyCreateDto.md)| |
**api_key_create_dto** | [**ApiKeyCreateDto**](ApiKeyCreateDto.md)| |
### Return type
[**APIKeyCreateResponseDto**](APIKeyCreateResponseDto.md)
[**ApiKeyCreateResponseDto**](ApiKeyCreateResponseDto.md)
### Authorization
@@ -102,6 +108,10 @@ Name | Type | Description | Notes
# **delete_api_key**
> delete_api_key(id)
Delete an API key
Deletes an API key identified by its ID. The current user must own this API key.
### Example
* Api Key Authentication (cookie):
@@ -145,9 +155,10 @@ configuration = generated.immich.openapi_client.Configuration(
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.APIKeysApi(api_client)
id = 'id_example' # str |
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |
try:
# Delete an API key
api_instance.delete_api_key(id)
except Exception as e:
print("Exception when calling APIKeysApi->delete_api_key: %s\n" % e)
@@ -160,7 +171,7 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| |
**id** | **UUID**| |
### Return type
@@ -184,7 +195,11 @@ void (empty response body)
[[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_api_key**
> APIKeyResponseDto get_api_key(id)
> ApiKeyResponseDto get_api_key(id)
Retrieve an API key
Retrieve an API key by its ID. The current user must own this API key.
### Example
@@ -194,7 +209,7 @@ void (empty response body)
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.models.api_key_response_dto import APIKeyResponseDto
from generated.immich.openapi_client.models.api_key_response_dto import ApiKeyResponseDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
@@ -230,9 +245,10 @@ configuration = generated.immich.openapi_client.Configuration(
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.APIKeysApi(api_client)
id = 'id_example' # str |
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |
try:
# Retrieve an API key
api_response = api_instance.get_api_key(id)
print("The response of APIKeysApi->get_api_key:\n")
pprint(api_response)
@@ -247,11 +263,11 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| |
**id** | **UUID**| |
### Return type
[**APIKeyResponseDto**](APIKeyResponseDto.md)
[**ApiKeyResponseDto**](ApiKeyResponseDto.md)
### Authorization
@@ -271,7 +287,11 @@ Name | Type | Description | Notes
[[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_api_keys**
> List[APIKeyResponseDto] get_api_keys()
> List[ApiKeyResponseDto] get_api_keys()
List all API keys
Retrieve all API keys of the current user.
### Example
@@ -281,7 +301,7 @@ Name | Type | Description | Notes
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.models.api_key_response_dto import APIKeyResponseDto
from generated.immich.openapi_client.models.api_key_response_dto import ApiKeyResponseDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
@@ -319,6 +339,7 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
api_instance = generated.immich.openapi_client.APIKeysApi(api_client)
try:
# List all API keys
api_response = api_instance.get_api_keys()
print("The response of APIKeysApi->get_api_keys:\n")
pprint(api_response)
@@ -334,7 +355,95 @@ This endpoint does not need any parameter.
### Return type
[**List[APIKeyResponseDto]**](APIKeyResponseDto.md)
[**List[ApiKeyResponseDto]**](ApiKeyResponseDto.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
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[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_my_api_key**
> ApiKeyResponseDto get_my_api_key()
Retrieve the current API key
Retrieve the API key that is used to access this endpoint.
### Example
* Api Key Authentication (cookie):
* Api Key Authentication (api_key):
* Bearer (JWT) Authentication (bearer):
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.models.api_key_response_dto import ApiKeyResponseDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
host = "https://github.com/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.APIKeysApi(api_client)
try:
# Retrieve the current API key
api_response = api_instance.get_my_api_key()
print("The response of APIKeysApi->get_my_api_key:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling APIKeysApi->get_my_api_key: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**ApiKeyResponseDto**](ApiKeyResponseDto.md)
### Authorization
@@ -354,7 +463,11 @@ This endpoint does not need any parameter.
[[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_api_key**
> APIKeyResponseDto update_api_key(id, api_key_update_dto)
> ApiKeyResponseDto update_api_key(id, api_key_update_dto)
Update an API key
Updates the name and permissions of an API key by its ID. The current user must own this API key.
### Example
@@ -364,8 +477,8 @@ This endpoint does not need any parameter.
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.models.api_key_response_dto import APIKeyResponseDto
from generated.immich.openapi_client.models.api_key_update_dto import APIKeyUpdateDto
from generated.immich.openapi_client.models.api_key_response_dto import ApiKeyResponseDto
from generated.immich.openapi_client.models.api_key_update_dto import ApiKeyUpdateDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
@@ -401,10 +514,11 @@ configuration = generated.immich.openapi_client.Configuration(
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.APIKeysApi(api_client)
id = 'id_example' # str |
api_key_update_dto = generated.immich.openapi_client.APIKeyUpdateDto() # APIKeyUpdateDto |
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |
api_key_update_dto = generated.immich.openapi_client.ApiKeyUpdateDto() # ApiKeyUpdateDto |
try:
# Update an API key
api_response = api_instance.update_api_key(id, api_key_update_dto)
print("The response of APIKeysApi->update_api_key:\n")
pprint(api_response)
@@ -419,12 +533,12 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| |
**api_key_update_dto** | [**APIKeyUpdateDto**](APIKeyUpdateDto.md)| |
**id** | **UUID**| |
**api_key_update_dto** | [**ApiKeyUpdateDto**](ApiKeyUpdateDto.md)| |
### Return type
[**APIKeyResponseDto**](APIKeyResponseDto.md)
[**ApiKeyResponseDto**](ApiKeyResponseDto.md)
### Authorization
generated/immich/openapi_client/docs/ActivitiesApi.md
+36 -16
View File
@@ -4,15 +4,19 @@ All URIs are relative to *https://github.com/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create_activity**](ActivitiesApi.md#create_activity) | **POST** /activities |
[**delete_activity**](ActivitiesApi.md#delete_activity) | **DELETE** /activities/{id} |
[**get_activities**](ActivitiesApi.md#get_activities) | **GET** /activities |
[**get_activity_statistics**](ActivitiesApi.md#get_activity_statistics) | **GET** /activities/statistics |
[**create_activity**](ActivitiesApi.md#create_activity) | **POST** /activities | Create an activity
[**delete_activity**](ActivitiesApi.md#delete_activity) | **DELETE** /activities/{id} | Delete an activity
[**get_activities**](ActivitiesApi.md#get_activities) | **GET** /activities | List all activities
[**get_activity_statistics**](ActivitiesApi.md#get_activity_statistics) | **GET** /activities/statistics | Retrieve activity statistics
# **create_activity**
> ActivityResponseDto create_activity(activity_create_dto)
Create an activity
Create a like or a comment for an album, or an asset in an album.
### Example
* Api Key Authentication (cookie):
@@ -61,6 +65,7 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
activity_create_dto = generated.immich.openapi_client.ActivityCreateDto() # ActivityCreateDto |
try:
# Create an activity
api_response = api_instance.create_activity(activity_create_dto)
print("The response of ActivitiesApi->create_activity:\n")
pprint(api_response)
@@ -101,6 +106,10 @@ Name | Type | Description | Notes
# **delete_activity**
> delete_activity(id)
Delete an activity
Removes a like or comment from a given album or asset in an album.
### Example
* Api Key Authentication (cookie):
@@ -144,9 +153,10 @@ configuration = generated.immich.openapi_client.Configuration(
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.ActivitiesApi(api_client)
id = 'id_example' # str |
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |
try:
# Delete an activity
api_instance.delete_activity(id)
except Exception as e:
print("Exception when calling ActivitiesApi->delete_activity: %s\n" % e)
@@ -159,7 +169,7 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| |
**id** | **UUID**| |
### Return type
@@ -185,6 +195,10 @@ void (empty response body)
# **get_activities**
> List[ActivityResponseDto] get_activities(album_id, asset_id=asset_id, level=level, type=type, user_id=user_id)
List all activities
Returns a list of activities for the selected asset or album. The activities are returned in sorted order, with the oldest activities appearing first.
### Example
* Api Key Authentication (cookie):
@@ -231,13 +245,14 @@ configuration = generated.immich.openapi_client.Configuration(
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.ActivitiesApi(api_client)
album_id = 'album_id_example' # str |
asset_id = 'asset_id_example' # str | (optional)
album_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Album ID
asset_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Asset ID (if activity is for an asset) (optional)
level = generated.immich.openapi_client.ReactionLevel() # ReactionLevel | (optional)
type = generated.immich.openapi_client.ReactionType() # ReactionType | (optional)
user_id = 'user_id_example' # str | (optional)
user_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Filter by user ID (optional)
try:
# List all activities
api_response = api_instance.get_activities(album_id, asset_id=asset_id, level=level, type=type, user_id=user_id)
print("The response of ActivitiesApi->get_activities:\n")
pprint(api_response)
@@ -252,11 +267,11 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**album_id** | **str**| |
**asset_id** | **str**| | [optional]
**album_id** | **UUID**| Album ID |
**asset_id** | **UUID**| Asset ID (if activity is for an asset) | [optional]
**level** | [**ReactionLevel**](.md)| | [optional]
**type** | [**ReactionType**](.md)| | [optional]
**user_id** | **str**| | [optional]
**user_id** | **UUID**| Filter by user ID | [optional]
### Return type
@@ -282,6 +297,10 @@ Name | Type | Description | Notes
# **get_activity_statistics**
> ActivityStatisticsResponseDto get_activity_statistics(album_id, asset_id=asset_id)
Retrieve activity statistics
Returns the number of likes and comments for a given album or asset in an album.
### Example
* Api Key Authentication (cookie):
@@ -326,10 +345,11 @@ configuration = generated.immich.openapi_client.Configuration(
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.ActivitiesApi(api_client)
album_id = 'album_id_example' # str |
asset_id = 'asset_id_example' # str | (optional)
album_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Album ID
asset_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Asset ID (if activity is for an asset) (optional)
try:
# Retrieve activity statistics
api_response = api_instance.get_activity_statistics(album_id, asset_id=asset_id)
print("The response of ActivitiesApi->get_activity_statistics:\n")
pprint(api_response)
@@ -344,8 +364,8 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**album_id** | **str**| |
**asset_id** | **str**| | [optional]
**album_id** | **UUID**| Album ID |
**asset_id** | **UUID**| Asset ID (if activity is for an asset) | [optional]
### Return type
generated/immich/openapi_client/docs/ActivityCreateDto.md
+4 -3
View File
@@ -1,13 +1,14 @@
# ActivityCreateDto
Activity create
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**album_id** | **str** | |
**asset_id** | **str** | | [optional]
**comment** | **str** | | [optional]
**album_id** | **UUID** | Album ID |
**asset_id** | **UUID** | Asset ID (if activity is for an asset) | [optional]
**comment** | **str** | Comment text (required if type is comment) | [optional]
**type** | [**ReactionType**](ReactionType.md) | |
## Example
generated/immich/openapi_client/docs/ActivityResponseDto.md
+4 -4
View File
@@ -5,10 +5,10 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_id** | **str** | |
**comment** | **str** | | [optional]
**created_at** | **datetime** | |
**id** | **str** | |
**asset_id** | **UUID** | Asset ID (if activity is for an asset) |
**comment** | **str** | Comment text (for comment activities) | [optional]
**created_at** | **datetime** | Creation date |
**id** | **UUID** | Activity ID |
**type** | [**ReactionType**](ReactionType.md) | |
**user** | [**UserResponseDto**](UserResponseDto.md) | |
generated/immich/openapi_client/docs/ActivityStatisticsResponseDto.md
+2 -1
View File
@@ -5,7 +5,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**comments** | **int** | |
**comments** | **int** | Number of comments |
**likes** | **int** | Number of likes |
## Example
generated/immich/openapi_client/docs/AddUsersDto.md
+1 -1
View File
@@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**album_users** | [**List[AlbumUserAddDto]**](AlbumUserAddDto.md) | |
**album_users** | [**List[AlbumUserAddDto]**](AlbumUserAddDto.md) | Album users to add |
## Example
generated/immich/openapi_client/docs/AdminOnboardingUpdateDto.md
+1 -1
View File
@@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**is_onboarded** | **bool** | |
**is_onboarded** | **bool** | Is admin onboarded |
## Example
generated/immich/openapi_client/docs/AlbumResponseDto.md
+15 -17
View File
@@ -5,24 +5,22 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**album_name** | **str** | |
**album_thumbnail_asset_id** | **str** | |
**album_users** | [**List[AlbumUserResponseDto]**](AlbumUserResponseDto.md) | |
**asset_count** | **int** | |
**assets** | [**List[AssetResponseDto]**](AssetResponseDto.md) | |
**created_at** | **datetime** | |
**description** | **str** | |
**end_date** | **datetime** | | [optional]
**has_shared_link** | **bool** | |
**id** | **str** | |
**is_activity_enabled** | **bool** | |
**last_modified_asset_timestamp** | **datetime** | | [optional]
**album_name** | **str** | Album name |
**album_thumbnail_asset_id** | **UUID** | Thumbnail asset ID |
**album_users** | [**List[AlbumUserResponseDto]**](AlbumUserResponseDto.md) | First entry is always the album owner. Second entry is the auth user, if it differs from the owner. The rest are ordered alphabetically. |
**asset_count** | **int** | Number of assets |
**contributor_counts** | [**List[ContributorCountResponseDto]**](ContributorCountResponseDto.md) | | [optional]
**created_at** | **datetime** | Creation date |
**description** | **str** | Album description |
**end_date** | **datetime** | End date (latest asset) | [optional]
**has_shared_link** | **bool** | Has shared link |
**id** | **UUID** | Album ID |
**is_activity_enabled** | **bool** | Activity feed enabled |
**last_modified_asset_timestamp** | **datetime** | Last modified asset timestamp | [optional]
**order** | [**AssetOrder**](AssetOrder.md) | | [optional]
**owner** | [**UserResponseDto**](UserResponseDto.md) | |
**owner_id** | **str** | |
**shared** | **bool** | |
**start_date** | **datetime** | | [optional]
**updated_at** | **datetime** | |
**shared** | **bool** | Is shared album |
**start_date** | **datetime** | Start date (earliest asset) | [optional]
**updated_at** | **datetime** | Last update date |
## Example
generated/immich/openapi_client/docs/AlbumStatisticsResponseDto.md
+3 -3
View File
@@ -5,9 +5,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**not_shared** | **int** | |
**owned** | **int** | |
**shared** | **int** | |
**not_shared** | **int** | Number of non-shared albums |
**owned** | **int** | Number of owned albums |
**shared** | **int** | Number of shared albums |
## Example
generated/immich/openapi_client/docs/AlbumUserAddDto.md
+1 -1
View File
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**role** | [**AlbumUserRole**](AlbumUserRole.md) | | [optional]
**user_id** | **str** | |
**user_id** | **UUID** | User ID |
## Example
generated/immich/openapi_client/docs/AlbumUserCreateDto.md
+1 -1
View File
@@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**role** | [**AlbumUserRole**](AlbumUserRole.md) | |
**user_id** | **str** | |
**user_id** | **UUID** | User ID |
## Example
generated/immich/openapi_client/docs/AlbumUserRole.md
+3
View File
@@ -1,10 +1,13 @@
# AlbumUserRole
Album user role
## Enum
* `EDITOR` (value: `'editor'`)
* `OWNER` (value: `'owner'`)
* `VIEWER` (value: `'viewer'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
generated/immich/openapi_client/docs/AlbumsApi.md
+294 -44
View File
@@ -4,21 +4,27 @@ All URIs are relative to *https://github.com/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**add_assets_to_album**](AlbumsApi.md#add_assets_to_album) | **PUT** /albums/{id}/assets |
[**add_users_to_album**](AlbumsApi.md#add_users_to_album) | **PUT** /albums/{id}/users |
[**create_album**](AlbumsApi.md#create_album) | **POST** /albums |
[**delete_album**](AlbumsApi.md#delete_album) | **DELETE** /albums/{id} |
[**get_album_info**](AlbumsApi.md#get_album_info) | **GET** /albums/{id} |
[**get_album_statistics**](AlbumsApi.md#get_album_statistics) | **GET** /albums/statistics |
[**get_all_albums**](AlbumsApi.md#get_all_albums) | **GET** /albums |
[**remove_asset_from_album**](AlbumsApi.md#remove_asset_from_album) | **DELETE** /albums/{id}/assets |
[**remove_user_from_album**](AlbumsApi.md#remove_user_from_album) | **DELETE** /albums/{id}/user/{userId} |
[**update_album_info**](AlbumsApi.md#update_album_info) | **PATCH** /albums/{id} |
[**update_album_user**](AlbumsApi.md#update_album_user) | **PUT** /albums/{id}/user/{userId} |
[**add_assets_to_album**](AlbumsApi.md#add_assets_to_album) | **PUT** /albums/{id}/assets | Add assets to an album
[**add_assets_to_albums**](AlbumsApi.md#add_assets_to_albums) | **PUT** /albums/assets | Add assets to albums
[**add_users_to_album**](AlbumsApi.md#add_users_to_album) | **PUT** /albums/{id}/users | Share album with users
[**create_album**](AlbumsApi.md#create_album) | **POST** /albums | Create an album
[**delete_album**](AlbumsApi.md#delete_album) | **DELETE** /albums/{id} | Delete an album
[**get_album_info**](AlbumsApi.md#get_album_info) | **GET** /albums/{id} | Retrieve an album
[**get_album_map_markers**](AlbumsApi.md#get_album_map_markers) | **GET** /albums/{id}/map-markers | Retrieve album map markers
[**get_album_statistics**](AlbumsApi.md#get_album_statistics) | **GET** /albums/statistics | Retrieve album statistics
[**get_all_albums**](AlbumsApi.md#get_all_albums) | **GET** /albums | List all albums
[**remove_asset_from_album**](AlbumsApi.md#remove_asset_from_album) | **DELETE** /albums/{id}/assets | Remove assets from an album
[**remove_user_from_album**](AlbumsApi.md#remove_user_from_album) | **DELETE** /albums/{id}/user/{userId} | Remove user from album
[**update_album_info**](AlbumsApi.md#update_album_info) | **PATCH** /albums/{id} | Update an album
[**update_album_user**](AlbumsApi.md#update_album_user) | **PUT** /albums/{id}/user/{userId} | Update user role
# **add_assets_to_album**
> List[BulkIdResponseDto] add_assets_to_album(id, bulk_ids_dto, key=key)
> List[BulkIdResponseDto] add_assets_to_album(id, bulk_ids_dto)
Add assets to an album
Add multiple assets to a specific album by its ID.
### Example
@@ -65,12 +71,12 @@ configuration = generated.immich.openapi_client.Configuration(
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.AlbumsApi(api_client)
id = 'id_example' # str |
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |
bulk_ids_dto = generated.immich.openapi_client.BulkIdsDto() # BulkIdsDto |
key = 'key_example' # str | (optional)
try:
api_response = api_instance.add_assets_to_album(id, bulk_ids_dto, key=key)
# Add assets to an album
api_response = api_instance.add_assets_to_album(id, bulk_ids_dto)
print("The response of AlbumsApi->add_assets_to_album:\n")
pprint(api_response)
except Exception as e:
@@ -84,9 +90,8 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| |
**id** | **UUID**| |
**bulk_ids_dto** | [**BulkIdsDto**](BulkIdsDto.md)| |
**key** | **str**| | [optional]
### Return type
@@ -109,9 +114,106 @@ Name | Type | Description | Notes
[[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)
# **add_assets_to_albums**
> AlbumsAddAssetsResponseDto add_assets_to_albums(albums_add_assets_dto)
Add assets to albums
Send a list of asset IDs and album IDs to add each asset to each album.
### Example
* Api Key Authentication (cookie):
* Api Key Authentication (api_key):
* Bearer (JWT) Authentication (bearer):
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.models.albums_add_assets_dto import AlbumsAddAssetsDto
from generated.immich.openapi_client.models.albums_add_assets_response_dto import AlbumsAddAssetsResponseDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
host = "https://github.com/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.AlbumsApi(api_client)
albums_add_assets_dto = generated.immich.openapi_client.AlbumsAddAssetsDto() # AlbumsAddAssetsDto |
try:
# Add assets to albums
api_response = api_instance.add_assets_to_albums(albums_add_assets_dto)
print("The response of AlbumsApi->add_assets_to_albums:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AlbumsApi->add_assets_to_albums: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**albums_add_assets_dto** | [**AlbumsAddAssetsDto**](AlbumsAddAssetsDto.md)| |
### Return type
[**AlbumsAddAssetsResponseDto**](AlbumsAddAssetsResponseDto.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
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[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)
# **add_users_to_album**
> AlbumResponseDto add_users_to_album(id, add_users_dto)
Share album with users
Share an album with multiple users. Each user can be given a specific role in the album.
### Example
* Api Key Authentication (cookie):
@@ -157,10 +259,11 @@ configuration = generated.immich.openapi_client.Configuration(
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.AlbumsApi(api_client)
id = 'id_example' # str |
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |
add_users_dto = generated.immich.openapi_client.AddUsersDto() # AddUsersDto |
try:
# Share album with users
api_response = api_instance.add_users_to_album(id, add_users_dto)
print("The response of AlbumsApi->add_users_to_album:\n")
pprint(api_response)
@@ -175,7 +278,7 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| |
**id** | **UUID**| |
**add_users_dto** | [**AddUsersDto**](AddUsersDto.md)| |
### Return type
@@ -202,6 +305,10 @@ Name | Type | Description | Notes
# **create_album**
> AlbumResponseDto create_album(create_album_dto)
Create an album
Create a new album. The album can also be created with initial users and assets.
### Example
* Api Key Authentication (cookie):
@@ -250,6 +357,7 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
create_album_dto = generated.immich.openapi_client.CreateAlbumDto() # CreateAlbumDto |
try:
# Create an album
api_response = api_instance.create_album(create_album_dto)
print("The response of AlbumsApi->create_album:\n")
pprint(api_response)
@@ -290,6 +398,10 @@ Name | Type | Description | Notes
# **delete_album**
> delete_album(id)
Delete an album
Delete a specific album by its ID. Note the album is initially trashed and then immediately scheduled for deletion, but relies on a background job to complete the process.
### Example
* Api Key Authentication (cookie):
@@ -333,9 +445,10 @@ configuration = generated.immich.openapi_client.Configuration(
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.AlbumsApi(api_client)
id = 'id_example' # str |
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |
try:
# Delete an album
api_instance.delete_album(id)
except Exception as e:
print("Exception when calling AlbumsApi->delete_album: %s\n" % e)
@@ -348,7 +461,7 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| |
**id** | **UUID**| |
### Return type
@@ -367,12 +480,16 @@ void (empty response body)
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
**204** | | - |
[[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_album_info**
> AlbumResponseDto get_album_info(id, key=key, without_assets=without_assets)
> AlbumResponseDto get_album_info(id, key=key, slug=slug)
Retrieve an album
Retrieve information about a specific album by its ID.
### Example
@@ -418,12 +535,13 @@ configuration = generated.immich.openapi_client.Configuration(
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.AlbumsApi(api_client)
id = 'id_example' # str |
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |
key = 'key_example' # str | (optional)
without_assets = True # bool | (optional)
slug = 'slug_example' # str | (optional)
try:
api_response = api_instance.get_album_info(id, key=key, without_assets=without_assets)
# Retrieve an album
api_response = api_instance.get_album_info(id, key=key, slug=slug)
print("The response of AlbumsApi->get_album_info:\n")
pprint(api_response)
except Exception as e:
@@ -437,9 +555,9 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| |
**id** | **UUID**| |
**key** | **str**| | [optional]
**without_assets** | **bool**| | [optional]
**slug** | **str**| | [optional]
### Return type
@@ -462,9 +580,109 @@ Name | Type | Description | Notes
[[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_album_map_markers**
> List[MapMarkerResponseDto] get_album_map_markers(id, key=key, slug=slug)
Retrieve album map markers
Retrieve map marker information for a specific album by its ID.
### Example
* Api Key Authentication (cookie):
* Api Key Authentication (api_key):
* Bearer (JWT) Authentication (bearer):
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.models.map_marker_response_dto import MapMarkerResponseDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
host = "https://github.com/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.AlbumsApi(api_client)
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |
key = 'key_example' # str | (optional)
slug = 'slug_example' # str | (optional)
try:
# Retrieve album map markers
api_response = api_instance.get_album_map_markers(id, key=key, slug=slug)
print("The response of AlbumsApi->get_album_map_markers:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AlbumsApi->get_album_map_markers: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **UUID**| |
**key** | **str**| | [optional]
**slug** | **str**| | [optional]
### Return type
[**List[MapMarkerResponseDto]**](MapMarkerResponseDto.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
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[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_album_statistics**
> AlbumStatisticsResponseDto get_album_statistics()
Retrieve album statistics
Returns statistics about the albums available to the authenticated user.
### Example
* Api Key Authentication (cookie):
@@ -511,6 +729,7 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
api_instance = generated.immich.openapi_client.AlbumsApi(api_client)
try:
# Retrieve album statistics
api_response = api_instance.get_album_statistics()
print("The response of AlbumsApi->get_album_statistics:\n")
pprint(api_response)
@@ -546,7 +765,11 @@ This endpoint does not need any parameter.
[[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_all_albums**
> List[AlbumResponseDto] get_all_albums(asset_id=asset_id, shared=shared)
> List[AlbumResponseDto] get_all_albums(asset_id=asset_id, id=id, is_owned=is_owned, is_shared=is_shared, name=name)
List all albums
Retrieve a list of albums available to the authenticated user.
### Example
@@ -592,11 +815,15 @@ configuration = generated.immich.openapi_client.Configuration(
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.AlbumsApi(api_client)
asset_id = 'asset_id_example' # str | Only returns albums that contain the asset Ignores the shared parameter undefined: get all albums (optional)
shared = True # bool | (optional)
asset_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Filter albums containing this asset ID (ignores other parameters) (optional)
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Album ID (optional)
is_owned = True # bool | Filter by ownership: true = only owned, false = only shared-with-me, undefined = no filter (optional)
is_shared = True # bool | Filter by shared status: true = only shared, false = not shared, undefined = no filter (optional)
name = 'name_example' # str | Album name (exact match) (optional)
try:
api_response = api_instance.get_all_albums(asset_id=asset_id, shared=shared)
# List all albums
api_response = api_instance.get_all_albums(asset_id=asset_id, id=id, is_owned=is_owned, is_shared=is_shared, name=name)
print("The response of AlbumsApi->get_all_albums:\n")
pprint(api_response)
except Exception as e:
@@ -610,8 +837,11 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**asset_id** | **str**| Only returns albums that contain the asset Ignores the shared parameter undefined: get all albums | [optional]
**shared** | **bool**| | [optional]
**asset_id** | **UUID**| Filter albums containing this asset ID (ignores other parameters) | [optional]
**id** | **UUID**| Album ID | [optional]
**is_owned** | **bool**| Filter by ownership: true = only owned, false = only shared-with-me, undefined = no filter | [optional]
**is_shared** | **bool**| Filter by shared status: true = only shared, false = not shared, undefined = no filter | [optional]
**name** | **str**| Album name (exact match) | [optional]
### Return type
@@ -637,6 +867,10 @@ Name | Type | Description | Notes
# **remove_asset_from_album**
> List[BulkIdResponseDto] remove_asset_from_album(id, bulk_ids_dto)
Remove assets from an album
Remove multiple assets from a specific album by its ID.
### Example
* Api Key Authentication (cookie):
@@ -682,10 +916,11 @@ configuration = generated.immich.openapi_client.Configuration(
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.AlbumsApi(api_client)
id = 'id_example' # str |
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |
bulk_ids_dto = generated.immich.openapi_client.BulkIdsDto() # BulkIdsDto |
try:
# Remove assets from an album
api_response = api_instance.remove_asset_from_album(id, bulk_ids_dto)
print("The response of AlbumsApi->remove_asset_from_album:\n")
pprint(api_response)
@@ -700,7 +935,7 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| |
**id** | **UUID**| |
**bulk_ids_dto** | [**BulkIdsDto**](BulkIdsDto.md)| |
### Return type
@@ -727,6 +962,10 @@ Name | Type | Description | Notes
# **remove_user_from_album**
> remove_user_from_album(id, user_id)
Remove user from album
Remove a user from an album. Use an ID of "me" to leave a shared album.
### Example
* Api Key Authentication (cookie):
@@ -770,10 +1009,11 @@ configuration = generated.immich.openapi_client.Configuration(
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.AlbumsApi(api_client)
id = 'id_example' # str |
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |
user_id = 'user_id_example' # str |
try:
# Remove user from album
api_instance.remove_user_from_album(id, user_id)
except Exception as e:
print("Exception when calling AlbumsApi->remove_user_from_album: %s\n" % e)
@@ -786,7 +1026,7 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| |
**id** | **UUID**| |
**user_id** | **str**| |
### Return type
@@ -806,13 +1046,17 @@ void (empty response body)
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
**204** | | - |
[[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_album_info**
> AlbumResponseDto update_album_info(id, update_album_dto)
Update an album
Update the information of a specific album by its ID. This endpoint can be used to update the album name, description, sort order, etc. However, it is not used to add or remove assets or users from the album.
### Example
* Api Key Authentication (cookie):
@@ -858,10 +1102,11 @@ configuration = generated.immich.openapi_client.Configuration(
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.AlbumsApi(api_client)
id = 'id_example' # str |
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |
update_album_dto = generated.immich.openapi_client.UpdateAlbumDto() # UpdateAlbumDto |
try:
# Update an album
api_response = api_instance.update_album_info(id, update_album_dto)
print("The response of AlbumsApi->update_album_info:\n")
pprint(api_response)
@@ -876,7 +1121,7 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| |
**id** | **UUID**| |
**update_album_dto** | [**UpdateAlbumDto**](UpdateAlbumDto.md)| |
### Return type
@@ -903,6 +1148,10 @@ Name | Type | Description | Notes
# **update_album_user**
> update_album_user(id, user_id, update_album_user_dto)
Update user role
Change the role for a specific user in a specific album.
### Example
* Api Key Authentication (cookie):
@@ -947,11 +1196,12 @@ configuration = generated.immich.openapi_client.Configuration(
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.AlbumsApi(api_client)
id = 'id_example' # str |
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |
user_id = 'user_id_example' # str |
update_album_user_dto = generated.immich.openapi_client.UpdateAlbumUserDto() # UpdateAlbumUserDto |
try:
# Update user role
api_instance.update_album_user(id, user_id, update_album_user_dto)
except Exception as e:
print("Exception when calling AlbumsApi->update_album_user: %s\n" % e)
@@ -964,7 +1214,7 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| |
**id** | **UUID**| |
**user_id** | **str**| |
**update_album_user_dto** | [**UpdateAlbumUserDto**](UpdateAlbumUserDto.md)| |
@@ -985,7 +1235,7 @@ void (empty response body)
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
**204** | | - |
[[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)
generated/immich/openapi_client/docs/AllJobStatusResponseDto.md
-43
View File
@@ -1,43 +0,0 @@
# AllJobStatusResponseDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**background_task** | [**JobStatusDto**](JobStatusDto.md) | |
**backup_database** | [**JobStatusDto**](JobStatusDto.md) | |
**duplicate_detection** | [**JobStatusDto**](JobStatusDto.md) | |
**face_detection** | [**JobStatusDto**](JobStatusDto.md) | |
**facial_recognition** | [**JobStatusDto**](JobStatusDto.md) | |
**library** | [**JobStatusDto**](JobStatusDto.md) | |
**metadata_extraction** | [**JobStatusDto**](JobStatusDto.md) | |
**migration** | [**JobStatusDto**](JobStatusDto.md) | |
**notifications** | [**JobStatusDto**](JobStatusDto.md) | |
**search** | [**JobStatusDto**](JobStatusDto.md) | |
**sidecar** | [**JobStatusDto**](JobStatusDto.md) | |
**smart_search** | [**JobStatusDto**](JobStatusDto.md) | |
**storage_template_migration** | [**JobStatusDto**](JobStatusDto.md) | |
**thumbnail_generation** | [**JobStatusDto**](JobStatusDto.md) | |
**video_conversion** | [**JobStatusDto**](JobStatusDto.md) | |
## Example
```python
from generated.immich.openapi_client.models.all_job_status_response_dto import AllJobStatusResponseDto
# TODO update the JSON string below
json = "{}"
# create an instance of AllJobStatusResponseDto from a JSON string
all_job_status_response_dto_instance = AllJobStatusResponseDto.from_json(json)
# print the JSON string representation of the object
print(AllJobStatusResponseDto.to_json())
# convert the object into a dict
all_job_status_response_dto_dict = all_job_status_response_dto_instance.to_dict()
# create an instance of AllJobStatusResponseDto from a dict
all_job_status_response_dto_from_dict = AllJobStatusResponseDto.from_dict(all_job_status_response_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
generated/immich/openapi_client/docs/AssetBulkDeleteDto.md
+2 -2
View File
@@ -5,8 +5,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**force** | **bool** | | [optional]
**ids** | **List[str]** | |
**force** | **bool** | Force delete even if in use | [optional]
**ids** | **List[UUID]** | IDs to process |
## Example
generated/immich/openapi_client/docs/AssetBulkUpdateDto.md
+11 -8
View File
@@ -5,14 +5,17 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**date_time_original** | **str** | | [optional]
**duplicate_id** | **str** | | [optional]
**ids** | **List[str]** | |
**is_archived** | **bool** | | [optional]
**is_favorite** | **bool** | | [optional]
**latitude** | **float** | | [optional]
**longitude** | **float** | | [optional]
**rating** | **float** | | [optional]
**date_time_original** | **str** | Original date and time | [optional]
**date_time_relative** | **int** | Relative time offset in minutes | [optional]
**description** | **str** | Asset description | [optional]
**duplicate_id** | **str** | Duplicate ID | [optional]
**ids** | **List[UUID]** | Asset IDs to update |
**is_favorite** | **bool** | Mark as favorite | [optional]
**latitude** | **float** | Latitude coordinate | [optional]
**longitude** | **float** | Longitude coordinate | [optional]
**rating** | **int** | Rating in range [1-5] (starred), -1 (rejected), or null (unrated) | [optional]
**time_zone** | **str** | Time zone (IANA timezone) | [optional]
**visibility** | [**AssetVisibility**](AssetVisibility.md) | | [optional]
## Example
generated/immich/openapi_client/docs/AssetBulkUploadCheckDto.md
+1 -1
View File
@@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**assets** | [**List[AssetBulkUploadCheckItem]**](AssetBulkUploadCheckItem.md) | |
**assets** | [**List[AssetBulkUploadCheckItem]**](AssetBulkUploadCheckItem.md) | Assets to check |
## Example
generated/immich/openapi_client/docs/AssetBulkUploadCheckItem.md
+2 -2
View File
@@ -5,8 +5,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**checksum** | **str** | base64 or hex encoded sha1 hash |
**id** | **str** | |
**checksum** | **str** | Base64 or hex encoded SHA1 hash |
**id** | **str** | Client-side identifier echoed in the response to match results to inputs (e.g. filename) |
## Example
generated/immich/openapi_client/docs/AssetBulkUploadCheckResponseDto.md
+1 -1
View File
@@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**results** | [**List[AssetBulkUploadCheckResult]**](AssetBulkUploadCheckResult.md) | |
**results** | [**List[AssetBulkUploadCheckResult]**](AssetBulkUploadCheckResult.md) | Upload check results |
## Example
generated/immich/openapi_client/docs/AssetBulkUploadCheckResult.md
+5 -5
View File
@@ -5,11 +5,11 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**action** | **str** | |
**asset_id** | **str** | | [optional]
**id** | **str** | |
**is_trashed** | **bool** | | [optional]
**reason** | **str** | | [optional]
**action** | [**AssetUploadAction**](AssetUploadAction.md) | |
**asset_id** | **UUID** | Existing asset ID if duplicate | [optional]
**id** | **str** | Client-side identifier echoed from the request to match results to inputs |
**is_trashed** | **bool** | Whether existing asset is trashed | [optional]
**reason** | [**AssetRejectReason**](AssetRejectReason.md) | | [optional]
## Example
generated/immich/openapi_client/docs/AssetDeltaSyncDto.md
-30
View File
@@ -1,30 +0,0 @@
# AssetDeltaSyncDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**updated_after** | **datetime** | |
**user_ids** | **List[str]** | |
## Example
```python
from generated.immich.openapi_client.models.asset_delta_sync_dto import AssetDeltaSyncDto
# TODO update the JSON string below
json = "{}"
# create an instance of AssetDeltaSyncDto from a JSON string
asset_delta_sync_dto_instance = AssetDeltaSyncDto.from_json(json)
# print the JSON string representation of the object
print(AssetDeltaSyncDto.to_json())
# convert the object into a dict
asset_delta_sync_dto_dict = asset_delta_sync_dto_instance.to_dict()
# create an instance of AssetDeltaSyncDto from a dict
asset_delta_sync_dto_from_dict = AssetDeltaSyncDto.from_dict(asset_delta_sync_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
generated/immich/openapi_client/docs/AssetDeltaSyncResponseDto.md
-31
View File
@@ -1,31 +0,0 @@
# AssetDeltaSyncResponseDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**deleted** | **List[str]** | |
**needs_full_sync** | **bool** | |
**upserted** | [**List[AssetResponseDto]**](AssetResponseDto.md) | |
## Example
```python
from generated.immich.openapi_client.models.asset_delta_sync_response_dto import AssetDeltaSyncResponseDto
# TODO update the JSON string below
json = "{}"
# create an instance of AssetDeltaSyncResponseDto from a JSON string
asset_delta_sync_response_dto_instance = AssetDeltaSyncResponseDto.from_json(json)
# print the JSON string representation of the object
print(AssetDeltaSyncResponseDto.to_json())
# convert the object into a dict
asset_delta_sync_response_dto_dict = asset_delta_sync_response_dto_instance.to_dict()
# create an instance of AssetDeltaSyncResponseDto from a dict
asset_delta_sync_response_dto_from_dict = AssetDeltaSyncResponseDto.from_dict(asset_delta_sync_response_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
generated/immich/openapi_client/docs/AssetFaceCreateDto.md
+8 -8
View File
@@ -5,14 +5,14 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_id** | **str** | |
**height** | **int** | |
**image_height** | **int** | |
**image_width** | **int** | |
**person_id** | **str** | |
**width** | **int** | |
**x** | **int** | |
**y** | **int** | |
**asset_id** | **UUID** | Asset ID |
**height** | **int** | Face bounding box height |
**image_height** | **int** | Image height in pixels |
**image_width** | **int** | Image width in pixels |
**person_id** | **UUID** | Person ID |
**width** | **int** | Face bounding box width |
**x** | **int** | Face bounding box X coordinate |
**y** | **int** | Face bounding box Y coordinate |
## Example
generated/immich/openapi_client/docs/AssetFaceDeleteDto.md
+1 -1
View File
@@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**force** | **bool** | |
**force** | **bool** | Force delete even if person has other faces |
## Example
generated/immich/openapi_client/docs/AssetFaceResponseDto.md
+8 -7
View File
@@ -1,17 +1,18 @@
# AssetFaceResponseDto
Asset face with person
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**bounding_box_x1** | **int** | |
**bounding_box_x2** | **int** | |
**bounding_box_y1** | **int** | |
**bounding_box_y2** | **int** | |
**id** | **str** | |
**image_height** | **int** | |
**image_width** | **int** | |
**bounding_box_x1** | **int** | Bounding box X1 coordinate |
**bounding_box_x2** | **int** | Bounding box X2 coordinate |
**bounding_box_y1** | **int** | Bounding box Y1 coordinate |
**bounding_box_y2** | **int** | Bounding box Y2 coordinate |
**id** | **UUID** | Face ID |
**image_height** | **int** | Image height in pixels |
**image_width** | **int** | Image width in pixels |
**person** | [**PersonResponseDto**](PersonResponseDto.md) | |
**source_type** | [**SourceType**](SourceType.md) | | [optional]
generated/immich/openapi_client/docs/AssetFaceUpdateDto.md
+1 -1
View File
@@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**List[AssetFaceUpdateItem]**](AssetFaceUpdateItem.md) | |
**data** | [**List[AssetFaceUpdateItem]**](AssetFaceUpdateItem.md) | Face update items |
## Example
generated/immich/openapi_client/docs/AssetFaceUpdateItem.md
+2 -2
View File
@@ -5,8 +5,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_id** | **str** | |
**person_id** | **str** | |
**asset_id** | **UUID** | Asset ID |
**person_id** | **UUID** | Person ID |
## Example
generated/immich/openapi_client/docs/AssetFaceWithoutPersonResponseDto.md
-36
View File
@@ -1,36 +0,0 @@
# AssetFaceWithoutPersonResponseDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**bounding_box_x1** | **int** | |
**bounding_box_x2** | **int** | |
**bounding_box_y1** | **int** | |
**bounding_box_y2** | **int** | |
**id** | **str** | |
**image_height** | **int** | |
**image_width** | **int** | |
**source_type** | [**SourceType**](SourceType.md) | | [optional]
## Example
```python
from generated.immich.openapi_client.models.asset_face_without_person_response_dto import AssetFaceWithoutPersonResponseDto
# TODO update the JSON string below
json = "{}"
# create an instance of AssetFaceWithoutPersonResponseDto from a JSON string
asset_face_without_person_response_dto_instance = AssetFaceWithoutPersonResponseDto.from_json(json)
# print the JSON string representation of the object
print(AssetFaceWithoutPersonResponseDto.to_json())
# convert the object into a dict
asset_face_without_person_response_dto_dict = asset_face_without_person_response_dto_instance.to_dict()
# create an instance of AssetFaceWithoutPersonResponseDto from a dict
asset_face_without_person_response_dto_from_dict = AssetFaceWithoutPersonResponseDto.from_dict(asset_face_without_person_response_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
generated/immich/openapi_client/docs/AssetFullSyncDto.md
-32
View File
@@ -1,32 +0,0 @@
# AssetFullSyncDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**last_id** | **str** | | [optional]
**limit** | **int** | |
**updated_until** | **datetime** | |
**user_id** | **str** | | [optional]
## Example
```python
from generated.immich.openapi_client.models.asset_full_sync_dto import AssetFullSyncDto
# TODO update the JSON string below
json = "{}"
# create an instance of AssetFullSyncDto from a JSON string
asset_full_sync_dto_instance = AssetFullSyncDto.from_json(json)
# print the JSON string representation of the object
print(AssetFullSyncDto.to_json())
# convert the object into a dict
asset_full_sync_dto_dict = asset_full_sync_dto_instance.to_dict()
# create an instance of AssetFullSyncDto from a dict
asset_full_sync_dto_from_dict = AssetFullSyncDto.from_dict(asset_full_sync_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
generated/immich/openapi_client/docs/AssetIdsDto.md
+1 -1
View File
@@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_ids** | **List[str]** | |
**asset_ids** | **List[UUID]** | Asset IDs |
## Example
generated/immich/openapi_client/docs/AssetIdsResponseDto.md
+3 -3
View File
@@ -5,9 +5,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_id** | **str** | |
**error** | **str** | | [optional]
**success** | **bool** | |
**asset_id** | **UUID** | Asset ID |
**error** | [**AssetIdErrorReason**](AssetIdErrorReason.md) | | [optional]
**success** | **bool** | Whether operation succeeded |
## Example
generated/immich/openapi_client/docs/AssetJobName.md
+1
View File
@@ -1,5 +1,6 @@
# AssetJobName
Job name
## Enum
generated/immich/openapi_client/docs/AssetJobsDto.md
+1 -1
View File
@@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_ids** | **List[str]** | |
**asset_ids** | **List[UUID]** | Asset IDs |
**name** | [**AssetJobName**](AssetJobName.md) | |
## Example
generated/immich/openapi_client/docs/AssetMediaResponseDto.md
+1 -1
View File
@@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | |
**id** | **UUID** | Asset media ID |
**status** | [**AssetMediaStatus**](AssetMediaStatus.md) | |
## Example
generated/immich/openapi_client/docs/AssetMediaSize.md
+3
View File
@@ -1,8 +1,11 @@
# AssetMediaSize
Asset media size
## Enum
* `ORIGINAL` (value: `'original'`)
* `FULLSIZE` (value: `'fullsize'`)
* `PREVIEW` (value: `'preview'`)
generated/immich/openapi_client/docs/AssetMediaStatus.md
+1 -2
View File
@@ -1,12 +1,11 @@
# AssetMediaStatus
Upload status
## Enum
* `CREATED` (value: `'created'`)
* `REPLACED` (value: `'replaced'`)
* `DUPLICATE` (value: `'duplicate'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
generated/immich/openapi_client/docs/AssetOrder.md
+1
View File
@@ -1,5 +1,6 @@
# AssetOrder
Asset sort order
## Enum
generated/immich/openapi_client/docs/AssetResponseDto.md
+27 -25
View File
@@ -5,36 +5,38 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**checksum** | **str** | base64 encoded sha1 hash |
**device_asset_id** | **str** | |
**device_id** | **str** | |
**duplicate_id** | **str** | | [optional]
**duration** | **str** | |
**checksum** | **str** | Base64 encoded SHA1 hash |
**created_at** | **datetime** | The UTC timestamp when the asset was originally uploaded to Immich. |
**duplicate_id** | **UUID** | Duplicate group ID | [optional]
**duration** | **int** | Video/gif duration in milliseconds (null for static images) |
**exif_info** | [**ExifResponseDto**](ExifResponseDto.md) | | [optional]
**file_created_at** | **datetime** | |
**file_modified_at** | **datetime** | |
**has_metadata** | **bool** | |
**id** | **str** | |
**is_archived** | **bool** | |
**is_favorite** | **bool** | |
**is_offline** | **bool** | |
**is_trashed** | **bool** | |
**library_id** | **str** | This property was deprecated in v1.106.0 | [optional]
**live_photo_video_id** | **str** | | [optional]
**local_date_time** | **datetime** | |
**original_file_name** | **str** | |
**original_mime_type** | **str** | | [optional]
**original_path** | **str** | |
**file_created_at** | **datetime** | The actual UTC timestamp when the file was created/captured, preserving timezone information. This is the authoritative timestamp for chronological sorting within timeline groups. Combined with timezone data, this can be used to determine the exact moment the photo was taken. |
**file_modified_at** | **datetime** | The UTC timestamp when the file was last modified on the filesystem. This reflects the last time the physical file was changed, which may be different from when the photo was originally taken. |
**has_metadata** | **bool** | Whether asset has metadata |
**height** | **int** | Asset height |
**id** | **UUID** | Asset ID |
**is_archived** | **bool** | Is archived |
**is_edited** | **bool** | Is edited |
**is_favorite** | **bool** | Is favorite |
**is_offline** | **bool** | Is offline |
**is_trashed** | **bool** | Is trashed |
**library_id** | **UUID** | Library ID | [optional]
**live_photo_video_id** | **str** | Live photo video ID | [optional]
**local_date_time** | **datetime** | The local date and time when the photo/video was taken, derived from EXIF metadata. This represents the photographer's local time regardless of timezone, stored as a timezone-agnostic timestamp. Used for timeline grouping by \"local\" days and months. |
**original_file_name** | **str** | Original file name |
**original_mime_type** | **str** | Original MIME type | [optional]
**original_path** | **str** | Original file path |
**owner** | [**UserResponseDto**](UserResponseDto.md) | | [optional]
**owner_id** | **str** | |
**people** | [**List[PersonWithFacesResponseDto]**](PersonWithFacesResponseDto.md) | | [optional]
**resized** | **bool** | This property was deprecated in v1.113.0 | [optional]
**owner_id** | **UUID** | Owner user ID |
**people** | [**List[PersonResponseDto]**](PersonResponseDto.md) | | [optional]
**resized** | **bool** | Is resized | [optional]
**stack** | [**AssetStackResponseDto**](AssetStackResponseDto.md) | | [optional]
**tags** | [**List[TagResponseDto]**](TagResponseDto.md) | | [optional]
**thumbhash** | **str** | |
**thumbhash** | **str** | Thumbhash for thumbnail generation (base64) also used as the c query param for thumbnail cache busting. |
**type** | [**AssetTypeEnum**](AssetTypeEnum.md) | |
**unassigned_faces** | [**List[AssetFaceWithoutPersonResponseDto]**](AssetFaceWithoutPersonResponseDto.md) | | [optional]
**updated_at** | **datetime** | |
**updated_at** | **datetime** | The UTC timestamp when the asset record was last updated in the database. This is automatically maintained by the database and reflects when any field in the asset was last modified. |
**visibility** | [**AssetVisibility**](AssetVisibility.md) | |
**width** | **int** | Asset width |
## Example
generated/immich/openapi_client/docs/AssetStackResponseDto.md
+3 -3
View File
@@ -5,9 +5,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_count** | **int** | |
**id** | **str** | |
**primary_asset_id** | **str** | |
**asset_count** | **int** | Number of assets in stack |
**id** | **UUID** | Stack ID |
**primary_asset_id** | **UUID** | Primary asset ID |
## Example
generated/immich/openapi_client/docs/AssetStatsResponseDto.md
+3 -3
View File
@@ -5,9 +5,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**images** | **int** | |
**total** | **int** | |
**videos** | **int** | |
**images** | **int** | Number of images |
**total** | **int** | Total number of assets |
**videos** | **int** | Number of videos |
## Example
generated/immich/openapi_client/docs/AssetTypeEnum.md
+1
View File
@@ -1,5 +1,6 @@
# AssetTypeEnum
Asset type
## Enum
generated/immich/openapi_client/docs/AssetsApi.md
+1324 -309
View File
File diff suppressed because it is too large Load Diff
generated/immich/openapi_client/docs/AudioCodec.md
+2 -1
View File
@@ -1,5 +1,6 @@
# AudioCodec
Target audio codec
## Enum
@@ -7,7 +8,7 @@
* `AAC` (value: `'aac'`)
* `LIBOPUS` (value: `'libopus'`)
* `OPUS` (value: `'opus'`)
* `PCM_S16LE` (value: `'pcm_s16le'`)
generated/immich/openapi_client/docs/AuthenticationApi.md
+1020 -5
View File
File diff suppressed because it is too large Load Diff
generated/immich/openapi_client/docs/AvatarResponse.md
-29
View File
@@ -1,29 +0,0 @@
# AvatarResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**color** | [**UserAvatarColor**](UserAvatarColor.md) | |
## Example
```python
from generated.immich.openapi_client.models.avatar_response import AvatarResponse
# TODO update the JSON string below
json = "{}"
# create an instance of AvatarResponse from a JSON string
avatar_response_instance = AvatarResponse.from_json(json)
# print the JSON string representation of the object
print(AvatarResponse.to_json())
# convert the object into a dict
avatar_response_dict = avatar_response_instance.to_dict()
# create an instance of AvatarResponse from a dict
avatar_response_from_dict = AvatarResponse.from_dict(avatar_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
generated/immich/openapi_client/docs/BulkIdResponseDto.md
+4 -3
View File
@@ -5,9 +5,10 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**error** | **str** | | [optional]
**id** | **str** | |
**success** | **bool** | |
**error** | [**BulkIdErrorReason**](BulkIdErrorReason.md) | | [optional]
**error_message** | **str** | | [optional]
**id** | **UUID** | ID |
**success** | **bool** | Whether operation succeeded |
## Example
generated/immich/openapi_client/docs/BulkIdsDto.md
+1 -1
View File
@@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ids** | **List[str]** | |
**ids** | **List[UUID]** | IDs to process |
## Example
generated/immich/openapi_client/docs/CLIPConfig.md
+2 -2
View File
@@ -5,8 +5,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enabled** | **bool** | |
**model_name** | **str** | |
**enabled** | **bool** | Whether the task is enabled |
**model_name** | **str** | Name of the model to use |
## Example
generated/immich/openapi_client/docs/CQMode.md
+1
View File
@@ -1,5 +1,6 @@
# CQMode
CQ mode
## Enum
generated/immich/openapi_client/docs/ChangePasswordDto.md
+3 -2
View File
@@ -5,8 +5,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**new_password** | **str** | |
**password** | **str** | |
**invalidate_sessions** | **bool** | Invalidate all other sessions | [optional] [default to False]
**new_password** | **str** | New password (min 8 characters) |
**password** | **str** | Current password |
## Example
generated/immich/openapi_client/docs/CheckExistingAssetsDto.md
-30
View File
@@ -1,30 +0,0 @@
# CheckExistingAssetsDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**device_asset_ids** | **List[str]** | |
**device_id** | **str** | |
## Example
```python
from generated.immich.openapi_client.models.check_existing_assets_dto import CheckExistingAssetsDto
# TODO update the JSON string below
json = "{}"
# create an instance of CheckExistingAssetsDto from a JSON string
check_existing_assets_dto_instance = CheckExistingAssetsDto.from_json(json)
# print the JSON string representation of the object
print(CheckExistingAssetsDto.to_json())
# convert the object into a dict
check_existing_assets_dto_dict = check_existing_assets_dto_instance.to_dict()
# create an instance of CheckExistingAssetsDto from a dict
check_existing_assets_dto_from_dict = CheckExistingAssetsDto.from_dict(check_existing_assets_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
generated/immich/openapi_client/docs/CheckExistingAssetsResponseDto.md
-29
View File
@@ -1,29 +0,0 @@
# CheckExistingAssetsResponseDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**existing_ids** | **List[str]** | |
## Example
```python
from generated.immich.openapi_client.models.check_existing_assets_response_dto import CheckExistingAssetsResponseDto
# TODO update the JSON string below
json = "{}"
# create an instance of CheckExistingAssetsResponseDto from a JSON string
check_existing_assets_response_dto_instance = CheckExistingAssetsResponseDto.from_json(json)
# print the JSON string representation of the object
print(CheckExistingAssetsResponseDto.to_json())
# convert the object into a dict
check_existing_assets_response_dto_dict = check_existing_assets_response_dto_instance.to_dict()
# create an instance of CheckExistingAssetsResponseDto from a dict
check_existing_assets_response_dto_from_dict = CheckExistingAssetsResponseDto.from_dict(check_existing_assets_response_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
generated/immich/openapi_client/docs/Colorspace.md
+1
View File
@@ -1,5 +1,6 @@
# Colorspace
Colorspace
## Enum
generated/immich/openapi_client/docs/CreateAlbumDto.md
+4 -4
View File
@@ -5,10 +5,10 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**album_name** | **str** | |
**album_users** | [**List[AlbumUserCreateDto]**](AlbumUserCreateDto.md) | | [optional]
**asset_ids** | **List[str]** | | [optional]
**description** | **str** | | [optional]
**album_name** | **str** | Album name |
**album_users** | [**List[AlbumUserCreateDto]**](AlbumUserCreateDto.md) | Album users | [optional]
**asset_ids** | **List[UUID]** | Initial asset IDs | [optional]
**description** | **str** | Album description | [optional]
## Example
generated/immich/openapi_client/docs/CreateLibraryDto.md
+4 -4
View File
@@ -5,10 +5,10 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**exclusion_patterns** | **List[str]** | | [optional]
**import_paths** | **List[str]** | | [optional]
**name** | **str** | | [optional]
**owner_id** | **str** | |
**exclusion_patterns** | **List[str]** | Exclusion patterns (max 128) | [optional]
**import_paths** | **List[str]** | Import paths (max 128) | [optional]
**name** | **str** | Library name | [optional]
**owner_id** | **UUID** | Owner user ID |
## Example
generated/immich/openapi_client/docs/CreateProfileImageResponseDto.md
+3 -3
View File
@@ -5,9 +5,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**profile_changed_at** | **datetime** | |
**profile_image_path** | **str** | |
**user_id** | **str** | |
**profile_changed_at** | **datetime** | Profile image change date |
**profile_image_path** | **str** | Profile image file path |
**user_id** | **UUID** | User ID |
## Example
generated/immich/openapi_client/docs/DatabaseBackupConfig.md
+3 -3
View File
@@ -5,9 +5,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cron_expression** | **str** | |
**enabled** | **bool** | |
**keep_last_amount** | **float** | |
**cron_expression** | **str** | Cron expression |
**enabled** | **bool** | Enabled |
**keep_last_amount** | **int** | Keep last amount |
## Example
generated/immich/openapi_client/docs/DeprecatedApi.md
+1535 -11
View File
File diff suppressed because it is too large Load Diff
generated/immich/openapi_client/docs/DownloadApi.md
+23 -9
View File
@@ -4,12 +4,16 @@ All URIs are relative to *https://github.com/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**download_archive**](DownloadApi.md#download_archive) | **POST** /download/archive |
[**get_download_info**](DownloadApi.md#get_download_info) | **POST** /download/info |
[**download_archive**](DownloadApi.md#download_archive) | **POST** /download/archive | Download asset archive
[**get_download_info**](DownloadApi.md#get_download_info) | **POST** /download/info | Retrieve download information
# **download_archive**
> bytearray download_archive(asset_ids_dto, key=key)
> bytearray download_archive(download_archive_dto, key=key, slug=slug)
Download asset archive
Download a ZIP archive containing the specified assets. The assets must have been previously requested via the "getDownloadInfo" endpoint.
### Example
@@ -19,7 +23,7 @@ Method | HTTP request | Description
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.models.asset_ids_dto import AssetIdsDto
from generated.immich.openapi_client.models.download_archive_dto import DownloadArchiveDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
@@ -55,11 +59,13 @@ configuration = generated.immich.openapi_client.Configuration(
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.DownloadApi(api_client)
asset_ids_dto = generated.immich.openapi_client.AssetIdsDto() # AssetIdsDto |
download_archive_dto = generated.immich.openapi_client.DownloadArchiveDto() # DownloadArchiveDto |
key = 'key_example' # str | (optional)
slug = 'slug_example' # str | (optional)
try:
api_response = api_instance.download_archive(asset_ids_dto, key=key)
# Download asset archive
api_response = api_instance.download_archive(download_archive_dto, key=key, slug=slug)
print("The response of DownloadApi->download_archive:\n")
pprint(api_response)
except Exception as e:
@@ -73,8 +79,9 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**asset_ids_dto** | [**AssetIdsDto**](AssetIdsDto.md)| |
**download_archive_dto** | [**DownloadArchiveDto**](DownloadArchiveDto.md)| |
**key** | **str**| | [optional]
**slug** | **str**| | [optional]
### Return type
@@ -98,7 +105,11 @@ Name | Type | Description | Notes
[[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_download_info**
> DownloadResponseDto get_download_info(download_info_dto, key=key)
> DownloadResponseDto get_download_info(download_info_dto, key=key, slug=slug)
Retrieve download information
Retrieve information about how to request a download for the specified assets or album. The response includes groups of assets that can be downloaded together.
### Example
@@ -147,9 +158,11 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
api_instance = generated.immich.openapi_client.DownloadApi(api_client)
download_info_dto = generated.immich.openapi_client.DownloadInfoDto() # DownloadInfoDto |
key = 'key_example' # str | (optional)
slug = 'slug_example' # str | (optional)
try:
api_response = api_instance.get_download_info(download_info_dto, key=key)
# Retrieve download information
api_response = api_instance.get_download_info(download_info_dto, key=key, slug=slug)
print("The response of DownloadApi->get_download_info:\n")
pprint(api_response)
except Exception as e:
@@ -165,6 +178,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**download_info_dto** | [**DownloadInfoDto**](DownloadInfoDto.md)| |
**key** | **str**| | [optional]
**slug** | **str**| | [optional]
### Return type
generated/immich/openapi_client/docs/DownloadArchiveInfo.md
+2 -2
View File
@@ -5,8 +5,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_ids** | **List[str]** | |
**size** | **int** | |
**asset_ids** | **List[UUID]** | Asset IDs in this archive |
**size** | **int** | Archive size in bytes |
## Example
generated/immich/openapi_client/docs/DownloadInfoDto.md
+4 -4
View File
@@ -5,10 +5,10 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**album_id** | **str** | | [optional]
**archive_size** | **int** | | [optional]
**asset_ids** | **List[str]** | | [optional]
**user_id** | **str** | | [optional]
**album_id** | **UUID** | Album ID to download | [optional]
**archive_size** | **int** | Archive size limit in bytes | [optional]
**asset_ids** | **List[UUID]** | Asset IDs to download | [optional]
**user_id** | **UUID** | User ID to download assets from | [optional]
## Example
generated/immich/openapi_client/docs/DownloadResponse.md
+2 -2
View File
@@ -5,8 +5,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**archive_size** | **int** | |
**include_embedded_videos** | **bool** | | [default to False]
**archive_size** | **int** | Maximum archive size in bytes |
**include_embedded_videos** | **bool** | Whether to include embedded videos in downloads |
## Example
generated/immich/openapi_client/docs/DownloadResponseDto.md
+2 -2
View File
@@ -5,8 +5,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**archives** | [**List[DownloadArchiveInfo]**](DownloadArchiveInfo.md) | |
**total_size** | **int** | |
**archives** | [**List[DownloadArchiveInfo]**](DownloadArchiveInfo.md) | Archive information |
**total_size** | **int** | Total size in bytes |
## Example
generated/immich/openapi_client/docs/DownloadUpdate.md
+2 -2
View File
@@ -5,8 +5,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**archive_size** | **int** | | [optional]
**include_embedded_videos** | **bool** | | [optional]
**archive_size** | **int** | Maximum archive size in bytes | [optional]
**include_embedded_videos** | **bool** | Whether to include embedded videos in downloads | [optional]
## Example
generated/immich/openapi_client/docs/DuplicateDetectionConfig.md
+2 -2
View File
@@ -5,8 +5,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enabled** | **bool** | |
**max_distance** | **float** | |
**enabled** | **bool** | Whether the task is enabled |
**max_distance** | **float** | Maximum distance threshold for duplicate detection |
## Example
generated/immich/openapi_client/docs/DuplicateResponseDto.md
+3 -2
View File
@@ -5,8 +5,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**assets** | [**List[AssetResponseDto]**](AssetResponseDto.md) | |
**duplicate_id** | **str** | |
**assets** | [**List[AssetResponseDto]**](AssetResponseDto.md) | Duplicate assets |
**duplicate_id** | **UUID** | Duplicate group ID |
**suggested_keep_asset_ids** | **List[UUID]** | Suggested asset IDs to keep based on file size and EXIF data |
## Example
generated/immich/openapi_client/docs/DuplicatesApi.md
+281 -1
View File
@@ -4,12 +4,198 @@ All URIs are relative to *https://github.com/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get_asset_duplicates**](DuplicatesApi.md#get_asset_duplicates) | **GET** /duplicates |
[**delete_duplicate**](DuplicatesApi.md#delete_duplicate) | **DELETE** /duplicates/{id} | Dismiss a duplicate group
[**delete_duplicates**](DuplicatesApi.md#delete_duplicates) | **DELETE** /duplicates | Delete duplicates
[**get_asset_duplicates**](DuplicatesApi.md#get_asset_duplicates) | **GET** /duplicates | Retrieve duplicates
[**resolve_duplicates**](DuplicatesApi.md#resolve_duplicates) | **POST** /duplicates/resolve | Resolve duplicate groups
# **delete_duplicate**
> delete_duplicate(id)
Dismiss a duplicate group
Dismiss a duplicate group by its ID, unlinking all assets in the group without deleting them.
### Example
* Api Key Authentication (cookie):
* Api Key Authentication (api_key):
* Bearer (JWT) Authentication (bearer):
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
host = "https://github.com/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.DuplicatesApi(api_client)
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |
try:
# Dismiss a duplicate group
api_instance.delete_duplicate(id)
except Exception as e:
print("Exception when calling DuplicatesApi->delete_duplicate: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **UUID**| |
### 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
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | | - |
[[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_duplicates**
> delete_duplicates(bulk_ids_dto)
Delete duplicates
Delete multiple duplicate assets specified by their IDs.
### Example
* Api Key Authentication (cookie):
* Api Key Authentication (api_key):
* Bearer (JWT) Authentication (bearer):
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.models.bulk_ids_dto import BulkIdsDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
host = "https://github.com/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.DuplicatesApi(api_client)
bulk_ids_dto = generated.immich.openapi_client.BulkIdsDto() # BulkIdsDto |
try:
# Delete duplicates
api_instance.delete_duplicates(bulk_ids_dto)
except Exception as e:
print("Exception when calling DuplicatesApi->delete_duplicates: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**bulk_ids_dto** | [**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
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | | - |
[[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_asset_duplicates**
> List[DuplicateResponseDto] get_asset_duplicates()
Retrieve duplicates
Retrieve a list of duplicate assets available to the authenticated user.
### Example
* Api Key Authentication (cookie):
@@ -56,6 +242,7 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
api_instance = generated.immich.openapi_client.DuplicatesApi(api_client)
try:
# Retrieve duplicates
api_response = api_instance.get_asset_duplicates()
print("The response of DuplicatesApi->get_asset_duplicates:\n")
pprint(api_response)
@@ -90,3 +277,96 @@ This endpoint does not need any parameter.
[[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)
# **resolve_duplicates**
> List[BulkIdResponseDto] resolve_duplicates(duplicate_resolve_dto)
Resolve duplicate groups
Resolve duplicate groups by synchronizing metadata across assets and deleting/trashing duplicates.
### Example
* Api Key Authentication (cookie):
* Api Key Authentication (api_key):
* Bearer (JWT) Authentication (bearer):
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.models.bulk_id_response_dto import BulkIdResponseDto
from generated.immich.openapi_client.models.duplicate_resolve_dto import DuplicateResolveDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
host = "https://github.com/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.DuplicatesApi(api_client)
duplicate_resolve_dto = generated.immich.openapi_client.DuplicateResolveDto() # DuplicateResolveDto |
try:
# Resolve duplicate groups
api_response = api_instance.resolve_duplicates(duplicate_resolve_dto)
print("The response of DuplicatesApi->resolve_duplicates:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DuplicatesApi->resolve_duplicates: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**duplicate_resolve_dto** | [**DuplicateResolveDto**](DuplicateResolveDto.md)| |
### Return type
[**List[BulkIdResponseDto]**](BulkIdResponseDto.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
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[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)
generated/immich/openapi_client/docs/EmailNotificationsResponse.md
+3 -3
View File
@@ -5,9 +5,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**album_invite** | **bool** | |
**album_update** | **bool** | |
**enabled** | **bool** | |
**album_invite** | **bool** | Whether to receive email notifications for album invites |
**album_update** | **bool** | Whether to receive email notifications for album updates |
**enabled** | **bool** | Whether email notifications are enabled |
## Example
generated/immich/openapi_client/docs/EmailNotificationsUpdate.md
+3 -3
View File
@@ -5,9 +5,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**album_invite** | **bool** | | [optional]
**album_update** | **bool** | | [optional]
**enabled** | **bool** | | [optional]
**album_invite** | **bool** | Whether to receive email notifications for album invites | [optional]
**album_update** | **bool** | Whether to receive email notifications for album updates | [optional]
**enabled** | **bool** | Whether email notifications are enabled | [optional]
## Example
generated/immich/openapi_client/docs/ExifResponseDto.md
+23 -22
View File
@@ -1,32 +1,33 @@
# ExifResponseDto
EXIF response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**city** | **str** | | [optional]
**country** | **str** | | [optional]
**date_time_original** | **datetime** | | [optional]
**description** | **str** | | [optional]
**exif_image_height** | **float** | | [optional]
**exif_image_width** | **float** | | [optional]
**exposure_time** | **str** | | [optional]
**f_number** | **float** | | [optional]
**file_size_in_byte** | **int** | | [optional]
**focal_length** | **float** | | [optional]
**iso** | **float** | | [optional]
**latitude** | **float** | | [optional]
**lens_model** | **str** | | [optional]
**longitude** | **float** | | [optional]
**make** | **str** | | [optional]
**model** | **str** | | [optional]
**modify_date** | **datetime** | | [optional]
**orientation** | **str** | | [optional]
**projection_type** | **str** | | [optional]
**rating** | **float** | | [optional]
**state** | **str** | | [optional]
**time_zone** | **str** | | [optional]
**city** | **str** | City name | [optional]
**country** | **str** | Country name | [optional]
**date_time_original** | **datetime** | Original date/time | [optional]
**description** | **str** | Image description | [optional]
**exif_image_height** | **int** | Image height in pixels | [optional]
**exif_image_width** | **int** | Image width in pixels | [optional]
**exposure_time** | **str** | Exposure time | [optional]
**f_number** | **float** | F-number (aperture) | [optional]
**file_size_in_byte** | **int** | File size in bytes | [optional]
**focal_length** | **float** | Focal length in mm | [optional]
**iso** | **int** | ISO sensitivity | [optional]
**latitude** | **float** | GPS latitude | [optional]
**lens_model** | **str** | Lens model | [optional]
**longitude** | **float** | GPS longitude | [optional]
**make** | **str** | Camera make | [optional]
**model** | **str** | Camera model | [optional]
**modify_date** | **datetime** | Modification date/time | [optional]
**orientation** | **str** | Image orientation | [optional]
**projection_type** | **str** | Projection type | [optional]
**rating** | **int** | Rating | [optional]
**state** | **str** | State/province name | [optional]
**time_zone** | **str** | Time zone | [optional]
## Example
generated/immich/openapi_client/docs/FaceDto.md
+1 -1
View File
@@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | |
**id** | **UUID** | Face ID |
## Example
generated/immich/openapi_client/docs/FacesApi.md
+31 -11
View File
@@ -4,15 +4,19 @@ All URIs are relative to *https://github.com/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create_face**](FacesApi.md#create_face) | **POST** /faces |
[**delete_face**](FacesApi.md#delete_face) | **DELETE** /faces/{id} |
[**get_faces**](FacesApi.md#get_faces) | **GET** /faces |
[**reassign_faces_by_id**](FacesApi.md#reassign_faces_by_id) | **PUT** /faces/{id} |
[**create_face**](FacesApi.md#create_face) | **POST** /faces | Create a face
[**delete_face**](FacesApi.md#delete_face) | **DELETE** /faces/{id} | Delete a face
[**get_faces**](FacesApi.md#get_faces) | **GET** /faces | Retrieve faces for asset
[**reassign_faces_by_id**](FacesApi.md#reassign_faces_by_id) | **PUT** /faces/{id} | Re-assign a face to another person
# **create_face**
> create_face(asset_face_create_dto)
Create a face
Create a new face that has not been discovered by facial recognition. The content of the bounding box is considered a face.
### Example
* Api Key Authentication (cookie):
@@ -60,6 +64,7 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
asset_face_create_dto = generated.immich.openapi_client.AssetFaceCreateDto() # AssetFaceCreateDto |
try:
# Create a face
api_instance.create_face(asset_face_create_dto)
except Exception as e:
print("Exception when calling FacesApi->create_face: %s\n" % e)
@@ -98,6 +103,10 @@ void (empty response body)
# **delete_face**
> delete_face(id, asset_face_delete_dto)
Delete a face
Delete a face identified by the id. Optionally can be force deleted.
### Example
* Api Key Authentication (cookie):
@@ -142,10 +151,11 @@ configuration = generated.immich.openapi_client.Configuration(
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.FacesApi(api_client)
id = 'id_example' # str |
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |
asset_face_delete_dto = generated.immich.openapi_client.AssetFaceDeleteDto() # AssetFaceDeleteDto |
try:
# Delete a face
api_instance.delete_face(id, asset_face_delete_dto)
except Exception as e:
print("Exception when calling FacesApi->delete_face: %s\n" % e)
@@ -158,7 +168,7 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| |
**id** | **UUID**| |
**asset_face_delete_dto** | [**AssetFaceDeleteDto**](AssetFaceDeleteDto.md)| |
### Return type
@@ -178,13 +188,17 @@ void (empty response body)
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
**204** | | - |
[[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_faces**
> List[AssetFaceResponseDto] get_faces(id)
Retrieve faces for asset
Retrieve all faces belonging to an asset.
### Example
* Api Key Authentication (cookie):
@@ -229,9 +243,10 @@ configuration = generated.immich.openapi_client.Configuration(
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.FacesApi(api_client)
id = 'id_example' # str |
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Face ID
try:
# Retrieve faces for asset
api_response = api_instance.get_faces(id)
print("The response of FacesApi->get_faces:\n")
pprint(api_response)
@@ -246,7 +261,7 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| |
**id** | **UUID**| Face ID |
### Return type
@@ -272,6 +287,10 @@ Name | Type | Description | Notes
# **reassign_faces_by_id**
> PersonResponseDto reassign_faces_by_id(id, face_dto)
Re-assign a face to another person
Re-assign the face provided in the body to the person identified by the id in the path parameter.
### Example
* Api Key Authentication (cookie):
@@ -317,10 +336,11 @@ configuration = generated.immich.openapi_client.Configuration(
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.FacesApi(api_client)
id = 'id_example' # str |
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |
face_dto = generated.immich.openapi_client.FaceDto() # FaceDto |
try:
# Re-assign a face to another person
api_response = api_instance.reassign_faces_by_id(id, face_dto)
print("The response of FacesApi->reassign_faces_by_id:\n")
pprint(api_response)
@@ -335,7 +355,7 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| |
**id** | **UUID**| |
**face_dto** | [**FaceDto**](FaceDto.md)| |
### Return type
generated/immich/openapi_client/docs/FacialRecognitionConfig.md
+5 -5
View File
@@ -5,11 +5,11 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enabled** | **bool** | |
**max_distance** | **float** | |
**min_faces** | **int** | |
**min_score** | **float** | |
**model_name** | **str** | |
**enabled** | **bool** | Whether the task is enabled |
**max_distance** | **float** | Maximum distance threshold for face recognition |
**min_faces** | **int** | Minimum number of faces required for recognition |
**min_score** | **float** | Minimum confidence score for face detection |
**model_name** | **str** | Name of the model to use |
## Example
generated/immich/openapi_client/docs/FileChecksumDto.md
-29
View File
@@ -1,29 +0,0 @@
# FileChecksumDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**filenames** | **List[str]** | |
## Example
```python
from generated.immich.openapi_client.models.file_checksum_dto import FileChecksumDto
# TODO update the JSON string below
json = "{}"
# create an instance of FileChecksumDto from a JSON string
file_checksum_dto_instance = FileChecksumDto.from_json(json)
# print the JSON string representation of the object
print(FileChecksumDto.to_json())
# convert the object into a dict
file_checksum_dto_dict = file_checksum_dto_instance.to_dict()
# create an instance of FileChecksumDto from a dict
file_checksum_dto_from_dict = FileChecksumDto.from_dict(file_checksum_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
generated/immich/openapi_client/docs/FileChecksumResponseDto.md
-30
View File
@@ -1,30 +0,0 @@
# FileChecksumResponseDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**checksum** | **str** | |
**filename** | **str** | |
## Example
```python
from generated.immich.openapi_client.models.file_checksum_response_dto import FileChecksumResponseDto
# TODO update the JSON string below
json = "{}"
# create an instance of FileChecksumResponseDto from a JSON string
file_checksum_response_dto_instance = FileChecksumResponseDto.from_json(json)
# print the JSON string representation of the object
print(FileChecksumResponseDto.to_json())
# convert the object into a dict
file_checksum_response_dto_dict = file_checksum_response_dto_instance.to_dict()
# create an instance of FileChecksumResponseDto from a dict
file_checksum_response_dto_from_dict = FileChecksumResponseDto.from_dict(file_checksum_response_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
generated/immich/openapi_client/docs/FileReportDto.md
-30
View File
@@ -1,30 +0,0 @@
# FileReportDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**extras** | **List[str]** | |
**orphans** | [**List[FileReportItemDto]**](FileReportItemDto.md) | |
## Example
```python
from generated.immich.openapi_client.models.file_report_dto import FileReportDto
# TODO update the JSON string below
json = "{}"
# create an instance of FileReportDto from a JSON string
file_report_dto_instance = FileReportDto.from_json(json)
# print the JSON string representation of the object
print(FileReportDto.to_json())
# convert the object into a dict
file_report_dto_dict = file_report_dto_instance.to_dict()
# create an instance of FileReportDto from a dict
file_report_dto_from_dict = FileReportDto.from_dict(file_report_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
generated/immich/openapi_client/docs/FileReportFixDto.md
-29
View File
@@ -1,29 +0,0 @@
# FileReportFixDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**items** | [**List[FileReportItemDto]**](FileReportItemDto.md) | |
## Example
```python
from generated.immich.openapi_client.models.file_report_fix_dto import FileReportFixDto
# TODO update the JSON string below
json = "{}"
# create an instance of FileReportFixDto from a JSON string
file_report_fix_dto_instance = FileReportFixDto.from_json(json)
# print the JSON string representation of the object
print(FileReportFixDto.to_json())
# convert the object into a dict
file_report_fix_dto_dict = file_report_fix_dto_instance.to_dict()
# create an instance of FileReportFixDto from a dict
file_report_fix_dto_from_dict = FileReportFixDto.from_dict(file_report_fix_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
generated/immich/openapi_client/docs/FileReportItemDto.md
-33
View File
@@ -1,33 +0,0 @@
# FileReportItemDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**checksum** | **str** | | [optional]
**entity_id** | **str** | |
**entity_type** | [**PathEntityType**](PathEntityType.md) | |
**path_type** | [**PathType**](PathType.md) | |
**path_value** | **str** | |
## Example
```python
from generated.immich.openapi_client.models.file_report_item_dto import FileReportItemDto
# TODO update the JSON string below
json = "{}"
# create an instance of FileReportItemDto from a JSON string
file_report_item_dto_instance = FileReportItemDto.from_json(json)
# print the JSON string representation of the object
print(FileReportItemDto.to_json())
# convert the object into a dict
file_report_item_dto_dict = file_report_item_dto_instance.to_dict()
# create an instance of FileReportItemDto from a dict
file_report_item_dto_from_dict = FileReportItemDto.from_dict(file_report_item_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
generated/immich/openapi_client/docs/FileReportsApi.md
-267
View File
@@ -1,267 +0,0 @@
# generated.immich.openapi_client.FileReportsApi
All URIs are relative to *https://github.com/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**fix_audit_files**](FileReportsApi.md#fix_audit_files) | **POST** /reports/fix |
[**get_audit_files**](FileReportsApi.md#get_audit_files) | **GET** /reports |
[**get_file_checksums**](FileReportsApi.md#get_file_checksums) | **POST** /reports/checksum |
# **fix_audit_files**
> fix_audit_files(file_report_fix_dto)
### Example
* Api Key Authentication (cookie):
* Api Key Authentication (api_key):
* Bearer (JWT) Authentication (bearer):
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.models.file_report_fix_dto import FileReportFixDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
host = "https://github.com/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.FileReportsApi(api_client)
file_report_fix_dto = generated.immich.openapi_client.FileReportFixDto() # FileReportFixDto |
try:
api_instance.fix_audit_files(file_report_fix_dto)
except Exception as e:
print("Exception when calling FileReportsApi->fix_audit_files: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**file_report_fix_dto** | [**FileReportFixDto**](FileReportFixDto.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
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | | - |
[[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_audit_files**
> FileReportDto get_audit_files()
### Example
* Api Key Authentication (cookie):
* Api Key Authentication (api_key):
* Bearer (JWT) Authentication (bearer):
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.models.file_report_dto import FileReportDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
host = "https://github.com/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.FileReportsApi(api_client)
try:
api_response = api_instance.get_audit_files()
print("The response of FileReportsApi->get_audit_files:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling FileReportsApi->get_audit_files: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**FileReportDto**](FileReportDto.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
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[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_file_checksums**
> List[FileChecksumResponseDto] get_file_checksums(file_checksum_dto)
### Example
* Api Key Authentication (cookie):
* Api Key Authentication (api_key):
* Bearer (JWT) Authentication (bearer):
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.models.file_checksum_dto import FileChecksumDto
from generated.immich.openapi_client.models.file_checksum_response_dto import FileChecksumResponseDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
host = "https://github.com/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.FileReportsApi(api_client)
file_checksum_dto = generated.immich.openapi_client.FileChecksumDto() # FileChecksumDto |
try:
api_response = api_instance.get_file_checksums(file_checksum_dto)
print("The response of FileReportsApi->get_file_checksums:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling FileReportsApi->get_file_checksums: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**file_checksum_dto** | [**FileChecksumDto**](FileChecksumDto.md)| |
### Return type
[**List[FileChecksumResponseDto]**](FileChecksumResponseDto.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
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | | - |
[[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)
generated/immich/openapi_client/docs/FoldersResponse.md
+2 -2
View File
@@ -5,8 +5,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enabled** | **bool** | | [default to False]
**sidebar_web** | **bool** | | [default to False]
**enabled** | **bool** | Whether folders are enabled |
**sidebar_web** | **bool** | Whether folders appear in web sidebar |
## Example
generated/immich/openapi_client/docs/FoldersUpdate.md
+2 -2
View File
@@ -5,8 +5,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enabled** | **bool** | | [optional]
**sidebar_web** | **bool** | | [optional]
**enabled** | **bool** | Whether folders are enabled | [optional]
**sidebar_web** | **bool** | Whether folders appear in web sidebar | [optional]
## Example
generated/immich/openapi_client/docs/ImageFormat.md
+1
View File
@@ -1,5 +1,6 @@
# ImageFormat
Image format
## Enum
generated/immich/openapi_client/docs/JobCommand.md
-18
View File
@@ -1,18 +0,0 @@
# JobCommand
## Enum
* `START` (value: `'start'`)
* `PAUSE` (value: `'pause'`)
* `RESUME` (value: `'resume'`)
* `EMPTY` (value: `'empty'`)
* `CLEAR_MINUS_FAILED` (value: `'clear-failed'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
generated/immich/openapi_client/docs/JobCommandDto.md
-30
View File
@@ -1,30 +0,0 @@
# JobCommandDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**command** | [**JobCommand**](JobCommand.md) | |
**force** | **bool** | | [optional]
## Example
```python
from generated.immich.openapi_client.models.job_command_dto import JobCommandDto
# TODO update the JSON string below
json = "{}"
# create an instance of JobCommandDto from a JSON string
job_command_dto_instance = JobCommandDto.from_json(json)
# print the JSON string representation of the object
print(JobCommandDto.to_json())
# convert the object into a dict
job_command_dto_dict = job_command_dto_instance.to_dict()
# create an instance of JobCommandDto from a dict
job_command_dto_from_dict = JobCommandDto.from_dict(job_command_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
generated/immich/openapi_client/docs/JobCountsDto.md
-34
View File
@@ -1,34 +0,0 @@
# JobCountsDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**active** | **int** | |
**completed** | **int** | |
**delayed** | **int** | |
**failed** | **int** | |
**paused** | **int** | |
**waiting** | **int** | |
## Example
```python
from generated.immich.openapi_client.models.job_counts_dto import JobCountsDto
# TODO update the JSON string below
json = "{}"
# create an instance of JobCountsDto from a JSON string
job_counts_dto_instance = JobCountsDto.from_json(json)
# print the JSON string representation of the object
print(JobCountsDto.to_json())
# convert the object into a dict
job_counts_dto_dict = job_counts_dto_instance.to_dict()
# create an instance of JobCountsDto from a dict
job_counts_dto_from_dict = JobCountsDto.from_dict(job_counts_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
generated/immich/openapi_client/docs/JobName.md
+118 -15
View File
@@ -1,37 +1,140 @@
# JobName
Job name
## Enum
* `THUMBNAILGENERATION` (value: `'thumbnailGeneration'`)
* `ASSETDELETE` (value: `'AssetDelete'`)
* `METADATAEXTRACTION` (value: `'metadataExtraction'`)
* `ASSETDELETECHECK` (value: `'AssetDeleteCheck'`)
* `VIDEOCONVERSION` (value: `'videoConversion'`)
* `ASSETDETECTFACESQUEUEALL` (value: `'AssetDetectFacesQueueAll'`)
* `FACEDETECTION` (value: `'faceDetection'`)
* `ASSETDETECTFACES` (value: `'AssetDetectFaces'`)
* `FACIALRECOGNITION` (value: `'facialRecognition'`)
* `ASSETDETECTDUPLICATESQUEUEALL` (value: `'AssetDetectDuplicatesQueueAll'`)
* `SMARTSEARCH` (value: `'smartSearch'`)
* `ASSETDETECTDUPLICATES` (value: `'AssetDetectDuplicates'`)
* `DUPLICATEDETECTION` (value: `'duplicateDetection'`)
* `ASSETEDITTHUMBNAILGENERATION` (value: `'AssetEditThumbnailGeneration'`)
* `BACKGROUNDTASK` (value: `'backgroundTask'`)
* `ASSETENCODEVIDEOQUEUEALL` (value: `'AssetEncodeVideoQueueAll'`)
* `STORAGETEMPLATEMIGRATION` (value: `'storageTemplateMigration'`)
* `ASSETENCODEVIDEO` (value: `'AssetEncodeVideo'`)
* `MIGRATION` (value: `'migration'`)
* `ASSETEMPTYTRASH` (value: `'AssetEmptyTrash'`)
* `SEARCH` (value: `'search'`)
* `ASSETEXTRACTMETADATAQUEUEALL` (value: `'AssetExtractMetadataQueueAll'`)
* `SIDECAR` (value: `'sidecar'`)
* `ASSETEXTRACTMETADATA` (value: `'AssetExtractMetadata'`)
* `LIBRARY` (value: `'library'`)
* `ASSETFILEMIGRATION` (value: `'AssetFileMigration'`)
* `NOTIFICATIONS` (value: `'notifications'`)
* `ASSETGENERATETHUMBNAILSQUEUEALL` (value: `'AssetGenerateThumbnailsQueueAll'`)
* `BACKUPDATABASE` (value: `'backupDatabase'`)
* `ASSETGENERATETHUMBNAILS` (value: `'AssetGenerateThumbnails'`)
* `AUDITTABLECLEANUP` (value: `'AuditTableCleanup'`)
* `DATABASEBACKUP` (value: `'DatabaseBackup'`)
* `FACIALRECOGNITIONQUEUEALL` (value: `'FacialRecognitionQueueAll'`)
* `FACIALRECOGNITION` (value: `'FacialRecognition'`)
* `FILEDELETE` (value: `'FileDelete'`)
* `FILEMIGRATIONQUEUEALL` (value: `'FileMigrationQueueAll'`)
* `LIBRARYDELETECHECK` (value: `'LibraryDeleteCheck'`)
* `LIBRARYDELETE` (value: `'LibraryDelete'`)
* `LIBRARYREMOVEASSET` (value: `'LibraryRemoveAsset'`)
* `LIBRARYSCANASSETSQUEUEALL` (value: `'LibraryScanAssetsQueueAll'`)
* `LIBRARYSYNCASSETS` (value: `'LibrarySyncAssets'`)
* `LIBRARYSYNCFILESQUEUEALL` (value: `'LibrarySyncFilesQueueAll'`)
* `LIBRARYSYNCFILES` (value: `'LibrarySyncFiles'`)
* `LIBRARYSCANQUEUEALL` (value: `'LibraryScanQueueAll'`)
* `HLSSESSIONCLEANUP` (value: `'HlsSessionCleanup'`)
* `MEMORYCLEANUP` (value: `'MemoryCleanup'`)
* `MEMORYGENERATE` (value: `'MemoryGenerate'`)
* `NOTIFICATIONSCLEANUP` (value: `'NotificationsCleanup'`)
* `NOTIFYUSERSIGNUP` (value: `'NotifyUserSignup'`)
* `NOTIFYALBUMINVITE` (value: `'NotifyAlbumInvite'`)
* `NOTIFYALBUMUPDATE` (value: `'NotifyAlbumUpdate'`)
* `USERDELETE` (value: `'UserDelete'`)
* `USERDELETECHECK` (value: `'UserDeleteCheck'`)
* `USERSYNCUSAGE` (value: `'UserSyncUsage'`)
* `PERSONCLEANUP` (value: `'PersonCleanup'`)
* `PERSONFILEMIGRATION` (value: `'PersonFileMigration'`)
* `PERSONGENERATETHUMBNAIL` (value: `'PersonGenerateThumbnail'`)
* `SESSIONCLEANUP` (value: `'SessionCleanup'`)
* `SENDMAIL` (value: `'SendMail'`)
* `SIDECARQUEUEALL` (value: `'SidecarQueueAll'`)
* `SIDECARCHECK` (value: `'SidecarCheck'`)
* `SIDECARWRITE` (value: `'SidecarWrite'`)
* `SMARTSEARCHQUEUEALL` (value: `'SmartSearchQueueAll'`)
* `SMARTSEARCH` (value: `'SmartSearch'`)
* `STORAGETEMPLATEMIGRATION` (value: `'StorageTemplateMigration'`)
* `STORAGETEMPLATEMIGRATIONSINGLE` (value: `'StorageTemplateMigrationSingle'`)
* `TAGCLEANUP` (value: `'TagCleanup'`)
* `VERSIONCHECK` (value: `'VersionCheck'`)
* `OCRQUEUEALL` (value: `'OcrQueueAll'`)
* `OCR` (value: `'Ocr'`)
* `WORKFLOWASSETTRIGGER` (value: `'WorkflowAssetTrigger'`)
* `INTEGRITYUNTRACKEDFILESQUEUEALL` (value: `'IntegrityUntrackedFilesQueueAll'`)
* `INTEGRITYUNTRACKEDFILES` (value: `'IntegrityUntrackedFiles'`)
* `INTEGRITYUNTRACKEDREFRESH` (value: `'IntegrityUntrackedRefresh'`)
* `INTEGRITYMISSINGFILESQUEUEALL` (value: `'IntegrityMissingFilesQueueAll'`)
* `INTEGRITYMISSINGFILES` (value: `'IntegrityMissingFiles'`)
* `INTEGRITYMISSINGFILESREFRESH` (value: `'IntegrityMissingFilesRefresh'`)
* `INTEGRITYCHECKSUMFILES` (value: `'IntegrityChecksumFiles'`)
* `INTEGRITYCHECKSUMFILESREFRESH` (value: `'IntegrityChecksumFilesRefresh'`)
* `INTEGRITYDELETEREPORTTYPE` (value: `'IntegrityDeleteReportType'`)
* `INTEGRITYDELETEREPORTS` (value: `'IntegrityDeleteReports'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
generated/immich/openapi_client/docs/JobSettingsDto.md
+1 -1
View File
@@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**concurrency** | **int** | |
**concurrency** | **int** | Concurrency |
## Example
generated/immich/openapi_client/docs/JobStatusDto.md
-30
View File
@@ -1,30 +0,0 @@
# JobStatusDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**job_counts** | [**JobCountsDto**](JobCountsDto.md) | |
**queue_status** | [**QueueStatusDto**](QueueStatusDto.md) | |
## Example
```python
from generated.immich.openapi_client.models.job_status_dto import JobStatusDto
# TODO update the JSON string below
json = "{}"
# create an instance of JobStatusDto from a JSON string
job_status_dto_instance = JobStatusDto.from_json(json)
# print the JSON string representation of the object
print(JobStatusDto.to_json())
# convert the object into a dict
job_status_dto_dict = job_status_dto_instance.to_dict()
# create an instance of JobStatusDto from a dict
job_status_dto_from_dict = JobStatusDto.from_dict(job_status_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
generated/immich/openapi_client/docs/JobsApi.md
+39 -24
View File
@@ -4,14 +4,18 @@ All URIs are relative to *https://github.com/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create_job**](JobsApi.md#create_job) | **POST** /jobs |
[**get_all_jobs_status**](JobsApi.md#get_all_jobs_status) | **GET** /jobs |
[**send_job_command**](JobsApi.md#send_job_command) | **PUT** /jobs/{id} |
[**create_job**](JobsApi.md#create_job) | **POST** /jobs | Create a manual job
[**get_queues_legacy**](JobsApi.md#get_queues_legacy) | **GET** /jobs | Retrieve queue counts and status
[**run_queue_command_legacy**](JobsApi.md#run_queue_command_legacy) | **PUT** /jobs/{name} | Run jobs
# **create_job**
> create_job(job_create_dto)
Create a manual job
Run a specific job. Most jobs are queued automatically, but this endpoint allows for manual creation of a handful of jobs, including various cleanup tasks, as well as creating a new database backup.
### Example
* Api Key Authentication (cookie):
@@ -59,6 +63,7 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
job_create_dto = generated.immich.openapi_client.JobCreateDto() # JobCreateDto |
try:
# Create a manual job
api_instance.create_job(job_create_dto)
except Exception as e:
print("Exception when calling JobsApi->create_job: %s\n" % e)
@@ -90,12 +95,16 @@ void (empty response body)
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | | - |
**204** | | - |
[[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_all_jobs_status**
> AllJobStatusResponseDto get_all_jobs_status()
# **get_queues_legacy**
> QueuesResponseLegacyDto get_queues_legacy()
Retrieve queue counts and status
Retrieve the counts of the current queue, as well as the current status.
### Example
@@ -105,7 +114,7 @@ void (empty response body)
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.models.all_job_status_response_dto import AllJobStatusResponseDto
from generated.immich.openapi_client.models.queues_response_legacy_dto import QueuesResponseLegacyDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
@@ -143,11 +152,12 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
api_instance = generated.immich.openapi_client.JobsApi(api_client)
try:
api_response = api_instance.get_all_jobs_status()
print("The response of JobsApi->get_all_jobs_status:\n")
# Retrieve queue counts and status
api_response = api_instance.get_queues_legacy()
print("The response of JobsApi->get_queues_legacy:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling JobsApi->get_all_jobs_status: %s\n" % e)
print("Exception when calling JobsApi->get_queues_legacy: %s\n" % e)
```
@@ -158,7 +168,7 @@ This endpoint does not need any parameter.
### Return type
[**AllJobStatusResponseDto**](AllJobStatusResponseDto.md)
[**QueuesResponseLegacyDto**](QueuesResponseLegacyDto.md)
### Authorization
@@ -177,8 +187,12 @@ This endpoint does not need any parameter.
[[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)
# **send_job_command**
> JobStatusDto send_job_command(id, job_command_dto)
# **run_queue_command_legacy**
> QueueResponseLegacyDto run_queue_command_legacy(name, queue_command_dto)
Run jobs
Queue all assets for a specific job type. Defaults to only queueing assets that have not yet been processed, but the force command can be used to re-process all assets.
### Example
@@ -188,9 +202,9 @@ This endpoint does not need any parameter.
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.models.job_command_dto import JobCommandDto
from generated.immich.openapi_client.models.job_name import JobName
from generated.immich.openapi_client.models.job_status_dto import JobStatusDto
from generated.immich.openapi_client.models.queue_command_dto import QueueCommandDto
from generated.immich.openapi_client.models.queue_name import QueueName
from generated.immich.openapi_client.models.queue_response_legacy_dto import QueueResponseLegacyDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
@@ -226,15 +240,16 @@ configuration = generated.immich.openapi_client.Configuration(
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.JobsApi(api_client)
id = generated.immich.openapi_client.JobName() # JobName |
job_command_dto = generated.immich.openapi_client.JobCommandDto() # JobCommandDto |
name = generated.immich.openapi_client.QueueName() # QueueName |
queue_command_dto = generated.immich.openapi_client.QueueCommandDto() # QueueCommandDto |
try:
api_response = api_instance.send_job_command(id, job_command_dto)
print("The response of JobsApi->send_job_command:\n")
# Run jobs
api_response = api_instance.run_queue_command_legacy(name, queue_command_dto)
print("The response of JobsApi->run_queue_command_legacy:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling JobsApi->send_job_command: %s\n" % e)
print("Exception when calling JobsApi->run_queue_command_legacy: %s\n" % e)
```
@@ -244,12 +259,12 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | [**JobName**](.md)| |
**job_command_dto** | [**JobCommandDto**](JobCommandDto.md)| |
**name** | [**QueueName**](.md)| |
**queue_command_dto** | [**QueueCommandDto**](QueueCommandDto.md)| |
### Return type
[**JobStatusDto**](JobStatusDto.md)
[**QueueResponseLegacyDto**](QueueResponseLegacyDto.md)
### Authorization
generated/immich/openapi_client/docs/LibrariesApi.md
+60 -20
View File
@@ -4,19 +4,23 @@ All URIs are relative to *https://github.com/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create_library**](LibrariesApi.md#create_library) | **POST** /libraries |
[**delete_library**](LibrariesApi.md#delete_library) | **DELETE** /libraries/{id} |
[**get_all_libraries**](LibrariesApi.md#get_all_libraries) | **GET** /libraries |
[**get_library**](LibrariesApi.md#get_library) | **GET** /libraries/{id} |
[**get_library_statistics**](LibrariesApi.md#get_library_statistics) | **GET** /libraries/{id}/statistics |
[**scan_library**](LibrariesApi.md#scan_library) | **POST** /libraries/{id}/scan |
[**update_library**](LibrariesApi.md#update_library) | **PUT** /libraries/{id} |
[**validate**](LibrariesApi.md#validate) | **POST** /libraries/{id}/validate |
[**create_library**](LibrariesApi.md#create_library) | **POST** /libraries | Create a library
[**delete_library**](LibrariesApi.md#delete_library) | **DELETE** /libraries/{id} | Delete a library
[**get_all_libraries**](LibrariesApi.md#get_all_libraries) | **GET** /libraries | Retrieve libraries
[**get_library**](LibrariesApi.md#get_library) | **GET** /libraries/{id} | Retrieve a library
[**get_library_statistics**](LibrariesApi.md#get_library_statistics) | **GET** /libraries/{id}/statistics | Retrieve library statistics
[**scan_library**](LibrariesApi.md#scan_library) | **POST** /libraries/{id}/scan | Scan a library
[**update_library**](LibrariesApi.md#update_library) | **PUT** /libraries/{id} | Update a library
[**validate**](LibrariesApi.md#validate) | **POST** /libraries/{id}/validate | Validate library settings
# **create_library**
> LibraryResponseDto create_library(create_library_dto)
Create a library
Create a new external library.
### Example
* Api Key Authentication (cookie):
@@ -65,6 +69,7 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
create_library_dto = generated.immich.openapi_client.CreateLibraryDto() # CreateLibraryDto |
try:
# Create a library
api_response = api_instance.create_library(create_library_dto)
print("The response of LibrariesApi->create_library:\n")
pprint(api_response)
@@ -105,6 +110,10 @@ Name | Type | Description | Notes
# **delete_library**
> delete_library(id)
Delete a library
Delete an external library by its ID.
### Example
* Api Key Authentication (cookie):
@@ -148,9 +157,10 @@ configuration = generated.immich.openapi_client.Configuration(
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.LibrariesApi(api_client)
id = 'id_example' # str |
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |
try:
# Delete a library
api_instance.delete_library(id)
except Exception as e:
print("Exception when calling LibrariesApi->delete_library: %s\n" % e)
@@ -163,7 +173,7 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| |
**id** | **UUID**| |
### Return type
@@ -189,6 +199,10 @@ void (empty response body)
# **get_all_libraries**
> List[LibraryResponseDto] get_all_libraries()
Retrieve libraries
Retrieve a list of external libraries.
### Example
* Api Key Authentication (cookie):
@@ -235,6 +249,7 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
api_instance = generated.immich.openapi_client.LibrariesApi(api_client)
try:
# Retrieve libraries
api_response = api_instance.get_all_libraries()
print("The response of LibrariesApi->get_all_libraries:\n")
pprint(api_response)
@@ -272,6 +287,10 @@ This endpoint does not need any parameter.
# **get_library**
> LibraryResponseDto get_library(id)
Retrieve a library
Retrieve an external library by its ID.
### Example
* Api Key Authentication (cookie):
@@ -316,9 +335,10 @@ configuration = generated.immich.openapi_client.Configuration(
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.LibrariesApi(api_client)
id = 'id_example' # str |
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |
try:
# Retrieve a library
api_response = api_instance.get_library(id)
print("The response of LibrariesApi->get_library:\n")
pprint(api_response)
@@ -333,7 +353,7 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| |
**id** | **UUID**| |
### Return type
@@ -359,6 +379,10 @@ Name | Type | Description | Notes
# **get_library_statistics**
> LibraryStatsResponseDto get_library_statistics(id)
Retrieve library statistics
Retrieve statistics for a specific external library, including number of videos, images, and storage usage.
### Example
* Api Key Authentication (cookie):
@@ -403,9 +427,10 @@ configuration = generated.immich.openapi_client.Configuration(
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.LibrariesApi(api_client)
id = 'id_example' # str |
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |
try:
# Retrieve library statistics
api_response = api_instance.get_library_statistics(id)
print("The response of LibrariesApi->get_library_statistics:\n")
pprint(api_response)
@@ -420,7 +445,7 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| |
**id** | **UUID**| |
### Return type
@@ -446,6 +471,10 @@ Name | Type | Description | Notes
# **scan_library**
> scan_library(id)
Scan a library
Queue a scan for the external library to find and import new assets.
### Example
* Api Key Authentication (cookie):
@@ -489,9 +518,10 @@ configuration = generated.immich.openapi_client.Configuration(
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.LibrariesApi(api_client)
id = 'id_example' # str |
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |
try:
# Scan a library
api_instance.scan_library(id)
except Exception as e:
print("Exception when calling LibrariesApi->scan_library: %s\n" % e)
@@ -504,7 +534,7 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| |
**id** | **UUID**| |
### Return type
@@ -530,6 +560,10 @@ void (empty response body)
# **update_library**
> LibraryResponseDto update_library(id, update_library_dto)
Update a library
Update an existing external library.
### Example
* Api Key Authentication (cookie):
@@ -575,10 +609,11 @@ configuration = generated.immich.openapi_client.Configuration(
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.LibrariesApi(api_client)
id = 'id_example' # str |
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |
update_library_dto = generated.immich.openapi_client.UpdateLibraryDto() # UpdateLibraryDto |
try:
# Update a library
api_response = api_instance.update_library(id, update_library_dto)
print("The response of LibrariesApi->update_library:\n")
pprint(api_response)
@@ -593,7 +628,7 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| |
**id** | **UUID**| |
**update_library_dto** | [**UpdateLibraryDto**](UpdateLibraryDto.md)| |
### Return type
@@ -620,6 +655,10 @@ Name | Type | Description | Notes
# **validate**
> ValidateLibraryResponseDto validate(id, validate_library_dto)
Validate library settings
Validate the settings of an external library.
### Example
* Api Key Authentication (cookie):
@@ -665,10 +704,11 @@ configuration = generated.immich.openapi_client.Configuration(
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.LibrariesApi(api_client)
id = 'id_example' # str |
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |
validate_library_dto = generated.immich.openapi_client.ValidateLibraryDto() # ValidateLibraryDto |
try:
# Validate library settings
api_response = api_instance.validate(id, validate_library_dto)
print("The response of LibrariesApi->validate:\n")
pprint(api_response)
@@ -683,7 +723,7 @@ with generated.immich.openapi_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| |
**id** | **UUID**| |
**validate_library_dto** | [**ValidateLibraryDto**](ValidateLibraryDto.md)| |
### Return type
generated/immich/openapi_client/docs/LibraryResponseDto.md
+9 -9
View File
@@ -5,15 +5,15 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_count** | **int** | |
**created_at** | **datetime** | |
**exclusion_patterns** | **List[str]** | |
**id** | **str** | |
**import_paths** | **List[str]** | |
**name** | **str** | |
**owner_id** | **str** | |
**refreshed_at** | **datetime** | |
**updated_at** | **datetime** | |
**asset_count** | **int** | Number of assets |
**created_at** | **datetime** | Creation date |
**exclusion_patterns** | **List[str]** | Exclusion patterns |
**id** | **UUID** | Library ID |
**import_paths** | **List[str]** | Import paths |
**name** | **str** | Library name |
**owner_id** | **UUID** | Owner user ID |
**refreshed_at** | **datetime** | Last refresh date |
**updated_at** | **datetime** | Last update date |
## Example
generated/immich/openapi_client/docs/LibraryStatsResponseDto.md
+4 -4
View File
@@ -5,10 +5,10 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**photos** | **int** | | [default to 0]
**total** | **int** | | [default to 0]
**usage** | **int** | | [default to 0]
**videos** | **int** | | [default to 0]
**photos** | **int** | Number of photos |
**total** | **int** | Total number of assets |
**usage** | **int** | Storage usage in bytes |
**videos** | **int** | Number of videos |
## Example
generated/immich/openapi_client/docs/LicenseKeyDto.md
+2 -2
View File
@@ -5,8 +5,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**activation_key** | **str** | |
**license_key** | **str** | |
**activation_key** | **str** | Activation key |
**license_key** | **str** | License key (format: /^IM(SV|CL)(-[\\dA-Za-z]{4}){8}$/) |
## Example
generated/immich/openapi_client/docs/LicenseResponseDto.md
-31
View File
@@ -1,31 +0,0 @@
# LicenseResponseDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**activated_at** | **datetime** | |
**activation_key** | **str** | |
**license_key** | **str** | |
## Example
```python
from generated.immich.openapi_client.models.license_response_dto import LicenseResponseDto
# TODO update the JSON string below
json = "{}"
# create an instance of LicenseResponseDto from a JSON string
license_response_dto_instance = LicenseResponseDto.from_json(json)
# print the JSON string representation of the object
print(LicenseResponseDto.to_json())
# convert the object into a dict
license_response_dto_dict = license_response_dto_instance.to_dict()
# create an instance of LicenseResponseDto from a dict
license_response_dto_from_dict = LicenseResponseDto.from_dict(license_response_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
generated/immich/openapi_client/docs/LogLevel.md
+1
View File
@@ -1,5 +1,6 @@
# LogLevel
Log level
## Enum
generated/immich/openapi_client/docs/LoginCredentialDto.md
+2 -2
View File
@@ -5,8 +5,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **str** | |
**password** | **str** | |
**email** | **str** | User email |
**password** | **str** | User password |
## Example

Some files were not shown because too many files have changed in this diff Show More