@immich/sdk 2.4.1 → 2.5.2

package/.nvmrc

@@ -1 +1 @@
-24.11.1
+24.13.0

package/build/fetch-client.d.ts

@@ -1,6 +1,6 @@
 /**
  * Immich
- * 2.4.1
+ * 2.5.2
  * DO NOT MODIFY - This file has been generated using oazapfts.
  * See https://www.npmjs.com/package/oazapfts
  */
@@ -35,8 +35,31 @@ export type ActivityStatisticsResponseDto = {
     comments: number;
     likes: number;
 };
+export type DatabaseBackupDeleteDto = {
+    backups: string[];
+};
+export type DatabaseBackupDto = {
+    filename: string;
+    filesize: number;
+};
+export type DatabaseBackupListResponseDto = {
+    backups: DatabaseBackupDto[];
+};
+export type DatabaseBackupUploadDto = {
+    file?: Blob;
+};
 export type SetMaintenanceModeDto = {
     action: MaintenanceAction;
+    restoreBackupFilename?: string;
+};
+export type MaintenanceDetectInstallStorageFolderDto = {
+    files: number;
+    folder: StorageFolder;
+    readable: boolean;
+    writable: boolean;
+};
+export type MaintenanceDetectInstallResponseDto = {
+    storage: MaintenanceDetectInstallStorageFolderDto[];
 };
 export type MaintenanceLoginDto = {
     token?: string;
@@ -44,6 +67,13 @@ export type MaintenanceLoginDto = {
 export type MaintenanceAuthDto = {
     username: string;
 };
+export type MaintenanceStatusResponseDto = {
+    action: MaintenanceAction;
+    active: boolean;
+    error?: string;
+    progress?: number;
+    task?: string;
+};
 export type NotificationCreateDto = {
     data?: object;
     description?: string | null;
@@ -344,8 +374,10 @@ export type AssetResponseDto = {
     /** The UTC timestamp when the file was last modified on the filesystem. This reflects the last time the physical file was changed, which may be different from when the photo was originally taken. */
     fileModifiedAt: string;
     hasMetadata: boolean;
+    height: number | null;
     id: string;
     isArchived: boolean;
+    isEdited: boolean;
     isFavorite: boolean;
     isOffline: boolean;
     isTrashed: boolean;
@@ -368,6 +400,7 @@ export type AssetResponseDto = {
     /** The UTC timestamp when the asset record was last updated in the database. This is automatically maintained by the database and reflects when any field in the asset was last modified. */
     updatedAt: string;
     visibility: AssetVisibility;
+    width: number | null;
 };
 export type ContributorCountResponseDto = {
     assetCount: number;
@@ -466,7 +499,7 @@ export type AssetBulkDeleteDto = {
     ids: string[];
 };
 export type AssetMetadataUpsertItemDto = {
-    key: AssetMetadataKey;
+    key: string;
     value: object;
 };
 export type AssetMediaCreateDto = {
@@ -479,7 +512,7 @@ export type AssetMediaCreateDto = {
     filename?: string;
     isFavorite?: boolean;
     livePhotoVideoId?: string;
-    metadata: AssetMetadataUpsertItemDto[];
+    metadata?: AssetMetadataUpsertItemDto[];
     sidecarData?: Blob;
     visibility?: AssetVisibility;
 };
@@ -538,6 +571,27 @@ export type AssetJobsDto = {
     assetIds: string[];
     name: AssetJobName;
 };
+export type AssetMetadataBulkDeleteItemDto = {
+    assetId: string;
+    key: string;
+};
+export type AssetMetadataBulkDeleteDto = {
+    items: AssetMetadataBulkDeleteItemDto[];
+};
+export type AssetMetadataBulkUpsertItemDto = {
+    assetId: string;
+    key: string;
+    value: object;
+};
+export type AssetMetadataBulkUpsertDto = {
+    items: AssetMetadataBulkUpsertItemDto[];
+};
+export type AssetMetadataBulkResponseDto = {
+    assetId: string;
+    key: string;
+    updatedAt: string;
+    value: object;
+};
 export type UpdateAssetDto = {
     dateTimeOriginal?: string;
     description?: string;
@@ -548,8 +602,47 @@ export type UpdateAssetDto = {
     rating?: number;
     visibility?: AssetVisibility;
 };
+export type CropParameters = {
+    /** Height of the crop */
+    height: number;
+    /** Width of the crop */
+    width: number;
+    /** Top-Left X coordinate of crop */
+    x: number;
+    /** Top-Left Y coordinate of crop */
+    y: number;
+};
+export type AssetEditActionCrop = {
+    action: AssetEditAction;
+    parameters: CropParameters;
+};
+export type RotateParameters = {
+    /** Rotation angle in degrees */
+    angle: number;
+};
+export type AssetEditActionRotate = {
+    action: AssetEditAction;
+    parameters: RotateParameters;
+};
+export type MirrorParameters = {
+    /** Axis to mirror along */
+    axis: MirrorAxis;
+};
+export type AssetEditActionMirror = {
+    action: AssetEditAction;
+    parameters: MirrorParameters;
+};
+export type AssetEditsDto = {
+    assetId: string;
+    /** list of edits */
+    edits: (AssetEditActionCrop | AssetEditActionRotate | AssetEditActionMirror)[];
+};
+export type AssetEditActionListDto = {
+    /** list of edits */
+    edits: (AssetEditActionCrop | AssetEditActionRotate | AssetEditActionMirror)[];
+};
 export type AssetMetadataResponseDto = {
-    key: AssetMetadataKey;
+    key: string;
     updatedAt: string;
     value: object;
 };
@@ -723,6 +816,7 @@ export type QueuesResponseLegacyDto = {
     backgroundTask: QueueResponseLegacyDto;
     backupDatabase: QueueResponseLegacyDto;
     duplicateDetection: QueueResponseLegacyDto;
+    editor: QueueResponseLegacyDto;
     faceDetection: QueueResponseLegacyDto;
     facialRecognition: QueueResponseLegacyDto;
     library: QueueResponseLegacyDto;
@@ -937,7 +1031,7 @@ export type PluginActionResponseDto = {
     methodName: string;
     pluginId: string;
     schema: object | null;
-    supportedContexts: PluginContext[];
+    supportedContexts: PluginContextType[];
     title: string;
 };
 export type PluginFilterResponseDto = {
@@ -946,7 +1040,7 @@ export type PluginFilterResponseDto = {
     methodName: string;
     pluginId: string;
     schema: object | null;
-    supportedContexts: PluginContext[];
+    supportedContexts: PluginContextType[];
     title: string;
 };
 export type PluginResponseDto = {
@@ -961,6 +1055,10 @@ export type PluginResponseDto = {
     updatedAt: string;
     version: string;
 };
+export type PluginTriggerResponseDto = {
+    contextType: PluginContextType;
+    "type": PluginTriggerType;
+};
 export type QueueResponseDto = {
     isPaused: boolean;
     name: QueueName;
@@ -1435,10 +1533,12 @@ export type SystemConfigFFmpegDto = {
 export type SystemConfigGeneratedFullsizeImageDto = {
     enabled: boolean;
     format: ImageFormat;
+    progressive?: boolean;
     quality: number;
 };
 export type SystemConfigGeneratedImageDto = {
     format: ImageFormat;
+    progressive?: boolean;
     quality: number;
     size: number;
 };
@@ -1454,6 +1554,7 @@ export type JobSettingsDto = {
 };
 export type SystemConfigJobDto = {
     backgroundTask: JobSettingsDto;
+    editor: JobSettingsDto;
     faceDetection: JobSettingsDto;
     library: JobSettingsDto;
     metadataExtraction: JobSettingsDto;
@@ -1745,7 +1846,7 @@ export type WorkflowResponseDto = {
     id: string;
     name: string | null;
     ownerId: string;
-    triggerType: TriggerType;
+    triggerType: PluginTriggerType;
 };
 export type WorkflowActionItemDto = {
     actionConfig?: object;
@@ -1769,6 +1870,211 @@ export type WorkflowUpdateDto = {
     enabled?: boolean;
     filters?: WorkflowFilterItemDto[];
     name?: string;
+    triggerType?: PluginTriggerType;
+};
+export type SyncAckV1 = {};
+export type SyncAlbumDeleteV1 = {
+    albumId: string;
+};
+export type SyncAlbumToAssetDeleteV1 = {
+    albumId: string;
+    assetId: string;
+};
+export type SyncAlbumToAssetV1 = {
+    albumId: string;
+    assetId: string;
+};
+export type SyncAlbumUserDeleteV1 = {
+    albumId: string;
+    userId: string;
+};
+export type SyncAlbumUserV1 = {
+    albumId: string;
+    role: AlbumUserRole;
+    userId: string;
+};
+export type SyncAlbumV1 = {
+    createdAt: string;
+    description: string;
+    id: string;
+    isActivityEnabled: boolean;
+    name: string;
+    order: AssetOrder;
+    ownerId: string;
+    thumbnailAssetId: string | null;
+    updatedAt: string;
+};
+export type SyncAssetDeleteV1 = {
+    assetId: string;
+};
+export type SyncAssetExifV1 = {
+    assetId: string;
+    city: string | null;
+    country: string | null;
+    dateTimeOriginal: string | null;
+    description: string | null;
+    exifImageHeight: number | null;
+    exifImageWidth: number | null;
+    exposureTime: string | null;
+    fNumber: number | null;
+    fileSizeInByte: number | null;
+    focalLength: number | null;
+    fps: number | null;
+    iso: number | null;
+    latitude: number | null;
+    lensModel: string | null;
+    longitude: number | null;
+    make: string | null;
+    model: string | null;
+    modifyDate: string | null;
+    orientation: string | null;
+    profileDescription: string | null;
+    projectionType: string | null;
+    rating: number | null;
+    state: string | null;
+    timeZone: string | null;
+};
+export type SyncAssetFaceDeleteV1 = {
+    assetFaceId: string;
+};
+export type SyncAssetFaceV1 = {
+    assetId: string;
+    boundingBoxX1: number;
+    boundingBoxX2: number;
+    boundingBoxY1: number;
+    boundingBoxY2: number;
+    id: string;
+    imageHeight: number;
+    imageWidth: number;
+    personId: string | null;
+    sourceType: string;
+};
+export type SyncAssetMetadataDeleteV1 = {
+    assetId: string;
+    key: string;
+};
+export type SyncAssetMetadataV1 = {
+    assetId: string;
+    key: string;
+    value: object;
+};
+export type SyncAssetV1 = {
+    checksum: string;
+    deletedAt: string | null;
+    duration: string | null;
+    fileCreatedAt: string | null;
+    fileModifiedAt: string | null;
+    height: number | null;
+    id: string;
+    isEdited: boolean;
+    isFavorite: boolean;
+    libraryId: string | null;
+    livePhotoVideoId: string | null;
+    localDateTime: string | null;
+    originalFileName: string;
+    ownerId: string;
+    stackId: string | null;
+    thumbhash: string | null;
+    "type": AssetTypeEnum;
+    visibility: AssetVisibility;
+    width: number | null;
+};
+export type SyncAuthUserV1 = {
+    avatarColor: (UserAvatarColor) | null;
+    deletedAt: string | null;
+    email: string;
+    hasProfileImage: boolean;
+    id: string;
+    isAdmin: boolean;
+    name: string;
+    oauthId: string;
+    pinCode: string | null;
+    profileChangedAt: string;
+    quotaSizeInBytes: number | null;
+    quotaUsageInBytes: number;
+    storageLabel: string | null;
+};
+export type SyncCompleteV1 = {};
+export type SyncMemoryAssetDeleteV1 = {
+    assetId: string;
+    memoryId: string;
+};
+export type SyncMemoryAssetV1 = {
+    assetId: string;
+    memoryId: string;
+};
+export type SyncMemoryDeleteV1 = {
+    memoryId: string;
+};
+export type SyncMemoryV1 = {
+    createdAt: string;
+    data: object;
+    deletedAt: string | null;
+    hideAt: string | null;
+    id: string;
+    isSaved: boolean;
+    memoryAt: string;
+    ownerId: string;
+    seenAt: string | null;
+    showAt: string | null;
+    "type": MemoryType;
+    updatedAt: string;
+};
+export type SyncPartnerDeleteV1 = {
+    sharedById: string;
+    sharedWithId: string;
+};
+export type SyncPartnerV1 = {
+    inTimeline: boolean;
+    sharedById: string;
+    sharedWithId: string;
+};
+export type SyncPersonDeleteV1 = {
+    personId: string;
+};
+export type SyncPersonV1 = {
+    birthDate: string | null;
+    color: string | null;
+    createdAt: string;
+    faceAssetId: string | null;
+    id: string;
+    isFavorite: boolean;
+    isHidden: boolean;
+    name: string;
+    ownerId: string;
+    updatedAt: string;
+};
+export type SyncResetV1 = {};
+export type SyncStackDeleteV1 = {
+    stackId: string;
+};
+export type SyncStackV1 = {
+    createdAt: string;
+    id: string;
+    ownerId: string;
+    primaryAssetId: string;
+    updatedAt: string;
+};
+export type SyncUserDeleteV1 = {
+    userId: string;
+};
+export type SyncUserMetadataDeleteV1 = {
+    key: UserMetadataKey;
+    userId: string;
+};
+export type SyncUserMetadataV1 = {
+    key: UserMetadataKey;
+    userId: string;
+    value: object;
+};
+export type SyncUserV1 = {
+    avatarColor: (UserAvatarColor) | null;
+    deletedAt: string | null;
+    email: string;
+    hasProfileImage: boolean;
+    id: string;
+    name: string;
+    profileChangedAt: string;
 };
 /**
  * List all activities
@@ -1803,18 +2109,52 @@ export declare function deleteActivity({ id }: {
  * Unlink all OAuth accounts
  */
 export declare function unlinkAllOAuthAccountsAdmin(opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * Delete database backup
+ */
+export declare function deleteDatabaseBackup({ databaseBackupDeleteDto }: {
+    databaseBackupDeleteDto: DatabaseBackupDeleteDto;
+}, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * List database backups
+ */
+export declare function listDatabaseBackups(opts?: Oazapfts.RequestOpts): Promise<DatabaseBackupListResponseDto>;
+/**
+ * Start database backup restore flow
+ */
+export declare function startDatabaseRestoreFlow(opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * Upload database backup
+ */
+export declare function uploadDatabaseBackup({ databaseBackupUploadDto }: {
+    databaseBackupUploadDto: DatabaseBackupUploadDto;
+}, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * Download database backup
+ */
+export declare function downloadDatabaseBackup({ filename }: {
+    filename: string;
+}, opts?: Oazapfts.RequestOpts): Promise<Blob>;
 /**
  * Set maintenance mode
  */
 export declare function setMaintenanceMode({ setMaintenanceModeDto }: {
     setMaintenanceModeDto: SetMaintenanceModeDto;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * Detect existing install
+ */
+export declare function detectPriorInstall(opts?: Oazapfts.RequestOpts): Promise<MaintenanceDetectInstallResponseDto>;
 /**
  * Log into maintenance mode
  */
 export declare function maintenanceLogin({ maintenanceLoginDto }: {
     maintenanceLoginDto: MaintenanceLoginDto;
 }, opts?: Oazapfts.RequestOpts): Promise<MaintenanceAuthDto>;
+/**
+ * Get maintenance mode status
+ */
+export declare function getMaintenanceStatus(opts?: Oazapfts.RequestOpts): Promise<MaintenanceStatusResponseDto>;
 /**
  * Create a notification
  */
@@ -2070,6 +2410,18 @@ export declare function checkExistingAssets({ checkExistingAssetsDto }: {
 export declare function runAssetJobs({ assetJobsDto }: {
     assetJobsDto: AssetJobsDto;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * Delete asset metadata
+ */
+export declare function deleteBulkAssetMetadata({ assetMetadataBulkDeleteDto }: {
+    assetMetadataBulkDeleteDto: AssetMetadataBulkDeleteDto;
+}, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * Upsert asset metadata
+ */
+export declare function updateBulkAssetMetadata({ assetMetadataBulkUpsertDto }: {
+    assetMetadataBulkUpsertDto: AssetMetadataBulkUpsertDto;
+}, opts?: Oazapfts.RequestOpts): Promise<AssetMetadataBulkResponseDto[]>;
 /**
  * Get random assets
  */
@@ -2099,6 +2451,25 @@ export declare function updateAsset({ id, updateAssetDto }: {
     id: string;
     updateAssetDto: UpdateAssetDto;
 }, opts?: Oazapfts.RequestOpts): Promise<AssetResponseDto>;
+/**
+ * Remove edits from an existing asset
+ */
+export declare function removeAssetEdits({ id }: {
+    id: string;
+}, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * Retrieve edits for an existing asset
+ */
+export declare function getAssetEdits({ id }: {
+    id: string;
+}, opts?: Oazapfts.RequestOpts): Promise<AssetEditsDto>;
+/**
+ * Apply edits to an existing asset
+ */
+export declare function editAsset({ id, assetEditActionListDto }: {
+    id: string;
+    assetEditActionListDto: AssetEditActionListDto;
+}, opts?: Oazapfts.RequestOpts): Promise<AssetEditsDto>;
 /**
  * Get asset metadata
  */
@@ -2117,14 +2488,14 @@ export declare function updateAssetMetadata({ id, assetMetadataUpsertDto }: {
  */
 export declare function deleteAssetMetadata({ id, key }: {
     id: string;
-    key: AssetMetadataKey;
+    key: string;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
 /**
  * Retrieve asset metadata by key
  */
 export declare function getAssetMetadataByKey({ id, key }: {
     id: string;
-    key: AssetMetadataKey;
+    key: string;
 }, opts?: Oazapfts.RequestOpts): Promise<AssetMetadataResponseDto>;
 /**
  * Retrieve asset OCR data
@@ -2135,7 +2506,8 @@ export declare function getAssetOcr({ id }: {
 /**
  * Download original asset
  */
-export declare function downloadAsset({ id, key, slug }: {
+export declare function downloadAsset({ edited, id, key, slug }: {
+    edited?: boolean;
     id: string;
     key?: string;
     slug?: string;
@@ -2152,7 +2524,8 @@ export declare function replaceAsset({ id, key, slug, assetMediaReplaceDto }: {
 /**
  * View asset thumbnail
  */
-export declare function viewAsset({ id, key, size, slug }: {
+export declare function viewAsset({ edited, id, key, size, slug }: {
+    edited?: boolean;
     id: string;
     key?: string;
     size?: AssetMediaSize;
@@ -2600,6 +2973,10 @@ export declare function getPersonThumbnail({ id }: {
  * List all plugins
  */
 export declare function getPlugins(opts?: Oazapfts.RequestOpts): Promise<PluginResponseDto[]>;
+/**
+ * List all plugin triggers
+ */
+export declare function getPluginTriggers(opts?: Oazapfts.RequestOpts): Promise<PluginTriggerResponseDto[]>;
 /**
  * Retrieve a plugin
  */
@@ -2829,8 +3206,9 @@ export declare function lockSession({ id }: {
 /**
  * Retrieve all shared links
  */
-export declare function getAllSharedLinks({ albumId }: {
+export declare function getAllSharedLinks({ albumId, id }: {
     albumId?: string;
+    id?: string;
 }, opts?: Oazapfts.RequestOpts): Promise<SharedLinkResponseDto[]>;
 /**
  * Create a shared link
@@ -3239,7 +3617,17 @@ export declare enum UserAvatarColor {
 }
 export declare enum MaintenanceAction {
     Start = "start",
-    End = "end"
+    End = "end",
+    SelectDatabaseRestore = "select_database_restore",
+    RestoreDatabase = "restore_database"
+}
+export declare enum StorageFolder {
+    EncodedVideo = "encoded-video",
+    Library = "library",
+    Upload = "upload",
+    Profile = "profile",
+    Thumbs = "thumbs",
+    Backups = "backups"
 }
 export declare enum NotificationLevel {
     Success = "success",
@@ -3318,6 +3706,10 @@ export declare enum Permission {
     AssetUpload = "asset.upload",
     AssetReplace = "asset.replace",
     AssetCopy = "asset.copy",
+    AssetDerive = "asset.derive",
+    AssetEditGet = "asset.edit.get",
+    AssetEditCreate = "asset.edit.create",
+    AssetEditDelete = "asset.edit.delete",
     AlbumCreate = "album.create",
     AlbumRead = "album.read",
     AlbumUpdate = "album.update",
@@ -3333,12 +3725,17 @@ export declare enum Permission {
     AuthChangePassword = "auth.changePassword",
     AuthDeviceDelete = "authDevice.delete",
     ArchiveRead = "archive.read",
+    BackupList = "backup.list",
+    BackupDownload = "backup.download",
+    BackupUpload = "backup.upload",
+    BackupDelete = "backup.delete",
     DuplicateRead = "duplicate.read",
     DuplicateDelete = "duplicate.delete",
     FaceCreate = "face.create",
     FaceRead = "face.read",
     FaceUpdate = "face.update",
     FaceDelete = "face.delete",
+    FolderRead = "folder.read",
     JobCreate = "job.create",
     JobRead = "job.read",
     LibraryCreate = "library.create",
@@ -3349,6 +3746,8 @@ export declare enum Permission {
     TimelineRead = "timeline.read",
     TimelineDownload = "timeline.download",
     Maintenance = "maintenance",
+    MapRead = "map.read",
+    MapSearch = "map.search",
     MemoryCreate = "memory.create",
     MemoryRead = "memory.read",
     MemoryUpdate = "memory.update",
@@ -3444,9 +3843,6 @@ export declare enum Permission {
     AdminSessionRead = "adminSession.read",
     AdminAuthUnlinkAll = "adminAuth.unlinkAll"
 }
-export declare enum AssetMetadataKey {
-    MobileApp = "mobile-app"
-}
 export declare enum AssetMediaStatus {
     Created = "created",
     Replaced = "replaced",
@@ -3466,7 +3862,17 @@ export declare enum AssetJobName {
     RegenerateThumbnail = "regenerate-thumbnail",
     TranscodeVideo = "transcode-video"
 }
+export declare enum AssetEditAction {
+    Crop = "crop",
+    Rotate = "rotate",
+    Mirror = "mirror"
+}
+export declare enum MirrorAxis {
+    Horizontal = "horizontal",
+    Vertical = "vertical"
+}
 export declare enum AssetMediaSize {
+    Original = "original",
     Fullsize = "fullsize",
     Preview = "preview",
     Thumbnail = "thumbnail"
@@ -3496,7 +3902,8 @@ export declare enum QueueName {
     Notifications = "notifications",
     BackupDatabase = "backupDatabase",
     Ocr = "ocr",
-    Workflow = "workflow"
+    Workflow = "workflow",
+    Editor = "editor"
 }
 export declare enum QueueCommand {
     Start = "start",
@@ -3517,11 +3924,15 @@ export declare enum PartnerDirection {
     SharedBy = "shared-by",
     SharedWith = "shared-with"
 }
-export declare enum PluginContext {
+export declare enum PluginContextType {
     Asset = "asset",
     Album = "album",
     Person = "person"
 }
+export declare enum PluginTriggerType {
+    AssetCreate = "AssetCreate",
+    PersonRecognized = "PersonRecognized"
+}
 export declare enum QueueJobStatus {
     Active = "active",
     Failed = "failed",
@@ -3537,6 +3948,7 @@ export declare enum JobName {
     AssetDetectFaces = "AssetDetectFaces",
     AssetDetectDuplicatesQueueAll = "AssetDetectDuplicatesQueueAll",
     AssetDetectDuplicates = "AssetDetectDuplicates",
+    AssetEditThumbnailGeneration = "AssetEditThumbnailGeneration",
     AssetEncodeVideoQueueAll = "AssetEncodeVideoQueueAll",
     AssetEncodeVideo = "AssetEncodeVideo",
     AssetEmptyTrash = "AssetEmptyTrash",
@@ -3738,11 +4150,8 @@ export declare enum OAuthTokenEndpointAuthMethod {
     ClientSecretPost = "client_secret_post",
     ClientSecretBasic = "client_secret_basic"
 }
-export declare enum TriggerType {
-    AssetCreate = "AssetCreate",
-    PersonRecognized = "PersonRecognized"
-}
-export declare enum PluginTriggerType {
-    AssetCreate = "AssetCreate",
-    PersonRecognized = "PersonRecognized"
+export declare enum UserMetadataKey {
+    Preferences = "preferences",
+    License = "license",
+    Onboarding = "onboarding"
 }

package/build/fetch-client.js

@@ -1,6 +1,6 @@
 /**
  * Immich
- * 2.4.1
+ * 2.5.2
  * DO NOT MODIFY - This file has been generated using oazapfts.
  * See https://www.npmjs.com/package/oazapfts
  */
@@ -8,7 +8,7 @@ import * as Oazapfts from "@oazapfts/runtime";
 import * as QS from "@oazapfts/runtime/query";
 export const defaults = {
     headers: {},
-    baseUrl: "/api",
+    baseUrl: "/api"
 };
 const oazapfts = Oazapfts.runtime(defaults);
 export const servers = {
@@ -67,6 +67,51 @@ export function unlinkAllOAuthAccountsAdmin(opts) {
         method: "POST"
     }));
 }
+/**
+ * Delete database backup
+ */
+export function deleteDatabaseBackup({ databaseBackupDeleteDto }, opts) {
+    return oazapfts.ok(oazapfts.fetchText("/admin/database-backups", oazapfts.json({
+        ...opts,
+        method: "DELETE",
+        body: databaseBackupDeleteDto
+    })));
+}
+/**
+ * List database backups
+ */
+export function listDatabaseBackups(opts) {
+    return oazapfts.ok(oazapfts.fetchJson("/admin/database-backups", {
+        ...opts
+    }));
+}
+/**
+ * Start database backup restore flow
+ */
+export function startDatabaseRestoreFlow(opts) {
+    return oazapfts.ok(oazapfts.fetchText("/admin/database-backups/start-restore", {
+        ...opts,
+        method: "POST"
+    }));
+}
+/**
+ * Upload database backup
+ */
+export function uploadDatabaseBackup({ databaseBackupUploadDto }, opts) {
+    return oazapfts.ok(oazapfts.fetchText("/admin/database-backups/upload", oazapfts.multipart({
+        ...opts,
+        method: "POST",
+        body: databaseBackupUploadDto
+    })));
+}
+/**
+ * Download database backup
+ */
+export function downloadDatabaseBackup({ filename }, opts) {
+    return oazapfts.ok(oazapfts.fetchBlob(`/admin/database-backups/${encodeURIComponent(filename)}`, {
+        ...opts
+    }));
+}
 /**
  * Set maintenance mode
  */
@@ -77,6 +122,14 @@ export function setMaintenanceMode({ setMaintenanceModeDto }, opts) {
         body: setMaintenanceModeDto
     })));
 }
+/**
+ * Detect existing install
+ */
+export function detectPriorInstall(opts) {
+    return oazapfts.ok(oazapfts.fetchJson("/admin/maintenance/detect-install", {
+        ...opts
+    }));
+}
 /**
  * Log into maintenance mode
  */
@@ -87,6 +140,14 @@ export function maintenanceLogin({ maintenanceLoginDto }, opts) {
         body: maintenanceLoginDto
     })));
 }
+/**
+ * Get maintenance mode status
+ */
+export function getMaintenanceStatus(opts) {
+    return oazapfts.ok(oazapfts.fetchJson("/admin/maintenance/status", {
+        ...opts
+    }));
+}
 /**
  * Create a notification
  */
@@ -475,6 +536,26 @@ export function runAssetJobs({ assetJobsDto }, opts) {
         body: assetJobsDto
     })));
 }
+/**
+ * Delete asset metadata
+ */
+export function deleteBulkAssetMetadata({ assetMetadataBulkDeleteDto }, opts) {
+    return oazapfts.ok(oazapfts.fetchText("/assets/metadata", oazapfts.json({
+        ...opts,
+        method: "DELETE",
+        body: assetMetadataBulkDeleteDto
+    })));
+}
+/**
+ * Upsert asset metadata
+ */
+export function updateBulkAssetMetadata({ assetMetadataBulkUpsertDto }, opts) {
+    return oazapfts.ok(oazapfts.fetchJson("/assets/metadata", oazapfts.json({
+        ...opts,
+        method: "PUT",
+        body: assetMetadataBulkUpsertDto
+    })));
+}
 /**
  * Get random assets
  */
@@ -518,6 +599,33 @@ export function updateAsset({ id, updateAssetDto }, opts) {
         body: updateAssetDto
     })));
 }
+/**
+ * Remove edits from an existing asset
+ */
+export function removeAssetEdits({ id }, opts) {
+    return oazapfts.ok(oazapfts.fetchText(`/assets/${encodeURIComponent(id)}/edits`, {
+        ...opts,
+        method: "DELETE"
+    }));
+}
+/**
+ * Retrieve edits for an existing asset
+ */
+export function getAssetEdits({ id }, opts) {
+    return oazapfts.ok(oazapfts.fetchJson(`/assets/${encodeURIComponent(id)}/edits`, {
+        ...opts
+    }));
+}
+/**
+ * Apply edits to an existing asset
+ */
+export function editAsset({ id, assetEditActionListDto }, opts) {
+    return oazapfts.ok(oazapfts.fetchJson(`/assets/${encodeURIComponent(id)}/edits`, oazapfts.json({
+        ...opts,
+        method: "PUT",
+        body: assetEditActionListDto
+    })));
+}
 /**
  * Get asset metadata
  */
@@ -564,8 +672,9 @@ export function getAssetOcr({ id }, opts) {
 /**
  * Download original asset
  */
-export function downloadAsset({ id, key, slug }, opts) {
+export function downloadAsset({ edited, id, key, slug }, opts) {
     return oazapfts.ok(oazapfts.fetchBlob(`/assets/${encodeURIComponent(id)}/original${QS.query(QS.explode({
+        edited,
         key,
         slug
     }))}`, {
@@ -588,8 +697,9 @@ export function replaceAsset({ id, key, slug, assetMediaReplaceDto }, opts) {
 /**
  * View asset thumbnail
  */
-export function viewAsset({ id, key, size, slug }, opts) {
+export function viewAsset({ edited, id, key, size, slug }, opts) {
     return oazapfts.ok(oazapfts.fetchBlob(`/assets/${encodeURIComponent(id)}/thumbnail${QS.query(QS.explode({
+        edited,
         key,
         size,
         slug
@@ -1289,6 +1399,14 @@ export function getPlugins(opts) {
         ...opts
     }));
 }
+/**
+ * List all plugin triggers
+ */
+export function getPluginTriggers(opts) {
+    return oazapfts.ok(oazapfts.fetchJson("/plugins/triggers", {
+        ...opts
+    }));
+}
 /**
  * Retrieve a plugin
  */
@@ -1659,9 +1777,10 @@ export function lockSession({ id }, opts) {
 /**
  * Retrieve all shared links
  */
-export function getAllSharedLinks({ albumId }, opts) {
+export function getAllSharedLinks({ albumId, id }, opts) {
     return oazapfts.ok(oazapfts.fetchJson(`/shared-links${QS.query(QS.explode({
-        albumId
+        albumId,
+        id
     }))}`, {
         ...opts
     }));
@@ -2315,7 +2434,18 @@ export var MaintenanceAction;
 (function (MaintenanceAction) {
     MaintenanceAction["Start"] = "start";
     MaintenanceAction["End"] = "end";
+    MaintenanceAction["SelectDatabaseRestore"] = "select_database_restore";
+    MaintenanceAction["RestoreDatabase"] = "restore_database";
 })(MaintenanceAction || (MaintenanceAction = {}));
+export var StorageFolder;
+(function (StorageFolder) {
+    StorageFolder["EncodedVideo"] = "encoded-video";
+    StorageFolder["Library"] = "library";
+    StorageFolder["Upload"] = "upload";
+    StorageFolder["Profile"] = "profile";
+    StorageFolder["Thumbs"] = "thumbs";
+    StorageFolder["Backups"] = "backups";
+})(StorageFolder || (StorageFolder = {}));
 export var NotificationLevel;
 (function (NotificationLevel) {
     NotificationLevel["Success"] = "success";
@@ -2404,6 +2534,10 @@ export var Permission;
     Permission["AssetUpload"] = "asset.upload";
     Permission["AssetReplace"] = "asset.replace";
     Permission["AssetCopy"] = "asset.copy";
+    Permission["AssetDerive"] = "asset.derive";
+    Permission["AssetEditGet"] = "asset.edit.get";
+    Permission["AssetEditCreate"] = "asset.edit.create";
+    Permission["AssetEditDelete"] = "asset.edit.delete";
     Permission["AlbumCreate"] = "album.create";
     Permission["AlbumRead"] = "album.read";
     Permission["AlbumUpdate"] = "album.update";
@@ -2419,12 +2553,17 @@ export var Permission;
     Permission["AuthChangePassword"] = "auth.changePassword";
     Permission["AuthDeviceDelete"] = "authDevice.delete";
     Permission["ArchiveRead"] = "archive.read";
+    Permission["BackupList"] = "backup.list";
+    Permission["BackupDownload"] = "backup.download";
+    Permission["BackupUpload"] = "backup.upload";
+    Permission["BackupDelete"] = "backup.delete";
     Permission["DuplicateRead"] = "duplicate.read";
     Permission["DuplicateDelete"] = "duplicate.delete";
     Permission["FaceCreate"] = "face.create";
     Permission["FaceRead"] = "face.read";
     Permission["FaceUpdate"] = "face.update";
     Permission["FaceDelete"] = "face.delete";
+    Permission["FolderRead"] = "folder.read";
     Permission["JobCreate"] = "job.create";
     Permission["JobRead"] = "job.read";
     Permission["LibraryCreate"] = "library.create";
@@ -2435,6 +2574,8 @@ export var Permission;
     Permission["TimelineRead"] = "timeline.read";
     Permission["TimelineDownload"] = "timeline.download";
     Permission["Maintenance"] = "maintenance";
+    Permission["MapRead"] = "map.read";
+    Permission["MapSearch"] = "map.search";
     Permission["MemoryCreate"] = "memory.create";
     Permission["MemoryRead"] = "memory.read";
     Permission["MemoryUpdate"] = "memory.update";
@@ -2530,10 +2671,6 @@ export var Permission;
     Permission["AdminSessionRead"] = "adminSession.read";
     Permission["AdminAuthUnlinkAll"] = "adminAuth.unlinkAll";
 })(Permission || (Permission = {}));
-export var AssetMetadataKey;
-(function (AssetMetadataKey) {
-    AssetMetadataKey["MobileApp"] = "mobile-app";
-})(AssetMetadataKey || (AssetMetadataKey = {}));
 export var AssetMediaStatus;
 (function (AssetMediaStatus) {
     AssetMediaStatus["Created"] = "created";
@@ -2557,8 +2694,20 @@ export var AssetJobName;
     AssetJobName["RegenerateThumbnail"] = "regenerate-thumbnail";
     AssetJobName["TranscodeVideo"] = "transcode-video";
 })(AssetJobName || (AssetJobName = {}));
+export var AssetEditAction;
+(function (AssetEditAction) {
+    AssetEditAction["Crop"] = "crop";
+    AssetEditAction["Rotate"] = "rotate";
+    AssetEditAction["Mirror"] = "mirror";
+})(AssetEditAction || (AssetEditAction = {}));
+export var MirrorAxis;
+(function (MirrorAxis) {
+    MirrorAxis["Horizontal"] = "horizontal";
+    MirrorAxis["Vertical"] = "vertical";
+})(MirrorAxis || (MirrorAxis = {}));
 export var AssetMediaSize;
 (function (AssetMediaSize) {
+    AssetMediaSize["Original"] = "original";
     AssetMediaSize["Fullsize"] = "fullsize";
     AssetMediaSize["Preview"] = "preview";
     AssetMediaSize["Thumbnail"] = "thumbnail";
@@ -2591,6 +2740,7 @@ export var QueueName;
     QueueName["BackupDatabase"] = "backupDatabase";
     QueueName["Ocr"] = "ocr";
     QueueName["Workflow"] = "workflow";
+    QueueName["Editor"] = "editor";
 })(QueueName || (QueueName = {}));
 export var QueueCommand;
 (function (QueueCommand) {
@@ -2615,12 +2765,17 @@ export var PartnerDirection;
     PartnerDirection["SharedBy"] = "shared-by";
     PartnerDirection["SharedWith"] = "shared-with";
 })(PartnerDirection || (PartnerDirection = {}));
-export var PluginContext;
-(function (PluginContext) {
-    PluginContext["Asset"] = "asset";
-    PluginContext["Album"] = "album";
-    PluginContext["Person"] = "person";
-})(PluginContext || (PluginContext = {}));
+export var PluginContextType;
+(function (PluginContextType) {
+    PluginContextType["Asset"] = "asset";
+    PluginContextType["Album"] = "album";
+    PluginContextType["Person"] = "person";
+})(PluginContextType || (PluginContextType = {}));
+export var PluginTriggerType;
+(function (PluginTriggerType) {
+    PluginTriggerType["AssetCreate"] = "AssetCreate";
+    PluginTriggerType["PersonRecognized"] = "PersonRecognized";
+})(PluginTriggerType || (PluginTriggerType = {}));
 export var QueueJobStatus;
 (function (QueueJobStatus) {
     QueueJobStatus["Active"] = "active";
@@ -2638,6 +2793,7 @@ export var JobName;
     JobName["AssetDetectFaces"] = "AssetDetectFaces";
     JobName["AssetDetectDuplicatesQueueAll"] = "AssetDetectDuplicatesQueueAll";
     JobName["AssetDetectDuplicates"] = "AssetDetectDuplicates";
+    JobName["AssetEditThumbnailGeneration"] = "AssetEditThumbnailGeneration";
     JobName["AssetEncodeVideoQueueAll"] = "AssetEncodeVideoQueueAll";
     JobName["AssetEncodeVideo"] = "AssetEncodeVideo";
     JobName["AssetEmptyTrash"] = "AssetEmptyTrash";
@@ -2855,13 +3011,9 @@ export var OAuthTokenEndpointAuthMethod;
     OAuthTokenEndpointAuthMethod["ClientSecretPost"] = "client_secret_post";
     OAuthTokenEndpointAuthMethod["ClientSecretBasic"] = "client_secret_basic";
 })(OAuthTokenEndpointAuthMethod || (OAuthTokenEndpointAuthMethod = {}));
-export var TriggerType;
-(function (TriggerType) {
-    TriggerType["AssetCreate"] = "AssetCreate";
-    TriggerType["PersonRecognized"] = "PersonRecognized";
-})(TriggerType || (TriggerType = {}));
-export var PluginTriggerType;
-(function (PluginTriggerType) {
-    PluginTriggerType["AssetCreate"] = "AssetCreate";
-    PluginTriggerType["PersonRecognized"] = "PersonRecognized";
-})(PluginTriggerType || (PluginTriggerType = {}));
+export var UserMetadataKey;
+(function (UserMetadataKey) {
+    UserMetadataKey["Preferences"] = "preferences";
+    UserMetadataKey["License"] = "license";
+    UserMetadataKey["Onboarding"] = "onboarding";
+})(UserMetadataKey || (UserMetadataKey = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@immich/sdk",
-  "version": "2.4.1",
+  "version": "2.5.2",
   "description": "Auto-generated TypeScript SDK for the Immich API",
   "type": "module",
   "main": "./build/index.js",
@@ -16,7 +16,7 @@
     "@oazapfts/runtime": "^1.0.2"
   },
   "devDependencies": {
-    "@types/node": "^24.10.3",
+    "@types/node": "^24.10.9",
     "typescript": "^5.3.3"
   },
   "repository": {
@@ -25,7 +25,7 @@
     "directory": "open-api/typescript-sdk"
   },
   "volta": {
-    "node": "24.11.1"
+    "node": "24.13.0"
   },
   "scripts": {
     "build": "tsc"