[TASK] Initial version, with some help from Junie. Copies all files in albums to the local filesystem.
This commit is contained in:
30
generated/immich/openapi_client/docs/APIKeyCreateDto.md
Normal file
30
generated/immich/openapi_client/docs/APIKeyCreateDto.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# 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)
|
||||
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
# 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)
|
||||
|
||||
|
||||
33
generated/immich/openapi_client/docs/APIKeyResponseDto.md
Normal file
33
generated/immich/openapi_client/docs/APIKeyResponseDto.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# 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)
|
||||
|
||||
|
||||
29
generated/immich/openapi_client/docs/APIKeyUpdateDto.md
Normal file
29
generated/immich/openapi_client/docs/APIKeyUpdateDto.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# 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)
|
||||
|
||||
|
||||
445
generated/immich/openapi_client/docs/APIKeysApi.md
Normal file
445
generated/immich/openapi_client/docs/APIKeysApi.md
Normal file
@@ -0,0 +1,445 @@
|
||||
# generated.immich.openapi_client.APIKeysApi
|
||||
|
||||
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**
|
||||
> APIKeyCreateResponseDto create_api_key(api_key_create_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.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
|
||||
|
||||
# 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)
|
||||
api_key_create_dto = generated.immich.openapi_client.APIKeyCreateDto() # APIKeyCreateDto |
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_api_key(api_key_create_dto)
|
||||
print("The response of APIKeysApi->create_api_key:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling APIKeysApi->create_api_key: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**api_key_create_dto** | [**APIKeyCreateDto**](APIKeyCreateDto.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**APIKeyCreateResponseDto**](APIKeyCreateResponseDto.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)
|
||||
|
||||
# **delete_api_key**
|
||||
> delete_api_key(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.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)
|
||||
id = 'id_example' # str |
|
||||
|
||||
try:
|
||||
api_instance.delete_api_key(id)
|
||||
except Exception as e:
|
||||
print("Exception when calling APIKeysApi->delete_api_key: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **str**| |
|
||||
|
||||
### 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)
|
||||
|
||||
# **get_api_key**
|
||||
> APIKeyResponseDto get_api_key(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.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)
|
||||
id = 'id_example' # str |
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_key(id)
|
||||
print("The response of APIKeysApi->get_api_key:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling APIKeysApi->get_api_key: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **str**| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**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_api_keys**
|
||||
> List[APIKeyResponseDto] get_api_keys()
|
||||
|
||||
### 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:
|
||||
api_response = api_instance.get_api_keys()
|
||||
print("The response of APIKeysApi->get_api_keys:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling APIKeysApi->get_api_keys: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**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)
|
||||
|
||||
# **update_api_key**
|
||||
> APIKeyResponseDto update_api_key(id, api_key_update_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.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
|
||||
|
||||
# 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)
|
||||
id = 'id_example' # str |
|
||||
api_key_update_dto = generated.immich.openapi_client.APIKeyUpdateDto() # APIKeyUpdateDto |
|
||||
|
||||
try:
|
||||
api_response = api_instance.update_api_key(id, api_key_update_dto)
|
||||
print("The response of APIKeysApi->update_api_key:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling APIKeysApi->update_api_key: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **str**| |
|
||||
**api_key_update_dto** | [**APIKeyUpdateDto**](APIKeyUpdateDto.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**APIKeyResponseDto**](APIKeyResponseDto.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)
|
||||
|
||||
370
generated/immich/openapi_client/docs/ActivitiesApi.md
Normal file
370
generated/immich/openapi_client/docs/ActivitiesApi.md
Normal file
@@ -0,0 +1,370 @@
|
||||
# generated.immich.openapi_client.ActivitiesApi
|
||||
|
||||
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**
|
||||
> ActivityResponseDto create_activity(activity_create_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.activity_create_dto import ActivityCreateDto
|
||||
from generated.immich.openapi_client.models.activity_response_dto import ActivityResponseDto
|
||||
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.ActivitiesApi(api_client)
|
||||
activity_create_dto = generated.immich.openapi_client.ActivityCreateDto() # ActivityCreateDto |
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_activity(activity_create_dto)
|
||||
print("The response of ActivitiesApi->create_activity:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling ActivitiesApi->create_activity: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**activity_create_dto** | [**ActivityCreateDto**](ActivityCreateDto.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ActivityResponseDto**](ActivityResponseDto.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)
|
||||
|
||||
# **delete_activity**
|
||||
> delete_activity(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.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.ActivitiesApi(api_client)
|
||||
id = 'id_example' # str |
|
||||
|
||||
try:
|
||||
api_instance.delete_activity(id)
|
||||
except Exception as e:
|
||||
print("Exception when calling ActivitiesApi->delete_activity: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **str**| |
|
||||
|
||||
### 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)
|
||||
|
||||
# **get_activities**
|
||||
> List[ActivityResponseDto] get_activities(album_id, asset_id=asset_id, level=level, type=type, user_id=user_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.activity_response_dto import ActivityResponseDto
|
||||
from generated.immich.openapi_client.models.reaction_level import ReactionLevel
|
||||
from generated.immich.openapi_client.models.reaction_type import ReactionType
|
||||
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.ActivitiesApi(api_client)
|
||||
album_id = 'album_id_example' # str |
|
||||
asset_id = 'asset_id_example' # str | (optional)
|
||||
level = generated.immich.openapi_client.ReactionLevel() # ReactionLevel | (optional)
|
||||
type = generated.immich.openapi_client.ReactionType() # ReactionType | (optional)
|
||||
user_id = 'user_id_example' # str | (optional)
|
||||
|
||||
try:
|
||||
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)
|
||||
except Exception as e:
|
||||
print("Exception when calling ActivitiesApi->get_activities: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**album_id** | **str**| |
|
||||
**asset_id** | **str**| | [optional]
|
||||
**level** | [**ReactionLevel**](.md)| | [optional]
|
||||
**type** | [**ReactionType**](.md)| | [optional]
|
||||
**user_id** | **str**| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**List[ActivityResponseDto]**](ActivityResponseDto.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_activity_statistics**
|
||||
> ActivityStatisticsResponseDto get_activity_statistics(album_id, asset_id=asset_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.activity_statistics_response_dto import ActivityStatisticsResponseDto
|
||||
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.ActivitiesApi(api_client)
|
||||
album_id = 'album_id_example' # str |
|
||||
asset_id = 'asset_id_example' # str | (optional)
|
||||
|
||||
try:
|
||||
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)
|
||||
except Exception as e:
|
||||
print("Exception when calling ActivitiesApi->get_activity_statistics: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**album_id** | **str**| |
|
||||
**asset_id** | **str**| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ActivityStatisticsResponseDto**](ActivityStatisticsResponseDto.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)
|
||||
|
||||
32
generated/immich/openapi_client/docs/ActivityCreateDto.md
Normal file
32
generated/immich/openapi_client/docs/ActivityCreateDto.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# ActivityCreateDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**album_id** | **str** | |
|
||||
**asset_id** | **str** | | [optional]
|
||||
**comment** | **str** | | [optional]
|
||||
**type** | [**ReactionType**](ReactionType.md) | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.activity_create_dto import ActivityCreateDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ActivityCreateDto from a JSON string
|
||||
activity_create_dto_instance = ActivityCreateDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(ActivityCreateDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
activity_create_dto_dict = activity_create_dto_instance.to_dict()
|
||||
# create an instance of ActivityCreateDto from a dict
|
||||
activity_create_dto_from_dict = ActivityCreateDto.from_dict(activity_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)
|
||||
|
||||
|
||||
34
generated/immich/openapi_client/docs/ActivityResponseDto.md
Normal file
34
generated/immich/openapi_client/docs/ActivityResponseDto.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# ActivityResponseDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**asset_id** | **str** | |
|
||||
**comment** | **str** | | [optional]
|
||||
**created_at** | **datetime** | |
|
||||
**id** | **str** | |
|
||||
**type** | [**ReactionType**](ReactionType.md) | |
|
||||
**user** | [**UserResponseDto**](UserResponseDto.md) | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.activity_response_dto import ActivityResponseDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ActivityResponseDto from a JSON string
|
||||
activity_response_dto_instance = ActivityResponseDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(ActivityResponseDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
activity_response_dto_dict = activity_response_dto_instance.to_dict()
|
||||
# create an instance of ActivityResponseDto from a dict
|
||||
activity_response_dto_from_dict = ActivityResponseDto.from_dict(activity_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
# ActivityStatisticsResponseDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**comments** | **int** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.activity_statistics_response_dto import ActivityStatisticsResponseDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ActivityStatisticsResponseDto from a JSON string
|
||||
activity_statistics_response_dto_instance = ActivityStatisticsResponseDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(ActivityStatisticsResponseDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
activity_statistics_response_dto_dict = activity_statistics_response_dto_instance.to_dict()
|
||||
# create an instance of ActivityStatisticsResponseDto from a dict
|
||||
activity_statistics_response_dto_from_dict = ActivityStatisticsResponseDto.from_dict(activity_statistics_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)
|
||||
|
||||
|
||||
29
generated/immich/openapi_client/docs/AddUsersDto.md
Normal file
29
generated/immich/openapi_client/docs/AddUsersDto.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# AddUsersDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**album_users** | [**List[AlbumUserAddDto]**](AlbumUserAddDto.md) | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.add_users_dto import AddUsersDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AddUsersDto from a JSON string
|
||||
add_users_dto_instance = AddUsersDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AddUsersDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
add_users_dto_dict = add_users_dto_instance.to_dict()
|
||||
# create an instance of AddUsersDto from a dict
|
||||
add_users_dto_from_dict = AddUsersDto.from_dict(add_users_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
# AdminOnboardingUpdateDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**is_onboarded** | **bool** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.admin_onboarding_update_dto import AdminOnboardingUpdateDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AdminOnboardingUpdateDto from a JSON string
|
||||
admin_onboarding_update_dto_instance = AdminOnboardingUpdateDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AdminOnboardingUpdateDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
admin_onboarding_update_dto_dict = admin_onboarding_update_dto_instance.to_dict()
|
||||
# create an instance of AdminOnboardingUpdateDto from a dict
|
||||
admin_onboarding_update_dto_from_dict = AdminOnboardingUpdateDto.from_dict(admin_onboarding_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)
|
||||
|
||||
|
||||
46
generated/immich/openapi_client/docs/AlbumResponseDto.md
Normal file
46
generated/immich/openapi_client/docs/AlbumResponseDto.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# AlbumResponseDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
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]
|
||||
**order** | [**AssetOrder**](AssetOrder.md) | | [optional]
|
||||
**owner** | [**UserResponseDto**](UserResponseDto.md) | |
|
||||
**owner_id** | **str** | |
|
||||
**shared** | **bool** | |
|
||||
**start_date** | **datetime** | | [optional]
|
||||
**updated_at** | **datetime** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.album_response_dto import AlbumResponseDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AlbumResponseDto from a JSON string
|
||||
album_response_dto_instance = AlbumResponseDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AlbumResponseDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
album_response_dto_dict = album_response_dto_instance.to_dict()
|
||||
# create an instance of AlbumResponseDto from a dict
|
||||
album_response_dto_from_dict = AlbumResponseDto.from_dict(album_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
# AlbumStatisticsResponseDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**not_shared** | **int** | |
|
||||
**owned** | **int** | |
|
||||
**shared** | **int** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.album_statistics_response_dto import AlbumStatisticsResponseDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AlbumStatisticsResponseDto from a JSON string
|
||||
album_statistics_response_dto_instance = AlbumStatisticsResponseDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AlbumStatisticsResponseDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
album_statistics_response_dto_dict = album_statistics_response_dto_instance.to_dict()
|
||||
# create an instance of AlbumStatisticsResponseDto from a dict
|
||||
album_statistics_response_dto_from_dict = AlbumStatisticsResponseDto.from_dict(album_statistics_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)
|
||||
|
||||
|
||||
30
generated/immich/openapi_client/docs/AlbumUserAddDto.md
Normal file
30
generated/immich/openapi_client/docs/AlbumUserAddDto.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# AlbumUserAddDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**role** | [**AlbumUserRole**](AlbumUserRole.md) | | [optional]
|
||||
**user_id** | **str** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.album_user_add_dto import AlbumUserAddDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AlbumUserAddDto from a JSON string
|
||||
album_user_add_dto_instance = AlbumUserAddDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AlbumUserAddDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
album_user_add_dto_dict = album_user_add_dto_instance.to_dict()
|
||||
# create an instance of AlbumUserAddDto from a dict
|
||||
album_user_add_dto_from_dict = AlbumUserAddDto.from_dict(album_user_add_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)
|
||||
|
||||
|
||||
30
generated/immich/openapi_client/docs/AlbumUserCreateDto.md
Normal file
30
generated/immich/openapi_client/docs/AlbumUserCreateDto.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# AlbumUserCreateDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**role** | [**AlbumUserRole**](AlbumUserRole.md) | |
|
||||
**user_id** | **str** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.album_user_create_dto import AlbumUserCreateDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AlbumUserCreateDto from a JSON string
|
||||
album_user_create_dto_instance = AlbumUserCreateDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AlbumUserCreateDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
album_user_create_dto_dict = album_user_create_dto_instance.to_dict()
|
||||
# create an instance of AlbumUserCreateDto from a dict
|
||||
album_user_create_dto_from_dict = AlbumUserCreateDto.from_dict(album_user_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)
|
||||
|
||||
|
||||
30
generated/immich/openapi_client/docs/AlbumUserResponseDto.md
Normal file
30
generated/immich/openapi_client/docs/AlbumUserResponseDto.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# AlbumUserResponseDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**role** | [**AlbumUserRole**](AlbumUserRole.md) | |
|
||||
**user** | [**UserResponseDto**](UserResponseDto.md) | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.album_user_response_dto import AlbumUserResponseDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AlbumUserResponseDto from a JSON string
|
||||
album_user_response_dto_instance = AlbumUserResponseDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AlbumUserResponseDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
album_user_response_dto_dict = album_user_response_dto_instance.to_dict()
|
||||
# create an instance of AlbumUserResponseDto from a dict
|
||||
album_user_response_dto_from_dict = AlbumUserResponseDto.from_dict(album_user_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)
|
||||
|
||||
|
||||
12
generated/immich/openapi_client/docs/AlbumUserRole.md
Normal file
12
generated/immich/openapi_client/docs/AlbumUserRole.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# AlbumUserRole
|
||||
|
||||
|
||||
## Enum
|
||||
|
||||
* `EDITOR` (value: `'editor'`)
|
||||
|
||||
* `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)
|
||||
|
||||
|
||||
991
generated/immich/openapi_client/docs/AlbumsApi.md
Normal file
991
generated/immich/openapi_client/docs/AlbumsApi.md
Normal file
@@ -0,0 +1,991 @@
|
||||
# generated.immich.openapi_client.AlbumsApi
|
||||
|
||||
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**
|
||||
> List[BulkIdResponseDto] add_assets_to_album(id, bulk_ids_dto, key=key)
|
||||
|
||||
### 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.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.AlbumsApi(api_client)
|
||||
id = 'id_example' # str |
|
||||
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)
|
||||
print("The response of AlbumsApi->add_assets_to_album:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling AlbumsApi->add_assets_to_album: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **str**| |
|
||||
**bulk_ids_dto** | [**BulkIdsDto**](BulkIdsDto.md)| |
|
||||
**key** | **str**| | [optional]
|
||||
|
||||
### 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)
|
||||
|
||||
# **add_users_to_album**
|
||||
> AlbumResponseDto add_users_to_album(id, add_users_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.add_users_dto import AddUsersDto
|
||||
from generated.immich.openapi_client.models.album_response_dto import AlbumResponseDto
|
||||
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 = 'id_example' # str |
|
||||
add_users_dto = generated.immich.openapi_client.AddUsersDto() # AddUsersDto |
|
||||
|
||||
try:
|
||||
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)
|
||||
except Exception as e:
|
||||
print("Exception when calling AlbumsApi->add_users_to_album: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **str**| |
|
||||
**add_users_dto** | [**AddUsersDto**](AddUsersDto.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**AlbumResponseDto**](AlbumResponseDto.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)
|
||||
|
||||
# **create_album**
|
||||
> AlbumResponseDto create_album(create_album_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.album_response_dto import AlbumResponseDto
|
||||
from generated.immich.openapi_client.models.create_album_dto import CreateAlbumDto
|
||||
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)
|
||||
create_album_dto = generated.immich.openapi_client.CreateAlbumDto() # CreateAlbumDto |
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_album(create_album_dto)
|
||||
print("The response of AlbumsApi->create_album:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling AlbumsApi->create_album: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**create_album_dto** | [**CreateAlbumDto**](CreateAlbumDto.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**AlbumResponseDto**](AlbumResponseDto.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)
|
||||
|
||||
# **delete_album**
|
||||
> delete_album(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.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 = 'id_example' # str |
|
||||
|
||||
try:
|
||||
api_instance.delete_album(id)
|
||||
except Exception as e:
|
||||
print("Exception when calling AlbumsApi->delete_album: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **str**| |
|
||||
|
||||
### 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 |
|
||||
|-------------|-------------|------------------|
|
||||
**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_info**
|
||||
> AlbumResponseDto get_album_info(id, key=key, without_assets=without_assets)
|
||||
|
||||
### 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.album_response_dto import AlbumResponseDto
|
||||
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 = 'id_example' # str |
|
||||
key = 'key_example' # str | (optional)
|
||||
without_assets = True # bool | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_album_info(id, key=key, without_assets=without_assets)
|
||||
print("The response of AlbumsApi->get_album_info:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling AlbumsApi->get_album_info: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **str**| |
|
||||
**key** | **str**| | [optional]
|
||||
**without_assets** | **bool**| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**AlbumResponseDto**](AlbumResponseDto.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()
|
||||
|
||||
### 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.album_statistics_response_dto import AlbumStatisticsResponseDto
|
||||
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)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_album_statistics()
|
||||
print("The response of AlbumsApi->get_album_statistics:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling AlbumsApi->get_album_statistics: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**AlbumStatisticsResponseDto**](AlbumStatisticsResponseDto.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_all_albums**
|
||||
> List[AlbumResponseDto] get_all_albums(asset_id=asset_id, shared=shared)
|
||||
|
||||
### 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.album_response_dto import AlbumResponseDto
|
||||
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)
|
||||
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)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_all_albums(asset_id=asset_id, shared=shared)
|
||||
print("The response of AlbumsApi->get_all_albums:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling AlbumsApi->get_all_albums: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
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]
|
||||
|
||||
### Return type
|
||||
|
||||
[**List[AlbumResponseDto]**](AlbumResponseDto.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)
|
||||
|
||||
# **remove_asset_from_album**
|
||||
> List[BulkIdResponseDto] remove_asset_from_album(id, bulk_ids_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.bulk_id_response_dto import BulkIdResponseDto
|
||||
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.AlbumsApi(api_client)
|
||||
id = 'id_example' # str |
|
||||
bulk_ids_dto = generated.immich.openapi_client.BulkIdsDto() # BulkIdsDto |
|
||||
|
||||
try:
|
||||
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)
|
||||
except Exception as e:
|
||||
print("Exception when calling AlbumsApi->remove_asset_from_album: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **str**| |
|
||||
**bulk_ids_dto** | [**BulkIdsDto**](BulkIdsDto.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)
|
||||
|
||||
# **remove_user_from_album**
|
||||
> remove_user_from_album(id, user_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.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 = 'id_example' # str |
|
||||
user_id = 'user_id_example' # str |
|
||||
|
||||
try:
|
||||
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)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **str**| |
|
||||
**user_id** | **str**| |
|
||||
|
||||
### 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 |
|
||||
|-------------|-------------|------------------|
|
||||
**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)
|
||||
|
||||
# **update_album_info**
|
||||
> AlbumResponseDto update_album_info(id, update_album_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.album_response_dto import AlbumResponseDto
|
||||
from generated.immich.openapi_client.models.update_album_dto import UpdateAlbumDto
|
||||
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 = 'id_example' # str |
|
||||
update_album_dto = generated.immich.openapi_client.UpdateAlbumDto() # UpdateAlbumDto |
|
||||
|
||||
try:
|
||||
api_response = api_instance.update_album_info(id, update_album_dto)
|
||||
print("The response of AlbumsApi->update_album_info:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling AlbumsApi->update_album_info: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **str**| |
|
||||
**update_album_dto** | [**UpdateAlbumDto**](UpdateAlbumDto.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**AlbumResponseDto**](AlbumResponseDto.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)
|
||||
|
||||
# **update_album_user**
|
||||
> update_album_user(id, user_id, update_album_user_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.update_album_user_dto import UpdateAlbumUserDto
|
||||
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 = 'id_example' # str |
|
||||
user_id = 'user_id_example' # str |
|
||||
update_album_user_dto = generated.immich.openapi_client.UpdateAlbumUserDto() # UpdateAlbumUserDto |
|
||||
|
||||
try:
|
||||
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)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **str**| |
|
||||
**user_id** | **str**| |
|
||||
**update_album_user_dto** | [**UpdateAlbumUserDto**](UpdateAlbumUserDto.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 |
|
||||
|-------------|-------------|------------------|
|
||||
**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)
|
||||
|
||||
@@ -0,0 +1,43 @@
|
||||
# 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)
|
||||
|
||||
|
||||
30
generated/immich/openapi_client/docs/AssetBulkDeleteDto.md
Normal file
30
generated/immich/openapi_client/docs/AssetBulkDeleteDto.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# AssetBulkDeleteDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**force** | **bool** | | [optional]
|
||||
**ids** | **List[str]** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.asset_bulk_delete_dto import AssetBulkDeleteDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AssetBulkDeleteDto from a JSON string
|
||||
asset_bulk_delete_dto_instance = AssetBulkDeleteDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AssetBulkDeleteDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
asset_bulk_delete_dto_dict = asset_bulk_delete_dto_instance.to_dict()
|
||||
# create an instance of AssetBulkDeleteDto from a dict
|
||||
asset_bulk_delete_dto_from_dict = AssetBulkDeleteDto.from_dict(asset_bulk_delete_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)
|
||||
|
||||
|
||||
36
generated/immich/openapi_client/docs/AssetBulkUpdateDto.md
Normal file
36
generated/immich/openapi_client/docs/AssetBulkUpdateDto.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# AssetBulkUpdateDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
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]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.asset_bulk_update_dto import AssetBulkUpdateDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AssetBulkUpdateDto from a JSON string
|
||||
asset_bulk_update_dto_instance = AssetBulkUpdateDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AssetBulkUpdateDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
asset_bulk_update_dto_dict = asset_bulk_update_dto_instance.to_dict()
|
||||
# create an instance of AssetBulkUpdateDto from a dict
|
||||
asset_bulk_update_dto_from_dict = AssetBulkUpdateDto.from_dict(asset_bulk_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
# AssetBulkUploadCheckDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**assets** | [**List[AssetBulkUploadCheckItem]**](AssetBulkUploadCheckItem.md) | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.asset_bulk_upload_check_dto import AssetBulkUploadCheckDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AssetBulkUploadCheckDto from a JSON string
|
||||
asset_bulk_upload_check_dto_instance = AssetBulkUploadCheckDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AssetBulkUploadCheckDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
asset_bulk_upload_check_dto_dict = asset_bulk_upload_check_dto_instance.to_dict()
|
||||
# create an instance of AssetBulkUploadCheckDto from a dict
|
||||
asset_bulk_upload_check_dto_from_dict = AssetBulkUploadCheckDto.from_dict(asset_bulk_upload_check_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
# AssetBulkUploadCheckItem
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**checksum** | **str** | base64 or hex encoded sha1 hash |
|
||||
**id** | **str** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.asset_bulk_upload_check_item import AssetBulkUploadCheckItem
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AssetBulkUploadCheckItem from a JSON string
|
||||
asset_bulk_upload_check_item_instance = AssetBulkUploadCheckItem.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AssetBulkUploadCheckItem.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
asset_bulk_upload_check_item_dict = asset_bulk_upload_check_item_instance.to_dict()
|
||||
# create an instance of AssetBulkUploadCheckItem from a dict
|
||||
asset_bulk_upload_check_item_from_dict = AssetBulkUploadCheckItem.from_dict(asset_bulk_upload_check_item_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
# AssetBulkUploadCheckResponseDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**results** | [**List[AssetBulkUploadCheckResult]**](AssetBulkUploadCheckResult.md) | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.asset_bulk_upload_check_response_dto import AssetBulkUploadCheckResponseDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AssetBulkUploadCheckResponseDto from a JSON string
|
||||
asset_bulk_upload_check_response_dto_instance = AssetBulkUploadCheckResponseDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AssetBulkUploadCheckResponseDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
asset_bulk_upload_check_response_dto_dict = asset_bulk_upload_check_response_dto_instance.to_dict()
|
||||
# create an instance of AssetBulkUploadCheckResponseDto from a dict
|
||||
asset_bulk_upload_check_response_dto_from_dict = AssetBulkUploadCheckResponseDto.from_dict(asset_bulk_upload_check_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
# AssetBulkUploadCheckResult
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**action** | **str** | |
|
||||
**asset_id** | **str** | | [optional]
|
||||
**id** | **str** | |
|
||||
**is_trashed** | **bool** | | [optional]
|
||||
**reason** | **str** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.asset_bulk_upload_check_result import AssetBulkUploadCheckResult
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AssetBulkUploadCheckResult from a JSON string
|
||||
asset_bulk_upload_check_result_instance = AssetBulkUploadCheckResult.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AssetBulkUploadCheckResult.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
asset_bulk_upload_check_result_dict = asset_bulk_upload_check_result_instance.to_dict()
|
||||
# create an instance of AssetBulkUploadCheckResult from a dict
|
||||
asset_bulk_upload_check_result_from_dict = AssetBulkUploadCheckResult.from_dict(asset_bulk_upload_check_result_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)
|
||||
|
||||
|
||||
30
generated/immich/openapi_client/docs/AssetDeltaSyncDto.md
Normal file
30
generated/immich/openapi_client/docs/AssetDeltaSyncDto.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# 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)
|
||||
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
# 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)
|
||||
|
||||
|
||||
36
generated/immich/openapi_client/docs/AssetFaceCreateDto.md
Normal file
36
generated/immich/openapi_client/docs/AssetFaceCreateDto.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# AssetFaceCreateDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**asset_id** | **str** | |
|
||||
**height** | **int** | |
|
||||
**image_height** | **int** | |
|
||||
**image_width** | **int** | |
|
||||
**person_id** | **str** | |
|
||||
**width** | **int** | |
|
||||
**x** | **int** | |
|
||||
**y** | **int** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.asset_face_create_dto import AssetFaceCreateDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AssetFaceCreateDto from a JSON string
|
||||
asset_face_create_dto_instance = AssetFaceCreateDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AssetFaceCreateDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
asset_face_create_dto_dict = asset_face_create_dto_instance.to_dict()
|
||||
# create an instance of AssetFaceCreateDto from a dict
|
||||
asset_face_create_dto_from_dict = AssetFaceCreateDto.from_dict(asset_face_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)
|
||||
|
||||
|
||||
29
generated/immich/openapi_client/docs/AssetFaceDeleteDto.md
Normal file
29
generated/immich/openapi_client/docs/AssetFaceDeleteDto.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# AssetFaceDeleteDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**force** | **bool** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.asset_face_delete_dto import AssetFaceDeleteDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AssetFaceDeleteDto from a JSON string
|
||||
asset_face_delete_dto_instance = AssetFaceDeleteDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AssetFaceDeleteDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
asset_face_delete_dto_dict = asset_face_delete_dto_instance.to_dict()
|
||||
# create an instance of AssetFaceDeleteDto from a dict
|
||||
asset_face_delete_dto_from_dict = AssetFaceDeleteDto.from_dict(asset_face_delete_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)
|
||||
|
||||
|
||||
37
generated/immich/openapi_client/docs/AssetFaceResponseDto.md
Normal file
37
generated/immich/openapi_client/docs/AssetFaceResponseDto.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# AssetFaceResponseDto
|
||||
|
||||
|
||||
## 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** | |
|
||||
**person** | [**PersonResponseDto**](PersonResponseDto.md) | |
|
||||
**source_type** | [**SourceType**](SourceType.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.asset_face_response_dto import AssetFaceResponseDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AssetFaceResponseDto from a JSON string
|
||||
asset_face_response_dto_instance = AssetFaceResponseDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AssetFaceResponseDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
asset_face_response_dto_dict = asset_face_response_dto_instance.to_dict()
|
||||
# create an instance of AssetFaceResponseDto from a dict
|
||||
asset_face_response_dto_from_dict = AssetFaceResponseDto.from_dict(asset_face_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)
|
||||
|
||||
|
||||
29
generated/immich/openapi_client/docs/AssetFaceUpdateDto.md
Normal file
29
generated/immich/openapi_client/docs/AssetFaceUpdateDto.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# AssetFaceUpdateDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**data** | [**List[AssetFaceUpdateItem]**](AssetFaceUpdateItem.md) | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.asset_face_update_dto import AssetFaceUpdateDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AssetFaceUpdateDto from a JSON string
|
||||
asset_face_update_dto_instance = AssetFaceUpdateDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AssetFaceUpdateDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
asset_face_update_dto_dict = asset_face_update_dto_instance.to_dict()
|
||||
# create an instance of AssetFaceUpdateDto from a dict
|
||||
asset_face_update_dto_from_dict = AssetFaceUpdateDto.from_dict(asset_face_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)
|
||||
|
||||
|
||||
30
generated/immich/openapi_client/docs/AssetFaceUpdateItem.md
Normal file
30
generated/immich/openapi_client/docs/AssetFaceUpdateItem.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# AssetFaceUpdateItem
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**asset_id** | **str** | |
|
||||
**person_id** | **str** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.asset_face_update_item import AssetFaceUpdateItem
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AssetFaceUpdateItem from a JSON string
|
||||
asset_face_update_item_instance = AssetFaceUpdateItem.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AssetFaceUpdateItem.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
asset_face_update_item_dict = asset_face_update_item_instance.to_dict()
|
||||
# create an instance of AssetFaceUpdateItem from a dict
|
||||
asset_face_update_item_from_dict = AssetFaceUpdateItem.from_dict(asset_face_update_item_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,36 @@
|
||||
# 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)
|
||||
|
||||
|
||||
32
generated/immich/openapi_client/docs/AssetFullSyncDto.md
Normal file
32
generated/immich/openapi_client/docs/AssetFullSyncDto.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# 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)
|
||||
|
||||
|
||||
29
generated/immich/openapi_client/docs/AssetIdsDto.md
Normal file
29
generated/immich/openapi_client/docs/AssetIdsDto.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# AssetIdsDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**asset_ids** | **List[str]** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.asset_ids_dto import AssetIdsDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AssetIdsDto from a JSON string
|
||||
asset_ids_dto_instance = AssetIdsDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AssetIdsDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
asset_ids_dto_dict = asset_ids_dto_instance.to_dict()
|
||||
# create an instance of AssetIdsDto from a dict
|
||||
asset_ids_dto_from_dict = AssetIdsDto.from_dict(asset_ids_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)
|
||||
|
||||
|
||||
31
generated/immich/openapi_client/docs/AssetIdsResponseDto.md
Normal file
31
generated/immich/openapi_client/docs/AssetIdsResponseDto.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# AssetIdsResponseDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**asset_id** | **str** | |
|
||||
**error** | **str** | | [optional]
|
||||
**success** | **bool** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.asset_ids_response_dto import AssetIdsResponseDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AssetIdsResponseDto from a JSON string
|
||||
asset_ids_response_dto_instance = AssetIdsResponseDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AssetIdsResponseDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
asset_ids_response_dto_dict = asset_ids_response_dto_instance.to_dict()
|
||||
# create an instance of AssetIdsResponseDto from a dict
|
||||
asset_ids_response_dto_from_dict = AssetIdsResponseDto.from_dict(asset_ids_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)
|
||||
|
||||
|
||||
16
generated/immich/openapi_client/docs/AssetJobName.md
Normal file
16
generated/immich/openapi_client/docs/AssetJobName.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# AssetJobName
|
||||
|
||||
|
||||
## Enum
|
||||
|
||||
* `REFRESH_MINUS_FACES` (value: `'refresh-faces'`)
|
||||
|
||||
* `REFRESH_MINUS_METADATA` (value: `'refresh-metadata'`)
|
||||
|
||||
* `REGENERATE_MINUS_THUMBNAIL` (value: `'regenerate-thumbnail'`)
|
||||
|
||||
* `TRANSCODE_MINUS_VIDEO` (value: `'transcode-video'`)
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
30
generated/immich/openapi_client/docs/AssetJobsDto.md
Normal file
30
generated/immich/openapi_client/docs/AssetJobsDto.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# AssetJobsDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**asset_ids** | **List[str]** | |
|
||||
**name** | [**AssetJobName**](AssetJobName.md) | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.asset_jobs_dto import AssetJobsDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AssetJobsDto from a JSON string
|
||||
asset_jobs_dto_instance = AssetJobsDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AssetJobsDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
asset_jobs_dto_dict = asset_jobs_dto_instance.to_dict()
|
||||
# create an instance of AssetJobsDto from a dict
|
||||
asset_jobs_dto_from_dict = AssetJobsDto.from_dict(asset_jobs_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
# AssetMediaResponseDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | |
|
||||
**status** | [**AssetMediaStatus**](AssetMediaStatus.md) | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.asset_media_response_dto import AssetMediaResponseDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AssetMediaResponseDto from a JSON string
|
||||
asset_media_response_dto_instance = AssetMediaResponseDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AssetMediaResponseDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
asset_media_response_dto_dict = asset_media_response_dto_instance.to_dict()
|
||||
# create an instance of AssetMediaResponseDto from a dict
|
||||
asset_media_response_dto_from_dict = AssetMediaResponseDto.from_dict(asset_media_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)
|
||||
|
||||
|
||||
14
generated/immich/openapi_client/docs/AssetMediaSize.md
Normal file
14
generated/immich/openapi_client/docs/AssetMediaSize.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# AssetMediaSize
|
||||
|
||||
|
||||
## Enum
|
||||
|
||||
* `FULLSIZE` (value: `'fullsize'`)
|
||||
|
||||
* `PREVIEW` (value: `'preview'`)
|
||||
|
||||
* `THUMBNAIL` (value: `'thumbnail'`)
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
14
generated/immich/openapi_client/docs/AssetMediaStatus.md
Normal file
14
generated/immich/openapi_client/docs/AssetMediaStatus.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# AssetMediaStatus
|
||||
|
||||
|
||||
## 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)
|
||||
|
||||
|
||||
12
generated/immich/openapi_client/docs/AssetOrder.md
Normal file
12
generated/immich/openapi_client/docs/AssetOrder.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# AssetOrder
|
||||
|
||||
|
||||
## Enum
|
||||
|
||||
* `ASC` (value: `'asc'`)
|
||||
|
||||
* `DESC` (value: `'desc'`)
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
58
generated/immich/openapi_client/docs/AssetResponseDto.md
Normal file
58
generated/immich/openapi_client/docs/AssetResponseDto.md
Normal file
@@ -0,0 +1,58 @@
|
||||
# AssetResponseDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**checksum** | **str** | base64 encoded sha1 hash |
|
||||
**device_asset_id** | **str** | |
|
||||
**device_id** | **str** | |
|
||||
**duplicate_id** | **str** | | [optional]
|
||||
**duration** | **str** | |
|
||||
**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** | |
|
||||
**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]
|
||||
**stack** | [**AssetStackResponseDto**](AssetStackResponseDto.md) | | [optional]
|
||||
**tags** | [**List[TagResponseDto]**](TagResponseDto.md) | | [optional]
|
||||
**thumbhash** | **str** | |
|
||||
**type** | [**AssetTypeEnum**](AssetTypeEnum.md) | |
|
||||
**unassigned_faces** | [**List[AssetFaceWithoutPersonResponseDto]**](AssetFaceWithoutPersonResponseDto.md) | | [optional]
|
||||
**updated_at** | **datetime** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.asset_response_dto import AssetResponseDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AssetResponseDto from a JSON string
|
||||
asset_response_dto_instance = AssetResponseDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AssetResponseDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
asset_response_dto_dict = asset_response_dto_instance.to_dict()
|
||||
# create an instance of AssetResponseDto from a dict
|
||||
asset_response_dto_from_dict = AssetResponseDto.from_dict(asset_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
# AssetStackResponseDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**asset_count** | **int** | |
|
||||
**id** | **str** | |
|
||||
**primary_asset_id** | **str** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.asset_stack_response_dto import AssetStackResponseDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AssetStackResponseDto from a JSON string
|
||||
asset_stack_response_dto_instance = AssetStackResponseDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AssetStackResponseDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
asset_stack_response_dto_dict = asset_stack_response_dto_instance.to_dict()
|
||||
# create an instance of AssetStackResponseDto from a dict
|
||||
asset_stack_response_dto_from_dict = AssetStackResponseDto.from_dict(asset_stack_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
# AssetStatsResponseDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**images** | **int** | |
|
||||
**total** | **int** | |
|
||||
**videos** | **int** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.asset_stats_response_dto import AssetStatsResponseDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AssetStatsResponseDto from a JSON string
|
||||
asset_stats_response_dto_instance = AssetStatsResponseDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AssetStatsResponseDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
asset_stats_response_dto_dict = asset_stats_response_dto_instance.to_dict()
|
||||
# create an instance of AssetStatsResponseDto from a dict
|
||||
asset_stats_response_dto_from_dict = AssetStatsResponseDto.from_dict(asset_stats_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)
|
||||
|
||||
|
||||
16
generated/immich/openapi_client/docs/AssetTypeEnum.md
Normal file
16
generated/immich/openapi_client/docs/AssetTypeEnum.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# AssetTypeEnum
|
||||
|
||||
|
||||
## Enum
|
||||
|
||||
* `IMAGE` (value: `'IMAGE'`)
|
||||
|
||||
* `VIDEO` (value: `'VIDEO'`)
|
||||
|
||||
* `AUDIO` (value: `'AUDIO'`)
|
||||
|
||||
* `OTHER` (value: `'OTHER'`)
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
1488
generated/immich/openapi_client/docs/AssetsApi.md
Normal file
1488
generated/immich/openapi_client/docs/AssetsApi.md
Normal file
File diff suppressed because it is too large
Load Diff
16
generated/immich/openapi_client/docs/AudioCodec.md
Normal file
16
generated/immich/openapi_client/docs/AudioCodec.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# AudioCodec
|
||||
|
||||
|
||||
## Enum
|
||||
|
||||
* `MP3` (value: `'mp3'`)
|
||||
|
||||
* `AAC` (value: `'aac'`)
|
||||
|
||||
* `LIBOPUS` (value: `'libopus'`)
|
||||
|
||||
* `PCM_S16LE` (value: `'pcm_s16le'`)
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
395
generated/immich/openapi_client/docs/AuthenticationApi.md
Normal file
395
generated/immich/openapi_client/docs/AuthenticationApi.md
Normal file
@@ -0,0 +1,395 @@
|
||||
# generated.immich.openapi_client.AuthenticationApi
|
||||
|
||||
All URIs are relative to *https://github.com/api*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**change_password**](AuthenticationApi.md#change_password) | **POST** /auth/change-password |
|
||||
[**login**](AuthenticationApi.md#login) | **POST** /auth/login |
|
||||
[**logout**](AuthenticationApi.md#logout) | **POST** /auth/logout |
|
||||
[**sign_up_admin**](AuthenticationApi.md#sign_up_admin) | **POST** /auth/admin-sign-up |
|
||||
[**validate_access_token**](AuthenticationApi.md#validate_access_token) | **POST** /auth/validateToken |
|
||||
|
||||
|
||||
# **change_password**
|
||||
> UserAdminResponseDto change_password(change_password_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.change_password_dto import ChangePasswordDto
|
||||
from generated.immich.openapi_client.models.user_admin_response_dto import UserAdminResponseDto
|
||||
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.AuthenticationApi(api_client)
|
||||
change_password_dto = generated.immich.openapi_client.ChangePasswordDto() # ChangePasswordDto |
|
||||
|
||||
try:
|
||||
api_response = api_instance.change_password(change_password_dto)
|
||||
print("The response of AuthenticationApi->change_password:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling AuthenticationApi->change_password: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**change_password_dto** | [**ChangePasswordDto**](ChangePasswordDto.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**UserAdminResponseDto**](UserAdminResponseDto.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)
|
||||
|
||||
# **login**
|
||||
> LoginResponseDto login(login_credential_dto)
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import generated.immich.openapi_client
|
||||
from generated.immich.openapi_client.models.login_credential_dto import LoginCredentialDto
|
||||
from generated.immich.openapi_client.models.login_response_dto import LoginResponseDto
|
||||
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"
|
||||
)
|
||||
|
||||
|
||||
# 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.AuthenticationApi(api_client)
|
||||
login_credential_dto = generated.immich.openapi_client.LoginCredentialDto() # LoginCredentialDto |
|
||||
|
||||
try:
|
||||
api_response = api_instance.login(login_credential_dto)
|
||||
print("The response of AuthenticationApi->login:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling AuthenticationApi->login: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**login_credential_dto** | [**LoginCredentialDto**](LoginCredentialDto.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**LoginResponseDto**](LoginResponseDto.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### 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)
|
||||
|
||||
# **logout**
|
||||
> LogoutResponseDto logout()
|
||||
|
||||
### 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.logout_response_dto import LogoutResponseDto
|
||||
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.AuthenticationApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.logout()
|
||||
print("The response of AuthenticationApi->logout:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling AuthenticationApi->logout: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**LogoutResponseDto**](LogoutResponseDto.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)
|
||||
|
||||
# **sign_up_admin**
|
||||
> UserAdminResponseDto sign_up_admin(sign_up_dto)
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import generated.immich.openapi_client
|
||||
from generated.immich.openapi_client.models.sign_up_dto import SignUpDto
|
||||
from generated.immich.openapi_client.models.user_admin_response_dto import UserAdminResponseDto
|
||||
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"
|
||||
)
|
||||
|
||||
|
||||
# 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.AuthenticationApi(api_client)
|
||||
sign_up_dto = generated.immich.openapi_client.SignUpDto() # SignUpDto |
|
||||
|
||||
try:
|
||||
api_response = api_instance.sign_up_admin(sign_up_dto)
|
||||
print("The response of AuthenticationApi->sign_up_admin:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling AuthenticationApi->sign_up_admin: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**sign_up_dto** | [**SignUpDto**](SignUpDto.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**UserAdminResponseDto**](UserAdminResponseDto.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### 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)
|
||||
|
||||
# **validate_access_token**
|
||||
> ValidateAccessTokenResponseDto validate_access_token()
|
||||
|
||||
### 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.validate_access_token_response_dto import ValidateAccessTokenResponseDto
|
||||
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.AuthenticationApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.validate_access_token()
|
||||
print("The response of AuthenticationApi->validate_access_token:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling AuthenticationApi->validate_access_token: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**ValidateAccessTokenResponseDto**](ValidateAccessTokenResponseDto.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)
|
||||
|
||||
29
generated/immich/openapi_client/docs/AvatarResponse.md
Normal file
29
generated/immich/openapi_client/docs/AvatarResponse.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# 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)
|
||||
|
||||
|
||||
29
generated/immich/openapi_client/docs/AvatarUpdate.md
Normal file
29
generated/immich/openapi_client/docs/AvatarUpdate.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# AvatarUpdate
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**color** | [**UserAvatarColor**](UserAvatarColor.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.avatar_update import AvatarUpdate
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AvatarUpdate from a JSON string
|
||||
avatar_update_instance = AvatarUpdate.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AvatarUpdate.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
avatar_update_dict = avatar_update_instance.to_dict()
|
||||
# create an instance of AvatarUpdate from a dict
|
||||
avatar_update_from_dict = AvatarUpdate.from_dict(avatar_update_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)
|
||||
|
||||
|
||||
31
generated/immich/openapi_client/docs/BulkIdResponseDto.md
Normal file
31
generated/immich/openapi_client/docs/BulkIdResponseDto.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# BulkIdResponseDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**error** | **str** | | [optional]
|
||||
**id** | **str** | |
|
||||
**success** | **bool** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.bulk_id_response_dto import BulkIdResponseDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of BulkIdResponseDto from a JSON string
|
||||
bulk_id_response_dto_instance = BulkIdResponseDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(BulkIdResponseDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
bulk_id_response_dto_dict = bulk_id_response_dto_instance.to_dict()
|
||||
# create an instance of BulkIdResponseDto from a dict
|
||||
bulk_id_response_dto_from_dict = BulkIdResponseDto.from_dict(bulk_id_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)
|
||||
|
||||
|
||||
29
generated/immich/openapi_client/docs/BulkIdsDto.md
Normal file
29
generated/immich/openapi_client/docs/BulkIdsDto.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# BulkIdsDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ids** | **List[str]** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.bulk_ids_dto import BulkIdsDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of BulkIdsDto from a JSON string
|
||||
bulk_ids_dto_instance = BulkIdsDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(BulkIdsDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
bulk_ids_dto_dict = bulk_ids_dto_instance.to_dict()
|
||||
# create an instance of BulkIdsDto from a dict
|
||||
bulk_ids_dto_from_dict = BulkIdsDto.from_dict(bulk_ids_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)
|
||||
|
||||
|
||||
30
generated/immich/openapi_client/docs/CLIPConfig.md
Normal file
30
generated/immich/openapi_client/docs/CLIPConfig.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# CLIPConfig
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**enabled** | **bool** | |
|
||||
**model_name** | **str** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.clip_config import CLIPConfig
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of CLIPConfig from a JSON string
|
||||
clip_config_instance = CLIPConfig.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(CLIPConfig.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
clip_config_dict = clip_config_instance.to_dict()
|
||||
# create an instance of CLIPConfig from a dict
|
||||
clip_config_from_dict = CLIPConfig.from_dict(clip_config_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)
|
||||
|
||||
|
||||
14
generated/immich/openapi_client/docs/CQMode.md
Normal file
14
generated/immich/openapi_client/docs/CQMode.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# CQMode
|
||||
|
||||
|
||||
## Enum
|
||||
|
||||
* `AUTO` (value: `'auto'`)
|
||||
|
||||
* `CQP` (value: `'cqp'`)
|
||||
|
||||
* `ICQ` (value: `'icq'`)
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
30
generated/immich/openapi_client/docs/ChangePasswordDto.md
Normal file
30
generated/immich/openapi_client/docs/ChangePasswordDto.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# ChangePasswordDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**new_password** | **str** | |
|
||||
**password** | **str** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.change_password_dto import ChangePasswordDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ChangePasswordDto from a JSON string
|
||||
change_password_dto_instance = ChangePasswordDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(ChangePasswordDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
change_password_dto_dict = change_password_dto_instance.to_dict()
|
||||
# create an instance of ChangePasswordDto from a dict
|
||||
change_password_dto_from_dict = ChangePasswordDto.from_dict(change_password_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
# 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)
|
||||
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
# 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)
|
||||
|
||||
|
||||
12
generated/immich/openapi_client/docs/Colorspace.md
Normal file
12
generated/immich/openapi_client/docs/Colorspace.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# Colorspace
|
||||
|
||||
|
||||
## Enum
|
||||
|
||||
* `SRGB` (value: `'srgb'`)
|
||||
|
||||
* `P3` (value: `'p3'`)
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
32
generated/immich/openapi_client/docs/CreateAlbumDto.md
Normal file
32
generated/immich/openapi_client/docs/CreateAlbumDto.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# CreateAlbumDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**album_name** | **str** | |
|
||||
**album_users** | [**List[AlbumUserCreateDto]**](AlbumUserCreateDto.md) | | [optional]
|
||||
**asset_ids** | **List[str]** | | [optional]
|
||||
**description** | **str** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.create_album_dto import CreateAlbumDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of CreateAlbumDto from a JSON string
|
||||
create_album_dto_instance = CreateAlbumDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(CreateAlbumDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
create_album_dto_dict = create_album_dto_instance.to_dict()
|
||||
# create an instance of CreateAlbumDto from a dict
|
||||
create_album_dto_from_dict = CreateAlbumDto.from_dict(create_album_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)
|
||||
|
||||
|
||||
32
generated/immich/openapi_client/docs/CreateLibraryDto.md
Normal file
32
generated/immich/openapi_client/docs/CreateLibraryDto.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# CreateLibraryDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**exclusion_patterns** | **List[str]** | | [optional]
|
||||
**import_paths** | **List[str]** | | [optional]
|
||||
**name** | **str** | | [optional]
|
||||
**owner_id** | **str** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.create_library_dto import CreateLibraryDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of CreateLibraryDto from a JSON string
|
||||
create_library_dto_instance = CreateLibraryDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(CreateLibraryDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
create_library_dto_dict = create_library_dto_instance.to_dict()
|
||||
# create an instance of CreateLibraryDto from a dict
|
||||
create_library_dto_from_dict = CreateLibraryDto.from_dict(create_library_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
# CreateProfileImageResponseDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**profile_changed_at** | **datetime** | |
|
||||
**profile_image_path** | **str** | |
|
||||
**user_id** | **str** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.create_profile_image_response_dto import CreateProfileImageResponseDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of CreateProfileImageResponseDto from a JSON string
|
||||
create_profile_image_response_dto_instance = CreateProfileImageResponseDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(CreateProfileImageResponseDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
create_profile_image_response_dto_dict = create_profile_image_response_dto_instance.to_dict()
|
||||
# create an instance of CreateProfileImageResponseDto from a dict
|
||||
create_profile_image_response_dto_from_dict = CreateProfileImageResponseDto.from_dict(create_profile_image_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)
|
||||
|
||||
|
||||
31
generated/immich/openapi_client/docs/DatabaseBackupConfig.md
Normal file
31
generated/immich/openapi_client/docs/DatabaseBackupConfig.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# DatabaseBackupConfig
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**cron_expression** | **str** | |
|
||||
**enabled** | **bool** | |
|
||||
**keep_last_amount** | **float** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.database_backup_config import DatabaseBackupConfig
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of DatabaseBackupConfig from a JSON string
|
||||
database_backup_config_instance = DatabaseBackupConfig.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(DatabaseBackupConfig.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
database_backup_config_dict = database_backup_config_instance.to_dict()
|
||||
# create an instance of DatabaseBackupConfig from a dict
|
||||
database_backup_config_from_dict = DatabaseBackupConfig.from_dict(database_backup_config_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)
|
||||
|
||||
|
||||
98
generated/immich/openapi_client/docs/DeprecatedApi.md
Normal file
98
generated/immich/openapi_client/docs/DeprecatedApi.md
Normal file
@@ -0,0 +1,98 @@
|
||||
# generated.immich.openapi_client.DeprecatedApi
|
||||
|
||||
All URIs are relative to *https://github.com/api*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_random**](DeprecatedApi.md#get_random) | **GET** /assets/random |
|
||||
|
||||
|
||||
# **get_random**
|
||||
> List[AssetResponseDto] get_random(count=count)
|
||||
|
||||
This property was deprecated in v1.116.0
|
||||
|
||||
### 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.asset_response_dto import AssetResponseDto
|
||||
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.DeprecatedApi(api_client)
|
||||
count = 3.4 # float | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_random(count=count)
|
||||
print("The response of DeprecatedApi->get_random:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling DeprecatedApi->get_random: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**count** | **float**| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**List[AssetResponseDto]**](AssetResponseDto.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### 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)
|
||||
|
||||
189
generated/immich/openapi_client/docs/DownloadApi.md
Normal file
189
generated/immich/openapi_client/docs/DownloadApi.md
Normal file
@@ -0,0 +1,189 @@
|
||||
# generated.immich.openapi_client.DownloadApi
|
||||
|
||||
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**
|
||||
> bytearray download_archive(asset_ids_dto, key=key)
|
||||
|
||||
### 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.asset_ids_dto import AssetIdsDto
|
||||
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.DownloadApi(api_client)
|
||||
asset_ids_dto = generated.immich.openapi_client.AssetIdsDto() # AssetIdsDto |
|
||||
key = 'key_example' # str | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.download_archive(asset_ids_dto, key=key)
|
||||
print("The response of DownloadApi->download_archive:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling DownloadApi->download_archive: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**asset_ids_dto** | [**AssetIdsDto**](AssetIdsDto.md)| |
|
||||
**key** | **str**| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
**bytearray**
|
||||
|
||||
### Authorization
|
||||
|
||||
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/octet-stream
|
||||
|
||||
### 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_download_info**
|
||||
> DownloadResponseDto get_download_info(download_info_dto, key=key)
|
||||
|
||||
### 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.download_info_dto import DownloadInfoDto
|
||||
from generated.immich.openapi_client.models.download_response_dto import DownloadResponseDto
|
||||
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.DownloadApi(api_client)
|
||||
download_info_dto = generated.immich.openapi_client.DownloadInfoDto() # DownloadInfoDto |
|
||||
key = 'key_example' # str | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_download_info(download_info_dto, key=key)
|
||||
print("The response of DownloadApi->get_download_info:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling DownloadApi->get_download_info: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**download_info_dto** | [**DownloadInfoDto**](DownloadInfoDto.md)| |
|
||||
**key** | **str**| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**DownloadResponseDto**](DownloadResponseDto.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)
|
||||
|
||||
30
generated/immich/openapi_client/docs/DownloadArchiveInfo.md
Normal file
30
generated/immich/openapi_client/docs/DownloadArchiveInfo.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# DownloadArchiveInfo
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**asset_ids** | **List[str]** | |
|
||||
**size** | **int** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.download_archive_info import DownloadArchiveInfo
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of DownloadArchiveInfo from a JSON string
|
||||
download_archive_info_instance = DownloadArchiveInfo.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(DownloadArchiveInfo.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
download_archive_info_dict = download_archive_info_instance.to_dict()
|
||||
# create an instance of DownloadArchiveInfo from a dict
|
||||
download_archive_info_from_dict = DownloadArchiveInfo.from_dict(download_archive_info_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)
|
||||
|
||||
|
||||
32
generated/immich/openapi_client/docs/DownloadInfoDto.md
Normal file
32
generated/immich/openapi_client/docs/DownloadInfoDto.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# DownloadInfoDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**album_id** | **str** | | [optional]
|
||||
**archive_size** | **int** | | [optional]
|
||||
**asset_ids** | **List[str]** | | [optional]
|
||||
**user_id** | **str** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.download_info_dto import DownloadInfoDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of DownloadInfoDto from a JSON string
|
||||
download_info_dto_instance = DownloadInfoDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(DownloadInfoDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
download_info_dto_dict = download_info_dto_instance.to_dict()
|
||||
# create an instance of DownloadInfoDto from a dict
|
||||
download_info_dto_from_dict = DownloadInfoDto.from_dict(download_info_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)
|
||||
|
||||
|
||||
30
generated/immich/openapi_client/docs/DownloadResponse.md
Normal file
30
generated/immich/openapi_client/docs/DownloadResponse.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# DownloadResponse
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**archive_size** | **int** | |
|
||||
**include_embedded_videos** | **bool** | | [default to False]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.download_response import DownloadResponse
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of DownloadResponse from a JSON string
|
||||
download_response_instance = DownloadResponse.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(DownloadResponse.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
download_response_dict = download_response_instance.to_dict()
|
||||
# create an instance of DownloadResponse from a dict
|
||||
download_response_from_dict = DownloadResponse.from_dict(download_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)
|
||||
|
||||
|
||||
30
generated/immich/openapi_client/docs/DownloadResponseDto.md
Normal file
30
generated/immich/openapi_client/docs/DownloadResponseDto.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# DownloadResponseDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**archives** | [**List[DownloadArchiveInfo]**](DownloadArchiveInfo.md) | |
|
||||
**total_size** | **int** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.download_response_dto import DownloadResponseDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of DownloadResponseDto from a JSON string
|
||||
download_response_dto_instance = DownloadResponseDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(DownloadResponseDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
download_response_dto_dict = download_response_dto_instance.to_dict()
|
||||
# create an instance of DownloadResponseDto from a dict
|
||||
download_response_dto_from_dict = DownloadResponseDto.from_dict(download_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)
|
||||
|
||||
|
||||
30
generated/immich/openapi_client/docs/DownloadUpdate.md
Normal file
30
generated/immich/openapi_client/docs/DownloadUpdate.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# DownloadUpdate
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**archive_size** | **int** | | [optional]
|
||||
**include_embedded_videos** | **bool** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.download_update import DownloadUpdate
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of DownloadUpdate from a JSON string
|
||||
download_update_instance = DownloadUpdate.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(DownloadUpdate.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
download_update_dict = download_update_instance.to_dict()
|
||||
# create an instance of DownloadUpdate from a dict
|
||||
download_update_from_dict = DownloadUpdate.from_dict(download_update_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
# DuplicateDetectionConfig
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**enabled** | **bool** | |
|
||||
**max_distance** | **float** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.duplicate_detection_config import DuplicateDetectionConfig
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of DuplicateDetectionConfig from a JSON string
|
||||
duplicate_detection_config_instance = DuplicateDetectionConfig.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(DuplicateDetectionConfig.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
duplicate_detection_config_dict = duplicate_detection_config_instance.to_dict()
|
||||
# create an instance of DuplicateDetectionConfig from a dict
|
||||
duplicate_detection_config_from_dict = DuplicateDetectionConfig.from_dict(duplicate_detection_config_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)
|
||||
|
||||
|
||||
30
generated/immich/openapi_client/docs/DuplicateResponseDto.md
Normal file
30
generated/immich/openapi_client/docs/DuplicateResponseDto.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# DuplicateResponseDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**assets** | [**List[AssetResponseDto]**](AssetResponseDto.md) | |
|
||||
**duplicate_id** | **str** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.duplicate_response_dto import DuplicateResponseDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of DuplicateResponseDto from a JSON string
|
||||
duplicate_response_dto_instance = DuplicateResponseDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(DuplicateResponseDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
duplicate_response_dto_dict = duplicate_response_dto_instance.to_dict()
|
||||
# create an instance of DuplicateResponseDto from a dict
|
||||
duplicate_response_dto_from_dict = DuplicateResponseDto.from_dict(duplicate_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)
|
||||
|
||||
|
||||
92
generated/immich/openapi_client/docs/DuplicatesApi.md
Normal file
92
generated/immich/openapi_client/docs/DuplicatesApi.md
Normal file
@@ -0,0 +1,92 @@
|
||||
# generated.immich.openapi_client.DuplicatesApi
|
||||
|
||||
All URIs are relative to *https://github.com/api*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_asset_duplicates**](DuplicatesApi.md#get_asset_duplicates) | **GET** /duplicates |
|
||||
|
||||
|
||||
# **get_asset_duplicates**
|
||||
> List[DuplicateResponseDto] get_asset_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.duplicate_response_dto import DuplicateResponseDto
|
||||
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)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_asset_duplicates()
|
||||
print("The response of DuplicatesApi->get_asset_duplicates:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling DuplicatesApi->get_asset_duplicates: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**List[DuplicateResponseDto]**](DuplicateResponseDto.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)
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
# EmailNotificationsResponse
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**album_invite** | **bool** | |
|
||||
**album_update** | **bool** | |
|
||||
**enabled** | **bool** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.email_notifications_response import EmailNotificationsResponse
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of EmailNotificationsResponse from a JSON string
|
||||
email_notifications_response_instance = EmailNotificationsResponse.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(EmailNotificationsResponse.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
email_notifications_response_dict = email_notifications_response_instance.to_dict()
|
||||
# create an instance of EmailNotificationsResponse from a dict
|
||||
email_notifications_response_from_dict = EmailNotificationsResponse.from_dict(email_notifications_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
# EmailNotificationsUpdate
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**album_invite** | **bool** | | [optional]
|
||||
**album_update** | **bool** | | [optional]
|
||||
**enabled** | **bool** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.email_notifications_update import EmailNotificationsUpdate
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of EmailNotificationsUpdate from a JSON string
|
||||
email_notifications_update_instance = EmailNotificationsUpdate.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(EmailNotificationsUpdate.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
email_notifications_update_dict = email_notifications_update_instance.to_dict()
|
||||
# create an instance of EmailNotificationsUpdate from a dict
|
||||
email_notifications_update_from_dict = EmailNotificationsUpdate.from_dict(email_notifications_update_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)
|
||||
|
||||
|
||||
50
generated/immich/openapi_client/docs/ExifResponseDto.md
Normal file
50
generated/immich/openapi_client/docs/ExifResponseDto.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# ExifResponseDto
|
||||
|
||||
|
||||
## 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]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.exif_response_dto import ExifResponseDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ExifResponseDto from a JSON string
|
||||
exif_response_dto_instance = ExifResponseDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(ExifResponseDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
exif_response_dto_dict = exif_response_dto_instance.to_dict()
|
||||
# create an instance of ExifResponseDto from a dict
|
||||
exif_response_dto_from_dict = ExifResponseDto.from_dict(exif_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)
|
||||
|
||||
|
||||
29
generated/immich/openapi_client/docs/FaceDto.md
Normal file
29
generated/immich/openapi_client/docs/FaceDto.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# FaceDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.face_dto import FaceDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of FaceDto from a JSON string
|
||||
face_dto_instance = FaceDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(FaceDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
face_dto_dict = face_dto_instance.to_dict()
|
||||
# create an instance of FaceDto from a dict
|
||||
face_dto_from_dict = FaceDto.from_dict(face_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)
|
||||
|
||||
|
||||
361
generated/immich/openapi_client/docs/FacesApi.md
Normal file
361
generated/immich/openapi_client/docs/FacesApi.md
Normal file
@@ -0,0 +1,361 @@
|
||||
# generated.immich.openapi_client.FacesApi
|
||||
|
||||
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**
|
||||
> create_face(asset_face_create_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.asset_face_create_dto import AssetFaceCreateDto
|
||||
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.FacesApi(api_client)
|
||||
asset_face_create_dto = generated.immich.openapi_client.AssetFaceCreateDto() # AssetFaceCreateDto |
|
||||
|
||||
try:
|
||||
api_instance.create_face(asset_face_create_dto)
|
||||
except Exception as e:
|
||||
print("Exception when calling FacesApi->create_face: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**asset_face_create_dto** | [**AssetFaceCreateDto**](AssetFaceCreateDto.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)
|
||||
|
||||
# **delete_face**
|
||||
> delete_face(id, asset_face_delete_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.asset_face_delete_dto import AssetFaceDeleteDto
|
||||
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.FacesApi(api_client)
|
||||
id = 'id_example' # str |
|
||||
asset_face_delete_dto = generated.immich.openapi_client.AssetFaceDeleteDto() # AssetFaceDeleteDto |
|
||||
|
||||
try:
|
||||
api_instance.delete_face(id, asset_face_delete_dto)
|
||||
except Exception as e:
|
||||
print("Exception when calling FacesApi->delete_face: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **str**| |
|
||||
**asset_face_delete_dto** | [**AssetFaceDeleteDto**](AssetFaceDeleteDto.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 |
|
||||
|-------------|-------------|------------------|
|
||||
**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_faces**
|
||||
> List[AssetFaceResponseDto] get_faces(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.asset_face_response_dto import AssetFaceResponseDto
|
||||
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.FacesApi(api_client)
|
||||
id = 'id_example' # str |
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_faces(id)
|
||||
print("The response of FacesApi->get_faces:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling FacesApi->get_faces: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **str**| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**List[AssetFaceResponseDto]**](AssetFaceResponseDto.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)
|
||||
|
||||
# **reassign_faces_by_id**
|
||||
> PersonResponseDto reassign_faces_by_id(id, face_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.face_dto import FaceDto
|
||||
from generated.immich.openapi_client.models.person_response_dto import PersonResponseDto
|
||||
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.FacesApi(api_client)
|
||||
id = 'id_example' # str |
|
||||
face_dto = generated.immich.openapi_client.FaceDto() # FaceDto |
|
||||
|
||||
try:
|
||||
api_response = api_instance.reassign_faces_by_id(id, face_dto)
|
||||
print("The response of FacesApi->reassign_faces_by_id:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling FacesApi->reassign_faces_by_id: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **str**| |
|
||||
**face_dto** | [**FaceDto**](FaceDto.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**PersonResponseDto**](PersonResponseDto.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### 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)
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
# FacialRecognitionConfig
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**enabled** | **bool** | |
|
||||
**max_distance** | **float** | |
|
||||
**min_faces** | **int** | |
|
||||
**min_score** | **float** | |
|
||||
**model_name** | **str** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.facial_recognition_config import FacialRecognitionConfig
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of FacialRecognitionConfig from a JSON string
|
||||
facial_recognition_config_instance = FacialRecognitionConfig.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(FacialRecognitionConfig.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
facial_recognition_config_dict = facial_recognition_config_instance.to_dict()
|
||||
# create an instance of FacialRecognitionConfig from a dict
|
||||
facial_recognition_config_from_dict = FacialRecognitionConfig.from_dict(facial_recognition_config_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)
|
||||
|
||||
|
||||
29
generated/immich/openapi_client/docs/FileChecksumDto.md
Normal file
29
generated/immich/openapi_client/docs/FileChecksumDto.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# 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)
|
||||
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
# 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)
|
||||
|
||||
|
||||
30
generated/immich/openapi_client/docs/FileReportDto.md
Normal file
30
generated/immich/openapi_client/docs/FileReportDto.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# 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)
|
||||
|
||||
|
||||
29
generated/immich/openapi_client/docs/FileReportFixDto.md
Normal file
29
generated/immich/openapi_client/docs/FileReportFixDto.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# 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)
|
||||
|
||||
|
||||
33
generated/immich/openapi_client/docs/FileReportItemDto.md
Normal file
33
generated/immich/openapi_client/docs/FileReportItemDto.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# 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)
|
||||
|
||||
|
||||
267
generated/immich/openapi_client/docs/FileReportsApi.md
Normal file
267
generated/immich/openapi_client/docs/FileReportsApi.md
Normal file
@@ -0,0 +1,267 @@
|
||||
# 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)
|
||||
|
||||
30
generated/immich/openapi_client/docs/FoldersResponse.md
Normal file
30
generated/immich/openapi_client/docs/FoldersResponse.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# FoldersResponse
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**enabled** | **bool** | | [default to False]
|
||||
**sidebar_web** | **bool** | | [default to False]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.folders_response import FoldersResponse
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of FoldersResponse from a JSON string
|
||||
folders_response_instance = FoldersResponse.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(FoldersResponse.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
folders_response_dict = folders_response_instance.to_dict()
|
||||
# create an instance of FoldersResponse from a dict
|
||||
folders_response_from_dict = FoldersResponse.from_dict(folders_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)
|
||||
|
||||
|
||||
30
generated/immich/openapi_client/docs/FoldersUpdate.md
Normal file
30
generated/immich/openapi_client/docs/FoldersUpdate.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# FoldersUpdate
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**enabled** | **bool** | | [optional]
|
||||
**sidebar_web** | **bool** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.folders_update import FoldersUpdate
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of FoldersUpdate from a JSON string
|
||||
folders_update_instance = FoldersUpdate.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(FoldersUpdate.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
folders_update_dict = folders_update_instance.to_dict()
|
||||
# create an instance of FoldersUpdate from a dict
|
||||
folders_update_from_dict = FoldersUpdate.from_dict(folders_update_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)
|
||||
|
||||
|
||||
12
generated/immich/openapi_client/docs/ImageFormat.md
Normal file
12
generated/immich/openapi_client/docs/ImageFormat.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# ImageFormat
|
||||
|
||||
|
||||
## Enum
|
||||
|
||||
* `JPEG` (value: `'jpeg'`)
|
||||
|
||||
* `WEBP` (value: `'webp'`)
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
18
generated/immich/openapi_client/docs/JobCommand.md
Normal file
18
generated/immich/openapi_client/docs/JobCommand.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# 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)
|
||||
|
||||
|
||||
30
generated/immich/openapi_client/docs/JobCommandDto.md
Normal file
30
generated/immich/openapi_client/docs/JobCommandDto.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# 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)
|
||||
|
||||
|
||||
34
generated/immich/openapi_client/docs/JobCountsDto.md
Normal file
34
generated/immich/openapi_client/docs/JobCountsDto.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# 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)
|
||||
|
||||
|
||||
29
generated/immich/openapi_client/docs/JobCreateDto.md
Normal file
29
generated/immich/openapi_client/docs/JobCreateDto.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# JobCreateDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | [**ManualJobName**](ManualJobName.md) | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.job_create_dto import JobCreateDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of JobCreateDto from a JSON string
|
||||
job_create_dto_instance = JobCreateDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(JobCreateDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
job_create_dto_dict = job_create_dto_instance.to_dict()
|
||||
# create an instance of JobCreateDto from a dict
|
||||
job_create_dto_from_dict = JobCreateDto.from_dict(job_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)
|
||||
|
||||
|
||||
38
generated/immich/openapi_client/docs/JobName.md
Normal file
38
generated/immich/openapi_client/docs/JobName.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# JobName
|
||||
|
||||
|
||||
## Enum
|
||||
|
||||
* `THUMBNAILGENERATION` (value: `'thumbnailGeneration'`)
|
||||
|
||||
* `METADATAEXTRACTION` (value: `'metadataExtraction'`)
|
||||
|
||||
* `VIDEOCONVERSION` (value: `'videoConversion'`)
|
||||
|
||||
* `FACEDETECTION` (value: `'faceDetection'`)
|
||||
|
||||
* `FACIALRECOGNITION` (value: `'facialRecognition'`)
|
||||
|
||||
* `SMARTSEARCH` (value: `'smartSearch'`)
|
||||
|
||||
* `DUPLICATEDETECTION` (value: `'duplicateDetection'`)
|
||||
|
||||
* `BACKGROUNDTASK` (value: `'backgroundTask'`)
|
||||
|
||||
* `STORAGETEMPLATEMIGRATION` (value: `'storageTemplateMigration'`)
|
||||
|
||||
* `MIGRATION` (value: `'migration'`)
|
||||
|
||||
* `SEARCH` (value: `'search'`)
|
||||
|
||||
* `SIDECAR` (value: `'sidecar'`)
|
||||
|
||||
* `LIBRARY` (value: `'library'`)
|
||||
|
||||
* `NOTIFICATIONS` (value: `'notifications'`)
|
||||
|
||||
* `BACKUPDATABASE` (value: `'backupDatabase'`)
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
generated/immich/openapi_client/docs/JobSettingsDto.md
Normal file
29
generated/immich/openapi_client/docs/JobSettingsDto.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# JobSettingsDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**concurrency** | **int** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.job_settings_dto import JobSettingsDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of JobSettingsDto from a JSON string
|
||||
job_settings_dto_instance = JobSettingsDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(JobSettingsDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
job_settings_dto_dict = job_settings_dto_instance.to_dict()
|
||||
# create an instance of JobSettingsDto from a dict
|
||||
job_settings_dto_from_dict = JobSettingsDto.from_dict(job_settings_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)
|
||||
|
||||
|
||||
30
generated/immich/openapi_client/docs/JobStatusDto.md
Normal file
30
generated/immich/openapi_client/docs/JobStatusDto.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# 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)
|
||||
|
||||
|
||||
270
generated/immich/openapi_client/docs/JobsApi.md
Normal file
270
generated/immich/openapi_client/docs/JobsApi.md
Normal file
@@ -0,0 +1,270 @@
|
||||
# generated.immich.openapi_client.JobsApi
|
||||
|
||||
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**
|
||||
> create_job(job_create_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.job_create_dto import JobCreateDto
|
||||
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.JobsApi(api_client)
|
||||
job_create_dto = generated.immich.openapi_client.JobCreateDto() # JobCreateDto |
|
||||
|
||||
try:
|
||||
api_instance.create_job(job_create_dto)
|
||||
except Exception as e:
|
||||
print("Exception when calling JobsApi->create_job: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**job_create_dto** | [**JobCreateDto**](JobCreateDto.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_all_jobs_status**
|
||||
> AllJobStatusResponseDto get_all_jobs_status()
|
||||
|
||||
### 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.all_job_status_response_dto import AllJobStatusResponseDto
|
||||
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.JobsApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_all_jobs_status()
|
||||
print("The response of JobsApi->get_all_jobs_status:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling JobsApi->get_all_jobs_status: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**AllJobStatusResponseDto**](AllJobStatusResponseDto.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)
|
||||
|
||||
# **send_job_command**
|
||||
> JobStatusDto send_job_command(id, job_command_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.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.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.JobsApi(api_client)
|
||||
id = generated.immich.openapi_client.JobName() # JobName |
|
||||
job_command_dto = generated.immich.openapi_client.JobCommandDto() # JobCommandDto |
|
||||
|
||||
try:
|
||||
api_response = api_instance.send_job_command(id, job_command_dto)
|
||||
print("The response of JobsApi->send_job_command:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling JobsApi->send_job_command: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | [**JobName**](.md)| |
|
||||
**job_command_dto** | [**JobCommandDto**](JobCommandDto.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**JobStatusDto**](JobStatusDto.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)
|
||||
|
||||
709
generated/immich/openapi_client/docs/LibrariesApi.md
Normal file
709
generated/immich/openapi_client/docs/LibrariesApi.md
Normal file
@@ -0,0 +1,709 @@
|
||||
# generated.immich.openapi_client.LibrariesApi
|
||||
|
||||
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**
|
||||
> LibraryResponseDto create_library(create_library_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.create_library_dto import CreateLibraryDto
|
||||
from generated.immich.openapi_client.models.library_response_dto import LibraryResponseDto
|
||||
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.LibrariesApi(api_client)
|
||||
create_library_dto = generated.immich.openapi_client.CreateLibraryDto() # CreateLibraryDto |
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_library(create_library_dto)
|
||||
print("The response of LibrariesApi->create_library:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling LibrariesApi->create_library: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**create_library_dto** | [**CreateLibraryDto**](CreateLibraryDto.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**LibraryResponseDto**](LibraryResponseDto.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)
|
||||
|
||||
# **delete_library**
|
||||
> delete_library(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.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.LibrariesApi(api_client)
|
||||
id = 'id_example' # str |
|
||||
|
||||
try:
|
||||
api_instance.delete_library(id)
|
||||
except Exception as e:
|
||||
print("Exception when calling LibrariesApi->delete_library: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **str**| |
|
||||
|
||||
### 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)
|
||||
|
||||
# **get_all_libraries**
|
||||
> List[LibraryResponseDto] get_all_libraries()
|
||||
|
||||
### 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.library_response_dto import LibraryResponseDto
|
||||
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.LibrariesApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_all_libraries()
|
||||
print("The response of LibrariesApi->get_all_libraries:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling LibrariesApi->get_all_libraries: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**List[LibraryResponseDto]**](LibraryResponseDto.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_library**
|
||||
> LibraryResponseDto get_library(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.library_response_dto import LibraryResponseDto
|
||||
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.LibrariesApi(api_client)
|
||||
id = 'id_example' # str |
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_library(id)
|
||||
print("The response of LibrariesApi->get_library:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling LibrariesApi->get_library: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **str**| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**LibraryResponseDto**](LibraryResponseDto.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_library_statistics**
|
||||
> LibraryStatsResponseDto get_library_statistics(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.library_stats_response_dto import LibraryStatsResponseDto
|
||||
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.LibrariesApi(api_client)
|
||||
id = 'id_example' # str |
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_library_statistics(id)
|
||||
print("The response of LibrariesApi->get_library_statistics:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling LibrariesApi->get_library_statistics: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **str**| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**LibraryStatsResponseDto**](LibraryStatsResponseDto.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)
|
||||
|
||||
# **scan_library**
|
||||
> scan_library(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.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.LibrariesApi(api_client)
|
||||
id = 'id_example' # str |
|
||||
|
||||
try:
|
||||
api_instance.scan_library(id)
|
||||
except Exception as e:
|
||||
print("Exception when calling LibrariesApi->scan_library: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **str**| |
|
||||
|
||||
### 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)
|
||||
|
||||
# **update_library**
|
||||
> LibraryResponseDto update_library(id, update_library_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.library_response_dto import LibraryResponseDto
|
||||
from generated.immich.openapi_client.models.update_library_dto import UpdateLibraryDto
|
||||
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.LibrariesApi(api_client)
|
||||
id = 'id_example' # str |
|
||||
update_library_dto = generated.immich.openapi_client.UpdateLibraryDto() # UpdateLibraryDto |
|
||||
|
||||
try:
|
||||
api_response = api_instance.update_library(id, update_library_dto)
|
||||
print("The response of LibrariesApi->update_library:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling LibrariesApi->update_library: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **str**| |
|
||||
**update_library_dto** | [**UpdateLibraryDto**](UpdateLibraryDto.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**LibraryResponseDto**](LibraryResponseDto.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)
|
||||
|
||||
# **validate**
|
||||
> ValidateLibraryResponseDto validate(id, validate_library_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.validate_library_dto import ValidateLibraryDto
|
||||
from generated.immich.openapi_client.models.validate_library_response_dto import ValidateLibraryResponseDto
|
||||
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.LibrariesApi(api_client)
|
||||
id = 'id_example' # str |
|
||||
validate_library_dto = generated.immich.openapi_client.ValidateLibraryDto() # ValidateLibraryDto |
|
||||
|
||||
try:
|
||||
api_response = api_instance.validate(id, validate_library_dto)
|
||||
print("The response of LibrariesApi->validate:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling LibrariesApi->validate: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **str**| |
|
||||
**validate_library_dto** | [**ValidateLibraryDto**](ValidateLibraryDto.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ValidateLibraryResponseDto**](ValidateLibraryResponseDto.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)
|
||||
|
||||
37
generated/immich/openapi_client/docs/LibraryResponseDto.md
Normal file
37
generated/immich/openapi_client/docs/LibraryResponseDto.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# LibraryResponseDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
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** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.library_response_dto import LibraryResponseDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of LibraryResponseDto from a JSON string
|
||||
library_response_dto_instance = LibraryResponseDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(LibraryResponseDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
library_response_dto_dict = library_response_dto_instance.to_dict()
|
||||
# create an instance of LibraryResponseDto from a dict
|
||||
library_response_dto_from_dict = LibraryResponseDto.from_dict(library_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
# LibraryStatsResponseDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**photos** | **int** | | [default to 0]
|
||||
**total** | **int** | | [default to 0]
|
||||
**usage** | **int** | | [default to 0]
|
||||
**videos** | **int** | | [default to 0]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.library_stats_response_dto import LibraryStatsResponseDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of LibraryStatsResponseDto from a JSON string
|
||||
library_stats_response_dto_instance = LibraryStatsResponseDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(LibraryStatsResponseDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
library_stats_response_dto_dict = library_stats_response_dto_instance.to_dict()
|
||||
# create an instance of LibraryStatsResponseDto from a dict
|
||||
library_stats_response_dto_from_dict = LibraryStatsResponseDto.from_dict(library_stats_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)
|
||||
|
||||
|
||||
30
generated/immich/openapi_client/docs/LicenseKeyDto.md
Normal file
30
generated/immich/openapi_client/docs/LicenseKeyDto.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# LicenseKeyDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**activation_key** | **str** | |
|
||||
**license_key** | **str** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from generated.immich.openapi_client.models.license_key_dto import LicenseKeyDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of LicenseKeyDto from a JSON string
|
||||
license_key_dto_instance = LicenseKeyDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(LicenseKeyDto.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
license_key_dto_dict = license_key_dto_instance.to_dict()
|
||||
# create an instance of LicenseKeyDto from a dict
|
||||
license_key_dto_from_dict = LicenseKeyDto.from_dict(license_key_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)
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user