@immich/sdk 1.138.1 → 2.2.0

package/build/fetch-client.js

@@ -1,6 +1,6 @@
 /**
  * Immich
- * 1.138.1
+ * 2.2.0
  * DO NOT MODIFY - This file has been generated using oazapfts.
  * See https://www.npmjs.com/package/oazapfts
  */
@@ -164,6 +164,14 @@ export function restoreUserAdmin({ id }, opts) {
         method: "POST"
     }));
 }
+/**
+ * This endpoint is an admin-only route, and requires the `adminSession.read` permission.
+ */
+export function getUserSessionsAdmin({ id }, opts) {
+    return oazapfts.ok(oazapfts.fetchJson(`/admin/users/${encodeURIComponent(id)}/sessions`, {
+        ...opts
+    }));
+}
 /**
  * This endpoint is an admin-only route, and requires the `adminUser.read` permission.
  */
@@ -197,6 +205,19 @@ export function createAlbum({ createAlbumDto }, opts) {
         body: createAlbumDto
     })));
 }
+/**
+ * This endpoint requires the `albumAsset.create` permission.
+ */
+export function addAssetsToAlbums({ key, slug, albumsAddAssetsDto }, opts) {
+    return oazapfts.ok(oazapfts.fetchJson(`/albums/assets${QS.query(QS.explode({
+        key,
+        slug
+    }))}`, oazapfts.json({
+        ...opts,
+        method: "PUT",
+        body: albumsAddAssetsDto
+    })));
+}
 /**
  * This endpoint requires the `album.statistics` permission.
  */
@@ -306,6 +327,11 @@ export function createApiKey({ apiKeyCreateDto }, opts) {
         body: apiKeyCreateDto
     })));
 }
+export function getMyApiKey(opts) {
+    return oazapfts.ok(oazapfts.fetchJson("/api-keys/me", {
+        ...opts
+    }));
+}
 /**
  * This endpoint requires the `apiKey.delete` permission.
  */
@@ -379,6 +405,16 @@ export function checkBulkUpload({ assetBulkUploadCheckDto }, opts) {
         body: assetBulkUploadCheckDto
     })));
 }
+/**
+ * This endpoint requires the `asset.copy` permission.
+ */
+export function copyAsset({ assetCopyDto }, opts) {
+    return oazapfts.ok(oazapfts.fetchText("/assets/copy", oazapfts.json({
+        ...opts,
+        method: "PUT",
+        body: assetCopyDto
+    })));
+}
 /**
  * getAllUserAssetsByDeviceId
  */
@@ -447,6 +483,49 @@ export function updateAsset({ id, updateAssetDto }, opts) {
         body: updateAssetDto
     })));
 }
+/**
+ * This endpoint requires the `asset.read` permission.
+ */
+export function getAssetMetadata({ id }, opts) {
+    return oazapfts.ok(oazapfts.fetchJson(`/assets/${encodeURIComponent(id)}/metadata`, {
+        ...opts
+    }));
+}
+/**
+ * This endpoint requires the `asset.update` permission.
+ */
+export function updateAssetMetadata({ id, assetMetadataUpsertDto }, opts) {
+    return oazapfts.ok(oazapfts.fetchJson(`/assets/${encodeURIComponent(id)}/metadata`, oazapfts.json({
+        ...opts,
+        method: "PUT",
+        body: assetMetadataUpsertDto
+    })));
+}
+/**
+ * This endpoint requires the `asset.update` permission.
+ */
+export function deleteAssetMetadata({ id, key }, opts) {
+    return oazapfts.ok(oazapfts.fetchText(`/assets/${encodeURIComponent(id)}/metadata/${encodeURIComponent(key)}`, {
+        ...opts,
+        method: "DELETE"
+    }));
+}
+/**
+ * This endpoint requires the `asset.read` permission.
+ */
+export function getAssetMetadataByKey({ id, key }, opts) {
+    return oazapfts.ok(oazapfts.fetchJson(`/assets/${encodeURIComponent(id)}/metadata/${encodeURIComponent(key)}`, {
+        ...opts
+    }));
+}
+/**
+ * This endpoint requires the `asset.read` permission.
+ */
+export function getAssetOcr({ id }, opts) {
+    return oazapfts.ok(oazapfts.fetchJson(`/assets/${encodeURIComponent(id)}/ocr`, {
+        ...opts
+    }));
+}
 /**
  * This endpoint requires the `asset.download` permission.
  */
@@ -459,7 +538,7 @@ export function downloadAsset({ id, key, slug }, opts) {
     }));
 }
 /**
- * replaceAsset
+ * Replace the asset with new file, without changing its id
  */
 export function replaceAsset({ id, key, slug, assetMediaReplaceDto }, opts) {
     return oazapfts.ok(oazapfts.fetchJson(`/assets/${encodeURIComponent(id)}/original${QS.query(QS.explode({
@@ -973,6 +1052,16 @@ export function getPartners({ direction }, opts) {
         ...opts
     }));
 }
+/**
+ * This endpoint requires the `partner.create` permission.
+ */
+export function createPartner({ partnerCreateDto }, opts) {
+    return oazapfts.ok(oazapfts.fetchJson("/partners", oazapfts.json({
+        ...opts,
+        method: "POST",
+        body: partnerCreateDto
+    })));
+}
 /**
  * This endpoint requires the `partner.delete` permission.
  */
@@ -983,9 +1072,9 @@ export function removePartner({ id }, opts) {
     }));
 }
 /**
- * This endpoint requires the `partner.create` permission.
+ * This property was deprecated in v1.141.0. This endpoint requires the `partner.create` permission.
  */
-export function createPartner({ id }, opts) {
+export function createPartnerDeprecated({ id }, opts) {
     return oazapfts.ok(oazapfts.fetchJson(`/partners/${encodeURIComponent(id)}`, {
         ...opts,
         method: "POST"
@@ -994,11 +1083,11 @@ export function createPartner({ id }, opts) {
 /**
  * This endpoint requires the `partner.update` permission.
  */
-export function updatePartner({ id, updatePartnerDto }, opts) {
+export function updatePartner({ id, partnerUpdateDto }, opts) {
     return oazapfts.ok(oazapfts.fetchJson(`/partners/${encodeURIComponent(id)}`, oazapfts.json({
         ...opts,
         method: "PUT",
-        body: updatePartnerDto
+        body: partnerUpdateDto
     })));
 }
 /**
@@ -1127,7 +1216,7 @@ export function getExploreData(opts) {
 /**
  * This endpoint requires the `asset.read` permission.
  */
-export 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 }, opts) {
+export function searchLargeAssets({ albumIds, city, country, createdAfter, createdBefore, deviceId, isEncoded, isFavorite, isMotion, isNotInAlbum, isOffline, lensModel, libraryId, make, minFileSize, model, ocr, personIds, rating, size, state, tagIds, takenAfter, takenBefore, trashedAfter, trashedBefore, $type, updatedAfter, updatedBefore, visibility, withDeleted, withExif }, opts) {
     return oazapfts.ok(oazapfts.fetchJson(`/search/large-assets${QS.query(QS.explode({
         albumIds,
         city,
@@ -1145,6 +1234,7 @@ export function searchLargeAssets({ albumIds, city, country, createdAfter, creat
         make,
         minFileSize,
         model,
+        ocr,
         personIds,
         rating,
         size,
@@ -1229,10 +1319,11 @@ export function searchAssetStatistics({ statisticsSearchDto }, opts) {
 /**
  * This endpoint requires the `asset.read` permission.
  */
-export function getSearchSuggestions({ country, includeNull, make, model, state, $type }, opts) {
+export function getSearchSuggestions({ country, includeNull, lensModel, make, model, state, $type }, opts) {
     return oazapfts.ok(oazapfts.fetchJson(`/search/suggestions${QS.query(QS.explode({
         country,
         includeNull,
+        lensModel,
         make,
         model,
         state,
@@ -1749,7 +1840,7 @@ export function tagAssets({ id, bulkIdsDto }, opts) {
 /**
  * This endpoint requires the `asset.read` permission.
  */
-export function getTimeBucket({ albumId, isFavorite, isTrashed, key, order, personId, slug, tagId, timeBucket, userId, visibility, withPartners, withStacked }, opts) {
+export function getTimeBucket({ albumId, isFavorite, isTrashed, key, order, personId, slug, tagId, timeBucket, userId, visibility, withCoordinates, withPartners, withStacked }, opts) {
     return oazapfts.ok(oazapfts.fetchJson(`/timeline/bucket${QS.query(QS.explode({
         albumId,
         isFavorite,
@@ -1762,6 +1853,7 @@ export function getTimeBucket({ albumId, isFavorite, isTrashed, key, order, pers
         timeBucket,
         userId,
         visibility,
+        withCoordinates,
         withPartners,
         withStacked
     }))}`, {
@@ -1771,7 +1863,7 @@ export function getTimeBucket({ albumId, isFavorite, isTrashed, key, order, pers
 /**
  * This endpoint requires the `asset.read` permission.
  */
-export function getTimeBuckets({ albumId, isFavorite, isTrashed, key, order, personId, slug, tagId, userId, visibility, withPartners, withStacked }, opts) {
+export function getTimeBuckets({ albumId, isFavorite, isTrashed, key, order, personId, slug, tagId, userId, visibility, withCoordinates, withPartners, withStacked }, opts) {
     return oazapfts.ok(oazapfts.fetchJson(`/timeline/buckets${QS.query(QS.explode({
         albumId,
         isFavorite,
@@ -1783,6 +1875,7 @@ export function getTimeBuckets({ albumId, isFavorite, isTrashed, key, order, per
         tagId,
         userId,
         visibility,
+        withCoordinates,
         withPartners,
         withStacked
     }))}`, {
@@ -1997,6 +2090,8 @@ export var NotificationType;
     NotificationType["JobFailed"] = "JobFailed";
     NotificationType["BackupFailed"] = "BackupFailed";
     NotificationType["SystemMessage"] = "SystemMessage";
+    NotificationType["AlbumInvite"] = "AlbumInvite";
+    NotificationType["AlbumUpdate"] = "AlbumUpdate";
     NotificationType["Custom"] = "Custom";
 })(NotificationType || (NotificationType = {}));
 export var UserStatus;
@@ -2035,6 +2130,13 @@ export var AssetTypeEnum;
     AssetTypeEnum["Audio"] = "AUDIO";
     AssetTypeEnum["Other"] = "OTHER";
 })(AssetTypeEnum || (AssetTypeEnum = {}));
+export var BulkIdErrorReason;
+(function (BulkIdErrorReason) {
+    BulkIdErrorReason["Duplicate"] = "duplicate";
+    BulkIdErrorReason["NoPermission"] = "no_permission";
+    BulkIdErrorReason["NotFound"] = "not_found";
+    BulkIdErrorReason["Unknown"] = "unknown";
+})(BulkIdErrorReason || (BulkIdErrorReason = {}));
 export var Error;
 (function (Error) {
     Error["Duplicate"] = "duplicate";
@@ -2063,6 +2165,7 @@ export var Permission;
     Permission["AssetDownload"] = "asset.download";
     Permission["AssetUpload"] = "asset.upload";
     Permission["AssetReplace"] = "asset.replace";
+    Permission["AssetCopy"] = "asset.copy";
     Permission["AlbumCreate"] = "album.create";
     Permission["AlbumRead"] = "album.read";
     Permission["AlbumUpdate"] = "album.update";
@@ -2171,8 +2274,13 @@ export var Permission;
     Permission["AdminUserRead"] = "adminUser.read";
     Permission["AdminUserUpdate"] = "adminUser.update";
     Permission["AdminUserDelete"] = "adminUser.delete";
+    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";
@@ -2228,6 +2336,7 @@ export var JobName;
     JobName["Library"] = "library";
     JobName["Notifications"] = "notifications";
     JobName["BackupDatabase"] = "backupDatabase";
+    JobName["Ocr"] = "ocr";
 })(JobName || (JobName = {}));
 export var JobCommand;
 (function (JobCommand) {
@@ -2253,6 +2362,7 @@ export var SearchSuggestionType;
     SearchSuggestionType["City"] = "city";
     SearchSuggestionType["CameraMake"] = "camera-make";
     SearchSuggestionType["CameraModel"] = "camera-model";
+    SearchSuggestionType["CameraLensModel"] = "camera-lens-model";
 })(SearchSuggestionType || (SearchSuggestionType = {}));
 export var SharedLinkType;
 (function (SharedLinkType) {
@@ -2273,6 +2383,8 @@ export var SyncEntityType;
     SyncEntityType["AssetV1"] = "AssetV1";
     SyncEntityType["AssetDeleteV1"] = "AssetDeleteV1";
     SyncEntityType["AssetExifV1"] = "AssetExifV1";
+    SyncEntityType["AssetMetadataV1"] = "AssetMetadataV1";
+    SyncEntityType["AssetMetadataDeleteV1"] = "AssetMetadataDeleteV1";
     SyncEntityType["PartnerV1"] = "PartnerV1";
     SyncEntityType["PartnerDeleteV1"] = "PartnerDeleteV1";
     SyncEntityType["PartnerAssetV1"] = "PartnerAssetV1";
@@ -2311,6 +2423,7 @@ export var SyncEntityType;
     SyncEntityType["UserMetadataDeleteV1"] = "UserMetadataDeleteV1";
     SyncEntityType["SyncAckV1"] = "SyncAckV1";
     SyncEntityType["SyncResetV1"] = "SyncResetV1";
+    SyncEntityType["SyncCompleteV1"] = "SyncCompleteV1";
 })(SyncEntityType || (SyncEntityType = {}));
 export var SyncRequestType;
 (function (SyncRequestType) {
@@ -2321,6 +2434,7 @@ export var SyncRequestType;
     SyncRequestType["AlbumAssetExifsV1"] = "AlbumAssetExifsV1";
     SyncRequestType["AssetsV1"] = "AssetsV1";
     SyncRequestType["AssetExifsV1"] = "AssetExifsV1";
+    SyncRequestType["AssetMetadataV1"] = "AssetMetadataV1";
     SyncRequestType["AuthUsersV1"] = "AuthUsersV1";
     SyncRequestType["MemoriesV1"] = "MemoriesV1";
     SyncRequestType["MemoryToAssetsV1"] = "MemoryToAssetsV1";

package/build/index.d.ts

@@ -3,11 +3,14 @@ export * from './fetch-errors.js';
 export interface InitOptions {
     baseUrl: string;
     apiKey: string;
+    headers?: Record<string, string>;
 }
-export declare const init: ({ baseUrl, apiKey }: InitOptions) => void;
+export declare const init: ({ baseUrl, apiKey, headers }: InitOptions) => void;
 export declare const getBaseUrl: () => string;
 export declare const setBaseUrl: (baseUrl: string) => void;
 export declare const setApiKey: (apiKey: string) => void;
+export declare const setHeader: (key: string, value: string) => void;
+export declare const setHeaders: (headers: Record<string, string>) => void;
 export declare const getAssetOriginalPath: (id: string) => string;
 export declare const getAssetThumbnailPath: (id: string) => string;
 export declare const getAssetPlaybackPath: (id: string) => string;

package/build/index.js

@@ -1,9 +1,12 @@
 import { defaults } from './fetch-client.js';
 export * from './fetch-client.js';
 export * from './fetch-errors.js';
-export const init = ({ baseUrl, apiKey }) => {
+export const init = ({ baseUrl, apiKey, headers }) => {
     setBaseUrl(baseUrl);
     setApiKey(apiKey);
+    if (headers) {
+        setHeaders(headers);
+    }
 };
 export const getBaseUrl = () => defaults.baseUrl;
 export const setBaseUrl = (baseUrl) => {
@@ -13,6 +16,23 @@ export const setApiKey = (apiKey) => {
     defaults.headers = defaults.headers || {};
     defaults.headers['x-api-key'] = apiKey;
 };
+export const setHeader = (key, value) => {
+    assertNoApiKey(key);
+    defaults.headers = defaults.headers || {};
+    defaults.headers[key] = value;
+};
+export const setHeaders = (headers) => {
+    defaults.headers = defaults.headers || {};
+    for (const [key, value] of Object.entries(headers)) {
+        assertNoApiKey(key);
+        defaults.headers[key] = value;
+    }
+};
+const assertNoApiKey = (headerKey) => {
+    if (headerKey.toLowerCase() === 'x-api-key') {
+        throw new Error('The API key header can only be set using setApiKey().');
+    }
+};
 export const getAssetOriginalPath = (id) => `/assets/${id}/original`;
 export const getAssetThumbnailPath = (id) => `/assets/${id}/thumbnail`;
 export const getAssetPlaybackPath = (id) => `/assets/${id}/video/playback`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@immich/sdk",
-  "version": "1.138.1",
+  "version": "2.2.0",
   "description": "Auto-generated TypeScript SDK for the Immich API",
   "type": "module",
   "main": "./build/index.js",
@@ -11,15 +11,12 @@
       "default": "./build/index.js"
     }
   },
-  "scripts": {
-    "build": "tsc"
-  },
   "license": "GNU Affero General Public License version 3",
   "dependencies": {
     "@oazapfts/runtime": "^1.0.2"
   },
   "devDependencies": {
-    "@types/node": "^22.17.0",
+    "@types/node": "^22.18.12",
     "typescript": "^5.3.3"
   },
   "repository": {
@@ -28,6 +25,9 @@
     "directory": "open-api/typescript-sdk"
   },
   "volta": {
-    "node": "22.18.0"
+    "node": "24.11.0"
+  },
+  "scripts": {
+    "build": "tsc"
   }
-}
+}