@immich/sdk 1.134.0 → 1.135.0

package/build/fetch-client.d.ts

@@ -1,6 +1,6 @@
 /**
  * Immich
- * 1.134.0
+ * 1.135.0
  * DO NOT MODIFY - This file has been generated using oazapfts.
  * See https://www.npmjs.com/package/oazapfts
  */
@@ -33,6 +33,7 @@ export type ActivityCreateDto = {
 };
 export type ActivityStatisticsResponseDto = {
     comments: number;
+    likes: number;
 };
 export type NotificationCreateDto = {
     data?: object;
@@ -103,6 +104,7 @@ export type UserAdminResponseDto = {
 export type UserAdminCreateDto = {
     avatarColor?: (UserAvatarColor) | null;
     email: string;
+    isAdmin?: boolean;
     name: string;
     notify?: boolean;
     password: string;
@@ -116,6 +118,7 @@ export type UserAdminDeleteDto = {
 export type UserAdminUpdateDto = {
     avatarColor?: (UserAvatarColor) | null;
     email?: string;
+    isAdmin?: boolean;
     name?: string;
     password?: string;
     pinCode?: string | null;
@@ -123,6 +126,12 @@ export type UserAdminUpdateDto = {
     shouldChangePassword?: boolean;
     storageLabel?: string | null;
 };
+export type AlbumsResponse = {
+    defaultAssetOrder: AssetOrder;
+};
+export type CastResponse = {
+    gCastEnabled: boolean;
+};
 export type DownloadResponse = {
     archiveSize: number;
     includeEmbeddedVideos: boolean;
@@ -159,6 +168,8 @@ export type TagsResponse = {
     sidebarWeb: boolean;
 };
 export type UserPreferencesResponseDto = {
+    albums: AlbumsResponse;
+    cast: CastResponse;
     download: DownloadResponse;
     emailNotifications: EmailNotificationsResponse;
     folders: FoldersResponse;
@@ -169,9 +180,15 @@ export type UserPreferencesResponseDto = {
     sharedLinks: SharedLinksResponse;
     tags: TagsResponse;
 };
+export type AlbumsUpdate = {
+    defaultAssetOrder?: AssetOrder;
+};
 export type AvatarUpdate = {
     color?: UserAvatarColor;
 };
+export type CastUpdate = {
+    gCastEnabled?: boolean;
+};
 export type DownloadUpdate = {
     archiveSize?: number;
     includeEmbeddedVideos?: boolean;
@@ -208,7 +225,9 @@ export type TagsUpdate = {
     sidebarWeb?: boolean;
 };
 export type UserPreferencesUpdateDto = {
+    albums?: AlbumsUpdate;
     avatar?: AvatarUpdate;
+    cast?: CastUpdate;
     download?: DownloadUpdate;
     emailNotifications?: EmailNotificationsUpdate;
     folders?: FoldersUpdate;
@@ -298,7 +317,9 @@ export type AssetResponseDto = {
     duplicateId?: string | null;
     duration: string;
     exifInfo?: ExifResponseDto;
+    /** The actual UTC timestamp when the file was created/captured, preserving timezone information. This is the authoritative timestamp for chronological sorting within timeline groups. Combined with timezone data, this can be used to determine the exact moment the photo was taken. */
     fileCreatedAt: string;
+    /** 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;
     id: string;
@@ -309,6 +330,7 @@ export type AssetResponseDto = {
     /** This property was deprecated in v1.106.0 */
     libraryId?: string | null;
     livePhotoVideoId?: string | null;
+    /** The local date and time when the photo/video was taken, derived from EXIF metadata. This represents the photographer's local time regardless of timezone, stored as a timezone-agnostic timestamp. Used for timeline grouping by "local" days and months. */
     localDateTime: string;
     originalFileName: string;
     originalMimeType?: string;
@@ -323,6 +345,7 @@ export type AssetResponseDto = {
     thumbhash: string | null;
     "type": AssetTypeEnum;
     unassignedFaces?: AssetFaceWithoutPersonResponseDto[];
+    /** 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;
 };
@@ -402,7 +425,8 @@ export type ApiKeyCreateResponseDto = {
     secret: string;
 };
 export type ApiKeyUpdateDto = {
-    name: string;
+    name?: string;
+    permissions?: Permission[];
 };
 export type AssetBulkDeleteDto = {
     force?: boolean;
@@ -415,6 +439,7 @@ export type AssetMediaCreateDto = {
     duration?: string;
     fileCreatedAt: string;
     fileModifiedAt: string;
+    filename?: string;
     isFavorite?: boolean;
     livePhotoVideoId?: string;
     sidecarData?: Blob;
@@ -481,6 +506,7 @@ export type AssetMediaReplaceDto = {
     duration?: string;
     fileCreatedAt: string;
     fileModifiedAt: string;
+    filename?: string;
 };
 export type SignUpDto = {
     email: string;
@@ -498,6 +524,7 @@ export type LoginCredentialDto = {
 export type LoginResponseDto = {
     accessToken: string;
     isAdmin: boolean;
+    isOnboarded: boolean;
     name: string;
     profileImagePath: string;
     shouldChangePassword: boolean;
@@ -714,6 +741,9 @@ export type MemoryCreateDto = {
     seenAt?: string;
     "type": MemoryType;
 };
+export type MemoryStatisticsResponseDto = {
+    total: number;
+};
 export type MemoryUpdateDto = {
     isSaved?: boolean;
     memoryAt?: string;
@@ -825,6 +855,7 @@ export type SearchExploreResponseDto = {
     items: SearchExploreItem[];
 };
 export type MetadataSearchDto = {
+    albumIds?: string[];
     checksum?: string;
     city?: string | null;
     country?: string | null;
@@ -901,6 +932,7 @@ export type PlacesResponseDto = {
     name: string;
 };
 export type RandomSearchDto = {
+    albumIds?: string[];
     city?: string | null;
     country?: string | null;
     createdAfter?: string;
@@ -934,6 +966,7 @@ export type RandomSearchDto = {
     withStacked?: boolean;
 };
 export type SmartSearchDto = {
+    albumIds?: string[];
     city?: string | null;
     country?: string | null;
     createdAfter?: string;
@@ -967,6 +1000,39 @@ export type SmartSearchDto = {
     withDeleted?: boolean;
     withExif?: boolean;
 };
+export type StatisticsSearchDto = {
+    albumIds?: string[];
+    city?: string | null;
+    country?: string | null;
+    createdAfter?: string;
+    createdBefore?: string;
+    description?: string;
+    deviceId?: string;
+    isEncoded?: boolean;
+    isFavorite?: boolean;
+    isMotion?: boolean;
+    isNotInAlbum?: boolean;
+    isOffline?: boolean;
+    lensModel?: string | null;
+    libraryId?: string | null;
+    make?: string;
+    model?: string | null;
+    personIds?: string[];
+    rating?: number;
+    state?: string | null;
+    tagIds?: string[];
+    takenAfter?: string;
+    takenBefore?: string;
+    trashedAfter?: string;
+    trashedBefore?: string;
+    "type"?: AssetTypeEnum;
+    updatedAfter?: string;
+    updatedBefore?: string;
+    visibility?: AssetVisibility;
+};
+export type SearchStatisticsResponseDto = {
+    total: number;
+};
 export type ServerAboutResponseDto = {
     build?: string;
     buildImage?: string;
@@ -990,6 +1056,12 @@ export type ServerAboutResponseDto = {
     version: string;
     versionUrl: string;
 };
+export type ServerApkLinksDto = {
+    arm64v8a: string;
+    armeabiv7a: string;
+    universal: string;
+    x86_64: string;
+};
 export type ServerConfigDto = {
     externalDomain: string;
     isInitialized: boolean;
@@ -1315,7 +1387,7 @@ export type SystemConfigOAuthDto = {
     buttonText: string;
     clientId: string;
     clientSecret: string;
-    defaultStorageQuota: number;
+    defaultStorageQuota: number | null;
     enabled: boolean;
     issuerUrl: string;
     mobileOverrideEnabled: boolean;
@@ -1420,25 +1492,43 @@ export type TagUpdateDto = {
     color?: string | null;
 };
 export type TimeBucketAssetResponseDto = {
+    /** Array of city names extracted from EXIF GPS data */
     city: (string | null)[];
+    /** Array of country names extracted from EXIF GPS data */
     country: (string | null)[];
+    /** Array of video durations in HH:MM:SS format (null for images) */
     duration: (string | null)[];
+    /** Array of file creation timestamps in UTC (ISO 8601 format, without timezone) */
+    fileCreatedAt: string[];
+    /** Array of asset IDs in the time bucket */
     id: string[];
+    /** Array indicating whether each asset is favorited */
     isFavorite: boolean[];
+    /** Array indicating whether each asset is an image (false for videos) */
     isImage: boolean[];
+    /** Array indicating whether each asset is in the trash */
     isTrashed: boolean[];
+    /** Array of live photo video asset IDs (null for non-live photos) */
     livePhotoVideoId: (string | null)[];
-    localDateTime: string[];
+    /** Array of UTC offset hours at the time each photo was taken. Positive values are east of UTC, negative values are west of UTC. Values may be fractional (e.g., 5.5 for +05:30, -9.75 for -09:45). Applying this offset to 'fileCreatedAt' will give you the time the photo was taken from the photographer's perspective. */
+    localOffsetHours: number[];
+    /** Array of owner IDs for each asset */
     ownerId: string[];
+    /** Array of projection types for 360° content (e.g., "EQUIRECTANGULAR", "CUBEFACE", "CYLINDRICAL") */
     projectionType: (string | null)[];
+    /** Array of aspect ratios (width/height) for each asset */
     ratio: number[];
-    /** (stack ID, stack asset count) tuple */
+    /** Array of stack information as [stackId, assetCount] tuples (null for non-stacked assets) */
     stack?: (string[] | null)[];
+    /** Array of BlurHash strings for generating asset previews (base64 encoded) */
     thumbhash: (string | null)[];
+    /** Array of visibility statuses for each asset (e.g., ARCHIVE, TIMELINE, HIDDEN, LOCKED) */
     visibility: AssetVisibility[];
 };
 export type TimeBucketsResponseDto = {
+    /** Number of assets in this time bucket */
     count: number;
+    /** Time bucket identifier in YYYY-MM-DD format representing the start of the time period */
     timeBucket: string;
 };
 export type TrashResponseDto = {
@@ -1450,6 +1540,12 @@ export type UserUpdateMeDto = {
     name?: string;
     password?: string;
 };
+export type OnboardingResponseDto = {
+    isOnboarded: boolean;
+};
+export type OnboardingDto = {
+    isOnboarded: boolean;
+};
 export type CreateProfileImageDto = {
     file: Blob;
 };
@@ -1680,7 +1776,13 @@ export declare function getDownloadInfo({ key, downloadInfoDto }: {
     key?: string;
     downloadInfoDto: DownloadInfoDto;
 }, opts?: Oazapfts.RequestOpts): Promise<DownloadResponseDto>;
+export declare function deleteDuplicates({ bulkIdsDto }: {
+    bulkIdsDto: BulkIdsDto;
+}, opts?: Oazapfts.RequestOpts): Promise<never>;
 export declare function getAssetDuplicates(opts?: Oazapfts.RequestOpts): Promise<DuplicateResponseDto[]>;
+export declare function deleteDuplicate({ id }: {
+    id: string;
+}, opts?: Oazapfts.RequestOpts): Promise<never>;
 export declare function getFaces({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<AssetFaceResponseDto[]>;
@@ -1748,6 +1850,12 @@ export declare function searchMemories({ $for, isSaved, isTrashed, $type }: {
 export declare function createMemory({ memoryCreateDto }: {
     memoryCreateDto: MemoryCreateDto;
 }, opts?: Oazapfts.RequestOpts): Promise<MemoryResponseDto>;
+export declare function memoriesStatistics({ $for, isSaved, isTrashed, $type }: {
+    $for?: string;
+    isSaved?: boolean;
+    isTrashed?: boolean;
+    $type?: MemoryType;
+}, opts?: Oazapfts.RequestOpts): Promise<MemoryStatisticsResponseDto>;
 export declare function deleteMemory({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<never>;
@@ -1864,6 +1972,9 @@ export declare function searchRandom({ randomSearchDto }: {
 export declare function searchSmart({ smartSearchDto }: {
     smartSearchDto: SmartSearchDto;
 }, opts?: Oazapfts.RequestOpts): Promise<SearchResponseDto>;
+export declare function searchAssetStatistics({ statisticsSearchDto }: {
+    statisticsSearchDto: StatisticsSearchDto;
+}, opts?: Oazapfts.RequestOpts): Promise<SearchStatisticsResponseDto>;
 export declare function getSearchSuggestions({ country, includeNull, make, model, state, $type }: {
     country?: string;
     includeNull?: boolean;
@@ -1873,6 +1984,7 @@ export declare function getSearchSuggestions({ country, includeNull, make, model
     $type: SearchSuggestionType;
 }, opts?: Oazapfts.RequestOpts): Promise<string[]>;
 export declare function getAboutInfo(opts?: Oazapfts.RequestOpts): Promise<ServerAboutResponseDto>;
+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>;
 export declare function deleteServerLicense(opts?: Oazapfts.RequestOpts): Promise<never>;
@@ -2005,14 +2117,12 @@ export declare function tagAssets({ id, bulkIdsDto }: {
     id: string;
     bulkIdsDto: BulkIdsDto;
 }, opts?: Oazapfts.RequestOpts): Promise<BulkIdResponseDto[]>;
-export declare function getTimeBucket({ albumId, isFavorite, isTrashed, key, order, page, pageSize, personId, tagId, timeBucket, userId, visibility, withPartners, withStacked }: {
+export declare function getTimeBucket({ albumId, isFavorite, isTrashed, key, order, personId, tagId, timeBucket, userId, visibility, withPartners, withStacked }: {
     albumId?: string;
     isFavorite?: boolean;
     isTrashed?: boolean;
     key?: string;
     order?: AssetOrder;
-    page?: number;
-    pageSize?: number;
     personId?: string;
     tagId?: string;
     timeBucket: string;
@@ -2049,6 +2159,11 @@ export declare function getUserLicense(opts?: Oazapfts.RequestOpts): Promise<Lic
 export declare function setUserLicense({ licenseKeyDto }: {
     licenseKeyDto: LicenseKeyDto;
 }, opts?: Oazapfts.RequestOpts): Promise<LicenseResponseDto>;
+export declare function deleteUserOnboarding(opts?: Oazapfts.RequestOpts): Promise<never>;
+export declare function getUserOnboarding(opts?: Oazapfts.RequestOpts): Promise<OnboardingResponseDto>;
+export declare function setUserOnboarding({ onboardingDto }: {
+    onboardingDto: OnboardingDto;
+}, opts?: Oazapfts.RequestOpts): Promise<OnboardingResponseDto>;
 export declare function getMyPreferences(opts?: Oazapfts.RequestOpts): Promise<UserPreferencesResponseDto>;
 export declare function updateMyPreferences({ userPreferencesUpdateDto }: {
     userPreferencesUpdateDto: UserPreferencesUpdateDto;
@@ -2104,6 +2219,10 @@ export declare enum UserStatus {
     Removing = "removing",
     Deleted = "deleted"
 }
+export declare enum AssetOrder {
+    Asc = "asc",
+    Desc = "desc"
+}
 export declare enum AssetVisibility {
     Archive = "archive",
     Timeline = "timeline",
@@ -2125,10 +2244,6 @@ export declare enum AssetTypeEnum {
     Audio = "AUDIO",
     Other = "OTHER"
 }
-export declare enum AssetOrder {
-    Asc = "asc",
-    Desc = "desc"
-}
 export declare enum Error {
     Duplicate = "duplicate",
     NoPermission = "no_permission",
@@ -2309,12 +2424,15 @@ export declare enum SyncEntityType {
     AssetDeleteV1 = "AssetDeleteV1",
     AssetExifV1 = "AssetExifV1",
     PartnerAssetV1 = "PartnerAssetV1",
+    PartnerAssetBackfillV1 = "PartnerAssetBackfillV1",
     PartnerAssetDeleteV1 = "PartnerAssetDeleteV1",
     PartnerAssetExifV1 = "PartnerAssetExifV1",
+    PartnerAssetExifBackfillV1 = "PartnerAssetExifBackfillV1",
     AlbumV1 = "AlbumV1",
     AlbumDeleteV1 = "AlbumDeleteV1",
     AlbumUserV1 = "AlbumUserV1",
-    AlbumUserDeleteV1 = "AlbumUserDeleteV1"
+    AlbumUserDeleteV1 = "AlbumUserDeleteV1",
+    SyncAckV1 = "SyncAckV1"
 }
 export declare enum SyncRequestType {
     UsersV1 = "UsersV1",

package/build/fetch-client.js

@@ -1,6 +1,6 @@
 /**
  * Immich
- * 1.134.0
+ * 1.135.0
  * DO NOT MODIFY - This file has been generated using oazapfts.
  * See https://www.npmjs.com/package/oazapfts
  */
@@ -453,11 +453,24 @@ export function getDownloadInfo({ key, downloadInfoDto }, opts) {
         body: downloadInfoDto
     })));
 }
+export function deleteDuplicates({ bulkIdsDto }, opts) {
+    return oazapfts.ok(oazapfts.fetchText("/duplicates", oazapfts.json({
+        ...opts,
+        method: "DELETE",
+        body: bulkIdsDto
+    })));
+}
 export function getAssetDuplicates(opts) {
     return oazapfts.ok(oazapfts.fetchJson("/duplicates", {
         ...opts
     }));
 }
+export function deleteDuplicate({ id }, opts) {
+    return oazapfts.ok(oazapfts.fetchText(`/duplicates/${encodeURIComponent(id)}`, {
+        ...opts,
+        method: "DELETE"
+    }));
+}
 export function getFaces({ id }, opts) {
     return oazapfts.ok(oazapfts.fetchJson(`/faces${QS.query(QS.explode({
         id
@@ -590,6 +603,16 @@ export function createMemory({ memoryCreateDto }, opts) {
         body: memoryCreateDto
     })));
 }
+export function memoriesStatistics({ $for, isSaved, isTrashed, $type }, opts) {
+    return oazapfts.ok(oazapfts.fetchJson(`/memories/statistics${QS.query(QS.explode({
+        "for": $for,
+        isSaved,
+        isTrashed,
+        "type": $type
+    }))}`, {
+        ...opts
+    }));
+}
 export function deleteMemory({ id }, opts) {
     return oazapfts.ok(oazapfts.fetchText(`/memories/${encodeURIComponent(id)}`, {
         ...opts,
@@ -829,6 +852,13 @@ export function searchSmart({ smartSearchDto }, opts) {
         body: smartSearchDto
     })));
 }
+export function searchAssetStatistics({ statisticsSearchDto }, opts) {
+    return oazapfts.ok(oazapfts.fetchJson("/search/statistics", oazapfts.json({
+        ...opts,
+        method: "POST",
+        body: statisticsSearchDto
+    })));
+}
 export function getSearchSuggestions({ country, includeNull, make, model, state, $type }, opts) {
     return oazapfts.ok(oazapfts.fetchJson(`/search/suggestions${QS.query(QS.explode({
         country,
@@ -846,6 +876,11 @@ export function getAboutInfo(opts) {
         ...opts
     }));
 }
+export function getApkLinks(opts) {
+    return oazapfts.ok(oazapfts.fetchJson("/server/apk-links", {
+        ...opts
+    }));
+}
 export function getServerConfig(opts) {
     return oazapfts.ok(oazapfts.fetchJson("/server/config", {
         ...opts
@@ -1184,15 +1219,13 @@ export function tagAssets({ id, bulkIdsDto }, opts) {
         body: bulkIdsDto
     })));
 }
-export function getTimeBucket({ albumId, isFavorite, isTrashed, key, order, page, pageSize, personId, tagId, timeBucket, userId, visibility, withPartners, withStacked }, opts) {
+export function getTimeBucket({ albumId, isFavorite, isTrashed, key, order, personId, tagId, timeBucket, userId, visibility, withPartners, withStacked }, opts) {
     return oazapfts.ok(oazapfts.fetchJson(`/timeline/bucket${QS.query(QS.explode({
         albumId,
         isFavorite,
         isTrashed,
         key,
         order,
-        page,
-        pageSize,
         personId,
         tagId,
         timeBucket,
@@ -1275,6 +1308,24 @@ export function setUserLicense({ licenseKeyDto }, opts) {
         body: licenseKeyDto
     })));
 }
+export function deleteUserOnboarding(opts) {
+    return oazapfts.ok(oazapfts.fetchText("/users/me/onboarding", {
+        ...opts,
+        method: "DELETE"
+    }));
+}
+export function getUserOnboarding(opts) {
+    return oazapfts.ok(oazapfts.fetchJson("/users/me/onboarding", {
+        ...opts
+    }));
+}
+export function setUserOnboarding({ onboardingDto }, opts) {
+    return oazapfts.ok(oazapfts.fetchJson("/users/me/onboarding", oazapfts.json({
+        ...opts,
+        method: "PUT",
+        body: onboardingDto
+    })));
+}
 export function getMyPreferences(opts) {
     return oazapfts.ok(oazapfts.fetchJson("/users/me/preferences", {
         ...opts
@@ -1365,6 +1416,11 @@ export var UserStatus;
     UserStatus["Removing"] = "removing";
     UserStatus["Deleted"] = "deleted";
 })(UserStatus || (UserStatus = {}));
+export var AssetOrder;
+(function (AssetOrder) {
+    AssetOrder["Asc"] = "asc";
+    AssetOrder["Desc"] = "desc";
+})(AssetOrder || (AssetOrder = {}));
 export var AssetVisibility;
 (function (AssetVisibility) {
     AssetVisibility["Archive"] = "archive";
@@ -1390,11 +1446,6 @@ export var AssetTypeEnum;
     AssetTypeEnum["Audio"] = "AUDIO";
     AssetTypeEnum["Other"] = "OTHER";
 })(AssetTypeEnum || (AssetTypeEnum = {}));
-export var AssetOrder;
-(function (AssetOrder) {
-    AssetOrder["Asc"] = "asc";
-    AssetOrder["Desc"] = "desc";
-})(AssetOrder || (AssetOrder = {}));
 export var Error;
 (function (Error) {
     Error["Duplicate"] = "duplicate";
@@ -1591,12 +1642,15 @@ export var SyncEntityType;
     SyncEntityType["AssetDeleteV1"] = "AssetDeleteV1";
     SyncEntityType["AssetExifV1"] = "AssetExifV1";
     SyncEntityType["PartnerAssetV1"] = "PartnerAssetV1";
+    SyncEntityType["PartnerAssetBackfillV1"] = "PartnerAssetBackfillV1";
     SyncEntityType["PartnerAssetDeleteV1"] = "PartnerAssetDeleteV1";
     SyncEntityType["PartnerAssetExifV1"] = "PartnerAssetExifV1";
+    SyncEntityType["PartnerAssetExifBackfillV1"] = "PartnerAssetExifBackfillV1";
     SyncEntityType["AlbumV1"] = "AlbumV1";
     SyncEntityType["AlbumDeleteV1"] = "AlbumDeleteV1";
     SyncEntityType["AlbumUserV1"] = "AlbumUserV1";
     SyncEntityType["AlbumUserDeleteV1"] = "AlbumUserDeleteV1";
+    SyncEntityType["SyncAckV1"] = "SyncAckV1";
 })(SyncEntityType || (SyncEntityType = {}));
 export var SyncRequestType;
 (function (SyncRequestType) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@immich/sdk",
-  "version": "1.134.0",
+  "version": "1.135.0",
   "description": "Auto-generated TypeScript SDK for the Immich API",
   "type": "module",
   "main": "./build/index.js",
@@ -19,7 +19,7 @@
     "@oazapfts/runtime": "^1.0.2"
   },
   "devDependencies": {
-    "@types/node": "^22.15.21",
+    "@types/node": "^22.15.31",
     "typescript": "^5.3.3"
   },
   "repository": {