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

[CLEANUP] Cleaner API gen (less unneeded stuff)

Browse Source
This commit is contained in:
Bas Dado
2026-07-03 20:42:47 +02:00
parent d50345fc64
commit fe08201250
750 changed files with 15316 additions and 100454 deletions
Download Patch File Download Diff File Expand all files Collapse all files
generated/immich/openapi_client/api/__init__.py
-34
View File
@@ -1,41 +1,7 @@
# flake8: noqa
# import apis into api package
from generated.immich.openapi_client.api.api_keys_api import APIKeysApi
from generated.immich.openapi_client.api.activities_api import ActivitiesApi
from generated.immich.openapi_client.api.albums_api import AlbumsApi
from generated.immich.openapi_client.api.assets_api import AssetsApi
from generated.immich.openapi_client.api.authentication_api import AuthenticationApi
from generated.immich.openapi_client.api.authentication_admin_api import AuthenticationAdminApi
from generated.immich.openapi_client.api.database_backups_admin_api import DatabaseBackupsAdminApi
from generated.immich.openapi_client.api.deprecated_api import DeprecatedApi
from generated.immich.openapi_client.api.download_api import DownloadApi
from generated.immich.openapi_client.api.duplicates_api import DuplicatesApi
from generated.immich.openapi_client.api.faces_api import FacesApi
from generated.immich.openapi_client.api.jobs_api import JobsApi
from generated.immich.openapi_client.api.libraries_api import LibrariesApi
from generated.immich.openapi_client.api.maintenance_admin_api import MaintenanceAdminApi
from generated.immich.openapi_client.api.map_api import MapApi
from generated.immich.openapi_client.api.memories_api import MemoriesApi
from generated.immich.openapi_client.api.notifications_api import NotificationsApi
from generated.immich.openapi_client.api.notifications_admin_api import NotificationsAdminApi
from generated.immich.openapi_client.api.partners_api import PartnersApi
from generated.immich.openapi_client.api.people_api import PeopleApi
from generated.immich.openapi_client.api.plugins_api import PluginsApi
from generated.immich.openapi_client.api.queues_api import QueuesApi
from generated.immich.openapi_client.api.search_api import SearchApi
from generated.immich.openapi_client.api.server_api import ServerApi
from generated.immich.openapi_client.api.sessions_api import SessionsApi
from generated.immich.openapi_client.api.shared_links_api import SharedLinksApi
from generated.immich.openapi_client.api.stacks_api import StacksApi
from generated.immich.openapi_client.api.sync_api import SyncApi
from generated.immich.openapi_client.api.system_config_api import SystemConfigApi
from generated.immich.openapi_client.api.system_metadata_api import SystemMetadataApi
from generated.immich.openapi_client.api.tags_api import TagsApi
from generated.immich.openapi_client.api.timeline_api import TimelineApi
from generated.immich.openapi_client.api.trash_api import TrashApi
from generated.immich.openapi_client.api.users_api import UsersApi
from generated.immich.openapi_client.api.users_admin_api import UsersAdminApi
from generated.immich.openapi_client.api.views_api import ViewsApi
from generated.immich.openapi_client.api.workflows_api import WorkflowsApi
generated/immich/openapi_client/api/activities_api.py
-1191
View File
File diff suppressed because it is too large Load Diff
generated/immich/openapi_client/api/albums_api.py
+67 -68
View File
@@ -16,10 +16,9 @@ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
from typing import Any, Dict, List, Optional, Tuple, Union
from typing_extensions import Annotated
from pydantic import Field, StrictBool, StrictStr
from pydantic import Field, StrictBool, StrictStr, field_validator
from typing import List, Optional
from typing_extensions import Annotated
from uuid import UUID
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.models.album_statistics_response_dto import AlbumStatisticsResponseDto
@@ -53,7 +52,7 @@ class AlbumsApi:
@validate_call
def add_assets_to_album(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
bulk_ids_dto: BulkIdsDto,
_request_timeout: Union[
None,
@@ -73,7 +72,7 @@ class AlbumsApi:
Add multiple assets to a specific album by its ID.
:param id: (required)
:type id: UUID
:type id: str
:param bulk_ids_dto: (required)
:type bulk_ids_dto: BulkIdsDto
:param _request_timeout: timeout setting for this request. If one
@@ -124,7 +123,7 @@ class AlbumsApi:
@validate_call
def add_assets_to_album_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
bulk_ids_dto: BulkIdsDto,
_request_timeout: Union[
None,
@@ -144,7 +143,7 @@ class AlbumsApi:
Add multiple assets to a specific album by its ID.
:param id: (required)
:type id: UUID
:type id: str
:param bulk_ids_dto: (required)
:type bulk_ids_dto: BulkIdsDto
:param _request_timeout: timeout setting for this request. If one
@@ -195,7 +194,7 @@ class AlbumsApi:
@validate_call
def add_assets_to_album_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
bulk_ids_dto: BulkIdsDto,
_request_timeout: Union[
None,
@@ -215,7 +214,7 @@ class AlbumsApi:
Add multiple assets to a specific album by its ID.
:param id: (required)
:type id: UUID
:type id: str
:param bulk_ids_dto: (required)
:type bulk_ids_dto: BulkIdsDto
:param _request_timeout: timeout setting for this request. If one
@@ -620,7 +619,7 @@ class AlbumsApi:
@validate_call
def add_users_to_album(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
add_users_dto: AddUsersDto,
_request_timeout: Union[
None,
@@ -640,7 +639,7 @@ class AlbumsApi:
Share an album with multiple users. Each user can be given a specific role in the album.
:param id: (required)
:type id: UUID
:type id: str
:param add_users_dto: (required)
:type add_users_dto: AddUsersDto
:param _request_timeout: timeout setting for this request. If one
@@ -691,7 +690,7 @@ class AlbumsApi:
@validate_call
def add_users_to_album_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
add_users_dto: AddUsersDto,
_request_timeout: Union[
None,
@@ -711,7 +710,7 @@ class AlbumsApi:
Share an album with multiple users. Each user can be given a specific role in the album.
:param id: (required)
:type id: UUID
:type id: str
:param add_users_dto: (required)
:type add_users_dto: AddUsersDto
:param _request_timeout: timeout setting for this request. If one
@@ -762,7 +761,7 @@ class AlbumsApi:
@validate_call
def add_users_to_album_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
add_users_dto: AddUsersDto,
_request_timeout: Union[
None,
@@ -782,7 +781,7 @@ class AlbumsApi:
Share an album with multiple users. Each user can be given a specific role in the album.
:param id: (required)
:type id: UUID
:type id: str
:param add_users_dto: (required)
:type add_users_dto: AddUsersDto
:param _request_timeout: timeout setting for this request. If one
@@ -1187,7 +1186,7 @@ class AlbumsApi:
@validate_call
def delete_album(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -1206,7 +1205,7 @@ class AlbumsApi:
Delete a specific album by its ID. Note the album is initially trashed and then immediately scheduled for deletion, but relies on a background job to complete the process.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -1254,7 +1253,7 @@ class AlbumsApi:
@validate_call
def delete_album_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -1273,7 +1272,7 @@ class AlbumsApi:
Delete a specific album by its ID. Note the album is initially trashed and then immediately scheduled for deletion, but relies on a background job to complete the process.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -1321,7 +1320,7 @@ class AlbumsApi:
@validate_call
def delete_album_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -1340,7 +1339,7 @@ class AlbumsApi:
Delete a specific album by its ID. Note the album is initially trashed and then immediately scheduled for deletion, but relies on a background job to complete the process.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -1443,7 +1442,7 @@ class AlbumsApi:
@validate_call
def get_album_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -1464,7 +1463,7 @@ class AlbumsApi:
Retrieve information about a specific album by its ID.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -1518,7 +1517,7 @@ class AlbumsApi:
@validate_call
def get_album_info_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -1539,7 +1538,7 @@ class AlbumsApi:
Retrieve information about a specific album by its ID.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -1593,7 +1592,7 @@ class AlbumsApi:
@validate_call
def get_album_info_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -1614,7 +1613,7 @@ class AlbumsApi:
Retrieve information about a specific album by its ID.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -1740,7 +1739,7 @@ class AlbumsApi:
@validate_call
def get_album_map_markers(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -1761,7 +1760,7 @@ class AlbumsApi:
Retrieve map marker information for a specific album by its ID.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -1815,7 +1814,7 @@ class AlbumsApi:
@validate_call
def get_album_map_markers_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -1836,7 +1835,7 @@ class AlbumsApi:
Retrieve map marker information for a specific album by its ID.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -1890,7 +1889,7 @@ class AlbumsApi:
@validate_call
def get_album_map_markers_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -1911,7 +1910,7 @@ class AlbumsApi:
Retrieve map marker information for a specific album by its ID.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -2285,8 +2284,8 @@ class AlbumsApi:
@validate_call
def get_all_albums(
self,
asset_id: Annotated[Optional[UUID], Field(description="Filter albums containing this asset ID (ignores other parameters)")] = None,
id: Annotated[Optional[UUID], Field(description="Album ID")] = None,
asset_id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Filter albums containing this asset ID (ignores other parameters)")] = None,
id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Album ID")] = None,
is_owned: Annotated[Optional[StrictBool], Field(description="Filter by ownership: true = only owned, false = only shared-with-me, undefined = no filter")] = None,
is_shared: Annotated[Optional[StrictBool], Field(description="Filter by shared status: true = only shared, false = not shared, undefined = no filter")] = None,
name: Annotated[Optional[StrictStr], Field(description="Album name (exact match)")] = None,
@@ -2308,9 +2307,9 @@ class AlbumsApi:
Retrieve a list of albums available to the authenticated user.
:param asset_id: Filter albums containing this asset ID (ignores other parameters)
:type asset_id: UUID
:type asset_id: str
:param id: Album ID
:type id: UUID
:type id: str
:param is_owned: Filter by ownership: true = only owned, false = only shared-with-me, undefined = no filter
:type is_owned: bool
:param is_shared: Filter by shared status: true = only shared, false = not shared, undefined = no filter
@@ -2368,8 +2367,8 @@ class AlbumsApi:
@validate_call
def get_all_albums_with_http_info(
self,
asset_id: Annotated[Optional[UUID], Field(description="Filter albums containing this asset ID (ignores other parameters)")] = None,
id: Annotated[Optional[UUID], Field(description="Album ID")] = None,
asset_id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Filter albums containing this asset ID (ignores other parameters)")] = None,
id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Album ID")] = None,
is_owned: Annotated[Optional[StrictBool], Field(description="Filter by ownership: true = only owned, false = only shared-with-me, undefined = no filter")] = None,
is_shared: Annotated[Optional[StrictBool], Field(description="Filter by shared status: true = only shared, false = not shared, undefined = no filter")] = None,
name: Annotated[Optional[StrictStr], Field(description="Album name (exact match)")] = None,
@@ -2391,9 +2390,9 @@ class AlbumsApi:
Retrieve a list of albums available to the authenticated user.
:param asset_id: Filter albums containing this asset ID (ignores other parameters)
:type asset_id: UUID
:type asset_id: str
:param id: Album ID
:type id: UUID
:type id: str
:param is_owned: Filter by ownership: true = only owned, false = only shared-with-me, undefined = no filter
:type is_owned: bool
:param is_shared: Filter by shared status: true = only shared, false = not shared, undefined = no filter
@@ -2451,8 +2450,8 @@ class AlbumsApi:
@validate_call
def get_all_albums_without_preload_content(
self,
asset_id: Annotated[Optional[UUID], Field(description="Filter albums containing this asset ID (ignores other parameters)")] = None,
id: Annotated[Optional[UUID], Field(description="Album ID")] = None,
asset_id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Filter albums containing this asset ID (ignores other parameters)")] = None,
id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Album ID")] = None,
is_owned: Annotated[Optional[StrictBool], Field(description="Filter by ownership: true = only owned, false = only shared-with-me, undefined = no filter")] = None,
is_shared: Annotated[Optional[StrictBool], Field(description="Filter by shared status: true = only shared, false = not shared, undefined = no filter")] = None,
name: Annotated[Optional[StrictStr], Field(description="Album name (exact match)")] = None,
@@ -2474,9 +2473,9 @@ class AlbumsApi:
Retrieve a list of albums available to the authenticated user.
:param asset_id: Filter albums containing this asset ID (ignores other parameters)
:type asset_id: UUID
:type asset_id: str
:param id: Album ID
:type id: UUID
:type id: str
:param is_owned: Filter by ownership: true = only owned, false = only shared-with-me, undefined = no filter
:type is_owned: bool
:param is_shared: Filter by shared status: true = only shared, false = not shared, undefined = no filter
@@ -2618,7 +2617,7 @@ class AlbumsApi:
@validate_call
def remove_asset_from_album(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
bulk_ids_dto: BulkIdsDto,
_request_timeout: Union[
None,
@@ -2638,7 +2637,7 @@ class AlbumsApi:
Remove multiple assets from a specific album by its ID.
:param id: (required)
:type id: UUID
:type id: str
:param bulk_ids_dto: (required)
:type bulk_ids_dto: BulkIdsDto
:param _request_timeout: timeout setting for this request. If one
@@ -2689,7 +2688,7 @@ class AlbumsApi:
@validate_call
def remove_asset_from_album_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
bulk_ids_dto: BulkIdsDto,
_request_timeout: Union[
None,
@@ -2709,7 +2708,7 @@ class AlbumsApi:
Remove multiple assets from a specific album by its ID.
:param id: (required)
:type id: UUID
:type id: str
:param bulk_ids_dto: (required)
:type bulk_ids_dto: BulkIdsDto
:param _request_timeout: timeout setting for this request. If one
@@ -2760,7 +2759,7 @@ class AlbumsApi:
@validate_call
def remove_asset_from_album_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
bulk_ids_dto: BulkIdsDto,
_request_timeout: Union[
None,
@@ -2780,7 +2779,7 @@ class AlbumsApi:
Remove multiple assets from a specific album by its ID.
:param id: (required)
:type id: UUID
:type id: str
:param bulk_ids_dto: (required)
:type bulk_ids_dto: BulkIdsDto
:param _request_timeout: timeout setting for this request. If one
@@ -2909,7 +2908,7 @@ class AlbumsApi:
@validate_call
def remove_user_from_album(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
user_id: StrictStr,
_request_timeout: Union[
None,
@@ -2929,7 +2928,7 @@ class AlbumsApi:
Remove a user from an album. Use an ID of \"me\" to leave a shared album.
:param id: (required)
:type id: UUID
:type id: str
:param user_id: (required)
:type user_id: str
:param _request_timeout: timeout setting for this request. If one
@@ -2980,7 +2979,7 @@ class AlbumsApi:
@validate_call
def remove_user_from_album_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
user_id: StrictStr,
_request_timeout: Union[
None,
@@ -3000,7 +2999,7 @@ class AlbumsApi:
Remove a user from an album. Use an ID of \"me\" to leave a shared album.
:param id: (required)
:type id: UUID
:type id: str
:param user_id: (required)
:type user_id: str
:param _request_timeout: timeout setting for this request. If one
@@ -3051,7 +3050,7 @@ class AlbumsApi:
@validate_call
def remove_user_from_album_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
user_id: StrictStr,
_request_timeout: Union[
None,
@@ -3071,7 +3070,7 @@ class AlbumsApi:
Remove a user from an album. Use an ID of \"me\" to leave a shared album.
:param id: (required)
:type id: UUID
:type id: str
:param user_id: (required)
:type user_id: str
:param _request_timeout: timeout setting for this request. If one
@@ -3180,7 +3179,7 @@ class AlbumsApi:
@validate_call
def update_album_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
update_album_dto: UpdateAlbumDto,
_request_timeout: Union[
None,
@@ -3200,7 +3199,7 @@ class AlbumsApi:
Update the information of a specific album by its ID. This endpoint can be used to update the album name, description, sort order, etc. However, it is not used to add or remove assets or users from the album.
:param id: (required)
:type id: UUID
:type id: str
:param update_album_dto: (required)
:type update_album_dto: UpdateAlbumDto
:param _request_timeout: timeout setting for this request. If one
@@ -3251,7 +3250,7 @@ class AlbumsApi:
@validate_call
def update_album_info_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
update_album_dto: UpdateAlbumDto,
_request_timeout: Union[
None,
@@ -3271,7 +3270,7 @@ class AlbumsApi:
Update the information of a specific album by its ID. This endpoint can be used to update the album name, description, sort order, etc. However, it is not used to add or remove assets or users from the album.
:param id: (required)
:type id: UUID
:type id: str
:param update_album_dto: (required)
:type update_album_dto: UpdateAlbumDto
:param _request_timeout: timeout setting for this request. If one
@@ -3322,7 +3321,7 @@ class AlbumsApi:
@validate_call
def update_album_info_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
update_album_dto: UpdateAlbumDto,
_request_timeout: Union[
None,
@@ -3342,7 +3341,7 @@ class AlbumsApi:
Update the information of a specific album by its ID. This endpoint can be used to update the album name, description, sort order, etc. However, it is not used to add or remove assets or users from the album.
:param id: (required)
:type id: UUID
:type id: str
:param update_album_dto: (required)
:type update_album_dto: UpdateAlbumDto
:param _request_timeout: timeout setting for this request. If one
@@ -3471,7 +3470,7 @@ class AlbumsApi:
@validate_call
def update_album_user(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
user_id: StrictStr,
update_album_user_dto: UpdateAlbumUserDto,
_request_timeout: Union[
@@ -3492,7 +3491,7 @@ class AlbumsApi:
Change the role for a specific user in a specific album.
:param id: (required)
:type id: UUID
:type id: str
:param user_id: (required)
:type user_id: str
:param update_album_user_dto: (required)
@@ -3546,7 +3545,7 @@ class AlbumsApi:
@validate_call
def update_album_user_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
user_id: StrictStr,
update_album_user_dto: UpdateAlbumUserDto,
_request_timeout: Union[
@@ -3567,7 +3566,7 @@ class AlbumsApi:
Change the role for a specific user in a specific album.
:param id: (required)
:type id: UUID
:type id: str
:param user_id: (required)
:type user_id: str
:param update_album_user_dto: (required)
@@ -3621,7 +3620,7 @@ class AlbumsApi:
@validate_call
def update_album_user_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
user_id: StrictStr,
update_album_user_dto: UpdateAlbumUserDto,
_request_timeout: Union[
@@ -3642,7 +3641,7 @@ class AlbumsApi:
Change the role for a specific user in a specific album.
:param id: (required)
:type id: UUID
:type id: str
:param user_id: (required)
:type user_id: str
:param update_album_user_dto: (required)
generated/immich/openapi_client/api/api_keys_api.py
-1626
View File
File diff suppressed because it is too large Load Diff
generated/immich/openapi_client/api/assets_api.py
+126 -127
View File
@@ -20,7 +20,6 @@ from datetime import datetime
from pydantic import Field, StrictBool, StrictBytes, StrictStr, field_validator
from typing import List, Optional, Tuple, Union
from typing_extensions import Annotated
from uuid import UUID
from generated.immich.openapi_client.models.asset_bulk_delete_dto import AssetBulkDeleteDto
from generated.immich.openapi_client.models.asset_bulk_update_dto import AssetBulkUpdateDto
from generated.immich.openapi_client.models.asset_bulk_upload_check_dto import AssetBulkUploadCheckDto
@@ -609,7 +608,7 @@ class AssetsApi:
@validate_call
def delete_asset_metadata(
self,
id: Annotated[UUID, Field(description="Asset ID")],
id: Annotated[str, Field(strict=True, description="Asset ID")],
key: Annotated[StrictStr, Field(description="Metadata key")],
_request_timeout: Union[
None,
@@ -629,7 +628,7 @@ class AssetsApi:
Delete a specific metadata key-value pair associated with the specified asset.
:param id: Asset ID (required)
:type id: UUID
:type id: str
:param key: Metadata key (required)
:type key: str
:param _request_timeout: timeout setting for this request. If one
@@ -680,7 +679,7 @@ class AssetsApi:
@validate_call
def delete_asset_metadata_with_http_info(
self,
id: Annotated[UUID, Field(description="Asset ID")],
id: Annotated[str, Field(strict=True, description="Asset ID")],
key: Annotated[StrictStr, Field(description="Metadata key")],
_request_timeout: Union[
None,
@@ -700,7 +699,7 @@ class AssetsApi:
Delete a specific metadata key-value pair associated with the specified asset.
:param id: Asset ID (required)
:type id: UUID
:type id: str
:param key: Metadata key (required)
:type key: str
:param _request_timeout: timeout setting for this request. If one
@@ -751,7 +750,7 @@ class AssetsApi:
@validate_call
def delete_asset_metadata_without_preload_content(
self,
id: Annotated[UUID, Field(description="Asset ID")],
id: Annotated[str, Field(strict=True, description="Asset ID")],
key: Annotated[StrictStr, Field(description="Metadata key")],
_request_timeout: Union[
None,
@@ -771,7 +770,7 @@ class AssetsApi:
Delete a specific metadata key-value pair associated with the specified asset.
:param id: Asset ID (required)
:type id: UUID
:type id: str
:param key: Metadata key (required)
:type key: str
:param _request_timeout: timeout setting for this request. If one
@@ -1418,7 +1417,7 @@ class AssetsApi:
@validate_call
def download_asset(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
edited: Annotated[Optional[StrictBool], Field(description="Return edited asset if available")] = None,
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
@@ -1440,7 +1439,7 @@ class AssetsApi:
Downloads the original file of the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param edited: Return edited asset if available
:type edited: bool
:param key:
@@ -1497,7 +1496,7 @@ class AssetsApi:
@validate_call
def download_asset_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
edited: Annotated[Optional[StrictBool], Field(description="Return edited asset if available")] = None,
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
@@ -1519,7 +1518,7 @@ class AssetsApi:
Downloads the original file of the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param edited: Return edited asset if available
:type edited: bool
:param key:
@@ -1576,7 +1575,7 @@ class AssetsApi:
@validate_call
def download_asset_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
edited: Annotated[Optional[StrictBool], Field(description="Return edited asset if available")] = None,
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
@@ -1598,7 +1597,7 @@ class AssetsApi:
Downloads the original file of the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param edited: Return edited asset if available
:type edited: bool
:param key:
@@ -1732,7 +1731,7 @@ class AssetsApi:
@validate_call
def edit_asset(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
asset_edits_create_dto: AssetEditsCreateDto,
_request_timeout: Union[
None,
@@ -1752,7 +1751,7 @@ class AssetsApi:
Apply a series of edit actions (crop, rotate, mirror) to the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param asset_edits_create_dto: (required)
:type asset_edits_create_dto: AssetEditsCreateDto
:param _request_timeout: timeout setting for this request. If one
@@ -1803,7 +1802,7 @@ class AssetsApi:
@validate_call
def edit_asset_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
asset_edits_create_dto: AssetEditsCreateDto,
_request_timeout: Union[
None,
@@ -1823,7 +1822,7 @@ class AssetsApi:
Apply a series of edit actions (crop, rotate, mirror) to the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param asset_edits_create_dto: (required)
:type asset_edits_create_dto: AssetEditsCreateDto
:param _request_timeout: timeout setting for this request. If one
@@ -1874,7 +1873,7 @@ class AssetsApi:
@validate_call
def edit_asset_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
asset_edits_create_dto: AssetEditsCreateDto,
_request_timeout: Union[
None,
@@ -1894,7 +1893,7 @@ class AssetsApi:
Apply a series of edit actions (crop, rotate, mirror) to the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param asset_edits_create_dto: (required)
:type asset_edits_create_dto: AssetEditsCreateDto
:param _request_timeout: timeout setting for this request. If one
@@ -2023,8 +2022,8 @@ class AssetsApi:
@validate_call
def end_session(
self,
id: UUID,
session_id: UUID,
id: Annotated[str, Field(strict=True)],
session_id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -2045,9 +2044,9 @@ class AssetsApi:
Releases server resources for the streaming session.
:param id: (required)
:type id: UUID
:type id: str
:param session_id: (required)
:type session_id: UUID
:type session_id: str
:param key:
:type key: str
:param slug:
@@ -2102,8 +2101,8 @@ class AssetsApi:
@validate_call
def end_session_with_http_info(
self,
id: UUID,
session_id: UUID,
id: Annotated[str, Field(strict=True)],
session_id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -2124,9 +2123,9 @@ class AssetsApi:
Releases server resources for the streaming session.
:param id: (required)
:type id: UUID
:type id: str
:param session_id: (required)
:type session_id: UUID
:type session_id: str
:param key:
:type key: str
:param slug:
@@ -2181,8 +2180,8 @@ class AssetsApi:
@validate_call
def end_session_without_preload_content(
self,
id: UUID,
session_id: UUID,
id: Annotated[str, Field(strict=True)],
session_id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -2203,9 +2202,9 @@ class AssetsApi:
Releases server resources for the streaming session.
:param id: (required)
:type id: UUID
:type id: str
:param session_id: (required)
:type session_id: UUID
:type session_id: str
:param key:
:type key: str
:param slug:
@@ -2328,7 +2327,7 @@ class AssetsApi:
@validate_call
def get_asset_edits(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -2347,7 +2346,7 @@ class AssetsApi:
Retrieve a series of edit actions (crop, rotate, mirror) associated with the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -2395,7 +2394,7 @@ class AssetsApi:
@validate_call
def get_asset_edits_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -2414,7 +2413,7 @@ class AssetsApi:
Retrieve a series of edit actions (crop, rotate, mirror) associated with the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -2462,7 +2461,7 @@ class AssetsApi:
@validate_call
def get_asset_edits_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -2481,7 +2480,7 @@ class AssetsApi:
Retrieve a series of edit actions (crop, rotate, mirror) associated with the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -2591,7 +2590,7 @@ class AssetsApi:
@validate_call
def get_asset_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -2612,7 +2611,7 @@ class AssetsApi:
Retrieve detailed information about a specific asset.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -2666,7 +2665,7 @@ class AssetsApi:
@validate_call
def get_asset_info_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -2687,7 +2686,7 @@ class AssetsApi:
Retrieve detailed information about a specific asset.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -2741,7 +2740,7 @@ class AssetsApi:
@validate_call
def get_asset_info_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -2762,7 +2761,7 @@ class AssetsApi:
Retrieve detailed information about a specific asset.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -2888,7 +2887,7 @@ class AssetsApi:
@validate_call
def get_asset_metadata(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -2907,7 +2906,7 @@ class AssetsApi:
Retrieve all metadata key-value pairs associated with the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -2955,7 +2954,7 @@ class AssetsApi:
@validate_call
def get_asset_metadata_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -2974,7 +2973,7 @@ class AssetsApi:
Retrieve all metadata key-value pairs associated with the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -3022,7 +3021,7 @@ class AssetsApi:
@validate_call
def get_asset_metadata_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -3041,7 +3040,7 @@ class AssetsApi:
Retrieve all metadata key-value pairs associated with the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -3151,7 +3150,7 @@ class AssetsApi:
@validate_call
def get_asset_metadata_by_key(
self,
id: Annotated[UUID, Field(description="Asset ID")],
id: Annotated[str, Field(strict=True, description="Asset ID")],
key: Annotated[StrictStr, Field(description="Metadata key")],
_request_timeout: Union[
None,
@@ -3171,7 +3170,7 @@ class AssetsApi:
Retrieve the value of a specific metadata key associated with the specified asset.
:param id: Asset ID (required)
:type id: UUID
:type id: str
:param key: Metadata key (required)
:type key: str
:param _request_timeout: timeout setting for this request. If one
@@ -3222,7 +3221,7 @@ class AssetsApi:
@validate_call
def get_asset_metadata_by_key_with_http_info(
self,
id: Annotated[UUID, Field(description="Asset ID")],
id: Annotated[str, Field(strict=True, description="Asset ID")],
key: Annotated[StrictStr, Field(description="Metadata key")],
_request_timeout: Union[
None,
@@ -3242,7 +3241,7 @@ class AssetsApi:
Retrieve the value of a specific metadata key associated with the specified asset.
:param id: Asset ID (required)
:type id: UUID
:type id: str
:param key: Metadata key (required)
:type key: str
:param _request_timeout: timeout setting for this request. If one
@@ -3293,7 +3292,7 @@ class AssetsApi:
@validate_call
def get_asset_metadata_by_key_without_preload_content(
self,
id: Annotated[UUID, Field(description="Asset ID")],
id: Annotated[str, Field(strict=True, description="Asset ID")],
key: Annotated[StrictStr, Field(description="Metadata key")],
_request_timeout: Union[
None,
@@ -3313,7 +3312,7 @@ class AssetsApi:
Retrieve the value of a specific metadata key associated with the specified asset.
:param id: Asset ID (required)
:type id: UUID
:type id: str
:param key: Metadata key (required)
:type key: str
:param _request_timeout: timeout setting for this request. If one
@@ -3429,7 +3428,7 @@ class AssetsApi:
@validate_call
def get_asset_ocr(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -3448,7 +3447,7 @@ class AssetsApi:
Retrieve all OCR (Optical Character Recognition) data associated with the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -3496,7 +3495,7 @@ class AssetsApi:
@validate_call
def get_asset_ocr_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -3515,7 +3514,7 @@ class AssetsApi:
Retrieve all OCR (Optical Character Recognition) data associated with the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -3563,7 +3562,7 @@ class AssetsApi:
@validate_call
def get_asset_ocr_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -3582,7 +3581,7 @@ class AssetsApi:
Retrieve all OCR (Optical Character Recognition) data associated with the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -3991,7 +3990,7 @@ class AssetsApi:
@validate_call
def get_main_playlist(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -4012,7 +4011,7 @@ class AssetsApi:
Returns an HLS main playlist with all available variants for the asset.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -4066,7 +4065,7 @@ class AssetsApi:
@validate_call
def get_main_playlist_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -4087,7 +4086,7 @@ class AssetsApi:
Returns an HLS main playlist with all available variants for the asset.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -4141,7 +4140,7 @@ class AssetsApi:
@validate_call
def get_main_playlist_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -4162,7 +4161,7 @@ class AssetsApi:
Returns an HLS main playlist with all available variants for the asset.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -4288,8 +4287,8 @@ class AssetsApi:
@validate_call
def get_media_playlist(
self,
id: UUID,
session_id: UUID,
id: Annotated[str, Field(strict=True)],
session_id: Annotated[str, Field(strict=True)],
variant_index: Annotated[int, Field(le=9007199254740991, strict=True, ge=0)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
@@ -4312,9 +4311,9 @@ class AssetsApi:
Returns an HLS media playlist for one variant of the streaming session.
:param id: (required)
:type id: UUID
:type id: str
:param session_id: (required)
:type session_id: UUID
:type session_id: str
:param variant_index: (required)
:type variant_index: int
:param key:
@@ -4375,8 +4374,8 @@ class AssetsApi:
@validate_call
def get_media_playlist_with_http_info(
self,
id: UUID,
session_id: UUID,
id: Annotated[str, Field(strict=True)],
session_id: Annotated[str, Field(strict=True)],
variant_index: Annotated[int, Field(le=9007199254740991, strict=True, ge=0)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
@@ -4399,9 +4398,9 @@ class AssetsApi:
Returns an HLS media playlist for one variant of the streaming session.
:param id: (required)
:type id: UUID
:type id: str
:param session_id: (required)
:type session_id: UUID
:type session_id: str
:param variant_index: (required)
:type variant_index: int
:param key:
@@ -4462,8 +4461,8 @@ class AssetsApi:
@validate_call
def get_media_playlist_without_preload_content(
self,
id: UUID,
session_id: UUID,
id: Annotated[str, Field(strict=True)],
session_id: Annotated[str, Field(strict=True)],
variant_index: Annotated[int, Field(le=9007199254740991, strict=True, ge=0)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
@@ -4486,9 +4485,9 @@ class AssetsApi:
Returns an HLS media playlist for one variant of the streaming session.
:param id: (required)
:type id: UUID
:type id: str
:param session_id: (required)
:type session_id: UUID
:type session_id: str
:param variant_index: (required)
:type variant_index: int
:param key:
@@ -4631,8 +4630,8 @@ class AssetsApi:
def get_segment(
self,
filename: Annotated[str, Field(strict=True)],
id: UUID,
session_id: UUID,
id: Annotated[str, Field(strict=True)],
session_id: Annotated[str, Field(strict=True)],
variant_index: Annotated[int, Field(le=9007199254740991, strict=True, ge=0)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
@@ -4657,9 +4656,9 @@ class AssetsApi:
:param filename: (required)
:type filename: str
:param id: (required)
:type id: UUID
:type id: str
:param session_id: (required)
:type session_id: UUID
:type session_id: str
:param variant_index: (required)
:type variant_index: int
:param key:
@@ -4722,8 +4721,8 @@ class AssetsApi:
def get_segment_with_http_info(
self,
filename: Annotated[str, Field(strict=True)],
id: UUID,
session_id: UUID,
id: Annotated[str, Field(strict=True)],
session_id: Annotated[str, Field(strict=True)],
variant_index: Annotated[int, Field(le=9007199254740991, strict=True, ge=0)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
@@ -4748,9 +4747,9 @@ class AssetsApi:
:param filename: (required)
:type filename: str
:param id: (required)
:type id: UUID
:type id: str
:param session_id: (required)
:type session_id: UUID
:type session_id: str
:param variant_index: (required)
:type variant_index: int
:param key:
@@ -4813,8 +4812,8 @@ class AssetsApi:
def get_segment_without_preload_content(
self,
filename: Annotated[str, Field(strict=True)],
id: UUID,
session_id: UUID,
id: Annotated[str, Field(strict=True)],
session_id: Annotated[str, Field(strict=True)],
variant_index: Annotated[int, Field(le=9007199254740991, strict=True, ge=0)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
@@ -4839,9 +4838,9 @@ class AssetsApi:
:param filename: (required)
:type filename: str
:param id: (required)
:type id: UUID
:type id: str
:param session_id: (required)
:type session_id: UUID
:type session_id: str
:param variant_index: (required)
:type variant_index: int
:param key:
@@ -4987,7 +4986,7 @@ class AssetsApi:
@validate_call
def play_asset_video(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -5008,7 +5007,7 @@ class AssetsApi:
Streams the video file for the specified asset. This endpoint also supports byte range requests.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -5062,7 +5061,7 @@ class AssetsApi:
@validate_call
def play_asset_video_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -5083,7 +5082,7 @@ class AssetsApi:
Streams the video file for the specified asset. This endpoint also supports byte range requests.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -5137,7 +5136,7 @@ class AssetsApi:
@validate_call
def play_asset_video_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -5158,7 +5157,7 @@ class AssetsApi:
Streams the video file for the specified asset. This endpoint also supports byte range requests.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -5284,7 +5283,7 @@ class AssetsApi:
@validate_call
def remove_asset_edits(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -5303,7 +5302,7 @@ class AssetsApi:
Removes all edit actions (crop, rotate, mirror) associated with the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -5351,7 +5350,7 @@ class AssetsApi:
@validate_call
def remove_asset_edits_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -5370,7 +5369,7 @@ class AssetsApi:
Removes all edit actions (crop, rotate, mirror) associated with the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -5418,7 +5417,7 @@ class AssetsApi:
@validate_call
def remove_asset_edits_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -5437,7 +5436,7 @@ class AssetsApi:
Removes all edit actions (crop, rotate, mirror) associated with the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -5809,7 +5808,7 @@ class AssetsApi:
@validate_call
def update_asset(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
update_asset_dto: UpdateAssetDto,
_request_timeout: Union[
None,
@@ -5829,7 +5828,7 @@ class AssetsApi:
Update information of a specific asset.
:param id: (required)
:type id: UUID
:type id: str
:param update_asset_dto: (required)
:type update_asset_dto: UpdateAssetDto
:param _request_timeout: timeout setting for this request. If one
@@ -5881,7 +5880,7 @@ class AssetsApi:
@validate_call
def update_asset_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
update_asset_dto: UpdateAssetDto,
_request_timeout: Union[
None,
@@ -5901,7 +5900,7 @@ class AssetsApi:
Update information of a specific asset.
:param id: (required)
:type id: UUID
:type id: str
:param update_asset_dto: (required)
:type update_asset_dto: UpdateAssetDto
:param _request_timeout: timeout setting for this request. If one
@@ -5953,7 +5952,7 @@ class AssetsApi:
@validate_call
def update_asset_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
update_asset_dto: UpdateAssetDto,
_request_timeout: Union[
None,
@@ -5973,7 +5972,7 @@ class AssetsApi:
Update information of a specific asset.
:param id: (required)
:type id: UUID
:type id: str
:param update_asset_dto: (required)
:type update_asset_dto: UpdateAssetDto
:param _request_timeout: timeout setting for this request. If one
@@ -6103,7 +6102,7 @@ class AssetsApi:
@validate_call
def update_asset_metadata(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
asset_metadata_upsert_dto: AssetMetadataUpsertDto,
_request_timeout: Union[
None,
@@ -6123,7 +6122,7 @@ class AssetsApi:
Update or add metadata key-value pairs for the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param asset_metadata_upsert_dto: (required)
:type asset_metadata_upsert_dto: AssetMetadataUpsertDto
:param _request_timeout: timeout setting for this request. If one
@@ -6174,7 +6173,7 @@ class AssetsApi:
@validate_call
def update_asset_metadata_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
asset_metadata_upsert_dto: AssetMetadataUpsertDto,
_request_timeout: Union[
None,
@@ -6194,7 +6193,7 @@ class AssetsApi:
Update or add metadata key-value pairs for the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param asset_metadata_upsert_dto: (required)
:type asset_metadata_upsert_dto: AssetMetadataUpsertDto
:param _request_timeout: timeout setting for this request. If one
@@ -6245,7 +6244,7 @@ class AssetsApi:
@validate_call
def update_asset_metadata_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
asset_metadata_upsert_dto: AssetMetadataUpsertDto,
_request_timeout: Union[
None,
@@ -6265,7 +6264,7 @@ class AssetsApi:
Update or add metadata key-value pairs for the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param asset_metadata_upsert_dto: (required)
:type asset_metadata_upsert_dto: AssetMetadataUpsertDto
:param _request_timeout: timeout setting for this request. If one
@@ -6951,7 +6950,7 @@ class AssetsApi:
duration: Annotated[Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=0)]], Field(description="Duration in milliseconds (for videos)")] = None,
filename: Annotated[Optional[StrictStr], Field(description="Filename")] = None,
is_favorite: Annotated[Optional[StrictBool], Field(description="Mark as favorite")] = None,
live_photo_video_id: Annotated[Optional[UUID], Field(description="Live photo video ID")] = None,
live_photo_video_id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Live photo video ID")] = None,
metadata: Annotated[Optional[List[AssetMetadataUpsertItemDto]], Field(description="Asset metadata items")] = None,
sidecar_data: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="Sidecar file data")] = None,
visibility: Optional[AssetVisibility] = None,
@@ -6991,7 +6990,7 @@ class AssetsApi:
:param is_favorite: Mark as favorite
:type is_favorite: bool
:param live_photo_video_id: Live photo video ID
:type live_photo_video_id: UUID
:type live_photo_video_id: str
:param metadata: Asset metadata items
:type metadata: List[AssetMetadataUpsertItemDto]
:param sidecar_data: Sidecar file data
@@ -7067,7 +7066,7 @@ class AssetsApi:
duration: Annotated[Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=0)]], Field(description="Duration in milliseconds (for videos)")] = None,
filename: Annotated[Optional[StrictStr], Field(description="Filename")] = None,
is_favorite: Annotated[Optional[StrictBool], Field(description="Mark as favorite")] = None,
live_photo_video_id: Annotated[Optional[UUID], Field(description="Live photo video ID")] = None,
live_photo_video_id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Live photo video ID")] = None,
metadata: Annotated[Optional[List[AssetMetadataUpsertItemDto]], Field(description="Asset metadata items")] = None,
sidecar_data: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="Sidecar file data")] = None,
visibility: Optional[AssetVisibility] = None,
@@ -7107,7 +7106,7 @@ class AssetsApi:
:param is_favorite: Mark as favorite
:type is_favorite: bool
:param live_photo_video_id: Live photo video ID
:type live_photo_video_id: UUID
:type live_photo_video_id: str
:param metadata: Asset metadata items
:type metadata: List[AssetMetadataUpsertItemDto]
:param sidecar_data: Sidecar file data
@@ -7183,7 +7182,7 @@ class AssetsApi:
duration: Annotated[Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=0)]], Field(description="Duration in milliseconds (for videos)")] = None,
filename: Annotated[Optional[StrictStr], Field(description="Filename")] = None,
is_favorite: Annotated[Optional[StrictBool], Field(description="Mark as favorite")] = None,
live_photo_video_id: Annotated[Optional[UUID], Field(description="Live photo video ID")] = None,
live_photo_video_id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Live photo video ID")] = None,
metadata: Annotated[Optional[List[AssetMetadataUpsertItemDto]], Field(description="Asset metadata items")] = None,
sidecar_data: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="Sidecar file data")] = None,
visibility: Optional[AssetVisibility] = None,
@@ -7223,7 +7222,7 @@ class AssetsApi:
:param is_favorite: Mark as favorite
:type is_favorite: bool
:param live_photo_video_id: Live photo video ID
:type live_photo_video_id: UUID
:type live_photo_video_id: str
:param metadata: Asset metadata items
:type metadata: List[AssetMetadataUpsertItemDto]
:param sidecar_data: Sidecar file data
@@ -7406,7 +7405,7 @@ class AssetsApi:
@validate_call
def view_asset(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
edited: Annotated[Optional[StrictBool], Field(description="Return edited asset if available")] = None,
key: Optional[StrictStr] = None,
size: Optional[AssetMediaSize] = None,
@@ -7429,7 +7428,7 @@ class AssetsApi:
Retrieve the thumbnail image for the specified asset. Viewing the fullsize thumbnail might redirect to downloadAsset, which requires a different permission.
:param id: (required)
:type id: UUID
:type id: str
:param edited: Return edited asset if available
:type edited: bool
:param key:
@@ -7489,7 +7488,7 @@ class AssetsApi:
@validate_call
def view_asset_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
edited: Annotated[Optional[StrictBool], Field(description="Return edited asset if available")] = None,
key: Optional[StrictStr] = None,
size: Optional[AssetMediaSize] = None,
@@ -7512,7 +7511,7 @@ class AssetsApi:
Retrieve the thumbnail image for the specified asset. Viewing the fullsize thumbnail might redirect to downloadAsset, which requires a different permission.
:param id: (required)
:type id: UUID
:type id: str
:param edited: Return edited asset if available
:type edited: bool
:param key:
@@ -7572,7 +7571,7 @@ class AssetsApi:
@validate_call
def view_asset_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
edited: Annotated[Optional[StrictBool], Field(description="Return edited asset if available")] = None,
key: Optional[StrictStr] = None,
size: Optional[AssetMediaSize] = None,
@@ -7595,7 +7594,7 @@ class AssetsApi:
Retrieve the thumbnail image for the specified asset. Viewing the fullsize thumbnail might redirect to downloadAsset, which requires a different permission.
:param id: (required)
:type id: UUID
:type id: str
:param edited: Return edited asset if available
:type edited: bool
:param key:
generated/immich/openapi_client/api/authentication_api.py
-4509
View File
File diff suppressed because it is too large Load Diff
generated/immich/openapi_client/api/deprecated_api.py
-4940
View File
File diff suppressed because it is too large Load Diff
generated/immich/openapi_client/api/download_api.py
-660
View File
@@ -1,660 +0,0 @@
# coding: utf-8
"""
Immich
Immich API
The version of the OpenAPI document: 3.0.1
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import warnings
from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
from typing import Any, Dict, List, Optional, Tuple, Union
from typing_extensions import Annotated
from pydantic import StrictBytes, StrictStr
from typing import Optional, Tuple, Union
from generated.immich.openapi_client.models.download_archive_dto import DownloadArchiveDto
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.api_client import ApiClient, RequestSerialized
from generated.immich.openapi_client.api_response import ApiResponse
from generated.immich.openapi_client.rest import RESTResponseType
class DownloadApi:
"""NOTE: This class is auto generated by OpenAPI Generator
Ref: https://openapi-generator.tech
Do not edit the class manually.
"""
def __init__(self, api_client=None) -> None:
if api_client is None:
api_client = ApiClient.get_default()
self.api_client = api_client
@validate_call
def download_archive(
self,
download_archive_dto: DownloadArchiveDto,
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> bytearray:
"""Download asset archive
Download a ZIP archive containing the specified assets. The assets must have been previously requested via the \"getDownloadInfo\" endpoint.
:param download_archive_dto: (required)
:type download_archive_dto: DownloadArchiveDto
:param key:
:type key: str
:param slug:
:type slug: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._download_archive_serialize(
download_archive_dto=download_archive_dto,
key=key,
slug=slug,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "bytearray",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
).data
@validate_call
def download_archive_with_http_info(
self,
download_archive_dto: DownloadArchiveDto,
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[bytearray]:
"""Download asset archive
Download a ZIP archive containing the specified assets. The assets must have been previously requested via the \"getDownloadInfo\" endpoint.
:param download_archive_dto: (required)
:type download_archive_dto: DownloadArchiveDto
:param key:
:type key: str
:param slug:
:type slug: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._download_archive_serialize(
download_archive_dto=download_archive_dto,
key=key,
slug=slug,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "bytearray",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
)
@validate_call
def download_archive_without_preload_content(
self,
download_archive_dto: DownloadArchiveDto,
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
"""Download asset archive
Download a ZIP archive containing the specified assets. The assets must have been previously requested via the \"getDownloadInfo\" endpoint.
:param download_archive_dto: (required)
:type download_archive_dto: DownloadArchiveDto
:param key:
:type key: str
:param slug:
:type slug: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._download_archive_serialize(
download_archive_dto=download_archive_dto,
key=key,
slug=slug,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "bytearray",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
return response_data.response
def _download_archive_serialize(
self,
download_archive_dto,
key,
slug,
_request_auth,
_content_type,
_headers,
_host_index,
) -> RequestSerialized:
_host = None
_collection_formats: Dict[str, str] = {
}
_path_params: Dict[str, str] = {}
_query_params: List[Tuple[str, str]] = []
_header_params: Dict[str, Optional[str]] = _headers or {}
_form_params: List[Tuple[str, str]] = []
_files: Dict[
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
] = {}
_body_params: Optional[bytes] = None
# process the path parameters
# process the query parameters
if key is not None:
_query_params.append(('key', key))
if slug is not None:
_query_params.append(('slug', slug))
# process the header parameters
# process the form parameters
# process the body parameter
if download_archive_dto is not None:
_body_params = download_archive_dto
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/octet-stream'
]
)
# set the HTTP header `Content-Type`
if _content_type:
_header_params['Content-Type'] = _content_type
else:
_default_content_type = (
self.api_client.select_header_content_type(
[
'application/json'
]
)
)
if _default_content_type is not None:
_header_params['Content-Type'] = _default_content_type
# authentication setting
_auth_settings: List[str] = [
'cookie',
'api_key',
'bearer'
]
return self.api_client.param_serialize(
method='POST',
resource_path='/download/archive',
path_params=_path_params,
query_params=_query_params,
header_params=_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
auth_settings=_auth_settings,
collection_formats=_collection_formats,
_host=_host,
_request_auth=_request_auth
)
@validate_call
def get_download_info(
self,
download_info_dto: DownloadInfoDto,
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> DownloadResponseDto:
"""Retrieve download information
Retrieve information about how to request a download for the specified assets or album. The response includes groups of assets that can be downloaded together.
:param download_info_dto: (required)
:type download_info_dto: DownloadInfoDto
:param key:
:type key: str
:param slug:
:type slug: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._get_download_info_serialize(
download_info_dto=download_info_dto,
key=key,
slug=slug,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'201': "DownloadResponseDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
).data
@validate_call
def get_download_info_with_http_info(
self,
download_info_dto: DownloadInfoDto,
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[DownloadResponseDto]:
"""Retrieve download information
Retrieve information about how to request a download for the specified assets or album. The response includes groups of assets that can be downloaded together.
:param download_info_dto: (required)
:type download_info_dto: DownloadInfoDto
:param key:
:type key: str
:param slug:
:type slug: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._get_download_info_serialize(
download_info_dto=download_info_dto,
key=key,
slug=slug,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'201': "DownloadResponseDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
)
@validate_call
def get_download_info_without_preload_content(
self,
download_info_dto: DownloadInfoDto,
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
"""Retrieve download information
Retrieve information about how to request a download for the specified assets or album. The response includes groups of assets that can be downloaded together.
:param download_info_dto: (required)
:type download_info_dto: DownloadInfoDto
:param key:
:type key: str
:param slug:
:type slug: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._get_download_info_serialize(
download_info_dto=download_info_dto,
key=key,
slug=slug,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'201': "DownloadResponseDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
return response_data.response
def _get_download_info_serialize(
self,
download_info_dto,
key,
slug,
_request_auth,
_content_type,
_headers,
_host_index,
) -> RequestSerialized:
_host = None
_collection_formats: Dict[str, str] = {
}
_path_params: Dict[str, str] = {}
_query_params: List[Tuple[str, str]] = []
_header_params: Dict[str, Optional[str]] = _headers or {}
_form_params: List[Tuple[str, str]] = []
_files: Dict[
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
] = {}
_body_params: Optional[bytes] = None
# process the path parameters
# process the query parameters
if key is not None:
_query_params.append(('key', key))
if slug is not None:
_query_params.append(('slug', slug))
# process the header parameters
# process the form parameters
# process the body parameter
if download_info_dto is not None:
_body_params = download_info_dto
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/json'
]
)
# set the HTTP header `Content-Type`
if _content_type:
_header_params['Content-Type'] = _content_type
else:
_default_content_type = (
self.api_client.select_header_content_type(
[
'application/json'
]
)
)
if _default_content_type is not None:
_header_params['Content-Type'] = _default_content_type
# authentication setting
_auth_settings: List[str] = [
'cookie',
'api_key',
'bearer'
]
return self.api_client.param_serialize(
method='POST',
resource_path='/download/info',
path_params=_path_params,
query_params=_query_params,
header_params=_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
auth_settings=_auth_settings,
collection_formats=_collection_formats,
_host=_host,
_request_auth=_request_auth
)
generated/immich/openapi_client/api/duplicates_api.py
-1090
View File
File diff suppressed because it is too large Load Diff
generated/immich/openapi_client/api/faces_api.py
-1153
View File
File diff suppressed because it is too large Load Diff
generated/immich/openapi_client/api/jobs_api.py
-854
View File
@@ -1,854 +0,0 @@
# coding: utf-8
"""
Immich
Immich API
The version of the OpenAPI document: 3.0.1
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import warnings
from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
from typing import Any, Dict, List, Optional, Tuple, Union
from typing_extensions import Annotated
from generated.immich.openapi_client.models.job_create_dto import JobCreateDto
from generated.immich.openapi_client.models.queue_command_dto import QueueCommandDto
from generated.immich.openapi_client.models.queue_name import QueueName
from generated.immich.openapi_client.models.queue_response_legacy_dto import QueueResponseLegacyDto
from generated.immich.openapi_client.models.queues_response_legacy_dto import QueuesResponseLegacyDto
from generated.immich.openapi_client.api_client import ApiClient, RequestSerialized
from generated.immich.openapi_client.api_response import ApiResponse
from generated.immich.openapi_client.rest import RESTResponseType
class JobsApi:
"""NOTE: This class is auto generated by OpenAPI Generator
Ref: https://openapi-generator.tech
Do not edit the class manually.
"""
def __init__(self, api_client=None) -> None:
if api_client is None:
api_client = ApiClient.get_default()
self.api_client = api_client
@validate_call
def create_job(
self,
job_create_dto: JobCreateDto,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> None:
"""Create a manual job
Run a specific job. Most jobs are queued automatically, but this endpoint allows for manual creation of a handful of jobs, including various cleanup tasks, as well as creating a new database backup.
:param job_create_dto: (required)
:type job_create_dto: JobCreateDto
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._create_job_serialize(
job_create_dto=job_create_dto,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'204': None,
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
).data
@validate_call
def create_job_with_http_info(
self,
job_create_dto: JobCreateDto,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[None]:
"""Create a manual job
Run a specific job. Most jobs are queued automatically, but this endpoint allows for manual creation of a handful of jobs, including various cleanup tasks, as well as creating a new database backup.
:param job_create_dto: (required)
:type job_create_dto: JobCreateDto
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._create_job_serialize(
job_create_dto=job_create_dto,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'204': None,
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
)
@validate_call
def create_job_without_preload_content(
self,
job_create_dto: JobCreateDto,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
"""Create a manual job
Run a specific job. Most jobs are queued automatically, but this endpoint allows for manual creation of a handful of jobs, including various cleanup tasks, as well as creating a new database backup.
:param job_create_dto: (required)
:type job_create_dto: JobCreateDto
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._create_job_serialize(
job_create_dto=job_create_dto,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'204': None,
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
return response_data.response
def _create_job_serialize(
self,
job_create_dto,
_request_auth,
_content_type,
_headers,
_host_index,
) -> RequestSerialized:
_host = None
_collection_formats: Dict[str, str] = {
}
_path_params: Dict[str, str] = {}
_query_params: List[Tuple[str, str]] = []
_header_params: Dict[str, Optional[str]] = _headers or {}
_form_params: List[Tuple[str, str]] = []
_files: Dict[
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
] = {}
_body_params: Optional[bytes] = None
# process the path parameters
# process the query parameters
# process the header parameters
# process the form parameters
# process the body parameter
if job_create_dto is not None:
_body_params = job_create_dto
# set the HTTP header `Content-Type`
if _content_type:
_header_params['Content-Type'] = _content_type
else:
_default_content_type = (
self.api_client.select_header_content_type(
[
'application/json'
]
)
)
if _default_content_type is not None:
_header_params['Content-Type'] = _default_content_type
# authentication setting
_auth_settings: List[str] = [
'cookie',
'api_key',
'bearer'
]
return self.api_client.param_serialize(
method='POST',
resource_path='/jobs',
path_params=_path_params,
query_params=_query_params,
header_params=_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
auth_settings=_auth_settings,
collection_formats=_collection_formats,
_host=_host,
_request_auth=_request_auth
)
@validate_call
def get_queues_legacy(
self,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> QueuesResponseLegacyDto:
"""(Deprecated) Retrieve queue counts and status
Retrieve the counts of the current queue, as well as the current status.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
warnings.warn("GET /jobs is deprecated.", DeprecationWarning)
_param = self._get_queues_legacy_serialize(
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "QueuesResponseLegacyDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
).data
@validate_call
def get_queues_legacy_with_http_info(
self,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[QueuesResponseLegacyDto]:
"""(Deprecated) Retrieve queue counts and status
Retrieve the counts of the current queue, as well as the current status.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
warnings.warn("GET /jobs is deprecated.", DeprecationWarning)
_param = self._get_queues_legacy_serialize(
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "QueuesResponseLegacyDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
)
@validate_call
def get_queues_legacy_without_preload_content(
self,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
"""(Deprecated) Retrieve queue counts and status
Retrieve the counts of the current queue, as well as the current status.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
warnings.warn("GET /jobs is deprecated.", DeprecationWarning)
_param = self._get_queues_legacy_serialize(
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "QueuesResponseLegacyDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
return response_data.response
def _get_queues_legacy_serialize(
self,
_request_auth,
_content_type,
_headers,
_host_index,
) -> RequestSerialized:
_host = None
_collection_formats: Dict[str, str] = {
}
_path_params: Dict[str, str] = {}
_query_params: List[Tuple[str, str]] = []
_header_params: Dict[str, Optional[str]] = _headers or {}
_form_params: List[Tuple[str, str]] = []
_files: Dict[
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
] = {}
_body_params: Optional[bytes] = None
# process the path parameters
# process the query parameters
# process the header parameters
# process the form parameters
# process the body parameter
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/json'
]
)
# authentication setting
_auth_settings: List[str] = [
'cookie',
'api_key',
'bearer'
]
return self.api_client.param_serialize(
method='GET',
resource_path='/jobs',
path_params=_path_params,
query_params=_query_params,
header_params=_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
auth_settings=_auth_settings,
collection_formats=_collection_formats,
_host=_host,
_request_auth=_request_auth
)
@validate_call
def run_queue_command_legacy(
self,
name: QueueName,
queue_command_dto: QueueCommandDto,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> QueueResponseLegacyDto:
"""(Deprecated) Run jobs
Queue all assets for a specific job type. Defaults to only queueing assets that have not yet been processed, but the force command can be used to re-process all assets.
:param name: (required)
:type name: QueueName
:param queue_command_dto: (required)
:type queue_command_dto: QueueCommandDto
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
warnings.warn("PUT /jobs/{name} is deprecated.", DeprecationWarning)
_param = self._run_queue_command_legacy_serialize(
name=name,
queue_command_dto=queue_command_dto,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "QueueResponseLegacyDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
).data
@validate_call
def run_queue_command_legacy_with_http_info(
self,
name: QueueName,
queue_command_dto: QueueCommandDto,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[QueueResponseLegacyDto]:
"""(Deprecated) Run jobs
Queue all assets for a specific job type. Defaults to only queueing assets that have not yet been processed, but the force command can be used to re-process all assets.
:param name: (required)
:type name: QueueName
:param queue_command_dto: (required)
:type queue_command_dto: QueueCommandDto
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
warnings.warn("PUT /jobs/{name} is deprecated.", DeprecationWarning)
_param = self._run_queue_command_legacy_serialize(
name=name,
queue_command_dto=queue_command_dto,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "QueueResponseLegacyDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
)
@validate_call
def run_queue_command_legacy_without_preload_content(
self,
name: QueueName,
queue_command_dto: QueueCommandDto,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
"""(Deprecated) Run jobs
Queue all assets for a specific job type. Defaults to only queueing assets that have not yet been processed, but the force command can be used to re-process all assets.
:param name: (required)
:type name: QueueName
:param queue_command_dto: (required)
:type queue_command_dto: QueueCommandDto
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
warnings.warn("PUT /jobs/{name} is deprecated.", DeprecationWarning)
_param = self._run_queue_command_legacy_serialize(
name=name,
queue_command_dto=queue_command_dto,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "QueueResponseLegacyDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
return response_data.response
def _run_queue_command_legacy_serialize(
self,
name,
queue_command_dto,
_request_auth,
_content_type,
_headers,
_host_index,
) -> RequestSerialized:
_host = None
_collection_formats: Dict[str, str] = {
}
_path_params: Dict[str, str] = {}
_query_params: List[Tuple[str, str]] = []
_header_params: Dict[str, Optional[str]] = _headers or {}
_form_params: List[Tuple[str, str]] = []
_files: Dict[
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
] = {}
_body_params: Optional[bytes] = None
# process the path parameters
if name is not None:
_path_params['name'] = name.value
# process the query parameters
# process the header parameters
# process the form parameters
# process the body parameter
if queue_command_dto is not None:
_body_params = queue_command_dto
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/json'
]
)
# set the HTTP header `Content-Type`
if _content_type:
_header_params['Content-Type'] = _content_type
else:
_default_content_type = (
self.api_client.select_header_content_type(
[
'application/json'
]
)
)
if _default_content_type is not None:
_header_params['Content-Type'] = _default_content_type
# authentication setting
_auth_settings: List[str] = [
'cookie',
'api_key',
'bearer'
]
return self.api_client.param_serialize(
method='PUT',
resource_path='/jobs/{name}',
path_params=_path_params,
query_params=_query_params,
header_params=_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
auth_settings=_auth_settings,
collection_formats=_collection_formats,
_host=_host,
_request_auth=_request_auth
)
generated/immich/openapi_client/api/libraries_api.py
-2190
View File
File diff suppressed because it is too large Load Diff
generated/immich/openapi_client/api/map_api.py
-691
View File
@@ -1,691 +0,0 @@
# coding: utf-8
"""
Immich
Immich API
The version of the OpenAPI document: 3.0.1
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import warnings
from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
from typing import Any, Dict, List, Optional, Tuple, Union
from typing_extensions import Annotated
from datetime import datetime
from pydantic import Field, StrictBool, StrictFloat, StrictInt
from typing import List, Optional, Union
from typing_extensions import Annotated
from generated.immich.openapi_client.models.map_marker_response_dto import MapMarkerResponseDto
from generated.immich.openapi_client.models.map_reverse_geocode_response_dto import MapReverseGeocodeResponseDto
from generated.immich.openapi_client.api_client import ApiClient, RequestSerialized
from generated.immich.openapi_client.api_response import ApiResponse
from generated.immich.openapi_client.rest import RESTResponseType
class MapApi:
"""NOTE: This class is auto generated by OpenAPI Generator
Ref: https://openapi-generator.tech
Do not edit the class manually.
"""
def __init__(self, api_client=None) -> None:
if api_client is None:
api_client = ApiClient.get_default()
self.api_client = api_client
@validate_call
def get_map_markers(
self,
file_created_after: Annotated[Optional[datetime], Field(description="Filter assets created after this date")] = None,
file_created_before: Annotated[Optional[datetime], Field(description="Filter assets created before this date")] = None,
is_archived: Annotated[Optional[StrictBool], Field(description="Filter by archived status")] = None,
is_favorite: Annotated[Optional[StrictBool], Field(description="Filter by favorite status")] = None,
with_partners: Annotated[Optional[StrictBool], Field(description="Include partner assets")] = None,
with_shared_albums: Annotated[Optional[StrictBool], Field(description="Include shared album assets")] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> List[MapMarkerResponseDto]:
"""Retrieve map markers
Retrieve a list of latitude and longitude coordinates for every asset with location data.
:param file_created_after: Filter assets created after this date
:type file_created_after: datetime
:param file_created_before: Filter assets created before this date
:type file_created_before: datetime
:param is_archived: Filter by archived status
:type is_archived: bool
:param is_favorite: Filter by favorite status
:type is_favorite: bool
:param with_partners: Include partner assets
:type with_partners: bool
:param with_shared_albums: Include shared album assets
:type with_shared_albums: bool
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._get_map_markers_serialize(
file_created_after=file_created_after,
file_created_before=file_created_before,
is_archived=is_archived,
is_favorite=is_favorite,
with_partners=with_partners,
with_shared_albums=with_shared_albums,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "List[MapMarkerResponseDto]",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
).data
@validate_call
def get_map_markers_with_http_info(
self,
file_created_after: Annotated[Optional[datetime], Field(description="Filter assets created after this date")] = None,
file_created_before: Annotated[Optional[datetime], Field(description="Filter assets created before this date")] = None,
is_archived: Annotated[Optional[StrictBool], Field(description="Filter by archived status")] = None,
is_favorite: Annotated[Optional[StrictBool], Field(description="Filter by favorite status")] = None,
with_partners: Annotated[Optional[StrictBool], Field(description="Include partner assets")] = None,
with_shared_albums: Annotated[Optional[StrictBool], Field(description="Include shared album assets")] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[List[MapMarkerResponseDto]]:
"""Retrieve map markers
Retrieve a list of latitude and longitude coordinates for every asset with location data.
:param file_created_after: Filter assets created after this date
:type file_created_after: datetime
:param file_created_before: Filter assets created before this date
:type file_created_before: datetime
:param is_archived: Filter by archived status
:type is_archived: bool
:param is_favorite: Filter by favorite status
:type is_favorite: bool
:param with_partners: Include partner assets
:type with_partners: bool
:param with_shared_albums: Include shared album assets
:type with_shared_albums: bool
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._get_map_markers_serialize(
file_created_after=file_created_after,
file_created_before=file_created_before,
is_archived=is_archived,
is_favorite=is_favorite,
with_partners=with_partners,
with_shared_albums=with_shared_albums,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "List[MapMarkerResponseDto]",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
)
@validate_call
def get_map_markers_without_preload_content(
self,
file_created_after: Annotated[Optional[datetime], Field(description="Filter assets created after this date")] = None,
file_created_before: Annotated[Optional[datetime], Field(description="Filter assets created before this date")] = None,
is_archived: Annotated[Optional[StrictBool], Field(description="Filter by archived status")] = None,
is_favorite: Annotated[Optional[StrictBool], Field(description="Filter by favorite status")] = None,
with_partners: Annotated[Optional[StrictBool], Field(description="Include partner assets")] = None,
with_shared_albums: Annotated[Optional[StrictBool], Field(description="Include shared album assets")] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
"""Retrieve map markers
Retrieve a list of latitude and longitude coordinates for every asset with location data.
:param file_created_after: Filter assets created after this date
:type file_created_after: datetime
:param file_created_before: Filter assets created before this date
:type file_created_before: datetime
:param is_archived: Filter by archived status
:type is_archived: bool
:param is_favorite: Filter by favorite status
:type is_favorite: bool
:param with_partners: Include partner assets
:type with_partners: bool
:param with_shared_albums: Include shared album assets
:type with_shared_albums: bool
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._get_map_markers_serialize(
file_created_after=file_created_after,
file_created_before=file_created_before,
is_archived=is_archived,
is_favorite=is_favorite,
with_partners=with_partners,
with_shared_albums=with_shared_albums,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "List[MapMarkerResponseDto]",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
return response_data.response
def _get_map_markers_serialize(
self,
file_created_after,
file_created_before,
is_archived,
is_favorite,
with_partners,
with_shared_albums,
_request_auth,
_content_type,
_headers,
_host_index,
) -> RequestSerialized:
_host = None
_collection_formats: Dict[str, str] = {
}
_path_params: Dict[str, str] = {}
_query_params: List[Tuple[str, str]] = []
_header_params: Dict[str, Optional[str]] = _headers or {}
_form_params: List[Tuple[str, str]] = []
_files: Dict[
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
] = {}
_body_params: Optional[bytes] = None
# process the path parameters
# process the query parameters
if file_created_after is not None:
if isinstance(file_created_after, datetime):
_query_params.append(
(
'fileCreatedAfter',
file_created_after.strftime(
self.api_client.configuration.datetime_format
)
)
)
else:
_query_params.append(('fileCreatedAfter', file_created_after))
if file_created_before is not None:
if isinstance(file_created_before, datetime):
_query_params.append(
(
'fileCreatedBefore',
file_created_before.strftime(
self.api_client.configuration.datetime_format
)
)
)
else:
_query_params.append(('fileCreatedBefore', file_created_before))
if is_archived is not None:
_query_params.append(('isArchived', is_archived))
if is_favorite is not None:
_query_params.append(('isFavorite', is_favorite))
if with_partners is not None:
_query_params.append(('withPartners', with_partners))
if with_shared_albums is not None:
_query_params.append(('withSharedAlbums', with_shared_albums))
# process the header parameters
# process the form parameters
# process the body parameter
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/json'
]
)
# authentication setting
_auth_settings: List[str] = [
'cookie',
'api_key',
'bearer'
]
return self.api_client.param_serialize(
method='GET',
resource_path='/map/markers',
path_params=_path_params,
query_params=_query_params,
header_params=_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
auth_settings=_auth_settings,
collection_formats=_collection_formats,
_host=_host,
_request_auth=_request_auth
)
@validate_call
def reverse_geocode(
self,
lat: Annotated[Union[StrictFloat, StrictInt], Field(description="Latitude (-90 to 90)")],
lon: Annotated[Union[StrictFloat, StrictInt], Field(description="Longitude (-180 to 180)")],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> List[MapReverseGeocodeResponseDto]:
"""Reverse geocode coordinates
Retrieve location information (e.g., city, country) for given latitude and longitude coordinates.
:param lat: Latitude (-90 to 90) (required)
:type lat: float
:param lon: Longitude (-180 to 180) (required)
:type lon: float
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._reverse_geocode_serialize(
lat=lat,
lon=lon,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "List[MapReverseGeocodeResponseDto]",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
).data
@validate_call
def reverse_geocode_with_http_info(
self,
lat: Annotated[Union[StrictFloat, StrictInt], Field(description="Latitude (-90 to 90)")],
lon: Annotated[Union[StrictFloat, StrictInt], Field(description="Longitude (-180 to 180)")],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[List[MapReverseGeocodeResponseDto]]:
"""Reverse geocode coordinates
Retrieve location information (e.g., city, country) for given latitude and longitude coordinates.
:param lat: Latitude (-90 to 90) (required)
:type lat: float
:param lon: Longitude (-180 to 180) (required)
:type lon: float
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._reverse_geocode_serialize(
lat=lat,
lon=lon,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "List[MapReverseGeocodeResponseDto]",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
)
@validate_call
def reverse_geocode_without_preload_content(
self,
lat: Annotated[Union[StrictFloat, StrictInt], Field(description="Latitude (-90 to 90)")],
lon: Annotated[Union[StrictFloat, StrictInt], Field(description="Longitude (-180 to 180)")],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
"""Reverse geocode coordinates
Retrieve location information (e.g., city, country) for given latitude and longitude coordinates.
:param lat: Latitude (-90 to 90) (required)
:type lat: float
:param lon: Longitude (-180 to 180) (required)
:type lon: float
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._reverse_geocode_serialize(
lat=lat,
lon=lon,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "List[MapReverseGeocodeResponseDto]",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
return response_data.response
def _reverse_geocode_serialize(
self,
lat,
lon,
_request_auth,
_content_type,
_headers,
_host_index,
) -> RequestSerialized:
_host = None
_collection_formats: Dict[str, str] = {
}
_path_params: Dict[str, str] = {}
_query_params: List[Tuple[str, str]] = []
_header_params: Dict[str, Optional[str]] = _headers or {}
_form_params: List[Tuple[str, str]] = []
_files: Dict[
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
] = {}
_body_params: Optional[bytes] = None
# process the path parameters
# process the query parameters
if lat is not None:
_query_params.append(('lat', lat))
if lon is not None:
_query_params.append(('lon', lon))
# process the header parameters
# process the form parameters
# process the body parameter
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/json'
]
)
# authentication setting
_auth_settings: List[str] = [
'cookie',
'api_key',
'bearer'
]
return self.api_client.param_serialize(
method='GET',
resource_path='/map/reverse-geocode',
path_params=_path_params,
query_params=_query_params,
header_params=_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
auth_settings=_auth_settings,
collection_formats=_collection_formats,
_host=_host,
_request_auth=_request_auth
)
generated/immich/openapi_client/api/memories_api.py
-2437
View File
File diff suppressed because it is too large Load Diff
generated/immich/openapi_client/api/notifications_api.py
-1709
View File
File diff suppressed because it is too large Load Diff
generated/immich/openapi_client/api/partners_api.py
-1395
View File
File diff suppressed because it is too large Load Diff
generated/immich/openapi_client/api/people_api.py
-3124
View File
File diff suppressed because it is too large Load Diff
generated/immich/openapi_client/api/search_api.py
+25 -26
View File
@@ -17,10 +17,9 @@ from typing import Any, Dict, List, Optional, Tuple, Union
from typing_extensions import Annotated
from datetime import datetime
from pydantic import Field, StrictBool, StrictStr
from pydantic import Field, StrictBool, StrictStr, field_validator
from typing import List, Optional
from typing_extensions import Annotated
from uuid import UUID
from generated.immich.openapi_client.models.asset_response_dto import AssetResponseDto
from generated.immich.openapi_client.models.asset_type_enum import AssetTypeEnum
from generated.immich.openapi_client.models.asset_visibility import AssetVisibility
@@ -1471,7 +1470,7 @@ class SearchApi:
@validate_call
def search_large_assets(
self,
album_ids: Annotated[Optional[List[UUID]], Field(description="Filter by album IDs")] = None,
album_ids: Annotated[Optional[List[Annotated[str, Field(strict=True)]]], Field(description="Filter by album IDs")] = None,
city: Annotated[Optional[StrictStr], Field(description="Filter by city name")] = None,
country: Annotated[Optional[StrictStr], Field(description="Filter by country name")] = None,
created_after: Annotated[Optional[datetime], Field(description="Filter by creation date (after)")] = None,
@@ -1482,16 +1481,16 @@ class SearchApi:
is_not_in_album: Annotated[Optional[StrictBool], Field(description="Filter assets not in any album")] = None,
is_offline: Annotated[Optional[StrictBool], Field(description="Filter by offline status")] = None,
lens_model: Annotated[Optional[StrictStr], Field(description="Filter by lens model")] = None,
library_id: Annotated[Optional[UUID], Field(description="Library ID to filter by")] = None,
library_id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Library ID to filter by")] = None,
make: Annotated[Optional[StrictStr], Field(description="Filter by camera make")] = None,
min_file_size: Annotated[Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=0)]], Field(description="Minimum file size in bytes")] = None,
model: Annotated[Optional[StrictStr], Field(description="Filter by camera model")] = None,
ocr: Annotated[Optional[StrictStr], Field(description="Filter by OCR text content")] = None,
person_ids: Annotated[Optional[List[UUID]], Field(description="Filter by person IDs")] = None,
person_ids: Annotated[Optional[List[Annotated[str, Field(strict=True)]]], Field(description="Filter by person IDs")] = None,
rating: Annotated[Optional[Annotated[int, Field(le=5, strict=True, ge=1)]], Field(description="Filter by rating [1-5], or null for unrated")] = None,
size: Annotated[Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]], Field(description="Number of results to return")] = None,
state: Annotated[Optional[StrictStr], Field(description="Filter by state/province name")] = None,
tag_ids: Annotated[Optional[List[UUID]], Field(description="Filter by tag IDs")] = None,
tag_ids: Annotated[Optional[List[Annotated[str, Field(strict=True)]]], Field(description="Filter by tag IDs")] = None,
taken_after: Annotated[Optional[datetime], Field(description="Filter by taken date (after)")] = None,
taken_before: Annotated[Optional[datetime], Field(description="Filter by taken date (before)")] = None,
trashed_after: Annotated[Optional[datetime], Field(description="Filter by trash date (after)")] = None,
@@ -1520,7 +1519,7 @@ class SearchApi:
Search for assets that are considered large based on specified criteria.
:param album_ids: Filter by album IDs
:type album_ids: List[UUID]
:type album_ids: List[str]
:param city: Filter by city name
:type city: str
:param country: Filter by country name
@@ -1542,7 +1541,7 @@ class SearchApi:
:param lens_model: Filter by lens model
:type lens_model: str
:param library_id: Library ID to filter by
:type library_id: UUID
:type library_id: str
:param make: Filter by camera make
:type make: str
:param min_file_size: Minimum file size in bytes
@@ -1552,7 +1551,7 @@ class SearchApi:
:param ocr: Filter by OCR text content
:type ocr: str
:param person_ids: Filter by person IDs
:type person_ids: List[UUID]
:type person_ids: List[str]
:param rating: Filter by rating [1-5], or null for unrated
:type rating: int
:param size: Number of results to return
@@ -1560,7 +1559,7 @@ class SearchApi:
:param state: Filter by state/province name
:type state: str
:param tag_ids: Filter by tag IDs
:type tag_ids: List[UUID]
:type tag_ids: List[str]
:param taken_after: Filter by taken date (after)
:type taken_after: datetime
:param taken_before: Filter by taken date (before)
@@ -1658,7 +1657,7 @@ class SearchApi:
@validate_call
def search_large_assets_with_http_info(
self,
album_ids: Annotated[Optional[List[UUID]], Field(description="Filter by album IDs")] = None,
album_ids: Annotated[Optional[List[Annotated[str, Field(strict=True)]]], Field(description="Filter by album IDs")] = None,
city: Annotated[Optional[StrictStr], Field(description="Filter by city name")] = None,
country: Annotated[Optional[StrictStr], Field(description="Filter by country name")] = None,
created_after: Annotated[Optional[datetime], Field(description="Filter by creation date (after)")] = None,
@@ -1669,16 +1668,16 @@ class SearchApi:
is_not_in_album: Annotated[Optional[StrictBool], Field(description="Filter assets not in any album")] = None,
is_offline: Annotated[Optional[StrictBool], Field(description="Filter by offline status")] = None,
lens_model: Annotated[Optional[StrictStr], Field(description="Filter by lens model")] = None,
library_id: Annotated[Optional[UUID], Field(description="Library ID to filter by")] = None,
library_id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Library ID to filter by")] = None,
make: Annotated[Optional[StrictStr], Field(description="Filter by camera make")] = None,
min_file_size: Annotated[Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=0)]], Field(description="Minimum file size in bytes")] = None,
model: Annotated[Optional[StrictStr], Field(description="Filter by camera model")] = None,
ocr: Annotated[Optional[StrictStr], Field(description="Filter by OCR text content")] = None,
person_ids: Annotated[Optional[List[UUID]], Field(description="Filter by person IDs")] = None,
person_ids: Annotated[Optional[List[Annotated[str, Field(strict=True)]]], Field(description="Filter by person IDs")] = None,
rating: Annotated[Optional[Annotated[int, Field(le=5, strict=True, ge=1)]], Field(description="Filter by rating [1-5], or null for unrated")] = None,
size: Annotated[Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]], Field(description="Number of results to return")] = None,
state: Annotated[Optional[StrictStr], Field(description="Filter by state/province name")] = None,
tag_ids: Annotated[Optional[List[UUID]], Field(description="Filter by tag IDs")] = None,
tag_ids: Annotated[Optional[List[Annotated[str, Field(strict=True)]]], Field(description="Filter by tag IDs")] = None,
taken_after: Annotated[Optional[datetime], Field(description="Filter by taken date (after)")] = None,
taken_before: Annotated[Optional[datetime], Field(description="Filter by taken date (before)")] = None,
trashed_after: Annotated[Optional[datetime], Field(description="Filter by trash date (after)")] = None,
@@ -1707,7 +1706,7 @@ class SearchApi:
Search for assets that are considered large based on specified criteria.
:param album_ids: Filter by album IDs
:type album_ids: List[UUID]
:type album_ids: List[str]
:param city: Filter by city name
:type city: str
:param country: Filter by country name
@@ -1729,7 +1728,7 @@ class SearchApi:
:param lens_model: Filter by lens model
:type lens_model: str
:param library_id: Library ID to filter by
:type library_id: UUID
:type library_id: str
:param make: Filter by camera make
:type make: str
:param min_file_size: Minimum file size in bytes
@@ -1739,7 +1738,7 @@ class SearchApi:
:param ocr: Filter by OCR text content
:type ocr: str
:param person_ids: Filter by person IDs
:type person_ids: List[UUID]
:type person_ids: List[str]
:param rating: Filter by rating [1-5], or null for unrated
:type rating: int
:param size: Number of results to return
@@ -1747,7 +1746,7 @@ class SearchApi:
:param state: Filter by state/province name
:type state: str
:param tag_ids: Filter by tag IDs
:type tag_ids: List[UUID]
:type tag_ids: List[str]
:param taken_after: Filter by taken date (after)
:type taken_after: datetime
:param taken_before: Filter by taken date (before)
@@ -1845,7 +1844,7 @@ class SearchApi:
@validate_call
def search_large_assets_without_preload_content(
self,
album_ids: Annotated[Optional[List[UUID]], Field(description="Filter by album IDs")] = None,
album_ids: Annotated[Optional[List[Annotated[str, Field(strict=True)]]], Field(description="Filter by album IDs")] = None,
city: Annotated[Optional[StrictStr], Field(description="Filter by city name")] = None,
country: Annotated[Optional[StrictStr], Field(description="Filter by country name")] = None,
created_after: Annotated[Optional[datetime], Field(description="Filter by creation date (after)")] = None,
@@ -1856,16 +1855,16 @@ class SearchApi:
is_not_in_album: Annotated[Optional[StrictBool], Field(description="Filter assets not in any album")] = None,
is_offline: Annotated[Optional[StrictBool], Field(description="Filter by offline status")] = None,
lens_model: Annotated[Optional[StrictStr], Field(description="Filter by lens model")] = None,
library_id: Annotated[Optional[UUID], Field(description="Library ID to filter by")] = None,
library_id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Library ID to filter by")] = None,
make: Annotated[Optional[StrictStr], Field(description="Filter by camera make")] = None,
min_file_size: Annotated[Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=0)]], Field(description="Minimum file size in bytes")] = None,
model: Annotated[Optional[StrictStr], Field(description="Filter by camera model")] = None,
ocr: Annotated[Optional[StrictStr], Field(description="Filter by OCR text content")] = None,
person_ids: Annotated[Optional[List[UUID]], Field(description="Filter by person IDs")] = None,
person_ids: Annotated[Optional[List[Annotated[str, Field(strict=True)]]], Field(description="Filter by person IDs")] = None,
rating: Annotated[Optional[Annotated[int, Field(le=5, strict=True, ge=1)]], Field(description="Filter by rating [1-5], or null for unrated")] = None,
size: Annotated[Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]], Field(description="Number of results to return")] = None,
state: Annotated[Optional[StrictStr], Field(description="Filter by state/province name")] = None,
tag_ids: Annotated[Optional[List[UUID]], Field(description="Filter by tag IDs")] = None,
tag_ids: Annotated[Optional[List[Annotated[str, Field(strict=True)]]], Field(description="Filter by tag IDs")] = None,
taken_after: Annotated[Optional[datetime], Field(description="Filter by taken date (after)")] = None,
taken_before: Annotated[Optional[datetime], Field(description="Filter by taken date (before)")] = None,
trashed_after: Annotated[Optional[datetime], Field(description="Filter by trash date (after)")] = None,
@@ -1894,7 +1893,7 @@ class SearchApi:
Search for assets that are considered large based on specified criteria.
:param album_ids: Filter by album IDs
:type album_ids: List[UUID]
:type album_ids: List[str]
:param city: Filter by city name
:type city: str
:param country: Filter by country name
@@ -1916,7 +1915,7 @@ class SearchApi:
:param lens_model: Filter by lens model
:type lens_model: str
:param library_id: Library ID to filter by
:type library_id: UUID
:type library_id: str
:param make: Filter by camera make
:type make: str
:param min_file_size: Minimum file size in bytes
@@ -1926,7 +1925,7 @@ class SearchApi:
:param ocr: Filter by OCR text content
:type ocr: str
:param person_ids: Filter by person IDs
:type person_ids: List[UUID]
:type person_ids: List[str]
:param rating: Filter by rating [1-5], or null for unrated
:type rating: int
:param size: Number of results to return
@@ -1934,7 +1933,7 @@ class SearchApi:
:param state: Filter by state/province name
:type state: str
:param tag_ids: Filter by tag IDs
:type tag_ids: List[UUID]
:type tag_ids: List[str]
:param taken_after: Filter by taken date (after)
:type taken_after: datetime
:param taken_before: Filter by taken date (before)
generated/immich/openapi_client/api/server_api.py
-3527
View File
File diff suppressed because it is too large Load Diff
generated/immich/openapi_client/api/sessions_api.py
-1612
View File
File diff suppressed because it is too large Load Diff
generated/immich/openapi_client/api/shared_links_api.py
-2587
View File
File diff suppressed because it is too large Load Diff
generated/immich/openapi_client/api/stacks_api.py
-1937
View File
File diff suppressed because it is too large Load Diff
generated/immich/openapi_client/api/sync_api.py
-1095
View File
File diff suppressed because it is too large Load Diff
generated/immich/openapi_client/api/system_config_api.py
-1057
View File
File diff suppressed because it is too large Load Diff
generated/immich/openapi_client/api/system_metadata_api.py
-1051
View File
File diff suppressed because it is too large Load Diff
generated/immich/openapi_client/api/tags_api.py
-2516
View File
File diff suppressed because it is too large Load Diff
generated/immich/openapi_client/api/timeline_api.py
-1067
View File
File diff suppressed because it is too large Load Diff
generated/immich/openapi_client/api/trash_api.py
-809
View File
@@ -1,809 +0,0 @@
# coding: utf-8
"""
Immich
Immich API
The version of the OpenAPI document: 3.0.1
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import warnings
from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
from typing import Any, Dict, List, Optional, Tuple, Union
from typing_extensions import Annotated
from generated.immich.openapi_client.models.bulk_ids_dto import BulkIdsDto
from generated.immich.openapi_client.models.trash_response_dto import TrashResponseDto
from generated.immich.openapi_client.api_client import ApiClient, RequestSerialized
from generated.immich.openapi_client.api_response import ApiResponse
from generated.immich.openapi_client.rest import RESTResponseType
class TrashApi:
"""NOTE: This class is auto generated by OpenAPI Generator
Ref: https://openapi-generator.tech
Do not edit the class manually.
"""
def __init__(self, api_client=None) -> None:
if api_client is None:
api_client = ApiClient.get_default()
self.api_client = api_client
@validate_call
def empty_trash(
self,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> TrashResponseDto:
"""Empty trash
Permanently delete all items in the trash.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._empty_trash_serialize(
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "TrashResponseDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
).data
@validate_call
def empty_trash_with_http_info(
self,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[TrashResponseDto]:
"""Empty trash
Permanently delete all items in the trash.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._empty_trash_serialize(
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "TrashResponseDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
)
@validate_call
def empty_trash_without_preload_content(
self,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
"""Empty trash
Permanently delete all items in the trash.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._empty_trash_serialize(
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "TrashResponseDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
return response_data.response
def _empty_trash_serialize(
self,
_request_auth,
_content_type,
_headers,
_host_index,
) -> RequestSerialized:
_host = None
_collection_formats: Dict[str, str] = {
}
_path_params: Dict[str, str] = {}
_query_params: List[Tuple[str, str]] = []
_header_params: Dict[str, Optional[str]] = _headers or {}
_form_params: List[Tuple[str, str]] = []
_files: Dict[
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
] = {}
_body_params: Optional[bytes] = None
# process the path parameters
# process the query parameters
# process the header parameters
# process the form parameters
# process the body parameter
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/json'
]
)
# authentication setting
_auth_settings: List[str] = [
'cookie',
'api_key',
'bearer'
]
return self.api_client.param_serialize(
method='POST',
resource_path='/trash/empty',
path_params=_path_params,
query_params=_query_params,
header_params=_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
auth_settings=_auth_settings,
collection_formats=_collection_formats,
_host=_host,
_request_auth=_request_auth
)
@validate_call
def restore_assets(
self,
bulk_ids_dto: BulkIdsDto,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> TrashResponseDto:
"""Restore assets
Restore specific assets from the trash.
:param bulk_ids_dto: (required)
:type bulk_ids_dto: BulkIdsDto
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._restore_assets_serialize(
bulk_ids_dto=bulk_ids_dto,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "TrashResponseDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
).data
@validate_call
def restore_assets_with_http_info(
self,
bulk_ids_dto: BulkIdsDto,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[TrashResponseDto]:
"""Restore assets
Restore specific assets from the trash.
:param bulk_ids_dto: (required)
:type bulk_ids_dto: BulkIdsDto
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._restore_assets_serialize(
bulk_ids_dto=bulk_ids_dto,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "TrashResponseDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
)
@validate_call
def restore_assets_without_preload_content(
self,
bulk_ids_dto: BulkIdsDto,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
"""Restore assets
Restore specific assets from the trash.
:param bulk_ids_dto: (required)
:type bulk_ids_dto: BulkIdsDto
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._restore_assets_serialize(
bulk_ids_dto=bulk_ids_dto,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "TrashResponseDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
return response_data.response
def _restore_assets_serialize(
self,
bulk_ids_dto,
_request_auth,
_content_type,
_headers,
_host_index,
) -> RequestSerialized:
_host = None
_collection_formats: Dict[str, str] = {
}
_path_params: Dict[str, str] = {}
_query_params: List[Tuple[str, str]] = []
_header_params: Dict[str, Optional[str]] = _headers or {}
_form_params: List[Tuple[str, str]] = []
_files: Dict[
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
] = {}
_body_params: Optional[bytes] = None
# process the path parameters
# process the query parameters
# process the header parameters
# process the form parameters
# process the body parameter
if bulk_ids_dto is not None:
_body_params = bulk_ids_dto
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/json'
]
)
# set the HTTP header `Content-Type`
if _content_type:
_header_params['Content-Type'] = _content_type
else:
_default_content_type = (
self.api_client.select_header_content_type(
[
'application/json'
]
)
)
if _default_content_type is not None:
_header_params['Content-Type'] = _default_content_type
# authentication setting
_auth_settings: List[str] = [
'cookie',
'api_key',
'bearer'
]
return self.api_client.param_serialize(
method='POST',
resource_path='/trash/restore/assets',
path_params=_path_params,
query_params=_query_params,
header_params=_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
auth_settings=_auth_settings,
collection_formats=_collection_formats,
_host=_host,
_request_auth=_request_auth
)
@validate_call
def restore_trash(
self,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> TrashResponseDto:
"""Restore trash
Restore all items in the trash.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._restore_trash_serialize(
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "TrashResponseDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
).data
@validate_call
def restore_trash_with_http_info(
self,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[TrashResponseDto]:
"""Restore trash
Restore all items in the trash.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._restore_trash_serialize(
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "TrashResponseDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
)
@validate_call
def restore_trash_without_preload_content(
self,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
"""Restore trash
Restore all items in the trash.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._restore_trash_serialize(
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "TrashResponseDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
return response_data.response
def _restore_trash_serialize(
self,
_request_auth,
_content_type,
_headers,
_host_index,
) -> RequestSerialized:
_host = None
_collection_formats: Dict[str, str] = {
}
_path_params: Dict[str, str] = {}
_query_params: List[Tuple[str, str]] = []
_header_params: Dict[str, Optional[str]] = _headers or {}
_form_params: List[Tuple[str, str]] = []
_files: Dict[
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
] = {}
_body_params: Optional[bytes] = None
# process the path parameters
# process the query parameters
# process the header parameters
# process the form parameters
# process the body parameter
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/json'
]
)
# authentication setting
_auth_settings: List[str] = [
'cookie',
'api_key',
'bearer'
]
return self.api_client.param_serialize(
method='POST',
resource_path='/trash/restore',
path_params=_path_params,
query_params=_query_params,
header_params=_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
auth_settings=_auth_settings,
collection_formats=_collection_formats,
_host=_host,
_request_auth=_request_auth
)
generated/immich/openapi_client/api/users_admin_api.py
-3186
View File
File diff suppressed because it is too large Load Diff
generated/immich/openapi_client/api/users_api.py
-4244
View File
File diff suppressed because it is too large Load Diff