@immich/sdk 1.136.0 → 1.137.0

package/build/fetch-client.d.ts

@@ -1,6 +1,6 @@
 /**
  * Immich
- * 1.136.0
+ * 1.137.0
  * DO NOT MODIFY - This file has been generated using oazapfts.
  * See https://www.npmjs.com/package/oazapfts
  */
@@ -1194,6 +1194,7 @@ export type SharedLinkResponseDto = {
     key: string;
     password: string | null;
     showMetadata: boolean;
+    slug: string | null;
     token?: string | null;
     "type": SharedLinkType;
     userId: string;
@@ -1203,10 +1204,11 @@ export type SharedLinkCreateDto = {
     allowDownload?: boolean;
     allowUpload?: boolean;
     assetIds?: string[];
-    description?: string;
+    description?: string | null;
     expiresAt?: string | null;
-    password?: string;
+    password?: string | null;
     showMetadata?: boolean;
+    slug?: string | null;
     "type": SharedLinkType;
 };
 export type SharedLinkEditDto = {
@@ -1216,10 +1218,11 @@ export type SharedLinkEditDto = {
     Setting this flag and not sending expiryAt is considered as null instead.
     Clients that can send null values can ignore this. */
     changeExpiryTime?: boolean;
-    description?: string;
+    description?: string | null;
     expiresAt?: string | null;
-    password?: string;
+    password?: string | null;
     showMetadata?: boolean;
+    slug?: string | null;
 };
 export type AssetIdsResponseDto = {
     assetId: string;
@@ -1570,6 +1573,9 @@ export type CreateProfileImageResponseDto = {
     profileImagePath: string;
     userId: string;
 };
+/**
+ * This endpoint requires the `activity.read` permission.
+ */
 export declare function getActivities({ albumId, assetId, level, $type, userId }: {
     albumId: string;
     assetId?: string;
@@ -1577,13 +1583,22 @@ export declare function getActivities({ albumId, assetId, level, $type, userId }
     $type?: ReactionType;
     userId?: string;
 }, opts?: Oazapfts.RequestOpts): Promise<ActivityResponseDto[]>;
+/**
+ * This endpoint requires the `activity.create` permission.
+ */
 export declare function createActivity({ activityCreateDto }: {
     activityCreateDto: ActivityCreateDto;
 }, opts?: Oazapfts.RequestOpts): Promise<ActivityResponseDto>;
+/**
+ * This endpoint requires the `activity.statistics` permission.
+ */
 export declare function getActivityStatistics({ albumId, assetId }: {
     albumId: string;
     assetId?: string;
 }, opts?: Oazapfts.RequestOpts): Promise<ActivityStatisticsResponseDto>;
+/**
+ * This endpoint requires the `activity.delete` permission.
+ */
 export declare function deleteActivity({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
@@ -1597,104 +1612,191 @@ export declare function getNotificationTemplateAdmin({ name, templateDto }: {
 export declare function sendTestEmailAdmin({ systemConfigSmtpDto }: {
     systemConfigSmtpDto: SystemConfigSmtpDto;
 }, opts?: Oazapfts.RequestOpts): Promise<TestEmailResponseDto>;
+/**
+ * This endpoint is an admin-only route, and requires the `adminUser.read` permission.
+ */
 export declare function searchUsersAdmin({ id, withDeleted }: {
     id?: string;
     withDeleted?: boolean;
 }, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto[]>;
+/**
+ * This endpoint is an admin-only route, and requires the `adminUser.create` permission.
+ */
 export declare function createUserAdmin({ userAdminCreateDto }: {
     userAdminCreateDto: UserAdminCreateDto;
 }, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
+/**
+ * This endpoint is an admin-only route, and requires the `adminUser.delete` permission.
+ */
 export declare function deleteUserAdmin({ id, userAdminDeleteDto }: {
     id: string;
     userAdminDeleteDto: UserAdminDeleteDto;
 }, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
+/**
+ * This endpoint is an admin-only route, and requires the `adminUser.read` permission.
+ */
 export declare function getUserAdmin({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
+/**
+ * This endpoint is an admin-only route, and requires the `adminUser.update` permission.
+ */
 export declare function updateUserAdmin({ id, userAdminUpdateDto }: {
     id: string;
     userAdminUpdateDto: UserAdminUpdateDto;
 }, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
+/**
+ * This endpoint is an admin-only route, and requires the `adminUser.read` permission.
+ */
 export declare function getUserPreferencesAdmin({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<UserPreferencesResponseDto>;
+/**
+ * This endpoint is an admin-only route, and requires the `adminUser.update` permission.
+ */
 export declare function updateUserPreferencesAdmin({ id, userPreferencesUpdateDto }: {
     id: string;
     userPreferencesUpdateDto: UserPreferencesUpdateDto;
 }, opts?: Oazapfts.RequestOpts): Promise<UserPreferencesResponseDto>;
+/**
+ * This endpoint is an admin-only route, and requires the `adminUser.delete` permission.
+ */
 export declare function restoreUserAdmin({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
+/**
+ * This endpoint is an admin-only route, and requires the `adminUser.read` permission.
+ */
 export declare function getUserStatisticsAdmin({ id, isFavorite, isTrashed, visibility }: {
     id: string;
     isFavorite?: boolean;
     isTrashed?: boolean;
     visibility?: AssetVisibility;
 }, opts?: Oazapfts.RequestOpts): Promise<AssetStatsResponseDto>;
+/**
+ * This endpoint requires the `album.read` permission.
+ */
 export declare function getAllAlbums({ assetId, shared }: {
     assetId?: string;
     shared?: boolean;
 }, opts?: Oazapfts.RequestOpts): Promise<AlbumResponseDto[]>;
+/**
+ * This endpoint requires the `album.create` permission.
+ */
 export declare function createAlbum({ createAlbumDto }: {
     createAlbumDto: CreateAlbumDto;
 }, opts?: Oazapfts.RequestOpts): Promise<AlbumResponseDto>;
+/**
+ * This endpoint requires the `album.statistics` permission.
+ */
 export declare function getAlbumStatistics(opts?: Oazapfts.RequestOpts): Promise<AlbumStatisticsResponseDto>;
+/**
+ * This endpoint requires the `album.delete` permission.
+ */
 export declare function deleteAlbum({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
-export declare function getAlbumInfo({ id, key, withoutAssets }: {
+/**
+ * This endpoint requires the `album.read` permission.
+ */
+export declare function getAlbumInfo({ id, key, slug, withoutAssets }: {
     id: string;
     key?: string;
+    slug?: string;
     withoutAssets?: boolean;
 }, opts?: Oazapfts.RequestOpts): Promise<AlbumResponseDto>;
+/**
+ * This endpoint requires the `album.update` permission.
+ */
 export declare function updateAlbumInfo({ id, updateAlbumDto }: {
     id: string;
     updateAlbumDto: UpdateAlbumDto;
 }, opts?: Oazapfts.RequestOpts): Promise<AlbumResponseDto>;
+/**
+ * This endpoint requires the `albumAsset.delete` permission.
+ */
 export declare function removeAssetFromAlbum({ id, bulkIdsDto }: {
     id: string;
     bulkIdsDto: BulkIdsDto;
 }, opts?: Oazapfts.RequestOpts): Promise<BulkIdResponseDto[]>;
-export declare function addAssetsToAlbum({ id, key, bulkIdsDto }: {
+/**
+ * This endpoint requires the `albumAsset.create` permission.
+ */
+export declare function addAssetsToAlbum({ id, key, slug, bulkIdsDto }: {
     id: string;
     key?: string;
+    slug?: string;
     bulkIdsDto: BulkIdsDto;
 }, opts?: Oazapfts.RequestOpts): Promise<BulkIdResponseDto[]>;
+/**
+ * This endpoint requires the `albumUser.delete` permission.
+ */
 export declare function removeUserFromAlbum({ id, userId }: {
     id: string;
     userId: string;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint requires the `albumUser.update` permission.
+ */
 export declare function updateAlbumUser({ id, userId, updateAlbumUserDto }: {
     id: string;
     userId: string;
     updateAlbumUserDto: UpdateAlbumUserDto;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint requires the `albumUser.create` permission.
+ */
 export declare function addUsersToAlbum({ id, addUsersDto }: {
     id: string;
     addUsersDto: AddUsersDto;
 }, opts?: Oazapfts.RequestOpts): Promise<AlbumResponseDto>;
+/**
+ * This endpoint requires the `apiKey.read` permission.
+ */
 export declare function getApiKeys(opts?: Oazapfts.RequestOpts): Promise<ApiKeyResponseDto[]>;
+/**
+ * This endpoint requires the `apiKey.create` permission.
+ */
 export declare function createApiKey({ apiKeyCreateDto }: {
     apiKeyCreateDto: ApiKeyCreateDto;
 }, opts?: Oazapfts.RequestOpts): Promise<ApiKeyCreateResponseDto>;
+/**
+ * This endpoint requires the `apiKey.delete` permission.
+ */
 export declare function deleteApiKey({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint requires the `apiKey.read` permission.
+ */
 export declare function getApiKey({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<ApiKeyResponseDto>;
+/**
+ * This endpoint requires the `apiKey.update` permission.
+ */
 export declare function updateApiKey({ id, apiKeyUpdateDto }: {
     id: string;
     apiKeyUpdateDto: ApiKeyUpdateDto;
 }, opts?: Oazapfts.RequestOpts): Promise<ApiKeyResponseDto>;
+/**
+ * This endpoint requires the `asset.delete` permission.
+ */
 export declare function deleteAssets({ assetBulkDeleteDto }: {
     assetBulkDeleteDto: AssetBulkDeleteDto;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
-export declare function uploadAsset({ key, xImmichChecksum, assetMediaCreateDto }: {
+/**
+ * This endpoint requires the `asset.upload` permission.
+ */
+export declare function uploadAsset({ key, slug, xImmichChecksum, assetMediaCreateDto }: {
     key?: string;
+    slug?: string;
     xImmichChecksum?: string;
     assetMediaCreateDto: AssetMediaCreateDto;
 }, opts?: Oazapfts.RequestOpts): Promise<AssetMediaResponseDto>;
+/**
+ * This endpoint requires the `asset.update` permission.
+ */
 export declare function updateAssets({ assetBulkUpdateDto }: {
     assetBulkUpdateDto: AssetBulkUpdateDto;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
@@ -1720,48 +1822,74 @@ export declare function runAssetJobs({ assetJobsDto }: {
     assetJobsDto: AssetJobsDto;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
 /**
- * This property was deprecated in v1.116.0
+ * This property was deprecated in v1.116.0. This endpoint requires the `asset.read` permission.
  */
 export declare function getRandom({ count }: {
     count?: number;
 }, opts?: Oazapfts.RequestOpts): Promise<AssetResponseDto[]>;
+/**
+ * This endpoint requires the `asset.statistics` permission.
+ */
 export declare function getAssetStatistics({ isFavorite, isTrashed, visibility }: {
     isFavorite?: boolean;
     isTrashed?: boolean;
     visibility?: AssetVisibility;
 }, opts?: Oazapfts.RequestOpts): Promise<AssetStatsResponseDto>;
-export declare function getAssetInfo({ id, key }: {
+/**
+ * This endpoint requires the `asset.read` permission.
+ */
+export declare function getAssetInfo({ id, key, slug }: {
     id: string;
     key?: string;
+    slug?: string;
 }, opts?: Oazapfts.RequestOpts): Promise<AssetResponseDto>;
+/**
+ * This endpoint requires the `asset.update` permission.
+ */
 export declare function updateAsset({ id, updateAssetDto }: {
     id: string;
     updateAssetDto: UpdateAssetDto;
 }, opts?: Oazapfts.RequestOpts): Promise<AssetResponseDto>;
-export declare function downloadAsset({ id, key }: {
+/**
+ * This endpoint requires the `asset.download` permission.
+ */
+export declare function downloadAsset({ id, key, slug }: {
     id: string;
     key?: string;
+    slug?: string;
 }, opts?: Oazapfts.RequestOpts): Promise<Blob>;
 /**
  * replaceAsset
  */
-export declare function replaceAsset({ id, key, assetMediaReplaceDto }: {
+export declare function replaceAsset({ id, key, slug, assetMediaReplaceDto }: {
     id: string;
     key?: string;
+    slug?: string;
     assetMediaReplaceDto: AssetMediaReplaceDto;
 }, opts?: Oazapfts.RequestOpts): Promise<AssetMediaResponseDto>;
-export declare function viewAsset({ id, key, size }: {
+/**
+ * This endpoint requires the `asset.view` permission.
+ */
+export declare function viewAsset({ id, key, size, slug }: {
     id: string;
     key?: string;
     size?: AssetMediaSize;
+    slug?: string;
 }, opts?: Oazapfts.RequestOpts): Promise<Blob>;
-export declare function playAssetVideo({ id, key }: {
+/**
+ * This endpoint requires the `asset.view` permission.
+ */
+export declare function playAssetVideo({ id, key, slug }: {
     id: string;
     key?: string;
+    slug?: string;
 }, opts?: Oazapfts.RequestOpts): Promise<Blob>;
 export declare function signUpAdmin({ signUpDto }: {
     signUpDto: SignUpDto;
 }, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
+/**
+ * This endpoint requires the `auth.changePassword` permission.
+ */
 export declare function changePassword({ changePasswordDto }: {
     changePasswordDto: ChangePasswordDto;
 }, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
@@ -1769,12 +1897,21 @@ export declare function login({ loginCredentialDto }: {
     loginCredentialDto: LoginCredentialDto;
 }, opts?: Oazapfts.RequestOpts): Promise<LoginResponseDto>;
 export declare function logout(opts?: Oazapfts.RequestOpts): Promise<LogoutResponseDto>;
+/**
+ * This endpoint requires the `pinCode.delete` permission.
+ */
 export declare function resetPinCode({ pinCodeResetDto }: {
     pinCodeResetDto: PinCodeResetDto;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint requires the `pinCode.create` permission.
+ */
 export declare function setupPinCode({ pinCodeSetupDto }: {
     pinCodeSetupDto: PinCodeSetupDto;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint requires the `pinCode.update` permission.
+ */
 export declare function changePinCode({ pinCodeChangeDto }: {
     pinCodeChangeDto: PinCodeChangeDto;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
@@ -1784,60 +1921,119 @@ export declare function unlockAuthSession({ sessionUnlockDto }: {
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
 export declare function getAuthStatus(opts?: Oazapfts.RequestOpts): Promise<AuthStatusResponseDto>;
 export declare function validateAccessToken(opts?: Oazapfts.RequestOpts): Promise<ValidateAccessTokenResponseDto>;
-export declare function downloadArchive({ key, assetIdsDto }: {
+/**
+ * This endpoint requires the `asset.download` permission.
+ */
+export declare function downloadArchive({ key, slug, assetIdsDto }: {
     key?: string;
+    slug?: string;
     assetIdsDto: AssetIdsDto;
 }, opts?: Oazapfts.RequestOpts): Promise<Blob>;
-export declare function getDownloadInfo({ key, downloadInfoDto }: {
+/**
+ * This endpoint requires the `asset.download` permission.
+ */
+export declare function getDownloadInfo({ key, slug, downloadInfoDto }: {
     key?: string;
+    slug?: string;
     downloadInfoDto: DownloadInfoDto;
 }, opts?: Oazapfts.RequestOpts): Promise<DownloadResponseDto>;
+/**
+ * This endpoint requires the `duplicate.delete` permission.
+ */
 export declare function deleteDuplicates({ bulkIdsDto }: {
     bulkIdsDto: BulkIdsDto;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint requires the `duplicate.read` permission.
+ */
 export declare function getAssetDuplicates(opts?: Oazapfts.RequestOpts): Promise<DuplicateResponseDto[]>;
+/**
+ * This endpoint requires the `duplicate.delete` permission.
+ */
 export declare function deleteDuplicate({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint requires the `face.read` permission.
+ */
 export declare function getFaces({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<AssetFaceResponseDto[]>;
+/**
+ * This endpoint requires the `face.create` permission.
+ */
 export declare function createFace({ assetFaceCreateDto }: {
     assetFaceCreateDto: AssetFaceCreateDto;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint requires the `face.delete` permission.
+ */
 export declare function deleteFace({ id, assetFaceDeleteDto }: {
     id: string;
     assetFaceDeleteDto: AssetFaceDeleteDto;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint requires the `face.update` permission.
+ */
 export declare function reassignFacesById({ id, faceDto }: {
     id: string;
     faceDto: FaceDto;
 }, opts?: Oazapfts.RequestOpts): Promise<PersonResponseDto>;
+/**
+ * This endpoint is an admin-only route, and requires the `job.read` permission.
+ */
 export declare function getAllJobsStatus(opts?: Oazapfts.RequestOpts): Promise<AllJobStatusResponseDto>;
+/**
+ * This endpoint is an admin-only route, and requires the `job.create` permission.
+ */
 export declare function createJob({ jobCreateDto }: {
     jobCreateDto: JobCreateDto;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint is an admin-only route, and requires the `job.create` permission.
+ */
 export declare function sendJobCommand({ id, jobCommandDto }: {
     id: JobName;
     jobCommandDto: JobCommandDto;
 }, opts?: Oazapfts.RequestOpts): Promise<JobStatusDto>;
+/**
+ * This endpoint is an admin-only route, and requires the `library.read` permission.
+ */
 export declare function getAllLibraries(opts?: Oazapfts.RequestOpts): Promise<LibraryResponseDto[]>;
+/**
+ * This endpoint is an admin-only route, and requires the `library.create` permission.
+ */
 export declare function createLibrary({ createLibraryDto }: {
     createLibraryDto: CreateLibraryDto;
 }, opts?: Oazapfts.RequestOpts): Promise<LibraryResponseDto>;
+/**
+ * This endpoint is an admin-only route, and requires the `library.delete` permission.
+ */
 export declare function deleteLibrary({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint is an admin-only route, and requires the `library.read` permission.
+ */
 export declare function getLibrary({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<LibraryResponseDto>;
+/**
+ * This endpoint is an admin-only route, and requires the `library.update` permission.
+ */
 export declare function updateLibrary({ id, updateLibraryDto }: {
     id: string;
     updateLibraryDto: UpdateLibraryDto;
 }, opts?: Oazapfts.RequestOpts): Promise<LibraryResponseDto>;
+/**
+ * This endpoint is an admin-only route, and requires the `library.update` permission.
+ */
 export declare function scanLibrary({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint is an admin-only route, and requires the `library.statistics` permission.
+ */
 export declare function getLibraryStatistics({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<LibraryStatsResponseDto>;
@@ -1845,11 +2041,11 @@ export declare function validate({ id, validateLibraryDto }: {
     id: string;
     validateLibraryDto: ValidateLibraryDto;
 }, opts?: Oazapfts.RequestOpts): Promise<ValidateLibraryResponseDto>;
-export declare function getMapMarkers({ fileCreatedAfter, fileCreatedBefore, isArchived, isFavorite, withPartners, withSharedAlbums }: {
-    fileCreatedAfter?: string;
-    fileCreatedBefore?: string;
+export declare function getMapMarkers({ isArchived, isFavorite, fileCreatedAfter, fileCreatedBefore, withPartners, withSharedAlbums }: {
     isArchived?: boolean;
     isFavorite?: boolean;
+    fileCreatedAfter?: string;
+    fileCreatedBefore?: string;
     withPartners?: boolean;
     withSharedAlbums?: boolean;
 }, opts?: Oazapfts.RequestOpts): Promise<MapMarkerResponseDto[]>;
@@ -1857,57 +2053,99 @@ export declare function reverseGeocode({ lat, lon }: {
     lat: number;
     lon: number;
 }, opts?: Oazapfts.RequestOpts): Promise<MapReverseGeocodeResponseDto[]>;
+/**
+ * This endpoint requires the `memory.read` permission.
+ */
 export declare function searchMemories({ $for, isSaved, isTrashed, $type }: {
     $for?: string;
     isSaved?: boolean;
     isTrashed?: boolean;
     $type?: MemoryType;
 }, opts?: Oazapfts.RequestOpts): Promise<MemoryResponseDto[]>;
+/**
+ * This endpoint requires the `memory.create` permission.
+ */
 export declare function createMemory({ memoryCreateDto }: {
     memoryCreateDto: MemoryCreateDto;
 }, opts?: Oazapfts.RequestOpts): Promise<MemoryResponseDto>;
+/**
+ * This endpoint requires the `memory.statistics` permission.
+ */
 export declare function memoriesStatistics({ $for, isSaved, isTrashed, $type }: {
     $for?: string;
     isSaved?: boolean;
     isTrashed?: boolean;
     $type?: MemoryType;
 }, opts?: Oazapfts.RequestOpts): Promise<MemoryStatisticsResponseDto>;
+/**
+ * This endpoint requires the `memory.delete` permission.
+ */
 export declare function deleteMemory({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint requires the `memory.read` permission.
+ */
 export declare function getMemory({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<MemoryResponseDto>;
+/**
+ * This endpoint requires the `memory.update` permission.
+ */
 export declare function updateMemory({ id, memoryUpdateDto }: {
     id: string;
     memoryUpdateDto: MemoryUpdateDto;
 }, opts?: Oazapfts.RequestOpts): Promise<MemoryResponseDto>;
+/**
+ * This endpoint requires the `memoryAsset.delete` permission.
+ */
 export declare function removeMemoryAssets({ id, bulkIdsDto }: {
     id: string;
     bulkIdsDto: BulkIdsDto;
 }, opts?: Oazapfts.RequestOpts): Promise<BulkIdResponseDto[]>;
+/**
+ * This endpoint requires the `memoryAsset.create` permission.
+ */
 export declare function addMemoryAssets({ id, bulkIdsDto }: {
     id: string;
     bulkIdsDto: BulkIdsDto;
 }, opts?: Oazapfts.RequestOpts): Promise<BulkIdResponseDto[]>;
+/**
+ * This endpoint requires the `notification.delete` permission.
+ */
 export declare function deleteNotifications({ notificationDeleteAllDto }: {
     notificationDeleteAllDto: NotificationDeleteAllDto;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint requires the `notification.read` permission.
+ */
 export declare function getNotifications({ id, level, $type, unread }: {
     id?: string;
     level?: NotificationLevel;
     $type?: NotificationType;
     unread?: boolean;
 }, opts?: Oazapfts.RequestOpts): Promise<NotificationDto[]>;
+/**
+ * This endpoint requires the `notification.update` permission.
+ */
 export declare function updateNotifications({ notificationUpdateAllDto }: {
     notificationUpdateAllDto: NotificationUpdateAllDto;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint requires the `notification.delete` permission.
+ */
 export declare function deleteNotification({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint requires the `notification.read` permission.
+ */
 export declare function getNotification({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<NotificationDto>;
+/**
+ * This endpoint requires the `notification.update` permission.
+ */
 export declare function updateNotification({ id, notificationUpdateDto }: {
     id: string;
     notificationUpdateDto: NotificationUpdateDto;
@@ -1923,22 +2161,40 @@ export declare function linkOAuthAccount({ oAuthCallbackDto }: {
 }, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
 export declare function redirectOAuthToMobile(opts?: Oazapfts.RequestOpts): Promise<never>;
 export declare function unlinkOAuthAccount(opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
+/**
+ * This endpoint requires the `partner.read` permission.
+ */
 export declare function getPartners({ direction }: {
     direction: PartnerDirection;
 }, opts?: Oazapfts.RequestOpts): Promise<PartnerResponseDto[]>;
+/**
+ * This endpoint requires the `partner.delete` permission.
+ */
 export declare function removePartner({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint requires the `partner.create` permission.
+ */
 export declare function createPartner({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<PartnerResponseDto>;
+/**
+ * This endpoint requires the `partner.update` permission.
+ */
 export declare function updatePartner({ id, updatePartnerDto }: {
     id: string;
     updatePartnerDto: UpdatePartnerDto;
 }, opts?: Oazapfts.RequestOpts): Promise<PartnerResponseDto>;
+/**
+ * This endpoint requires the `person.delete` permission.
+ */
 export declare function deletePeople({ bulkIdsDto }: {
     bulkIdsDto: BulkIdsDto;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint requires the `person.read` permission.
+ */
 export declare function getAllPeople({ closestAssetId, closestPersonId, page, size, withHidden }: {
     closestAssetId?: string;
     closestPersonId?: string;
@@ -1946,57 +2202,147 @@ export declare function getAllPeople({ closestAssetId, closestPersonId, page, si
     size?: number;
     withHidden?: boolean;
 }, opts?: Oazapfts.RequestOpts): Promise<PeopleResponseDto>;
+/**
+ * This endpoint requires the `person.create` permission.
+ */
 export declare function createPerson({ personCreateDto }: {
     personCreateDto: PersonCreateDto;
 }, opts?: Oazapfts.RequestOpts): Promise<PersonResponseDto>;
+/**
+ * This endpoint requires the `person.update` permission.
+ */
 export declare function updatePeople({ peopleUpdateDto }: {
     peopleUpdateDto: PeopleUpdateDto;
 }, opts?: Oazapfts.RequestOpts): Promise<BulkIdResponseDto[]>;
+/**
+ * This endpoint requires the `person.delete` permission.
+ */
 export declare function deletePerson({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint requires the `person.read` permission.
+ */
 export declare function getPerson({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<PersonResponseDto>;
+/**
+ * This endpoint requires the `person.update` permission.
+ */
 export declare function updatePerson({ id, personUpdateDto }: {
     id: string;
     personUpdateDto: PersonUpdateDto;
 }, opts?: Oazapfts.RequestOpts): Promise<PersonResponseDto>;
+/**
+ * This endpoint requires the `person.merge` permission.
+ */
 export declare function mergePerson({ id, mergePersonDto }: {
     id: string;
     mergePersonDto: MergePersonDto;
 }, opts?: Oazapfts.RequestOpts): Promise<BulkIdResponseDto[]>;
+/**
+ * This endpoint requires the `person.reassign` permission.
+ */
 export declare function reassignFaces({ id, assetFaceUpdateDto }: {
     id: string;
     assetFaceUpdateDto: AssetFaceUpdateDto;
 }, opts?: Oazapfts.RequestOpts): Promise<PersonResponseDto[]>;
+/**
+ * This endpoint requires the `person.statistics` permission.
+ */
 export declare function getPersonStatistics({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<PersonStatisticsResponseDto>;
+/**
+ * This endpoint requires the `person.read` permission.
+ */
 export declare function getPersonThumbnail({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<Blob>;
+/**
+ * This endpoint requires the `asset.read` permission.
+ */
 export declare function getAssetsByCity(opts?: Oazapfts.RequestOpts): Promise<AssetResponseDto[]>;
+/**
+ * This endpoint requires the `asset.read` permission.
+ */
 export declare function getExploreData(opts?: Oazapfts.RequestOpts): Promise<SearchExploreResponseDto[]>;
+/**
+ * This endpoint requires the `asset.read` permission.
+ */
+export declare function searchLargeAssets({ albumIds, city, country, createdAfter, createdBefore, deviceId, isEncoded, isFavorite, isMotion, isNotInAlbum, isOffline, lensModel, libraryId, make, minFileSize, model, personIds, rating, size, state, tagIds, takenAfter, takenBefore, trashedAfter, trashedBefore, $type, updatedAfter, updatedBefore, visibility, withDeleted, withExif }: {
+    albumIds?: string[];
+    city?: string | null;
+    country?: string | null;
+    createdAfter?: string;
+    createdBefore?: string;
+    deviceId?: string;
+    isEncoded?: boolean;
+    isFavorite?: boolean;
+    isMotion?: boolean;
+    isNotInAlbum?: boolean;
+    isOffline?: boolean;
+    lensModel?: string | null;
+    libraryId?: string | null;
+    make?: string;
+    minFileSize?: number;
+    model?: string | null;
+    personIds?: string[];
+    rating?: number;
+    size?: number;
+    state?: string | null;
+    tagIds?: string[] | null;
+    takenAfter?: string;
+    takenBefore?: string;
+    trashedAfter?: string;
+    trashedBefore?: string;
+    $type?: AssetTypeEnum;
+    updatedAfter?: string;
+    updatedBefore?: string;
+    visibility?: AssetVisibility;
+    withDeleted?: boolean;
+    withExif?: boolean;
+}, opts?: Oazapfts.RequestOpts): Promise<AssetResponseDto[]>;
+/**
+ * This endpoint requires the `asset.read` permission.
+ */
 export declare function searchAssets({ metadataSearchDto }: {
     metadataSearchDto: MetadataSearchDto;
 }, opts?: Oazapfts.RequestOpts): Promise<SearchResponseDto>;
+/**
+ * This endpoint requires the `person.read` permission.
+ */
 export declare function searchPerson({ name, withHidden }: {
     name: string;
     withHidden?: boolean;
 }, opts?: Oazapfts.RequestOpts): Promise<PersonResponseDto[]>;
+/**
+ * This endpoint requires the `asset.read` permission.
+ */
 export declare function searchPlaces({ name }: {
     name: string;
 }, opts?: Oazapfts.RequestOpts): Promise<PlacesResponseDto[]>;
+/**
+ * This endpoint requires the `asset.read` permission.
+ */
 export declare function searchRandom({ randomSearchDto }: {
     randomSearchDto: RandomSearchDto;
 }, opts?: Oazapfts.RequestOpts): Promise<AssetResponseDto[]>;
+/**
+ * This endpoint requires the `asset.read` permission.
+ */
 export declare function searchSmart({ smartSearchDto }: {
     smartSearchDto: SmartSearchDto;
 }, opts?: Oazapfts.RequestOpts): Promise<SearchResponseDto>;
+/**
+ * This endpoint requires the `asset.statistics` permission.
+ */
 export declare function searchAssetStatistics({ statisticsSearchDto }: {
     statisticsSearchDto: StatisticsSearchDto;
 }, opts?: Oazapfts.RequestOpts): Promise<SearchStatisticsResponseDto>;
+/**
+ * This endpoint requires the `asset.read` permission.
+ */
 export declare function getSearchSuggestions({ country, includeNull, make, model, state, $type }: {
     country?: string;
     includeNull?: boolean;
@@ -2005,96 +2351,183 @@ export declare function getSearchSuggestions({ country, includeNull, make, model
     state?: string;
     $type: SearchSuggestionType;
 }, opts?: Oazapfts.RequestOpts): Promise<string[]>;
+/**
+ * This endpoint requires the `server.about` permission.
+ */
 export declare function getAboutInfo(opts?: Oazapfts.RequestOpts): Promise<ServerAboutResponseDto>;
+/**
+ * This endpoint requires the `server.apkLinks` permission.
+ */
 export declare function getApkLinks(opts?: Oazapfts.RequestOpts): Promise<ServerApkLinksDto>;
 export declare function getServerConfig(opts?: Oazapfts.RequestOpts): Promise<ServerConfigDto>;
 export declare function getServerFeatures(opts?: Oazapfts.RequestOpts): Promise<ServerFeaturesDto>;
+/**
+ * This endpoint is an admin-only route, and requires the `serverLicense.delete` permission.
+ */
 export declare function deleteServerLicense(opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint is an admin-only route, and requires the `serverLicense.read` permission.
+ */
 export declare function getServerLicense(opts?: Oazapfts.RequestOpts): Promise<LicenseResponseDto>;
+/**
+ * This endpoint is an admin-only route, and requires the `serverLicense.update` permission.
+ */
 export declare function setServerLicense({ licenseKeyDto }: {
     licenseKeyDto: LicenseKeyDto;
 }, opts?: Oazapfts.RequestOpts): Promise<LicenseResponseDto>;
 export declare function getSupportedMediaTypes(opts?: Oazapfts.RequestOpts): Promise<ServerMediaTypesResponseDto>;
 export declare function pingServer(opts?: Oazapfts.RequestOpts): Promise<ServerPingResponseRead>;
+/**
+ * This endpoint is an admin-only route, and requires the `server.statistics` permission.
+ */
 export declare function getServerStatistics(opts?: Oazapfts.RequestOpts): Promise<ServerStatsResponseDto>;
+/**
+ * This endpoint requires the `server.storage` permission.
+ */
 export declare function getStorage(opts?: Oazapfts.RequestOpts): Promise<ServerStorageResponseDto>;
 export declare function getTheme(opts?: Oazapfts.RequestOpts): Promise<ServerThemeDto>;
 export declare function getServerVersion(opts?: Oazapfts.RequestOpts): Promise<ServerVersionResponseDto>;
 export declare function getVersionCheck(opts?: Oazapfts.RequestOpts): Promise<VersionCheckStateResponseDto>;
 export declare function getVersionHistory(opts?: Oazapfts.RequestOpts): Promise<ServerVersionHistoryResponseDto[]>;
+/**
+ * This endpoint requires the `session.delete` permission.
+ */
 export declare function deleteAllSessions(opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint requires the `session.read` permission.
+ */
 export declare function getSessions(opts?: Oazapfts.RequestOpts): Promise<SessionResponseDto[]>;
+/**
+ * This endpoint requires the `session.create` permission.
+ */
 export declare function createSession({ sessionCreateDto }: {
     sessionCreateDto: SessionCreateDto;
 }, opts?: Oazapfts.RequestOpts): Promise<SessionCreateResponseDto>;
+/**
+ * This endpoint requires the `session.delete` permission.
+ */
 export declare function deleteSession({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint requires the `session.update` permission.
+ */
 export declare function updateSession({ id, sessionUpdateDto }: {
     id: string;
     sessionUpdateDto: SessionUpdateDto;
 }, opts?: Oazapfts.RequestOpts): Promise<SessionResponseDto>;
+/**
+ * This endpoint requires the `session.lock` permission.
+ */
 export declare function lockSession({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint requires the `sharedLink.read` permission.
+ */
 export declare function getAllSharedLinks({ albumId }: {
     albumId?: string;
 }, opts?: Oazapfts.RequestOpts): Promise<SharedLinkResponseDto[]>;
+/**
+ * This endpoint requires the `sharedLink.create` permission.
+ */
 export declare function createSharedLink({ sharedLinkCreateDto }: {
     sharedLinkCreateDto: SharedLinkCreateDto;
 }, opts?: Oazapfts.RequestOpts): Promise<SharedLinkResponseDto>;
-export declare function getMySharedLink({ key, password, token }: {
-    key?: string;
+export declare function getMySharedLink({ password, token, key, slug }: {
     password?: string;
     token?: string;
+    key?: string;
+    slug?: string;
 }, opts?: Oazapfts.RequestOpts): Promise<SharedLinkResponseDto>;
+/**
+ * This endpoint requires the `sharedLink.delete` permission.
+ */
 export declare function removeSharedLink({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint requires the `sharedLink.read` permission.
+ */
 export declare function getSharedLinkById({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<SharedLinkResponseDto>;
+/**
+ * This endpoint requires the `sharedLink.update` permission.
+ */
 export declare function updateSharedLink({ id, sharedLinkEditDto }: {
     id: string;
     sharedLinkEditDto: SharedLinkEditDto;
 }, opts?: Oazapfts.RequestOpts): Promise<SharedLinkResponseDto>;
-export declare function removeSharedLinkAssets({ id, key, assetIdsDto }: {
+export declare function removeSharedLinkAssets({ id, key, slug, assetIdsDto }: {
     id: string;
     key?: string;
+    slug?: string;
     assetIdsDto: AssetIdsDto;
 }, opts?: Oazapfts.RequestOpts): Promise<AssetIdsResponseDto[]>;
-export declare function addSharedLinkAssets({ id, key, assetIdsDto }: {
+export declare function addSharedLinkAssets({ id, key, slug, assetIdsDto }: {
     id: string;
     key?: string;
+    slug?: string;
     assetIdsDto: AssetIdsDto;
 }, opts?: Oazapfts.RequestOpts): Promise<AssetIdsResponseDto[]>;
+/**
+ * This endpoint requires the `stack.delete` permission.
+ */
 export declare function deleteStacks({ bulkIdsDto }: {
     bulkIdsDto: BulkIdsDto;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint requires the `stack.read` permission.
+ */
 export declare function searchStacks({ primaryAssetId }: {
     primaryAssetId?: string;
 }, opts?: Oazapfts.RequestOpts): Promise<StackResponseDto[]>;
+/**
+ * This endpoint requires the `stack.create` permission.
+ */
 export declare function createStack({ stackCreateDto }: {
     stackCreateDto: StackCreateDto;
 }, opts?: Oazapfts.RequestOpts): Promise<StackResponseDto>;
+/**
+ * This endpoint requires the `stack.delete` permission.
+ */
 export declare function deleteStack({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint requires the `stack.read` permission.
+ */
 export declare function getStack({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<StackResponseDto>;
+/**
+ * This endpoint requires the `stack.update` permission.
+ */
 export declare function updateStack({ id, stackUpdateDto }: {
     id: string;
     stackUpdateDto: StackUpdateDto;
 }, opts?: Oazapfts.RequestOpts): Promise<StackResponseDto>;
+/**
+ * This endpoint requires the `stack.update` permission.
+ */
 export declare function removeAssetFromStack({ assetId, id }: {
     assetId: string;
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint requires the `syncCheckpoint.delete` permission.
+ */
 export declare function deleteSyncAck({ syncAckDeleteDto }: {
     syncAckDeleteDto: SyncAckDeleteDto;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint requires the `syncCheckpoint.read` permission.
+ */
 export declare function getSyncAck(opts?: Oazapfts.RequestOpts): Promise<SyncAckDto[]>;
+/**
+ * This endpoint requires the `syncCheckpoint.update` permission.
+ */
 export declare function sendSyncAck({ syncAckSetDto }: {
     syncAckSetDto: SyncAckSetDto;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
@@ -2104,56 +2537,114 @@ export declare function getDeltaSync({ assetDeltaSyncDto }: {
 export declare function getFullSyncForUser({ assetFullSyncDto }: {
     assetFullSyncDto: AssetFullSyncDto;
 }, opts?: Oazapfts.RequestOpts): Promise<AssetResponseDto[]>;
+/**
+ * This endpoint requires the `sync.stream` permission.
+ */
 export declare function getSyncStream({ syncStreamDto }: {
     syncStreamDto: SyncStreamDto;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
+ */
 export declare function getConfig(opts?: Oazapfts.RequestOpts): Promise<SystemConfigDto>;
+/**
+ * This endpoint is an admin-only route, and requires the `systemConfig.update` permission.
+ */
 export declare function updateConfig({ systemConfigDto }: {
     systemConfigDto: SystemConfigDto;
 }, opts?: Oazapfts.RequestOpts): Promise<SystemConfigDto>;
+/**
+ * This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
+ */
 export declare function getConfigDefaults(opts?: Oazapfts.RequestOpts): Promise<SystemConfigDto>;
+/**
+ * This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
+ */
 export declare function getStorageTemplateOptions(opts?: Oazapfts.RequestOpts): Promise<SystemConfigTemplateStorageOptionDto>;
+/**
+ * This endpoint is an admin-only route, and requires the `systemMetadata.read` permission.
+ */
 export declare function getAdminOnboarding(opts?: Oazapfts.RequestOpts): Promise<AdminOnboardingUpdateDto>;
+/**
+ * This endpoint is an admin-only route, and requires the `systemMetadata.update` permission.
+ */
 export declare function updateAdminOnboarding({ adminOnboardingUpdateDto }: {
     adminOnboardingUpdateDto: AdminOnboardingUpdateDto;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint is an admin-only route, and requires the `systemMetadata.read` permission.
+ */
 export declare function getReverseGeocodingState(opts?: Oazapfts.RequestOpts): Promise<ReverseGeocodingStateResponseDto>;
+/**
+ * This endpoint is an admin-only route, and requires the `systemMetadata.read` permission.
+ */
 export declare function getVersionCheckState(opts?: Oazapfts.RequestOpts): Promise<VersionCheckStateResponseDto>;
+/**
+ * This endpoint requires the `tag.read` permission.
+ */
 export declare function getAllTags(opts?: Oazapfts.RequestOpts): Promise<TagResponseDto[]>;
+/**
+ * This endpoint requires the `tag.create` permission.
+ */
 export declare function createTag({ tagCreateDto }: {
     tagCreateDto: TagCreateDto;
 }, opts?: Oazapfts.RequestOpts): Promise<TagResponseDto>;
+/**
+ * This endpoint requires the `tag.create` permission.
+ */
 export declare function upsertTags({ tagUpsertDto }: {
     tagUpsertDto: TagUpsertDto;
 }, opts?: Oazapfts.RequestOpts): Promise<TagResponseDto[]>;
+/**
+ * This endpoint requires the `tag.asset` permission.
+ */
 export declare function bulkTagAssets({ tagBulkAssetsDto }: {
     tagBulkAssetsDto: TagBulkAssetsDto;
 }, opts?: Oazapfts.RequestOpts): Promise<TagBulkAssetsResponseDto>;
+/**
+ * This endpoint requires the `tag.delete` permission.
+ */
 export declare function deleteTag({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint requires the `tag.read` permission.
+ */
 export declare function getTagById({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<TagResponseDto>;
+/**
+ * This endpoint requires the `tag.update` permission.
+ */
 export declare function updateTag({ id, tagUpdateDto }: {
     id: string;
     tagUpdateDto: TagUpdateDto;
 }, opts?: Oazapfts.RequestOpts): Promise<TagResponseDto>;
+/**
+ * This endpoint requires the `tag.asset` permission.
+ */
 export declare function untagAssets({ id, bulkIdsDto }: {
     id: string;
     bulkIdsDto: BulkIdsDto;
 }, opts?: Oazapfts.RequestOpts): Promise<BulkIdResponseDto[]>;
+/**
+ * This endpoint requires the `tag.asset` permission.
+ */
 export declare function tagAssets({ id, bulkIdsDto }: {
     id: string;
     bulkIdsDto: BulkIdsDto;
 }, opts?: Oazapfts.RequestOpts): Promise<BulkIdResponseDto[]>;
-export declare function getTimeBucket({ albumId, isFavorite, isTrashed, key, order, personId, tagId, timeBucket, userId, visibility, withPartners, withStacked }: {
+/**
+ * This endpoint requires the `asset.read` permission.
+ */
+export declare function getTimeBucket({ albumId, isFavorite, isTrashed, key, order, personId, slug, tagId, timeBucket, userId, visibility, withPartners, withStacked }: {
     albumId?: string;
     isFavorite?: boolean;
     isTrashed?: boolean;
     key?: string;
     order?: AssetOrder;
     personId?: string;
+    slug?: string;
     tagId?: string;
     timeBucket: string;
     userId?: string;
@@ -2161,50 +2652,108 @@ export declare function getTimeBucket({ albumId, isFavorite, isTrashed, key, ord
     withPartners?: boolean;
     withStacked?: boolean;
 }, opts?: Oazapfts.RequestOpts): Promise<TimeBucketAssetResponseDto>;
-export declare function getTimeBuckets({ albumId, isFavorite, isTrashed, key, order, personId, tagId, userId, visibility, withPartners, withStacked }: {
+/**
+ * This endpoint requires the `asset.read` permission.
+ */
+export declare function getTimeBuckets({ albumId, isFavorite, isTrashed, key, order, personId, slug, tagId, userId, visibility, withPartners, withStacked }: {
     albumId?: string;
     isFavorite?: boolean;
     isTrashed?: boolean;
     key?: string;
     order?: AssetOrder;
     personId?: string;
+    slug?: string;
     tagId?: string;
     userId?: string;
     visibility?: AssetVisibility;
     withPartners?: boolean;
     withStacked?: boolean;
 }, opts?: Oazapfts.RequestOpts): Promise<TimeBucketsResponseDto[]>;
+/**
+ * This endpoint requires the `asset.delete` permission.
+ */
 export declare function emptyTrash(opts?: Oazapfts.RequestOpts): Promise<TrashResponseDto>;
+/**
+ * This endpoint requires the `asset.delete` permission.
+ */
 export declare function restoreTrash(opts?: Oazapfts.RequestOpts): Promise<TrashResponseDto>;
+/**
+ * This endpoint requires the `asset.delete` permission.
+ */
 export declare function restoreAssets({ bulkIdsDto }: {
     bulkIdsDto: BulkIdsDto;
 }, opts?: Oazapfts.RequestOpts): Promise<TrashResponseDto>;
+/**
+ * This endpoint requires the `user.read` permission.
+ */
 export declare function searchUsers(opts?: Oazapfts.RequestOpts): Promise<UserResponseDto[]>;
+/**
+ * This endpoint requires the `user.read` permission.
+ */
 export declare function getMyUser(opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
+/**
+ * This endpoint requires the `user.update` permission.
+ */
 export declare function updateMyUser({ userUpdateMeDto }: {
     userUpdateMeDto: UserUpdateMeDto;
 }, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
+/**
+ * This endpoint requires the `userLicense.delete` permission.
+ */
 export declare function deleteUserLicense(opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint requires the `userLicense.read` permission.
+ */
 export declare function getUserLicense(opts?: Oazapfts.RequestOpts): Promise<LicenseResponseDto>;
+/**
+ * This endpoint requires the `userLicense.update` permission.
+ */
 export declare function setUserLicense({ licenseKeyDto }: {
     licenseKeyDto: LicenseKeyDto;
 }, opts?: Oazapfts.RequestOpts): Promise<LicenseResponseDto>;
+/**
+ * This endpoint requires the `userOnboarding.delete` permission.
+ */
 export declare function deleteUserOnboarding(opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint requires the `userOnboarding.read` permission.
+ */
 export declare function getUserOnboarding(opts?: Oazapfts.RequestOpts): Promise<OnboardingResponseDto>;
+/**
+ * This endpoint requires the `userOnboarding.update` permission.
+ */
 export declare function setUserOnboarding({ onboardingDto }: {
     onboardingDto: OnboardingDto;
 }, opts?: Oazapfts.RequestOpts): Promise<OnboardingResponseDto>;
+/**
+ * This endpoint requires the `userPreference.read` permission.
+ */
 export declare function getMyPreferences(opts?: Oazapfts.RequestOpts): Promise<UserPreferencesResponseDto>;
+/**
+ * This endpoint requires the `userPreference.update` permission.
+ */
 export declare function updateMyPreferences({ userPreferencesUpdateDto }: {
     userPreferencesUpdateDto: UserPreferencesUpdateDto;
 }, opts?: Oazapfts.RequestOpts): Promise<UserPreferencesResponseDto>;
+/**
+ * This endpoint requires the `userProfileImage.delete` permission.
+ */
 export declare function deleteProfileImage(opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * This endpoint requires the `userProfileImage.update` permission.
+ */
 export declare function createProfileImage({ createProfileImageDto }: {
     createProfileImageDto: CreateProfileImageDto;
 }, opts?: Oazapfts.RequestOpts): Promise<CreateProfileImageResponseDto>;
+/**
+ * This endpoint requires the `user.read` permission.
+ */
 export declare function getUser({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<UserResponseDto>;
+/**
+ * This endpoint requires the `userProfileImage.read` permission.
+ */
 export declare function getProfileImage({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<Blob>;
@@ -2294,25 +2843,35 @@ export declare enum Permission {
     AssetRead = "asset.read",
     AssetUpdate = "asset.update",
     AssetDelete = "asset.delete",
+    AssetStatistics = "asset.statistics",
     AssetShare = "asset.share",
     AssetView = "asset.view",
     AssetDownload = "asset.download",
     AssetUpload = "asset.upload",
+    AssetReplace = "asset.replace",
     AlbumCreate = "album.create",
     AlbumRead = "album.read",
     AlbumUpdate = "album.update",
     AlbumDelete = "album.delete",
     AlbumStatistics = "album.statistics",
-    AlbumAddAsset = "album.addAsset",
-    AlbumRemoveAsset = "album.removeAsset",
     AlbumShare = "album.share",
     AlbumDownload = "album.download",
+    AlbumAssetCreate = "albumAsset.create",
+    AlbumAssetDelete = "albumAsset.delete",
+    AlbumUserCreate = "albumUser.create",
+    AlbumUserUpdate = "albumUser.update",
+    AlbumUserDelete = "albumUser.delete",
+    AuthChangePassword = "auth.changePassword",
     AuthDeviceDelete = "authDevice.delete",
     ArchiveRead = "archive.read",
+    DuplicateRead = "duplicate.read",
+    DuplicateDelete = "duplicate.delete",
     FaceCreate = "face.create",
     FaceRead = "face.read",
     FaceUpdate = "face.update",
     FaceDelete = "face.delete",
+    JobCreate = "job.create",
+    JobRead = "job.read",
     LibraryCreate = "library.create",
     LibraryRead = "library.read",
     LibraryUpdate = "library.update",
@@ -2324,6 +2883,9 @@ export declare enum Permission {
     MemoryRead = "memory.read",
     MemoryUpdate = "memory.update",
     MemoryDelete = "memory.delete",
+    MemoryStatistics = "memory.statistics",
+    MemoryAssetCreate = "memoryAsset.create",
+    MemoryAssetDelete = "memoryAsset.delete",
     NotificationCreate = "notification.create",
     NotificationRead = "notification.read",
     NotificationUpdate = "notification.update",
@@ -2339,6 +2901,16 @@ export declare enum Permission {
     PersonStatistics = "person.statistics",
     PersonMerge = "person.merge",
     PersonReassign = "person.reassign",
+    PinCodeCreate = "pinCode.create",
+    PinCodeUpdate = "pinCode.update",
+    PinCodeDelete = "pinCode.delete",
+    ServerAbout = "server.about",
+    ServerApkLinks = "server.apkLinks",
+    ServerStorage = "server.storage",
+    ServerStatistics = "server.statistics",
+    ServerLicenseRead = "serverLicense.read",
+    ServerLicenseUpdate = "serverLicense.update",
+    ServerLicenseDelete = "serverLicense.delete",
     SessionCreate = "session.create",
     SessionRead = "session.read",
     SessionUpdate = "session.update",
@@ -2352,6 +2924,10 @@ export declare enum Permission {
     StackRead = "stack.read",
     StackUpdate = "stack.update",
     StackDelete = "stack.delete",
+    SyncStream = "sync.stream",
+    SyncCheckpointRead = "syncCheckpoint.read",
+    SyncCheckpointUpdate = "syncCheckpoint.update",
+    SyncCheckpointDelete = "syncCheckpoint.delete",
     SystemConfigRead = "systemConfig.read",
     SystemConfigUpdate = "systemConfig.update",
     SystemMetadataRead = "systemMetadata.read",
@@ -2361,10 +2937,25 @@ export declare enum Permission {
     TagUpdate = "tag.update",
     TagDelete = "tag.delete",
     TagAsset = "tag.asset",
-    AdminUserCreate = "admin.user.create",
-    AdminUserRead = "admin.user.read",
-    AdminUserUpdate = "admin.user.update",
-    AdminUserDelete = "admin.user.delete"
+    UserRead = "user.read",
+    UserUpdate = "user.update",
+    UserLicenseCreate = "userLicense.create",
+    UserLicenseRead = "userLicense.read",
+    UserLicenseUpdate = "userLicense.update",
+    UserLicenseDelete = "userLicense.delete",
+    UserOnboardingRead = "userOnboarding.read",
+    UserOnboardingUpdate = "userOnboarding.update",
+    UserOnboardingDelete = "userOnboarding.delete",
+    UserPreferenceRead = "userPreference.read",
+    UserPreferenceUpdate = "userPreference.update",
+    UserProfileImageCreate = "userProfileImage.create",
+    UserProfileImageRead = "userProfileImage.read",
+    UserProfileImageUpdate = "userProfileImage.update",
+    UserProfileImageDelete = "userProfileImage.delete",
+    AdminUserCreate = "adminUser.create",
+    AdminUserRead = "adminUser.read",
+    AdminUserUpdate = "adminUser.update",
+    AdminUserDelete = "adminUser.delete"
 }
 export declare enum AssetMediaStatus {
     Created = "created",