helpy4/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich synced 2025-11-14 17:36:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: endpoint descriptions (#23813)

Browse source
This commit is contained in:
Jason Rasmussen 2025-11-11 17:01:14 -05:00 • committed by GitHub
parent 896665bca9
commit edde0f93ae
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
76 changed files with 4193 additions and 1663 deletions
Download patch file Download diff file Expand all files Collapse all files

2
mobile/lib/repositories/folder_api.repository.dart
View file

@ -8,7 +8,7 @@ import 'package:openapi/api.dart';
final folderApiRepositoryProvider = Provider((ref) => FolderApiRepository(ref.watch(apiServiceProvider).viewApi));
class FolderApiRepository extends ApiRepository {
final ViewApi _api;
final ViewsApi _api;
final Logger _log = Logger("FolderApiRepository");
FolderApiRepository(this._api);

8
mobile/lib/services/api.service.dart
View file

@ -17,7 +17,7 @@ class ApiService implements Authentication {
late UsersApi usersApi;
late AuthenticationApi authenticationApi;
late OAuthApi oAuthApi;
late AuthenticationApi oAuthApi;
late AlbumsApi albumsApi;
late AssetsApi assetsApi;
late SearchApi searchApi;
@ -32,7 +32,7 @@ class ApiService implements Authentication {
late DownloadApi downloadApi;
late TrashApi trashApi;
late StacksApi stacksApi;
late ViewApi viewApi;
late ViewsApi viewApi;
late MemoriesApi memoriesApi;
late SessionsApi sessionsApi;
@ -56,7 +56,7 @@ class ApiService implements Authentication {
}
usersApi = UsersApi(_apiClient);
authenticationApi = AuthenticationApi(_apiClient);
oAuthApi = OAuthApi(_apiClient);
oAuthApi = AuthenticationApi(_apiClient);
albumsApi = AlbumsApi(_apiClient);
assetsApi = AssetsApi(_apiClient);
serverInfoApi = ServerApi(_apiClient);
@ -71,7 +71,7 @@ class ApiService implements Authentication {
downloadApi = DownloadApi(_apiClient);
trashApi = TrashApi(_apiClient);
stacksApi = StacksApi(_apiClient);
viewApi = ViewApi(_apiClient);
viewApi = ViewsApi(_apiClient);
memoriesApi = MemoriesApi(_apiClient);
sessionsApi = SessionsApi(_apiClient);
}

441
mobile/openapi/README.md generated
View file

@ -73,225 +73,228 @@ All URIs are relative to */api*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*APIKeysApi* | [**createApiKey**](doc//APIKeysApi.md#createapikey) | **POST** /api-keys |
*APIKeysApi* | [**deleteApiKey**](doc//APIKeysApi.md#deleteapikey) | **DELETE** /api-keys/{id} |
*APIKeysApi* | [**getApiKey**](doc//APIKeysApi.md#getapikey) | **GET** /api-keys/{id} |
*APIKeysApi* | [**getApiKeys**](doc//APIKeysApi.md#getapikeys) | **GET** /api-keys |
*APIKeysApi* | [**getMyApiKey**](doc//APIKeysApi.md#getmyapikey) | **GET** /api-keys/me |
*APIKeysApi* | [**updateApiKey**](doc//APIKeysApi.md#updateapikey) | **PUT** /api-keys/{id} |
*ActivitiesApi* | [**createActivity**](doc//ActivitiesApi.md#createactivity) | **POST** /activities |
*ActivitiesApi* | [**deleteActivity**](doc//ActivitiesApi.md#deleteactivity) | **DELETE** /activities/{id} |
*ActivitiesApi* | [**getActivities**](doc//ActivitiesApi.md#getactivities) | **GET** /activities |
*ActivitiesApi* | [**getActivityStatistics**](doc//ActivitiesApi.md#getactivitystatistics) | **GET** /activities/statistics |
*AlbumsApi* | [**addAssetsToAlbum**](doc//AlbumsApi.md#addassetstoalbum) | **PUT** /albums/{id}/assets |
*AlbumsApi* | [**addAssetsToAlbums**](doc//AlbumsApi.md#addassetstoalbums) | **PUT** /albums/assets |
*AlbumsApi* | [**addUsersToAlbum**](doc//AlbumsApi.md#adduserstoalbum) | **PUT** /albums/{id}/users |
*AlbumsApi* | [**createAlbum**](doc//AlbumsApi.md#createalbum) | **POST** /albums |
*AlbumsApi* | [**deleteAlbum**](doc//AlbumsApi.md#deletealbum) | **DELETE** /albums/{id} |
*AlbumsApi* | [**getAlbumInfo**](doc//AlbumsApi.md#getalbuminfo) | **GET** /albums/{id} |
*AlbumsApi* | [**getAlbumStatistics**](doc//AlbumsApi.md#getalbumstatistics) | **GET** /albums/statistics |
*AlbumsApi* | [**getAllAlbums**](doc//AlbumsApi.md#getallalbums) | **GET** /albums |
*AlbumsApi* | [**removeAssetFromAlbum**](doc//AlbumsApi.md#removeassetfromalbum) | **DELETE** /albums/{id}/assets |
*AlbumsApi* | [**removeUserFromAlbum**](doc//AlbumsApi.md#removeuserfromalbum) | **DELETE** /albums/{id}/user/{userId} |
*AlbumsApi* | [**updateAlbumInfo**](doc//AlbumsApi.md#updatealbuminfo) | **PATCH** /albums/{id} |
*AlbumsApi* | [**updateAlbumUser**](doc//AlbumsApi.md#updatealbumuser) | **PUT** /albums/{id}/user/{userId} |
*AssetsApi* | [**checkBulkUpload**](doc//AssetsApi.md#checkbulkupload) | **POST** /assets/bulk-upload-check | checkBulkUpload
*AssetsApi* | [**checkExistingAssets**](doc//AssetsApi.md#checkexistingassets) | **POST** /assets/exist | checkExistingAssets
*AssetsApi* | [**copyAsset**](doc//AssetsApi.md#copyasset) | **PUT** /assets/copy |
*AssetsApi* | [**deleteAssetMetadata**](doc//AssetsApi.md#deleteassetmetadata) | **DELETE** /assets/{id}/metadata/{key} |
*AssetsApi* | [**deleteAssets**](doc//AssetsApi.md#deleteassets) | **DELETE** /assets |
*AssetsApi* | [**downloadAsset**](doc//AssetsApi.md#downloadasset) | **GET** /assets/{id}/original |
*AssetsApi* | [**getAllUserAssetsByDeviceId**](doc//AssetsApi.md#getalluserassetsbydeviceid) | **GET** /assets/device/{deviceId} | getAllUserAssetsByDeviceId
*AssetsApi* | [**getAssetInfo**](doc//AssetsApi.md#getassetinfo) | **GET** /assets/{id} |
*AssetsApi* | [**getAssetMetadata**](doc//AssetsApi.md#getassetmetadata) | **GET** /assets/{id}/metadata |
*AssetsApi* | [**getAssetMetadataByKey**](doc//AssetsApi.md#getassetmetadatabykey) | **GET** /assets/{id}/metadata/{key} |
*AssetsApi* | [**getAssetOcr**](doc//AssetsApi.md#getassetocr) | **GET** /assets/{id}/ocr |
*AssetsApi* | [**getAssetStatistics**](doc//AssetsApi.md#getassetstatistics) | **GET** /assets/statistics |
*AssetsApi* | [**getRandom**](doc//AssetsApi.md#getrandom) | **GET** /assets/random |
*AssetsApi* | [**playAssetVideo**](doc//AssetsApi.md#playassetvideo) | **GET** /assets/{id}/video/playback |
*AssetsApi* | [**replaceAsset**](doc//AssetsApi.md#replaceasset) | **PUT** /assets/{id}/original | Replace the asset with new file, without changing its id
*AssetsApi* | [**runAssetJobs**](doc//AssetsApi.md#runassetjobs) | **POST** /assets/jobs |
*AssetsApi* | [**updateAsset**](doc//AssetsApi.md#updateasset) | **PUT** /assets/{id} |
*AssetsApi* | [**updateAssetMetadata**](doc//AssetsApi.md#updateassetmetadata) | **PUT** /assets/{id}/metadata |
*AssetsApi* | [**updateAssets**](doc//AssetsApi.md#updateassets) | **PUT** /assets |
*AssetsApi* | [**uploadAsset**](doc//AssetsApi.md#uploadasset) | **POST** /assets |
*AssetsApi* | [**viewAsset**](doc//AssetsApi.md#viewasset) | **GET** /assets/{id}/thumbnail |
*AuthAdminApi* | [**unlinkAllOAuthAccountsAdmin**](doc//AuthAdminApi.md#unlinkalloauthaccountsadmin) | **POST** /admin/auth/unlink-all |
*AuthenticationApi* | [**changePassword**](doc//AuthenticationApi.md#changepassword) | **POST** /auth/change-password |
*AuthenticationApi* | [**changePinCode**](doc//AuthenticationApi.md#changepincode) | **PUT** /auth/pin-code |
*AuthenticationApi* | [**getAuthStatus**](doc//AuthenticationApi.md#getauthstatus) | **GET** /auth/status |
*AuthenticationApi* | [**lockAuthSession**](doc//AuthenticationApi.md#lockauthsession) | **POST** /auth/session/lock |
*AuthenticationApi* | [**login**](doc//AuthenticationApi.md#login) | **POST** /auth/login |
*AuthenticationApi* | [**logout**](doc//AuthenticationApi.md#logout) | **POST** /auth/logout |
*AuthenticationApi* | [**resetPinCode**](doc//AuthenticationApi.md#resetpincode) | **DELETE** /auth/pin-code |
*AuthenticationApi* | [**setupPinCode**](doc//AuthenticationApi.md#setuppincode) | **POST** /auth/pin-code |
*AuthenticationApi* | [**signUpAdmin**](doc//AuthenticationApi.md#signupadmin) | **POST** /auth/admin-sign-up |
*AuthenticationApi* | [**unlockAuthSession**](doc//AuthenticationApi.md#unlockauthsession) | **POST** /auth/session/unlock |
*AuthenticationApi* | [**validateAccessToken**](doc//AuthenticationApi.md#validateaccesstoken) | **POST** /auth/validateToken |
*DeprecatedApi* | [**createPartnerDeprecated**](doc//DeprecatedApi.md#createpartnerdeprecated) | **POST** /partners/{id} |
*DeprecatedApi* | [**getRandom**](doc//DeprecatedApi.md#getrandom) | **GET** /assets/random |
*DeprecatedApi* | [**replaceAsset**](doc//DeprecatedApi.md#replaceasset) | **PUT** /assets/{id}/original | Replace the asset with new file, without changing its id
*DownloadApi* | [**downloadArchive**](doc//DownloadApi.md#downloadarchive) | **POST** /download/archive |
*DownloadApi* | [**getDownloadInfo**](doc//DownloadApi.md#getdownloadinfo) | **POST** /download/info |
*DuplicatesApi* | [**deleteDuplicate**](doc//DuplicatesApi.md#deleteduplicate) | **DELETE** /duplicates/{id} |
*DuplicatesApi* | [**deleteDuplicates**](doc//DuplicatesApi.md#deleteduplicates) | **DELETE** /duplicates |
*DuplicatesApi* | [**getAssetDuplicates**](doc//DuplicatesApi.md#getassetduplicates) | **GET** /duplicates |
*FacesApi* | [**createFace**](doc//FacesApi.md#createface) | **POST** /faces |
*FacesApi* | [**deleteFace**](doc//FacesApi.md#deleteface) | **DELETE** /faces/{id} |
*FacesApi* | [**getFaces**](doc//FacesApi.md#getfaces) | **GET** /faces |
*FacesApi* | [**reassignFacesById**](doc//FacesApi.md#reassignfacesbyid) | **PUT** /faces/{id} |
*JobsApi* | [**createJob**](doc//JobsApi.md#createjob) | **POST** /jobs |
*JobsApi* | [**getAllJobsStatus**](doc//JobsApi.md#getalljobsstatus) | **GET** /jobs |
*JobsApi* | [**sendJobCommand**](doc//JobsApi.md#sendjobcommand) | **PUT** /jobs/{id} |
*LibrariesApi* | [**createLibrary**](doc//LibrariesApi.md#createlibrary) | **POST** /libraries |
*LibrariesApi* | [**deleteLibrary**](doc//LibrariesApi.md#deletelibrary) | **DELETE** /libraries/{id} |
*LibrariesApi* | [**getAllLibraries**](doc//LibrariesApi.md#getalllibraries) | **GET** /libraries |
*LibrariesApi* | [**getLibrary**](doc//LibrariesApi.md#getlibrary) | **GET** /libraries/{id} |
*LibrariesApi* | [**getLibraryStatistics**](doc//LibrariesApi.md#getlibrarystatistics) | **GET** /libraries/{id}/statistics |
*LibrariesApi* | [**scanLibrary**](doc//LibrariesApi.md#scanlibrary) | **POST** /libraries/{id}/scan |
*LibrariesApi* | [**updateLibrary**](doc//LibrariesApi.md#updatelibrary) | **PUT** /libraries/{id} |
*LibrariesApi* | [**validate**](doc//LibrariesApi.md#validate) | **POST** /libraries/{id}/validate |
*MapApi* | [**getMapMarkers**](doc//MapApi.md#getmapmarkers) | **GET** /map/markers |
*MapApi* | [**reverseGeocode**](doc//MapApi.md#reversegeocode) | **GET** /map/reverse-geocode |
*MemoriesApi* | [**addMemoryAssets**](doc//MemoriesApi.md#addmemoryassets) | **PUT** /memories/{id}/assets |
*MemoriesApi* | [**createMemory**](doc//MemoriesApi.md#creatememory) | **POST** /memories |
*MemoriesApi* | [**deleteMemory**](doc//MemoriesApi.md#deletememory) | **DELETE** /memories/{id} |
*MemoriesApi* | [**getMemory**](doc//MemoriesApi.md#getmemory) | **GET** /memories/{id} |
*MemoriesApi* | [**memoriesStatistics**](doc//MemoriesApi.md#memoriesstatistics) | **GET** /memories/statistics |
*MemoriesApi* | [**removeMemoryAssets**](doc//MemoriesApi.md#removememoryassets) | **DELETE** /memories/{id}/assets |
*MemoriesApi* | [**searchMemories**](doc//MemoriesApi.md#searchmemories) | **GET** /memories |
*MemoriesApi* | [**updateMemory**](doc//MemoriesApi.md#updatememory) | **PUT** /memories/{id} |
*NotificationsApi* | [**deleteNotification**](doc//NotificationsApi.md#deletenotification) | **DELETE** /notifications/{id} |
*NotificationsApi* | [**deleteNotifications**](doc//NotificationsApi.md#deletenotifications) | **DELETE** /notifications |
*NotificationsApi* | [**getNotification**](doc//NotificationsApi.md#getnotification) | **GET** /notifications/{id} |
*NotificationsApi* | [**getNotifications**](doc//NotificationsApi.md#getnotifications) | **GET** /notifications |
*NotificationsApi* | [**updateNotification**](doc//NotificationsApi.md#updatenotification) | **PUT** /notifications/{id} |
*NotificationsApi* | [**updateNotifications**](doc//NotificationsApi.md#updatenotifications) | **PUT** /notifications |
*NotificationsAdminApi* | [**createNotification**](doc//NotificationsAdminApi.md#createnotification) | **POST** /admin/notifications |
*NotificationsAdminApi* | [**getNotificationTemplateAdmin**](doc//NotificationsAdminApi.md#getnotificationtemplateadmin) | **POST** /admin/notifications/templates/{name} |
*NotificationsAdminApi* | [**sendTestEmailAdmin**](doc//NotificationsAdminApi.md#sendtestemailadmin) | **POST** /admin/notifications/test-email |
*OAuthApi* | [**finishOAuth**](doc//OAuthApi.md#finishoauth) | **POST** /oauth/callback |
*OAuthApi* | [**linkOAuthAccount**](doc//OAuthApi.md#linkoauthaccount) | **POST** /oauth/link |
*OAuthApi* | [**redirectOAuthToMobile**](doc//OAuthApi.md#redirectoauthtomobile) | **GET** /oauth/mobile-redirect |
*OAuthApi* | [**startOAuth**](doc//OAuthApi.md#startoauth) | **POST** /oauth/authorize |
*OAuthApi* | [**unlinkOAuthAccount**](doc//OAuthApi.md#unlinkoauthaccount) | **POST** /oauth/unlink |
*PartnersApi* | [**createPartner**](doc//PartnersApi.md#createpartner) | **POST** /partners |
*PartnersApi* | [**createPartnerDeprecated**](doc//PartnersApi.md#createpartnerdeprecated) | **POST** /partners/{id} |
*PartnersApi* | [**getPartners**](doc//PartnersApi.md#getpartners) | **GET** /partners |
*PartnersApi* | [**removePartner**](doc//PartnersApi.md#removepartner) | **DELETE** /partners/{id} |
*PartnersApi* | [**updatePartner**](doc//PartnersApi.md#updatepartner) | **PUT** /partners/{id} |
*PeopleApi* | [**createPerson**](doc//PeopleApi.md#createperson) | **POST** /people |
*PeopleApi* | [**deletePeople**](doc//PeopleApi.md#deletepeople) | **DELETE** /people |
*PeopleApi* | [**deletePerson**](doc//PeopleApi.md#deleteperson) | **DELETE** /people/{id} |
*PeopleApi* | [**getAllPeople**](doc//PeopleApi.md#getallpeople) | **GET** /people |
*PeopleApi* | [**getPerson**](doc//PeopleApi.md#getperson) | **GET** /people/{id} |
*PeopleApi* | [**getPersonStatistics**](doc//PeopleApi.md#getpersonstatistics) | **GET** /people/{id}/statistics |
*PeopleApi* | [**getPersonThumbnail**](doc//PeopleApi.md#getpersonthumbnail) | **GET** /people/{id}/thumbnail |
*PeopleApi* | [**mergePerson**](doc//PeopleApi.md#mergeperson) | **POST** /people/{id}/merge |
*PeopleApi* | [**reassignFaces**](doc//PeopleApi.md#reassignfaces) | **PUT** /people/{id}/reassign |
*PeopleApi* | [**updatePeople**](doc//PeopleApi.md#updatepeople) | **PUT** /people |
*PeopleApi* | [**updatePerson**](doc//PeopleApi.md#updateperson) | **PUT** /people/{id} |
*SearchApi* | [**getAssetsByCity**](doc//SearchApi.md#getassetsbycity) | **GET** /search/cities |
*SearchApi* | [**getExploreData**](doc//SearchApi.md#getexploredata) | **GET** /search/explore |
*SearchApi* | [**getSearchSuggestions**](doc//SearchApi.md#getsearchsuggestions) | **GET** /search/suggestions |
*SearchApi* | [**searchAssetStatistics**](doc//SearchApi.md#searchassetstatistics) | **POST** /search/statistics |
*SearchApi* | [**searchAssets**](doc//SearchApi.md#searchassets) | **POST** /search/metadata |
*SearchApi* | [**searchLargeAssets**](doc//SearchApi.md#searchlargeassets) | **POST** /search/large-assets |
*SearchApi* | [**searchPerson**](doc//SearchApi.md#searchperson) | **GET** /search/person |
*SearchApi* | [**searchPlaces**](doc//SearchApi.md#searchplaces) | **GET** /search/places |
*SearchApi* | [**searchRandom**](doc//SearchApi.md#searchrandom) | **POST** /search/random |
*SearchApi* | [**searchSmart**](doc//SearchApi.md#searchsmart) | **POST** /search/smart |
*ServerApi* | [**deleteServerLicense**](doc//ServerApi.md#deleteserverlicense) | **DELETE** /server/license |
*ServerApi* | [**getAboutInfo**](doc//ServerApi.md#getaboutinfo) | **GET** /server/about |
*ServerApi* | [**getApkLinks**](doc//ServerApi.md#getapklinks) | **GET** /server/apk-links |
*ServerApi* | [**getServerConfig**](doc//ServerApi.md#getserverconfig) | **GET** /server/config |
*ServerApi* | [**getServerFeatures**](doc//ServerApi.md#getserverfeatures) | **GET** /server/features |
*ServerApi* | [**getServerLicense**](doc//ServerApi.md#getserverlicense) | **GET** /server/license |
*ServerApi* | [**getServerStatistics**](doc//ServerApi.md#getserverstatistics) | **GET** /server/statistics |
*ServerApi* | [**getServerVersion**](doc//ServerApi.md#getserverversion) | **GET** /server/version |
*ServerApi* | [**getStorage**](doc//ServerApi.md#getstorage) | **GET** /server/storage |
*ServerApi* | [**getSupportedMediaTypes**](doc//ServerApi.md#getsupportedmediatypes) | **GET** /server/media-types |
*ServerApi* | [**getTheme**](doc//ServerApi.md#gettheme) | **GET** /server/theme |
*ServerApi* | [**getVersionCheck**](doc//ServerApi.md#getversioncheck) | **GET** /server/version-check |
*ServerApi* | [**getVersionHistory**](doc//ServerApi.md#getversionhistory) | **GET** /server/version-history |
*ServerApi* | [**pingServer**](doc//ServerApi.md#pingserver) | **GET** /server/ping |
*ServerApi* | [**setServerLicense**](doc//ServerApi.md#setserverlicense) | **PUT** /server/license |
*SessionsApi* | [**createSession**](doc//SessionsApi.md#createsession) | **POST** /sessions |
*SessionsApi* | [**deleteAllSessions**](doc//SessionsApi.md#deleteallsessions) | **DELETE** /sessions |
*SessionsApi* | [**deleteSession**](doc//SessionsApi.md#deletesession) | **DELETE** /sessions/{id} |
*SessionsApi* | [**getSessions**](doc//SessionsApi.md#getsessions) | **GET** /sessions |
*SessionsApi* | [**lockSession**](doc//SessionsApi.md#locksession) | **POST** /sessions/{id}/lock |
*SessionsApi* | [**updateSession**](doc//SessionsApi.md#updatesession) | **PUT** /sessions/{id} |
*SharedLinksApi* | [**addSharedLinkAssets**](doc//SharedLinksApi.md#addsharedlinkassets) | **PUT** /shared-links/{id}/assets |
*SharedLinksApi* | [**createSharedLink**](doc//SharedLinksApi.md#createsharedlink) | **POST** /shared-links |
*SharedLinksApi* | [**getAllSharedLinks**](doc//SharedLinksApi.md#getallsharedlinks) | **GET** /shared-links |
*SharedLinksApi* | [**getMySharedLink**](doc//SharedLinksApi.md#getmysharedlink) | **GET** /shared-links/me |
*SharedLinksApi* | [**getSharedLinkById**](doc//SharedLinksApi.md#getsharedlinkbyid) | **GET** /shared-links/{id} |
*SharedLinksApi* | [**removeSharedLink**](doc//SharedLinksApi.md#removesharedlink) | **DELETE** /shared-links/{id} |
*SharedLinksApi* | [**removeSharedLinkAssets**](doc//SharedLinksApi.md#removesharedlinkassets) | **DELETE** /shared-links/{id}/assets |
*SharedLinksApi* | [**updateSharedLink**](doc//SharedLinksApi.md#updatesharedlink) | **PATCH** /shared-links/{id} |
*StacksApi* | [**createStack**](doc//StacksApi.md#createstack) | **POST** /stacks |
*StacksApi* | [**deleteStack**](doc//StacksApi.md#deletestack) | **DELETE** /stacks/{id} |
*StacksApi* | [**deleteStacks**](doc//StacksApi.md#deletestacks) | **DELETE** /stacks |
*StacksApi* | [**getStack**](doc//StacksApi.md#getstack) | **GET** /stacks/{id} |
*StacksApi* | [**removeAssetFromStack**](doc//StacksApi.md#removeassetfromstack) | **DELETE** /stacks/{id}/assets/{assetId} |
*StacksApi* | [**searchStacks**](doc//StacksApi.md#searchstacks) | **GET** /stacks |
*StacksApi* | [**updateStack**](doc//StacksApi.md#updatestack) | **PUT** /stacks/{id} |
*SyncApi* | [**deleteSyncAck**](doc//SyncApi.md#deletesyncack) | **DELETE** /sync/ack |
*SyncApi* | [**getDeltaSync**](doc//SyncApi.md#getdeltasync) | **POST** /sync/delta-sync |
*SyncApi* | [**getFullSyncForUser**](doc//SyncApi.md#getfullsyncforuser) | **POST** /sync/full-sync |
*SyncApi* | [**getSyncAck**](doc//SyncApi.md#getsyncack) | **GET** /sync/ack |
*SyncApi* | [**getSyncStream**](doc//SyncApi.md#getsyncstream) | **POST** /sync/stream |
*SyncApi* | [**sendSyncAck**](doc//SyncApi.md#sendsyncack) | **POST** /sync/ack |
*SystemConfigApi* | [**getConfig**](doc//SystemConfigApi.md#getconfig) | **GET** /system-config |
*SystemConfigApi* | [**getConfigDefaults**](doc//SystemConfigApi.md#getconfigdefaults) | **GET** /system-config/defaults |
*SystemConfigApi* | [**getStorageTemplateOptions**](doc//SystemConfigApi.md#getstoragetemplateoptions) | **GET** /system-config/storage-template-options |
*SystemConfigApi* | [**updateConfig**](doc//SystemConfigApi.md#updateconfig) | **PUT** /system-config |
*SystemMetadataApi* | [**getAdminOnboarding**](doc//SystemMetadataApi.md#getadminonboarding) | **GET** /system-metadata/admin-onboarding |
*SystemMetadataApi* | [**getReverseGeocodingState**](doc//SystemMetadataApi.md#getreversegeocodingstate) | **GET** /system-metadata/reverse-geocoding-state |
*SystemMetadataApi* | [**getVersionCheckState**](doc//SystemMetadataApi.md#getversioncheckstate) | **GET** /system-metadata/version-check-state |
*SystemMetadataApi* | [**updateAdminOnboarding**](doc//SystemMetadataApi.md#updateadminonboarding) | **POST** /system-metadata/admin-onboarding |
*TagsApi* | [**bulkTagAssets**](doc//TagsApi.md#bulktagassets) | **PUT** /tags/assets |
*TagsApi* | [**createTag**](doc//TagsApi.md#createtag) | **POST** /tags |
*TagsApi* | [**deleteTag**](doc//TagsApi.md#deletetag) | **DELETE** /tags/{id} |
*TagsApi* | [**getAllTags**](doc//TagsApi.md#getalltags) | **GET** /tags |
*TagsApi* | [**getTagById**](doc//TagsApi.md#gettagbyid) | **GET** /tags/{id} |
*TagsApi* | [**tagAssets**](doc//TagsApi.md#tagassets) | **PUT** /tags/{id}/assets |
*TagsApi* | [**untagAssets**](doc//TagsApi.md#untagassets) | **DELETE** /tags/{id}/assets |
*TagsApi* | [**updateTag**](doc//TagsApi.md#updatetag) | **PUT** /tags/{id} |
*TagsApi* | [**upsertTags**](doc//TagsApi.md#upserttags) | **PUT** /tags |
*TimelineApi* | [**getTimeBucket**](doc//TimelineApi.md#gettimebucket) | **GET** /timeline/bucket |
*TimelineApi* | [**getTimeBuckets**](doc//TimelineApi.md#gettimebuckets) | **GET** /timeline/buckets |
*TrashApi* | [**emptyTrash**](doc//TrashApi.md#emptytrash) | **POST** /trash/empty |
*TrashApi* | [**restoreAssets**](doc//TrashApi.md#restoreassets) | **POST** /trash/restore/assets |
*TrashApi* | [**restoreTrash**](doc//TrashApi.md#restoretrash) | **POST** /trash/restore |
*UsersApi* | [**createProfileImage**](doc//UsersApi.md#createprofileimage) | **POST** /users/profile-image |
*UsersApi* | [**deleteProfileImage**](doc//UsersApi.md#deleteprofileimage) | **DELETE** /users/profile-image |
*UsersApi* | [**deleteUserLicense**](doc//UsersApi.md#deleteuserlicense) | **DELETE** /users/me/license |
*UsersApi* | [**deleteUserOnboarding**](doc//UsersApi.md#deleteuseronboarding) | **DELETE** /users/me/onboarding |
*UsersApi* | [**getMyPreferences**](doc//UsersApi.md#getmypreferences) | **GET** /users/me/preferences |
*UsersApi* | [**getMyUser**](doc//UsersApi.md#getmyuser) | **GET** /users/me |
*UsersApi* | [**getProfileImage**](doc//UsersApi.md#getprofileimage) | **GET** /users/{id}/profile-image |
*UsersApi* | [**getUser**](doc//UsersApi.md#getuser) | **GET** /users/{id} |
*UsersApi* | [**getUserLicense**](doc//UsersApi.md#getuserlicense) | **GET** /users/me/license |
*UsersApi* | [**getUserOnboarding**](doc//UsersApi.md#getuseronboarding) | **GET** /users/me/onboarding |
*UsersApi* | [**searchUsers**](doc//UsersApi.md#searchusers) | **GET** /users |
*UsersApi* | [**setUserLicense**](doc//UsersApi.md#setuserlicense) | **PUT** /users/me/license |
*UsersApi* | [**setUserOnboarding**](doc//UsersApi.md#setuseronboarding) | **PUT** /users/me/onboarding |
*UsersApi* | [**updateMyPreferences**](doc//UsersApi.md#updatemypreferences) | **PUT** /users/me/preferences |
*UsersApi* | [**updateMyUser**](doc//UsersApi.md#updatemyuser) | **PUT** /users/me |
*UsersAdminApi* | [**createUserAdmin**](doc//UsersAdminApi.md#createuseradmin) | **POST** /admin/users |
*UsersAdminApi* | [**deleteUserAdmin**](doc//UsersAdminApi.md#deleteuseradmin) | **DELETE** /admin/users/{id} |
*UsersAdminApi* | [**getUserAdmin**](doc//UsersAdminApi.md#getuseradmin) | **GET** /admin/users/{id} |
*UsersAdminApi* | [**getUserPreferencesAdmin**](doc//UsersAdminApi.md#getuserpreferencesadmin) | **GET** /admin/users/{id}/preferences |
*UsersAdminApi* | [**getUserSessionsAdmin**](doc//UsersAdminApi.md#getusersessionsadmin) | **GET** /admin/users/{id}/sessions |
*UsersAdminApi* | [**getUserStatisticsAdmin**](doc//UsersAdminApi.md#getuserstatisticsadmin) | **GET** /admin/users/{id}/statistics |
*UsersAdminApi* | [**restoreUserAdmin**](doc//UsersAdminApi.md#restoreuseradmin) | **POST** /admin/users/{id}/restore |
*UsersAdminApi* | [**searchUsersAdmin**](doc//UsersAdminApi.md#searchusersadmin) | **GET** /admin/users |
*UsersAdminApi* | [**updateUserAdmin**](doc//UsersAdminApi.md#updateuseradmin) | **PUT** /admin/users/{id} |
*UsersAdminApi* | [**updateUserPreferencesAdmin**](doc//UsersAdminApi.md#updateuserpreferencesadmin) | **PUT** /admin/users/{id}/preferences |
*ViewApi* | [**getAssetsByOriginalPath**](doc//ViewApi.md#getassetsbyoriginalpath) | **GET** /view/folder |
*ViewApi* | [**getUniqueOriginalPaths**](doc//ViewApi.md#getuniqueoriginalpaths) | **GET** /view/folder/unique-paths |
*APIKeysApi* | [**createApiKey**](doc//APIKeysApi.md#createapikey) | **POST** /api-keys | Create an API key
*APIKeysApi* | [**deleteApiKey**](doc//APIKeysApi.md#deleteapikey) | **DELETE** /api-keys/{id} | Delete an API key
*APIKeysApi* | [**getApiKey**](doc//APIKeysApi.md#getapikey) | **GET** /api-keys/{id} | Retrieve an API key
*APIKeysApi* | [**getApiKeys**](doc//APIKeysApi.md#getapikeys) | **GET** /api-keys | List all API keys
*APIKeysApi* | [**getMyApiKey**](doc//APIKeysApi.md#getmyapikey) | **GET** /api-keys/me | Retrieve the current API key
*APIKeysApi* | [**updateApiKey**](doc//APIKeysApi.md#updateapikey) | **PUT** /api-keys/{id} | Update an API key
*ActivitiesApi* | [**createActivity**](doc//ActivitiesApi.md#createactivity) | **POST** /activities | Create an activity
*ActivitiesApi* | [**deleteActivity**](doc//ActivitiesApi.md#deleteactivity) | **DELETE** /activities/{id} | Delete an activity
*ActivitiesApi* | [**getActivities**](doc//ActivitiesApi.md#getactivities) | **GET** /activities | List all activities
*ActivitiesApi* | [**getActivityStatistics**](doc//ActivitiesApi.md#getactivitystatistics) | **GET** /activities/statistics | Retrieve activity statistics
*AlbumsApi* | [**addAssetsToAlbum**](doc//AlbumsApi.md#addassetstoalbum) | **PUT** /albums/{id}/assets | Add assets to an album
*AlbumsApi* | [**addAssetsToAlbums**](doc//AlbumsApi.md#addassetstoalbums) | **PUT** /albums/assets | Add assets to albums
*AlbumsApi* | [**addUsersToAlbum**](doc//AlbumsApi.md#adduserstoalbum) | **PUT** /albums/{id}/users | Share album with users
*AlbumsApi* | [**createAlbum**](doc//AlbumsApi.md#createalbum) | **POST** /albums | Create an album
*AlbumsApi* | [**deleteAlbum**](doc//AlbumsApi.md#deletealbum) | **DELETE** /albums/{id} | Delete an album
*AlbumsApi* | [**getAlbumInfo**](doc//AlbumsApi.md#getalbuminfo) | **GET** /albums/{id} | Retrieve an album
*AlbumsApi* | [**getAlbumStatistics**](doc//AlbumsApi.md#getalbumstatistics) | **GET** /albums/statistics | Retrieve album statistics
*AlbumsApi* | [**getAllAlbums**](doc//AlbumsApi.md#getallalbums) | **GET** /albums | List all albums
*AlbumsApi* | [**removeAssetFromAlbum**](doc//AlbumsApi.md#removeassetfromalbum) | **DELETE** /albums/{id}/assets | Remove assets from an album
*AlbumsApi* | [**removeUserFromAlbum**](doc//AlbumsApi.md#removeuserfromalbum) | **DELETE** /albums/{id}/user/{userId} | Remove user from album
*AlbumsApi* | [**updateAlbumInfo**](doc//AlbumsApi.md#updatealbuminfo) | **PATCH** /albums/{id} | Update an album
*AlbumsApi* | [**updateAlbumUser**](doc//AlbumsApi.md#updatealbumuser) | **PUT** /albums/{id}/user/{userId} | Update user role
*AssetsApi* | [**checkBulkUpload**](doc//AssetsApi.md#checkbulkupload) | **POST** /assets/bulk-upload-check | Check bulk upload
*AssetsApi* | [**checkExistingAssets**](doc//AssetsApi.md#checkexistingassets) | **POST** /assets/exist | Check existing assets
*AssetsApi* | [**copyAsset**](doc//AssetsApi.md#copyasset) | **PUT** /assets/copy | Copy asset
*AssetsApi* | [**deleteAssetMetadata**](doc//AssetsApi.md#deleteassetmetadata) | **DELETE** /assets/{id}/metadata/{key} | Delete asset metadata by key
*AssetsApi* | [**deleteAssets**](doc//AssetsApi.md#deleteassets) | **DELETE** /assets | Delete assets
*AssetsApi* | [**downloadAsset**](doc//AssetsApi.md#downloadasset) | **GET** /assets/{id}/original | Download original asset
*AssetsApi* | [**getAllUserAssetsByDeviceId**](doc//AssetsApi.md#getalluserassetsbydeviceid) | **GET** /assets/device/{deviceId} | Retrieve assets by device ID
*AssetsApi* | [**getAssetInfo**](doc//AssetsApi.md#getassetinfo) | **GET** /assets/{id} | Retrieve an asset
*AssetsApi* | [**getAssetMetadata**](doc//AssetsApi.md#getassetmetadata) | **GET** /assets/{id}/metadata | Get asset metadata
*AssetsApi* | [**getAssetMetadataByKey**](doc//AssetsApi.md#getassetmetadatabykey) | **GET** /assets/{id}/metadata/{key} | Retrieve asset metadata by key
*AssetsApi* | [**getAssetOcr**](doc//AssetsApi.md#getassetocr) | **GET** /assets/{id}/ocr | Retrieve asset OCR data
*AssetsApi* | [**getAssetStatistics**](doc//AssetsApi.md#getassetstatistics) | **GET** /assets/statistics | Get asset statistics
*AssetsApi* | [**getRandom**](doc//AssetsApi.md#getrandom) | **GET** /assets/random | Get random assets
*AssetsApi* | [**playAssetVideo**](doc//AssetsApi.md#playassetvideo) | **GET** /assets/{id}/video/playback | Play asset video
*AssetsApi* | [**replaceAsset**](doc//AssetsApi.md#replaceasset) | **PUT** /assets/{id}/original | Replace asset
*AssetsApi* | [**runAssetJobs**](doc//AssetsApi.md#runassetjobs) | **POST** /assets/jobs | Run an asset job
*AssetsApi* | [**updateAsset**](doc//AssetsApi.md#updateasset) | **PUT** /assets/{id} | Update an asset
*AssetsApi* | [**updateAssetMetadata**](doc//AssetsApi.md#updateassetmetadata) | **PUT** /assets/{id}/metadata | Update asset metadata
*AssetsApi* | [**updateAssets**](doc//AssetsApi.md#updateassets) | **PUT** /assets | Update assets
*AssetsApi* | [**uploadAsset**](doc//AssetsApi.md#uploadasset) | **POST** /assets | Upload asset
*AssetsApi* | [**viewAsset**](doc//AssetsApi.md#viewasset) | **GET** /assets/{id}/thumbnail | View asset thumbnail
*AuthenticationApi* | [**changePassword**](doc//AuthenticationApi.md#changepassword) | **POST** /auth/change-password | Change password
*AuthenticationApi* | [**changePinCode**](doc//AuthenticationApi.md#changepincode) | **PUT** /auth/pin-code | Change pin code
*AuthenticationApi* | [**finishOAuth**](doc//AuthenticationApi.md#finishoauth) | **POST** /oauth/callback | Finish OAuth
*AuthenticationApi* | [**getAuthStatus**](doc//AuthenticationApi.md#getauthstatus) | **GET** /auth/status | Retrieve auth status
*AuthenticationApi* | [**linkOAuthAccount**](doc//AuthenticationApi.md#linkoauthaccount) | **POST** /oauth/link | Link OAuth account
*AuthenticationApi* | [**lockAuthSession**](doc//AuthenticationApi.md#lockauthsession) | **POST** /auth/session/lock | Lock auth session
*AuthenticationApi* | [**login**](doc//AuthenticationApi.md#login) | **POST** /auth/login | Login
*AuthenticationApi* | [**logout**](doc//AuthenticationApi.md#logout) | **POST** /auth/logout | Logout
*AuthenticationApi* | [**redirectOAuthToMobile**](doc//AuthenticationApi.md#redirectoauthtomobile) | **GET** /oauth/mobile-redirect | Redirect OAuth to mobile
*AuthenticationApi* | [**resetPinCode**](doc//AuthenticationApi.md#resetpincode) | **DELETE** /auth/pin-code | Reset pin code
*AuthenticationApi* | [**setupPinCode**](doc//AuthenticationApi.md#setuppincode) | **POST** /auth/pin-code | Setup pin code
*AuthenticationApi* | [**signUpAdmin**](doc//AuthenticationApi.md#signupadmin) | **POST** /auth/admin-sign-up | Register admin
*AuthenticationApi* | [**startOAuth**](doc//AuthenticationApi.md#startoauth) | **POST** /oauth/authorize | Start OAuth
*AuthenticationApi* | [**unlinkOAuthAccount**](doc//AuthenticationApi.md#unlinkoauthaccount) | **POST** /oauth/unlink | Unlink OAuth account
*AuthenticationApi* | [**unlockAuthSession**](doc//AuthenticationApi.md#unlockauthsession) | **POST** /auth/session/unlock | Unlock auth session
*AuthenticationApi* | [**validateAccessToken**](doc//AuthenticationApi.md#validateaccesstoken) | **POST** /auth/validateToken | Validate access token
*AuthenticationAdminApi* | [**unlinkAllOAuthAccountsAdmin**](doc//AuthenticationAdminApi.md#unlinkalloauthaccountsadmin) | **POST** /admin/auth/unlink-all | Unlink all OAuth accounts
*DeprecatedApi* | [**createPartnerDeprecated**](doc//DeprecatedApi.md#createpartnerdeprecated) | **POST** /partners/{id} | Create a partner
*DeprecatedApi* | [**getAllUserAssetsByDeviceId**](doc//DeprecatedApi.md#getalluserassetsbydeviceid) | **GET** /assets/device/{deviceId} | Retrieve assets by device ID
*DeprecatedApi* | [**getDeltaSync**](doc//DeprecatedApi.md#getdeltasync) | **POST** /sync/delta-sync | Get delta sync for user
*DeprecatedApi* | [**getFullSyncForUser**](doc//DeprecatedApi.md#getfullsyncforuser) | **POST** /sync/full-sync | Get full sync for user
*DeprecatedApi* | [**getRandom**](doc//DeprecatedApi.md#getrandom) | **GET** /assets/random | Get random assets
*DeprecatedApi* | [**replaceAsset**](doc//DeprecatedApi.md#replaceasset) | **PUT** /assets/{id}/original | Replace asset
*DownloadApi* | [**downloadArchive**](doc//DownloadApi.md#downloadarchive) | **POST** /download/archive | Download asset archive
*DownloadApi* | [**getDownloadInfo**](doc//DownloadApi.md#getdownloadinfo) | **POST** /download/info | Retrieve download information
*DuplicatesApi* | [**deleteDuplicate**](doc//DuplicatesApi.md#deleteduplicate) | **DELETE** /duplicates/{id} | Delete a duplicate
*DuplicatesApi* | [**deleteDuplicates**](doc//DuplicatesApi.md#deleteduplicates) | **DELETE** /duplicates | Delete duplicates
*DuplicatesApi* | [**getAssetDuplicates**](doc//DuplicatesApi.md#getassetduplicates) | **GET** /duplicates | Retrieve duplicates
*FacesApi* | [**createFace**](doc//FacesApi.md#createface) | **POST** /faces | Create a face
*FacesApi* | [**deleteFace**](doc//FacesApi.md#deleteface) | **DELETE** /faces/{id} | Delete a face
*FacesApi* | [**getFaces**](doc//FacesApi.md#getfaces) | **GET** /faces | Retrieve faces for asset
*FacesApi* | [**reassignFacesById**](doc//FacesApi.md#reassignfacesbyid) | **PUT** /faces/{id} | Re-assign a face to another person
*JobsApi* | [**createJob**](doc//JobsApi.md#createjob) | **POST** /jobs | Create a manual job
*JobsApi* | [**getAllJobsStatus**](doc//JobsApi.md#getalljobsstatus) | **GET** /jobs | Retrieve queue counts and status
*JobsApi* | [**sendJobCommand**](doc//JobsApi.md#sendjobcommand) | **PUT** /jobs/{id} | Run jobs
*LibrariesApi* | [**createLibrary**](doc//LibrariesApi.md#createlibrary) | **POST** /libraries | Create a library
*LibrariesApi* | [**deleteLibrary**](doc//LibrariesApi.md#deletelibrary) | **DELETE** /libraries/{id} | Delete a library
*LibrariesApi* | [**getAllLibraries**](doc//LibrariesApi.md#getalllibraries) | **GET** /libraries | Retrieve libraries
*LibrariesApi* | [**getLibrary**](doc//LibrariesApi.md#getlibrary) | **GET** /libraries/{id} | Retrieve a library
*LibrariesApi* | [**getLibraryStatistics**](doc//LibrariesApi.md#getlibrarystatistics) | **GET** /libraries/{id}/statistics | Retrieve library statistics
*LibrariesApi* | [**scanLibrary**](doc//LibrariesApi.md#scanlibrary) | **POST** /libraries/{id}/scan | Scan a library
*LibrariesApi* | [**updateLibrary**](doc//LibrariesApi.md#updatelibrary) | **PUT** /libraries/{id} | Update a library
*LibrariesApi* | [**validate**](doc//LibrariesApi.md#validate) | **POST** /libraries/{id}/validate | Validate library settings
*MapApi* | [**getMapMarkers**](doc//MapApi.md#getmapmarkers) | **GET** /map/markers | Retrieve map markers
*MapApi* | [**reverseGeocode**](doc//MapApi.md#reversegeocode) | **GET** /map/reverse-geocode | Reverse geocode coordinates
*MemoriesApi* | [**addMemoryAssets**](doc//MemoriesApi.md#addmemoryassets) | **PUT** /memories/{id}/assets | Add assets to a memory
*MemoriesApi* | [**createMemory**](doc//MemoriesApi.md#creatememory) | **POST** /memories | Create a memory
*MemoriesApi* | [**deleteMemory**](doc//MemoriesApi.md#deletememory) | **DELETE** /memories/{id} | Delete a memory
*MemoriesApi* | [**getMemory**](doc//MemoriesApi.md#getmemory) | **GET** /memories/{id} | Retrieve a memory
*MemoriesApi* | [**memoriesStatistics**](doc//MemoriesApi.md#memoriesstatistics) | **GET** /memories/statistics | Retrieve memories statistics
*MemoriesApi* | [**removeMemoryAssets**](doc//MemoriesApi.md#removememoryassets) | **DELETE** /memories/{id}/assets | Remove assets from a memory
*MemoriesApi* | [**searchMemories**](doc//MemoriesApi.md#searchmemories) | **GET** /memories | Retrieve memories
*MemoriesApi* | [**updateMemory**](doc//MemoriesApi.md#updatememory) | **PUT** /memories/{id} | Update a memory
*NotificationsApi* | [**deleteNotification**](doc//NotificationsApi.md#deletenotification) | **DELETE** /notifications/{id} | Delete a notification
*NotificationsApi* | [**deleteNotifications**](doc//NotificationsApi.md#deletenotifications) | **DELETE** /notifications | Delete notifications
*NotificationsApi* | [**getNotification**](doc//NotificationsApi.md#getnotification) | **GET** /notifications/{id} | Get a notification
*NotificationsApi* | [**getNotifications**](doc//NotificationsApi.md#getnotifications) | **GET** /notifications | Retrieve notifications
*NotificationsApi* | [**updateNotification**](doc//NotificationsApi.md#updatenotification) | **PUT** /notifications/{id} | Update a notification
*NotificationsApi* | [**updateNotifications**](doc//NotificationsApi.md#updatenotifications) | **PUT** /notifications | Update notifications
*NotificationsAdminApi* | [**createNotification**](doc//NotificationsAdminApi.md#createnotification) | **POST** /admin/notifications | Create a notification
*NotificationsAdminApi* | [**getNotificationTemplateAdmin**](doc//NotificationsAdminApi.md#getnotificationtemplateadmin) | **POST** /admin/notifications/templates/{name} | Render email template
*NotificationsAdminApi* | [**sendTestEmailAdmin**](doc//NotificationsAdminApi.md#sendtestemailadmin) | **POST** /admin/notifications/test-email | Send test email
*PartnersApi* | [**createPartner**](doc//PartnersApi.md#createpartner) | **POST** /partners | Create a partner
*PartnersApi* | [**createPartnerDeprecated**](doc//PartnersApi.md#createpartnerdeprecated) | **POST** /partners/{id} | Create a partner
*PartnersApi* | [**getPartners**](doc//PartnersApi.md#getpartners) | **GET** /partners | Retrieve partners
*PartnersApi* | [**removePartner**](doc//PartnersApi.md#removepartner) | **DELETE** /partners/{id} | Remove a partner
*PartnersApi* | [**updatePartner**](doc//PartnersApi.md#updatepartner) | **PUT** /partners/{id} | Update a partner
*PeopleApi* | [**createPerson**](doc//PeopleApi.md#createperson) | **POST** /people | Create a person
*PeopleApi* | [**deletePeople**](doc//PeopleApi.md#deletepeople) | **DELETE** /people | Delete people
*PeopleApi* | [**deletePerson**](doc//PeopleApi.md#deleteperson) | **DELETE** /people/{id} | Delete person
*PeopleApi* | [**getAllPeople**](doc//PeopleApi.md#getallpeople) | **GET** /people | Get all people
*PeopleApi* | [**getPerson**](doc//PeopleApi.md#getperson) | **GET** /people/{id} | Get a person
*PeopleApi* | [**getPersonStatistics**](doc//PeopleApi.md#getpersonstatistics) | **GET** /people/{id}/statistics | Get person statistics
*PeopleApi* | [**getPersonThumbnail**](doc//PeopleApi.md#getpersonthumbnail) | **GET** /people/{id}/thumbnail | Get person thumbnail
*PeopleApi* | [**mergePerson**](doc//PeopleApi.md#mergeperson) | **POST** /people/{id}/merge | Merge people
*PeopleApi* | [**reassignFaces**](doc//PeopleApi.md#reassignfaces) | **PUT** /people/{id}/reassign | Reassign faces
*PeopleApi* | [**updatePeople**](doc//PeopleApi.md#updatepeople) | **PUT** /people | Update people
*PeopleApi* | [**updatePerson**](doc//PeopleApi.md#updateperson) | **PUT** /people/{id} | Update person
*SearchApi* | [**getAssetsByCity**](doc//SearchApi.md#getassetsbycity) | **GET** /search/cities | Retrieve assets by city
*SearchApi* | [**getExploreData**](doc//SearchApi.md#getexploredata) | **GET** /search/explore | Retrieve explore data
*SearchApi* | [**getSearchSuggestions**](doc//SearchApi.md#getsearchsuggestions) | **GET** /search/suggestions | Retrieve search suggestions
*SearchApi* | [**searchAssetStatistics**](doc//SearchApi.md#searchassetstatistics) | **POST** /search/statistics | Search asset statistics
*SearchApi* | [**searchAssets**](doc//SearchApi.md#searchassets) | **POST** /search/metadata | Search assets by metadata
*SearchApi* | [**searchLargeAssets**](doc//SearchApi.md#searchlargeassets) | **POST** /search/large-assets | Search large assets
*SearchApi* | [**searchPerson**](doc//SearchApi.md#searchperson) | **GET** /search/person | Search people
*SearchApi* | [**searchPlaces**](doc//SearchApi.md#searchplaces) | **GET** /search/places | Search places
*SearchApi* | [**searchRandom**](doc//SearchApi.md#searchrandom) | **POST** /search/random | Search random assets
*SearchApi* | [**searchSmart**](doc//SearchApi.md#searchsmart) | **POST** /search/smart | Smart asset search
*ServerApi* | [**deleteServerLicense**](doc//ServerApi.md#deleteserverlicense) | **DELETE** /server/license | Delete server product key
*ServerApi* | [**getAboutInfo**](doc//ServerApi.md#getaboutinfo) | **GET** /server/about | Get server information
*ServerApi* | [**getApkLinks**](doc//ServerApi.md#getapklinks) | **GET** /server/apk-links | Get APK links
*ServerApi* | [**getServerConfig**](doc//ServerApi.md#getserverconfig) | **GET** /server/config | Get config
*ServerApi* | [**getServerFeatures**](doc//ServerApi.md#getserverfeatures) | **GET** /server/features | Get features
*ServerApi* | [**getServerLicense**](doc//ServerApi.md#getserverlicense) | **GET** /server/license | Get product key
*ServerApi* | [**getServerStatistics**](doc//ServerApi.md#getserverstatistics) | **GET** /server/statistics | Get statistics
*ServerApi* | [**getServerVersion**](doc//ServerApi.md#getserverversion) | **GET** /server/version | Get server version
*ServerApi* | [**getStorage**](doc//ServerApi.md#getstorage) | **GET** /server/storage | Get storage
*ServerApi* | [**getSupportedMediaTypes**](doc//ServerApi.md#getsupportedmediatypes) | **GET** /server/media-types | Get supported media types
*ServerApi* | [**getTheme**](doc//ServerApi.md#gettheme) | **GET** /server/theme | Get theme
*ServerApi* | [**getVersionCheck**](doc//ServerApi.md#getversioncheck) | **GET** /server/version-check | Get version check status
*ServerApi* | [**getVersionHistory**](doc//ServerApi.md#getversionhistory) | **GET** /server/version-history | Get version history
*ServerApi* | [**pingServer**](doc//ServerApi.md#pingserver) | **GET** /server/ping | Ping
*ServerApi* | [**setServerLicense**](doc//ServerApi.md#setserverlicense) | **PUT** /server/license | Set server product key
*SessionsApi* | [**createSession**](doc//SessionsApi.md#createsession) | **POST** /sessions | Create a session
*SessionsApi* | [**deleteAllSessions**](doc//SessionsApi.md#deleteallsessions) | **DELETE** /sessions | Delete all sessions
*SessionsApi* | [**deleteSession**](doc//SessionsApi.md#deletesession) | **DELETE** /sessions/{id} | Delete a session
*SessionsApi* | [**getSessions**](doc//SessionsApi.md#getsessions) | **GET** /sessions | Retrieve sessions
*SessionsApi* | [**lockSession**](doc//SessionsApi.md#locksession) | **POST** /sessions/{id}/lock | Lock a session
*SessionsApi* | [**updateSession**](doc//SessionsApi.md#updatesession) | **PUT** /sessions/{id} | Update a session
*SharedLinksApi* | [**addSharedLinkAssets**](doc//SharedLinksApi.md#addsharedlinkassets) | **PUT** /shared-links/{id}/assets | Add assets to a shared link
*SharedLinksApi* | [**createSharedLink**](doc//SharedLinksApi.md#createsharedlink) | **POST** /shared-links | Create a shared link
*SharedLinksApi* | [**getAllSharedLinks**](doc//SharedLinksApi.md#getallsharedlinks) | **GET** /shared-links | Retrieve all shared links
*SharedLinksApi* | [**getMySharedLink**](doc//SharedLinksApi.md#getmysharedlink) | **GET** /shared-links/me | Retrieve current shared link
*SharedLinksApi* | [**getSharedLinkById**](doc//SharedLinksApi.md#getsharedlinkbyid) | **GET** /shared-links/{id} | Retrieve a shared link
*SharedLinksApi* | [**removeSharedLink**](doc//SharedLinksApi.md#removesharedlink) | **DELETE** /shared-links/{id} | Delete a shared link
*SharedLinksApi* | [**removeSharedLinkAssets**](doc//SharedLinksApi.md#removesharedlinkassets) | **DELETE** /shared-links/{id}/assets | Remove assets from a shared link
*SharedLinksApi* | [**updateSharedLink**](doc//SharedLinksApi.md#updatesharedlink) | **PATCH** /shared-links/{id} | Update a shared link
*StacksApi* | [**createStack**](doc//StacksApi.md#createstack) | **POST** /stacks | Create a stack
*StacksApi* | [**deleteStack**](doc//StacksApi.md#deletestack) | **DELETE** /stacks/{id} | Delete a stack
*StacksApi* | [**deleteStacks**](doc//StacksApi.md#deletestacks) | **DELETE** /stacks | Delete stacks
*StacksApi* | [**getStack**](doc//StacksApi.md#getstack) | **GET** /stacks/{id} | Retrieve a stack
*StacksApi* | [**removeAssetFromStack**](doc//StacksApi.md#removeassetfromstack) | **DELETE** /stacks/{id}/assets/{assetId} | Remove an asset from a stack
*StacksApi* | [**searchStacks**](doc//StacksApi.md#searchstacks) | **GET** /stacks | Retrieve stacks
*StacksApi* | [**updateStack**](doc//StacksApi.md#updatestack) | **PUT** /stacks/{id} | Update a stack
*SyncApi* | [**deleteSyncAck**](doc//SyncApi.md#deletesyncack) | **DELETE** /sync/ack | Delete acknowledgements
*SyncApi* | [**getDeltaSync**](doc//SyncApi.md#getdeltasync) | **POST** /sync/delta-sync | Get delta sync for user
*SyncApi* | [**getFullSyncForUser**](doc//SyncApi.md#getfullsyncforuser) | **POST** /sync/full-sync | Get full sync for user
*SyncApi* | [**getSyncAck**](doc//SyncApi.md#getsyncack) | **GET** /sync/ack | Retrieve acknowledgements
*SyncApi* | [**getSyncStream**](doc//SyncApi.md#getsyncstream) | **POST** /sync/stream | Stream sync changes
*SyncApi* | [**sendSyncAck**](doc//SyncApi.md#sendsyncack) | **POST** /sync/ack | Acknowledge changes
*SystemConfigApi* | [**getConfig**](doc//SystemConfigApi.md#getconfig) | **GET** /system-config | Get system configuration
*SystemConfigApi* | [**getConfigDefaults**](doc//SystemConfigApi.md#getconfigdefaults) | **GET** /system-config/defaults | Get system configuration defaults
*SystemConfigApi* | [**getStorageTemplateOptions**](doc//SystemConfigApi.md#getstoragetemplateoptions) | **GET** /system-config/storage-template-options | Get storage template options
*SystemConfigApi* | [**updateConfig**](doc//SystemConfigApi.md#updateconfig) | **PUT** /system-config | Update system configuration
*SystemMetadataApi* | [**getAdminOnboarding**](doc//SystemMetadataApi.md#getadminonboarding) | **GET** /system-metadata/admin-onboarding | Retrieve admin onboarding
*SystemMetadataApi* | [**getReverseGeocodingState**](doc//SystemMetadataApi.md#getreversegeocodingstate) | **GET** /system-metadata/reverse-geocoding-state | Retrieve reverse geocoding state
*SystemMetadataApi* | [**getVersionCheckState**](doc//SystemMetadataApi.md#getversioncheckstate) | **GET** /system-metadata/version-check-state | Retrieve version check state
*SystemMetadataApi* | [**updateAdminOnboarding**](doc//SystemMetadataApi.md#updateadminonboarding) | **POST** /system-metadata/admin-onboarding | Update admin onboarding
*TagsApi* | [**bulkTagAssets**](doc//TagsApi.md#bulktagassets) | **PUT** /tags/assets | Tag assets
*TagsApi* | [**createTag**](doc//TagsApi.md#createtag) | **POST** /tags | Create a tag
*TagsApi* | [**deleteTag**](doc//TagsApi.md#deletetag) | **DELETE** /tags/{id} | Delete a tag
*TagsApi* | [**getAllTags**](doc//TagsApi.md#getalltags) | **GET** /tags | Retrieve tags
*TagsApi* | [**getTagById**](doc//TagsApi.md#gettagbyid) | **GET** /tags/{id} | Retrieve a tag
*TagsApi* | [**tagAssets**](doc//TagsApi.md#tagassets) | **PUT** /tags/{id}/assets | Tag assets
*TagsApi* | [**untagAssets**](doc//TagsApi.md#untagassets) | **DELETE** /tags/{id}/assets | Untag assets
*TagsApi* | [**updateTag**](doc//TagsApi.md#updatetag) | **PUT** /tags/{id} | Update a tag
*TagsApi* | [**upsertTags**](doc//TagsApi.md#upserttags) | **PUT** /tags | Upsert tags
*TimelineApi* | [**getTimeBucket**](doc//TimelineApi.md#gettimebucket) | **GET** /timeline/bucket | Get time bucket
*TimelineApi* | [**getTimeBuckets**](doc//TimelineApi.md#gettimebuckets) | **GET** /timeline/buckets | Get time buckets
*TrashApi* | [**emptyTrash**](doc//TrashApi.md#emptytrash) | **POST** /trash/empty | Empty trash
*TrashApi* | [**restoreAssets**](doc//TrashApi.md#restoreassets) | **POST** /trash/restore/assets | Restore assets
*TrashApi* | [**restoreTrash**](doc//TrashApi.md#restoretrash) | **POST** /trash/restore | Restore trash
*UsersApi* | [**createProfileImage**](doc//UsersApi.md#createprofileimage) | **POST** /users/profile-image | Create user profile image
*UsersApi* | [**deleteProfileImage**](doc//UsersApi.md#deleteprofileimage) | **DELETE** /users/profile-image | Delete user profile image
*UsersApi* | [**deleteUserLicense**](doc//UsersApi.md#deleteuserlicense) | **DELETE** /users/me/license | Delete user product key
*UsersApi* | [**deleteUserOnboarding**](doc//UsersApi.md#deleteuseronboarding) | **DELETE** /users/me/onboarding | Delete user onboarding
*UsersApi* | [**getMyPreferences**](doc//UsersApi.md#getmypreferences) | **GET** /users/me/preferences | Get my preferences
*UsersApi* | [**getMyUser**](doc//UsersApi.md#getmyuser) | **GET** /users/me | Get current user
*UsersApi* | [**getProfileImage**](doc//UsersApi.md#getprofileimage) | **GET** /users/{id}/profile-image | Retrieve user profile image
*UsersApi* | [**getUser**](doc//UsersApi.md#getuser) | **GET** /users/{id} | Retrieve a user
*UsersApi* | [**getUserLicense**](doc//UsersApi.md#getuserlicense) | **GET** /users/me/license | Retrieve user product key
*UsersApi* | [**getUserOnboarding**](doc//UsersApi.md#getuseronboarding) | **GET** /users/me/onboarding | Retrieve user onboarding
*UsersApi* | [**searchUsers**](doc//UsersApi.md#searchusers) | **GET** /users | Get all users
*UsersApi* | [**setUserLicense**](doc//UsersApi.md#setuserlicense) | **PUT** /users/me/license | Set user product key
*UsersApi* | [**setUserOnboarding**](doc//UsersApi.md#setuseronboarding) | **PUT** /users/me/onboarding | Update user onboarding
*UsersApi* | [**updateMyPreferences**](doc//UsersApi.md#updatemypreferences) | **PUT** /users/me/preferences | Update my preferences
*UsersApi* | [**updateMyUser**](doc//UsersApi.md#updatemyuser) | **PUT** /users/me | Update current user
*UsersAdminApi* | [**createUserAdmin**](doc//UsersAdminApi.md#createuseradmin) | **POST** /admin/users | Create a user
*UsersAdminApi* | [**deleteUserAdmin**](doc//UsersAdminApi.md#deleteuseradmin) | **DELETE** /admin/users/{id} | Delete a user
*UsersAdminApi* | [**getUserAdmin**](doc//UsersAdminApi.md#getuseradmin) | **GET** /admin/users/{id} | Retrieve a user
*UsersAdminApi* | [**getUserPreferencesAdmin**](doc//UsersAdminApi.md#getuserpreferencesadmin) | **GET** /admin/users/{id}/preferences | Retrieve user preferences
*UsersAdminApi* | [**getUserSessionsAdmin**](doc//UsersAdminApi.md#getusersessionsadmin) | **GET** /admin/users/{id}/sessions | Retrieve user sessions
*UsersAdminApi* | [**getUserStatisticsAdmin**](doc//UsersAdminApi.md#getuserstatisticsadmin) | **GET** /admin/users/{id}/statistics | Retrieve user statistics
*UsersAdminApi* | [**restoreUserAdmin**](doc//UsersAdminApi.md#restoreuseradmin) | **POST** /admin/users/{id}/restore | Restore a deleted user
*UsersAdminApi* | [**searchUsersAdmin**](doc//UsersAdminApi.md#searchusersadmin) | **GET** /admin/users | Search users
*UsersAdminApi* | [**updateUserAdmin**](doc//UsersAdminApi.md#updateuseradmin) | **PUT** /admin/users/{id} | Update a user
*UsersAdminApi* | [**updateUserPreferencesAdmin**](doc//UsersAdminApi.md#updateuserpreferencesadmin) | **PUT** /admin/users/{id}/preferences | Update user preferences
*ViewsApi* | [**getAssetsByOriginalPath**](doc//ViewsApi.md#getassetsbyoriginalpath) | **GET** /view/folder | Retrieve assets by original path
*ViewsApi* | [**getUniqueOriginalPaths**](doc//ViewsApi.md#getuniqueoriginalpaths) | **GET** /view/folder/unique-paths | Retrieve unique paths
## Documentation For Models

5
mobile/openapi/lib/api.dart generated
View file

@ -34,8 +34,8 @@ part 'api/api_keys_api.dart';
part 'api/activities_api.dart';
part 'api/albums_api.dart';
part 'api/assets_api.dart';
part 'api/auth_admin_api.dart';
part 'api/authentication_api.dart';
part 'api/authentication_admin_api.dart';
part 'api/deprecated_api.dart';
part 'api/download_api.dart';
part 'api/duplicates_api.dart';
@ -46,7 +46,6 @@ part 'api/map_api.dart';
part 'api/memories_api.dart';
part 'api/notifications_api.dart';
part 'api/notifications_admin_api.dart';
part 'api/o_auth_api.dart';
part 'api/partners_api.dart';
part 'api/people_api.dart';
part 'api/search_api.dart';
@ -62,7 +61,7 @@ part 'api/timeline_api.dart';
part 'api/trash_api.dart';
part 'api/users_api.dart';
part 'api/users_admin_api.dart';
part 'api/view_api.dart';
part 'api/views_api.dart';
part 'model/api_key_create_dto.dart';
part 'model/api_key_create_response_dto.dart';

32
mobile/openapi/lib/api/activities_api.dart generated
View file

@ -16,7 +16,9 @@ class ActivitiesApi {
final ApiClient apiClient;
/// This endpoint requires the `activity.create` permission.
/// Create an activity
///
/// Create a like or a comment for an album, or an asset in an album.
///
/// Note: This method returns the HTTP [Response].
///
@ -48,7 +50,9 @@ class ActivitiesApi {
);
}
/// This endpoint requires the `activity.create` permission.
/// Create an activity
///
/// Create a like or a comment for an album, or an asset in an album.
///
/// Parameters:
///
@ -68,7 +72,9 @@ class ActivitiesApi {
return null;
}
/// This endpoint requires the `activity.delete` permission.
/// Delete an activity
///
/// Removes a like or comment from a given album or asset in an album.
///
/// Note: This method returns the HTTP [Response].
///
@ -101,7 +107,9 @@ class ActivitiesApi {
);
}
/// This endpoint requires the `activity.delete` permission.
/// Delete an activity
///
/// Removes a like or comment from a given album or asset in an album.
///
/// Parameters:
///
@ -113,7 +121,9 @@ class ActivitiesApi {
}
}
/// This endpoint requires the `activity.read` permission.
/// List all activities
///
/// Returns a list of activities for the selected asset or album. The activities are returned in sorted order, with the oldest activities appearing first.
///
/// Note: This method returns the HTTP [Response].
///
@ -167,7 +177,9 @@ class ActivitiesApi {
);
}
/// This endpoint requires the `activity.read` permission.
/// List all activities
///
/// Returns a list of activities for the selected asset or album. The activities are returned in sorted order, with the oldest activities appearing first.
///
/// Parameters:
///
@ -198,7 +210,9 @@ class ActivitiesApi {
return null;
}
/// This endpoint requires the `activity.statistics` permission.
/// Retrieve activity statistics
///
/// Returns the number of likes and comments for a given album or asset in an album.
///
/// Note: This method returns the HTTP [Response].
///
@ -237,7 +251,9 @@ class ActivitiesApi {
);
}
/// This endpoint requires the `activity.statistics` permission.
/// Retrieve activity statistics
///
/// Returns the number of likes and comments for a given album or asset in an album.
///
/// Parameters:
///

96
mobile/openapi/lib/api/albums_api.dart generated
View file

@ -16,7 +16,9 @@ class AlbumsApi {
final ApiClient apiClient;
/// This endpoint requires the `albumAsset.create` permission.
/// Add assets to an album
///
/// Add multiple assets to a specific album by its ID.
///
/// Note: This method returns the HTTP [Response].
///
@ -62,7 +64,9 @@ class AlbumsApi {
);
}
/// This endpoint requires the `albumAsset.create` permission.
/// Add assets to an album
///
/// Add multiple assets to a specific album by its ID.
///
/// Parameters:
///
@ -91,7 +95,9 @@ class AlbumsApi {
return null;
}
/// This endpoint requires the `albumAsset.create` permission.
/// Add assets to albums
///
/// Send a list of asset IDs and album IDs to add each asset to each album.
///
/// Note: This method returns the HTTP [Response].
///
@ -134,7 +140,9 @@ class AlbumsApi {
);
}
/// This endpoint requires the `albumAsset.create` permission.
/// Add assets to albums
///
/// Send a list of asset IDs and album IDs to add each asset to each album.
///
/// Parameters:
///
@ -158,7 +166,9 @@ class AlbumsApi {
return null;
}
/// This endpoint requires the `albumUser.create` permission.
/// Share album with users
///
/// Share an album with multiple users. Each user can be given a specific role in the album.
///
/// Note: This method returns the HTTP [Response].
///
@ -193,7 +203,9 @@ class AlbumsApi {
);
}
/// This endpoint requires the `albumUser.create` permission.
/// Share album with users
///
/// Share an album with multiple users. Each user can be given a specific role in the album.
///
/// Parameters:
///
@ -215,7 +227,9 @@ class AlbumsApi {
return null;
}
/// This endpoint requires the `album.create` permission.
/// Create an album
///
/// Create a new album. The album can also be created with initial users and assets.
///
/// Note: This method returns the HTTP [Response].
///
@ -247,7 +261,9 @@ class AlbumsApi {
);
}
/// This endpoint requires the `album.create` permission.
/// Create an album
///
/// Create a new album. The album can also be created with initial users and assets.
///
/// Parameters:
///
@ -267,7 +283,9 @@ class AlbumsApi {
return null;
}
/// This endpoint requires the `album.delete` permission.
/// Delete an album
///
/// Delete a specific album by its ID. Note the album is initially trashed and then immediately scheduled for deletion, but relies on a background job to complete the process.
///
/// Note: This method returns the HTTP [Response].
///
@ -300,7 +318,9 @@ class AlbumsApi {
);
}
/// This endpoint requires the `album.delete` permission.
/// Delete an album
///
/// Delete a specific album by its ID. Note the album is initially trashed and then immediately scheduled for deletion, but relies on a background job to complete the process.
///
/// Parameters:
///
@ -312,7 +332,9 @@ class AlbumsApi {
}
}
/// This endpoint requires the `album.read` permission.
/// Retrieve an album
///
/// Retrieve information about a specific album by its ID.
///
/// Note: This method returns the HTTP [Response].
///
@ -361,7 +383,9 @@ class AlbumsApi {
);
}
/// This endpoint requires the `album.read` permission.
/// Retrieve an album
///
/// Retrieve information about a specific album by its ID.
///
/// Parameters:
///
@ -387,7 +411,9 @@ class AlbumsApi {
return null;
}
/// This endpoint requires the `album.statistics` permission.
/// Retrieve album statistics
///
/// Returns statistics about the albums available to the authenticated user.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getAlbumStatisticsWithHttpInfo() async {
@ -415,7 +441,9 @@ class AlbumsApi {
);
}
/// This endpoint requires the `album.statistics` permission.
/// Retrieve album statistics
///
/// Returns statistics about the albums available to the authenticated user.
Future<AlbumStatisticsResponseDto?> getAlbumStatistics() async {
final response = await getAlbumStatisticsWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -431,7 +459,9 @@ class AlbumsApi {
return null;
}
/// This endpoint requires the `album.read` permission.
/// List all albums
///
/// Retrieve a list of albums available to the authenticated user.
///
/// Note: This method returns the HTTP [Response].
///
@ -473,7 +503,9 @@ class AlbumsApi {
);
}
/// This endpoint requires the `album.read` permission.
/// List all albums
///
/// Retrieve a list of albums available to the authenticated user.
///
/// Parameters:
///
@ -499,7 +531,9 @@ class AlbumsApi {
return null;
}
/// This endpoint requires the `albumAsset.delete` permission.
/// Remove assets from an album
///
/// Remove multiple assets from a specific album by its ID.
///
/// Note: This method returns the HTTP [Response].
///
@ -534,7 +568,9 @@ class AlbumsApi {
);
}
/// This endpoint requires the `albumAsset.delete` permission.
/// Remove assets from an album
///
/// Remove multiple assets from a specific album by its ID.
///
/// Parameters:
///
@ -559,7 +595,9 @@ class AlbumsApi {
return null;
}
/// This endpoint requires the `albumUser.delete` permission.
/// Remove user from album
///
/// Remove a user from an album. Use an ID of \"me\" to leave a shared album.
///
/// Note: This method returns the HTTP [Response].
///
@ -595,7 +633,9 @@ class AlbumsApi {
);
}
/// This endpoint requires the `albumUser.delete` permission.
/// Remove user from album
///
/// Remove a user from an album. Use an ID of \"me\" to leave a shared album.
///
/// Parameters:
///
@ -609,7 +649,9 @@ class AlbumsApi {
}
}
/// This endpoint requires the `album.update` permission.
/// Update an album
///
/// Update the information of a specific album by its ID. This endpoint can be used to update the album name, description, sort order, etc. However, it is not used to add or remove assets or users from the album.
///
/// Note: This method returns the HTTP [Response].
///
@ -644,7 +686,9 @@ class AlbumsApi {
);
}
/// This endpoint requires the `album.update` permission.
/// Update an album
///
/// Update the information of a specific album by its ID. This endpoint can be used to update the album name, description, sort order, etc. However, it is not used to add or remove assets or users from the album.
///
/// Parameters:
///
@ -666,7 +710,9 @@ class AlbumsApi {
return null;
}
/// This endpoint requires the `albumUser.update` permission.
/// Update user role
///
/// Change the role for a specific user in a specific album.
///
/// Note: This method returns the HTTP [Response].
///
@ -704,7 +750,9 @@ class AlbumsApi {
);
}
/// This endpoint requires the `albumUser.update` permission.
/// Update user role
///
/// Change the role for a specific user in a specific album.
///
/// Parameters:
///

49
mobile/openapi/lib/api/api_keys_api.dart generated
View file

@ -16,7 +16,9 @@ class APIKeysApi {
final ApiClient apiClient;
/// This endpoint requires the `apiKey.create` permission.
/// Create an API key
///
/// Creates a new API key. It will be limited to the permissions specified.
///
/// Note: This method returns the HTTP [Response].
///
@ -48,7 +50,9 @@ class APIKeysApi {
);
}
/// This endpoint requires the `apiKey.create` permission.
/// Create an API key
///
/// Creates a new API key. It will be limited to the permissions specified.
///
/// Parameters:
///
@ -68,7 +72,9 @@ class APIKeysApi {
return null;
}
/// This endpoint requires the `apiKey.delete` permission.
/// Delete an API key
///
/// Deletes an API key identified by its ID. The current user must own this API key.
///
/// Note: This method returns the HTTP [Response].
///
@ -101,7 +107,9 @@ class APIKeysApi {
);
}
/// This endpoint requires the `apiKey.delete` permission.
/// Delete an API key
///
/// Deletes an API key identified by its ID. The current user must own this API key.
///
/// Parameters:
///
@ -113,7 +121,9 @@ class APIKeysApi {
}
}
/// This endpoint requires the `apiKey.read` permission.
/// Retrieve an API key
///
/// Retrieve an API key by its ID. The current user must own this API key.
///
/// Note: This method returns the HTTP [Response].
///
@ -146,7 +156,9 @@ class APIKeysApi {
);
}
/// This endpoint requires the `apiKey.read` permission.
/// Retrieve an API key
///
/// Retrieve an API key by its ID. The current user must own this API key.
///
/// Parameters:
///
@ -166,7 +178,9 @@ class APIKeysApi {
return null;
}
/// This endpoint requires the `apiKey.read` permission.
/// List all API keys
///
/// Retrieve all API keys of the current user.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getApiKeysWithHttpInfo() async {
@ -194,7 +208,9 @@ class APIKeysApi {
);
}
/// This endpoint requires the `apiKey.read` permission.
/// List all API keys
///
/// Retrieve all API keys of the current user.
Future<List<APIKeyResponseDto>?> getApiKeys() async {
final response = await getApiKeysWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -213,7 +229,11 @@ class APIKeysApi {
return null;
}
/// Performs an HTTP 'GET /api-keys/me' operation and returns the [Response].
/// Retrieve the current API key
///
/// Retrieve the API key that is used to access this endpoint.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getMyApiKeyWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = r'/api-keys/me';
@ -239,6 +259,9 @@ class APIKeysApi {
);
}
/// Retrieve the current API key
///
/// Retrieve the API key that is used to access this endpoint.
Future<APIKeyResponseDto?> getMyApiKey() async {
final response = await getMyApiKeyWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -254,7 +277,9 @@ class APIKeysApi {
return null;
}
/// This endpoint requires the `apiKey.update` permission.
/// Update an API key
///
/// Updates the name and permissions of an API key by its ID. The current user must own this API key.
///
/// Note: This method returns the HTTP [Response].
///
@ -289,7 +314,9 @@ class APIKeysApi {
);
}
/// This endpoint requires the `apiKey.update` permission.
/// Update an API key
///
/// Updates the name and permissions of an API key by its ID. The current user must own this API key.
///
/// Parameters:
///

167
mobile/openapi/lib/api/assets_api.dart generated
View file

@ -16,9 +16,9 @@ class AssetsApi {
final ApiClient apiClient;
/// checkBulkUpload
/// Check bulk upload
///
/// Checks if assets exist by checksums. This endpoint requires the `asset.upload` permission.
/// Determine which assets have already been uploaded to the server based on their SHA1 checksums.
///
/// Note: This method returns the HTTP [Response].
///
@ -50,9 +50,9 @@ class AssetsApi {
);
}
/// checkBulkUpload
/// Check bulk upload
///
/// Checks if assets exist by checksums. This endpoint requires the `asset.upload` permission.
/// Determine which assets have already been uploaded to the server based on their SHA1 checksums.
///
/// Parameters:
///
@ -72,7 +72,7 @@ class AssetsApi {
return null;
}
/// checkExistingAssets
/// Check existing assets
///
/// Checks if multiple assets exist on the server and returns all existing - used by background backup
///
@ -106,7 +106,7 @@ class AssetsApi {
);
}
/// checkExistingAssets
/// Check existing assets
///
/// Checks if multiple assets exist on the server and returns all existing - used by background backup
///
@ -128,7 +128,9 @@ class AssetsApi {
return null;
}
/// This endpoint requires the `asset.copy` permission.
/// Copy asset
///
/// Copy asset information like albums, tags, etc. from one asset to another.
///
/// Note: This method returns the HTTP [Response].
///
@ -160,7 +162,9 @@ class AssetsApi {
);
}
/// This endpoint requires the `asset.copy` permission.
/// Copy asset
///
/// Copy asset information like albums, tags, etc. from one asset to another.
///
/// Parameters:
///
@ -172,7 +176,9 @@ class AssetsApi {
}
}
/// This endpoint requires the `asset.update` permission.
/// Delete asset metadata by key
///
/// Delete a specific metadata key-value pair associated with the specified asset.
///
/// Note: This method returns the HTTP [Response].
///
@ -208,7 +214,9 @@ class AssetsApi {
);
}
/// This endpoint requires the `asset.update` permission.
/// Delete asset metadata by key
///
/// Delete a specific metadata key-value pair associated with the specified asset.
///
/// Parameters:
///
@ -222,7 +230,9 @@ class AssetsApi {
}
}
/// This endpoint requires the `asset.delete` permission.
/// Delete assets
///
/// Deletes multiple assets at the same time.
///
/// Note: This method returns the HTTP [Response].
///
@ -254,7 +264,9 @@ class AssetsApi {
);
}
/// This endpoint requires the `asset.delete` permission.
/// Delete assets
///
/// Deletes multiple assets at the same time.
///
/// Parameters:
///
@ -266,7 +278,9 @@ class AssetsApi {
}
}
/// This endpoint requires the `asset.download` permission.
/// Download original asset
///
/// Downloads the original file of the specified asset.
///
/// Note: This method returns the HTTP [Response].
///
@ -310,7 +324,9 @@ class AssetsApi {
);
}
/// This endpoint requires the `asset.download` permission.
/// Download original asset
///
/// Downloads the original file of the specified asset.
///
/// Parameters:
///
@ -334,9 +350,9 @@ class AssetsApi {
return null;
}
/// getAllUserAssetsByDeviceId
/// Retrieve assets by device ID
///
/// Get all asset of a device that are in the database, ID only.
/// This property was deprecated in v2.0.0. Get all asset of a device that are in the database, ID only.
///
/// Note: This method returns the HTTP [Response].
///
@ -369,9 +385,9 @@ class AssetsApi {
);
}
/// getAllUserAssetsByDeviceId
/// Retrieve assets by device ID
///
/// Get all asset of a device that are in the database, ID only.
/// This property was deprecated in v2.0.0. Get all asset of a device that are in the database, ID only.
///
/// Parameters:
///
@ -394,7 +410,9 @@ class AssetsApi {
return null;
}
/// This endpoint requires the `asset.read` permission.
/// Retrieve an asset
///
/// Retrieve detailed information about a specific asset.
///
/// Note: This method returns the HTTP [Response].
///
@ -438,7 +456,9 @@ class AssetsApi {
);
}
/// This endpoint requires the `asset.read` permission.
/// Retrieve an asset
///
/// Retrieve detailed information about a specific asset.
///
/// Parameters:
///
@ -462,7 +482,9 @@ class AssetsApi {
return null;
}
/// This endpoint requires the `asset.read` permission.
/// Get asset metadata
///
/// Retrieve all metadata key-value pairs associated with the specified asset.
///
/// Note: This method returns the HTTP [Response].
///
@ -495,7 +517,9 @@ class AssetsApi {
);
}
/// This endpoint requires the `asset.read` permission.
/// Get asset metadata
///
/// Retrieve all metadata key-value pairs associated with the specified asset.
///
/// Parameters:
///
@ -518,7 +542,9 @@ class AssetsApi {
return null;
}
/// This endpoint requires the `asset.read` permission.
/// Retrieve asset metadata by key
///
/// Retrieve the value of a specific metadata key associated with the specified asset.
///
/// Note: This method returns the HTTP [Response].
///
@ -554,7 +580,9 @@ class AssetsApi {
);
}
/// This endpoint requires the `asset.read` permission.
/// Retrieve asset metadata by key
///
/// Retrieve the value of a specific metadata key associated with the specified asset.
///
/// Parameters:
///
@ -576,7 +604,9 @@ class AssetsApi {
return null;
}
/// This endpoint requires the `asset.read` permission.
/// Retrieve asset OCR data
///
/// Retrieve all OCR (Optical Character Recognition) data associated with the specified asset.
///
/// Note: This method returns the HTTP [Response].
///
@ -609,7 +639,9 @@ class AssetsApi {
);
}
/// This endpoint requires the `asset.read` permission.
/// Retrieve asset OCR data
///
/// Retrieve all OCR (Optical Character Recognition) data associated with the specified asset.
///
/// Parameters:
///
@ -632,7 +664,9 @@ class AssetsApi {
return null;
}
/// This endpoint requires the `asset.statistics` permission.
/// Get asset statistics
///
/// Retrieve various statistics about the assets owned by the authenticated user.
///
/// Note: This method returns the HTTP [Response].
///
@ -678,7 +712,9 @@ class AssetsApi {
);
}
/// This endpoint requires the `asset.statistics` permission.
/// Get asset statistics
///
/// Retrieve various statistics about the assets owned by the authenticated user.
///
/// Parameters:
///
@ -702,7 +738,9 @@ class AssetsApi {
return null;
}
/// This property was deprecated in v1.116.0. This endpoint requires the `asset.read` permission.
/// Get random assets
///
/// This property was deprecated in v1.116.0. Retrieve a specified number of random assets for the authenticated user.
///
/// Note: This method returns the HTTP [Response].
///
@ -738,7 +776,9 @@ class AssetsApi {
);
}
/// This property was deprecated in v1.116.0. This endpoint requires the `asset.read` permission.
/// Get random assets
///
/// This property was deprecated in v1.116.0. Retrieve a specified number of random assets for the authenticated user.
///
/// Parameters:
///
@ -761,7 +801,9 @@ class AssetsApi {
return null;
}
/// This endpoint requires the `asset.view` permission.
/// Play asset video
///
/// Streams the video file for the specified asset. This endpoint also supports byte range requests.
///
/// Note: This method returns the HTTP [Response].
///
@ -805,7 +847,9 @@ class AssetsApi {
);
}
/// This endpoint requires the `asset.view` permission.
/// Play asset video
///
/// Streams the video file for the specified asset. This endpoint also supports byte range requests.
///
/// Parameters:
///
@ -829,9 +873,9 @@ class AssetsApi {
return null;
}
/// Replace the asset with new file, without changing its id
/// Replace asset
///
/// This property was deprecated in v1.142.0. Replace the asset with new file, without changing its id. This endpoint requires the `asset.replace` permission.
/// This property was deprecated in v1.142.0. Replace the asset with new file, without changing its id.
///
/// Note: This method returns the HTTP [Response].
///
@ -923,9 +967,9 @@ class AssetsApi {
);
}
/// Replace the asset with new file, without changing its id
/// Replace asset
///
/// This property was deprecated in v1.142.0. Replace the asset with new file, without changing its id. This endpoint requires the `asset.replace` permission.
/// This property was deprecated in v1.142.0. Replace the asset with new file, without changing its id.
///
/// Parameters:
///
@ -963,7 +1007,12 @@ class AssetsApi {
return null;
}
/// Performs an HTTP 'POST /assets/jobs' operation and returns the [Response].
/// Run an asset job
///
/// Run a specific job on a set of assets.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [AssetJobsDto] assetJobsDto (required):
@ -992,6 +1041,10 @@ class AssetsApi {
);
}
/// Run an asset job
///
/// Run a specific job on a set of assets.
///
/// Parameters:
///
/// * [AssetJobsDto] assetJobsDto (required):
@ -1002,7 +1055,9 @@ class AssetsApi {
}
}
/// This endpoint requires the `asset.update` permission.
/// Update an asset
///
/// Update information of a specific asset.
///
/// Note: This method returns the HTTP [Response].
///
@ -1037,7 +1092,9 @@ class AssetsApi {
);
}
/// This endpoint requires the `asset.update` permission.
/// Update an asset
///
/// Update information of a specific asset.
///
/// Parameters:
///
@ -1059,7 +1116,9 @@ class AssetsApi {
return null;
}
/// This endpoint requires the `asset.update` permission.
/// Update asset metadata
///
/// Update or add metadata key-value pairs for the specified asset.
///
/// Note: This method returns the HTTP [Response].
///
@ -1094,7 +1153,9 @@ class AssetsApi {
);
}
/// This endpoint requires the `asset.update` permission.
/// Update asset metadata
///
/// Update or add metadata key-value pairs for the specified asset.
///
/// Parameters:
///
@ -1119,7 +1180,9 @@ class AssetsApi {
return null;
}
/// This endpoint requires the `asset.update` permission.
/// Update assets
///
/// Updates multiple assets at the same time.
///
/// Note: This method returns the HTTP [Response].
///
@ -1151,7 +1214,9 @@ class AssetsApi {
);
}
/// This endpoint requires the `asset.update` permission.
/// Update assets
///
/// Updates multiple assets at the same time.
///
/// Parameters:
///
@ -1163,7 +1228,9 @@ class AssetsApi {
}
}
/// This endpoint requires the `asset.upload` permission.
/// Upload asset
///
/// Uploads a new asset to the server.
///
/// Note: This method returns the HTTP [Response].
///
@ -1290,7 +1357,9 @@ class AssetsApi {
);
}
/// This endpoint requires the `asset.upload` permission.
/// Upload asset
///
/// Uploads a new asset to the server.
///
/// Parameters:
///
@ -1339,7 +1408,9 @@ class AssetsApi {
return null;
}
/// This endpoint requires the `asset.view` permission.
/// View asset thumbnail
///
/// Retrieve the thumbnail image for the specified asset.
///
/// Note: This method returns the HTTP [Response].
///
@ -1388,7 +1459,9 @@ class AssetsApi {
);
}
/// This endpoint requires the `asset.view` permission.
/// View asset thumbnail
///
/// Retrieve the thumbnail image for the specified asset.
///
/// Parameters:
///

12
mobile/openapi/lib/api/auth_admin_api.dart → mobile/openapi/lib/api/authentication_admin_api.dart generated
View file

@ -11,12 +11,14 @@
part of openapi.api;
class AuthAdminApi {
AuthAdminApi([ApiClient? apiClient]) : apiClient = apiClient ?? defaultApiClient;
class AuthenticationAdminApi {
AuthenticationAdminApi([ApiClient? apiClient]) : apiClient = apiClient ?? defaultApiClient;
final ApiClient apiClient;
/// This endpoint is an admin-only route, and requires the `adminAuth.unlinkAll` permission.
/// Unlink all OAuth accounts
///
/// Unlinks all OAuth accounts associated with user accounts in the system.
///
/// Note: This method returns the HTTP [Response].
Future<Response> unlinkAllOAuthAccountsAdminWithHttpInfo() async {
@ -44,7 +46,9 @@ class AuthAdminApi {
);
}
/// This endpoint is an admin-only route, and requires the `adminAuth.unlinkAll` permission.
/// Unlink all OAuth accounts
///
/// Unlinks all OAuth accounts associated with user accounts in the system.
Future<void> unlinkAllOAuthAccountsAdmin() async {
final response = await unlinkAllOAuthAccountsAdminWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {

357
mobile/openapi/lib/api/authentication_api.dart generated
View file

@ -16,7 +16,9 @@ class AuthenticationApi {
final ApiClient apiClient;
/// This endpoint requires the `auth.changePassword` permission.
/// Change password
///
/// Change the password of the current user.
///
/// Note: This method returns the HTTP [Response].
///
@ -48,7 +50,9 @@ class AuthenticationApi {
);
}
/// This endpoint requires the `auth.changePassword` permission.
/// Change password
///
/// Change the password of the current user.
///
/// Parameters:
///
@ -68,7 +72,9 @@ class AuthenticationApi {
return null;
}
/// This endpoint requires the `pinCode.update` permission.
/// Change pin code
///
/// Change the pin code for the current user.
///
/// Note: This method returns the HTTP [Response].
///
@ -100,7 +106,9 @@ class AuthenticationApi {
);
}
/// This endpoint requires the `pinCode.update` permission.
/// Change pin code
///
/// Change the pin code for the current user.
///
/// Parameters:
///
@ -112,7 +120,67 @@ class AuthenticationApi {
}
}
/// Performs an HTTP 'GET /auth/status' operation and returns the [Response].
/// Finish OAuth
///
/// Complete the OAuth authorization process by exchanging the authorization code for a session token.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [OAuthCallbackDto] oAuthCallbackDto (required):
Future<Response> finishOAuthWithHttpInfo(OAuthCallbackDto oAuthCallbackDto,) async {
// ignore: prefer_const_declarations
final apiPath = r'/oauth/callback';
// ignore: prefer_final_locals
Object? postBody = oAuthCallbackDto;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>['application/json'];
return apiClient.invokeAPI(
apiPath,
'POST',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
/// Finish OAuth
///
/// Complete the OAuth authorization process by exchanging the authorization code for a session token.
///
/// Parameters:
///
/// * [OAuthCallbackDto] oAuthCallbackDto (required):
Future<LoginResponseDto?> finishOAuth(OAuthCallbackDto oAuthCallbackDto,) async {
final response = await finishOAuthWithHttpInfo(oAuthCallbackDto,);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'LoginResponseDto',) as LoginResponseDto;
}
return null;
}
/// Retrieve auth status
///
/// Get information about the current session, including whether the user has a password, and if the session can access locked assets.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getAuthStatusWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = r'/auth/status';
@ -138,6 +206,9 @@ class AuthenticationApi {
);
}
/// Retrieve auth status
///
/// Get information about the current session, including whether the user has a password, and if the session can access locked assets.
Future<AuthStatusResponseDto?> getAuthStatus() async {
final response = await getAuthStatusWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -153,7 +224,67 @@ class AuthenticationApi {
return null;
}
/// Performs an HTTP 'POST /auth/session/lock' operation and returns the [Response].
/// Link OAuth account
///
/// Link an OAuth account to the authenticated user.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [OAuthCallbackDto] oAuthCallbackDto (required):
Future<Response> linkOAuthAccountWithHttpInfo(OAuthCallbackDto oAuthCallbackDto,) async {
// ignore: prefer_const_declarations
final apiPath = r'/oauth/link';
// ignore: prefer_final_locals
Object? postBody = oAuthCallbackDto;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>['application/json'];
return apiClient.invokeAPI(
apiPath,
'POST',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
/// Link OAuth account
///
/// Link an OAuth account to the authenticated user.
///
/// Parameters:
///
/// * [OAuthCallbackDto] oAuthCallbackDto (required):
Future<UserAdminResponseDto?> linkOAuthAccount(OAuthCallbackDto oAuthCallbackDto,) async {
final response = await linkOAuthAccountWithHttpInfo(oAuthCallbackDto,);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'UserAdminResponseDto',) as UserAdminResponseDto;
}
return null;
}
/// Lock auth session
///
/// Remove elevated access to locked assets from the current session.
///
/// Note: This method returns the HTTP [Response].
Future<Response> lockAuthSessionWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = r'/auth/session/lock';
@ -179,6 +310,9 @@ class AuthenticationApi {
);
}
/// Lock auth session
///
/// Remove elevated access to locked assets from the current session.
Future<void> lockAuthSession() async {
final response = await lockAuthSessionWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -186,7 +320,12 @@ class AuthenticationApi {
}
}
/// Performs an HTTP 'POST /auth/login' operation and returns the [Response].
/// Login
///
/// Login with username and password and receive a session token.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [LoginCredentialDto] loginCredentialDto (required):
@ -215,6 +354,10 @@ class AuthenticationApi {
);
}
/// Login
///
/// Login with username and password and receive a session token.
///
/// Parameters:
///
/// * [LoginCredentialDto] loginCredentialDto (required):
@ -233,7 +376,11 @@ class AuthenticationApi {
return null;
}
/// Performs an HTTP 'POST /auth/logout' operation and returns the [Response].
/// Logout
///
/// Logout the current user and invalidate the session token.
///
/// Note: This method returns the HTTP [Response].
Future<Response> logoutWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = r'/auth/logout';
@ -259,6 +406,9 @@ class AuthenticationApi {
);
}
/// Logout
///
/// Logout the current user and invalidate the session token.
Future<LogoutResponseDto?> logout() async {
final response = await logoutWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -274,7 +424,49 @@ class AuthenticationApi {
return null;
}
/// This endpoint requires the `pinCode.delete` permission.
/// Redirect OAuth to mobile
///
/// Requests to this URL are automatically forwarded to the mobile app, and is used in some cases for OAuth redirecting.
///
/// Note: This method returns the HTTP [Response].
Future<Response> redirectOAuthToMobileWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = r'/oauth/mobile-redirect';
// ignore: prefer_final_locals
Object? postBody;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>[];
return apiClient.invokeAPI(
apiPath,
'GET',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
/// Redirect OAuth to mobile
///
/// Requests to this URL are automatically forwarded to the mobile app, and is used in some cases for OAuth redirecting.
Future<void> redirectOAuthToMobile() async {
final response = await redirectOAuthToMobileWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
}
/// Reset pin code
///
/// Reset the pin code for the current user by providing the account password
///
/// Note: This method returns the HTTP [Response].
///
@ -306,7 +498,9 @@ class AuthenticationApi {
);
}
/// This endpoint requires the `pinCode.delete` permission.
/// Reset pin code
///
/// Reset the pin code for the current user by providing the account password
///
/// Parameters:
///
@ -318,7 +512,9 @@ class AuthenticationApi {
}
}
/// This endpoint requires the `pinCode.create` permission.
/// Setup pin code
///
/// Setup a new pin code for the current user.
///
/// Note: This method returns the HTTP [Response].
///
@ -350,7 +546,9 @@ class AuthenticationApi {
);
}
/// This endpoint requires the `pinCode.create` permission.
/// Setup pin code
///
/// Setup a new pin code for the current user.
///
/// Parameters:
///
@ -362,7 +560,12 @@ class AuthenticationApi {
}
}
/// Performs an HTTP 'POST /auth/admin-sign-up' operation and returns the [Response].
/// Register admin
///
/// Create the first admin user in the system.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [SignUpDto] signUpDto (required):
@ -391,6 +594,10 @@ class AuthenticationApi {
);
}
/// Register admin
///
/// Create the first admin user in the system.
///
/// Parameters:
///
/// * [SignUpDto] signUpDto (required):
@ -409,7 +616,116 @@ class AuthenticationApi {
return null;
}
/// Performs an HTTP 'POST /auth/session/unlock' operation and returns the [Response].
/// Start OAuth
///
/// Initiate the OAuth authorization process.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [OAuthConfigDto] oAuthConfigDto (required):
Future<Response> startOAuthWithHttpInfo(OAuthConfigDto oAuthConfigDto,) async {
// ignore: prefer_const_declarations
final apiPath = r'/oauth/authorize';
// ignore: prefer_final_locals
Object? postBody = oAuthConfigDto;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>['application/json'];
return apiClient.invokeAPI(
apiPath,
'POST',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
/// Start OAuth
///
/// Initiate the OAuth authorization process.
///
/// Parameters:
///
/// * [OAuthConfigDto] oAuthConfigDto (required):
Future<OAuthAuthorizeResponseDto?> startOAuth(OAuthConfigDto oAuthConfigDto,) async {
final response = await startOAuthWithHttpInfo(oAuthConfigDto,);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'OAuthAuthorizeResponseDto',) as OAuthAuthorizeResponseDto;
}
return null;
}
/// Unlink OAuth account
///
/// Unlink the OAuth account from the authenticated user.
///
/// Note: This method returns the HTTP [Response].
Future<Response> unlinkOAuthAccountWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = r'/oauth/unlink';
// ignore: prefer_final_locals
Object? postBody;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>[];
return apiClient.invokeAPI(
apiPath,
'POST',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
/// Unlink OAuth account
///
/// Unlink the OAuth account from the authenticated user.
Future<UserAdminResponseDto?> unlinkOAuthAccount() async {
final response = await unlinkOAuthAccountWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'UserAdminResponseDto',) as UserAdminResponseDto;
}
return null;
}
/// Unlock auth session
///
/// Temporarily grant the session elevated access to locked assets by providing the correct PIN code.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [SessionUnlockDto] sessionUnlockDto (required):
@ -438,6 +754,10 @@ class AuthenticationApi {
);
}
/// Unlock auth session
///
/// Temporarily grant the session elevated access to locked assets by providing the correct PIN code.
///
/// Parameters:
///
/// * [SessionUnlockDto] sessionUnlockDto (required):
@ -448,7 +768,11 @@ class AuthenticationApi {
}
}
/// Performs an HTTP 'POST /auth/validateToken' operation and returns the [Response].
/// Validate access token
///
/// Validate the current authorization method is still valid.
///
/// Note: This method returns the HTTP [Response].
Future<Response> validateAccessTokenWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = r'/auth/validateToken';
@ -474,6 +798,9 @@ class AuthenticationApi {
);
}
/// Validate access token
///
/// Validate the current authorization method is still valid.
Future<ValidateAccessTokenResponseDto?> validateAccessToken() async {
final response = await validateAccessTokenWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {

199
mobile/openapi/lib/api/deprecated_api.dart generated
View file

@ -16,7 +16,9 @@ class DeprecatedApi {
final ApiClient apiClient;
/// This property was deprecated in v1.141.0. This endpoint requires the `partner.create` permission.
/// Create a partner
///
/// This property was deprecated in v1.141.0. Create a new partner to share assets with.
///
/// Note: This method returns the HTTP [Response].
///
@ -49,7 +51,9 @@ class DeprecatedApi {
);
}
/// This property was deprecated in v1.141.0. This endpoint requires the `partner.create` permission.
/// Create a partner
///
/// This property was deprecated in v1.141.0. Create a new partner to share assets with.
///
/// Parameters:
///
@ -69,7 +73,184 @@ class DeprecatedApi {
return null;
}
/// This property was deprecated in v1.116.0. This endpoint requires the `asset.read` permission.
/// Retrieve assets by device ID
///
/// This property was deprecated in v2.0.0. Get all asset of a device that are in the database, ID only.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] deviceId (required):
Future<Response> getAllUserAssetsByDeviceIdWithHttpInfo(String deviceId,) async {
// ignore: prefer_const_declarations
final apiPath = r'/assets/device/{deviceId}'
.replaceAll('{deviceId}', deviceId);
// ignore: prefer_final_locals
Object? postBody;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>[];
return apiClient.invokeAPI(
apiPath,
'GET',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
/// Retrieve assets by device ID
///
/// This property was deprecated in v2.0.0. Get all asset of a device that are in the database, ID only.
///
/// Parameters:
///
/// * [String] deviceId (required):
Future<List<String>?> getAllUserAssetsByDeviceId(String deviceId,) async {
final response = await getAllUserAssetsByDeviceIdWithHttpInfo(deviceId,);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
final responseBody = await _decodeBodyBytes(response);
return (await apiClient.deserializeAsync(responseBody, 'List<String>') as List)
.cast<String>()
.toList(growable: false);
}
return null;
}
/// Get delta sync for user
///
/// This property was deprecated in v2.0.0. Retrieve changed assets since the last sync for the authenticated user.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [AssetDeltaSyncDto] assetDeltaSyncDto (required):
Future<Response> getDeltaSyncWithHttpInfo(AssetDeltaSyncDto assetDeltaSyncDto,) async {
// ignore: prefer_const_declarations
final apiPath = r'/sync/delta-sync';
// ignore: prefer_final_locals
Object? postBody = assetDeltaSyncDto;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>['application/json'];
return apiClient.invokeAPI(
apiPath,
'POST',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
/// Get delta sync for user
///
/// This property was deprecated in v2.0.0. Retrieve changed assets since the last sync for the authenticated user.
///
/// Parameters:
///
/// * [AssetDeltaSyncDto] assetDeltaSyncDto (required):
Future<AssetDeltaSyncResponseDto?> getDeltaSync(AssetDeltaSyncDto assetDeltaSyncDto,) async {
final response = await getDeltaSyncWithHttpInfo(assetDeltaSyncDto,);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'AssetDeltaSyncResponseDto',) as AssetDeltaSyncResponseDto;
}
return null;
}
/// Get full sync for user
///
/// This property was deprecated in v2.0.0. Retrieve all assets for a full synchronization for the authenticated user.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [AssetFullSyncDto] assetFullSyncDto (required):
Future<Response> getFullSyncForUserWithHttpInfo(AssetFullSyncDto assetFullSyncDto,) async {
// ignore: prefer_const_declarations
final apiPath = r'/sync/full-sync';
// ignore: prefer_final_locals
Object? postBody = assetFullSyncDto;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>['application/json'];
return apiClient.invokeAPI(
apiPath,
'POST',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
/// Get full sync for user
///
/// This property was deprecated in v2.0.0. Retrieve all assets for a full synchronization for the authenticated user.
///
/// Parameters:
///
/// * [AssetFullSyncDto] assetFullSyncDto (required):
Future<List<AssetResponseDto>?> getFullSyncForUser(AssetFullSyncDto assetFullSyncDto,) async {
final response = await getFullSyncForUserWithHttpInfo(assetFullSyncDto,);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
final responseBody = await _decodeBodyBytes(response);
return (await apiClient.deserializeAsync(responseBody, 'List<AssetResponseDto>') as List)
.cast<AssetResponseDto>()
.toList(growable: false);
}
return null;
}
/// Get random assets
///
/// This property was deprecated in v1.116.0. Retrieve a specified number of random assets for the authenticated user.
///
/// Note: This method returns the HTTP [Response].
///
@ -105,7 +286,9 @@ class DeprecatedApi {
);
}
/// This property was deprecated in v1.116.0. This endpoint requires the `asset.read` permission.
/// Get random assets
///
/// This property was deprecated in v1.116.0. Retrieve a specified number of random assets for the authenticated user.
///
/// Parameters:
///
@ -128,9 +311,9 @@ class DeprecatedApi {
return null;
}
/// Replace the asset with new file, without changing its id
/// Replace asset
///
/// This property was deprecated in v1.142.0. Replace the asset with new file, without changing its id. This endpoint requires the `asset.replace` permission.
/// This property was deprecated in v1.142.0. Replace the asset with new file, without changing its id.
///
/// Note: This method returns the HTTP [Response].
///
@ -222,9 +405,9 @@ class DeprecatedApi {
);
}
/// Replace the asset with new file, without changing its id
/// Replace asset
///
/// This property was deprecated in v1.142.0. Replace the asset with new file, without changing its id. This endpoint requires the `asset.replace` permission.
/// This property was deprecated in v1.142.0. Replace the asset with new file, without changing its id.
///
/// Parameters:
///

16
mobile/openapi/lib/api/download_api.dart generated
View file

@ -16,7 +16,9 @@ class DownloadApi {
final ApiClient apiClient;
/// This endpoint requires the `asset.download` permission.
/// Download asset archive
///
/// Download a ZIP archive containing the specified assets. The assets must have been previously requested via the \"getDownloadInfo\" endpoint.
///
/// Note: This method returns the HTTP [Response].
///
@ -59,7 +61,9 @@ class DownloadApi {
);
}
/// This endpoint requires the `asset.download` permission.
/// Download asset archive
///
/// Download a ZIP archive containing the specified assets. The assets must have been previously requested via the \"getDownloadInfo\" endpoint.
///
/// Parameters:
///
@ -83,7 +87,9 @@ class DownloadApi {
return null;
}
/// This endpoint requires the `asset.download` permission.
/// 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.
///
/// Note: This method returns the HTTP [Response].
///
@ -126,7 +132,9 @@ class DownloadApi {
);
}
/// This endpoint requires the `asset.download` permission.
/// 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.
///
/// Parameters:
///

24
mobile/openapi/lib/api/duplicates_api.dart generated
View file

@ -16,7 +16,9 @@ class DuplicatesApi {
final ApiClient apiClient;
/// This endpoint requires the `duplicate.delete` permission.
/// Delete a duplicate
///
/// Delete a single duplicate asset specified by its ID.
///
/// Note: This method returns the HTTP [Response].
///
@ -49,7 +51,9 @@ class DuplicatesApi {
);
}
/// This endpoint requires the `duplicate.delete` permission.
/// Delete a duplicate
///
/// Delete a single duplicate asset specified by its ID.
///
/// Parameters:
///
@ -61,7 +65,9 @@ class DuplicatesApi {
}
}
/// This endpoint requires the `duplicate.delete` permission.
/// Delete duplicates
///
/// Delete multiple duplicate assets specified by their IDs.
///
/// Note: This method returns the HTTP [Response].
///
@ -93,7 +99,9 @@ class DuplicatesApi {
);
}
/// This endpoint requires the `duplicate.delete` permission.
/// Delete duplicates
///
/// Delete multiple duplicate assets specified by their IDs.
///
/// Parameters:
///
@ -105,7 +113,9 @@ class DuplicatesApi {
}
}
/// This endpoint requires the `duplicate.read` permission.
/// Retrieve duplicates
///
/// Retrieve a list of duplicate assets available to the authenticated user.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getAssetDuplicatesWithHttpInfo() async {
@ -133,7 +143,9 @@ class DuplicatesApi {
);
}
/// This endpoint requires the `duplicate.read` permission.
/// Retrieve duplicates
///
/// Retrieve a list of duplicate assets available to the authenticated user.
Future<List<DuplicateResponseDto>?> getAssetDuplicates() async {
final response = await getAssetDuplicatesWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {

32
mobile/openapi/lib/api/faces_api.dart generated
View file

@ -16,7 +16,9 @@ class FacesApi {
final ApiClient apiClient;
/// This endpoint requires the `face.create` permission.
/// Create a face
///
/// Create a new face that has not been discovered by facial recognition. The content of the bounding box is considered a face.
///
/// Note: This method returns the HTTP [Response].
///
@ -48,7 +50,9 @@ class FacesApi {
);
}
/// This endpoint requires the `face.create` permission.
/// Create a face
///
/// Create a new face that has not been discovered by facial recognition. The content of the bounding box is considered a face.
///
/// Parameters:
///
@ -60,7 +64,9 @@ class FacesApi {
}
}
/// This endpoint requires the `face.delete` permission.
/// Delete a face
///
/// Delete a face identified by the id. Optionally can be force deleted.
///
/// Note: This method returns the HTTP [Response].
///
@ -95,7 +101,9 @@ class FacesApi {
);
}
/// This endpoint requires the `face.delete` permission.
/// Delete a face
///
/// Delete a face identified by the id. Optionally can be force deleted.
///
/// Parameters:
///
@ -109,7 +117,9 @@ class FacesApi {
}
}
/// This endpoint requires the `face.read` permission.
/// Retrieve faces for asset
///
/// Retrieve all faces belonging to an asset.
///
/// Note: This method returns the HTTP [Response].
///
@ -143,7 +153,9 @@ class FacesApi {
);
}
/// This endpoint requires the `face.read` permission.
/// Retrieve faces for asset
///
/// Retrieve all faces belonging to an asset.
///
/// Parameters:
///
@ -166,7 +178,9 @@ class FacesApi {
return null;
}
/// This endpoint requires the `face.update` permission.
/// Re-assign a face to another person
///
/// Re-assign the face provided in the body to the person identified by the id in the path parameter.
///
/// Note: This method returns the HTTP [Response].
///
@ -201,7 +215,9 @@ class FacesApi {
);
}
/// This endpoint requires the `face.update` permission.
/// Re-assign a face to another person
///
/// Re-assign the face provided in the body to the person identified by the id in the path parameter.
///
/// Parameters:
///

24
mobile/openapi/lib/api/jobs_api.dart generated
View file

@ -16,7 +16,9 @@ class JobsApi {
final ApiClient apiClient;
/// This endpoint is an admin-only route, and requires the `job.create` permission.
/// 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.
///
/// Note: This method returns the HTTP [Response].
///
@ -48,7 +50,9 @@ class JobsApi {
);
}
/// This endpoint is an admin-only route, and requires the `job.create` permission.
/// 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.
///
/// Parameters:
///
@ -60,7 +64,9 @@ class JobsApi {
}
}
/// This endpoint is an admin-only route, and requires the `job.read` permission.
/// Retrieve queue counts and status
///
/// Retrieve the counts of the current queue, as well as the current status.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getAllJobsStatusWithHttpInfo() async {
@ -88,7 +94,9 @@ class JobsApi {
);
}
/// This endpoint is an admin-only route, and requires the `job.read` permission.
/// Retrieve queue counts and status
///
/// Retrieve the counts of the current queue, as well as the current status.
Future<AllJobStatusResponseDto?> getAllJobsStatus() async {
final response = await getAllJobsStatusWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -104,7 +112,9 @@ class JobsApi {
return null;
}
/// This endpoint is an admin-only route, and requires the `job.create` permission.
/// 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.
///
/// Note: This method returns the HTTP [Response].
///
@ -139,7 +149,9 @@ class JobsApi {
);
}
/// This endpoint is an admin-only route, and requires the `job.create` permission.
/// 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.
///
/// Parameters:
///

67
mobile/openapi/lib/api/libraries_api.dart generated
View file

@ -16,7 +16,9 @@ class LibrariesApi {
final ApiClient apiClient;
/// This endpoint is an admin-only route, and requires the `library.create` permission.
/// Create a library
///
/// Create a new external library.
///
/// Note: This method returns the HTTP [Response].
///
@ -48,7 +50,9 @@ class LibrariesApi {
);
}
/// This endpoint is an admin-only route, and requires the `library.create` permission.
/// Create a library
///
/// Create a new external library.
///
/// Parameters:
///
@ -68,7 +72,9 @@ class LibrariesApi {
return null;
}
/// This endpoint is an admin-only route, and requires the `library.delete` permission.
/// Delete a library
///
/// Delete an external library by its ID.
///
/// Note: This method returns the HTTP [Response].
///
@ -101,7 +107,9 @@ class LibrariesApi {
);
}
/// This endpoint is an admin-only route, and requires the `library.delete` permission.
/// Delete a library
///
/// Delete an external library by its ID.
///
/// Parameters:
///
@ -113,7 +121,9 @@ class LibrariesApi {
}
}
/// This endpoint is an admin-only route, and requires the `library.read` permission.
/// Retrieve libraries
///
/// Retrieve a list of external libraries.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getAllLibrariesWithHttpInfo() async {
@ -141,7 +151,9 @@ class LibrariesApi {
);
}
/// This endpoint is an admin-only route, and requires the `library.read` permission.
/// Retrieve libraries
///
/// Retrieve a list of external libraries.
Future<List<LibraryResponseDto>?> getAllLibraries() async {
final response = await getAllLibrariesWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -160,7 +172,9 @@ class LibrariesApi {
return null;
}
/// This endpoint is an admin-only route, and requires the `library.read` permission.
/// Retrieve a library
///
/// Retrieve an external library by its ID.
///
/// Note: This method returns the HTTP [Response].
///
@ -193,7 +207,9 @@ class LibrariesApi {
);
}
/// This endpoint is an admin-only route, and requires the `library.read` permission.
/// Retrieve a library
///
/// Retrieve an external library by its ID.
///
/// Parameters:
///
@ -213,7 +229,9 @@ class LibrariesApi {
return null;
}
/// This endpoint is an admin-only route, and requires the `library.statistics` permission.
/// Retrieve library statistics
///
/// Retrieve statistics for a specific external library, including number of videos, images, and storage usage.
///
/// Note: This method returns the HTTP [Response].
///
@ -246,7 +264,9 @@ class LibrariesApi {
);
}
/// This endpoint is an admin-only route, and requires the `library.statistics` permission.
/// Retrieve library statistics
///
/// Retrieve statistics for a specific external library, including number of videos, images, and storage usage.
///
/// Parameters:
///
@ -266,7 +286,9 @@ class LibrariesApi {
return null;
}
/// This endpoint is an admin-only route, and requires the `library.update` permission.
/// Scan a library
///
/// Queue a scan for the external library to find and import new assets.
///
/// Note: This method returns the HTTP [Response].
///
@ -299,7 +321,9 @@ class LibrariesApi {
);
}
/// This endpoint is an admin-only route, and requires the `library.update` permission.
/// Scan a library
///
/// Queue a scan for the external library to find and import new assets.
///
/// Parameters:
///
@ -311,7 +335,9 @@ class LibrariesApi {
}
}
/// This endpoint is an admin-only route, and requires the `library.update` permission.
/// Update a library
///
/// Update an existing external library.
///
/// Note: This method returns the HTTP [Response].
///
@ -346,7 +372,9 @@ class LibrariesApi {
);
}
/// This endpoint is an admin-only route, and requires the `library.update` permission.
/// Update a library
///
/// Update an existing external library.
///
/// Parameters:
///
@ -368,7 +396,12 @@ class LibrariesApi {
return null;
}
/// Performs an HTTP 'POST /libraries/{id}/validate' operation and returns the [Response].
/// Validate library settings
///
/// Validate the settings of an external library.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
@ -400,6 +433,10 @@ class LibrariesApi {
);
}
/// Validate library settings
///
/// Validate the settings of an external library.
///
/// Parameters:
///
/// * [String] id (required):

56
mobile/openapi/lib/api/map_api.dart generated
View file

@ -16,21 +16,26 @@ class MapApi {
final ApiClient apiClient;
/// Performs an HTTP 'GET /map/markers' operation and returns the [Response].
/// Retrieve map markers
///
/// Retrieve a list of latitude and longitude coordinates for every asset with location data.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [bool] isArchived:
///
/// * [bool] isFavorite:
///
/// * [DateTime] fileCreatedAfter:
///
/// * [DateTime] fileCreatedBefore:
///
/// * [bool] isArchived:
///
/// * [bool] isFavorite:
///
/// * [bool] withPartners:
///
/// * [bool] withSharedAlbums:
Future<Response> getMapMarkersWithHttpInfo({ bool? isArchived, bool? isFavorite, DateTime? fileCreatedAfter, DateTime? fileCreatedBefore, bool? withPartners, bool? withSharedAlbums, }) async {
Future<Response> getMapMarkersWithHttpInfo({ DateTime? fileCreatedAfter, DateTime? fileCreatedBefore, bool? isArchived, bool? isFavorite, bool? withPartners, bool? withSharedAlbums, }) async {
// ignore: prefer_const_declarations
final apiPath = r'/map/markers';
@ -41,18 +46,18 @@ class MapApi {
final headerParams = <String, String>{};
final formParams = <String, String>{};
if (isArchived != null) {
queryParams.addAll(_queryParams('', 'isArchived', isArchived));
}
if (isFavorite != null) {
queryParams.addAll(_queryParams('', 'isFavorite', isFavorite));
}
if (fileCreatedAfter != null) {
queryParams.addAll(_queryParams('', 'fileCreatedAfter', fileCreatedAfter));
}
if (fileCreatedBefore != null) {
queryParams.addAll(_queryParams('', 'fileCreatedBefore', fileCreatedBefore));
}
if (isArchived != null) {
queryParams.addAll(_queryParams('', 'isArchived', isArchived));
}
if (isFavorite != null) {
queryParams.addAll(_queryParams('', 'isFavorite', isFavorite));
}
if (withPartners != null) {
queryParams.addAll(_queryParams('', 'withPartners', withPartners));
}
@ -74,21 +79,25 @@ class MapApi {
);
}
/// Retrieve map markers
///
/// Retrieve a list of latitude and longitude coordinates for every asset with location data.
///
/// Parameters:
///
/// * [bool] isArchived:
///
/// * [bool] isFavorite:
///
/// * [DateTime] fileCreatedAfter:
///
/// * [DateTime] fileCreatedBefore:
///
/// * [bool] isArchived:
///
/// * [bool] isFavorite:
///
/// * [bool] withPartners:
///
/// * [bool] withSharedAlbums:
Future<List<MapMarkerResponseDto>?> getMapMarkers({ bool? isArchived, bool? isFavorite, DateTime? fileCreatedAfter, DateTime? fileCreatedBefore, bool? withPartners, bool? withSharedAlbums, }) async {
final response = await getMapMarkersWithHttpInfo( isArchived: isArchived, isFavorite: isFavorite, fileCreatedAfter: fileCreatedAfter, fileCreatedBefore: fileCreatedBefore, withPartners: withPartners, withSharedAlbums: withSharedAlbums, );
Future<List<MapMarkerResponseDto>?> getMapMarkers({ DateTime? fileCreatedAfter, DateTime? fileCreatedBefore, bool? isArchived, bool? isFavorite, bool? withPartners, bool? withSharedAlbums, }) async {
final response = await getMapMarkersWithHttpInfo( fileCreatedAfter: fileCreatedAfter, fileCreatedBefore: fileCreatedBefore, isArchived: isArchived, isFavorite: isFavorite, withPartners: withPartners, withSharedAlbums: withSharedAlbums, );
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
@ -105,7 +114,12 @@ class MapApi {
return null;
}
/// Performs an HTTP 'GET /map/reverse-geocode' operation and returns the [Response].
/// Reverse geocode coordinates
///
/// Retrieve location information (e.g., city, country) for given latitude and longitude coordinates.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [double] lat (required):
@ -139,6 +153,10 @@ class MapApi {
);
}
/// Reverse geocode coordinates
///
/// Retrieve location information (e.g., city, country) for given latitude and longitude coordinates.
///
/// Parameters:
///
/// * [double] lat (required):

64
mobile/openapi/lib/api/memories_api.dart generated
View file

@ -16,7 +16,9 @@ class MemoriesApi {
final ApiClient apiClient;
/// This endpoint requires the `memoryAsset.create` permission.
/// Add assets to a memory
///
/// Add a list of asset IDs to a specific memory.
///
/// Note: This method returns the HTTP [Response].
///
@ -51,7 +53,9 @@ class MemoriesApi {
);
}
/// This endpoint requires the `memoryAsset.create` permission.
/// Add assets to a memory
///
/// Add a list of asset IDs to a specific memory.
///
/// Parameters:
///
@ -76,7 +80,9 @@ class MemoriesApi {
return null;
}
/// This endpoint requires the `memory.create` permission.
/// Create a memory
///
/// Create a new memory by providing a name, description, and a list of asset IDs to include in the memory.
///
/// Note: This method returns the HTTP [Response].
///
@ -108,7 +114,9 @@ class MemoriesApi {
);
}
/// This endpoint requires the `memory.create` permission.
/// Create a memory
///
/// Create a new memory by providing a name, description, and a list of asset IDs to include in the memory.
///
/// Parameters:
///
@ -128,7 +136,9 @@ class MemoriesApi {
return null;
}
/// This endpoint requires the `memory.delete` permission.
/// Delete a memory
///
/// Delete a specific memory by its ID.
///
/// Note: This method returns the HTTP [Response].
///
@ -161,7 +171,9 @@ class MemoriesApi {
);
}
/// This endpoint requires the `memory.delete` permission.
/// Delete a memory
///
/// Delete a specific memory by its ID.
///
/// Parameters:
///
@ -173,7 +185,9 @@ class MemoriesApi {
}
}
/// This endpoint requires the `memory.read` permission.
/// Retrieve a memory
///
/// Retrieve a specific memory by its ID.
///
/// Note: This method returns the HTTP [Response].
///
@ -206,7 +220,9 @@ class MemoriesApi {
);
}
/// This endpoint requires the `memory.read` permission.
/// Retrieve a memory
///
/// Retrieve a specific memory by its ID.
///
/// Parameters:
///
@ -226,7 +242,9 @@ class MemoriesApi {
return null;
}
/// This endpoint requires the `memory.statistics` permission.
/// Retrieve memories statistics
///
/// Retrieve statistics about memories, such as total count and other relevant metrics.
///
/// Note: This method returns the HTTP [Response].
///
@ -288,7 +306,9 @@ class MemoriesApi {
);
}
/// This endpoint requires the `memory.statistics` permission.
/// Retrieve memories statistics
///
/// Retrieve statistics about memories, such as total count and other relevant metrics.
///
/// Parameters:
///
@ -319,7 +339,9 @@ class MemoriesApi {
return null;
}
/// This endpoint requires the `memoryAsset.delete` permission.
/// Remove assets from a memory
///
/// Remove a list of asset IDs from a specific memory.
///
/// Note: This method returns the HTTP [Response].
///
@ -354,7 +376,9 @@ class MemoriesApi {
);
}
/// This endpoint requires the `memoryAsset.delete` permission.
/// Remove assets from a memory
///
/// Remove a list of asset IDs from a specific memory.
///
/// Parameters:
///
@ -379,7 +403,9 @@ class MemoriesApi {
return null;
}
/// This endpoint requires the `memory.read` permission.
/// Retrieve memories
///
/// Retrieve a list of memories. Memories are sorted descending by creation date by default, although they can also be sorted in ascending order, or randomly.
///
/// Note: This method returns the HTTP [Response].
///
@ -441,7 +467,9 @@ class MemoriesApi {
);
}
/// This endpoint requires the `memory.read` permission.
/// Retrieve memories
///
/// Retrieve a list of memories. Memories are sorted descending by creation date by default, although they can also be sorted in ascending order, or randomly.
///
/// Parameters:
///
@ -475,7 +503,9 @@ class MemoriesApi {
return null;
}
/// This endpoint requires the `memory.update` permission.
/// Update a memory
///
/// Update an existing memory by its ID.
///
/// Note: This method returns the HTTP [Response].
///
@ -510,7 +540,9 @@ class MemoriesApi {
);
}
/// This endpoint requires the `memory.update` permission.
/// Update a memory
///
/// Update an existing memory by its ID.
///
/// Parameters:
///

33
mobile/openapi/lib/api/notifications_admin_api.dart generated
View file

@ -16,7 +16,12 @@ class NotificationsAdminApi {
final ApiClient apiClient;
/// Performs an HTTP 'POST /admin/notifications' operation and returns the [Response].
/// Create a notification
///
/// Create a new notification for a specific user.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [NotificationCreateDto] notificationCreateDto (required):
@ -45,6 +50,10 @@ class NotificationsAdminApi {
);
}
/// Create a notification
///
/// Create a new notification for a specific user.
///
/// Parameters:
///
/// * [NotificationCreateDto] notificationCreateDto (required):
@ -63,7 +72,12 @@ class NotificationsAdminApi {
return null;
}
/// Performs an HTTP 'POST /admin/notifications/templates/{name}' operation and returns the [Response].
/// Render email template
///
/// Retrieve a preview of the provided email template.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] name (required):
@ -95,6 +109,10 @@ class NotificationsAdminApi {
);
}
/// Render email template
///
/// Retrieve a preview of the provided email template.
///
/// Parameters:
///
/// * [String] name (required):
@ -115,7 +133,12 @@ class NotificationsAdminApi {
return null;
}
/// Performs an HTTP 'POST /admin/notifications/test-email' operation and returns the [Response].
/// Send test email
///
/// Send a test email using the provided SMTP configuration.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [SystemConfigSmtpDto] systemConfigSmtpDto (required):
@ -144,6 +167,10 @@ class NotificationsAdminApi {
);
}
/// Send test email
///
/// Send a test email using the provided SMTP configuration.
///
/// Parameters:
///
/// * [SystemConfigSmtpDto] systemConfigSmtpDto (required):

48
mobile/openapi/lib/api/notifications_api.dart generated
View file

@ -16,7 +16,9 @@ class NotificationsApi {
final ApiClient apiClient;
/// This endpoint requires the `notification.delete` permission.
/// Delete a notification
///
/// Delete a specific notification.
///
/// Note: This method returns the HTTP [Response].
///
@ -49,7 +51,9 @@ class NotificationsApi {
);
}
/// This endpoint requires the `notification.delete` permission.
/// Delete a notification
///
/// Delete a specific notification.
///
/// Parameters:
///
@ -61,7 +65,9 @@ class NotificationsApi {
}
}
/// This endpoint requires the `notification.delete` permission.
/// Delete notifications
///
/// Delete a list of notifications at once.
///
/// Note: This method returns the HTTP [Response].
///
@ -93,7 +99,9 @@ class NotificationsApi {
);
}
/// This endpoint requires the `notification.delete` permission.
/// Delete notifications
///
/// Delete a list of notifications at once.
///
/// Parameters:
///
@ -105,7 +113,9 @@ class NotificationsApi {
}
}
/// This endpoint requires the `notification.read` permission.
/// Get a notification
///
/// Retrieve a specific notification identified by id.
///
/// Note: This method returns the HTTP [Response].
///
@ -138,7 +148,9 @@ class NotificationsApi {
);
}
/// This endpoint requires the `notification.read` permission.
/// Get a notification
///
/// Retrieve a specific notification identified by id.
///
/// Parameters:
///
@ -158,7 +170,9 @@ class NotificationsApi {
return null;
}
/// This endpoint requires the `notification.read` permission.
/// Retrieve notifications
///
/// Retrieve a list of notifications.
///
/// Note: This method returns the HTTP [Response].
///
@ -209,7 +223,9 @@ class NotificationsApi {
);
}
/// This endpoint requires the `notification.read` permission.
/// Retrieve notifications
///
/// Retrieve a list of notifications.
///
/// Parameters:
///
@ -238,7 +254,9 @@ class NotificationsApi {
return null;
}
/// This endpoint requires the `notification.update` permission.
/// Update a notification
///
/// Update a specific notification to set its read status.
///
/// Note: This method returns the HTTP [Response].
///
@ -273,7 +291,9 @@ class NotificationsApi {
);
}
/// This endpoint requires the `notification.update` permission.
/// Update a notification
///
/// Update a specific notification to set its read status.
///
/// Parameters:
///
@ -295,7 +315,9 @@ class NotificationsApi {
return null;
}
/// This endpoint requires the `notification.update` permission.
/// Update notifications
///
/// Update a list of notifications. Allows to bulk-set the read status of notifications.
///
/// Note: This method returns the HTTP [Response].
///
@ -327,7 +349,9 @@ class NotificationsApi {
);
}
/// This endpoint requires the `notification.update` permission.
/// Update notifications
///
/// Update a list of notifications. Allows to bulk-set the read status of notifications.
///
/// Parameters:
///

233
mobile/openapi/lib/api/o_auth_api.dart generated
View file

@ -1,233 +0,0 @@
//
// AUTO-GENERATED FILE, DO NOT MODIFY!
//
// @dart=2.18
// ignore_for_file: unused_element, unused_import
// ignore_for_file: always_put_required_named_parameters_first
// ignore_for_file: constant_identifier_names
// ignore_for_file: lines_longer_than_80_chars
part of openapi.api;
class OAuthApi {
OAuthApi([ApiClient? apiClient]) : apiClient = apiClient ?? defaultApiClient;
final ApiClient apiClient;
/// Performs an HTTP 'POST /oauth/callback' operation and returns the [Response].
/// Parameters:
///
/// * [OAuthCallbackDto] oAuthCallbackDto (required):
Future<Response> finishOAuthWithHttpInfo(OAuthCallbackDto oAuthCallbackDto,) async {
// ignore: prefer_const_declarations
final apiPath = r'/oauth/callback';
// ignore: prefer_final_locals
Object? postBody = oAuthCallbackDto;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>['application/json'];
return apiClient.invokeAPI(
apiPath,
'POST',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
/// Parameters:
///
/// * [OAuthCallbackDto] oAuthCallbackDto (required):
Future<LoginResponseDto?> finishOAuth(OAuthCallbackDto oAuthCallbackDto,) async {
final response = await finishOAuthWithHttpInfo(oAuthCallbackDto,);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'LoginResponseDto',) as LoginResponseDto;
}
return null;
}
/// Performs an HTTP 'POST /oauth/link' operation and returns the [Response].
/// Parameters:
///
/// * [OAuthCallbackDto] oAuthCallbackDto (required):
Future<Response> linkOAuthAccountWithHttpInfo(OAuthCallbackDto oAuthCallbackDto,) async {
// ignore: prefer_const_declarations
final apiPath = r'/oauth/link';
// ignore: prefer_final_locals
Object? postBody = oAuthCallbackDto;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>['application/json'];
return apiClient.invokeAPI(
apiPath,
'POST',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
/// Parameters:
///
/// * [OAuthCallbackDto] oAuthCallbackDto (required):
Future<UserAdminResponseDto?> linkOAuthAccount(OAuthCallbackDto oAuthCallbackDto,) async {
final response = await linkOAuthAccountWithHttpInfo(oAuthCallbackDto,);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'UserAdminResponseDto',) as UserAdminResponseDto;
}
return null;
}
/// Performs an HTTP 'GET /oauth/mobile-redirect' operation and returns the [Response].
Future<Response> redirectOAuthToMobileWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = r'/oauth/mobile-redirect';
// ignore: prefer_final_locals
Object? postBody;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>[];
return apiClient.invokeAPI(
apiPath,
'GET',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
Future<void> redirectOAuthToMobile() async {
final response = await redirectOAuthToMobileWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
}
/// Performs an HTTP 'POST /oauth/authorize' operation and returns the [Response].
/// Parameters:
///
/// * [OAuthConfigDto] oAuthConfigDto (required):
Future<Response> startOAuthWithHttpInfo(OAuthConfigDto oAuthConfigDto,) async {
// ignore: prefer_const_declarations
final apiPath = r'/oauth/authorize';
// ignore: prefer_final_locals
Object? postBody = oAuthConfigDto;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>['application/json'];
return apiClient.invokeAPI(
apiPath,
'POST',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
/// Parameters:
///
/// * [OAuthConfigDto] oAuthConfigDto (required):
Future<OAuthAuthorizeResponseDto?> startOAuth(OAuthConfigDto oAuthConfigDto,) async {
final response = await startOAuthWithHttpInfo(oAuthConfigDto,);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'OAuthAuthorizeResponseDto',) as OAuthAuthorizeResponseDto;
}
return null;
}
/// Performs an HTTP 'POST /oauth/unlink' operation and returns the [Response].
Future<Response> unlinkOAuthAccountWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = r'/oauth/unlink';
// ignore: prefer_final_locals
Object? postBody;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>[];
return apiClient.invokeAPI(
apiPath,
'POST',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
Future<UserAdminResponseDto?> unlinkOAuthAccount() async {
final response = await unlinkOAuthAccountWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'UserAdminResponseDto',) as UserAdminResponseDto;
}
return null;
}
}

40
mobile/openapi/lib/api/partners_api.dart generated
View file

@ -16,7 +16,9 @@ class PartnersApi {
final ApiClient apiClient;
/// This endpoint requires the `partner.create` permission.
/// Create a partner
///
/// Create a new partner to share assets with.
///
/// Note: This method returns the HTTP [Response].
///
@ -48,7 +50,9 @@ class PartnersApi {
);
}
/// This endpoint requires the `partner.create` permission.
/// Create a partner
///
/// Create a new partner to share assets with.
///
/// Parameters:
///
@ -68,7 +72,9 @@ class PartnersApi {
return null;
}
/// This property was deprecated in v1.141.0. This endpoint requires the `partner.create` permission.
/// Create a partner
///
/// This property was deprecated in v1.141.0. Create a new partner to share assets with.
///
/// Note: This method returns the HTTP [Response].
///
@ -101,7 +107,9 @@ class PartnersApi {
);
}
/// This property was deprecated in v1.141.0. This endpoint requires the `partner.create` permission.
/// Create a partner
///
/// This property was deprecated in v1.141.0. Create a new partner to share assets with.
///
/// Parameters:
///
@ -121,7 +129,9 @@ class PartnersApi {
return null;
}
/// This endpoint requires the `partner.read` permission.
/// Retrieve partners
///
/// Retrieve a list of partners with whom assets are shared.
///
/// Note: This method returns the HTTP [Response].
///
@ -155,7 +165,9 @@ class PartnersApi {
);
}
/// This endpoint requires the `partner.read` permission.
/// Retrieve partners
///
/// Retrieve a list of partners with whom assets are shared.
///
/// Parameters:
///
@ -178,7 +190,9 @@ class PartnersApi {
return null;
}
/// This endpoint requires the `partner.delete` permission.
/// Remove a partner
///
/// Stop sharing assets with a partner.
///
/// Note: This method returns the HTTP [Response].
///
@ -211,7 +225,9 @@ class PartnersApi {
);
}
/// This endpoint requires the `partner.delete` permission.
/// Remove a partner
///
/// Stop sharing assets with a partner.
///
/// Parameters:
///
@ -223,7 +239,9 @@ class PartnersApi {
}
}
/// This endpoint requires the `partner.update` permission.
/// Update a partner
///
/// Specify whether a partner's assets should appear in the user's timeline.
///
/// Note: This method returns the HTTP [Response].
///
@ -258,7 +276,9 @@ class PartnersApi {
);
}
/// This endpoint requires the `partner.update` permission.
/// Update a partner
///
/// Specify whether a partner's assets should appear in the user's timeline.
///
/// Parameters:
///

88
mobile/openapi/lib/api/people_api.dart generated
View file

@ -16,7 +16,9 @@ class PeopleApi {
final ApiClient apiClient;
/// This endpoint requires the `person.create` permission.
/// Create a person
///
/// Create a new person that can have multiple faces assigned to them.
///
/// Note: This method returns the HTTP [Response].
///
@ -48,7 +50,9 @@ class PeopleApi {
);
}
/// This endpoint requires the `person.create` permission.
/// Create a person
///
/// Create a new person that can have multiple faces assigned to them.
///
/// Parameters:
///
@ -68,7 +72,9 @@ class PeopleApi {
return null;
}
/// This endpoint requires the `person.delete` permission.
/// Delete people
///
/// Bulk delete a list of people at once.
///
/// Note: This method returns the HTTP [Response].
///
@ -100,7 +106,9 @@ class PeopleApi {
);
}
/// This endpoint requires the `person.delete` permission.
/// Delete people
///
/// Bulk delete a list of people at once.
///
/// Parameters:
///
@ -112,7 +120,9 @@ class PeopleApi {
}
}
/// This endpoint requires the `person.delete` permission.
/// Delete person
///
/// Delete an individual person.
///
/// Note: This method returns the HTTP [Response].
///
@ -145,7 +155,9 @@ class PeopleApi {
);
}
/// This endpoint requires the `person.delete` permission.
/// Delete person
///
/// Delete an individual person.
///
/// Parameters:
///
@ -157,7 +169,9 @@ class PeopleApi {
}
}
/// This endpoint requires the `person.read` permission.
/// Get all people
///
/// Retrieve a list of all people.
///
/// Note: This method returns the HTTP [Response].
///
@ -215,7 +229,9 @@ class PeopleApi {
);
}
/// This endpoint requires the `person.read` permission.
/// Get all people
///
/// Retrieve a list of all people.
///
/// Parameters:
///
@ -245,7 +261,9 @@ class PeopleApi {
return null;
}
/// This endpoint requires the `person.read` permission.
/// Get a person
///
/// Retrieve a person by id.
///
/// Note: This method returns the HTTP [Response].
///
@ -278,7 +296,9 @@ class PeopleApi {
);
}
/// This endpoint requires the `person.read` permission.
/// Get a person
///
/// Retrieve a person by id.
///
/// Parameters:
///
@ -298,7 +318,9 @@ class PeopleApi {
return null;
}
/// This endpoint requires the `person.statistics` permission.
/// Get person statistics
///
/// Retrieve statistics about a specific person.
///
/// Note: This method returns the HTTP [Response].
///
@ -331,7 +353,9 @@ class PeopleApi {
);
}
/// This endpoint requires the `person.statistics` permission.
/// Get person statistics
///
/// Retrieve statistics about a specific person.
///
/// Parameters:
///
@ -351,7 +375,9 @@ class PeopleApi {
return null;
}
/// This endpoint requires the `person.read` permission.
/// Get person thumbnail
///
/// Retrieve the thumbnail file for a person.
///
/// Note: This method returns the HTTP [Response].
///
@ -384,7 +410,9 @@ class PeopleApi {
);
}
/// This endpoint requires the `person.read` permission.
/// Get person thumbnail
///
/// Retrieve the thumbnail file for a person.
///
/// Parameters:
///
@ -404,7 +432,9 @@ class PeopleApi {
return null;
}
/// This endpoint requires the `person.merge` permission.
/// Merge people
///
/// Merge a list of people into the person specified in the path parameter.
///
/// Note: This method returns the HTTP [Response].
///
@ -439,7 +469,9 @@ class PeopleApi {
);
}
/// This endpoint requires the `person.merge` permission.
/// Merge people
///
/// Merge a list of people into the person specified in the path parameter.
///
/// Parameters:
///
@ -464,7 +496,9 @@ class PeopleApi {
return null;
}
/// This endpoint requires the `person.reassign` permission.
/// Reassign faces
///
/// Bulk reassign a list of faces to a different person.
///
/// Note: This method returns the HTTP [Response].
///
@ -499,7 +533,9 @@ class PeopleApi {
);
}
/// This endpoint requires the `person.reassign` permission.
/// Reassign faces
///
/// Bulk reassign a list of faces to a different person.
///
/// Parameters:
///
@ -524,7 +560,9 @@ class PeopleApi {
return null;
}
/// This endpoint requires the `person.update` permission.
/// Update people
///
/// Bulk update multiple people at once.
///
/// Note: This method returns the HTTP [Response].
///
@ -556,7 +594,9 @@ class PeopleApi {
);
}
/// This endpoint requires the `person.update` permission.
/// Update people
///
/// Bulk update multiple people at once.
///
/// Parameters:
///
@ -579,7 +619,9 @@ class PeopleApi {
return null;
}
/// This endpoint requires the `person.update` permission.
/// Update person
///
/// Update an individual person.
///
/// Note: This method returns the HTTP [Response].
///
@ -614,7 +656,9 @@ class PeopleApi {
);
}
/// This endpoint requires the `person.update` permission.
/// Update person
///
/// Update an individual person.
///
/// Parameters:
///

80
mobile/openapi/lib/api/search_api.dart generated
View file

@ -16,7 +16,9 @@ class SearchApi {
final ApiClient apiClient;
/// This endpoint requires the `asset.read` permission.
/// Retrieve assets by city
///
/// Retrieve a list of assets with each asset belonging to a different city. This endpoint is used on the places pages to show a single thumbnail for each city the user has assets in.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getAssetsByCityWithHttpInfo() async {
@ -44,7 +46,9 @@ class SearchApi {
);
}
/// This endpoint requires the `asset.read` permission.
/// Retrieve assets by city
///
/// Retrieve a list of assets with each asset belonging to a different city. This endpoint is used on the places pages to show a single thumbnail for each city the user has assets in.
Future<List<AssetResponseDto>?> getAssetsByCity() async {
final response = await getAssetsByCityWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -63,7 +67,9 @@ class SearchApi {
return null;
}
/// This endpoint requires the `asset.read` permission.
/// Retrieve explore data
///
/// Retrieve data for the explore section, such as popular people and places.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getExploreDataWithHttpInfo() async {
@ -91,7 +97,9 @@ class SearchApi {
);
}
/// This endpoint requires the `asset.read` permission.
/// Retrieve explore data
///
/// Retrieve data for the explore section, such as popular people and places.
Future<List<SearchExploreResponseDto>?> getExploreData() async {
final response = await getExploreDataWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -110,7 +118,9 @@ class SearchApi {
return null;
}
/// This endpoint requires the `asset.read` permission.
/// Retrieve search suggestions
///
/// Retrieve search suggestions based on partial input. This endpoint is used for typeahead search features.
///
/// Note: This method returns the HTTP [Response].
///
@ -175,7 +185,9 @@ class SearchApi {
);
}
/// This endpoint requires the `asset.read` permission.
/// Retrieve search suggestions
///
/// Retrieve search suggestions based on partial input. This endpoint is used for typeahead search features.
///
/// Parameters:
///
@ -211,7 +223,9 @@ class SearchApi {
return null;
}
/// This endpoint requires the `asset.statistics` permission.
/// Search asset statistics
///
/// Retrieve statistical data about assets based on search criteria, such as the total matching count.
///
/// Note: This method returns the HTTP [Response].
///
@ -243,7 +257,9 @@ class SearchApi {
);
}
/// This endpoint requires the `asset.statistics` permission.
/// Search asset statistics
///
/// Retrieve statistical data about assets based on search criteria, such as the total matching count.
///
/// Parameters:
///
@ -263,7 +279,9 @@ class SearchApi {
return null;
}
/// This endpoint requires the `asset.read` permission.
/// Search assets by metadata
///
/// Search for assets based on various metadata criteria.
///
/// Note: This method returns the HTTP [Response].
///
@ -295,7 +313,9 @@ class SearchApi {
);
}
/// This endpoint requires the `asset.read` permission.
/// Search assets by metadata
///
/// Search for assets based on various metadata criteria.
///
/// Parameters:
///
@ -315,7 +335,9 @@ class SearchApi {
return null;
}
/// This endpoint requires the `asset.read` permission.
/// Search large assets
///
/// Search for assets that are considered large based on specified criteria.
///
/// Note: This method returns the HTTP [Response].
///
@ -506,7 +528,9 @@ class SearchApi {
);
}
/// This endpoint requires the `asset.read` permission.
/// Search large assets
///
/// Search for assets that are considered large based on specified criteria.
///
/// Parameters:
///
@ -591,7 +615,9 @@ class SearchApi {
return null;
}
/// This endpoint requires the `person.read` permission.
/// Search people
///
/// Search for people by name.
///
/// Note: This method returns the HTTP [Response].
///
@ -630,7 +656,9 @@ class SearchApi {
);
}
/// This endpoint requires the `person.read` permission.
/// Search people
///
/// Search for people by name.
///
/// Parameters:
///
@ -655,7 +683,9 @@ class SearchApi {
return null;
}
/// This endpoint requires the `asset.read` permission.
/// Search places
///
/// Search for places by name.
///
/// Note: This method returns the HTTP [Response].
///
@ -689,7 +719,9 @@ class SearchApi {
);
}
/// This endpoint requires the `asset.read` permission.
/// Search places
///
/// Search for places by name.
///
/// Parameters:
///
@ -712,7 +744,9 @@ class SearchApi {
return null;
}
/// This endpoint requires the `asset.read` permission.
/// Search random assets
///
/// Retrieve a random selection of assets based on the provided criteria.
///
/// Note: This method returns the HTTP [Response].
///
@ -744,7 +778,9 @@ class SearchApi {
);
}
/// This endpoint requires the `asset.read` permission.
/// Search random assets
///
/// Retrieve a random selection of assets based on the provided criteria.
///
/// Parameters:
///
@ -767,7 +803,9 @@ class SearchApi {
return null;
}
/// This endpoint requires the `asset.read` permission.
/// Smart asset search
///
/// Perform a smart search for assets by using machine learning vectors to determine relevance.
///
/// Note: This method returns the HTTP [Response].
///
@ -799,7 +837,9 @@ class SearchApi {
);
}
/// This endpoint requires the `asset.read` permission.
/// Smart asset search
///
/// Perform a smart search for assets by using machine learning vectors to determine relevance.
///
/// Parameters:
///

127
mobile/openapi/lib/api/server_api.dart generated
View file

@ -16,7 +16,9 @@ class ServerApi {
final ApiClient apiClient;
/// This endpoint is an admin-only route, and requires the `serverLicense.delete` permission.
/// Delete server product key
///
/// Delete the currently set server product key.
///
/// Note: This method returns the HTTP [Response].
Future<Response> deleteServerLicenseWithHttpInfo() async {
@ -44,7 +46,9 @@ class ServerApi {
);
}
/// This endpoint is an admin-only route, and requires the `serverLicense.delete` permission.
/// Delete server product key
///
/// Delete the currently set server product key.
Future<void> deleteServerLicense() async {
final response = await deleteServerLicenseWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -52,7 +56,9 @@ class ServerApi {
}
}
/// This endpoint requires the `server.about` permission.
/// Get server information
///
/// Retrieve a list of information about the server.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getAboutInfoWithHttpInfo() async {
@ -80,7 +86,9 @@ class ServerApi {
);
}
/// This endpoint requires the `server.about` permission.
/// Get server information
///
/// Retrieve a list of information about the server.
Future<ServerAboutResponseDto?> getAboutInfo() async {
final response = await getAboutInfoWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -96,7 +104,9 @@ class ServerApi {
return null;
}
/// This endpoint requires the `server.apkLinks` permission.
/// Get APK links
///
/// Retrieve links to the APKs for the current server version.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getApkLinksWithHttpInfo() async {
@ -124,7 +134,9 @@ class ServerApi {
);
}
/// This endpoint requires the `server.apkLinks` permission.
/// Get APK links
///
/// Retrieve links to the APKs for the current server version.
Future<ServerApkLinksDto?> getApkLinks() async {
final response = await getApkLinksWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -140,7 +152,11 @@ class ServerApi {
return null;
}
/// Performs an HTTP 'GET /server/config' operation and returns the [Response].
/// Get config
///
/// Retrieve the current server configuration.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getServerConfigWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = r'/server/config';
@ -166,6 +182,9 @@ class ServerApi {
);
}
/// Get config
///
/// Retrieve the current server configuration.
Future<ServerConfigDto?> getServerConfig() async {
final response = await getServerConfigWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -181,7 +200,11 @@ class ServerApi {
return null;
}
/// Performs an HTTP 'GET /server/features' operation and returns the [Response].
/// Get features
///
/// Retrieve available features supported by this server.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getServerFeaturesWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = r'/server/features';
@ -207,6 +230,9 @@ class ServerApi {
);
}
/// Get features
///
/// Retrieve available features supported by this server.
Future<ServerFeaturesDto?> getServerFeatures() async {
final response = await getServerFeaturesWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -222,7 +248,9 @@ class ServerApi {
return null;
}
/// This endpoint is an admin-only route, and requires the `serverLicense.read` permission.
/// Get product key
///
/// Retrieve information about whether the server currently has a product key registered.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getServerLicenseWithHttpInfo() async {
@ -250,7 +278,9 @@ class ServerApi {
);
}
/// This endpoint is an admin-only route, and requires the `serverLicense.read` permission.
/// Get product key
///
/// Retrieve information about whether the server currently has a product key registered.
Future<LicenseResponseDto?> getServerLicense() async {
final response = await getServerLicenseWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -266,7 +296,9 @@ class ServerApi {
return null;
}
/// This endpoint is an admin-only route, and requires the `server.statistics` permission.
/// Get statistics
///
/// Retrieve statistics about the entire Immich instance such as asset counts.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getServerStatisticsWithHttpInfo() async {
@ -294,7 +326,9 @@ class ServerApi {
);
}
/// This endpoint is an admin-only route, and requires the `server.statistics` permission.
/// Get statistics
///
/// Retrieve statistics about the entire Immich instance such as asset counts.
Future<ServerStatsResponseDto?> getServerStatistics() async {
final response = await getServerStatisticsWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -310,7 +344,11 @@ class ServerApi {
return null;
}
/// Performs an HTTP 'GET /server/version' operation and returns the [Response].
/// Get server version
///
/// Retrieve the current server version in semantic versioning (semver) format.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getServerVersionWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = r'/server/version';
@ -336,6 +374,9 @@ class ServerApi {
);
}
/// Get server version
///
/// Retrieve the current server version in semantic versioning (semver) format.
Future<ServerVersionResponseDto?> getServerVersion() async {
final response = await getServerVersionWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -351,7 +392,9 @@ class ServerApi {
return null;
}
/// This endpoint requires the `server.storage` permission.
/// Get storage
///
/// Retrieve the current storage utilization information of the server.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getStorageWithHttpInfo() async {
@ -379,7 +422,9 @@ class ServerApi {
);
}
/// This endpoint requires the `server.storage` permission.
/// Get storage
///
/// Retrieve the current storage utilization information of the server.
Future<ServerStorageResponseDto?> getStorage() async {
final response = await getStorageWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -395,7 +440,11 @@ class ServerApi {
return null;
}
/// Performs an HTTP 'GET /server/media-types' operation and returns the [Response].
/// Get supported media types
///
/// Retrieve all media types supported by the server.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getSupportedMediaTypesWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = r'/server/media-types';
@ -421,6 +470,9 @@ class ServerApi {
);
}
/// Get supported media types
///
/// Retrieve all media types supported by the server.
Future<ServerMediaTypesResponseDto?> getSupportedMediaTypes() async {
final response = await getSupportedMediaTypesWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -436,7 +488,11 @@ class ServerApi {
return null;
}
/// Performs an HTTP 'GET /server/theme' operation and returns the [Response].
/// Get theme
///
/// Retrieve the custom CSS, if existent.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getThemeWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = r'/server/theme';
@ -462,6 +518,9 @@ class ServerApi {
);
}
/// Get theme
///
/// Retrieve the custom CSS, if existent.
Future<ServerThemeDto?> getTheme() async {
final response = await getThemeWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -477,7 +536,9 @@ class ServerApi {
return null;
}
/// This endpoint requires the `server.versionCheck` permission.
/// Get version check status
///
/// Retrieve information about the last time the version check ran.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getVersionCheckWithHttpInfo() async {
@ -505,7 +566,9 @@ class ServerApi {
);
}
/// This endpoint requires the `server.versionCheck` permission.
/// Get version check status
///
/// Retrieve information about the last time the version check ran.
Future<VersionCheckStateResponseDto?> getVersionCheck() async {
final response = await getVersionCheckWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -521,7 +584,11 @@ class ServerApi {
return null;
}
/// Performs an HTTP 'GET /server/version-history' operation and returns the [Response].
/// Get version history
///
/// Retrieve a list of past versions the server has been on.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getVersionHistoryWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = r'/server/version-history';
@ -547,6 +614,9 @@ class ServerApi {
);
}
/// Get version history
///
/// Retrieve a list of past versions the server has been on.
Future<List<ServerVersionHistoryResponseDto>?> getVersionHistory() async {
final response = await getVersionHistoryWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -565,7 +635,11 @@ class ServerApi {
return null;
}
/// Performs an HTTP 'GET /server/ping' operation and returns the [Response].
/// Ping
///
/// Pong
///
/// Note: This method returns the HTTP [Response].
Future<Response> pingServerWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = r'/server/ping';
@ -591,6 +665,9 @@ class ServerApi {
);
}
/// Ping
///
/// Pong
Future<ServerPingResponse?> pingServer() async {
final response = await pingServerWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -606,7 +683,9 @@ class ServerApi {
return null;
}
/// This endpoint is an admin-only route, and requires the `serverLicense.update` permission.
/// Set server product key
///
/// Validate and set the server product key if successful.
///
/// Note: This method returns the HTTP [Response].
///
@ -638,7 +717,9 @@ class ServerApi {
);
}
/// This endpoint is an admin-only route, and requires the `serverLicense.update` permission.
/// Set server product key
///
/// Validate and set the server product key if successful.
///
/// Parameters:
///

48
mobile/openapi/lib/api/sessions_api.dart generated
View file

@ -16,7 +16,9 @@ class SessionsApi {
final ApiClient apiClient;
/// This endpoint requires the `session.create` permission.
/// Create a session
///
/// Create a session as a child to the current session. This endpoint is used for casting.
///
/// Note: This method returns the HTTP [Response].
///
@ -48,7 +50,9 @@ class SessionsApi {
);
}
/// This endpoint requires the `session.create` permission.
/// Create a session
///
/// Create a session as a child to the current session. This endpoint is used for casting.
///
/// Parameters:
///
@ -68,7 +72,9 @@ class SessionsApi {
return null;
}
/// This endpoint requires the `session.delete` permission.
/// Delete all sessions
///
/// Delete all sessions for the user. This will not delete the current session.
///
/// Note: This method returns the HTTP [Response].
Future<Response> deleteAllSessionsWithHttpInfo() async {
@ -96,7 +102,9 @@ class SessionsApi {
);
}
/// This endpoint requires the `session.delete` permission.
/// Delete all sessions
///
/// Delete all sessions for the user. This will not delete the current session.
Future<void> deleteAllSessions() async {
final response = await deleteAllSessionsWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -104,7 +112,9 @@ class SessionsApi {
}
}
/// This endpoint requires the `session.delete` permission.
/// Delete a session
///
/// Delete a specific session by id.
///
/// Note: This method returns the HTTP [Response].
///
@ -137,7 +147,9 @@ class SessionsApi {
);
}
/// This endpoint requires the `session.delete` permission.
/// Delete a session
///
/// Delete a specific session by id.
///
/// Parameters:
///
@ -149,7 +161,9 @@ class SessionsApi {
}
}
/// This endpoint requires the `session.read` permission.
/// Retrieve sessions
///
/// Retrieve a list of sessions for the user.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getSessionsWithHttpInfo() async {
@ -177,7 +191,9 @@ class SessionsApi {
);
}
/// This endpoint requires the `session.read` permission.
/// Retrieve sessions
///
/// Retrieve a list of sessions for the user.
Future<List<SessionResponseDto>?> getSessions() async {
final response = await getSessionsWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -196,7 +212,9 @@ class SessionsApi {
return null;
}
/// This endpoint requires the `session.lock` permission.
/// Lock a session
///
/// Lock a specific session by id.
///
/// Note: This method returns the HTTP [Response].
///
@ -229,7 +247,9 @@ class SessionsApi {
);
}
/// This endpoint requires the `session.lock` permission.
/// Lock a session
///
/// Lock a specific session by id.
///
/// Parameters:
///
@ -241,7 +261,9 @@ class SessionsApi {
}
}
/// This endpoint requires the `session.update` permission.
/// Update a session
///
/// Update a specific session identified by id.
///
/// Note: This method returns the HTTP [Response].
///
@ -276,7 +298,9 @@ class SessionsApi {
);
}
/// This endpoint requires the `session.update` permission.
/// Update a session
///
/// Update a specific session identified by id.
///
/// Parameters:
///

107
mobile/openapi/lib/api/shared_links_api.dart generated
View file

@ -16,7 +16,12 @@ class SharedLinksApi {
final ApiClient apiClient;
/// Performs an HTTP 'PUT /shared-links/{id}/assets' operation and returns the [Response].
/// Add assets to a shared link
///
/// Add assets to a specific shared link by its ID. This endpoint is only relevant for shared link of type individual.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
@ -59,6 +64,10 @@ class SharedLinksApi {
);
}
/// Add assets to a shared link
///
/// Add assets to a specific shared link by its ID. This endpoint is only relevant for shared link of type individual.
///
/// Parameters:
///
/// * [String] id (required):
@ -86,7 +95,9 @@ class SharedLinksApi {
return null;
}
/// This endpoint requires the `sharedLink.create` permission.
/// Create a shared link
///
/// Create a new shared link.
///
/// Note: This method returns the HTTP [Response].
///
@ -118,7 +129,9 @@ class SharedLinksApi {
);
}
/// This endpoint requires the `sharedLink.create` permission.
/// Create a shared link
///
/// Create a new shared link.
///
/// Parameters:
///
@ -138,7 +151,9 @@ class SharedLinksApi {
return null;
}
/// This endpoint requires the `sharedLink.read` permission.
/// Retrieve all shared links
///
/// Retrieve a list of all shared links.
///
/// Note: This method returns the HTTP [Response].
///
@ -174,7 +189,9 @@ class SharedLinksApi {
);
}
/// This endpoint requires the `sharedLink.read` permission.
/// Retrieve all shared links
///
/// Retrieve a list of all shared links.
///
/// Parameters:
///
@ -197,17 +214,22 @@ class SharedLinksApi {
return null;
}
/// Performs an HTTP 'GET /shared-links/me' operation and returns the [Response].
/// Retrieve current shared link
///
/// Retrieve the current shared link associated with authentication method.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] password:
///
/// * [String] token:
///
/// * [String] key:
///
/// * [String] password:
///
/// * [String] slug:
Future<Response> getMySharedLinkWithHttpInfo({ String? password, String? token, String? key, String? slug, }) async {
///
/// * [String] token:
Future<Response> getMySharedLinkWithHttpInfo({ String? key, String? password, String? slug, String? token, }) async {
// ignore: prefer_const_declarations
final apiPath = r'/shared-links/me';
@ -218,18 +240,18 @@ class SharedLinksApi {
final headerParams = <String, String>{};
final formParams = <String, String>{};
if (password != null) {
queryParams.addAll(_queryParams('', 'password', password));
}
if (token != null) {
queryParams.addAll(_queryParams('', 'token', token));
}
if (key != null) {
queryParams.addAll(_queryParams('', 'key', key));
}
if (password != null) {
queryParams.addAll(_queryParams('', 'password', password));
}
if (slug != null) {
queryParams.addAll(_queryParams('', 'slug', slug));
}
if (token != null) {
queryParams.addAll(_queryParams('', 'token', token));
}
const contentTypes = <String>[];
@ -245,17 +267,21 @@ class SharedLinksApi {
);
}
/// Retrieve current shared link
///
/// Retrieve the current shared link associated with authentication method.
///
/// Parameters:
///
/// * [String] password:
///
/// * [String] token:
///
/// * [String] key:
///
/// * [String] password:
///
/// * [String] slug:
Future<SharedLinkResponseDto?> getMySharedLink({ String? password, String? token, String? key, String? slug, }) async {
final response = await getMySharedLinkWithHttpInfo( password: password, token: token, key: key, slug: slug, );
///
/// * [String] token:
Future<SharedLinkResponseDto?> getMySharedLink({ String? key, String? password, String? slug, String? token, }) async {
final response = await getMySharedLinkWithHttpInfo( key: key, password: password, slug: slug, token: token, );
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
@ -269,7 +295,9 @@ class SharedLinksApi {
return null;
}
/// This endpoint requires the `sharedLink.read` permission.
/// Retrieve a shared link
///
/// Retrieve a specific shared link by its ID.
///
/// Note: This method returns the HTTP [Response].
///
@ -302,7 +330,9 @@ class SharedLinksApi {
);
}
/// This endpoint requires the `sharedLink.read` permission.
/// Retrieve a shared link
///
/// Retrieve a specific shared link by its ID.
///
/// Parameters:
///
@ -322,7 +352,9 @@ class SharedLinksApi {
return null;
}
/// This endpoint requires the `sharedLink.delete` permission.
/// Delete a shared link
///
/// Delete a specific shared link by its ID.
///
/// Note: This method returns the HTTP [Response].
///
@ -355,7 +387,9 @@ class SharedLinksApi {
);
}
/// This endpoint requires the `sharedLink.delete` permission.
/// Delete a shared link
///
/// Delete a specific shared link by its ID.
///
/// Parameters:
///
@ -367,7 +401,12 @@ class SharedLinksApi {
}
}
/// Performs an HTTP 'DELETE /shared-links/{id}/assets' operation and returns the [Response].
/// Remove assets from a shared link
///
/// Remove assets from a specific shared link by its ID. This endpoint is only relevant for shared link of type individual.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
@ -410,6 +449,10 @@ class SharedLinksApi {
);
}
/// Remove assets from a shared link
///
/// Remove assets from a specific shared link by its ID. This endpoint is only relevant for shared link of type individual.
///
/// Parameters:
///
/// * [String] id (required):
@ -437,7 +480,9 @@ class SharedLinksApi {
return null;
}
/// This endpoint requires the `sharedLink.update` permission.
/// Update a shared link
///
/// Update an existing shared link by its ID.
///
/// Note: This method returns the HTTP [Response].
///
@ -472,7 +517,9 @@ class SharedLinksApi {
);
}
/// This endpoint requires the `sharedLink.update` permission.
/// Update a shared link
///
/// Update an existing shared link by its ID.
///
/// Parameters:
///

56
mobile/openapi/lib/api/stacks_api.dart generated
View file

@ -16,7 +16,9 @@ class StacksApi {
final ApiClient apiClient;
/// This endpoint requires the `stack.create` permission.
/// Create a stack
///
/// Create a new stack by providing a name and a list of asset IDs to include in the stack. If any of the provided asset IDs are primary assets of an existing stack, the existing stack will be merged into the newly created stack.
///
/// Note: This method returns the HTTP [Response].
///
@ -48,7 +50,9 @@ class StacksApi {
);
}
/// This endpoint requires the `stack.create` permission.
/// Create a stack
///
/// Create a new stack by providing a name and a list of asset IDs to include in the stack. If any of the provided asset IDs are primary assets of an existing stack, the existing stack will be merged into the newly created stack.
///
/// Parameters:
///
@ -68,7 +72,9 @@ class StacksApi {
return null;
}
/// This endpoint requires the `stack.delete` permission.
/// Delete a stack
///
/// Delete a specific stack by its ID.
///
/// Note: This method returns the HTTP [Response].
///
@ -101,7 +107,9 @@ class StacksApi {
);
}
/// This endpoint requires the `stack.delete` permission.
/// Delete a stack
///
/// Delete a specific stack by its ID.
///
/// Parameters:
///
@ -113,7 +121,9 @@ class StacksApi {
}
}
/// This endpoint requires the `stack.delete` permission.
/// Delete stacks
///
/// Delete multiple stacks by providing a list of stack IDs.
///
/// Note: This method returns the HTTP [Response].
///
@ -145,7 +155,9 @@ class StacksApi {
);
}
/// This endpoint requires the `stack.delete` permission.
/// Delete stacks
///
/// Delete multiple stacks by providing a list of stack IDs.
///
/// Parameters:
///
@ -157,7 +169,9 @@ class StacksApi {
}
}
/// This endpoint requires the `stack.read` permission.
/// Retrieve a stack
///
/// Retrieve a specific stack by its ID.
///
/// Note: This method returns the HTTP [Response].
///
@ -190,7 +204,9 @@ class StacksApi {
);
}
/// This endpoint requires the `stack.read` permission.
/// Retrieve a stack
///
/// Retrieve a specific stack by its ID.
///
/// Parameters:
///
@ -210,7 +226,9 @@ class StacksApi {
return null;
}
/// This endpoint requires the `stack.update` permission.
/// Remove an asset from a stack
///
/// Remove a specific asset from a stack by providing the stack ID and asset ID.
///
/// Note: This method returns the HTTP [Response].
///
@ -246,7 +264,9 @@ class StacksApi {
);
}
/// This endpoint requires the `stack.update` permission.
/// Remove an asset from a stack
///
/// Remove a specific asset from a stack by providing the stack ID and asset ID.
///
/// Parameters:
///
@ -260,7 +280,9 @@ class StacksApi {
}
}
/// This endpoint requires the `stack.read` permission.
/// Retrieve stacks
///
/// Retrieve a list of stacks.
///
/// Note: This method returns the HTTP [Response].
///
@ -296,7 +318,9 @@ class StacksApi {
);
}
/// This endpoint requires the `stack.read` permission.
/// Retrieve stacks
///
/// Retrieve a list of stacks.
///
/// Parameters:
///
@ -319,7 +343,9 @@ class StacksApi {
return null;
}
/// This endpoint requires the `stack.update` permission.
/// Update a stack
///
/// Update an existing stack by its ID.
///
/// Note: This method returns the HTTP [Response].
///
@ -354,7 +380,9 @@ class StacksApi {
);
}
/// This endpoint requires the `stack.update` permission.
/// Update a stack
///
/// Update an existing stack by its ID.
///
/// Parameters:
///

54
mobile/openapi/lib/api/sync_api.dart generated
View file

@ -16,7 +16,9 @@ class SyncApi {
final ApiClient apiClient;
/// This endpoint requires the `syncCheckpoint.delete` permission.
/// Delete acknowledgements
///
/// Delete specific synchronization acknowledgments.
///
/// Note: This method returns the HTTP [Response].
///
@ -48,7 +50,9 @@ class SyncApi {
);
}
/// This endpoint requires the `syncCheckpoint.delete` permission.
/// Delete acknowledgements
///
/// Delete specific synchronization acknowledgments.
///
/// Parameters:
///
@ -60,7 +64,12 @@ class SyncApi {
}
}
/// Performs an HTTP 'POST /sync/delta-sync' operation and returns the [Response].
/// Get delta sync for user
///
/// This property was deprecated in v2.0.0. Retrieve changed assets since the last sync for the authenticated user.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [AssetDeltaSyncDto] assetDeltaSyncDto (required):
@ -89,6 +98,10 @@ class SyncApi {
);
}
/// Get delta sync for user
///
/// This property was deprecated in v2.0.0. Retrieve changed assets since the last sync for the authenticated user.
///
/// Parameters:
///
/// * [AssetDeltaSyncDto] assetDeltaSyncDto (required):
@ -107,7 +120,12 @@ class SyncApi {
return null;
}
/// Performs an HTTP 'POST /sync/full-sync' operation and returns the [Response].
/// Get full sync for user
///
/// This property was deprecated in v2.0.0. Retrieve all assets for a full synchronization for the authenticated user.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [AssetFullSyncDto] assetFullSyncDto (required):
@ -136,6 +154,10 @@ class SyncApi {
);
}
/// Get full sync for user
///
/// This property was deprecated in v2.0.0. Retrieve all assets for a full synchronization for the authenticated user.
///
/// Parameters:
///
/// * [AssetFullSyncDto] assetFullSyncDto (required):
@ -157,7 +179,9 @@ class SyncApi {
return null;
}
/// This endpoint requires the `syncCheckpoint.read` permission.
/// Retrieve acknowledgements
///
/// Retrieve the synchronization acknowledgments for the current session.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getSyncAckWithHttpInfo() async {
@ -185,7 +209,9 @@ class SyncApi {
);
}
/// This endpoint requires the `syncCheckpoint.read` permission.
/// Retrieve acknowledgements
///
/// Retrieve the synchronization acknowledgments for the current session.
Future<List<SyncAckDto>?> getSyncAck() async {
final response = await getSyncAckWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -204,7 +230,9 @@ class SyncApi {
return null;
}
/// This endpoint requires the `sync.stream` permission.
/// Stream sync changes
///
/// Retrieve a JSON lines streamed response of changes for synchronization. This endpoint is used by the mobile app to efficiently stay up to date with changes.
///
/// Note: This method returns the HTTP [Response].
///
@ -236,7 +264,9 @@ class SyncApi {
);
}
/// This endpoint requires the `sync.stream` permission.
/// Stream sync changes
///
/// Retrieve a JSON lines streamed response of changes for synchronization. This endpoint is used by the mobile app to efficiently stay up to date with changes.
///
/// Parameters:
///
@ -248,7 +278,9 @@ class SyncApi {
}
}
/// This endpoint requires the `syncCheckpoint.update` permission.
/// Acknowledge changes
///
/// Send a list of synchronization acknowledgements to confirm that the latest changes have been received.
///
/// Note: This method returns the HTTP [Response].
///
@ -280,7 +312,9 @@ class SyncApi {
);
}
/// This endpoint requires the `syncCheckpoint.update` permission.
/// Acknowledge changes
///
/// Send a list of synchronization acknowledgements to confirm that the latest changes have been received.
///
/// Parameters:
///

32
mobile/openapi/lib/api/system_config_api.dart generated
View file

@ -16,7 +16,9 @@ class SystemConfigApi {
final ApiClient apiClient;
/// This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
/// Get system configuration
///
/// Retrieve the current system configuration.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getConfigWithHttpInfo() async {
@ -44,7 +46,9 @@ class SystemConfigApi {
);
}
/// This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
/// Get system configuration
///
/// Retrieve the current system configuration.
Future<SystemConfigDto?> getConfig() async {
final response = await getConfigWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -60,7 +64,9 @@ class SystemConfigApi {
return null;
}
/// This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
/// Get system configuration defaults
///
/// Retrieve the default values for the system configuration.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getConfigDefaultsWithHttpInfo() async {
@ -88,7 +94,9 @@ class SystemConfigApi {
);
}
/// This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
/// Get system configuration defaults
///
/// Retrieve the default values for the system configuration.
Future<SystemConfigDto?> getConfigDefaults() async {
final response = await getConfigDefaultsWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -104,7 +112,9 @@ class SystemConfigApi {
return null;
}
/// This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
/// Get storage template options
///
/// Retrieve exemplary storage template options.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getStorageTemplateOptionsWithHttpInfo() async {
@ -132,7 +142,9 @@ class SystemConfigApi {
);
}
/// This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
/// Get storage template options
///
/// Retrieve exemplary storage template options.
Future<SystemConfigTemplateStorageOptionDto?> getStorageTemplateOptions() async {
final response = await getStorageTemplateOptionsWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -148,7 +160,9 @@ class SystemConfigApi {
return null;
}
/// This endpoint is an admin-only route, and requires the `systemConfig.update` permission.
/// Update system configuration
///
/// Update the system configuration with a new system configuration.
///
/// Note: This method returns the HTTP [Response].
///
@ -180,7 +194,9 @@ class SystemConfigApi {
);
}
/// This endpoint is an admin-only route, and requires the `systemConfig.update` permission.
/// Update system configuration
///
/// Update the system configuration with a new system configuration.
///
/// Parameters:
///

32
mobile/openapi/lib/api/system_metadata_api.dart generated
View file

@ -16,7 +16,9 @@ class SystemMetadataApi {
final ApiClient apiClient;
/// This endpoint is an admin-only route, and requires the `systemMetadata.read` permission.
/// Retrieve admin onboarding
///
/// Retrieve the current admin onboarding status.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getAdminOnboardingWithHttpInfo() async {
@ -44,7 +46,9 @@ class SystemMetadataApi {
);
}
/// This endpoint is an admin-only route, and requires the `systemMetadata.read` permission.
/// Retrieve admin onboarding
///
/// Retrieve the current admin onboarding status.
Future<AdminOnboardingUpdateDto?> getAdminOnboarding() async {
final response = await getAdminOnboardingWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -60,7 +64,9 @@ class SystemMetadataApi {
return null;
}
/// This endpoint is an admin-only route, and requires the `systemMetadata.read` permission.
/// Retrieve reverse geocoding state
///
/// Retrieve the current state of the reverse geocoding import.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getReverseGeocodingStateWithHttpInfo() async {
@ -88,7 +94,9 @@ class SystemMetadataApi {
);
}
/// This endpoint is an admin-only route, and requires the `systemMetadata.read` permission.
/// Retrieve reverse geocoding state
///
/// Retrieve the current state of the reverse geocoding import.
Future<ReverseGeocodingStateResponseDto?> getReverseGeocodingState() async {
final response = await getReverseGeocodingStateWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -104,7 +112,9 @@ class SystemMetadataApi {
return null;
}
/// This endpoint is an admin-only route, and requires the `systemMetadata.read` permission.
/// Retrieve version check state
///
/// Retrieve the current state of the version check process.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getVersionCheckStateWithHttpInfo() async {
@ -132,7 +142,9 @@ class SystemMetadataApi {
);
}
/// This endpoint is an admin-only route, and requires the `systemMetadata.read` permission.
/// Retrieve version check state
///
/// Retrieve the current state of the version check process.
Future<VersionCheckStateResponseDto?> getVersionCheckState() async {
final response = await getVersionCheckStateWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -148,7 +160,9 @@ class SystemMetadataApi {
return null;
}
/// This endpoint is an admin-only route, and requires the `systemMetadata.update` permission.
/// Update admin onboarding
///
/// Update the admin onboarding status.
///
/// Note: This method returns the HTTP [Response].
///
@ -180,7 +194,9 @@ class SystemMetadataApi {
);
}
/// This endpoint is an admin-only route, and requires the `systemMetadata.update` permission.
/// Update admin onboarding
///
/// Update the admin onboarding status.
///
/// Parameters:
///

72
mobile/openapi/lib/api/tags_api.dart generated
View file

@ -16,7 +16,9 @@ class TagsApi {
final ApiClient apiClient;
/// This endpoint requires the `tag.asset` permission.
/// Tag assets
///
/// Add multiple tags to multiple assets in a single request.
///
/// Note: This method returns the HTTP [Response].
///
@ -48,7 +50,9 @@ class TagsApi {
);
}
/// This endpoint requires the `tag.asset` permission.
/// Tag assets
///
/// Add multiple tags to multiple assets in a single request.
///
/// Parameters:
///
@ -68,7 +72,9 @@ class TagsApi {
return null;
}
/// This endpoint requires the `tag.create` permission.
/// Create a tag
///
/// Create a new tag by providing a name and optional color.
///
/// Note: This method returns the HTTP [Response].
///
@ -100,7 +106,9 @@ class TagsApi {
);
}
/// This endpoint requires the `tag.create` permission.
/// Create a tag
///
/// Create a new tag by providing a name and optional color.
///
/// Parameters:
///
@ -120,7 +128,9 @@ class TagsApi {
return null;
}
/// This endpoint requires the `tag.delete` permission.
/// Delete a tag
///
/// Delete a specific tag by its ID.
///
/// Note: This method returns the HTTP [Response].
///
@ -153,7 +163,9 @@ class TagsApi {
);
}
/// This endpoint requires the `tag.delete` permission.
/// Delete a tag
///
/// Delete a specific tag by its ID.
///
/// Parameters:
///
@ -165,7 +177,9 @@ class TagsApi {
}
}
/// This endpoint requires the `tag.read` permission.
/// Retrieve tags
///
/// Retrieve a list of all tags.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getAllTagsWithHttpInfo() async {
@ -193,7 +207,9 @@ class TagsApi {
);
}
/// This endpoint requires the `tag.read` permission.
/// Retrieve tags
///
/// Retrieve a list of all tags.
Future<List<TagResponseDto>?> getAllTags() async {
final response = await getAllTagsWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -212,7 +228,9 @@ class TagsApi {
return null;
}
/// This endpoint requires the `tag.read` permission.
/// Retrieve a tag
///
/// Retrieve a specific tag by its ID.
///
/// Note: This method returns the HTTP [Response].
///
@ -245,7 +263,9 @@ class TagsApi {
);
}
/// This endpoint requires the `tag.read` permission.
/// Retrieve a tag
///
/// Retrieve a specific tag by its ID.
///
/// Parameters:
///
@ -265,7 +285,9 @@ class TagsApi {
return null;
}
/// This endpoint requires the `tag.asset` permission.
/// Tag assets
///
/// Add a tag to all the specified assets.
///
/// Note: This method returns the HTTP [Response].
///
@ -300,7 +322,9 @@ class TagsApi {
);
}
/// This endpoint requires the `tag.asset` permission.
/// Tag assets
///
/// Add a tag to all the specified assets.
///
/// Parameters:
///
@ -325,7 +349,9 @@ class TagsApi {
return null;
}
/// This endpoint requires the `tag.asset` permission.
/// Untag assets
///
/// Remove a tag from all the specified assets.
///
/// Note: This method returns the HTTP [Response].
///
@ -360,7 +386,9 @@ class TagsApi {
);
}
/// This endpoint requires the `tag.asset` permission.
/// Untag assets
///
/// Remove a tag from all the specified assets.
///
/// Parameters:
///
@ -385,7 +413,9 @@ class TagsApi {
return null;
}
/// This endpoint requires the `tag.update` permission.
/// Update a tag
///
/// Update an existing tag identified by its ID.
///
/// Note: This method returns the HTTP [Response].
///
@ -420,7 +450,9 @@ class TagsApi {
);
}
/// This endpoint requires the `tag.update` permission.
/// Update a tag
///
/// Update an existing tag identified by its ID.
///
/// Parameters:
///
@ -442,7 +474,9 @@ class TagsApi {
return null;
}
/// This endpoint requires the `tag.create` permission.
/// Upsert tags
///
/// Create or update multiple tags in a single request.
///
/// Note: This method returns the HTTP [Response].
///
@ -474,7 +508,9 @@ class TagsApi {
);
}
/// This endpoint requires the `tag.create` permission.
/// Upsert tags
///
/// Create or update multiple tags in a single request.
///
/// Parameters:
///

16
mobile/openapi/lib/api/timeline_api.dart generated
View file

@ -16,7 +16,9 @@ class TimelineApi {
final ApiClient apiClient;
/// This endpoint requires the `asset.read` permission.
/// Get time bucket
///
/// Retrieve a string of all asset ids in a given time bucket.
///
/// Note: This method returns the HTTP [Response].
///
@ -127,7 +129,9 @@ class TimelineApi {
);
}
/// This endpoint requires the `asset.read` permission.
/// Get time bucket
///
/// Retrieve a string of all asset ids in a given time bucket.
///
/// Parameters:
///
@ -185,7 +189,9 @@ class TimelineApi {
return null;
}
/// This endpoint requires the `asset.read` permission.
/// Get time buckets
///
/// Retrieve a list of all minimal time buckets.
///
/// Note: This method returns the HTTP [Response].
///
@ -292,7 +298,9 @@ class TimelineApi {
);
}
/// This endpoint requires the `asset.read` permission.
/// Get time buckets
///
/// Retrieve a list of all minimal time buckets.
///
/// Parameters:
///

24
mobile/openapi/lib/api/trash_api.dart generated
View file

@ -16,7 +16,9 @@ class TrashApi {
final ApiClient apiClient;
/// This endpoint requires the `asset.delete` permission.
/// Empty trash
///
/// Permanently delete all items in the trash.
///
/// Note: This method returns the HTTP [Response].
Future<Response> emptyTrashWithHttpInfo() async {
@ -44,7 +46,9 @@ class TrashApi {
);
}
/// This endpoint requires the `asset.delete` permission.
/// Empty trash
///
/// Permanently delete all items in the trash.
Future<TrashResponseDto?> emptyTrash() async {
final response = await emptyTrashWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -60,7 +64,9 @@ class TrashApi {
return null;
}
/// This endpoint requires the `asset.delete` permission.
/// Restore assets
///
/// Restore specific assets from the trash.
///
/// Note: This method returns the HTTP [Response].
///
@ -92,7 +98,9 @@ class TrashApi {
);
}
/// This endpoint requires the `asset.delete` permission.
/// Restore assets
///
/// Restore specific assets from the trash.
///
/// Parameters:
///
@ -112,7 +120,9 @@ class TrashApi {
return null;
}
/// This endpoint requires the `asset.delete` permission.
/// Restore trash
///
/// Restore all items in the trash.
///
/// Note: This method returns the HTTP [Response].
Future<Response> restoreTrashWithHttpInfo() async {
@ -140,7 +150,9 @@ class TrashApi {
);
}
/// This endpoint requires the `asset.delete` permission.
/// Restore trash
///
/// Restore all items in the trash.
Future<TrashResponseDto?> restoreTrash() async {
final response = await restoreTrashWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {

80
mobile/openapi/lib/api/users_admin_api.dart generated
View file

@ -16,7 +16,9 @@ class UsersAdminApi {
final ApiClient apiClient;
/// This endpoint is an admin-only route, and requires the `adminUser.create` permission.
/// Create a user
///
/// Create a new user.
///
/// Note: This method returns the HTTP [Response].
///
@ -48,7 +50,9 @@ class UsersAdminApi {
);
}
/// This endpoint is an admin-only route, and requires the `adminUser.create` permission.
/// Create a user
///
/// Create a new user.
///
/// Parameters:
///
@ -68,7 +72,9 @@ class UsersAdminApi {
return null;
}
/// This endpoint is an admin-only route, and requires the `adminUser.delete` permission.
/// Delete a user
///
/// Delete a user.
///
/// Note: This method returns the HTTP [Response].
///
@ -103,7 +109,9 @@ class UsersAdminApi {
);
}
/// This endpoint is an admin-only route, and requires the `adminUser.delete` permission.
/// Delete a user
///
/// Delete a user.
///
/// Parameters:
///
@ -125,7 +133,9 @@ class UsersAdminApi {
return null;
}
/// This endpoint is an admin-only route, and requires the `adminUser.read` permission.
/// Retrieve a user
///
/// Retrieve a specific user by their ID.
///
/// Note: This method returns the HTTP [Response].
///
@ -158,7 +168,9 @@ class UsersAdminApi {
);
}
/// This endpoint is an admin-only route, and requires the `adminUser.read` permission.
/// Retrieve a user
///
/// Retrieve a specific user by their ID.
///
/// Parameters:
///
@ -178,7 +190,9 @@ class UsersAdminApi {
return null;
}
/// This endpoint is an admin-only route, and requires the `adminUser.read` permission.
/// Retrieve user preferences
///
/// Retrieve the preferences of a specific user.
///
/// Note: This method returns the HTTP [Response].
///
@ -211,7 +225,9 @@ class UsersAdminApi {
);
}
/// This endpoint is an admin-only route, and requires the `adminUser.read` permission.
/// Retrieve user preferences
///
/// Retrieve the preferences of a specific user.
///
/// Parameters:
///
@ -231,7 +247,9 @@ class UsersAdminApi {
return null;
}
/// This endpoint is an admin-only route, and requires the `adminSession.read` permission.
/// Retrieve user sessions
///
/// Retrieve all sessions for a specific user.
///
/// Note: This method returns the HTTP [Response].
///
@ -264,7 +282,9 @@ class UsersAdminApi {
);
}
/// This endpoint is an admin-only route, and requires the `adminSession.read` permission.
/// Retrieve user sessions
///
/// Retrieve all sessions for a specific user.
///
/// Parameters:
///
@ -287,7 +307,9 @@ class UsersAdminApi {
return null;
}
/// This endpoint is an admin-only route, and requires the `adminUser.read` permission.
/// Retrieve user statistics
///
/// Retrieve asset statistics for a specific user.
///
/// Note: This method returns the HTTP [Response].
///
@ -336,7 +358,9 @@ class UsersAdminApi {
);
}
/// This endpoint is an admin-only route, and requires the `adminUser.read` permission.
/// Retrieve user statistics
///
/// Retrieve asset statistics for a specific user.
///
/// Parameters:
///
@ -362,7 +386,9 @@ class UsersAdminApi {
return null;
}
/// This endpoint is an admin-only route, and requires the `adminUser.delete` permission.
/// Restore a deleted user
///
/// Restore a previously deleted user.
///
/// Note: This method returns the HTTP [Response].
///
@ -395,7 +421,9 @@ class UsersAdminApi {
);
}
/// This endpoint is an admin-only route, and requires the `adminUser.delete` permission.
/// Restore a deleted user
///
/// Restore a previously deleted user.
///
/// Parameters:
///
@ -415,7 +443,9 @@ class UsersAdminApi {
return null;
}
/// This endpoint is an admin-only route, and requires the `adminUser.read` permission.
/// Search users
///
/// Search for users.
///
/// Note: This method returns the HTTP [Response].
///
@ -456,7 +486,9 @@ class UsersAdminApi {
);
}
/// This endpoint is an admin-only route, and requires the `adminUser.read` permission.
/// Search users
///
/// Search for users.
///
/// Parameters:
///
@ -481,7 +513,9 @@ class UsersAdminApi {
return null;
}
/// This endpoint is an admin-only route, and requires the `adminUser.update` permission.
/// Update a user
///
/// Update an existing user.
///
/// Note: This method returns the HTTP [Response].
///
@ -516,7 +550,9 @@ class UsersAdminApi {
);
}
/// This endpoint is an admin-only route, and requires the `adminUser.update` permission.
/// Update a user
///
/// Update an existing user.
///
/// Parameters:
///
@ -538,7 +574,9 @@ class UsersAdminApi {
return null;
}
/// This endpoint is an admin-only route, and requires the `adminUser.update` permission.
/// Update user preferences
///
/// Update the preferences of a specific user.
///
/// Note: This method returns the HTTP [Response].
///
@ -573,7 +611,9 @@ class UsersAdminApi {
);
}
/// This endpoint is an admin-only route, and requires the `adminUser.update` permission.
/// Update user preferences
///
/// Update the preferences of a specific user.
///
/// Parameters:
///

120
mobile/openapi/lib/api/users_api.dart generated
View file

@ -16,7 +16,9 @@ class UsersApi {
final ApiClient apiClient;
/// This endpoint requires the `userProfileImage.update` permission.
/// Create user profile image
///
/// Upload and set a new profile image for the current user.
///
/// Note: This method returns the HTTP [Response].
///
@ -58,7 +60,9 @@ class UsersApi {
);
}
/// This endpoint requires the `userProfileImage.update` permission.
/// Create user profile image
///
/// Upload and set a new profile image for the current user.
///
/// Parameters:
///
@ -78,7 +82,9 @@ class UsersApi {
return null;
}
/// This endpoint requires the `userProfileImage.delete` permission.
/// Delete user profile image
///
/// Delete the profile image of the current user.
///
/// Note: This method returns the HTTP [Response].
Future<Response> deleteProfileImageWithHttpInfo() async {
@ -106,7 +112,9 @@ class UsersApi {
);
}
/// This endpoint requires the `userProfileImage.delete` permission.
/// Delete user profile image
///
/// Delete the profile image of the current user.
Future<void> deleteProfileImage() async {
final response = await deleteProfileImageWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -114,7 +122,9 @@ class UsersApi {
}
}
/// This endpoint requires the `userLicense.delete` permission.
/// Delete user product key
///
/// Delete the registered product key for the current user.
///
/// Note: This method returns the HTTP [Response].
Future<Response> deleteUserLicenseWithHttpInfo() async {
@ -142,7 +152,9 @@ class UsersApi {
);
}
/// This endpoint requires the `userLicense.delete` permission.
/// Delete user product key
///
/// Delete the registered product key for the current user.
Future<void> deleteUserLicense() async {
final response = await deleteUserLicenseWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -150,7 +162,9 @@ class UsersApi {
}
}
/// This endpoint requires the `userOnboarding.delete` permission.
/// Delete user onboarding
///
/// Delete the onboarding status of the current user.
///
/// Note: This method returns the HTTP [Response].
Future<Response> deleteUserOnboardingWithHttpInfo() async {
@ -178,7 +192,9 @@ class UsersApi {
);
}
/// This endpoint requires the `userOnboarding.delete` permission.
/// Delete user onboarding
///
/// Delete the onboarding status of the current user.
Future<void> deleteUserOnboarding() async {
final response = await deleteUserOnboardingWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -186,7 +202,9 @@ class UsersApi {
}
}
/// This endpoint requires the `userPreference.read` permission.
/// Get my preferences
///
/// Retrieve the preferences for the current user.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getMyPreferencesWithHttpInfo() async {
@ -214,7 +232,9 @@ class UsersApi {
);
}
/// This endpoint requires the `userPreference.read` permission.
/// Get my preferences
///
/// Retrieve the preferences for the current user.
Future<UserPreferencesResponseDto?> getMyPreferences() async {
final response = await getMyPreferencesWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -230,7 +250,9 @@ class UsersApi {
return null;
}
/// This endpoint requires the `user.read` permission.
/// Get current user
///
/// Retrieve information about the user making the API request.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getMyUserWithHttpInfo() async {
@ -258,7 +280,9 @@ class UsersApi {
);
}
/// This endpoint requires the `user.read` permission.
/// Get current user
///
/// Retrieve information about the user making the API request.
Future<UserAdminResponseDto?> getMyUser() async {
final response = await getMyUserWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -274,7 +298,9 @@ class UsersApi {
return null;
}
/// This endpoint requires the `userProfileImage.read` permission.
/// Retrieve user profile image
///
/// Retrieve the profile image file for a user.
///
/// Note: This method returns the HTTP [Response].
///
@ -307,7 +333,9 @@ class UsersApi {
);
}
/// This endpoint requires the `userProfileImage.read` permission.
/// Retrieve user profile image
///
/// Retrieve the profile image file for a user.
///
/// Parameters:
///
@ -327,7 +355,9 @@ class UsersApi {
return null;
}
/// This endpoint requires the `user.read` permission.
/// Retrieve a user
///
/// Retrieve a specific user by their ID.
///
/// Note: This method returns the HTTP [Response].
///
@ -360,7 +390,9 @@ class UsersApi {
);
}
/// This endpoint requires the `user.read` permission.
/// Retrieve a user
///
/// Retrieve a specific user by their ID.
///
/// Parameters:
///
@ -380,7 +412,9 @@ class UsersApi {
return null;
}
/// This endpoint requires the `userLicense.read` permission.
/// Retrieve user product key
///
/// Retrieve information about whether the current user has a registered product key.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getUserLicenseWithHttpInfo() async {
@ -408,7 +442,9 @@ class UsersApi {
);
}
/// This endpoint requires the `userLicense.read` permission.
/// Retrieve user product key
///
/// Retrieve information about whether the current user has a registered product key.
Future<LicenseResponseDto?> getUserLicense() async {
final response = await getUserLicenseWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -424,7 +460,9 @@ class UsersApi {
return null;
}
/// This endpoint requires the `userOnboarding.read` permission.
/// Retrieve user onboarding
///
/// Retrieve the onboarding status of the current user.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getUserOnboardingWithHttpInfo() async {
@ -452,7 +490,9 @@ class UsersApi {
);
}
/// This endpoint requires the `userOnboarding.read` permission.
/// Retrieve user onboarding
///
/// Retrieve the onboarding status of the current user.
Future<OnboardingResponseDto?> getUserOnboarding() async {
final response = await getUserOnboardingWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -468,7 +508,9 @@ class UsersApi {
return null;
}
/// This endpoint requires the `user.read` permission.
/// Get all users
///
/// Retrieve a list of all users on the server.
///
/// Note: This method returns the HTTP [Response].
Future<Response> searchUsersWithHttpInfo() async {
@ -496,7 +538,9 @@ class UsersApi {
);
}
/// This endpoint requires the `user.read` permission.
/// Get all users
///
/// Retrieve a list of all users on the server.
Future<List<UserResponseDto>?> searchUsers() async {
final response = await searchUsersWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -515,7 +559,9 @@ class UsersApi {
return null;
}
/// This endpoint requires the `userLicense.update` permission.
/// Set user product key
///
/// Register a product key for the current user.
///
/// Note: This method returns the HTTP [Response].
///
@ -547,7 +593,9 @@ class UsersApi {
);
}
/// This endpoint requires the `userLicense.update` permission.
/// Set user product key
///
/// Register a product key for the current user.
///
/// Parameters:
///
@ -567,7 +615,9 @@ class UsersApi {
return null;
}
/// This endpoint requires the `userOnboarding.update` permission.
/// Update user onboarding
///
/// Update the onboarding status of the current user.
///
/// Note: This method returns the HTTP [Response].
///
@ -599,7 +649,9 @@ class UsersApi {
);
}
/// This endpoint requires the `userOnboarding.update` permission.
/// Update user onboarding
///
/// Update the onboarding status of the current user.
///
/// Parameters:
///
@ -619,7 +671,9 @@ class UsersApi {
return null;
}
/// This endpoint requires the `userPreference.update` permission.
/// Update my preferences
///
/// Update the preferences of the current user.
///
/// Note: This method returns the HTTP [Response].
///
@ -651,7 +705,9 @@ class UsersApi {
);
}
/// This endpoint requires the `userPreference.update` permission.
/// Update my preferences
///
/// Update the preferences of the current user.
///
/// Parameters:
///
@ -671,7 +727,9 @@ class UsersApi {
return null;
}
/// This endpoint requires the `user.update` permission.
/// Update current user
///
/// Update the current user making teh API request.
///
/// Note: This method returns the HTTP [Response].
///
@ -703,7 +761,9 @@ class UsersApi {
);
}
/// This endpoint requires the `user.update` permission.
/// Update current user
///
/// Update the current user making teh API request.
///
/// Parameters:
///

24
mobile/openapi/lib/api/view_api.dart → mobile/openapi/lib/api/views_api.dart generated
View file

@ -11,12 +11,17 @@
part of openapi.api;
class ViewApi {
ViewApi([ApiClient? apiClient]) : apiClient = apiClient ?? defaultApiClient;
class ViewsApi {
ViewsApi([ApiClient? apiClient]) : apiClient = apiClient ?? defaultApiClient;
final ApiClient apiClient;
/// Performs an HTTP 'GET /view/folder' operation and returns the [Response].
/// Retrieve assets by original path
///
/// Retrieve assets that are children of a specific folder.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] path (required):
@ -47,6 +52,10 @@ class ViewApi {
);
}
/// Retrieve assets by original path
///
/// Retrieve assets that are children of a specific folder.
///
/// Parameters:
///
/// * [String] path (required):
@ -68,7 +77,11 @@ class ViewApi {
return null;
}
/// Performs an HTTP 'GET /view/folder/unique-paths' operation and returns the [Response].
/// Retrieve unique paths
///
/// Retrieve a list of unique folder paths from asset original paths.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getUniqueOriginalPathsWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = r'/view/folder/unique-paths';
@ -94,6 +107,9 @@ class ViewApi {
);
}
/// Retrieve unique paths
///
/// Retrieve a list of unique folder paths from asset original paths.
Future<List<String>?> getUniqueOriginalPaths() async {
final response = await getUniqueOriginalPathsWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {

1256
open-api/immich-openapi-specs.json
View file

File diff suppressed because it is too large Load diff

488
open-api/typescript-sdk/src/fetch-client.ts
View file

File diff suppressed because it is too large Load diff

55
server/src/constants.ts
View file

@ -2,7 +2,7 @@ import { Duration } from 'luxon';
import { readFileSync } from 'node:fs';
import { dirname, join } from 'node:path';
import { SemVer } from 'semver';
import { DatabaseExtension, ExifOrientation, VectorIndex } from 'src/enum';
import { ApiTag, DatabaseExtension, ExifOrientation, VectorIndex } from 'src/enum';
export const POSTGRES_VERSION_RANGE = '>=14.0.0';
export const VECTORCHORD_VERSION_RANGE = '>=0.3 <0.6';
@ -138,3 +138,56 @@ export const ORIENTATION_TO_SHARP_ROTATION: Record<ExifOrientation, SharpRotatio
[ExifOrientation.MirrorHorizontalRotate90CW]: { angle: 90, flip: true },
[ExifOrientation.Rotate270CW]: { angle: 270 },
} as const;
export const endpointTags: Record<ApiTag, string> = {
[ApiTag.Activities]: 'An activity is a like or a comment made by a user on an asset or album.',
[ApiTag.Albums]: 'An album is a collection of assets that can be shared with other users or via shared links.',
[ApiTag.ApiKeys]: 'An api key can be used to programmatically access the Immich API.',
[ApiTag.Assets]: 'An asset is an image or video that has been uploaded to Immich.',
[ApiTag.Authentication]: 'Endpoints related to user authentication, including OAuth.',
[ApiTag.AuthenticationAdmin]: 'Administrative endpoints related to authentication.',
[ApiTag.Deprecated]: 'Deprecated endpoints that are planned for removal in the next major release.',
[ApiTag.Download]: 'Endpoints for downloading assets or collections of assets.',
[ApiTag.Duplicates]: 'Endpoints for managing and identifying duplicate assets.',
[ApiTag.Faces]:
'A face is a detected human face within an asset, which can be associated with a person. Faces are normally detected via machine learning, but can also be created via manually.',
[ApiTag.Jobs]:
'Queues and background jobs are used for processing tasks asynchronously. Queues can be paused and resumed as needed.',
[ApiTag.Libraries]:
'An external library is made up of input file paths or expressions that are scanned for asset files. Discovered files are automatically imported. Assets much be unique within a library, but can be duplicated across libraries. Each user has a default upload library, and can have one or more external libraries.',
[ApiTag.Map]:
'Map endpoints include supplemental functionality related to geolocation, such as reverse geocoding and retrieving map markers for assets with geolocation data.',
[ApiTag.Memories]:
'A memory is a specialized collection of assets with dedicated viewing implementations in the web and mobile clients. A memory includes fields related to visibility and are automatically generated per user via a background job.',
[ApiTag.Notifications]:
'A notification is a specialized message sent to users to inform them of important events. Currently, these notifications are only shown in the Immich web application.',
[ApiTag.NotificationsAdmin]: 'Notification administrative endpoints.',
[ApiTag.Partners]: 'A partner is a link with another user that allows sharing of assets between two users.',
[ApiTag.People]:
'A person is a collection of faces, which can be favorited and named. A person can also be merged into another person. People are automatically created via the face recognition job.',
[ApiTag.Search]:
'Endpoints related to searching assets via text, smart search, optical character recognition (OCR), and other filters like person, album, and other metadata. Search endpoints usually support pagination and sorting.',
[ApiTag.Server]:
'Information about the current server deployment, including version and build information, available features, supported media types, and more.',
[ApiTag.Sessions]:
'A session represents an authenticated login session for a user. Sessions also appear in the web application as "Authorized devices".',
[ApiTag.SharedLinks]:
'A shared link is a public url that provides access to a specific album, asset, or collection of assets. A shared link can be protected with a password, include a specific slug, allow or disallow downloads, and optionally include an expiration date.',
[ApiTag.Stacks]:
'A stack is a group of related assets. One asset is the "primary" asset, and the rest are "child" assets. On the main timeline, stack parents are included by default, while child assets are hidden.',
[ApiTag.Sync]: 'A collection of endpoints for the new mobile synchronization implementation.',
[ApiTag.SystemConfig]: 'Endpoints to view, modify, and validate the system configuration settings.',
[ApiTag.SystemMetadata]:
'Endpoints to view, modify, and validate the system metadata, which includes information about things like admin onboarding status.',
[ApiTag.Tags]:
'A tag is a user-defined label that can be applied to assets for organizational purposes. Tags can also be hierarchical, allowing for parent-child relationships between tags.',
[ApiTag.Timeline]:
'Specialized endpoints related to the timeline implementation used in the web application. External applications or tools should not use or rely on these endpoints, as they are subject to change without notice.',
[ApiTag.Trash]:
'Endpoints for managing the trash can, which includes assets that have been discarded. Items in the trash are automatically deleted after a configured amount of time.',
[ApiTag.UsersAdmin]:
'Administrative endpoints for managing users, including creating, updating, deleting, and restoring users. Also includes endpoints for resetting passwords and PIN codes.',
[ApiTag.Users]:
'Endpoints for viewing and updating the current users, including product key information, profile picture data, onboarding progress, and more.',
[ApiTag.Views]: 'Endpoints for specialized views, such as the folder view.',
};

23
server/src/controllers/activity.controller.ts
View file

@ -1,5 +1,5 @@
import { Body, Controller, Delete, Get, HttpCode, HttpStatus, Param, Post, Query, Res } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import { Response } from 'express';
import {
ActivityCreateDto,
@ -9,24 +9,33 @@ import {
ActivityStatisticsResponseDto,
} from 'src/dtos/activity.dto';
import { AuthDto } from 'src/dtos/auth.dto';
import { Permission } from 'src/enum';
import { ApiTag, Permission } from 'src/enum';
import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { ActivityService } from 'src/services/activity.service';
import { UUIDParamDto } from 'src/validation';
@ApiTags('Activities')
@ApiTags(ApiTag.Activities)
@Controller('activities')
export class ActivityController {
constructor(private service: ActivityService) {}
@Get()
@Authenticated({ permission: Permission.ActivityRead })
@ApiOperation({
summary: 'List all activities',
description:
'Returns a list of activities for the selected asset or album. The activities are returned in sorted order, with the oldest activities appearing first.',
})
getActivities(@Auth() auth: AuthDto, @Query() dto: ActivitySearchDto): Promise<ActivityResponseDto[]> {
return this.service.getAll(auth, dto);
}
@Post()
@Authenticated({ permission: Permission.ActivityCreate })
@ApiOperation({
summary: 'Create an activity',
description: 'Create a like or a comment for an album, or an asset in an album.',
})
async createActivity(
@Auth() auth: AuthDto,
@Body() dto: ActivityCreateDto,
@ -41,6 +50,10 @@ export class ActivityController {
@Get('statistics')
@Authenticated({ permission: Permission.ActivityStatistics })
@ApiOperation({
summary: 'Retrieve activity statistics',
description: 'Returns the number of likes and comments for a given album or asset in an album.',
})
getActivityStatistics(@Auth() auth: AuthDto, @Query() dto: ActivityDto): Promise<ActivityStatisticsResponseDto> {
return this.service.getStatistics(auth, dto);
}
@ -48,6 +61,10 @@ export class ActivityController {
@Delete(':id')
@Authenticated({ permission: Permission.ActivityDelete })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Delete an activity',
description: 'Removes a like or comment from a given album or asset in an album.',
})
deleteActivity(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<void> {
return this.service.delete(auth, id);
}

56
server/src/controllers/album.controller.ts
View file

@ -1,5 +1,5 @@
import { Body, Controller, Delete, Get, HttpCode, HttpStatus, Param, Patch, Post, Put, Query } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import {
AddUsersDto,
AlbumInfoDto,
@ -14,36 +14,52 @@ import {
} from 'src/dtos/album.dto';
import { BulkIdResponseDto, BulkIdsDto } from 'src/dtos/asset-ids.response.dto';
import { AuthDto } from 'src/dtos/auth.dto';
import { Permission } from 'src/enum';
import { ApiTag, Permission } from 'src/enum';
import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { AlbumService } from 'src/services/album.service';
import { ParseMeUUIDPipe, UUIDParamDto } from 'src/validation';
@ApiTags('Albums')
@ApiTags(ApiTag.Albums)
@Controller('albums')
export class AlbumController {
constructor(private service: AlbumService) {}
@Get()
@Authenticated({ permission: Permission.AlbumRead })
@ApiOperation({
summary: 'List all albums',
description: 'Retrieve a list of albums available to the authenticated user.',
})
getAllAlbums(@Auth() auth: AuthDto, @Query() query: GetAlbumsDto): Promise<AlbumResponseDto[]> {
return this.service.getAll(auth, query);
}
@Post()
@Authenticated({ permission: Permission.AlbumCreate })
@ApiOperation({
summary: 'Create an album',
description: 'Create a new album. The album can also be created with initial users and assets.',
})
createAlbum(@Auth() auth: AuthDto, @Body() dto: CreateAlbumDto): Promise<AlbumResponseDto> {
return this.service.create(auth, dto);
}
@Get('statistics')
@Authenticated({ permission: Permission.AlbumStatistics })
@ApiOperation({
summary: 'Retrieve album statistics',
description: 'Returns statistics about the albums available to the authenticated user.',
})
getAlbumStatistics(@Auth() auth: AuthDto): Promise<AlbumStatisticsResponseDto> {
return this.service.getStatistics(auth);
}
@Authenticated({ permission: Permission.AlbumRead, sharedLink: true })
@Get(':id')
@ApiOperation({
summary: 'Retrieve an album',
description: 'Retrieve information about a specific album by its ID.',
})
getAlbumInfo(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,
@ -54,6 +70,11 @@ export class AlbumController {
@Patch(':id')
@Authenticated({ permission: Permission.AlbumUpdate })
@ApiOperation({
summary: 'Update an album',
description:
'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.',
})
updateAlbumInfo(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,
@ -65,12 +86,21 @@ export class AlbumController {
@Delete(':id')
@Authenticated({ permission: Permission.AlbumDelete })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Delete an album',
description:
'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.',
})
deleteAlbum(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto) {
return this.service.delete(auth, id);
}
@Put(':id/assets')
@Authenticated({ permission: Permission.AlbumAssetCreate, sharedLink: true })
@ApiOperation({
summary: 'Add assets to an album',
description: 'Add multiple assets to a specific album by its ID.',
})
addAssetsToAlbum(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,
@ -81,12 +111,20 @@ export class AlbumController {
@Put('assets')
@Authenticated({ permission: Permission.AlbumAssetCreate, sharedLink: true })
@ApiOperation({
summary: 'Add assets to albums',
description: 'Send a list of asset IDs and album IDs to add each asset to each album.',
})
addAssetsToAlbums(@Auth() auth: AuthDto, @Body() dto: AlbumsAddAssetsDto): Promise<AlbumsAddAssetsResponseDto> {
return this.service.addAssetsToAlbums(auth, dto);
}
@Delete(':id/assets')
@Authenticated({ permission: Permission.AlbumAssetDelete })
@ApiOperation({
summary: 'Remove assets from an album',
description: 'Remove multiple assets from a specific album by its ID.',
})
removeAssetFromAlbum(
@Auth() auth: AuthDto,
@Body() dto: BulkIdsDto,
@ -97,6 +135,10 @@ export class AlbumController {
@Put(':id/users')
@Authenticated({ permission: Permission.AlbumUserCreate })
@ApiOperation({
summary: 'Share album with users',
description: 'Share an album with multiple users. Each user can be given a specific role in the album.',
})
addUsersToAlbum(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,
@ -108,6 +150,10 @@ export class AlbumController {
@Put(':id/user/:userId')
@Authenticated({ permission: Permission.AlbumUserUpdate })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Update user role',
description: 'Change the role for a specific user in a specific album.',
})
updateAlbumUser(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,
@ -120,6 +166,10 @@ export class AlbumController {
@Delete(':id/user/:userId')
@Authenticated({ permission: Permission.AlbumUserDelete })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Remove user from album',
description: 'Remove a user from an album. Use an ID of "me" to leave a shared album.',
})
removeUserFromAlbum(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,

27
server/src/controllers/api-key.controller.ts
View file

@ -1,43 +1,60 @@
import { Body, Controller, Delete, Get, HttpCode, HttpStatus, Param, Post, Put } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import { APIKeyCreateDto, APIKeyCreateResponseDto, APIKeyResponseDto, APIKeyUpdateDto } from 'src/dtos/api-key.dto';
import { AuthDto } from 'src/dtos/auth.dto';
import { Permission } from 'src/enum';
import { ApiTag, Permission } from 'src/enum';
import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { ApiKeyService } from 'src/services/api-key.service';
import { UUIDParamDto } from 'src/validation';
@ApiTags('API Keys')
@ApiTags(ApiTag.ApiKeys)
@Controller('api-keys')
export class ApiKeyController {
constructor(private service: ApiKeyService) {}
@Post()
@Authenticated({ permission: Permission.ApiKeyCreate })
@ApiOperation({
summary: 'Create an API key',
description: 'Creates a new API key. It will be limited to the permissions specified.',
})
createApiKey(@Auth() auth: AuthDto, @Body() dto: APIKeyCreateDto): Promise<APIKeyCreateResponseDto> {
return this.service.create(auth, dto);
}
@Get()
@Authenticated({ permission: Permission.ApiKeyRead })
@ApiOperation({ summary: 'List all API keys', description: 'Retrieve all API keys of the current user.' })
getApiKeys(@Auth() auth: AuthDto): Promise<APIKeyResponseDto[]> {
return this.service.getAll(auth);
}
@Get('me')
@Authenticated({ permission: false })
@ApiOperation({
summary: 'Retrieve the current API key',
description: 'Retrieve the API key that is used to access this endpoint.',
})
async getMyApiKey(@Auth() auth: AuthDto): Promise<APIKeyResponseDto> {
return this.service.getMine(auth);
}
@Get(':id')
@Authenticated({ permission: Permission.ApiKeyRead })
@ApiOperation({
summary: 'Retrieve an API key',
description: 'Retrieve an API key by its ID. The current user must own this API key.',
})
getApiKey(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<APIKeyResponseDto> {
return this.service.getById(auth, id);
}
@Put(':id')
@Authenticated({ permission: Permission.ApiKeyUpdate })
@ApiOperation({
summary: 'Update an API key',
description: 'Updates the name and permissions of an API key by its ID. The current user must own this API key.',
})
updateApiKey(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,
@ -49,6 +66,10 @@ export class ApiKeyController {
@Delete(':id')
@Authenticated({ permission: Permission.ApiKeyDelete })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Delete an API key',
description: 'Deletes an API key identified by its ID. The current user must own this API key.',
})
deleteApiKey(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<void> {
return this.service.delete(auth, id);
}

35
server/src/controllers/asset-media.controller.ts
View file

@ -34,7 +34,7 @@ import {
UploadFieldName,
} from 'src/dtos/asset-media.dto';
import { AuthDto } from 'src/dtos/auth.dto';
import { ImmichHeader, Permission, RouteKey } from 'src/enum';
import { ApiTag, ImmichHeader, Permission, RouteKey } from 'src/enum';
import { AssetUploadInterceptor } from 'src/middleware/asset-upload.interceptor';
import { Auth, Authenticated, FileResponse } from 'src/middleware/auth.guard';
import { FileUploadInterceptor, getFiles } from 'src/middleware/file-upload.interceptor';
@ -44,7 +44,7 @@ import { UploadFiles } from 'src/types';
import { ImmichFileResponse, sendFile } from 'src/utils/file';
import { FileNotEmptyValidator, UUIDParamDto } from 'src/validation';
@ApiTags('Assets')
@ApiTags(ApiTag.Assets)
@Controller(RouteKey.Asset)
export class AssetMediaController {
constructor(
@ -53,6 +53,7 @@ export class AssetMediaController {
) {}
@Post()
@Authenticated({ permission: Permission.AssetUpload, sharedLink: true })
@UseInterceptors(AssetUploadInterceptor, FileUploadInterceptor)
@ApiConsumes('multipart/form-data')
@ApiHeader({
@ -61,7 +62,10 @@ export class AssetMediaController {
required: false,
})
@ApiBody({ description: 'Asset Upload Information', type: AssetMediaCreateDto })
@Authenticated({ permission: Permission.AssetUpload, sharedLink: true })
@ApiOperation({
summary: 'Upload asset',
description: 'Uploads a new asset to the server.',
})
async uploadAsset(
@Auth() auth: AuthDto,
@UploadedFiles(new ParseFilePipe({ validators: [new FileNotEmptyValidator(['assetData'])] })) files: UploadFiles,
@ -81,6 +85,10 @@ export class AssetMediaController {
@Get(':id/original')
@FileResponse()
@Authenticated({ permission: Permission.AssetDownload, sharedLink: true })
@ApiOperation({
summary: 'Download original asset',
description: 'Downloads the original file of the specified asset.',
})
async downloadAsset(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,
@ -90,17 +98,14 @@ export class AssetMediaController {
await sendFile(res, next, () => this.service.downloadOriginal(auth, id), this.logger);
}
/**
* Replace the asset with new file, without changing its id
*/
@Put(':id/original')
@UseInterceptors(FileUploadInterceptor)
@ApiConsumes('multipart/form-data')
@EndpointLifecycle({
addedAt: 'v1.106.0',
deprecatedAt: 'v1.142.0',
summary: 'replaceAsset',
description: 'Replace the asset with new file, without changing its id',
summary: 'Replace asset',
description: 'Replace the asset with new file, without changing its id.',
})
@Authenticated({ permission: Permission.AssetReplace, sharedLink: true })
async replaceAsset(
@ -122,6 +127,10 @@ export class AssetMediaController {
@Get(':id/thumbnail')
@FileResponse()
@Authenticated({ permission: Permission.AssetView, sharedLink: true })
@ApiOperation({
summary: 'View asset thumbnail',
description: 'Retrieve the thumbnail image for the specified asset.',
})
async viewAsset(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,
@ -159,6 +168,10 @@ export class AssetMediaController {
@Get(':id/video/playback')
@FileResponse()
@Authenticated({ permission: Permission.AssetView, sharedLink: true })
@ApiOperation({
summary: 'Play asset video',
description: 'Streams the video file for the specified asset. This endpoint also supports byte range requests.',
})
async playAssetVideo(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,
@ -174,7 +187,7 @@ export class AssetMediaController {
@Post('exist')
@Authenticated()
@ApiOperation({
summary: 'checkExistingAssets',
summary: 'Check existing assets',
description: 'Checks if multiple assets exist on the server and returns all existing - used by background backup',
})
@HttpCode(HttpStatus.OK)
@ -191,8 +204,8 @@ export class AssetMediaController {
@Post('bulk-upload-check')
@Authenticated({ permission: Permission.AssetUpload })
@ApiOperation({
summary: 'checkBulkUpload',
description: 'Checks if assets exist by checksums',
summary: 'Check bulk upload',
description: 'Determine which assets have already been uploaded to the server based on their SHA1 checksums.',
})
@HttpCode(HttpStatus.OK)
checkBulkUpload(

66
server/src/controllers/asset.controller.ts
View file

@ -18,29 +18,31 @@ import {
} from 'src/dtos/asset.dto';
import { AuthDto } from 'src/dtos/auth.dto';
import { AssetOcrResponseDto } from 'src/dtos/ocr.dto';
import { Permission, RouteKey } from 'src/enum';
import { ApiTag, Permission, RouteKey } from 'src/enum';
import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { AssetService } from 'src/services/asset.service';
import { UUIDParamDto } from 'src/validation';
@ApiTags('Assets')
@ApiTags(ApiTag.Assets)
@Controller(RouteKey.Asset)
export class AssetController {
constructor(private service: AssetService) {}
@Get('random')
@Authenticated({ permission: Permission.AssetRead })
@EndpointLifecycle({ deprecatedAt: 'v1.116.0' })
@EndpointLifecycle({
deprecatedAt: 'v1.116.0',
summary: 'Get random assets',
description: 'Retrieve a specified number of random assets for the authenticated user.',
})
getRandom(@Auth() auth: AuthDto, @Query() dto: RandomAssetsDto): Promise<AssetResponseDto[]> {
return this.service.getRandom(auth, dto.count ?? 1);
}
/**
* Get all asset of a device that are in the database, ID only.
*/
@Get('/device/:deviceId')
@ApiOperation({
summary: 'getAllUserAssetsByDeviceId',
@EndpointLifecycle({
deprecatedAt: 'v2.0.0',
summary: 'Retrieve assets by device ID',
description: 'Get all asset of a device that are in the database, ID only.',
})
@Authenticated()
@ -50,6 +52,10 @@ export class AssetController {
@Get('statistics')
@Authenticated({ permission: Permission.AssetStatistics })
@ApiOperation({
summary: 'Get asset statistics',
description: 'Retrieve various statistics about the assets owned by the authenticated user.',
})
getAssetStatistics(@Auth() auth: AuthDto, @Query() dto: AssetStatsDto): Promise<AssetStatsResponseDto> {
return this.service.getStatistics(auth, dto);
}
@ -57,6 +63,10 @@ export class AssetController {
@Post('jobs')
@Authenticated()
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Run an asset job',
description: 'Run a specific job on a set of assets.',
})
runAssetJobs(@Auth() auth: AuthDto, @Body() dto: AssetJobsDto): Promise<void> {
return this.service.run(auth, dto);
}
@ -64,6 +74,10 @@ export class AssetController {
@Put()
@Authenticated({ permission: Permission.AssetUpdate })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Update assets',
description: 'Updates multiple assets at the same time.',
})
updateAssets(@Auth() auth: AuthDto, @Body() dto: AssetBulkUpdateDto): Promise<void> {
return this.service.updateAll(auth, dto);
}
@ -71,12 +85,20 @@ export class AssetController {
@Delete()
@Authenticated({ permission: Permission.AssetDelete })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Delete assets',
description: 'Deletes multiple assets at the same time.',
})
deleteAssets(@Auth() auth: AuthDto, @Body() dto: AssetBulkDeleteDto): Promise<void> {
return this.service.deleteAll(auth, dto);
}
@Get(':id')
@Authenticated({ permission: Permission.AssetRead, sharedLink: true })
@ApiOperation({
summary: 'Retrieve an asset',
description: 'Retrieve detailed information about a specific asset.',
})
getAssetInfo(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<AssetResponseDto> {
return this.service.get(auth, id) as Promise<AssetResponseDto>;
}
@ -84,12 +106,20 @@ export class AssetController {
@Put('copy')
@Authenticated({ permission: Permission.AssetCopy })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Copy asset',
description: 'Copy asset information like albums, tags, etc. from one asset to another.',
})
copyAsset(@Auth() auth: AuthDto, @Body() dto: AssetCopyDto): Promise<void> {
return this.service.copy(auth, dto);
}
@Put(':id')
@Authenticated({ permission: Permission.AssetUpdate })
@ApiOperation({
summary: 'Update an asset',
description: 'Update information of a specific asset.',
})
updateAsset(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,
@ -100,18 +130,30 @@ export class AssetController {
@Get(':id/metadata')
@Authenticated({ permission: Permission.AssetRead })
@ApiOperation({
summary: 'Get asset metadata',
description: 'Retrieve all metadata key-value pairs associated with the specified asset.',
})
getAssetMetadata(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<AssetMetadataResponseDto[]> {
return this.service.getMetadata(auth, id);
}
@Get(':id/ocr')
@Authenticated({ permission: Permission.AssetRead })
@ApiOperation({
summary: 'Retrieve asset OCR data',
description: 'Retrieve all OCR (Optical Character Recognition) data associated with the specified asset.',
})
getAssetOcr(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<AssetOcrResponseDto[]> {
return this.service.getOcr(auth, id);
}
@Put(':id/metadata')
@Authenticated({ permission: Permission.AssetUpdate })
@ApiOperation({
summary: 'Update asset metadata',
description: 'Update or add metadata key-value pairs for the specified asset.',
})
updateAssetMetadata(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,
@ -122,6 +164,10 @@ export class AssetController {
@Get(':id/metadata/:key')
@Authenticated({ permission: Permission.AssetRead })
@ApiOperation({
summary: 'Retrieve asset metadata by key',
description: 'Retrieve the value of a specific metadata key associated with the specified asset.',
})
getAssetMetadataByKey(
@Auth() auth: AuthDto,
@Param() { id, key }: AssetMetadataRouteParams,
@ -132,6 +178,10 @@ export class AssetController {
@Delete(':id/metadata/:key')
@Authenticated({ permission: Permission.AssetUpdate })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Delete asset metadata by key',
description: 'Delete a specific metadata key-value pair associated with the specified asset.',
})
deleteAssetMetadata(@Auth() auth: AuthDto, @Param() { id, key }: AssetMetadataRouteParams): Promise<void> {
return this.service.deleteMetadataByKey(auth, id, key);
}

10
server/src/controllers/auth-admin.controller.ts
View file

@ -1,17 +1,21 @@
import { Controller, HttpCode, HttpStatus, Post } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import { AuthDto } from 'src/dtos/auth.dto';
import { Permission } from 'src/enum';
import { ApiTag, Permission } from 'src/enum';
import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { AuthAdminService } from 'src/services/auth-admin.service';
@ApiTags('Auth (admin)')
@ApiTags(ApiTag.AuthenticationAdmin)
@Controller('admin/auth')
export class AuthAdminController {
constructor(private service: AuthAdminService) {}
@Post('unlink-all')
@Authenticated({ permission: Permission.AdminAuthUnlinkAll, admin: true })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Unlink all OAuth accounts',
description: 'Unlinks all OAuth accounts associated with user accounts in the system.',
})
unlinkAllOAuthAccountsAdmin(@Auth() auth: AuthDto): Promise<void> {
return this.service.unlinkAll(auth);
}

51
server/src/controllers/auth.controller.ts
View file

@ -1,5 +1,5 @@
import { Body, Controller, Delete, Get, HttpCode, HttpStatus, Post, Put, Req, Res } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import { Request, Response } from 'express';
import {
AuthDto,
@ -16,17 +16,21 @@ import {
ValidateAccessTokenResponseDto,
} from 'src/dtos/auth.dto';
import { UserAdminResponseDto } from 'src/dtos/user.dto';
import { AuthType, ImmichCookie, Permission } from 'src/enum';
import { ApiTag, AuthType, ImmichCookie, Permission } from 'src/enum';
import { Auth, Authenticated, GetLoginDetails } from 'src/middleware/auth.guard';
import { AuthService, LoginDetails } from 'src/services/auth.service';
import { respondWithCookie, respondWithoutCookie } from 'src/utils/response';
@ApiTags('Authentication')
@ApiTags(ApiTag.Authentication)
@Controller('auth')
export class AuthController {
constructor(private service: AuthService) {}
@Post('login')
@ApiOperation({
summary: 'Login',
description: 'Login with username and password and receive a session token.',
})
async login(
@Res({ passthrough: true }) res: Response,
@Body() loginCredential: LoginCredentialDto,
@ -44,11 +48,19 @@ export class AuthController {
}
@Post('admin-sign-up')
@ApiOperation({
summary: 'Register admin',
description: 'Create the first admin user in the system.',
})
signUpAdmin(@Body() dto: SignUpDto): Promise<UserAdminResponseDto> {
return this.service.adminSignUp(dto);
}
@Post('validateToken')
@ApiOperation({
summary: 'Validate access token',
description: 'Validate the current authorization method is still valid.',
})
@Authenticated({ permission: false })
@HttpCode(HttpStatus.OK)
validateAccessToken(): ValidateAccessTokenResponseDto {
@ -58,6 +70,10 @@ export class AuthController {
@Post('change-password')
@Authenticated({ permission: Permission.AuthChangePassword })
@HttpCode(HttpStatus.OK)
@ApiOperation({
summary: 'Change password',
description: 'Change the password of the current user.',
})
changePassword(@Auth() auth: AuthDto, @Body() dto: ChangePasswordDto): Promise<UserAdminResponseDto> {
return this.service.changePassword(auth, dto);
}
@ -65,6 +81,10 @@ export class AuthController {
@Post('logout')
@Authenticated()
@HttpCode(HttpStatus.OK)
@ApiOperation({
summary: 'Logout',
description: 'Logout the current user and invalidate the session token.',
})
async logout(
@Req() request: Request,
@Res({ passthrough: true }) res: Response,
@ -82,6 +102,11 @@ export class AuthController {
@Get('status')
@Authenticated()
@ApiOperation({
summary: 'Retrieve auth status',
description:
'Get information about the current session, including whether the user has a password, and if the session can access locked assets.',
})
getAuthStatus(@Auth() auth: AuthDto): Promise<AuthStatusResponseDto> {
return this.service.getAuthStatus(auth);
}
@ -89,6 +114,10 @@ export class AuthController {
@Post('pin-code')
@Authenticated({ permission: Permission.PinCodeCreate })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Setup pin code',
description: 'Setup a new pin code for the current user.',
})
setupPinCode(@Auth() auth: AuthDto, @Body() dto: PinCodeSetupDto): Promise<void> {
return this.service.setupPinCode(auth, dto);
}
@ -96,6 +125,10 @@ export class AuthController {
@Put('pin-code')
@Authenticated({ permission: Permission.PinCodeUpdate })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Change pin code',
description: 'Change the pin code for the current user.',
})
async changePinCode(@Auth() auth: AuthDto, @Body() dto: PinCodeChangeDto): Promise<void> {
return this.service.changePinCode(auth, dto);
}
@ -103,6 +136,10 @@ export class AuthController {
@Delete('pin-code')
@Authenticated({ permission: Permission.PinCodeDelete })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Reset pin code',
description: 'Reset the pin code for the current user by providing the account password',
})
async resetPinCode(@Auth() auth: AuthDto, @Body() dto: PinCodeResetDto): Promise<void> {
return this.service.resetPinCode(auth, dto);
}
@ -110,12 +147,20 @@ export class AuthController {
@Post('session/unlock')
@Authenticated()
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Unlock auth session',
description: 'Temporarily grant the session elevated access to locked assets by providing the correct PIN code.',
})
async unlockAuthSession(@Auth() auth: AuthDto, @Body() dto: SessionUnlockDto): Promise<void> {
return this.service.unlockSession(auth, dto);
}
@Post('session/lock')
@Authenticated()
@ApiOperation({
summary: 'Lock auth session',
description: 'Remove elevated access to locked assets from the current session.',
})
@HttpCode(HttpStatus.NO_CONTENT)
async lockAuthSession(@Auth() auth: AuthDto): Promise<void> {
return this.service.lockSession(auth);

16
server/src/controllers/download.controller.ts
View file

@ -1,20 +1,25 @@
import { Body, Controller, HttpCode, HttpStatus, Post, StreamableFile } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import { AssetIdsDto } from 'src/dtos/asset.dto';
import { AuthDto } from 'src/dtos/auth.dto';
import { DownloadInfoDto, DownloadResponseDto } from 'src/dtos/download.dto';
import { Permission } from 'src/enum';
import { ApiTag, Permission } from 'src/enum';
import { Auth, Authenticated, FileResponse } from 'src/middleware/auth.guard';
import { DownloadService } from 'src/services/download.service';
import { asStreamableFile } from 'src/utils/file';
@ApiTags('Download')
@ApiTags(ApiTag.Download)
@Controller('download')
export class DownloadController {
constructor(private service: DownloadService) {}
@Post('info')
@Authenticated({ permission: Permission.AssetDownload, sharedLink: true })
@ApiOperation({
summary: 'Retrieve download information',
description:
'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.',
})
getDownloadInfo(@Auth() auth: AuthDto, @Body() dto: DownloadInfoDto): Promise<DownloadResponseDto> {
return this.service.getDownloadInfo(auth, dto);
}
@ -23,6 +28,11 @@ export class DownloadController {
@Authenticated({ permission: Permission.AssetDownload, sharedLink: true })
@FileResponse()
@HttpCode(HttpStatus.OK)
@ApiOperation({
summary: 'Download asset archive',
description:
'Download a ZIP archive containing the specified assets. The assets must have been previously requested via the "getDownloadInfo" endpoint.',
})
downloadArchive(@Auth() auth: AuthDto, @Body() dto: AssetIdsDto): Promise<StreamableFile> {
return this.service.downloadArchive(auth, dto).then(asStreamableFile);
}

18
server/src/controllers/duplicate.controller.ts
View file

@ -1,20 +1,24 @@
import { Body, Controller, Delete, Get, HttpCode, HttpStatus, Param } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import { BulkIdsDto } from 'src/dtos/asset-ids.response.dto';
import { AuthDto } from 'src/dtos/auth.dto';
import { DuplicateResponseDto } from 'src/dtos/duplicate.dto';
import { Permission } from 'src/enum';
import { ApiTag, Permission } from 'src/enum';
import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { DuplicateService } from 'src/services/duplicate.service';
import { UUIDParamDto } from 'src/validation';
@ApiTags('Duplicates')
@ApiTags(ApiTag.Duplicates)
@Controller('duplicates')
export class DuplicateController {
constructor(private service: DuplicateService) {}
@Get()
@Authenticated({ permission: Permission.DuplicateRead })
@ApiOperation({
summary: 'Retrieve duplicates',
description: 'Retrieve a list of duplicate assets available to the authenticated user.',
})
getAssetDuplicates(@Auth() auth: AuthDto): Promise<DuplicateResponseDto[]> {
return this.service.getDuplicates(auth);
}
@ -22,6 +26,10 @@ export class DuplicateController {
@Delete()
@Authenticated({ permission: Permission.DuplicateDelete })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Delete duplicates',
description: 'Delete multiple duplicate assets specified by their IDs.',
})
deleteDuplicates(@Auth() auth: AuthDto, @Body() dto: BulkIdsDto): Promise<void> {
return this.service.deleteAll(auth, dto);
}
@ -29,6 +37,10 @@ export class DuplicateController {
@Delete(':id')
@Authenticated({ permission: Permission.DuplicateDelete })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Delete a duplicate',
description: 'Delete a single duplicate asset specified by its ID.',
})
deleteDuplicate(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<void> {
return this.service.delete(auth, id);
}

23
server/src/controllers/face.controller.ts
View file

@ -1,5 +1,5 @@
import { Body, Controller, Delete, Get, HttpCode, HttpStatus, Param, Post, Put, Query } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import { AuthDto } from 'src/dtos/auth.dto';
import {
AssetFaceCreateDto,
@ -8,30 +8,43 @@ import {
FaceDto,
PersonResponseDto,
} from 'src/dtos/person.dto';
import { Permission } from 'src/enum';
import { ApiTag, Permission } from 'src/enum';
import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { PersonService } from 'src/services/person.service';
import { UUIDParamDto } from 'src/validation';
@ApiTags('Faces')
@ApiTags(ApiTag.Faces)
@Controller('faces')
export class FaceController {
constructor(private service: PersonService) {}
@Post()
@Authenticated({ permission: Permission.FaceCreate })
@ApiOperation({
summary: 'Create a face',
description:
'Create a new face that has not been discovered by facial recognition. The content of the bounding box is considered a face.',
})
createFace(@Auth() auth: AuthDto, @Body() dto: AssetFaceCreateDto) {
return this.service.createFace(auth, dto);
}
@Get()
@Authenticated({ permission: Permission.FaceRead })
@ApiOperation({
summary: 'Retrieve faces for asset',
description: 'Retrieve all faces belonging to an asset.',
})
getFaces(@Auth() auth: AuthDto, @Query() dto: FaceDto): Promise<AssetFaceResponseDto[]> {
return this.service.getFacesById(auth, dto);
}
@Put(':id')
@Authenticated({ permission: Permission.FaceUpdate })
@ApiOperation({
summary: 'Re-assign a face to another person',
description: 'Re-assign the face provided in the body to the person identified by the id in the path parameter.',
})
reassignFacesById(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,
@ -43,6 +56,10 @@ export class FaceController {
@Delete(':id')
@Authenticated({ permission: Permission.FaceDelete })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Delete a face',
description: 'Delete a face identified by the id. Optionally can be force deleted.',
})
deleteFace(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto, @Body() dto: AssetFaceDeleteDto): Promise<void> {
return this.service.deleteFace(auth, id, dto);
}

20
server/src/controllers/job.controller.ts
View file

@ -1,17 +1,21 @@
import { Body, Controller, Get, HttpCode, HttpStatus, Param, Post, Put } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import { AllJobStatusResponseDto, JobCommandDto, JobCreateDto, JobIdParamDto, JobStatusDto } from 'src/dtos/job.dto';
import { Permission } from 'src/enum';
import { ApiTag, Permission } from 'src/enum';
import { Authenticated } from 'src/middleware/auth.guard';
import { JobService } from 'src/services/job.service';
@ApiTags('Jobs')
@ApiTags(ApiTag.Jobs)
@Controller('jobs')
export class JobController {
constructor(private service: JobService) {}
@Get()
@Authenticated({ permission: Permission.JobRead, admin: true })
@ApiOperation({
summary: 'Retrieve queue counts and status',
description: 'Retrieve the counts of the current queue, as well as the current status.',
})
getAllJobsStatus(): Promise<AllJobStatusResponseDto> {
return this.service.getAllJobsStatus();
}
@ -19,12 +23,22 @@ export class JobController {
@Post()
@Authenticated({ permission: Permission.JobCreate, admin: true })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Create a manual job',
description:
'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.',
})
createJob(@Body() dto: JobCreateDto): Promise<void> {
return this.service.create(dto);
}
@Put(':id')
@Authenticated({ permission: Permission.JobCreate, admin: true })
@ApiOperation({
summary: 'Run jobs',
description:
'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.',
})
sendJobCommand(@Param() { id }: JobIdParamDto, @Body() dto: JobCommandDto): Promise<JobStatusDto> {
return this.service.handleCommand(id, dto);
}

39
server/src/controllers/library.controller.ts
View file

@ -1,5 +1,5 @@
import { Body, Controller, Delete, Get, HttpCode, HttpStatus, Param, Post, Put } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import {
CreateLibraryDto,
LibraryResponseDto,
@ -8,36 +8,52 @@ import {
ValidateLibraryDto,
ValidateLibraryResponseDto,
} from 'src/dtos/library.dto';
import { Permission } from 'src/enum';
import { ApiTag, Permission } from 'src/enum';
import { Authenticated } from 'src/middleware/auth.guard';
import { LibraryService } from 'src/services/library.service';
import { UUIDParamDto } from 'src/validation';
@ApiTags('Libraries')
@ApiTags(ApiTag.Libraries)
@Controller('libraries')
export class LibraryController {
constructor(private service: LibraryService) {}
@Get()
@Authenticated({ permission: Permission.LibraryRead, admin: true })
@ApiOperation({
summary: 'Retrieve libraries',
description: 'Retrieve a list of external libraries.',
})
getAllLibraries(): Promise<LibraryResponseDto[]> {
return this.service.getAll();
}
@Post()
@Authenticated({ permission: Permission.LibraryCreate, admin: true })
@ApiOperation({
summary: 'Create a library',
description: 'Create a new external library.',
})
createLibrary(@Body() dto: CreateLibraryDto): Promise<LibraryResponseDto> {
return this.service.create(dto);
}
@Get(':id')
@Authenticated({ permission: Permission.LibraryRead, admin: true })
@ApiOperation({
summary: 'Retrieve a library',
description: 'Retrieve an external library by its ID.',
})
getLibrary(@Param() { id }: UUIDParamDto): Promise<LibraryResponseDto> {
return this.service.get(id);
}
@Put(':id')
@Authenticated({ permission: Permission.LibraryUpdate, admin: true })
@ApiOperation({
summary: 'Update a library',
description: 'Update an existing external library.',
})
updateLibrary(@Param() { id }: UUIDParamDto, @Body() dto: UpdateLibraryDto): Promise<LibraryResponseDto> {
return this.service.update(id, dto);
}
@ -45,6 +61,10 @@ export class LibraryController {
@Delete(':id')
@Authenticated({ permission: Permission.LibraryDelete, admin: true })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Delete a library',
description: 'Delete an external library by its ID.',
})
deleteLibrary(@Param() { id }: UUIDParamDto): Promise<void> {
return this.service.delete(id);
}
@ -52,6 +72,10 @@ export class LibraryController {
@Post(':id/validate')
@Authenticated({ admin: true })
@HttpCode(HttpStatus.OK)
@ApiOperation({
summary: 'Validate library settings',
description: 'Validate the settings of an external library.',
})
// TODO: change endpoint to validate current settings instead
validate(@Param() { id }: UUIDParamDto, @Body() dto: ValidateLibraryDto): Promise<ValidateLibraryResponseDto> {
return this.service.validate(id, dto);
@ -59,6 +83,11 @@ export class LibraryController {
@Get(':id/statistics')
@Authenticated({ permission: Permission.LibraryStatistics, admin: true })
@ApiOperation({
summary: 'Retrieve library statistics',
description:
'Retrieve statistics for a specific external library, including number of videos, images, and storage usage.',
})
getLibraryStatistics(@Param() { id }: UUIDParamDto): Promise<LibraryStatsResponseDto> {
return this.service.getStatistics(id);
}
@ -66,6 +95,10 @@ export class LibraryController {
@Post(':id/scan')
@Authenticated({ permission: Permission.LibraryUpdate, admin: true })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Scan a library',
description: 'Queue a scan for the external library to find and import new assets.',
})
scanLibrary(@Param() { id }: UUIDParamDto): Promise<void> {
return this.service.queueScan(id);
}

13
server/src/controllers/map.controller.ts
View file

@ -1,5 +1,5 @@
import { Controller, Get, HttpCode, HttpStatus, Query } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import { AuthDto } from 'src/dtos/auth.dto';
import {
MapMarkerDto,
@ -7,16 +7,21 @@ import {
MapReverseGeocodeDto,
MapReverseGeocodeResponseDto,
} from 'src/dtos/map.dto';
import { ApiTag } from 'src/enum';
import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { MapService } from 'src/services/map.service';
@ApiTags('Map')
@ApiTags(ApiTag.Map)
@Controller('map')
export class MapController {
constructor(private service: MapService) {}
@Get('markers')
@Authenticated()
@ApiOperation({
summary: 'Retrieve map markers',
description: 'Retrieve a list of latitude and longitude coordinates for every asset with location data.',
})
getMapMarkers(@Auth() auth: AuthDto, @Query() options: MapMarkerDto): Promise<MapMarkerResponseDto[]> {
return this.service.getMapMarkers(auth, options);
}
@ -24,6 +29,10 @@ export class MapController {
@Authenticated()
@Get('reverse-geocode')
@HttpCode(HttpStatus.OK)
@ApiOperation({
summary: 'Reverse geocode coordinates',
description: 'Retrieve location information (e.g., city, country) for given latitude and longitude coordinates.',
})
reverseGeocode(@Query() dto: MapReverseGeocodeDto): Promise<MapReverseGeocodeResponseDto[]> {
return this.service.reverseGeocode(dto);
}

40
server/src/controllers/memory.controller.ts
View file

@ -1,5 +1,5 @@
import { Body, Controller, Delete, Get, HttpCode, HttpStatus, Param, Post, Put, Query } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import { BulkIdResponseDto, BulkIdsDto } from 'src/dtos/asset-ids.response.dto';
import { AuthDto } from 'src/dtos/auth.dto';
import {
@ -9,42 +9,64 @@ import {
MemoryStatisticsResponseDto,
MemoryUpdateDto,
} from 'src/dtos/memory.dto';
import { Permission } from 'src/enum';
import { ApiTag, Permission } from 'src/enum';
import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { MemoryService } from 'src/services/memory.service';
import { UUIDParamDto } from 'src/validation';
@ApiTags('Memories')
@ApiTags(ApiTag.Memories)
@Controller('memories')
export class MemoryController {
constructor(private service: MemoryService) {}
@Get()
@Authenticated({ permission: Permission.MemoryRead })
@ApiOperation({
summary: 'Retrieve memories',
description:
'Retrieve a list of memories. Memories are sorted descending by creation date by default, although they can also be sorted in ascending order, or randomly.',
})
searchMemories(@Auth() auth: AuthDto, @Query() dto: MemorySearchDto): Promise<MemoryResponseDto[]> {
return this.service.search(auth, dto);
}
@Post()
@Authenticated({ permission: Permission.MemoryCreate })
@ApiOperation({
summary: 'Create a memory',
description:
'Create a new memory by providing a name, description, and a list of asset IDs to include in the memory.',
})
createMemory(@Auth() auth: AuthDto, @Body() dto: MemoryCreateDto): Promise<MemoryResponseDto> {
return this.service.create(auth, dto);
}
@Get('statistics')
@Authenticated({ permission: Permission.MemoryStatistics })
@ApiOperation({
summary: 'Retrieve memories statistics',
description: 'Retrieve statistics about memories, such as total count and other relevant metrics.',
})
memoriesStatistics(@Auth() auth: AuthDto, @Query() dto: MemorySearchDto): Promise<MemoryStatisticsResponseDto> {
return this.service.statistics(auth, dto);
}
@Get(':id')
@Authenticated({ permission: Permission.MemoryRead })
@ApiOperation({
summary: 'Retrieve a memory',
description: 'Retrieve a specific memory by its ID.',
})
getMemory(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<MemoryResponseDto> {
return this.service.get(auth, id);
}
@Put(':id')
@Authenticated({ permission: Permission.MemoryUpdate })
@ApiOperation({
summary: 'Update a memory',
description: 'Update an existing memory by its ID.',
})
updateMemory(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,
@ -56,12 +78,20 @@ export class MemoryController {
@Delete(':id')
@Authenticated({ permission: Permission.MemoryDelete })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Delete a memory',
description: 'Delete a specific memory by its ID.',
})
deleteMemory(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<void> {
return this.service.remove(auth, id);
}
@Put(':id/assets')
@Authenticated({ permission: Permission.MemoryAssetCreate })
@ApiOperation({
summary: 'Add assets to a memory',
description: 'Add a list of asset IDs to a specific memory.',
})
addMemoryAssets(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,
@ -73,6 +103,10 @@ export class MemoryController {
@Delete(':id/assets')
@Authenticated({ permission: Permission.MemoryAssetDelete })
@HttpCode(HttpStatus.OK)
@ApiOperation({
summary: 'Remove assets from a memory',
description: 'Remove a list of asset IDs from a specific memory.',
})
removeMemoryAssets(
@Auth() auth: AuthDto,
@Body() dto: BulkIdsDto,

17
server/src/controllers/notification-admin.controller.ts
View file

@ -1,5 +1,5 @@
import { Body, Controller, HttpCode, HttpStatus, Param, Post } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import { AuthDto } from 'src/dtos/auth.dto';
import {
NotificationCreateDto,
@ -9,17 +9,22 @@ import {
TestEmailResponseDto,
} from 'src/dtos/notification.dto';
import { SystemConfigSmtpDto } from 'src/dtos/system-config.dto';
import { ApiTag } from 'src/enum';
import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { EmailTemplate } from 'src/repositories/email.repository';
import { NotificationAdminService } from 'src/services/notification-admin.service';
@ApiTags('Notifications (Admin)')
@ApiTags(ApiTag.NotificationsAdmin)
@Controller('admin/notifications')
export class NotificationAdminController {
constructor(private service: NotificationAdminService) {}
@Post()
@Authenticated({ admin: true })
@ApiOperation({
summary: 'Create a notification',
description: 'Create a new notification for a specific user.',
})
createNotification(@Auth() auth: AuthDto, @Body() dto: NotificationCreateDto): Promise<NotificationDto> {
return this.service.create(auth, dto);
}
@ -27,6 +32,10 @@ export class NotificationAdminController {
@Post('test-email')
@Authenticated({ admin: true })
@HttpCode(HttpStatus.OK)
@ApiOperation({
summary: 'Send test email',
description: 'Send a test email using the provided SMTP configuration.',
})
sendTestEmailAdmin(@Auth() auth: AuthDto, @Body() dto: SystemConfigSmtpDto): Promise<TestEmailResponseDto> {
return this.service.sendTestEmail(auth.user.id, dto);
}
@ -34,6 +43,10 @@ export class NotificationAdminController {
@Post('templates/:name')
@Authenticated({ admin: true })
@HttpCode(HttpStatus.OK)
@ApiOperation({
summary: 'Render email template',
description: 'Retrieve a preview of the provided email template.',
})
getNotificationTemplateAdmin(
@Auth() auth: AuthDto,
@Param('name') name: EmailTemplate,

30
server/src/controllers/notification.controller.ts
View file

@ -1,5 +1,5 @@
import { Body, Controller, Delete, Get, HttpCode, HttpStatus, Param, Put, Query } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import { AuthDto } from 'src/dtos/auth.dto';
import {
NotificationDeleteAllDto,
@ -8,18 +8,22 @@ import {
NotificationUpdateAllDto,
NotificationUpdateDto,
} from 'src/dtos/notification.dto';
import { Permission } from 'src/enum';
import { ApiTag, Permission } from 'src/enum';
import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { NotificationService } from 'src/services/notification.service';
import { UUIDParamDto } from 'src/validation';
@ApiTags('Notifications')
@ApiTags(ApiTag.Notifications)
@Controller('notifications')
export class NotificationController {
constructor(private service: NotificationService) {}
@Get()
@Authenticated({ permission: Permission.NotificationRead })
@ApiOperation({
summary: 'Retrieve notifications',
description: 'Retrieve a list of notifications.',
})
getNotifications(@Auth() auth: AuthDto, @Query() dto: NotificationSearchDto): Promise<NotificationDto[]> {
return this.service.search(auth, dto);
}
@ -27,6 +31,10 @@ export class NotificationController {
@Put()
@Authenticated({ permission: Permission.NotificationUpdate })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Update notifications',
description: 'Update a list of notifications. Allows to bulk-set the read status of notifications.',
})
updateNotifications(@Auth() auth: AuthDto, @Body() dto: NotificationUpdateAllDto): Promise<void> {
return this.service.updateAll(auth, dto);
}
@ -34,18 +42,30 @@ export class NotificationController {
@Delete()
@Authenticated({ permission: Permission.NotificationDelete })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Delete notifications',
description: 'Delete a list of notifications at once.',
})
deleteNotifications(@Auth() auth: AuthDto, @Body() dto: NotificationDeleteAllDto): Promise<void> {
return this.service.deleteAll(auth, dto);
}
@Get(':id')
@Authenticated({ permission: Permission.NotificationRead })
@ApiOperation({
summary: 'Get a notification',
description: 'Retrieve a specific notification identified by id.',
})
getNotification(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<NotificationDto> {
return this.service.get(auth, id);
}
@Put(':id')
@Authenticated({ permission: Permission.NotificationUpdate })
@ApiOperation({
summary: 'Update a notification',
description: 'Update a specific notification to set its read status.',
})
updateNotification(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,
@ -57,6 +77,10 @@ export class NotificationController {
@Delete(':id')
@Authenticated({ permission: Permission.NotificationDelete })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Delete a notification',
description: 'Delete a specific notification.',
})
deleteNotification(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<void> {
return this.service.delete(auth, id);
}

27
server/src/controllers/oauth.controller.ts
View file

@ -1,5 +1,5 @@
import { Body, Controller, Get, HttpCode, HttpStatus, Post, Redirect, Req, Res } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import { Request, Response } from 'express';
import {
AuthDto,
@ -9,18 +9,23 @@ import {
OAuthConfigDto,
} from 'src/dtos/auth.dto';
import { UserAdminResponseDto } from 'src/dtos/user.dto';
import { AuthType, ImmichCookie } from 'src/enum';
import { ApiTag, AuthType, ImmichCookie } from 'src/enum';
import { Auth, Authenticated, GetLoginDetails } from 'src/middleware/auth.guard';
import { AuthService, LoginDetails } from 'src/services/auth.service';
import { respondWithCookie } from 'src/utils/response';
@ApiTags('OAuth')
@ApiTags(ApiTag.Authentication)
@Controller('oauth')
export class OAuthController {
constructor(private service: AuthService) {}
@Get('mobile-redirect')
@Redirect()
@ApiOperation({
summary: 'Redirect OAuth to mobile',
description:
'Requests to this URL are automatically forwarded to the mobile app, and is used in some cases for OAuth redirecting.',
})
redirectOAuthToMobile(@Req() request: Request) {
return {
url: this.service.getMobileRedirect(request.url),
@ -29,6 +34,10 @@ export class OAuthController {
}
@Post('authorize')
@ApiOperation({
summary: 'Start OAuth',
description: 'Initiate the OAuth authorization process.',
})
async startOAuth(
@Body() dto: OAuthConfigDto,
@Res({ passthrough: true }) res: Response,
@ -49,6 +58,10 @@ export class OAuthController {
}
@Post('callback')
@ApiOperation({
summary: 'Finish OAuth',
description: 'Complete the OAuth authorization process by exchanging the authorization code for a session token.',
})
async finishOAuth(
@Req() request: Request,
@Res({ passthrough: true }) res: Response,
@ -71,6 +84,10 @@ export class OAuthController {
@Post('link')
@Authenticated()
@HttpCode(HttpStatus.OK)
@ApiOperation({
summary: 'Link OAuth account',
description: 'Link an OAuth account to the authenticated user.',
})
linkOAuthAccount(
@Req() request: Request,
@Auth() auth: AuthDto,
@ -82,6 +99,10 @@ export class OAuthController {
@Post('unlink')
@Authenticated()
@HttpCode(HttpStatus.OK)
@ApiOperation({
summary: 'Unlink OAuth account',
description: 'Unlink the OAuth account from the authenticated user.',
})
unlinkOAuthAccount(@Auth() auth: AuthDto): Promise<UserAdminResponseDto> {
return this.service.unlink(auth);
}

28
server/src/controllers/partner.controller.ts
View file

@ -1,32 +1,44 @@
import { Body, Controller, Delete, Get, HttpCode, HttpStatus, Param, Post, Put, Query } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import { EndpointLifecycle } from 'src/decorators';
import { AuthDto } from 'src/dtos/auth.dto';
import { PartnerCreateDto, PartnerResponseDto, PartnerSearchDto, PartnerUpdateDto } from 'src/dtos/partner.dto';
import { Permission } from 'src/enum';
import { ApiTag, Permission } from 'src/enum';
import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { PartnerService } from 'src/services/partner.service';
import { UUIDParamDto } from 'src/validation';
@ApiTags('Partners')
@ApiTags(ApiTag.Partners)
@Controller('partners')
export class PartnerController {
constructor(private service: PartnerService) {}
@Get()
@Authenticated({ permission: Permission.PartnerRead })
@ApiOperation({
summary: 'Retrieve partners',
description: 'Retrieve a list of partners with whom assets are shared.',
})
getPartners(@Auth() auth: AuthDto, @Query() dto: PartnerSearchDto): Promise<PartnerResponseDto[]> {
return this.service.search(auth, dto);
}
@Post()
@Authenticated({ permission: Permission.PartnerCreate })
@ApiOperation({
summary: 'Create a partner',
description: 'Create a new partner to share assets with.',
})
createPartner(@Auth() auth: AuthDto, @Body() dto: PartnerCreateDto): Promise<PartnerResponseDto> {
return this.service.create(auth, dto);
}
@Post(':id')
@EndpointLifecycle({ deprecatedAt: 'v1.141.0' })
@EndpointLifecycle({
deprecatedAt: 'v1.141.0',
summary: 'Create a partner',
description: 'Create a new partner to share assets with.',
})
@Authenticated({ permission: Permission.PartnerCreate })
createPartnerDeprecated(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<PartnerResponseDto> {
return this.service.create(auth, { sharedWithId: id });
@ -34,6 +46,10 @@ export class PartnerController {
@Put(':id')
@Authenticated({ permission: Permission.PartnerUpdate })
@ApiOperation({
summary: 'Update a partner',
description: "Specify whether a partner's assets should appear in the user's timeline.",
})
updatePartner(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,
@ -45,6 +61,10 @@ export class PartnerController {
@Delete(':id')
@Authenticated({ permission: Permission.PartnerDelete })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Remove a partner',
description: 'Stop sharing assets with a partner.',
})
removePartner(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<void> {
return this.service.remove(auth, id);
}

23
server/src/controllers/person.controller.ts
View file

@ -12,7 +12,7 @@ import {
Query,
Res,
} from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import { NextFunction, Response } from 'express';
import { BulkIdResponseDto, BulkIdsDto } from 'src/dtos/asset-ids.response.dto';
import { AuthDto } from 'src/dtos/auth.dto';
@ -27,14 +27,14 @@ import {
PersonStatisticsResponseDto,
PersonUpdateDto,
} from 'src/dtos/person.dto';
import { Permission } from 'src/enum';
import { ApiTag, Permission } from 'src/enum';
import { Auth, Authenticated, FileResponse } from 'src/middleware/auth.guard';
import { LoggingRepository } from 'src/repositories/logging.repository';
import { PersonService } from 'src/services/person.service';
import { sendFile } from 'src/utils/file';
import { UUIDParamDto } from 'src/validation';
@ApiTags('People')
@ApiTags(ApiTag.People)
@Controller('people')
export class PersonController {
constructor(
@ -46,18 +46,24 @@ export class PersonController {
@Get()
@Authenticated({ permission: Permission.PersonRead })
@ApiOperation({ summary: 'Get all people', description: 'Retrieve a list of all people.' })
getAllPeople(@Auth() auth: AuthDto, @Query() options: PersonSearchDto): Promise<PeopleResponseDto> {
return this.service.getAll(auth, options);
}
@Post()
@Authenticated({ permission: Permission.PersonCreate })
@ApiOperation({
summary: 'Create a person',
description: 'Create a new person that can have multiple faces assigned to them.',
})
createPerson(@Auth() auth: AuthDto, @Body() dto: PersonCreateDto): Promise<PersonResponseDto> {
return this.service.create(auth, dto);
}
@Put()
@Authenticated({ permission: Permission.PersonUpdate })
@ApiOperation({ summary: 'Update people', description: 'Bulk update multiple people at once.' })
updatePeople(@Auth() auth: AuthDto, @Body() dto: PeopleUpdateDto): Promise<BulkIdResponseDto[]> {
return this.service.updateAll(auth, dto);
}
@ -65,18 +71,21 @@ export class PersonController {
@Delete()
@Authenticated({ permission: Permission.PersonDelete })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({ summary: 'Delete people', description: 'Bulk delete a list of people at once.' })
deletePeople(@Auth() auth: AuthDto, @Body() dto: BulkIdsDto): Promise<void> {
return this.service.deleteAll(auth, dto);
}
@Get(':id')
@Authenticated({ permission: Permission.PersonRead })
@ApiOperation({ summary: 'Get a person', description: 'Retrieve a person by id.' })
getPerson(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<PersonResponseDto> {
return this.service.getById(auth, id);
}
@Put(':id')
@Authenticated({ permission: Permission.PersonUpdate })
@ApiOperation({ summary: 'Update person', description: 'Update an individual person.' })
updatePerson(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,
@ -88,12 +97,14 @@ export class PersonController {
@Delete(':id')
@Authenticated({ permission: Permission.PersonDelete })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({ summary: 'Delete person', description: 'Delete an individual person.' })
deletePerson(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<void> {
return this.service.delete(auth, id);
}
@Get(':id/statistics')
@Authenticated({ permission: Permission.PersonStatistics })
@ApiOperation({ summary: 'Get person statistics', description: 'Retrieve statistics about a specific person.' })
getPersonStatistics(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<PersonStatisticsResponseDto> {
return this.service.getStatistics(auth, id);
}
@ -101,6 +112,7 @@ export class PersonController {
@Get(':id/thumbnail')
@FileResponse()
@Authenticated({ permission: Permission.PersonRead })
@ApiOperation({ summary: 'Get person thumbnail', description: 'Retrieve the thumbnail file for a person.' })
async getPersonThumbnail(
@Res() res: Response,
@Next() next: NextFunction,
@ -112,6 +124,7 @@ export class PersonController {
@Put(':id/reassign')
@Authenticated({ permission: Permission.PersonReassign })
@ApiOperation({ summary: 'Reassign faces', description: 'Bulk reassign a list of faces to a different person.' })
reassignFaces(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,
@ -123,6 +136,10 @@ export class PersonController {
@Post(':id/merge')
@Authenticated({ permission: Permission.PersonMerge })
@HttpCode(HttpStatus.OK)
@ApiOperation({
summary: 'Merge people',
description: 'Merge a list of people into the person specified in the path parameter.',
})
mergePerson(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,

48
server/src/controllers/search.controller.ts
View file

@ -1,5 +1,5 @@
import { Body, Controller, Get, HttpCode, HttpStatus, Post, Query } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import { AssetResponseDto } from 'src/dtos/asset-response.dto';
import { AuthDto } from 'src/dtos/auth.dto';
import { PersonResponseDto } from 'src/dtos/person.dto';
@ -17,11 +17,11 @@ import {
SmartSearchDto,
StatisticsSearchDto,
} from 'src/dtos/search.dto';
import { Permission } from 'src/enum';
import { ApiTag, Permission } from 'src/enum';
import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { SearchService } from 'src/services/search.service';
@ApiTags('Search')
@ApiTags(ApiTag.Search)
@Controller('search')
export class SearchController {
constructor(private service: SearchService) {}
@ -29,6 +29,10 @@ export class SearchController {
@Post('metadata')
@Authenticated({ permission: Permission.AssetRead })
@HttpCode(HttpStatus.OK)
@ApiOperation({
summary: 'Search assets by metadata',
description: 'Search for assets based on various metadata criteria.',
})
searchAssets(@Auth() auth: AuthDto, @Body() dto: MetadataSearchDto): Promise<SearchResponseDto> {
return this.service.searchMetadata(auth, dto);
}
@ -36,6 +40,10 @@ export class SearchController {
@Post('statistics')
@Authenticated({ permission: Permission.AssetStatistics })
@HttpCode(HttpStatus.OK)
@ApiOperation({
summary: 'Search asset statistics',
description: 'Retrieve statistical data about assets based on search criteria, such as the total matching count.',
})
searchAssetStatistics(@Auth() auth: AuthDto, @Body() dto: StatisticsSearchDto): Promise<SearchStatisticsResponseDto> {
return this.service.searchStatistics(auth, dto);
}
@ -43,6 +51,10 @@ export class SearchController {
@Post('random')
@Authenticated({ permission: Permission.AssetRead })
@HttpCode(HttpStatus.OK)
@ApiOperation({
summary: 'Search random assets',
description: 'Retrieve a random selection of assets based on the provided criteria.',
})
searchRandom(@Auth() auth: AuthDto, @Body() dto: RandomSearchDto): Promise<AssetResponseDto[]> {
return this.service.searchRandom(auth, dto);
}
@ -50,6 +62,10 @@ export class SearchController {
@Post('large-assets')
@Authenticated({ permission: Permission.AssetRead })
@HttpCode(HttpStatus.OK)
@ApiOperation({
summary: 'Search large assets',
description: 'Search for assets that are considered large based on specified criteria.',
})
searchLargeAssets(@Auth() auth: AuthDto, @Query() dto: LargeAssetSearchDto): Promise<AssetResponseDto[]> {
return this.service.searchLargeAssets(auth, dto);
}
@ -57,36 +73,62 @@ export class SearchController {
@Post('smart')
@Authenticated({ permission: Permission.AssetRead })
@HttpCode(HttpStatus.OK)
@ApiOperation({
summary: 'Smart asset search',
description: 'Perform a smart search for assets by using machine learning vectors to determine relevance.',
})
searchSmart(@Auth() auth: AuthDto, @Body() dto: SmartSearchDto): Promise<SearchResponseDto> {
return this.service.searchSmart(auth, dto);
}
@Get('explore')
@Authenticated({ permission: Permission.AssetRead })
@ApiOperation({
summary: 'Retrieve explore data',
description: 'Retrieve data for the explore section, such as popular people and places.',
})
getExploreData(@Auth() auth: AuthDto): Promise<SearchExploreResponseDto[]> {
return this.service.getExploreData(auth);
}
@Get('person')
@Authenticated({ permission: Permission.PersonRead })
@ApiOperation({
summary: 'Search people',
description: 'Search for people by name.',
})
searchPerson(@Auth() auth: AuthDto, @Query() dto: SearchPeopleDto): Promise<PersonResponseDto[]> {
return this.service.searchPerson(auth, dto);
}
@Get('places')
@Authenticated({ permission: Permission.AssetRead })
@ApiOperation({
summary: 'Search places',
description: 'Search for places by name.',
})
searchPlaces(@Query() dto: SearchPlacesDto): Promise<PlacesResponseDto[]> {
return this.service.searchPlaces(dto);
}
@Get('cities')
@Authenticated({ permission: Permission.AssetRead })
@ApiOperation({
summary: 'Retrieve assets by city',
description:
'Retrieve a list of assets with each asset belonging to a different city. This endpoint is used on the places pages to show a single thumbnail for each city the user has assets in.',
})
getAssetsByCity(@Auth() auth: AuthDto): Promise<AssetResponseDto[]> {
return this.service.getAssetsByCity(auth);
}
@Get('suggestions')
@Authenticated({ permission: Permission.AssetRead })
@ApiOperation({
summary: 'Retrieve search suggestions',
description:
'Retrieve search suggestions based on partial input. This endpoint is used for typeahead search features.',
})
getSearchSuggestions(@Auth() auth: AuthDto, @Query() dto: SearchSuggestionRequestDto): Promise<string[]> {
// TODO fix open api generation to indicate that results can be nullable
return this.service.getSearchSuggestions(auth, dto) as Promise<string[]>;

45
server/src/controllers/server.controller.ts
View file

@ -1,5 +1,5 @@
import { Body, Controller, Delete, Get, HttpCode, HttpStatus, Put } from '@nestjs/common';
import { ApiNotFoundResponse, ApiTags } from '@nestjs/swagger';
import { ApiNotFoundResponse, ApiOperation, ApiTags } from '@nestjs/swagger';
import { LicenseKeyDto, LicenseResponseDto } from 'src/dtos/license.dto';
import {
ServerAboutResponseDto,
@ -15,13 +15,13 @@ import {
ServerVersionResponseDto,
} from 'src/dtos/server.dto';
import { VersionCheckStateResponseDto } from 'src/dtos/system-metadata.dto';
import { Permission } from 'src/enum';
import { ApiTag, Permission } from 'src/enum';
import { Authenticated } from 'src/middleware/auth.guard';
import { ServerService } from 'src/services/server.service';
import { SystemMetadataService } from 'src/services/system-metadata.service';
import { VersionService } from 'src/services/version.service';
@ApiTags('Server')
@ApiTags(ApiTag.Server)
@Controller('server')
export class ServerController {
constructor(
@ -32,59 +32,85 @@ export class ServerController {
@Get('about')
@Authenticated({ permission: Permission.ServerAbout })
@ApiOperation({ summary: 'Get server information', description: 'Retrieve a list of information about the server.' })
getAboutInfo(): Promise<ServerAboutResponseDto> {
return this.service.getAboutInfo();
}
@Get('apk-links')
@Authenticated({ permission: Permission.ServerApkLinks })
@ApiOperation({ summary: 'Get APK links', description: 'Retrieve links to the APKs for the current server version.' })
getApkLinks(): ServerApkLinksDto {
return this.service.getApkLinks();
}
@Get('storage')
@Authenticated({ permission: Permission.ServerStorage })
@ApiOperation({
summary: 'Get storage',
description: 'Retrieve the current storage utilization information of the server.',
})
getStorage(): Promise<ServerStorageResponseDto> {
return this.service.getStorage();
}
@Get('ping')
@ApiOperation({ summary: 'Ping', description: 'Pong' })
pingServer(): ServerPingResponse {
return this.service.ping();
}
@Get('version')
@ApiOperation({
summary: 'Get server version',
description: 'Retrieve the current server version in semantic versioning (semver) format.',
})
getServerVersion(): ServerVersionResponseDto {
return this.versionService.getVersion();
}
@Get('version-history')
@ApiOperation({
summary: 'Get version history',
description: 'Retrieve a list of past versions the server has been on.',
})
getVersionHistory(): Promise<ServerVersionHistoryResponseDto[]> {
return this.versionService.getVersionHistory();
}
@Get('features')
@ApiOperation({ summary: 'Get features', description: 'Retrieve available features supported by this server.' })
getServerFeatures(): Promise<ServerFeaturesDto> {
return this.service.getFeatures();
}
@Get('theme')
@ApiOperation({ summary: 'Get theme', description: 'Retrieve the custom CSS, if existent.' })
getTheme(): Promise<ServerThemeDto> {
return this.service.getTheme();
}
@Get('config')
@ApiOperation({ summary: 'Get config', description: 'Retrieve the current server configuration.' })
getServerConfig(): Promise<ServerConfigDto> {
return this.service.getSystemConfig();
}
@Get('statistics')
@Authenticated({ permission: Permission.ServerStatistics, admin: true })
@ApiOperation({
summary: 'Get statistics',
description: 'Retrieve statistics about the entire Immich instance such as asset counts.',
})
getServerStatistics(): Promise<ServerStatsResponseDto> {
return this.service.getStatistics();
}
@Get('media-types')
@ApiOperation({
summary: 'Get supported media types',
description: 'Retrieve all media types supported by the server.',
})
getSupportedMediaTypes(): ServerMediaTypesResponseDto {
return this.service.getSupportedMediaTypes();
}
@ -92,12 +118,20 @@ export class ServerController {
@Get('license')
@Authenticated({ permission: Permission.ServerLicenseRead, admin: true })
@ApiNotFoundResponse()
@ApiOperation({
summary: 'Get product key',
description: 'Retrieve information about whether the server currently has a product key registered.',
})
getServerLicense(): Promise<LicenseResponseDto> {
return this.service.getLicense();
}
@Put('license')
@Authenticated({ permission: Permission.ServerLicenseUpdate, admin: true })
@ApiOperation({
summary: 'Set server product key',
description: 'Validate and set the server product key if successful.',
})
setServerLicense(@Body() license: LicenseKeyDto): Promise<LicenseResponseDto> {
return this.service.setLicense(license);
}
@ -105,12 +139,17 @@ export class ServerController {
@Delete('license')
@Authenticated({ permission: Permission.ServerLicenseDelete, admin: true })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({ summary: 'Delete server product key', description: 'Delete the currently set server product key.' })
deleteServerLicense(): Promise<void> {
return this.service.deleteLicense();
}
@Get('version-check')
@Authenticated({ permission: Permission.ServerVersionCheck })
@ApiOperation({
summary: 'Get version check status',
description: 'Retrieve information about the last time the version check ran.',
})
getVersionCheck(): Promise<VersionCheckStateResponseDto> {
return this.systemMetadataService.getVersionCheckState();
}

30
server/src/controllers/session.controller.ts
View file

@ -1,25 +1,33 @@
import { Body, Controller, Delete, Get, HttpCode, HttpStatus, Param, Post, Put } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import { AuthDto } from 'src/dtos/auth.dto';
import { SessionCreateDto, SessionCreateResponseDto, SessionResponseDto, SessionUpdateDto } from 'src/dtos/session.dto';
import { Permission } from 'src/enum';
import { ApiTag, Permission } from 'src/enum';
import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { SessionService } from 'src/services/session.service';
import { UUIDParamDto } from 'src/validation';
@ApiTags('Sessions')
@ApiTags(ApiTag.Sessions)
@Controller('sessions')
export class SessionController {
constructor(private service: SessionService) {}
@Post()
@Authenticated({ permission: Permission.SessionCreate })
@ApiOperation({
summary: 'Create a session',
description: 'Create a session as a child to the current session. This endpoint is used for casting.',
})
createSession(@Auth() auth: AuthDto, @Body() dto: SessionCreateDto): Promise<SessionCreateResponseDto> {
return this.service.create(auth, dto);
}
@Get()
@Authenticated({ permission: Permission.SessionRead })
@ApiOperation({
summary: 'Retrieve sessions',
description: 'Retrieve a list of sessions for the user.',
})
getSessions(@Auth() auth: AuthDto): Promise<SessionResponseDto[]> {
return this.service.getAll(auth);
}
@ -27,12 +35,20 @@ export class SessionController {
@Delete()
@Authenticated({ permission: Permission.SessionDelete })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Delete all sessions',
description: 'Delete all sessions for the user. This will not delete the current session.',
})
deleteAllSessions(@Auth() auth: AuthDto): Promise<void> {
return this.service.deleteAll(auth);
}
@Put(':id')
@Authenticated({ permission: Permission.SessionUpdate })
@ApiOperation({
summary: 'Update a session',
description: 'Update a specific session identified by id.',
})
updateSession(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,
@ -44,6 +60,10 @@ export class SessionController {
@Delete(':id')
@Authenticated({ permission: Permission.SessionDelete })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Delete a session',
description: 'Delete a specific session by id.',
})
deleteSession(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<void> {
return this.service.delete(auth, id);
}
@ -51,6 +71,10 @@ export class SessionController {
@Post(':id/lock')
@Authenticated({ permission: Permission.SessionLock })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Lock a session',
description: 'Lock a specific session by id.',
})
lockSession(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<void> {
return this.service.lock(auth, id);
}

40
server/src/controllers/shared-link.controller.ts
View file

@ -13,7 +13,7 @@ import {
Req,
Res,
} from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import { Request, Response } from 'express';
import { AssetIdsResponseDto } from 'src/dtos/asset-ids.response.dto';
import { AssetIdsDto } from 'src/dtos/asset.dto';
@ -25,26 +25,34 @@ import {
SharedLinkResponseDto,
SharedLinkSearchDto,
} from 'src/dtos/shared-link.dto';
import { ImmichCookie, Permission } from 'src/enum';
import { ApiTag, ImmichCookie, Permission } from 'src/enum';
import { Auth, Authenticated, GetLoginDetails } from 'src/middleware/auth.guard';
import { LoginDetails } from 'src/services/auth.service';
import { SharedLinkService } from 'src/services/shared-link.service';
import { respondWithCookie } from 'src/utils/response';
import { UUIDParamDto } from 'src/validation';
@ApiTags('Shared Links')
@ApiTags(ApiTag.SharedLinks)
@Controller('shared-links')
export class SharedLinkController {
constructor(private service: SharedLinkService) {}
@Get()
@Authenticated({ permission: Permission.SharedLinkRead })
@ApiOperation({
summary: 'Retrieve all shared links',
description: 'Retrieve a list of all shared links.',
})
getAllSharedLinks(@Auth() auth: AuthDto, @Query() dto: SharedLinkSearchDto): Promise<SharedLinkResponseDto[]> {
return this.service.getAll(auth, dto);
}
@Get('me')
@Authenticated({ sharedLink: true })
@ApiOperation({
summary: 'Retrieve current shared link',
description: 'Retrieve the current shared link associated with authentication method.',
})
async getMySharedLink(
@Auth() auth: AuthDto,
@Query() dto: SharedLinkPasswordDto,
@ -65,18 +73,30 @@ export class SharedLinkController {
@Get(':id')
@Authenticated({ permission: Permission.SharedLinkRead })
@ApiOperation({
summary: 'Retrieve a shared link',
description: 'Retrieve a specific shared link by its ID.',
})
getSharedLinkById(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<SharedLinkResponseDto> {
return this.service.get(auth, id);
}
@Post()
@Authenticated({ permission: Permission.SharedLinkCreate })
@ApiOperation({
summary: 'Create a shared link',
description: 'Create a new shared link.',
})
createSharedLink(@Auth() auth: AuthDto, @Body() dto: SharedLinkCreateDto) {
return this.service.create(auth, dto);
}
@Patch(':id')
@Authenticated({ permission: Permission.SharedLinkUpdate })
@ApiOperation({
summary: 'Update a shared link',
description: 'Update an existing shared link by its ID.',
})
updateSharedLink(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,
@ -88,12 +108,21 @@ export class SharedLinkController {
@Delete(':id')
@Authenticated({ permission: Permission.SharedLinkDelete })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Delete a shared link',
description: 'Delete a specific shared link by its ID.',
})
removeSharedLink(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<void> {
return this.service.remove(auth, id);
}
@Put(':id/assets')
@Authenticated({ sharedLink: true })
@ApiOperation({
summary: 'Add assets to a shared link',
description:
'Add assets to a specific shared link by its ID. This endpoint is only relevant for shared link of type individual.',
})
addSharedLinkAssets(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,
@ -104,6 +133,11 @@ export class SharedLinkController {
@Delete(':id/assets')
@Authenticated({ sharedLink: true })
@ApiOperation({
summary: 'Remove assets from a shared link',
description:
'Remove assets from a specific shared link by its ID. This endpoint is only relevant for shared link of type individual.',
})
removeSharedLinkAssets(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,

35
server/src/controllers/stack.controller.ts
View file

@ -1,26 +1,35 @@
import { Body, Controller, Delete, Get, HttpCode, HttpStatus, Param, Post, Put, Query } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import { BulkIdsDto } from 'src/dtos/asset-ids.response.dto';
import { AuthDto } from 'src/dtos/auth.dto';
import { StackCreateDto, StackResponseDto, StackSearchDto, StackUpdateDto } from 'src/dtos/stack.dto';
import { Permission } from 'src/enum';
import { ApiTag, Permission } from 'src/enum';
import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { StackService } from 'src/services/stack.service';
import { UUIDAssetIDParamDto, UUIDParamDto } from 'src/validation';
@ApiTags('Stacks')
@ApiTags(ApiTag.Stacks)
@Controller('stacks')
export class StackController {
constructor(private service: StackService) {}
@Get()
@Authenticated({ permission: Permission.StackRead })
@ApiOperation({
summary: 'Retrieve stacks',
description: 'Retrieve a list of stacks.',
})
searchStacks(@Auth() auth: AuthDto, @Query() query: StackSearchDto): Promise<StackResponseDto[]> {
return this.service.search(auth, query);
}
@Post()
@Authenticated({ permission: Permission.StackCreate })
@ApiOperation({
summary: 'Create a stack',
description:
'Create a new stack by providing a name and a list of asset IDs to include in the stack. If any of the provided asset IDs are primary assets of an existing stack, the existing stack will be merged into the newly created stack.',
})
createStack(@Auth() auth: AuthDto, @Body() dto: StackCreateDto): Promise<StackResponseDto> {
return this.service.create(auth, dto);
}
@ -28,18 +37,30 @@ export class StackController {
@Delete()
@Authenticated({ permission: Permission.StackDelete })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Delete stacks',
description: 'Delete multiple stacks by providing a list of stack IDs.',
})
deleteStacks(@Auth() auth: AuthDto, @Body() dto: BulkIdsDto): Promise<void> {
return this.service.deleteAll(auth, dto);
}
@Get(':id')
@Authenticated({ permission: Permission.StackRead })
@ApiOperation({
summary: 'Retrieve a stack',
description: 'Retrieve a specific stack by its ID.',
})
getStack(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<StackResponseDto> {
return this.service.get(auth, id);
}
@Put(':id')
@Authenticated({ permission: Permission.StackUpdate })
@ApiOperation({
summary: 'Update a stack',
description: 'Update an existing stack by its ID.',
})
updateStack(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,
@ -51,6 +72,10 @@ export class StackController {
@Delete(':id')
@Authenticated({ permission: Permission.StackDelete })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Delete a stack',
description: 'Delete a specific stack by its ID.',
})
deleteStack(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<void> {
return this.service.delete(auth, id);
}
@ -58,6 +83,10 @@ export class StackController {
@Delete(':id/assets/:assetId')
@Authenticated({ permission: Permission.StackUpdate })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Remove an asset from a stack',
description: 'Remove a specific asset from a stack by providing the stack ID and asset ID.',
})
removeAssetFromStack(@Auth() auth: AuthDto, @Param() dto: UUIDAssetIDParamDto): Promise<void> {
return this.service.removeAsset(auth, dto);
}

35
server/src/controllers/sync.controller.ts
View file

@ -1,6 +1,7 @@
import { Body, Controller, Delete, Get, Header, HttpCode, HttpStatus, Post, Res } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import { Response } from 'express';
import { EndpointLifecycle } from 'src/decorators';
import { AssetResponseDto } from 'src/dtos/asset-response.dto';
import { AuthDto } from 'src/dtos/auth.dto';
import {
@ -12,12 +13,12 @@ import {
SyncAckSetDto,
SyncStreamDto,
} from 'src/dtos/sync.dto';
import { Permission } from 'src/enum';
import { ApiTag, Permission } from 'src/enum';
import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { GlobalExceptionFilter } from 'src/middleware/global-exception.filter';
import { SyncService } from 'src/services/sync.service';
@ApiTags('Sync')
@ApiTags(ApiTag.Sync)
@Controller('sync')
export class SyncController {
constructor(
@ -28,6 +29,11 @@ export class SyncController {
@Post('full-sync')
@Authenticated()
@HttpCode(HttpStatus.OK)
@EndpointLifecycle({
deprecatedAt: 'v2.0.0',
summary: 'Get full sync for user',
description: 'Retrieve all assets for a full synchronization for the authenticated user.',
})
getFullSyncForUser(@Auth() auth: AuthDto, @Body() dto: AssetFullSyncDto): Promise<AssetResponseDto[]> {
return this.service.getFullSync(auth, dto);
}
@ -35,6 +41,11 @@ export class SyncController {
@Post('delta-sync')
@Authenticated()
@HttpCode(HttpStatus.OK)
@EndpointLifecycle({
deprecatedAt: 'v2.0.0',
summary: 'Get delta sync for user',
description: 'Retrieve changed assets since the last sync for the authenticated user.',
})
getDeltaSync(@Auth() auth: AuthDto, @Body() dto: AssetDeltaSyncDto): Promise<AssetDeltaSyncResponseDto> {
return this.service.getDeltaSync(auth, dto);
}
@ -43,6 +54,11 @@ export class SyncController {
@Authenticated({ permission: Permission.SyncStream })
@Header('Content-Type', 'application/jsonlines+json')
@HttpCode(HttpStatus.OK)
@ApiOperation({
summary: 'Stream sync changes',
description:
'Retrieve a JSON lines streamed response of changes for synchronization. This endpoint is used by the mobile app to efficiently stay up to date with changes.',
})
async getSyncStream(@Auth() auth: AuthDto, @Res() res: Response, @Body() dto: SyncStreamDto) {
try {
await this.service.stream(auth, res, dto);
@ -54,6 +70,10 @@ export class SyncController {
@Get('ack')
@Authenticated({ permission: Permission.SyncCheckpointRead })
@ApiOperation({
summary: 'Retrieve acknowledgements',
description: 'Retrieve the synchronization acknowledgments for the current session.',
})
getSyncAck(@Auth() auth: AuthDto): Promise<SyncAckDto[]> {
return this.service.getAcks(auth);
}
@ -61,6 +81,11 @@ export class SyncController {
@Post('ack')
@Authenticated({ permission: Permission.SyncCheckpointUpdate })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Acknowledge changes',
description:
'Send a list of synchronization acknowledgements to confirm that the latest changes have been received.',
})
sendSyncAck(@Auth() auth: AuthDto, @Body() dto: SyncAckSetDto) {
return this.service.setAcks(auth, dto);
}
@ -68,6 +93,10 @@ export class SyncController {
@Delete('ack')
@Authenticated({ permission: Permission.SyncCheckpointDelete })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Delete acknowledgements',
description: 'Delete specific synchronization acknowledgments.',
})
deleteSyncAck(@Auth() auth: AuthDto, @Body() dto: SyncAckDeleteDto): Promise<void> {
return this.service.deleteAcks(auth, dto);
}

19
server/src/controllers/system-config.controller.ts
View file

@ -1,12 +1,12 @@
import { Body, Controller, Get, Put } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import { SystemConfigDto, SystemConfigTemplateStorageOptionDto } from 'src/dtos/system-config.dto';
import { Permission } from 'src/enum';
import { ApiTag, Permission } from 'src/enum';
import { Authenticated } from 'src/middleware/auth.guard';
import { StorageTemplateService } from 'src/services/storage-template.service';
import { SystemConfigService } from 'src/services/system-config.service';
@ApiTags('System Config')
@ApiTags(ApiTag.SystemConfig)
@Controller('system-config')
export class SystemConfigController {
constructor(
@ -16,24 +16,37 @@ export class SystemConfigController {
@Get()
@Authenticated({ permission: Permission.SystemConfigRead, admin: true })
@ApiOperation({ summary: 'Get system configuration', description: 'Retrieve the current system configuration.' })
getConfig(): Promise<SystemConfigDto> {
return this.service.getSystemConfig();
}
@Get('defaults')
@Authenticated({ permission: Permission.SystemConfigRead, admin: true })
@ApiOperation({
summary: 'Get system configuration defaults',
description: 'Retrieve the default values for the system configuration.',
})
getConfigDefaults(): SystemConfigDto {
return this.service.getDefaults();
}
@Put()
@Authenticated({ permission: Permission.SystemConfigUpdate, admin: true })
@ApiOperation({
summary: 'Update system configuration',
description: 'Update the system configuration with a new system configuration.',
})
updateConfig(@Body() dto: SystemConfigDto): Promise<SystemConfigDto> {
return this.service.updateSystemConfig(dto);
}
@Get('storage-template-options')
@Authenticated({ permission: Permission.SystemConfigRead, admin: true })
@ApiOperation({
summary: 'Get storage template options',
description: 'Retrieve exemplary storage template options.',
})
getStorageTemplateOptions(): SystemConfigTemplateStorageOptionDto {
return this.storageTemplateService.getStorageTemplateOptions();
}

22
server/src/controllers/system-metadata.controller.ts
View file

@ -1,21 +1,25 @@
import { Body, Controller, Get, HttpCode, HttpStatus, Post } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import {
AdminOnboardingUpdateDto,
ReverseGeocodingStateResponseDto,
VersionCheckStateResponseDto,
} from 'src/dtos/system-metadata.dto';
import { Permission } from 'src/enum';
import { ApiTag, Permission } from 'src/enum';
import { Authenticated } from 'src/middleware/auth.guard';
import { SystemMetadataService } from 'src/services/system-metadata.service';
@ApiTags('System Metadata')
@ApiTags(ApiTag.SystemMetadata)
@Controller('system-metadata')
export class SystemMetadataController {
constructor(private service: SystemMetadataService) {}
@Get('admin-onboarding')
@Authenticated({ permission: Permission.SystemMetadataRead, admin: true })
@ApiOperation({
summary: 'Retrieve admin onboarding',
description: 'Retrieve the current admin onboarding status.',
})
getAdminOnboarding(): Promise<AdminOnboardingUpdateDto> {
return this.service.getAdminOnboarding();
}
@ -23,18 +27,30 @@ export class SystemMetadataController {
@Post('admin-onboarding')
@Authenticated({ permission: Permission.SystemMetadataUpdate, admin: true })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Update admin onboarding',
description: 'Update the admin onboarding status.',
})
updateAdminOnboarding(@Body() dto: AdminOnboardingUpdateDto): Promise<void> {
return this.service.updateAdminOnboarding(dto);
}
@Get('reverse-geocoding-state')
@Authenticated({ permission: Permission.SystemMetadataRead, admin: true })
@ApiOperation({
summary: 'Retrieve reverse geocoding state',
description: 'Retrieve the current state of the reverse geocoding import.',
})
getReverseGeocodingState(): Promise<ReverseGeocodingStateResponseDto> {
return this.service.getReverseGeocodingState();
}
@Get('version-check-state')
@Authenticated({ permission: Permission.SystemMetadataRead, admin: true })
@ApiOperation({
summary: 'Retrieve version check state',
description: 'Retrieve the current state of the version check process.',
})
getVersionCheckState(): Promise<VersionCheckStateResponseDto> {
return this.service.getVersionCheckState();
}

42
server/src/controllers/tag.controller.ts
View file

@ -1,5 +1,5 @@
import { Body, Controller, Delete, Get, HttpCode, HttpStatus, Param, Post, Put } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import { BulkIdResponseDto, BulkIdsDto } from 'src/dtos/asset-ids.response.dto';
import { AuthDto } from 'src/dtos/auth.dto';
import {
@ -10,48 +10,72 @@ import {
TagUpdateDto,
TagUpsertDto,
} from 'src/dtos/tag.dto';
import { Permission } from 'src/enum';
import { ApiTag, Permission } from 'src/enum';
import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { TagService } from 'src/services/tag.service';
import { UUIDParamDto } from 'src/validation';
@ApiTags('Tags')
@ApiTags(ApiTag.Tags)
@Controller('tags')
export class TagController {
constructor(private service: TagService) {}
@Post()
@Authenticated({ permission: Permission.TagCreate })
@ApiOperation({
summary: 'Create a tag',
description: 'Create a new tag by providing a name and optional color.',
})
createTag(@Auth() auth: AuthDto, @Body() dto: TagCreateDto): Promise<TagResponseDto> {
return this.service.create(auth, dto);
}
@Get()
@Authenticated({ permission: Permission.TagRead })
@ApiOperation({
summary: 'Retrieve tags',
description: 'Retrieve a list of all tags.',
})
getAllTags(@Auth() auth: AuthDto): Promise<TagResponseDto[]> {
return this.service.getAll(auth);
}
@Put()
@Authenticated({ permission: Permission.TagCreate })
@ApiOperation({
summary: 'Upsert tags',
description: 'Create or update multiple tags in a single request.',
})
upsertTags(@Auth() auth: AuthDto, @Body() dto: TagUpsertDto): Promise<TagResponseDto[]> {
return this.service.upsert(auth, dto);
}
@Put('assets')
@Authenticated({ permission: Permission.TagAsset })
@ApiOperation({
summary: 'Tag assets',
description: 'Add multiple tags to multiple assets in a single request.',
})
bulkTagAssets(@Auth() auth: AuthDto, @Body() dto: TagBulkAssetsDto): Promise<TagBulkAssetsResponseDto> {
return this.service.bulkTagAssets(auth, dto);
}
@Get(':id')
@Authenticated({ permission: Permission.TagRead })
@ApiOperation({
summary: 'Retrieve a tag',
description: 'Retrieve a specific tag by its ID.',
})
getTagById(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<TagResponseDto> {
return this.service.get(auth, id);
}
@Put(':id')
@Authenticated({ permission: Permission.TagUpdate })
@ApiOperation({
summary: 'Update a tag',
description: 'Update an existing tag identified by its ID.',
})
updateTag(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto, @Body() dto: TagUpdateDto): Promise<TagResponseDto> {
return this.service.update(auth, id, dto);
}
@ -59,12 +83,20 @@ export class TagController {
@Delete(':id')
@Authenticated({ permission: Permission.TagDelete })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Delete a tag',
description: 'Delete a specific tag by its ID.',
})
deleteTag(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<void> {
return this.service.remove(auth, id);
}
@Put(':id/assets')
@Authenticated({ permission: Permission.TagAsset })
@ApiOperation({
summary: 'Tag assets',
description: 'Add a tag to all the specified assets.',
})
tagAssets(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,
@ -75,6 +107,10 @@ export class TagController {
@Delete(':id/assets')
@Authenticated({ permission: Permission.TagAsset })
@ApiOperation({
summary: 'Untag assets',
description: 'Remove a tag from all the specified assets.',
})
untagAssets(
@Auth() auth: AuthDto,
@Body() dto: BulkIdsDto,

11
server/src/controllers/timeline.controller.ts
View file

@ -1,18 +1,19 @@
import { Controller, Get, Header, Query } from '@nestjs/common';
import { ApiOkResponse, ApiTags } from '@nestjs/swagger';
import { ApiOkResponse, ApiOperation, ApiTags } from '@nestjs/swagger';
import { AuthDto } from 'src/dtos/auth.dto';
import { TimeBucketAssetDto, TimeBucketAssetResponseDto, TimeBucketDto } from 'src/dtos/time-bucket.dto';
import { Permission } from 'src/enum';
import { ApiTag, Permission } from 'src/enum';
import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { TimelineService } from 'src/services/timeline.service';
@ApiTags('Timeline')
@ApiTags(ApiTag.Timeline)
@Controller('timeline')
export class TimelineController {
constructor(private service: TimelineService) {}
@Get('buckets')
@Authenticated({ permission: Permission.AssetRead, sharedLink: true })
@ApiOperation({ summary: 'Get time buckets', description: 'Retrieve a list of all minimal time buckets.' })
getTimeBuckets(@Auth() auth: AuthDto, @Query() dto: TimeBucketDto) {
return this.service.getTimeBuckets(auth, dto);
}
@ -21,6 +22,10 @@ export class TimelineController {
@Authenticated({ permission: Permission.AssetRead, sharedLink: true })
@ApiOkResponse({ type: TimeBucketAssetResponseDto })
@Header('Content-Type', 'application/json')
@ApiOperation({
summary: 'Get time bucket',
description: 'Retrieve a string of all asset ids in a given time bucket.',
})
getTimeBucket(@Auth() auth: AuthDto, @Query() dto: TimeBucketAssetDto) {
return this.service.getTimeBucket(auth, dto);
}

18
server/src/controllers/trash.controller.ts
View file

@ -1,13 +1,13 @@
import { Body, Controller, HttpCode, HttpStatus, Post } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import { BulkIdsDto } from 'src/dtos/asset-ids.response.dto';
import { AuthDto } from 'src/dtos/auth.dto';
import { TrashResponseDto } from 'src/dtos/trash.dto';
import { Permission } from 'src/enum';
import { ApiTag, Permission } from 'src/enum';
import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { TrashService } from 'src/services/trash.service';
@ApiTags('Trash')
@ApiTags(ApiTag.Trash)
@Controller('trash')
export class TrashController {
constructor(private service: TrashService) {}
@ -15,6 +15,10 @@ export class TrashController {
@Post('empty')
@Authenticated({ permission: Permission.AssetDelete })
@HttpCode(HttpStatus.OK)
@ApiOperation({
summary: 'Empty trash',
description: 'Permanently delete all items in the trash.',
})
emptyTrash(@Auth() auth: AuthDto): Promise<TrashResponseDto> {
return this.service.empty(auth);
}
@ -22,6 +26,10 @@ export class TrashController {
@Post('restore')
@Authenticated({ permission: Permission.AssetDelete })
@HttpCode(HttpStatus.OK)
@ApiOperation({
summary: 'Restore trash',
description: 'Restore all items in the trash.',
})
restoreTrash(@Auth() auth: AuthDto): Promise<TrashResponseDto> {
return this.service.restore(auth);
}
@ -29,6 +37,10 @@ export class TrashController {
@Post('restore/assets')
@Authenticated({ permission: Permission.AssetDelete })
@HttpCode(HttpStatus.OK)
@ApiOperation({
summary: 'Restore assets',
description: 'Restore specific assets from the trash.',
})
restoreAssets(@Auth() auth: AuthDto, @Body() dto: BulkIdsDto): Promise<TrashResponseDto> {
return this.service.restoreAssets(auth, dto);
}

46
server/src/controllers/user-admin.controller.ts
View file

@ -1,5 +1,5 @@
import { Body, Controller, Delete, Get, HttpCode, HttpStatus, Param, Post, Put, Query } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import { AssetStatsDto, AssetStatsResponseDto } from 'src/dtos/asset.dto';
import { AuthDto } from 'src/dtos/auth.dto';
import { SessionResponseDto } from 'src/dtos/session.dto';
@ -11,36 +11,52 @@ import {
UserAdminSearchDto,
UserAdminUpdateDto,
} from 'src/dtos/user.dto';
import { Permission } from 'src/enum';
import { ApiTag, Permission } from 'src/enum';
import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { UserAdminService } from 'src/services/user-admin.service';
import { UUIDParamDto } from 'src/validation';
@ApiTags('Users (admin)')
@ApiTags(ApiTag.UsersAdmin)
@Controller('admin/users')
export class UserAdminController {
constructor(private service: UserAdminService) {}
@Get()
@Authenticated({ permission: Permission.AdminUserRead, admin: true })
@ApiOperation({
summary: 'Search users',
description: 'Search for users.',
})
searchUsersAdmin(@Auth() auth: AuthDto, @Query() dto: UserAdminSearchDto): Promise<UserAdminResponseDto[]> {
return this.service.search(auth, dto);
}
@Post()
@Authenticated({ permission: Permission.AdminUserCreate, admin: true })
@ApiOperation({
summary: 'Create a user',
description: 'Create a new user.',
})
createUserAdmin(@Body() createUserDto: UserAdminCreateDto): Promise<UserAdminResponseDto> {
return this.service.create(createUserDto);
}
@Get(':id')
@Authenticated({ permission: Permission.AdminUserRead, admin: true })
@ApiOperation({
summary: 'Retrieve a user',
description: 'Retrieve a specific user by their ID.',
})
getUserAdmin(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<UserAdminResponseDto> {
return this.service.get(auth, id);
}
@Put(':id')
@Authenticated({ permission: Permission.AdminUserUpdate, admin: true })
@ApiOperation({
summary: 'Update a user',
description: 'Update an existing user.',
})
updateUserAdmin(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,
@ -51,6 +67,10 @@ export class UserAdminController {
@Delete(':id')
@Authenticated({ permission: Permission.AdminUserDelete, admin: true })
@ApiOperation({
summary: 'Delete a user',
description: 'Delete a user.',
})
deleteUserAdmin(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,
@ -61,12 +81,20 @@ export class UserAdminController {
@Get(':id/sessions')
@Authenticated({ permission: Permission.AdminSessionRead, admin: true })
@ApiOperation({
summary: 'Retrieve user sessions',
description: 'Retrieve all sessions for a specific user.',
})
getUserSessionsAdmin(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<SessionResponseDto[]> {
return this.service.getSessions(auth, id);
}
@Get(':id/statistics')
@Authenticated({ permission: Permission.AdminUserRead, admin: true })
@ApiOperation({
summary: 'Retrieve user statistics',
description: 'Retrieve asset statistics for a specific user.',
})
getUserStatisticsAdmin(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,
@ -77,12 +105,20 @@ export class UserAdminController {
@Get(':id/preferences')
@Authenticated({ permission: Permission.AdminUserRead, admin: true })
@ApiOperation({
summary: 'Retrieve user preferences',
description: 'Retrieve the preferences of a specific user.',
})
getUserPreferencesAdmin(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<UserPreferencesResponseDto> {
return this.service.getPreferences(auth, id);
}
@Put(':id/preferences')
@Authenticated({ permission: Permission.AdminUserUpdate, admin: true })
@ApiOperation({
summary: 'Update user preferences',
description: 'Update the preferences of a specific user.',
})
updateUserPreferencesAdmin(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,
@ -94,6 +130,10 @@ export class UserAdminController {
@Post(':id/restore')
@Authenticated({ permission: Permission.AdminUserDelete, admin: true })
@HttpCode(HttpStatus.OK)
@ApiOperation({
summary: 'Restore a deleted user',
description: 'Restore a previously deleted user.',
})
restoreUserAdmin(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<UserAdminResponseDto> {
return this.service.restore(auth, id);
}

54
server/src/controllers/user.controller.ts
View file

@ -13,7 +13,7 @@ import {
UploadedFile,
UseInterceptors,
} from '@nestjs/common';
import { ApiBody, ApiConsumes, ApiTags } from '@nestjs/swagger';
import { ApiBody, ApiConsumes, ApiOperation, ApiTags } from '@nestjs/swagger';
import { NextFunction, Response } from 'express';
import { AuthDto } from 'src/dtos/auth.dto';
import { LicenseKeyDto, LicenseResponseDto } from 'src/dtos/license.dto';
@ -21,7 +21,7 @@ import { OnboardingDto, OnboardingResponseDto } from 'src/dtos/onboarding.dto';
import { UserPreferencesResponseDto, UserPreferencesUpdateDto } from 'src/dtos/user-preferences.dto';
import { CreateProfileImageDto, CreateProfileImageResponseDto } from 'src/dtos/user-profile.dto';
import { UserAdminResponseDto, UserResponseDto, UserUpdateMeDto } from 'src/dtos/user.dto';
import { Permission, RouteKey } from 'src/enum';
import { ApiTag, Permission, RouteKey } from 'src/enum';
import { Auth, Authenticated, FileResponse } from 'src/middleware/auth.guard';
import { FileUploadInterceptor } from 'src/middleware/file-upload.interceptor';
import { LoggingRepository } from 'src/repositories/logging.repository';
@ -29,7 +29,7 @@ import { UserService } from 'src/services/user.service';
import { sendFile } from 'src/utils/file';
import { UUIDParamDto } from 'src/validation';
@ApiTags('Users')
@ApiTags(ApiTag.Users)
@Controller(RouteKey.User)
export class UserController {
constructor(
@ -39,30 +39,38 @@ export class UserController {
@Get()
@Authenticated({ permission: Permission.UserRead })
@ApiOperation({ summary: 'Get all users', description: 'Retrieve a list of all users on the server.' })
searchUsers(@Auth() auth: AuthDto): Promise<UserResponseDto[]> {
return this.service.search(auth);
}
@Get('me')
@Authenticated({ permission: Permission.UserRead })
@ApiOperation({
summary: 'Get current user',
description: 'Retrieve information about the user making the API request.',
})
getMyUser(@Auth() auth: AuthDto): Promise<UserAdminResponseDto> {
return this.service.getMe(auth);
}
@Put('me')
@Authenticated({ permission: Permission.UserUpdate })
@ApiOperation({ summary: 'Update current user', description: 'Update the current user making teh API request.' })
updateMyUser(@Auth() auth: AuthDto, @Body() dto: UserUpdateMeDto): Promise<UserAdminResponseDto> {
return this.service.updateMe(auth, dto);
}
@Get('me/preferences')
@Authenticated({ permission: Permission.UserPreferenceRead })
@ApiOperation({ summary: 'Get my preferences', description: 'Retrieve the preferences for the current user.' })
getMyPreferences(@Auth() auth: AuthDto): Promise<UserPreferencesResponseDto> {
return this.service.getMyPreferences(auth);
}
@Put('me/preferences')
@Authenticated({ permission: Permission.UserPreferenceUpdate })
@ApiOperation({ summary: 'Update my preferences', description: 'Update the preferences of the current user.' })
updateMyPreferences(
@Auth() auth: AuthDto,
@Body() dto: UserPreferencesUpdateDto,
@ -72,12 +80,20 @@ export class UserController {
@Get('me/license')
@Authenticated({ permission: Permission.UserLicenseRead })
@ApiOperation({
summary: 'Retrieve user product key',
description: 'Retrieve information about whether the current user has a registered product key.',
})
getUserLicense(@Auth() auth: AuthDto): Promise<LicenseResponseDto> {
return this.service.getLicense(auth);
}
@Put('me/license')
@Authenticated({ permission: Permission.UserLicenseUpdate })
@ApiOperation({
summary: 'Set user product key',
description: 'Register a product key for the current user.',
})
async setUserLicense(@Auth() auth: AuthDto, @Body() license: LicenseKeyDto): Promise<LicenseResponseDto> {
return this.service.setLicense(auth, license);
}
@ -85,18 +101,30 @@ export class UserController {
@Delete('me/license')
@Authenticated({ permission: Permission.UserLicenseDelete })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Delete user product key',
description: 'Delete the registered product key for the current user.',
})
async deleteUserLicense(@Auth() auth: AuthDto): Promise<void> {
await this.service.deleteLicense(auth);
}
@Get('me/onboarding')
@Authenticated({ permission: Permission.UserOnboardingRead })
@ApiOperation({
summary: 'Retrieve user onboarding',
description: 'Retrieve the onboarding status of the current user.',
})
getUserOnboarding(@Auth() auth: AuthDto): Promise<OnboardingResponseDto> {
return this.service.getOnboarding(auth);
}
@Put('me/onboarding')
@Authenticated({ permission: Permission.UserOnboardingUpdate })
@ApiOperation({
summary: 'Update user onboarding',
description: 'Update the onboarding status of the current user.',
})
async setUserOnboarding(@Auth() auth: AuthDto, @Body() Onboarding: OnboardingDto): Promise<OnboardingResponseDto> {
return this.service.setOnboarding(auth, Onboarding);
}
@ -104,12 +132,20 @@ export class UserController {
@Delete('me/onboarding')
@Authenticated({ permission: Permission.UserOnboardingDelete })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Delete user onboarding',
description: 'Delete the onboarding status of the current user.',
})
async deleteUserOnboarding(@Auth() auth: AuthDto): Promise<void> {
await this.service.deleteOnboarding(auth);
}
@Get(':id')
@Authenticated({ permission: Permission.UserRead })
@ApiOperation({
summary: 'Retrieve a user',
description: 'Retrieve a specific user by their ID.',
})
getUser(@Param() { id }: UUIDParamDto): Promise<UserResponseDto> {
return this.service.get(id);
}
@ -119,6 +155,10 @@ export class UserController {
@UseInterceptors(FileUploadInterceptor)
@ApiConsumes('multipart/form-data')
@ApiBody({ description: 'A new avatar for the user', type: CreateProfileImageDto })
@ApiOperation({
summary: 'Create user profile image',
description: 'Upload and set a new profile image for the current user.',
})
createProfileImage(
@Auth() auth: AuthDto,
@UploadedFile() fileInfo: Express.Multer.File,
@ -129,6 +169,10 @@ export class UserController {
@Delete('profile-image')
@Authenticated({ permission: Permission.UserProfileImageDelete })
@HttpCode(HttpStatus.NO_CONTENT)
@ApiOperation({
summary: 'Delete user profile image',
description: 'Delete the profile image of the current user.',
})
deleteProfileImage(@Auth() auth: AuthDto): Promise<void> {
return this.service.deleteProfileImage(auth);
}
@ -136,6 +180,10 @@ export class UserController {
@Get(':id/profile-image')
@FileResponse()
@Authenticated({ permission: Permission.UserProfileImageRead })
@ApiOperation({
summary: 'Retrieve user profile image',
description: 'Retrieve the profile image file for a user.',
})
async getProfileImage(@Res() res: Response, @Next() next: NextFunction, @Param() { id }: UUIDParamDto) {
await sendFile(res, next, () => this.service.getProfileImage(id), this.logger);
}

13
server/src/controllers/view.controller.ts
View file

@ -1,23 +1,32 @@
import { Controller, Get, Query } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import { AssetResponseDto } from 'src/dtos/asset-response.dto';
import { AuthDto } from 'src/dtos/auth.dto';
import { ApiTag } from 'src/enum';
import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { ViewService } from 'src/services/view.service';
@ApiTags('View')
@ApiTags(ApiTag.Views)
@Controller('view')
export class ViewController {
constructor(private service: ViewService) {}
@Get('folder/unique-paths')
@Authenticated()
@ApiOperation({
summary: 'Retrieve unique paths',
description: 'Retrieve a list of unique folder paths from asset original paths.',
})
getUniqueOriginalPaths(@Auth() auth: AuthDto): Promise<string[]> {
return this.service.getUniqueOriginalPaths(auth);
}
@Get('folder')
@Authenticated()
@ApiOperation({
summary: 'Retrieve assets by original path',
description: 'Retrieve assets that are children of a specific folder.',
})
getAssetsByOriginalPath(@Auth() auth: AuthDto, @Query('path') path: string): Promise<AssetResponseDto[]> {
return this.service.getAssetsByOriginalPath(auth, path);
}

4
server/src/decorators.ts
View file

@ -2,7 +2,7 @@ import { SetMetadata, applyDecorators } from '@nestjs/common';
import { ApiExtension, ApiOperation, ApiOperationOptions, ApiProperty, ApiTags } from '@nestjs/swagger';
import _ from 'lodash';
import { ADDED_IN_PREFIX, DEPRECATED_IN_PREFIX, LIFECYCLE_EXTENSION } from 'src/constants';
import { ImmichWorker, JobName, MetadataKey, QueueName } from 'src/enum';
import { ApiTag, ImmichWorker, JobName, MetadataKey, QueueName } from 'src/enum';
import { EmitEvent } from 'src/repositories/event.repository';
import { immich_uuid_v7, updated_at } from 'src/schema/functions';
import { BeforeUpdateTrigger, Column, ColumnOptions } from 'src/sql-tools';
@ -168,7 +168,7 @@ export const EndpointLifecycle = ({
const decorators: MethodDecorator[] = [ApiExtension(LIFECYCLE_EXTENSION, { addedAt, deprecatedAt })];
if (deprecatedAt) {
decorators.push(
ApiTags('Deprecated'),
ApiTags(ApiTag.Deprecated),
ApiOperation({
deprecated: true,
description: DEPRECATED_IN_PREFIX + deprecatedAt + (description ? `. ${description}` : ''),

35
server/src/enum.ts
View file

@ -771,3 +771,38 @@ export enum CronJob {
LibraryScan = 'LibraryScan',
NightlyJobs = 'NightlyJobs',
}
export enum ApiTag {
Activities = 'Activities',
Albums = 'Albums',
ApiKeys = 'API keys',
Authentication = 'Authentication',
AuthenticationAdmin = 'Authentication (admin)',
Assets = 'Assets',
Deprecated = 'Deprecated',
Download = 'Download',
Duplicates = 'Duplicates',
Faces = 'Faces',
Jobs = 'Jobs',
Libraries = 'Libraries',
Map = 'Map',
Memories = 'Memories',
Notifications = 'Notifications',
NotificationsAdmin = 'Notifications (admin)',
Partners = 'Partners',
People = 'People',
Search = 'Search',
Server = 'Server',
Sessions = 'Sessions',
SharedLinks = 'Shared links',
Stacks = 'Stacks',
Sync = 'Sync',
SystemConfig = 'System config',
SystemMetadata = 'System metadata',
Tags = 'Tags',
Timeline = 'Timeline',
Trash = 'Trash',
UsersAdmin = 'Users (admin)',
Users = 'Users',
Views = 'Views',
}

33
server/src/utils/misc.ts
View file

@ -17,7 +17,7 @@ import path from 'node:path';
import picomatch from 'picomatch';
import parse from 'picomatch/lib/parse';
import { SystemConfig } from 'src/config';
import { CLIP_MODEL_INFO, serverVersion } from 'src/constants';
import { CLIP_MODEL_INFO, endpointTags, serverVersion } from 'src/constants';
import { extraSyncModels } from 'src/dtos/sync.dto';
import { ApiCustomExtension, ImmichCookie, ImmichHeader, MetadataKey } from 'src/enum';
import { LoggingRepository } from 'src/repositories/logging.repository';
@ -218,25 +218,16 @@ const patchOpenAPI = (document: OpenAPIObject) => {
delete operation.summary;
}
if (operation.description === '') {
delete operation.description;
}
if (operation.operationId) {
// console.log(`${routeToErrorMessage(operation.operationId).padEnd(40)} (${operation.operationId})`);
}
const adminOnly = operation[ApiCustomExtension.AdminOnly] ?? false;
const permission = operation[ApiCustomExtension.Permission];
if (permission) {
let description = (operation.description || '').trim();
if (description && !description.endsWith('.')) {
description += '. ';
}
operation.description =
description +
`This endpoint ${adminOnly ? 'is an admin-only route, and ' : ''}requires the \`${permission}\` permission.`;
if (operation.parameters) {
operation.parameters = _.orderBy(operation.parameters, 'name');
}
if (operation.parameters) {
operation.parameters = _.orderBy(operation.parameters, 'name');
}
}
}
@ -245,7 +236,7 @@ const patchOpenAPI = (document: OpenAPIObject) => {
};
export const useSwagger = (app: INestApplication, { write }: { write: boolean }) => {
const config = new DocumentBuilder()
const builder = new DocumentBuilder()
.setTitle('Immich')
.setDescription('Immich API')
.setVersion(serverVersion.toString())
@ -263,8 +254,12 @@ export const useSwagger = (app: INestApplication, { write }: { write: boolean })
},
MetadataKey.ApiKeySecurity,
)
.addServer('/api')
.build();
.addServer('/api');
for (const [tag, description] of Object.entries(endpointTags)) {
builder.addTag(tag, description);
}
const config = builder.build();
const options: SwaggerDocumentOptions = {
operationIdFactory: (controllerKey: string, methodKey: string) => methodKey,