@immich/sdk 2.3.1 → 2.4.0

package/.nvmrc

@@ -1 +1 @@
-24.11.0
+24.11.1

package/build/fetch-client.d.ts

@@ -1,6 +1,6 @@
 /**
  * Immich
- * 2.3.1
+ * 2.4.0
  * DO NOT MODIFY - This file has been generated using oazapfts.
  * See https://www.npmjs.com/package/oazapfts
  */
@@ -711,32 +711,32 @@ export type QueueStatisticsDto = {
     paused: number;
     waiting: number;
 };
-export type QueueStatusDto = {
+export type QueueStatusLegacyDto = {
     isActive: boolean;
     isPaused: boolean;
 };
-export type QueueResponseDto = {
+export type QueueResponseLegacyDto = {
     jobCounts: QueueStatisticsDto;
-    queueStatus: QueueStatusDto;
-};
-export type QueuesResponseDto = {
-    backgroundTask: QueueResponseDto;
-    backupDatabase: QueueResponseDto;
-    duplicateDetection: QueueResponseDto;
-    faceDetection: QueueResponseDto;
-    facialRecognition: QueueResponseDto;
-    library: QueueResponseDto;
-    metadataExtraction: QueueResponseDto;
-    migration: QueueResponseDto;
-    notifications: QueueResponseDto;
-    ocr: QueueResponseDto;
-    search: QueueResponseDto;
-    sidecar: QueueResponseDto;
-    smartSearch: QueueResponseDto;
-    storageTemplateMigration: QueueResponseDto;
-    thumbnailGeneration: QueueResponseDto;
-    videoConversion: QueueResponseDto;
-    workflow: QueueResponseDto;
+    queueStatus: QueueStatusLegacyDto;
+};
+export type QueuesResponseLegacyDto = {
+    backgroundTask: QueueResponseLegacyDto;
+    backupDatabase: QueueResponseLegacyDto;
+    duplicateDetection: QueueResponseLegacyDto;
+    faceDetection: QueueResponseLegacyDto;
+    facialRecognition: QueueResponseLegacyDto;
+    library: QueueResponseLegacyDto;
+    metadataExtraction: QueueResponseLegacyDto;
+    migration: QueueResponseLegacyDto;
+    notifications: QueueResponseLegacyDto;
+    ocr: QueueResponseLegacyDto;
+    search: QueueResponseLegacyDto;
+    sidecar: QueueResponseLegacyDto;
+    smartSearch: QueueResponseLegacyDto;
+    storageTemplateMigration: QueueResponseLegacyDto;
+    thumbnailGeneration: QueueResponseLegacyDto;
+    videoConversion: QueueResponseLegacyDto;
+    workflow: QueueResponseLegacyDto;
 };
 export type JobCreateDto = {
     name: ManualJobName;
@@ -961,6 +961,24 @@ export type PluginResponseDto = {
     updatedAt: string;
     version: string;
 };
+export type QueueResponseDto = {
+    isPaused: boolean;
+    name: QueueName;
+    statistics: QueueStatisticsDto;
+};
+export type QueueUpdateDto = {
+    isPaused?: boolean;
+};
+export type QueueDeleteDto = {
+    /** If true, will also remove failed jobs from the queue. */
+    failed?: boolean;
+};
+export type QueueJobResponseDto = {
+    data: object;
+    id?: string;
+    name: JobName;
+    timestamp: number;
+};
 export type SearchExploreItem = {
     data: AssetResponseDto;
     value: string;
@@ -1706,16 +1724,16 @@ export type CreateProfileImageResponseDto = {
 };
 export type WorkflowActionResponseDto = {
     actionConfig: object | null;
-    actionId: string;
     id: string;
     order: number;
+    pluginActionId: string;
     workflowId: string;
 };
 export type WorkflowFilterResponseDto = {
     filterConfig: object | null;
-    filterId: string;
     id: string;
     order: number;
+    pluginFilterId: string;
     workflowId: string;
 };
 export type WorkflowResponseDto = {
@@ -1731,11 +1749,11 @@ export type WorkflowResponseDto = {
 };
 export type WorkflowActionItemDto = {
     actionConfig?: object;
-    actionId: string;
+    pluginActionId: string;
 };
 export type WorkflowFilterItemDto = {
     filterConfig?: object;
-    filterId: string;
+    pluginFilterId: string;
 };
 export type WorkflowCreateDto = {
     actions: WorkflowActionItemDto[];
@@ -2267,7 +2285,7 @@ export declare function reassignFacesById({ id, faceDto }: {
 /**
  * Retrieve queue counts and status
  */
-export declare function getQueuesLegacy(opts?: Oazapfts.RequestOpts): Promise<QueuesResponseDto>;
+export declare function getQueuesLegacy(opts?: Oazapfts.RequestOpts): Promise<QueuesResponseLegacyDto>;
 /**
  * Create a manual job
  */
@@ -2280,7 +2298,7 @@ export declare function createJob({ jobCreateDto }: {
 export declare function runQueueCommandLegacy({ name, queueCommandDto }: {
     name: QueueName;
     queueCommandDto: QueueCommandDto;
-}, opts?: Oazapfts.RequestOpts): Promise<QueueResponseDto>;
+}, opts?: Oazapfts.RequestOpts): Promise<QueueResponseLegacyDto>;
 /**
  * Retrieve libraries
  */
@@ -2588,6 +2606,37 @@ export declare function getPlugins(opts?: Oazapfts.RequestOpts): Promise<PluginR
 export declare function getPlugin({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<PluginResponseDto>;
+/**
+ * List all queues
+ */
+export declare function getQueues(opts?: Oazapfts.RequestOpts): Promise<QueueResponseDto[]>;
+/**
+ * Retrieve a queue
+ */
+export declare function getQueue({ name }: {
+    name: QueueName;
+}, opts?: Oazapfts.RequestOpts): Promise<QueueResponseDto>;
+/**
+ * Update a queue
+ */
+export declare function updateQueue({ name, queueUpdateDto }: {
+    name: QueueName;
+    queueUpdateDto: QueueUpdateDto;
+}, opts?: Oazapfts.RequestOpts): Promise<QueueResponseDto>;
+/**
+ * Empty a queue
+ */
+export declare function emptyQueue({ name, queueDeleteDto }: {
+    name: QueueName;
+    queueDeleteDto: QueueDeleteDto;
+}, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * Retrieve queue jobs
+ */
+export declare function getQueueJobs({ name, status }: {
+    name: QueueName;
+    status?: QueueJobStatus[];
+}, opts?: Oazapfts.RequestOpts): Promise<QueueJobResponseDto[]>;
 /**
  * Retrieve assets by city
  */
@@ -3378,6 +3427,12 @@ export declare enum Permission {
     UserProfileImageRead = "userProfileImage.read",
     UserProfileImageUpdate = "userProfileImage.update",
     UserProfileImageDelete = "userProfileImage.delete",
+    QueueRead = "queue.read",
+    QueueUpdate = "queue.update",
+    QueueJobCreate = "queueJob.create",
+    QueueJobRead = "queueJob.read",
+    QueueJobUpdate = "queueJob.update",
+    QueueJobDelete = "queueJob.delete",
     WorkflowCreate = "workflow.create",
     WorkflowRead = "workflow.read",
     WorkflowUpdate = "workflow.update",
@@ -3467,6 +3522,71 @@ export declare enum PluginContext {
     Album = "album",
     Person = "person"
 }
+export declare enum QueueJobStatus {
+    Active = "active",
+    Failed = "failed",
+    Completed = "completed",
+    Delayed = "delayed",
+    Waiting = "waiting",
+    Paused = "paused"
+}
+export declare enum JobName {
+    AssetDelete = "AssetDelete",
+    AssetDeleteCheck = "AssetDeleteCheck",
+    AssetDetectFacesQueueAll = "AssetDetectFacesQueueAll",
+    AssetDetectFaces = "AssetDetectFaces",
+    AssetDetectDuplicatesQueueAll = "AssetDetectDuplicatesQueueAll",
+    AssetDetectDuplicates = "AssetDetectDuplicates",
+    AssetEncodeVideoQueueAll = "AssetEncodeVideoQueueAll",
+    AssetEncodeVideo = "AssetEncodeVideo",
+    AssetEmptyTrash = "AssetEmptyTrash",
+    AssetExtractMetadataQueueAll = "AssetExtractMetadataQueueAll",
+    AssetExtractMetadata = "AssetExtractMetadata",
+    AssetFileMigration = "AssetFileMigration",
+    AssetGenerateThumbnailsQueueAll = "AssetGenerateThumbnailsQueueAll",
+    AssetGenerateThumbnails = "AssetGenerateThumbnails",
+    AuditLogCleanup = "AuditLogCleanup",
+    AuditTableCleanup = "AuditTableCleanup",
+    DatabaseBackup = "DatabaseBackup",
+    FacialRecognitionQueueAll = "FacialRecognitionQueueAll",
+    FacialRecognition = "FacialRecognition",
+    FileDelete = "FileDelete",
+    FileMigrationQueueAll = "FileMigrationQueueAll",
+    LibraryDeleteCheck = "LibraryDeleteCheck",
+    LibraryDelete = "LibraryDelete",
+    LibraryRemoveAsset = "LibraryRemoveAsset",
+    LibraryScanAssetsQueueAll = "LibraryScanAssetsQueueAll",
+    LibrarySyncAssets = "LibrarySyncAssets",
+    LibrarySyncFilesQueueAll = "LibrarySyncFilesQueueAll",
+    LibrarySyncFiles = "LibrarySyncFiles",
+    LibraryScanQueueAll = "LibraryScanQueueAll",
+    MemoryCleanup = "MemoryCleanup",
+    MemoryGenerate = "MemoryGenerate",
+    NotificationsCleanup = "NotificationsCleanup",
+    NotifyUserSignup = "NotifyUserSignup",
+    NotifyAlbumInvite = "NotifyAlbumInvite",
+    NotifyAlbumUpdate = "NotifyAlbumUpdate",
+    UserDelete = "UserDelete",
+    UserDeleteCheck = "UserDeleteCheck",
+    UserSyncUsage = "UserSyncUsage",
+    PersonCleanup = "PersonCleanup",
+    PersonFileMigration = "PersonFileMigration",
+    PersonGenerateThumbnail = "PersonGenerateThumbnail",
+    SessionCleanup = "SessionCleanup",
+    SendMail = "SendMail",
+    SidecarQueueAll = "SidecarQueueAll",
+    SidecarCheck = "SidecarCheck",
+    SidecarWrite = "SidecarWrite",
+    SmartSearchQueueAll = "SmartSearchQueueAll",
+    SmartSearch = "SmartSearch",
+    StorageTemplateMigration = "StorageTemplateMigration",
+    StorageTemplateMigrationSingle = "StorageTemplateMigrationSingle",
+    TagCleanup = "TagCleanup",
+    VersionCheck = "VersionCheck",
+    OcrQueueAll = "OcrQueueAll",
+    Ocr = "Ocr",
+    WorkflowRun = "WorkflowRun"
+}
 export declare enum SearchSuggestionType {
     Country = "country",
     State = "state",

package/build/fetch-client.js

@@ -1,6 +1,6 @@
 /**
  * Immich
- * 2.3.1
+ * 2.4.0
  * DO NOT MODIFY - This file has been generated using oazapfts.
  * See https://www.npmjs.com/package/oazapfts
  */
@@ -1297,6 +1297,52 @@ export function getPlugin({ id }, opts) {
         ...opts
     }));
 }
+/**
+ * List all queues
+ */
+export function getQueues(opts) {
+    return oazapfts.ok(oazapfts.fetchJson("/queues", {
+        ...opts
+    }));
+}
+/**
+ * Retrieve a queue
+ */
+export function getQueue({ name }, opts) {
+    return oazapfts.ok(oazapfts.fetchJson(`/queues/${encodeURIComponent(name)}`, {
+        ...opts
+    }));
+}
+/**
+ * Update a queue
+ */
+export function updateQueue({ name, queueUpdateDto }, opts) {
+    return oazapfts.ok(oazapfts.fetchJson(`/queues/${encodeURIComponent(name)}`, oazapfts.json({
+        ...opts,
+        method: "PUT",
+        body: queueUpdateDto
+    })));
+}
+/**
+ * Empty a queue
+ */
+export function emptyQueue({ name, queueDeleteDto }, opts) {
+    return oazapfts.ok(oazapfts.fetchText(`/queues/${encodeURIComponent(name)}/jobs`, oazapfts.json({
+        ...opts,
+        method: "DELETE",
+        body: queueDeleteDto
+    })));
+}
+/**
+ * Retrieve queue jobs
+ */
+export function getQueueJobs({ name, status }, opts) {
+    return oazapfts.ok(oazapfts.fetchJson(`/queues/${encodeURIComponent(name)}/jobs${QS.query(QS.explode({
+        status
+    }))}`, {
+        ...opts
+    }));
+}
 /**
  * Retrieve assets by city
  */
@@ -2467,6 +2513,12 @@ export var Permission;
     Permission["UserProfileImageRead"] = "userProfileImage.read";
     Permission["UserProfileImageUpdate"] = "userProfileImage.update";
     Permission["UserProfileImageDelete"] = "userProfileImage.delete";
+    Permission["QueueRead"] = "queue.read";
+    Permission["QueueUpdate"] = "queue.update";
+    Permission["QueueJobCreate"] = "queueJob.create";
+    Permission["QueueJobRead"] = "queueJob.read";
+    Permission["QueueJobUpdate"] = "queueJob.update";
+    Permission["QueueJobDelete"] = "queueJob.delete";
     Permission["WorkflowCreate"] = "workflow.create";
     Permission["WorkflowRead"] = "workflow.read";
     Permission["WorkflowUpdate"] = "workflow.update";
@@ -2569,6 +2621,73 @@ export var PluginContext;
     PluginContext["Album"] = "album";
     PluginContext["Person"] = "person";
 })(PluginContext || (PluginContext = {}));
+export var QueueJobStatus;
+(function (QueueJobStatus) {
+    QueueJobStatus["Active"] = "active";
+    QueueJobStatus["Failed"] = "failed";
+    QueueJobStatus["Completed"] = "completed";
+    QueueJobStatus["Delayed"] = "delayed";
+    QueueJobStatus["Waiting"] = "waiting";
+    QueueJobStatus["Paused"] = "paused";
+})(QueueJobStatus || (QueueJobStatus = {}));
+export var JobName;
+(function (JobName) {
+    JobName["AssetDelete"] = "AssetDelete";
+    JobName["AssetDeleteCheck"] = "AssetDeleteCheck";
+    JobName["AssetDetectFacesQueueAll"] = "AssetDetectFacesQueueAll";
+    JobName["AssetDetectFaces"] = "AssetDetectFaces";
+    JobName["AssetDetectDuplicatesQueueAll"] = "AssetDetectDuplicatesQueueAll";
+    JobName["AssetDetectDuplicates"] = "AssetDetectDuplicates";
+    JobName["AssetEncodeVideoQueueAll"] = "AssetEncodeVideoQueueAll";
+    JobName["AssetEncodeVideo"] = "AssetEncodeVideo";
+    JobName["AssetEmptyTrash"] = "AssetEmptyTrash";
+    JobName["AssetExtractMetadataQueueAll"] = "AssetExtractMetadataQueueAll";
+    JobName["AssetExtractMetadata"] = "AssetExtractMetadata";
+    JobName["AssetFileMigration"] = "AssetFileMigration";
+    JobName["AssetGenerateThumbnailsQueueAll"] = "AssetGenerateThumbnailsQueueAll";
+    JobName["AssetGenerateThumbnails"] = "AssetGenerateThumbnails";
+    JobName["AuditLogCleanup"] = "AuditLogCleanup";
+    JobName["AuditTableCleanup"] = "AuditTableCleanup";
+    JobName["DatabaseBackup"] = "DatabaseBackup";
+    JobName["FacialRecognitionQueueAll"] = "FacialRecognitionQueueAll";
+    JobName["FacialRecognition"] = "FacialRecognition";
+    JobName["FileDelete"] = "FileDelete";
+    JobName["FileMigrationQueueAll"] = "FileMigrationQueueAll";
+    JobName["LibraryDeleteCheck"] = "LibraryDeleteCheck";
+    JobName["LibraryDelete"] = "LibraryDelete";
+    JobName["LibraryRemoveAsset"] = "LibraryRemoveAsset";
+    JobName["LibraryScanAssetsQueueAll"] = "LibraryScanAssetsQueueAll";
+    JobName["LibrarySyncAssets"] = "LibrarySyncAssets";
+    JobName["LibrarySyncFilesQueueAll"] = "LibrarySyncFilesQueueAll";
+    JobName["LibrarySyncFiles"] = "LibrarySyncFiles";
+    JobName["LibraryScanQueueAll"] = "LibraryScanQueueAll";
+    JobName["MemoryCleanup"] = "MemoryCleanup";
+    JobName["MemoryGenerate"] = "MemoryGenerate";
+    JobName["NotificationsCleanup"] = "NotificationsCleanup";
+    JobName["NotifyUserSignup"] = "NotifyUserSignup";
+    JobName["NotifyAlbumInvite"] = "NotifyAlbumInvite";
+    JobName["NotifyAlbumUpdate"] = "NotifyAlbumUpdate";
+    JobName["UserDelete"] = "UserDelete";
+    JobName["UserDeleteCheck"] = "UserDeleteCheck";
+    JobName["UserSyncUsage"] = "UserSyncUsage";
+    JobName["PersonCleanup"] = "PersonCleanup";
+    JobName["PersonFileMigration"] = "PersonFileMigration";
+    JobName["PersonGenerateThumbnail"] = "PersonGenerateThumbnail";
+    JobName["SessionCleanup"] = "SessionCleanup";
+    JobName["SendMail"] = "SendMail";
+    JobName["SidecarQueueAll"] = "SidecarQueueAll";
+    JobName["SidecarCheck"] = "SidecarCheck";
+    JobName["SidecarWrite"] = "SidecarWrite";
+    JobName["SmartSearchQueueAll"] = "SmartSearchQueueAll";
+    JobName["SmartSearch"] = "SmartSearch";
+    JobName["StorageTemplateMigration"] = "StorageTemplateMigration";
+    JobName["StorageTemplateMigrationSingle"] = "StorageTemplateMigrationSingle";
+    JobName["TagCleanup"] = "TagCleanup";
+    JobName["VersionCheck"] = "VersionCheck";
+    JobName["OcrQueueAll"] = "OcrQueueAll";
+    JobName["Ocr"] = "Ocr";
+    JobName["WorkflowRun"] = "WorkflowRun";
+})(JobName || (JobName = {}));
 export var SearchSuggestionType;
 (function (SearchSuggestionType) {
     SearchSuggestionType["Country"] = "country";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@immich/sdk",
-  "version": "2.3.1",
+  "version": "2.4.0",
   "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": "^22.19.1",
+    "@types/node": "^24.10.3",
     "typescript": "^5.3.3"
   },
   "repository": {
@@ -25,7 +25,7 @@
     "directory": "open-api/typescript-sdk"
   },
   "volta": {
-    "node": "24.11.0"
+    "node": "24.11.1"
   },
   "scripts": {
     "build": "tsc"