@immich/sdk 2.2.2 → 2.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Immich
3
- * 2.2.2
3
+ * 2.3.0
4
4
  * DO NOT MODIFY - This file has been generated using oazapfts.
5
5
  * See https://www.npmjs.com/package/oazapfts
6
6
  */
@@ -35,6 +35,15 @@ export type ActivityStatisticsResponseDto = {
35
35
  comments: number;
36
36
  likes: number;
37
37
  };
38
+ export type SetMaintenanceModeDto = {
39
+ action: MaintenanceAction;
40
+ };
41
+ export type MaintenanceLoginDto = {
42
+ token?: string;
43
+ };
44
+ export type MaintenanceAuthDto = {
45
+ username: string;
46
+ };
38
47
  export type NotificationCreateDto = {
39
48
  data?: object;
40
49
  description?: string | null;
@@ -147,6 +156,7 @@ export type FoldersResponse = {
147
156
  sidebarWeb: boolean;
148
157
  };
149
158
  export type MemoriesResponse = {
159
+ duration: number;
150
160
  enabled: boolean;
151
161
  };
152
162
  export type PeopleResponse = {
@@ -204,6 +214,7 @@ export type FoldersUpdate = {
204
214
  sidebarWeb?: boolean;
205
215
  };
206
216
  export type MemoriesUpdate = {
217
+ duration?: number;
207
218
  enabled?: boolean;
208
219
  };
209
220
  export type PeopleUpdate = {
@@ -295,16 +306,13 @@ export type AssetFaceWithoutPersonResponseDto = {
295
306
  };
296
307
  export type PersonWithFacesResponseDto = {
297
308
  birthDate: string | null;
298
- /** This property was added in v1.126.0 */
299
309
  color?: string;
300
310
  faces: AssetFaceWithoutPersonResponseDto[];
301
311
  id: string;
302
- /** This property was added in v1.126.0 */
303
312
  isFavorite?: boolean;
304
313
  isHidden: boolean;
305
314
  name: string;
306
315
  thumbnailPath: string;
307
- /** This property was added in v1.107.0 */
308
316
  updatedAt?: string;
309
317
  };
310
318
  export type AssetStackResponseDto = {
@@ -341,7 +349,6 @@ export type AssetResponseDto = {
341
349
  isFavorite: boolean;
342
350
  isOffline: boolean;
343
351
  isTrashed: boolean;
344
- /** This property was deprecated in v1.106.0 */
345
352
  libraryId?: string | null;
346
353
  livePhotoVideoId?: string | null;
347
354
  /** 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. */
@@ -352,7 +359,6 @@ export type AssetResponseDto = {
352
359
  owner?: UserResponseDto;
353
360
  ownerId: string;
354
361
  people?: PersonWithFacesResponseDto[];
355
- /** This property was deprecated in v1.113.0 */
356
362
  resized?: boolean;
357
363
  stack?: (AssetStackResponseDto) | null;
358
364
  tags?: TagResponseDto[];
@@ -662,15 +668,12 @@ export type DuplicateResponseDto = {
662
668
  };
663
669
  export type PersonResponseDto = {
664
670
  birthDate: string | null;
665
- /** This property was added in v1.126.0 */
666
671
  color?: string;
667
672
  id: string;
668
- /** This property was added in v1.126.0 */
669
673
  isFavorite?: boolean;
670
674
  isHidden: boolean;
671
675
  name: string;
672
676
  thumbnailPath: string;
673
- /** This property was added in v1.107.0 */
674
677
  updatedAt?: string;
675
678
  };
676
679
  export type AssetFaceResponseDto = {
@@ -700,7 +703,7 @@ export type AssetFaceDeleteDto = {
700
703
  export type FaceDto = {
701
704
  id: string;
702
705
  };
703
- export type JobCountsDto = {
706
+ export type QueueStatisticsDto = {
704
707
  active: number;
705
708
  completed: number;
706
709
  delayed: number;
@@ -712,33 +715,34 @@ export type QueueStatusDto = {
712
715
  isActive: boolean;
713
716
  isPaused: boolean;
714
717
  };
715
- export type JobStatusDto = {
716
- jobCounts: JobCountsDto;
718
+ export type QueueResponseDto = {
719
+ jobCounts: QueueStatisticsDto;
717
720
  queueStatus: QueueStatusDto;
718
721
  };
719
- export type AllJobStatusResponseDto = {
720
- backgroundTask: JobStatusDto;
721
- backupDatabase: JobStatusDto;
722
- duplicateDetection: JobStatusDto;
723
- faceDetection: JobStatusDto;
724
- facialRecognition: JobStatusDto;
725
- library: JobStatusDto;
726
- metadataExtraction: JobStatusDto;
727
- migration: JobStatusDto;
728
- notifications: JobStatusDto;
729
- ocr: JobStatusDto;
730
- search: JobStatusDto;
731
- sidecar: JobStatusDto;
732
- smartSearch: JobStatusDto;
733
- storageTemplateMigration: JobStatusDto;
734
- thumbnailGeneration: JobStatusDto;
735
- videoConversion: JobStatusDto;
722
+ export type QueuesResponseDto = {
723
+ backgroundTask: QueueResponseDto;
724
+ backupDatabase: QueueResponseDto;
725
+ duplicateDetection: QueueResponseDto;
726
+ faceDetection: QueueResponseDto;
727
+ facialRecognition: QueueResponseDto;
728
+ library: QueueResponseDto;
729
+ metadataExtraction: QueueResponseDto;
730
+ migration: QueueResponseDto;
731
+ notifications: QueueResponseDto;
732
+ ocr: QueueResponseDto;
733
+ search: QueueResponseDto;
734
+ sidecar: QueueResponseDto;
735
+ smartSearch: QueueResponseDto;
736
+ storageTemplateMigration: QueueResponseDto;
737
+ thumbnailGeneration: QueueResponseDto;
738
+ videoConversion: QueueResponseDto;
739
+ workflow: QueueResponseDto;
736
740
  };
737
741
  export type JobCreateDto = {
738
742
  name: ManualJobName;
739
743
  };
740
- export type JobCommandDto = {
741
- command: JobCommand;
744
+ export type QueueCommandDto = {
745
+ command: QueueCommand;
742
746
  force?: boolean;
743
747
  };
744
748
  export type LibraryResponseDto = {
@@ -867,7 +871,6 @@ export type PartnerUpdateDto = {
867
871
  inTimeline: boolean;
868
872
  };
869
873
  export type PeopleResponseDto = {
870
- /** This property was added in v1.110.0 */
871
874
  hasNextPage?: boolean;
872
875
  hidden: number;
873
876
  people: PersonResponseDto[];
@@ -928,6 +931,36 @@ export type AssetFaceUpdateDto = {
928
931
  export type PersonStatisticsResponseDto = {
929
932
  assets: number;
930
933
  };
934
+ export type PluginActionResponseDto = {
935
+ description: string;
936
+ id: string;
937
+ methodName: string;
938
+ pluginId: string;
939
+ schema: object | null;
940
+ supportedContexts: PluginContext[];
941
+ title: string;
942
+ };
943
+ export type PluginFilterResponseDto = {
944
+ description: string;
945
+ id: string;
946
+ methodName: string;
947
+ pluginId: string;
948
+ schema: object | null;
949
+ supportedContexts: PluginContext[];
950
+ title: string;
951
+ };
952
+ export type PluginResponseDto = {
953
+ actions: PluginActionResponseDto[];
954
+ author: string;
955
+ createdAt: string;
956
+ description: string;
957
+ filters: PluginFilterResponseDto[];
958
+ id: string;
959
+ name: string;
960
+ title: string;
961
+ updatedAt: string;
962
+ version: string;
963
+ };
931
964
  export type SearchExploreItem = {
932
965
  data: AssetResponseDto;
933
966
  value: string;
@@ -1154,6 +1187,7 @@ export type ServerConfigDto = {
1154
1187
  isInitialized: boolean;
1155
1188
  isOnboarded: boolean;
1156
1189
  loginPageMessage: string;
1190
+ maintenanceMode: boolean;
1157
1191
  mapDarkStyleUrl: string;
1158
1192
  mapLightStyleUrl: string;
1159
1193
  oauthButtonText: string;
@@ -1413,6 +1447,7 @@ export type SystemConfigJobDto = {
1413
1447
  smartSearch: JobSettingsDto;
1414
1448
  thumbnailGeneration: JobSettingsDto;
1415
1449
  videoConversion: JobSettingsDto;
1450
+ workflow: JobSettingsDto;
1416
1451
  };
1417
1452
  export type SystemConfigLibraryScanDto = {
1418
1453
  cronExpression: string;
@@ -1669,8 +1704,56 @@ export type CreateProfileImageResponseDto = {
1669
1704
  profileImagePath: string;
1670
1705
  userId: string;
1671
1706
  };
1707
+ export type WorkflowActionResponseDto = {
1708
+ actionConfig: object | null;
1709
+ actionId: string;
1710
+ id: string;
1711
+ order: number;
1712
+ workflowId: string;
1713
+ };
1714
+ export type WorkflowFilterResponseDto = {
1715
+ filterConfig: object | null;
1716
+ filterId: string;
1717
+ id: string;
1718
+ order: number;
1719
+ workflowId: string;
1720
+ };
1721
+ export type WorkflowResponseDto = {
1722
+ actions: WorkflowActionResponseDto[];
1723
+ createdAt: string;
1724
+ description: string;
1725
+ enabled: boolean;
1726
+ filters: WorkflowFilterResponseDto[];
1727
+ id: string;
1728
+ name: string | null;
1729
+ ownerId: string;
1730
+ triggerType: TriggerType;
1731
+ };
1732
+ export type WorkflowActionItemDto = {
1733
+ actionConfig?: object;
1734
+ actionId: string;
1735
+ };
1736
+ export type WorkflowFilterItemDto = {
1737
+ filterConfig?: object;
1738
+ filterId: string;
1739
+ };
1740
+ export type WorkflowCreateDto = {
1741
+ actions: WorkflowActionItemDto[];
1742
+ description?: string;
1743
+ enabled?: boolean;
1744
+ filters: WorkflowFilterItemDto[];
1745
+ name: string;
1746
+ triggerType: PluginTriggerType;
1747
+ };
1748
+ export type WorkflowUpdateDto = {
1749
+ actions?: WorkflowActionItemDto[];
1750
+ description?: string;
1751
+ enabled?: boolean;
1752
+ filters?: WorkflowFilterItemDto[];
1753
+ name?: string;
1754
+ };
1672
1755
  /**
1673
- * This endpoint requires the `activity.read` permission.
1756
+ * List all activities
1674
1757
  */
1675
1758
  export declare function getActivities({ albumId, assetId, level, $type, userId }: {
1676
1759
  albumId: string;
@@ -1680,98 +1763,119 @@ export declare function getActivities({ albumId, assetId, level, $type, userId }
1680
1763
  userId?: string;
1681
1764
  }, opts?: Oazapfts.RequestOpts): Promise<ActivityResponseDto[]>;
1682
1765
  /**
1683
- * This endpoint requires the `activity.create` permission.
1766
+ * Create an activity
1684
1767
  */
1685
1768
  export declare function createActivity({ activityCreateDto }: {
1686
1769
  activityCreateDto: ActivityCreateDto;
1687
1770
  }, opts?: Oazapfts.RequestOpts): Promise<ActivityResponseDto>;
1688
1771
  /**
1689
- * This endpoint requires the `activity.statistics` permission.
1772
+ * Retrieve activity statistics
1690
1773
  */
1691
1774
  export declare function getActivityStatistics({ albumId, assetId }: {
1692
1775
  albumId: string;
1693
1776
  assetId?: string;
1694
1777
  }, opts?: Oazapfts.RequestOpts): Promise<ActivityStatisticsResponseDto>;
1695
1778
  /**
1696
- * This endpoint requires the `activity.delete` permission.
1779
+ * Delete an activity
1697
1780
  */
1698
1781
  export declare function deleteActivity({ id }: {
1699
1782
  id: string;
1700
1783
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
1701
1784
  /**
1702
- * This endpoint is an admin-only route, and requires the `adminAuth.unlinkAll` permission.
1785
+ * Unlink all OAuth accounts
1703
1786
  */
1704
1787
  export declare function unlinkAllOAuthAccountsAdmin(opts?: Oazapfts.RequestOpts): Promise<never>;
1788
+ /**
1789
+ * Set maintenance mode
1790
+ */
1791
+ export declare function setMaintenanceMode({ setMaintenanceModeDto }: {
1792
+ setMaintenanceModeDto: SetMaintenanceModeDto;
1793
+ }, opts?: Oazapfts.RequestOpts): Promise<never>;
1794
+ /**
1795
+ * Log into maintenance mode
1796
+ */
1797
+ export declare function maintenanceLogin({ maintenanceLoginDto }: {
1798
+ maintenanceLoginDto: MaintenanceLoginDto;
1799
+ }, opts?: Oazapfts.RequestOpts): Promise<MaintenanceAuthDto>;
1800
+ /**
1801
+ * Create a notification
1802
+ */
1705
1803
  export declare function createNotification({ notificationCreateDto }: {
1706
1804
  notificationCreateDto: NotificationCreateDto;
1707
1805
  }, opts?: Oazapfts.RequestOpts): Promise<NotificationDto>;
1806
+ /**
1807
+ * Render email template
1808
+ */
1708
1809
  export declare function getNotificationTemplateAdmin({ name, templateDto }: {
1709
1810
  name: string;
1710
1811
  templateDto: TemplateDto;
1711
1812
  }, opts?: Oazapfts.RequestOpts): Promise<TemplateResponseDto>;
1813
+ /**
1814
+ * Send test email
1815
+ */
1712
1816
  export declare function sendTestEmailAdmin({ systemConfigSmtpDto }: {
1713
1817
  systemConfigSmtpDto: SystemConfigSmtpDto;
1714
1818
  }, opts?: Oazapfts.RequestOpts): Promise<TestEmailResponseDto>;
1715
1819
  /**
1716
- * This endpoint is an admin-only route, and requires the `adminUser.read` permission.
1820
+ * Search users
1717
1821
  */
1718
1822
  export declare function searchUsersAdmin({ id, withDeleted }: {
1719
1823
  id?: string;
1720
1824
  withDeleted?: boolean;
1721
1825
  }, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto[]>;
1722
1826
  /**
1723
- * This endpoint is an admin-only route, and requires the `adminUser.create` permission.
1827
+ * Create a user
1724
1828
  */
1725
1829
  export declare function createUserAdmin({ userAdminCreateDto }: {
1726
1830
  userAdminCreateDto: UserAdminCreateDto;
1727
1831
  }, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
1728
1832
  /**
1729
- * This endpoint is an admin-only route, and requires the `adminUser.delete` permission.
1833
+ * Delete a user
1730
1834
  */
1731
1835
  export declare function deleteUserAdmin({ id, userAdminDeleteDto }: {
1732
1836
  id: string;
1733
1837
  userAdminDeleteDto: UserAdminDeleteDto;
1734
1838
  }, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
1735
1839
  /**
1736
- * This endpoint is an admin-only route, and requires the `adminUser.read` permission.
1840
+ * Retrieve a user
1737
1841
  */
1738
1842
  export declare function getUserAdmin({ id }: {
1739
1843
  id: string;
1740
1844
  }, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
1741
1845
  /**
1742
- * This endpoint is an admin-only route, and requires the `adminUser.update` permission.
1846
+ * Update a user
1743
1847
  */
1744
1848
  export declare function updateUserAdmin({ id, userAdminUpdateDto }: {
1745
1849
  id: string;
1746
1850
  userAdminUpdateDto: UserAdminUpdateDto;
1747
1851
  }, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
1748
1852
  /**
1749
- * This endpoint is an admin-only route, and requires the `adminUser.read` permission.
1853
+ * Retrieve user preferences
1750
1854
  */
1751
1855
  export declare function getUserPreferencesAdmin({ id }: {
1752
1856
  id: string;
1753
1857
  }, opts?: Oazapfts.RequestOpts): Promise<UserPreferencesResponseDto>;
1754
1858
  /**
1755
- * This endpoint is an admin-only route, and requires the `adminUser.update` permission.
1859
+ * Update user preferences
1756
1860
  */
1757
1861
  export declare function updateUserPreferencesAdmin({ id, userPreferencesUpdateDto }: {
1758
1862
  id: string;
1759
1863
  userPreferencesUpdateDto: UserPreferencesUpdateDto;
1760
1864
  }, opts?: Oazapfts.RequestOpts): Promise<UserPreferencesResponseDto>;
1761
1865
  /**
1762
- * This endpoint is an admin-only route, and requires the `adminUser.delete` permission.
1866
+ * Restore a deleted user
1763
1867
  */
1764
1868
  export declare function restoreUserAdmin({ id }: {
1765
1869
  id: string;
1766
1870
  }, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
1767
1871
  /**
1768
- * This endpoint is an admin-only route, and requires the `adminSession.read` permission.
1872
+ * Retrieve user sessions
1769
1873
  */
1770
1874
  export declare function getUserSessionsAdmin({ id }: {
1771
1875
  id: string;
1772
1876
  }, opts?: Oazapfts.RequestOpts): Promise<SessionResponseDto[]>;
1773
1877
  /**
1774
- * This endpoint is an admin-only route, and requires the `adminUser.read` permission.
1878
+ * Retrieve user statistics
1775
1879
  */
1776
1880
  export declare function getUserStatisticsAdmin({ id, isFavorite, isTrashed, visibility }: {
1777
1881
  id: string;
@@ -1780,20 +1884,20 @@ export declare function getUserStatisticsAdmin({ id, isFavorite, isTrashed, visi
1780
1884
  visibility?: AssetVisibility;
1781
1885
  }, opts?: Oazapfts.RequestOpts): Promise<AssetStatsResponseDto>;
1782
1886
  /**
1783
- * This endpoint requires the `album.read` permission.
1887
+ * List all albums
1784
1888
  */
1785
1889
  export declare function getAllAlbums({ assetId, shared }: {
1786
1890
  assetId?: string;
1787
1891
  shared?: boolean;
1788
1892
  }, opts?: Oazapfts.RequestOpts): Promise<AlbumResponseDto[]>;
1789
1893
  /**
1790
- * This endpoint requires the `album.create` permission.
1894
+ * Create an album
1791
1895
  */
1792
1896
  export declare function createAlbum({ createAlbumDto }: {
1793
1897
  createAlbumDto: CreateAlbumDto;
1794
1898
  }, opts?: Oazapfts.RequestOpts): Promise<AlbumResponseDto>;
1795
1899
  /**
1796
- * This endpoint requires the `albumAsset.create` permission.
1900
+ * Add assets to albums
1797
1901
  */
1798
1902
  export declare function addAssetsToAlbums({ key, slug, albumsAddAssetsDto }: {
1799
1903
  key?: string;
@@ -1801,17 +1905,17 @@ export declare function addAssetsToAlbums({ key, slug, albumsAddAssetsDto }: {
1801
1905
  albumsAddAssetsDto: AlbumsAddAssetsDto;
1802
1906
  }, opts?: Oazapfts.RequestOpts): Promise<AlbumsAddAssetsResponseDto>;
1803
1907
  /**
1804
- * This endpoint requires the `album.statistics` permission.
1908
+ * Retrieve album statistics
1805
1909
  */
1806
1910
  export declare function getAlbumStatistics(opts?: Oazapfts.RequestOpts): Promise<AlbumStatisticsResponseDto>;
1807
1911
  /**
1808
- * This endpoint requires the `album.delete` permission.
1912
+ * Delete an album
1809
1913
  */
1810
1914
  export declare function deleteAlbum({ id }: {
1811
1915
  id: string;
1812
1916
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
1813
1917
  /**
1814
- * This endpoint requires the `album.read` permission.
1918
+ * Retrieve an album
1815
1919
  */
1816
1920
  export declare function getAlbumInfo({ id, key, slug, withoutAssets }: {
1817
1921
  id: string;
@@ -1820,21 +1924,21 @@ export declare function getAlbumInfo({ id, key, slug, withoutAssets }: {
1820
1924
  withoutAssets?: boolean;
1821
1925
  }, opts?: Oazapfts.RequestOpts): Promise<AlbumResponseDto>;
1822
1926
  /**
1823
- * This endpoint requires the `album.update` permission.
1927
+ * Update an album
1824
1928
  */
1825
1929
  export declare function updateAlbumInfo({ id, updateAlbumDto }: {
1826
1930
  id: string;
1827
1931
  updateAlbumDto: UpdateAlbumDto;
1828
1932
  }, opts?: Oazapfts.RequestOpts): Promise<AlbumResponseDto>;
1829
1933
  /**
1830
- * This endpoint requires the `albumAsset.delete` permission.
1934
+ * Remove assets from an album
1831
1935
  */
1832
1936
  export declare function removeAssetFromAlbum({ id, bulkIdsDto }: {
1833
1937
  id: string;
1834
1938
  bulkIdsDto: BulkIdsDto;
1835
1939
  }, opts?: Oazapfts.RequestOpts): Promise<BulkIdResponseDto[]>;
1836
1940
  /**
1837
- * This endpoint requires the `albumAsset.create` permission.
1941
+ * Add assets to an album
1838
1942
  */
1839
1943
  export declare function addAssetsToAlbum({ id, key, slug, bulkIdsDto }: {
1840
1944
  id: string;
@@ -1843,14 +1947,14 @@ export declare function addAssetsToAlbum({ id, key, slug, bulkIdsDto }: {
1843
1947
  bulkIdsDto: BulkIdsDto;
1844
1948
  }, opts?: Oazapfts.RequestOpts): Promise<BulkIdResponseDto[]>;
1845
1949
  /**
1846
- * This endpoint requires the `albumUser.delete` permission.
1950
+ * Remove user from album
1847
1951
  */
1848
1952
  export declare function removeUserFromAlbum({ id, userId }: {
1849
1953
  id: string;
1850
1954
  userId: string;
1851
1955
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
1852
1956
  /**
1853
- * This endpoint requires the `albumUser.update` permission.
1957
+ * Update user role
1854
1958
  */
1855
1959
  export declare function updateAlbumUser({ id, userId, updateAlbumUserDto }: {
1856
1960
  id: string;
@@ -1858,50 +1962,53 @@ export declare function updateAlbumUser({ id, userId, updateAlbumUserDto }: {
1858
1962
  updateAlbumUserDto: UpdateAlbumUserDto;
1859
1963
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
1860
1964
  /**
1861
- * This endpoint requires the `albumUser.create` permission.
1965
+ * Share album with users
1862
1966
  */
1863
1967
  export declare function addUsersToAlbum({ id, addUsersDto }: {
1864
1968
  id: string;
1865
1969
  addUsersDto: AddUsersDto;
1866
1970
  }, opts?: Oazapfts.RequestOpts): Promise<AlbumResponseDto>;
1867
1971
  /**
1868
- * This endpoint requires the `apiKey.read` permission.
1972
+ * List all API keys
1869
1973
  */
1870
1974
  export declare function getApiKeys(opts?: Oazapfts.RequestOpts): Promise<ApiKeyResponseDto[]>;
1871
1975
  /**
1872
- * This endpoint requires the `apiKey.create` permission.
1976
+ * Create an API key
1873
1977
  */
1874
1978
  export declare function createApiKey({ apiKeyCreateDto }: {
1875
1979
  apiKeyCreateDto: ApiKeyCreateDto;
1876
1980
  }, opts?: Oazapfts.RequestOpts): Promise<ApiKeyCreateResponseDto>;
1981
+ /**
1982
+ * Retrieve the current API key
1983
+ */
1877
1984
  export declare function getMyApiKey(opts?: Oazapfts.RequestOpts): Promise<ApiKeyResponseDto>;
1878
1985
  /**
1879
- * This endpoint requires the `apiKey.delete` permission.
1986
+ * Delete an API key
1880
1987
  */
1881
1988
  export declare function deleteApiKey({ id }: {
1882
1989
  id: string;
1883
1990
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
1884
1991
  /**
1885
- * This endpoint requires the `apiKey.read` permission.
1992
+ * Retrieve an API key
1886
1993
  */
1887
1994
  export declare function getApiKey({ id }: {
1888
1995
  id: string;
1889
1996
  }, opts?: Oazapfts.RequestOpts): Promise<ApiKeyResponseDto>;
1890
1997
  /**
1891
- * This endpoint requires the `apiKey.update` permission.
1998
+ * Update an API key
1892
1999
  */
1893
2000
  export declare function updateApiKey({ id, apiKeyUpdateDto }: {
1894
2001
  id: string;
1895
2002
  apiKeyUpdateDto: ApiKeyUpdateDto;
1896
2003
  }, opts?: Oazapfts.RequestOpts): Promise<ApiKeyResponseDto>;
1897
2004
  /**
1898
- * This endpoint requires the `asset.delete` permission.
2005
+ * Delete assets
1899
2006
  */
1900
2007
  export declare function deleteAssets({ assetBulkDeleteDto }: {
1901
2008
  assetBulkDeleteDto: AssetBulkDeleteDto;
1902
2009
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
1903
2010
  /**
1904
- * This endpoint requires the `asset.upload` permission.
2011
+ * Upload asset
1905
2012
  */
1906
2013
  export declare function uploadAsset({ key, slug, xImmichChecksum, assetMediaCreateDto }: {
1907
2014
  key?: string;
@@ -1910,46 +2017,49 @@ export declare function uploadAsset({ key, slug, xImmichChecksum, assetMediaCrea
1910
2017
  assetMediaCreateDto: AssetMediaCreateDto;
1911
2018
  }, opts?: Oazapfts.RequestOpts): Promise<AssetMediaResponseDto>;
1912
2019
  /**
1913
- * This endpoint requires the `asset.update` permission.
2020
+ * Update assets
1914
2021
  */
1915
2022
  export declare function updateAssets({ assetBulkUpdateDto }: {
1916
2023
  assetBulkUpdateDto: AssetBulkUpdateDto;
1917
2024
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
1918
2025
  /**
1919
- * checkBulkUpload
2026
+ * Check bulk upload
1920
2027
  */
1921
2028
  export declare function checkBulkUpload({ assetBulkUploadCheckDto }: {
1922
2029
  assetBulkUploadCheckDto: AssetBulkUploadCheckDto;
1923
2030
  }, opts?: Oazapfts.RequestOpts): Promise<AssetBulkUploadCheckResponseDto>;
1924
2031
  /**
1925
- * This endpoint requires the `asset.copy` permission.
2032
+ * Copy asset
1926
2033
  */
1927
2034
  export declare function copyAsset({ assetCopyDto }: {
1928
2035
  assetCopyDto: AssetCopyDto;
1929
2036
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
1930
2037
  /**
1931
- * getAllUserAssetsByDeviceId
2038
+ * Retrieve assets by device ID
1932
2039
  */
1933
2040
  export declare function getAllUserAssetsByDeviceId({ deviceId }: {
1934
2041
  deviceId: string;
1935
2042
  }, opts?: Oazapfts.RequestOpts): Promise<string[]>;
1936
2043
  /**
1937
- * checkExistingAssets
2044
+ * Check existing assets
1938
2045
  */
1939
2046
  export declare function checkExistingAssets({ checkExistingAssetsDto }: {
1940
2047
  checkExistingAssetsDto: CheckExistingAssetsDto;
1941
2048
  }, opts?: Oazapfts.RequestOpts): Promise<CheckExistingAssetsResponseDto>;
2049
+ /**
2050
+ * Run an asset job
2051
+ */
1942
2052
  export declare function runAssetJobs({ assetJobsDto }: {
1943
2053
  assetJobsDto: AssetJobsDto;
1944
2054
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
1945
2055
  /**
1946
- * This property was deprecated in v1.116.0. This endpoint requires the `asset.read` permission.
2056
+ * Get random assets
1947
2057
  */
1948
2058
  export declare function getRandom({ count }: {
1949
2059
  count?: number;
1950
2060
  }, opts?: Oazapfts.RequestOpts): Promise<AssetResponseDto[]>;
1951
2061
  /**
1952
- * This endpoint requires the `asset.statistics` permission.
2062
+ * Get asset statistics
1953
2063
  */
1954
2064
  export declare function getAssetStatistics({ isFavorite, isTrashed, visibility }: {
1955
2065
  isFavorite?: boolean;
@@ -1957,7 +2067,7 @@ export declare function getAssetStatistics({ isFavorite, isTrashed, visibility }
1957
2067
  visibility?: AssetVisibility;
1958
2068
  }, opts?: Oazapfts.RequestOpts): Promise<AssetStatsResponseDto>;
1959
2069
  /**
1960
- * This endpoint requires the `asset.read` permission.
2070
+ * Retrieve an asset
1961
2071
  */
1962
2072
  export declare function getAssetInfo({ id, key, slug }: {
1963
2073
  id: string;
@@ -1965,47 +2075,47 @@ export declare function getAssetInfo({ id, key, slug }: {
1965
2075
  slug?: string;
1966
2076
  }, opts?: Oazapfts.RequestOpts): Promise<AssetResponseDto>;
1967
2077
  /**
1968
- * This endpoint requires the `asset.update` permission.
2078
+ * Update an asset
1969
2079
  */
1970
2080
  export declare function updateAsset({ id, updateAssetDto }: {
1971
2081
  id: string;
1972
2082
  updateAssetDto: UpdateAssetDto;
1973
2083
  }, opts?: Oazapfts.RequestOpts): Promise<AssetResponseDto>;
1974
2084
  /**
1975
- * This endpoint requires the `asset.read` permission.
2085
+ * Get asset metadata
1976
2086
  */
1977
2087
  export declare function getAssetMetadata({ id }: {
1978
2088
  id: string;
1979
2089
  }, opts?: Oazapfts.RequestOpts): Promise<AssetMetadataResponseDto[]>;
1980
2090
  /**
1981
- * This endpoint requires the `asset.update` permission.
2091
+ * Update asset metadata
1982
2092
  */
1983
2093
  export declare function updateAssetMetadata({ id, assetMetadataUpsertDto }: {
1984
2094
  id: string;
1985
2095
  assetMetadataUpsertDto: AssetMetadataUpsertDto;
1986
2096
  }, opts?: Oazapfts.RequestOpts): Promise<AssetMetadataResponseDto[]>;
1987
2097
  /**
1988
- * This endpoint requires the `asset.update` permission.
2098
+ * Delete asset metadata by key
1989
2099
  */
1990
2100
  export declare function deleteAssetMetadata({ id, key }: {
1991
2101
  id: string;
1992
2102
  key: AssetMetadataKey;
1993
2103
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
1994
2104
  /**
1995
- * This endpoint requires the `asset.read` permission.
2105
+ * Retrieve asset metadata by key
1996
2106
  */
1997
2107
  export declare function getAssetMetadataByKey({ id, key }: {
1998
2108
  id: string;
1999
2109
  key: AssetMetadataKey;
2000
2110
  }, opts?: Oazapfts.RequestOpts): Promise<AssetMetadataResponseDto>;
2001
2111
  /**
2002
- * This endpoint requires the `asset.read` permission.
2112
+ * Retrieve asset OCR data
2003
2113
  */
2004
2114
  export declare function getAssetOcr({ id }: {
2005
2115
  id: string;
2006
2116
  }, opts?: Oazapfts.RequestOpts): Promise<AssetOcrResponseDto[]>;
2007
2117
  /**
2008
- * This endpoint requires the `asset.download` permission.
2118
+ * Download original asset
2009
2119
  */
2010
2120
  export declare function downloadAsset({ id, key, slug }: {
2011
2121
  id: string;
@@ -2013,7 +2123,7 @@ export declare function downloadAsset({ id, key, slug }: {
2013
2123
  slug?: string;
2014
2124
  }, opts?: Oazapfts.RequestOpts): Promise<Blob>;
2015
2125
  /**
2016
- * Replace the asset with new file, without changing its id
2126
+ * Replace asset
2017
2127
  */
2018
2128
  export declare function replaceAsset({ id, key, slug, assetMediaReplaceDto }: {
2019
2129
  id: string;
@@ -2022,7 +2132,7 @@ export declare function replaceAsset({ id, key, slug, assetMediaReplaceDto }: {
2022
2132
  assetMediaReplaceDto: AssetMediaReplaceDto;
2023
2133
  }, opts?: Oazapfts.RequestOpts): Promise<AssetMediaResponseDto>;
2024
2134
  /**
2025
- * This endpoint requires the `asset.view` permission.
2135
+ * View asset thumbnail
2026
2136
  */
2027
2137
  export declare function viewAsset({ id, key, size, slug }: {
2028
2138
  id: string;
@@ -2031,52 +2141,73 @@ export declare function viewAsset({ id, key, size, slug }: {
2031
2141
  slug?: string;
2032
2142
  }, opts?: Oazapfts.RequestOpts): Promise<Blob>;
2033
2143
  /**
2034
- * This endpoint requires the `asset.view` permission.
2144
+ * Play asset video
2035
2145
  */
2036
2146
  export declare function playAssetVideo({ id, key, slug }: {
2037
2147
  id: string;
2038
2148
  key?: string;
2039
2149
  slug?: string;
2040
2150
  }, opts?: Oazapfts.RequestOpts): Promise<Blob>;
2151
+ /**
2152
+ * Register admin
2153
+ */
2041
2154
  export declare function signUpAdmin({ signUpDto }: {
2042
2155
  signUpDto: SignUpDto;
2043
2156
  }, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
2044
2157
  /**
2045
- * This endpoint requires the `auth.changePassword` permission.
2158
+ * Change password
2046
2159
  */
2047
2160
  export declare function changePassword({ changePasswordDto }: {
2048
2161
  changePasswordDto: ChangePasswordDto;
2049
2162
  }, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
2163
+ /**
2164
+ * Login
2165
+ */
2050
2166
  export declare function login({ loginCredentialDto }: {
2051
2167
  loginCredentialDto: LoginCredentialDto;
2052
2168
  }, opts?: Oazapfts.RequestOpts): Promise<LoginResponseDto>;
2169
+ /**
2170
+ * Logout
2171
+ */
2053
2172
  export declare function logout(opts?: Oazapfts.RequestOpts): Promise<LogoutResponseDto>;
2054
2173
  /**
2055
- * This endpoint requires the `pinCode.delete` permission.
2174
+ * Reset pin code
2056
2175
  */
2057
2176
  export declare function resetPinCode({ pinCodeResetDto }: {
2058
2177
  pinCodeResetDto: PinCodeResetDto;
2059
2178
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2060
2179
  /**
2061
- * This endpoint requires the `pinCode.create` permission.
2180
+ * Setup pin code
2062
2181
  */
2063
2182
  export declare function setupPinCode({ pinCodeSetupDto }: {
2064
2183
  pinCodeSetupDto: PinCodeSetupDto;
2065
2184
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2066
2185
  /**
2067
- * This endpoint requires the `pinCode.update` permission.
2186
+ * Change pin code
2068
2187
  */
2069
2188
  export declare function changePinCode({ pinCodeChangeDto }: {
2070
2189
  pinCodeChangeDto: PinCodeChangeDto;
2071
2190
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2191
+ /**
2192
+ * Lock auth session
2193
+ */
2072
2194
  export declare function lockAuthSession(opts?: Oazapfts.RequestOpts): Promise<never>;
2195
+ /**
2196
+ * Unlock auth session
2197
+ */
2073
2198
  export declare function unlockAuthSession({ sessionUnlockDto }: {
2074
2199
  sessionUnlockDto: SessionUnlockDto;
2075
2200
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2201
+ /**
2202
+ * Retrieve auth status
2203
+ */
2076
2204
  export declare function getAuthStatus(opts?: Oazapfts.RequestOpts): Promise<AuthStatusResponseDto>;
2205
+ /**
2206
+ * Validate access token
2207
+ */
2077
2208
  export declare function validateAccessToken(opts?: Oazapfts.RequestOpts): Promise<ValidateAccessTokenResponseDto>;
2078
2209
  /**
2079
- * This endpoint requires the `asset.download` permission.
2210
+ * Download asset archive
2080
2211
  */
2081
2212
  export declare function downloadArchive({ key, slug, assetIdsDto }: {
2082
2213
  key?: string;
@@ -2084,7 +2215,7 @@ export declare function downloadArchive({ key, slug, assetIdsDto }: {
2084
2215
  assetIdsDto: AssetIdsDto;
2085
2216
  }, opts?: Oazapfts.RequestOpts): Promise<Blob>;
2086
2217
  /**
2087
- * This endpoint requires the `asset.download` permission.
2218
+ * Retrieve download information
2088
2219
  */
2089
2220
  export declare function getDownloadInfo({ key, slug, downloadInfoDto }: {
2090
2221
  key?: string;
@@ -2092,186 +2223,199 @@ export declare function getDownloadInfo({ key, slug, downloadInfoDto }: {
2092
2223
  downloadInfoDto: DownloadInfoDto;
2093
2224
  }, opts?: Oazapfts.RequestOpts): Promise<DownloadResponseDto>;
2094
2225
  /**
2095
- * This endpoint requires the `duplicate.delete` permission.
2226
+ * Delete duplicates
2096
2227
  */
2097
2228
  export declare function deleteDuplicates({ bulkIdsDto }: {
2098
2229
  bulkIdsDto: BulkIdsDto;
2099
2230
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2100
2231
  /**
2101
- * This endpoint requires the `duplicate.read` permission.
2232
+ * Retrieve duplicates
2102
2233
  */
2103
2234
  export declare function getAssetDuplicates(opts?: Oazapfts.RequestOpts): Promise<DuplicateResponseDto[]>;
2104
2235
  /**
2105
- * This endpoint requires the `duplicate.delete` permission.
2236
+ * Delete a duplicate
2106
2237
  */
2107
2238
  export declare function deleteDuplicate({ id }: {
2108
2239
  id: string;
2109
2240
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2110
2241
  /**
2111
- * This endpoint requires the `face.read` permission.
2242
+ * Retrieve faces for asset
2112
2243
  */
2113
2244
  export declare function getFaces({ id }: {
2114
2245
  id: string;
2115
2246
  }, opts?: Oazapfts.RequestOpts): Promise<AssetFaceResponseDto[]>;
2116
2247
  /**
2117
- * This endpoint requires the `face.create` permission.
2248
+ * Create a face
2118
2249
  */
2119
2250
  export declare function createFace({ assetFaceCreateDto }: {
2120
2251
  assetFaceCreateDto: AssetFaceCreateDto;
2121
2252
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2122
2253
  /**
2123
- * This endpoint requires the `face.delete` permission.
2254
+ * Delete a face
2124
2255
  */
2125
2256
  export declare function deleteFace({ id, assetFaceDeleteDto }: {
2126
2257
  id: string;
2127
2258
  assetFaceDeleteDto: AssetFaceDeleteDto;
2128
2259
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2129
2260
  /**
2130
- * This endpoint requires the `face.update` permission.
2261
+ * Re-assign a face to another person
2131
2262
  */
2132
2263
  export declare function reassignFacesById({ id, faceDto }: {
2133
2264
  id: string;
2134
2265
  faceDto: FaceDto;
2135
2266
  }, opts?: Oazapfts.RequestOpts): Promise<PersonResponseDto>;
2136
2267
  /**
2137
- * This endpoint is an admin-only route, and requires the `job.read` permission.
2268
+ * Retrieve queue counts and status
2138
2269
  */
2139
- export declare function getAllJobsStatus(opts?: Oazapfts.RequestOpts): Promise<AllJobStatusResponseDto>;
2270
+ export declare function getQueuesLegacy(opts?: Oazapfts.RequestOpts): Promise<QueuesResponseDto>;
2140
2271
  /**
2141
- * This endpoint is an admin-only route, and requires the `job.create` permission.
2272
+ * Create a manual job
2142
2273
  */
2143
2274
  export declare function createJob({ jobCreateDto }: {
2144
2275
  jobCreateDto: JobCreateDto;
2145
2276
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2146
2277
  /**
2147
- * This endpoint is an admin-only route, and requires the `job.create` permission.
2278
+ * Run jobs
2148
2279
  */
2149
- export declare function sendJobCommand({ id, jobCommandDto }: {
2150
- id: JobName;
2151
- jobCommandDto: JobCommandDto;
2152
- }, opts?: Oazapfts.RequestOpts): Promise<JobStatusDto>;
2280
+ export declare function runQueueCommandLegacy({ name, queueCommandDto }: {
2281
+ name: QueueName;
2282
+ queueCommandDto: QueueCommandDto;
2283
+ }, opts?: Oazapfts.RequestOpts): Promise<QueueResponseDto>;
2153
2284
  /**
2154
- * This endpoint is an admin-only route, and requires the `library.read` permission.
2285
+ * Retrieve libraries
2155
2286
  */
2156
2287
  export declare function getAllLibraries(opts?: Oazapfts.RequestOpts): Promise<LibraryResponseDto[]>;
2157
2288
  /**
2158
- * This endpoint is an admin-only route, and requires the `library.create` permission.
2289
+ * Create a library
2159
2290
  */
2160
2291
  export declare function createLibrary({ createLibraryDto }: {
2161
2292
  createLibraryDto: CreateLibraryDto;
2162
2293
  }, opts?: Oazapfts.RequestOpts): Promise<LibraryResponseDto>;
2163
2294
  /**
2164
- * This endpoint is an admin-only route, and requires the `library.delete` permission.
2295
+ * Delete a library
2165
2296
  */
2166
2297
  export declare function deleteLibrary({ id }: {
2167
2298
  id: string;
2168
2299
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2169
2300
  /**
2170
- * This endpoint is an admin-only route, and requires the `library.read` permission.
2301
+ * Retrieve a library
2171
2302
  */
2172
2303
  export declare function getLibrary({ id }: {
2173
2304
  id: string;
2174
2305
  }, opts?: Oazapfts.RequestOpts): Promise<LibraryResponseDto>;
2175
2306
  /**
2176
- * This endpoint is an admin-only route, and requires the `library.update` permission.
2307
+ * Update a library
2177
2308
  */
2178
2309
  export declare function updateLibrary({ id, updateLibraryDto }: {
2179
2310
  id: string;
2180
2311
  updateLibraryDto: UpdateLibraryDto;
2181
2312
  }, opts?: Oazapfts.RequestOpts): Promise<LibraryResponseDto>;
2182
2313
  /**
2183
- * This endpoint is an admin-only route, and requires the `library.update` permission.
2314
+ * Scan a library
2184
2315
  */
2185
2316
  export declare function scanLibrary({ id }: {
2186
2317
  id: string;
2187
2318
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2188
2319
  /**
2189
- * This endpoint is an admin-only route, and requires the `library.statistics` permission.
2320
+ * Retrieve library statistics
2190
2321
  */
2191
2322
  export declare function getLibraryStatistics({ id }: {
2192
2323
  id: string;
2193
2324
  }, opts?: Oazapfts.RequestOpts): Promise<LibraryStatsResponseDto>;
2325
+ /**
2326
+ * Validate library settings
2327
+ */
2194
2328
  export declare function validate({ id, validateLibraryDto }: {
2195
2329
  id: string;
2196
2330
  validateLibraryDto: ValidateLibraryDto;
2197
2331
  }, opts?: Oazapfts.RequestOpts): Promise<ValidateLibraryResponseDto>;
2198
- export declare function getMapMarkers({ isArchived, isFavorite, fileCreatedAfter, fileCreatedBefore, withPartners, withSharedAlbums }: {
2199
- isArchived?: boolean;
2200
- isFavorite?: boolean;
2332
+ /**
2333
+ * Retrieve map markers
2334
+ */
2335
+ export declare function getMapMarkers({ fileCreatedAfter, fileCreatedBefore, isArchived, isFavorite, withPartners, withSharedAlbums }: {
2201
2336
  fileCreatedAfter?: string;
2202
2337
  fileCreatedBefore?: string;
2338
+ isArchived?: boolean;
2339
+ isFavorite?: boolean;
2203
2340
  withPartners?: boolean;
2204
2341
  withSharedAlbums?: boolean;
2205
2342
  }, opts?: Oazapfts.RequestOpts): Promise<MapMarkerResponseDto[]>;
2343
+ /**
2344
+ * Reverse geocode coordinates
2345
+ */
2206
2346
  export declare function reverseGeocode({ lat, lon }: {
2207
2347
  lat: number;
2208
2348
  lon: number;
2209
2349
  }, opts?: Oazapfts.RequestOpts): Promise<MapReverseGeocodeResponseDto[]>;
2210
2350
  /**
2211
- * This endpoint requires the `memory.read` permission.
2351
+ * Retrieve memories
2212
2352
  */
2213
- export declare function searchMemories({ $for, isSaved, isTrashed, $type }: {
2353
+ export declare function searchMemories({ $for, isSaved, isTrashed, order, size, $type }: {
2214
2354
  $for?: string;
2215
2355
  isSaved?: boolean;
2216
2356
  isTrashed?: boolean;
2357
+ order?: MemorySearchOrder;
2358
+ size?: number;
2217
2359
  $type?: MemoryType;
2218
2360
  }, opts?: Oazapfts.RequestOpts): Promise<MemoryResponseDto[]>;
2219
2361
  /**
2220
- * This endpoint requires the `memory.create` permission.
2362
+ * Create a memory
2221
2363
  */
2222
2364
  export declare function createMemory({ memoryCreateDto }: {
2223
2365
  memoryCreateDto: MemoryCreateDto;
2224
2366
  }, opts?: Oazapfts.RequestOpts): Promise<MemoryResponseDto>;
2225
2367
  /**
2226
- * This endpoint requires the `memory.statistics` permission.
2368
+ * Retrieve memories statistics
2227
2369
  */
2228
- export declare function memoriesStatistics({ $for, isSaved, isTrashed, $type }: {
2370
+ export declare function memoriesStatistics({ $for, isSaved, isTrashed, order, size, $type }: {
2229
2371
  $for?: string;
2230
2372
  isSaved?: boolean;
2231
2373
  isTrashed?: boolean;
2374
+ order?: MemorySearchOrder;
2375
+ size?: number;
2232
2376
  $type?: MemoryType;
2233
2377
  }, opts?: Oazapfts.RequestOpts): Promise<MemoryStatisticsResponseDto>;
2234
2378
  /**
2235
- * This endpoint requires the `memory.delete` permission.
2379
+ * Delete a memory
2236
2380
  */
2237
2381
  export declare function deleteMemory({ id }: {
2238
2382
  id: string;
2239
2383
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2240
2384
  /**
2241
- * This endpoint requires the `memory.read` permission.
2385
+ * Retrieve a memory
2242
2386
  */
2243
2387
  export declare function getMemory({ id }: {
2244
2388
  id: string;
2245
2389
  }, opts?: Oazapfts.RequestOpts): Promise<MemoryResponseDto>;
2246
2390
  /**
2247
- * This endpoint requires the `memory.update` permission.
2391
+ * Update a memory
2248
2392
  */
2249
2393
  export declare function updateMemory({ id, memoryUpdateDto }: {
2250
2394
  id: string;
2251
2395
  memoryUpdateDto: MemoryUpdateDto;
2252
2396
  }, opts?: Oazapfts.RequestOpts): Promise<MemoryResponseDto>;
2253
2397
  /**
2254
- * This endpoint requires the `memoryAsset.delete` permission.
2398
+ * Remove assets from a memory
2255
2399
  */
2256
2400
  export declare function removeMemoryAssets({ id, bulkIdsDto }: {
2257
2401
  id: string;
2258
2402
  bulkIdsDto: BulkIdsDto;
2259
2403
  }, opts?: Oazapfts.RequestOpts): Promise<BulkIdResponseDto[]>;
2260
2404
  /**
2261
- * This endpoint requires the `memoryAsset.create` permission.
2405
+ * Add assets to a memory
2262
2406
  */
2263
2407
  export declare function addMemoryAssets({ id, bulkIdsDto }: {
2264
2408
  id: string;
2265
2409
  bulkIdsDto: BulkIdsDto;
2266
2410
  }, opts?: Oazapfts.RequestOpts): Promise<BulkIdResponseDto[]>;
2267
2411
  /**
2268
- * This endpoint requires the `notification.delete` permission.
2412
+ * Delete notifications
2269
2413
  */
2270
2414
  export declare function deleteNotifications({ notificationDeleteAllDto }: {
2271
2415
  notificationDeleteAllDto: NotificationDeleteAllDto;
2272
2416
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2273
2417
  /**
2274
- * This endpoint requires the `notification.read` permission.
2418
+ * Retrieve notifications
2275
2419
  */
2276
2420
  export declare function getNotifications({ id, level, $type, unread }: {
2277
2421
  id?: string;
@@ -2280,80 +2424,95 @@ export declare function getNotifications({ id, level, $type, unread }: {
2280
2424
  unread?: boolean;
2281
2425
  }, opts?: Oazapfts.RequestOpts): Promise<NotificationDto[]>;
2282
2426
  /**
2283
- * This endpoint requires the `notification.update` permission.
2427
+ * Update notifications
2284
2428
  */
2285
2429
  export declare function updateNotifications({ notificationUpdateAllDto }: {
2286
2430
  notificationUpdateAllDto: NotificationUpdateAllDto;
2287
2431
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2288
2432
  /**
2289
- * This endpoint requires the `notification.delete` permission.
2433
+ * Delete a notification
2290
2434
  */
2291
2435
  export declare function deleteNotification({ id }: {
2292
2436
  id: string;
2293
2437
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2294
2438
  /**
2295
- * This endpoint requires the `notification.read` permission.
2439
+ * Get a notification
2296
2440
  */
2297
2441
  export declare function getNotification({ id }: {
2298
2442
  id: string;
2299
2443
  }, opts?: Oazapfts.RequestOpts): Promise<NotificationDto>;
2300
2444
  /**
2301
- * This endpoint requires the `notification.update` permission.
2445
+ * Update a notification
2302
2446
  */
2303
2447
  export declare function updateNotification({ id, notificationUpdateDto }: {
2304
2448
  id: string;
2305
2449
  notificationUpdateDto: NotificationUpdateDto;
2306
2450
  }, opts?: Oazapfts.RequestOpts): Promise<NotificationDto>;
2451
+ /**
2452
+ * Start OAuth
2453
+ */
2307
2454
  export declare function startOAuth({ oAuthConfigDto }: {
2308
2455
  oAuthConfigDto: OAuthConfigDto;
2309
2456
  }, opts?: Oazapfts.RequestOpts): Promise<OAuthAuthorizeResponseDto>;
2457
+ /**
2458
+ * Finish OAuth
2459
+ */
2310
2460
  export declare function finishOAuth({ oAuthCallbackDto }: {
2311
2461
  oAuthCallbackDto: OAuthCallbackDto;
2312
2462
  }, opts?: Oazapfts.RequestOpts): Promise<LoginResponseDto>;
2463
+ /**
2464
+ * Link OAuth account
2465
+ */
2313
2466
  export declare function linkOAuthAccount({ oAuthCallbackDto }: {
2314
2467
  oAuthCallbackDto: OAuthCallbackDto;
2315
2468
  }, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
2469
+ /**
2470
+ * Redirect OAuth to mobile
2471
+ */
2316
2472
  export declare function redirectOAuthToMobile(opts?: Oazapfts.RequestOpts): Promise<never>;
2473
+ /**
2474
+ * Unlink OAuth account
2475
+ */
2317
2476
  export declare function unlinkOAuthAccount(opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
2318
2477
  /**
2319
- * This endpoint requires the `partner.read` permission.
2478
+ * Retrieve partners
2320
2479
  */
2321
2480
  export declare function getPartners({ direction }: {
2322
2481
  direction: PartnerDirection;
2323
2482
  }, opts?: Oazapfts.RequestOpts): Promise<PartnerResponseDto[]>;
2324
2483
  /**
2325
- * This endpoint requires the `partner.create` permission.
2484
+ * Create a partner
2326
2485
  */
2327
2486
  export declare function createPartner({ partnerCreateDto }: {
2328
2487
  partnerCreateDto: PartnerCreateDto;
2329
2488
  }, opts?: Oazapfts.RequestOpts): Promise<PartnerResponseDto>;
2330
2489
  /**
2331
- * This endpoint requires the `partner.delete` permission.
2490
+ * Remove a partner
2332
2491
  */
2333
2492
  export declare function removePartner({ id }: {
2334
2493
  id: string;
2335
2494
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2336
2495
  /**
2337
- * This property was deprecated in v1.141.0. This endpoint requires the `partner.create` permission.
2496
+ * Create a partner
2338
2497
  */
2339
2498
  export declare function createPartnerDeprecated({ id }: {
2340
2499
  id: string;
2341
2500
  }, opts?: Oazapfts.RequestOpts): Promise<PartnerResponseDto>;
2342
2501
  /**
2343
- * This endpoint requires the `partner.update` permission.
2502
+ * Update a partner
2344
2503
  */
2345
2504
  export declare function updatePartner({ id, partnerUpdateDto }: {
2346
2505
  id: string;
2347
2506
  partnerUpdateDto: PartnerUpdateDto;
2348
2507
  }, opts?: Oazapfts.RequestOpts): Promise<PartnerResponseDto>;
2349
2508
  /**
2350
- * This endpoint requires the `person.delete` permission.
2509
+ * Delete people
2351
2510
  */
2352
2511
  export declare function deletePeople({ bulkIdsDto }: {
2353
2512
  bulkIdsDto: BulkIdsDto;
2354
2513
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2355
2514
  /**
2356
- * This endpoint requires the `person.read` permission.
2515
+ * Get all people
2357
2516
  */
2358
2517
  export declare function getAllPeople({ closestAssetId, closestPersonId, page, size, withHidden }: {
2359
2518
  closestAssetId?: string;
@@ -2363,72 +2522,82 @@ export declare function getAllPeople({ closestAssetId, closestPersonId, page, si
2363
2522
  withHidden?: boolean;
2364
2523
  }, opts?: Oazapfts.RequestOpts): Promise<PeopleResponseDto>;
2365
2524
  /**
2366
- * This endpoint requires the `person.create` permission.
2525
+ * Create a person
2367
2526
  */
2368
2527
  export declare function createPerson({ personCreateDto }: {
2369
2528
  personCreateDto: PersonCreateDto;
2370
2529
  }, opts?: Oazapfts.RequestOpts): Promise<PersonResponseDto>;
2371
2530
  /**
2372
- * This endpoint requires the `person.update` permission.
2531
+ * Update people
2373
2532
  */
2374
2533
  export declare function updatePeople({ peopleUpdateDto }: {
2375
2534
  peopleUpdateDto: PeopleUpdateDto;
2376
2535
  }, opts?: Oazapfts.RequestOpts): Promise<BulkIdResponseDto[]>;
2377
2536
  /**
2378
- * This endpoint requires the `person.delete` permission.
2537
+ * Delete person
2379
2538
  */
2380
2539
  export declare function deletePerson({ id }: {
2381
2540
  id: string;
2382
2541
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2383
2542
  /**
2384
- * This endpoint requires the `person.read` permission.
2543
+ * Get a person
2385
2544
  */
2386
2545
  export declare function getPerson({ id }: {
2387
2546
  id: string;
2388
2547
  }, opts?: Oazapfts.RequestOpts): Promise<PersonResponseDto>;
2389
2548
  /**
2390
- * This endpoint requires the `person.update` permission.
2549
+ * Update person
2391
2550
  */
2392
2551
  export declare function updatePerson({ id, personUpdateDto }: {
2393
2552
  id: string;
2394
2553
  personUpdateDto: PersonUpdateDto;
2395
2554
  }, opts?: Oazapfts.RequestOpts): Promise<PersonResponseDto>;
2396
2555
  /**
2397
- * This endpoint requires the `person.merge` permission.
2556
+ * Merge people
2398
2557
  */
2399
2558
  export declare function mergePerson({ id, mergePersonDto }: {
2400
2559
  id: string;
2401
2560
  mergePersonDto: MergePersonDto;
2402
2561
  }, opts?: Oazapfts.RequestOpts): Promise<BulkIdResponseDto[]>;
2403
2562
  /**
2404
- * This endpoint requires the `person.reassign` permission.
2563
+ * Reassign faces
2405
2564
  */
2406
2565
  export declare function reassignFaces({ id, assetFaceUpdateDto }: {
2407
2566
  id: string;
2408
2567
  assetFaceUpdateDto: AssetFaceUpdateDto;
2409
2568
  }, opts?: Oazapfts.RequestOpts): Promise<PersonResponseDto[]>;
2410
2569
  /**
2411
- * This endpoint requires the `person.statistics` permission.
2570
+ * Get person statistics
2412
2571
  */
2413
2572
  export declare function getPersonStatistics({ id }: {
2414
2573
  id: string;
2415
2574
  }, opts?: Oazapfts.RequestOpts): Promise<PersonStatisticsResponseDto>;
2416
2575
  /**
2417
- * This endpoint requires the `person.read` permission.
2576
+ * Get person thumbnail
2418
2577
  */
2419
2578
  export declare function getPersonThumbnail({ id }: {
2420
2579
  id: string;
2421
2580
  }, opts?: Oazapfts.RequestOpts): Promise<Blob>;
2422
2581
  /**
2423
- * This endpoint requires the `asset.read` permission.
2582
+ * List all plugins
2583
+ */
2584
+ export declare function getPlugins(opts?: Oazapfts.RequestOpts): Promise<PluginResponseDto[]>;
2585
+ /**
2586
+ * Retrieve a plugin
2587
+ */
2588
+ export declare function getPlugin({ id }: {
2589
+ id: string;
2590
+ }, opts?: Oazapfts.RequestOpts): Promise<PluginResponseDto>;
2591
+ /**
2592
+ * Retrieve assets by city
2424
2593
  */
2425
2594
  export declare function getAssetsByCity(opts?: Oazapfts.RequestOpts): Promise<AssetResponseDto[]>;
2426
2595
  /**
2427
- * This endpoint requires the `asset.read` permission.
2596
+ * Retrieve explore data
2428
2597
  */
2429
2598
  export declare function getExploreData(opts?: Oazapfts.RequestOpts): Promise<SearchExploreResponseDto[]>;
2430
2599
  /**
2431
- * This endpoint requires the `asset.read` permission.
2600
+ * Search large assets
2432
2601
  */
2433
2602
  export declare 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 }: {
2434
2603
  albumIds?: string[];
@@ -2465,44 +2634,44 @@ export declare function searchLargeAssets({ albumIds, city, country, createdAfte
2465
2634
  withExif?: boolean;
2466
2635
  }, opts?: Oazapfts.RequestOpts): Promise<AssetResponseDto[]>;
2467
2636
  /**
2468
- * This endpoint requires the `asset.read` permission.
2637
+ * Search assets by metadata
2469
2638
  */
2470
2639
  export declare function searchAssets({ metadataSearchDto }: {
2471
2640
  metadataSearchDto: MetadataSearchDto;
2472
2641
  }, opts?: Oazapfts.RequestOpts): Promise<SearchResponseDto>;
2473
2642
  /**
2474
- * This endpoint requires the `person.read` permission.
2643
+ * Search people
2475
2644
  */
2476
2645
  export declare function searchPerson({ name, withHidden }: {
2477
2646
  name: string;
2478
2647
  withHidden?: boolean;
2479
2648
  }, opts?: Oazapfts.RequestOpts): Promise<PersonResponseDto[]>;
2480
2649
  /**
2481
- * This endpoint requires the `asset.read` permission.
2650
+ * Search places
2482
2651
  */
2483
2652
  export declare function searchPlaces({ name }: {
2484
2653
  name: string;
2485
2654
  }, opts?: Oazapfts.RequestOpts): Promise<PlacesResponseDto[]>;
2486
2655
  /**
2487
- * This endpoint requires the `asset.read` permission.
2656
+ * Search random assets
2488
2657
  */
2489
2658
  export declare function searchRandom({ randomSearchDto }: {
2490
2659
  randomSearchDto: RandomSearchDto;
2491
2660
  }, opts?: Oazapfts.RequestOpts): Promise<AssetResponseDto[]>;
2492
2661
  /**
2493
- * This endpoint requires the `asset.read` permission.
2662
+ * Smart asset search
2494
2663
  */
2495
2664
  export declare function searchSmart({ smartSearchDto }: {
2496
2665
  smartSearchDto: SmartSearchDto;
2497
2666
  }, opts?: Oazapfts.RequestOpts): Promise<SearchResponseDto>;
2498
2667
  /**
2499
- * This endpoint requires the `asset.statistics` permission.
2668
+ * Search asset statistics
2500
2669
  */
2501
2670
  export declare function searchAssetStatistics({ statisticsSearchDto }: {
2502
2671
  statisticsSearchDto: StatisticsSearchDto;
2503
2672
  }, opts?: Oazapfts.RequestOpts): Promise<SearchStatisticsResponseDto>;
2504
2673
  /**
2505
- * This endpoint requires the `asset.read` permission.
2674
+ * Retrieve search suggestions
2506
2675
  */
2507
2676
  export declare function getSearchSuggestions({ country, includeNull, lensModel, make, model, state, $type }: {
2508
2677
  country?: string;
@@ -2514,122 +2683,152 @@ export declare function getSearchSuggestions({ country, includeNull, lensModel,
2514
2683
  $type: SearchSuggestionType;
2515
2684
  }, opts?: Oazapfts.RequestOpts): Promise<string[]>;
2516
2685
  /**
2517
- * This endpoint requires the `server.about` permission.
2686
+ * Get server information
2518
2687
  */
2519
2688
  export declare function getAboutInfo(opts?: Oazapfts.RequestOpts): Promise<ServerAboutResponseDto>;
2520
2689
  /**
2521
- * This endpoint requires the `server.apkLinks` permission.
2690
+ * Get APK links
2522
2691
  */
2523
2692
  export declare function getApkLinks(opts?: Oazapfts.RequestOpts): Promise<ServerApkLinksDto>;
2693
+ /**
2694
+ * Get config
2695
+ */
2524
2696
  export declare function getServerConfig(opts?: Oazapfts.RequestOpts): Promise<ServerConfigDto>;
2697
+ /**
2698
+ * Get features
2699
+ */
2525
2700
  export declare function getServerFeatures(opts?: Oazapfts.RequestOpts): Promise<ServerFeaturesDto>;
2526
2701
  /**
2527
- * This endpoint is an admin-only route, and requires the `serverLicense.delete` permission.
2702
+ * Delete server product key
2528
2703
  */
2529
2704
  export declare function deleteServerLicense(opts?: Oazapfts.RequestOpts): Promise<never>;
2530
2705
  /**
2531
- * This endpoint is an admin-only route, and requires the `serverLicense.read` permission.
2706
+ * Get product key
2532
2707
  */
2533
2708
  export declare function getServerLicense(opts?: Oazapfts.RequestOpts): Promise<LicenseResponseDto>;
2534
2709
  /**
2535
- * This endpoint is an admin-only route, and requires the `serverLicense.update` permission.
2710
+ * Set server product key
2536
2711
  */
2537
2712
  export declare function setServerLicense({ licenseKeyDto }: {
2538
2713
  licenseKeyDto: LicenseKeyDto;
2539
2714
  }, opts?: Oazapfts.RequestOpts): Promise<LicenseResponseDto>;
2715
+ /**
2716
+ * Get supported media types
2717
+ */
2540
2718
  export declare function getSupportedMediaTypes(opts?: Oazapfts.RequestOpts): Promise<ServerMediaTypesResponseDto>;
2719
+ /**
2720
+ * Ping
2721
+ */
2541
2722
  export declare function pingServer(opts?: Oazapfts.RequestOpts): Promise<ServerPingResponseRead>;
2542
2723
  /**
2543
- * This endpoint is an admin-only route, and requires the `server.statistics` permission.
2724
+ * Get statistics
2544
2725
  */
2545
2726
  export declare function getServerStatistics(opts?: Oazapfts.RequestOpts): Promise<ServerStatsResponseDto>;
2546
2727
  /**
2547
- * This endpoint requires the `server.storage` permission.
2728
+ * Get storage
2548
2729
  */
2549
2730
  export declare function getStorage(opts?: Oazapfts.RequestOpts): Promise<ServerStorageResponseDto>;
2731
+ /**
2732
+ * Get theme
2733
+ */
2550
2734
  export declare function getTheme(opts?: Oazapfts.RequestOpts): Promise<ServerThemeDto>;
2735
+ /**
2736
+ * Get server version
2737
+ */
2551
2738
  export declare function getServerVersion(opts?: Oazapfts.RequestOpts): Promise<ServerVersionResponseDto>;
2552
2739
  /**
2553
- * This endpoint requires the `server.versionCheck` permission.
2740
+ * Get version check status
2554
2741
  */
2555
2742
  export declare function getVersionCheck(opts?: Oazapfts.RequestOpts): Promise<VersionCheckStateResponseDto>;
2743
+ /**
2744
+ * Get version history
2745
+ */
2556
2746
  export declare function getVersionHistory(opts?: Oazapfts.RequestOpts): Promise<ServerVersionHistoryResponseDto[]>;
2557
2747
  /**
2558
- * This endpoint requires the `session.delete` permission.
2748
+ * Delete all sessions
2559
2749
  */
2560
2750
  export declare function deleteAllSessions(opts?: Oazapfts.RequestOpts): Promise<never>;
2561
2751
  /**
2562
- * This endpoint requires the `session.read` permission.
2752
+ * Retrieve sessions
2563
2753
  */
2564
2754
  export declare function getSessions(opts?: Oazapfts.RequestOpts): Promise<SessionResponseDto[]>;
2565
2755
  /**
2566
- * This endpoint requires the `session.create` permission.
2756
+ * Create a session
2567
2757
  */
2568
2758
  export declare function createSession({ sessionCreateDto }: {
2569
2759
  sessionCreateDto: SessionCreateDto;
2570
2760
  }, opts?: Oazapfts.RequestOpts): Promise<SessionCreateResponseDto>;
2571
2761
  /**
2572
- * This endpoint requires the `session.delete` permission.
2762
+ * Delete a session
2573
2763
  */
2574
2764
  export declare function deleteSession({ id }: {
2575
2765
  id: string;
2576
2766
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2577
2767
  /**
2578
- * This endpoint requires the `session.update` permission.
2768
+ * Update a session
2579
2769
  */
2580
2770
  export declare function updateSession({ id, sessionUpdateDto }: {
2581
2771
  id: string;
2582
2772
  sessionUpdateDto: SessionUpdateDto;
2583
2773
  }, opts?: Oazapfts.RequestOpts): Promise<SessionResponseDto>;
2584
2774
  /**
2585
- * This endpoint requires the `session.lock` permission.
2775
+ * Lock a session
2586
2776
  */
2587
2777
  export declare function lockSession({ id }: {
2588
2778
  id: string;
2589
2779
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2590
2780
  /**
2591
- * This endpoint requires the `sharedLink.read` permission.
2781
+ * Retrieve all shared links
2592
2782
  */
2593
2783
  export declare function getAllSharedLinks({ albumId }: {
2594
2784
  albumId?: string;
2595
2785
  }, opts?: Oazapfts.RequestOpts): Promise<SharedLinkResponseDto[]>;
2596
2786
  /**
2597
- * This endpoint requires the `sharedLink.create` permission.
2787
+ * Create a shared link
2598
2788
  */
2599
2789
  export declare function createSharedLink({ sharedLinkCreateDto }: {
2600
2790
  sharedLinkCreateDto: SharedLinkCreateDto;
2601
2791
  }, opts?: Oazapfts.RequestOpts): Promise<SharedLinkResponseDto>;
2602
- export declare function getMySharedLink({ password, token, key, slug }: {
2603
- password?: string;
2604
- token?: string;
2792
+ /**
2793
+ * Retrieve current shared link
2794
+ */
2795
+ export declare function getMySharedLink({ key, password, slug, token }: {
2605
2796
  key?: string;
2797
+ password?: string;
2606
2798
  slug?: string;
2799
+ token?: string;
2607
2800
  }, opts?: Oazapfts.RequestOpts): Promise<SharedLinkResponseDto>;
2608
2801
  /**
2609
- * This endpoint requires the `sharedLink.delete` permission.
2802
+ * Delete a shared link
2610
2803
  */
2611
2804
  export declare function removeSharedLink({ id }: {
2612
2805
  id: string;
2613
2806
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2614
2807
  /**
2615
- * This endpoint requires the `sharedLink.read` permission.
2808
+ * Retrieve a shared link
2616
2809
  */
2617
2810
  export declare function getSharedLinkById({ id }: {
2618
2811
  id: string;
2619
2812
  }, opts?: Oazapfts.RequestOpts): Promise<SharedLinkResponseDto>;
2620
2813
  /**
2621
- * This endpoint requires the `sharedLink.update` permission.
2814
+ * Update a shared link
2622
2815
  */
2623
2816
  export declare function updateSharedLink({ id, sharedLinkEditDto }: {
2624
2817
  id: string;
2625
2818
  sharedLinkEditDto: SharedLinkEditDto;
2626
2819
  }, opts?: Oazapfts.RequestOpts): Promise<SharedLinkResponseDto>;
2820
+ /**
2821
+ * Remove assets from a shared link
2822
+ */
2627
2823
  export declare function removeSharedLinkAssets({ id, key, slug, assetIdsDto }: {
2628
2824
  id: string;
2629
2825
  key?: string;
2630
2826
  slug?: string;
2631
2827
  assetIdsDto: AssetIdsDto;
2632
2828
  }, opts?: Oazapfts.RequestOpts): Promise<AssetIdsResponseDto[]>;
2829
+ /**
2830
+ * Add assets to a shared link
2831
+ */
2633
2832
  export declare function addSharedLinkAssets({ id, key, slug, assetIdsDto }: {
2634
2833
  id: string;
2635
2834
  key?: string;
@@ -2637,170 +2836,176 @@ export declare function addSharedLinkAssets({ id, key, slug, assetIdsDto }: {
2637
2836
  assetIdsDto: AssetIdsDto;
2638
2837
  }, opts?: Oazapfts.RequestOpts): Promise<AssetIdsResponseDto[]>;
2639
2838
  /**
2640
- * This endpoint requires the `stack.delete` permission.
2839
+ * Delete stacks
2641
2840
  */
2642
2841
  export declare function deleteStacks({ bulkIdsDto }: {
2643
2842
  bulkIdsDto: BulkIdsDto;
2644
2843
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2645
2844
  /**
2646
- * This endpoint requires the `stack.read` permission.
2845
+ * Retrieve stacks
2647
2846
  */
2648
2847
  export declare function searchStacks({ primaryAssetId }: {
2649
2848
  primaryAssetId?: string;
2650
2849
  }, opts?: Oazapfts.RequestOpts): Promise<StackResponseDto[]>;
2651
2850
  /**
2652
- * This endpoint requires the `stack.create` permission.
2851
+ * Create a stack
2653
2852
  */
2654
2853
  export declare function createStack({ stackCreateDto }: {
2655
2854
  stackCreateDto: StackCreateDto;
2656
2855
  }, opts?: Oazapfts.RequestOpts): Promise<StackResponseDto>;
2657
2856
  /**
2658
- * This endpoint requires the `stack.delete` permission.
2857
+ * Delete a stack
2659
2858
  */
2660
2859
  export declare function deleteStack({ id }: {
2661
2860
  id: string;
2662
2861
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2663
2862
  /**
2664
- * This endpoint requires the `stack.read` permission.
2863
+ * Retrieve a stack
2665
2864
  */
2666
2865
  export declare function getStack({ id }: {
2667
2866
  id: string;
2668
2867
  }, opts?: Oazapfts.RequestOpts): Promise<StackResponseDto>;
2669
2868
  /**
2670
- * This endpoint requires the `stack.update` permission.
2869
+ * Update a stack
2671
2870
  */
2672
2871
  export declare function updateStack({ id, stackUpdateDto }: {
2673
2872
  id: string;
2674
2873
  stackUpdateDto: StackUpdateDto;
2675
2874
  }, opts?: Oazapfts.RequestOpts): Promise<StackResponseDto>;
2676
2875
  /**
2677
- * This endpoint requires the `stack.update` permission.
2876
+ * Remove an asset from a stack
2678
2877
  */
2679
2878
  export declare function removeAssetFromStack({ assetId, id }: {
2680
2879
  assetId: string;
2681
2880
  id: string;
2682
2881
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2683
2882
  /**
2684
- * This endpoint requires the `syncCheckpoint.delete` permission.
2883
+ * Delete acknowledgements
2685
2884
  */
2686
2885
  export declare function deleteSyncAck({ syncAckDeleteDto }: {
2687
2886
  syncAckDeleteDto: SyncAckDeleteDto;
2688
2887
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2689
2888
  /**
2690
- * This endpoint requires the `syncCheckpoint.read` permission.
2889
+ * Retrieve acknowledgements
2691
2890
  */
2692
2891
  export declare function getSyncAck(opts?: Oazapfts.RequestOpts): Promise<SyncAckDto[]>;
2693
2892
  /**
2694
- * This endpoint requires the `syncCheckpoint.update` permission.
2893
+ * Acknowledge changes
2695
2894
  */
2696
2895
  export declare function sendSyncAck({ syncAckSetDto }: {
2697
2896
  syncAckSetDto: SyncAckSetDto;
2698
2897
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2898
+ /**
2899
+ * Get delta sync for user
2900
+ */
2699
2901
  export declare function getDeltaSync({ assetDeltaSyncDto }: {
2700
2902
  assetDeltaSyncDto: AssetDeltaSyncDto;
2701
2903
  }, opts?: Oazapfts.RequestOpts): Promise<AssetDeltaSyncResponseDto>;
2904
+ /**
2905
+ * Get full sync for user
2906
+ */
2702
2907
  export declare function getFullSyncForUser({ assetFullSyncDto }: {
2703
2908
  assetFullSyncDto: AssetFullSyncDto;
2704
2909
  }, opts?: Oazapfts.RequestOpts): Promise<AssetResponseDto[]>;
2705
2910
  /**
2706
- * This endpoint requires the `sync.stream` permission.
2911
+ * Stream sync changes
2707
2912
  */
2708
2913
  export declare function getSyncStream({ syncStreamDto }: {
2709
2914
  syncStreamDto: SyncStreamDto;
2710
2915
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2711
2916
  /**
2712
- * This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
2917
+ * Get system configuration
2713
2918
  */
2714
2919
  export declare function getConfig(opts?: Oazapfts.RequestOpts): Promise<SystemConfigDto>;
2715
2920
  /**
2716
- * This endpoint is an admin-only route, and requires the `systemConfig.update` permission.
2921
+ * Update system configuration
2717
2922
  */
2718
2923
  export declare function updateConfig({ systemConfigDto }: {
2719
2924
  systemConfigDto: SystemConfigDto;
2720
2925
  }, opts?: Oazapfts.RequestOpts): Promise<SystemConfigDto>;
2721
2926
  /**
2722
- * This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
2927
+ * Get system configuration defaults
2723
2928
  */
2724
2929
  export declare function getConfigDefaults(opts?: Oazapfts.RequestOpts): Promise<SystemConfigDto>;
2725
2930
  /**
2726
- * This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
2931
+ * Get storage template options
2727
2932
  */
2728
2933
  export declare function getStorageTemplateOptions(opts?: Oazapfts.RequestOpts): Promise<SystemConfigTemplateStorageOptionDto>;
2729
2934
  /**
2730
- * This endpoint is an admin-only route, and requires the `systemMetadata.read` permission.
2935
+ * Retrieve admin onboarding
2731
2936
  */
2732
2937
  export declare function getAdminOnboarding(opts?: Oazapfts.RequestOpts): Promise<AdminOnboardingUpdateDto>;
2733
2938
  /**
2734
- * This endpoint is an admin-only route, and requires the `systemMetadata.update` permission.
2939
+ * Update admin onboarding
2735
2940
  */
2736
2941
  export declare function updateAdminOnboarding({ adminOnboardingUpdateDto }: {
2737
2942
  adminOnboardingUpdateDto: AdminOnboardingUpdateDto;
2738
2943
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2739
2944
  /**
2740
- * This endpoint is an admin-only route, and requires the `systemMetadata.read` permission.
2945
+ * Retrieve reverse geocoding state
2741
2946
  */
2742
2947
  export declare function getReverseGeocodingState(opts?: Oazapfts.RequestOpts): Promise<ReverseGeocodingStateResponseDto>;
2743
2948
  /**
2744
- * This endpoint is an admin-only route, and requires the `systemMetadata.read` permission.
2949
+ * Retrieve version check state
2745
2950
  */
2746
2951
  export declare function getVersionCheckState(opts?: Oazapfts.RequestOpts): Promise<VersionCheckStateResponseDto>;
2747
2952
  /**
2748
- * This endpoint requires the `tag.read` permission.
2953
+ * Retrieve tags
2749
2954
  */
2750
2955
  export declare function getAllTags(opts?: Oazapfts.RequestOpts): Promise<TagResponseDto[]>;
2751
2956
  /**
2752
- * This endpoint requires the `tag.create` permission.
2957
+ * Create a tag
2753
2958
  */
2754
2959
  export declare function createTag({ tagCreateDto }: {
2755
2960
  tagCreateDto: TagCreateDto;
2756
2961
  }, opts?: Oazapfts.RequestOpts): Promise<TagResponseDto>;
2757
2962
  /**
2758
- * This endpoint requires the `tag.create` permission.
2963
+ * Upsert tags
2759
2964
  */
2760
2965
  export declare function upsertTags({ tagUpsertDto }: {
2761
2966
  tagUpsertDto: TagUpsertDto;
2762
2967
  }, opts?: Oazapfts.RequestOpts): Promise<TagResponseDto[]>;
2763
2968
  /**
2764
- * This endpoint requires the `tag.asset` permission.
2969
+ * Tag assets
2765
2970
  */
2766
2971
  export declare function bulkTagAssets({ tagBulkAssetsDto }: {
2767
2972
  tagBulkAssetsDto: TagBulkAssetsDto;
2768
2973
  }, opts?: Oazapfts.RequestOpts): Promise<TagBulkAssetsResponseDto>;
2769
2974
  /**
2770
- * This endpoint requires the `tag.delete` permission.
2975
+ * Delete a tag
2771
2976
  */
2772
2977
  export declare function deleteTag({ id }: {
2773
2978
  id: string;
2774
2979
  }, opts?: Oazapfts.RequestOpts): Promise<never>;
2775
2980
  /**
2776
- * This endpoint requires the `tag.read` permission.
2981
+ * Retrieve a tag
2777
2982
  */
2778
2983
  export declare function getTagById({ id }: {
2779
2984
  id: string;
2780
2985
  }, opts?: Oazapfts.RequestOpts): Promise<TagResponseDto>;
2781
2986
  /**
2782
- * This endpoint requires the `tag.update` permission.
2987
+ * Update a tag
2783
2988
  */
2784
2989
  export declare function updateTag({ id, tagUpdateDto }: {
2785
2990
  id: string;
2786
2991
  tagUpdateDto: TagUpdateDto;
2787
2992
  }, opts?: Oazapfts.RequestOpts): Promise<TagResponseDto>;
2788
2993
  /**
2789
- * This endpoint requires the `tag.asset` permission.
2994
+ * Untag assets
2790
2995
  */
2791
2996
  export declare function untagAssets({ id, bulkIdsDto }: {
2792
2997
  id: string;
2793
2998
  bulkIdsDto: BulkIdsDto;
2794
2999
  }, opts?: Oazapfts.RequestOpts): Promise<BulkIdResponseDto[]>;
2795
3000
  /**
2796
- * This endpoint requires the `tag.asset` permission.
3001
+ * Tag assets
2797
3002
  */
2798
3003
  export declare function tagAssets({ id, bulkIdsDto }: {
2799
3004
  id: string;
2800
3005
  bulkIdsDto: BulkIdsDto;
2801
3006
  }, opts?: Oazapfts.RequestOpts): Promise<BulkIdResponseDto[]>;
2802
3007
  /**
2803
- * This endpoint requires the `asset.read` permission.
3008
+ * Get time bucket
2804
3009
  */
2805
3010
  export declare function getTimeBucket({ albumId, isFavorite, isTrashed, key, order, personId, slug, tagId, timeBucket, userId, visibility, withCoordinates, withPartners, withStacked }: {
2806
3011
  albumId?: string;
@@ -2819,7 +3024,7 @@ export declare function getTimeBucket({ albumId, isFavorite, isTrashed, key, ord
2819
3024
  withStacked?: boolean;
2820
3025
  }, opts?: Oazapfts.RequestOpts): Promise<TimeBucketAssetResponseDto>;
2821
3026
  /**
2822
- * This endpoint requires the `asset.read` permission.
3027
+ * Get time buckets
2823
3028
  */
2824
3029
  export declare function getTimeBuckets({ albumId, isFavorite, isTrashed, key, order, personId, slug, tagId, userId, visibility, withCoordinates, withPartners, withStacked }: {
2825
3030
  albumId?: string;
@@ -2837,97 +3042,132 @@ export declare function getTimeBuckets({ albumId, isFavorite, isTrashed, key, or
2837
3042
  withStacked?: boolean;
2838
3043
  }, opts?: Oazapfts.RequestOpts): Promise<TimeBucketsResponseDto[]>;
2839
3044
  /**
2840
- * This endpoint requires the `asset.delete` permission.
3045
+ * Empty trash
2841
3046
  */
2842
3047
  export declare function emptyTrash(opts?: Oazapfts.RequestOpts): Promise<TrashResponseDto>;
2843
3048
  /**
2844
- * This endpoint requires the `asset.delete` permission.
3049
+ * Restore trash
2845
3050
  */
2846
3051
  export declare function restoreTrash(opts?: Oazapfts.RequestOpts): Promise<TrashResponseDto>;
2847
3052
  /**
2848
- * This endpoint requires the `asset.delete` permission.
3053
+ * Restore assets
2849
3054
  */
2850
3055
  export declare function restoreAssets({ bulkIdsDto }: {
2851
3056
  bulkIdsDto: BulkIdsDto;
2852
3057
  }, opts?: Oazapfts.RequestOpts): Promise<TrashResponseDto>;
2853
3058
  /**
2854
- * This endpoint requires the `user.read` permission.
3059
+ * Get all users
2855
3060
  */
2856
3061
  export declare function searchUsers(opts?: Oazapfts.RequestOpts): Promise<UserResponseDto[]>;
2857
3062
  /**
2858
- * This endpoint requires the `user.read` permission.
3063
+ * Get current user
2859
3064
  */
2860
3065
  export declare function getMyUser(opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
2861
3066
  /**
2862
- * This endpoint requires the `user.update` permission.
3067
+ * Update current user
2863
3068
  */
2864
3069
  export declare function updateMyUser({ userUpdateMeDto }: {
2865
3070
  userUpdateMeDto: UserUpdateMeDto;
2866
3071
  }, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
2867
3072
  /**
2868
- * This endpoint requires the `userLicense.delete` permission.
3073
+ * Delete user product key
2869
3074
  */
2870
3075
  export declare function deleteUserLicense(opts?: Oazapfts.RequestOpts): Promise<never>;
2871
3076
  /**
2872
- * This endpoint requires the `userLicense.read` permission.
3077
+ * Retrieve user product key
2873
3078
  */
2874
3079
  export declare function getUserLicense(opts?: Oazapfts.RequestOpts): Promise<LicenseResponseDto>;
2875
3080
  /**
2876
- * This endpoint requires the `userLicense.update` permission.
3081
+ * Set user product key
2877
3082
  */
2878
3083
  export declare function setUserLicense({ licenseKeyDto }: {
2879
3084
  licenseKeyDto: LicenseKeyDto;
2880
3085
  }, opts?: Oazapfts.RequestOpts): Promise<LicenseResponseDto>;
2881
3086
  /**
2882
- * This endpoint requires the `userOnboarding.delete` permission.
3087
+ * Delete user onboarding
2883
3088
  */
2884
3089
  export declare function deleteUserOnboarding(opts?: Oazapfts.RequestOpts): Promise<never>;
2885
3090
  /**
2886
- * This endpoint requires the `userOnboarding.read` permission.
3091
+ * Retrieve user onboarding
2887
3092
  */
2888
3093
  export declare function getUserOnboarding(opts?: Oazapfts.RequestOpts): Promise<OnboardingResponseDto>;
2889
3094
  /**
2890
- * This endpoint requires the `userOnboarding.update` permission.
3095
+ * Update user onboarding
2891
3096
  */
2892
3097
  export declare function setUserOnboarding({ onboardingDto }: {
2893
3098
  onboardingDto: OnboardingDto;
2894
3099
  }, opts?: Oazapfts.RequestOpts): Promise<OnboardingResponseDto>;
2895
3100
  /**
2896
- * This endpoint requires the `userPreference.read` permission.
3101
+ * Get my preferences
2897
3102
  */
2898
3103
  export declare function getMyPreferences(opts?: Oazapfts.RequestOpts): Promise<UserPreferencesResponseDto>;
2899
3104
  /**
2900
- * This endpoint requires the `userPreference.update` permission.
3105
+ * Update my preferences
2901
3106
  */
2902
3107
  export declare function updateMyPreferences({ userPreferencesUpdateDto }: {
2903
3108
  userPreferencesUpdateDto: UserPreferencesUpdateDto;
2904
3109
  }, opts?: Oazapfts.RequestOpts): Promise<UserPreferencesResponseDto>;
2905
3110
  /**
2906
- * This endpoint requires the `userProfileImage.delete` permission.
3111
+ * Delete user profile image
2907
3112
  */
2908
3113
  export declare function deleteProfileImage(opts?: Oazapfts.RequestOpts): Promise<never>;
2909
3114
  /**
2910
- * This endpoint requires the `userProfileImage.update` permission.
3115
+ * Create user profile image
2911
3116
  */
2912
3117
  export declare function createProfileImage({ createProfileImageDto }: {
2913
3118
  createProfileImageDto: CreateProfileImageDto;
2914
3119
  }, opts?: Oazapfts.RequestOpts): Promise<CreateProfileImageResponseDto>;
2915
3120
  /**
2916
- * This endpoint requires the `user.read` permission.
3121
+ * Retrieve a user
2917
3122
  */
2918
3123
  export declare function getUser({ id }: {
2919
3124
  id: string;
2920
3125
  }, opts?: Oazapfts.RequestOpts): Promise<UserResponseDto>;
2921
3126
  /**
2922
- * This endpoint requires the `userProfileImage.read` permission.
3127
+ * Retrieve user profile image
2923
3128
  */
2924
3129
  export declare function getProfileImage({ id }: {
2925
3130
  id: string;
2926
3131
  }, opts?: Oazapfts.RequestOpts): Promise<Blob>;
3132
+ /**
3133
+ * Retrieve assets by original path
3134
+ */
2927
3135
  export declare function getAssetsByOriginalPath({ path }: {
2928
3136
  path: string;
2929
3137
  }, opts?: Oazapfts.RequestOpts): Promise<AssetResponseDto[]>;
3138
+ /**
3139
+ * Retrieve unique paths
3140
+ */
2930
3141
  export declare function getUniqueOriginalPaths(opts?: Oazapfts.RequestOpts): Promise<string[]>;
3142
+ /**
3143
+ * List all workflows
3144
+ */
3145
+ export declare function getWorkflows(opts?: Oazapfts.RequestOpts): Promise<WorkflowResponseDto[]>;
3146
+ /**
3147
+ * Create a workflow
3148
+ */
3149
+ export declare function createWorkflow({ workflowCreateDto }: {
3150
+ workflowCreateDto: WorkflowCreateDto;
3151
+ }, opts?: Oazapfts.RequestOpts): Promise<WorkflowResponseDto>;
3152
+ /**
3153
+ * Delete a workflow
3154
+ */
3155
+ export declare function deleteWorkflow({ id }: {
3156
+ id: string;
3157
+ }, opts?: Oazapfts.RequestOpts): Promise<never>;
3158
+ /**
3159
+ * Retrieve a workflow
3160
+ */
3161
+ export declare function getWorkflow({ id }: {
3162
+ id: string;
3163
+ }, opts?: Oazapfts.RequestOpts): Promise<WorkflowResponseDto>;
3164
+ /**
3165
+ * Update a workflow
3166
+ */
3167
+ export declare function updateWorkflow({ id, workflowUpdateDto }: {
3168
+ id: string;
3169
+ workflowUpdateDto: WorkflowUpdateDto;
3170
+ }, opts?: Oazapfts.RequestOpts): Promise<WorkflowResponseDto>;
2931
3171
  export declare enum ReactionLevel {
2932
3172
  Album = "album",
2933
3173
  Asset = "asset"
@@ -2948,6 +3188,10 @@ export declare enum UserAvatarColor {
2948
3188
  Gray = "gray",
2949
3189
  Amber = "amber"
2950
3190
  }
3191
+ export declare enum MaintenanceAction {
3192
+ Start = "start",
3193
+ End = "end"
3194
+ }
2951
3195
  export declare enum NotificationLevel {
2952
3196
  Success = "success",
2953
3197
  Error = "error",
@@ -3055,6 +3299,7 @@ export declare enum Permission {
3055
3299
  LibraryStatistics = "library.statistics",
3056
3300
  TimelineRead = "timeline.read",
3057
3301
  TimelineDownload = "timeline.download",
3302
+ Maintenance = "maintenance",
3058
3303
  MemoryCreate = "memory.create",
3059
3304
  MemoryRead = "memory.read",
3060
3305
  MemoryUpdate = "memory.update",
@@ -3080,6 +3325,10 @@ export declare enum Permission {
3080
3325
  PinCodeCreate = "pinCode.create",
3081
3326
  PinCodeUpdate = "pinCode.update",
3082
3327
  PinCodeDelete = "pinCode.delete",
3328
+ PluginCreate = "plugin.create",
3329
+ PluginRead = "plugin.read",
3330
+ PluginUpdate = "plugin.update",
3331
+ PluginDelete = "plugin.delete",
3083
3332
  ServerAbout = "server.about",
3084
3333
  ServerApkLinks = "server.apkLinks",
3085
3334
  ServerStorage = "server.storage",
@@ -3129,6 +3378,10 @@ export declare enum Permission {
3129
3378
  UserProfileImageRead = "userProfileImage.read",
3130
3379
  UserProfileImageUpdate = "userProfileImage.update",
3131
3380
  UserProfileImageDelete = "userProfileImage.delete",
3381
+ WorkflowCreate = "workflow.create",
3382
+ WorkflowRead = "workflow.read",
3383
+ WorkflowUpdate = "workflow.update",
3384
+ WorkflowDelete = "workflow.delete",
3132
3385
  AdminUserCreate = "adminUser.create",
3133
3386
  AdminUserRead = "adminUser.read",
3134
3387
  AdminUserUpdate = "adminUser.update",
@@ -3171,7 +3424,7 @@ export declare enum ManualJobName {
3171
3424
  MemoryCreate = "memory-create",
3172
3425
  BackupDatabase = "backup-database"
3173
3426
  }
3174
- export declare enum JobName {
3427
+ export declare enum QueueName {
3175
3428
  ThumbnailGeneration = "thumbnailGeneration",
3176
3429
  MetadataExtraction = "metadataExtraction",
3177
3430
  VideoConversion = "videoConversion",
@@ -3187,15 +3440,21 @@ export declare enum JobName {
3187
3440
  Library = "library",
3188
3441
  Notifications = "notifications",
3189
3442
  BackupDatabase = "backupDatabase",
3190
- Ocr = "ocr"
3443
+ Ocr = "ocr",
3444
+ Workflow = "workflow"
3191
3445
  }
3192
- export declare enum JobCommand {
3446
+ export declare enum QueueCommand {
3193
3447
  Start = "start",
3194
3448
  Pause = "pause",
3195
3449
  Resume = "resume",
3196
3450
  Empty = "empty",
3197
3451
  ClearFailed = "clear-failed"
3198
3452
  }
3453
+ export declare enum MemorySearchOrder {
3454
+ Asc = "asc",
3455
+ Desc = "desc",
3456
+ Random = "random"
3457
+ }
3199
3458
  export declare enum MemoryType {
3200
3459
  OnThisDay = "on_this_day"
3201
3460
  }
@@ -3203,6 +3462,11 @@ export declare enum PartnerDirection {
3203
3462
  SharedBy = "shared-by",
3204
3463
  SharedWith = "shared-with"
3205
3464
  }
3465
+ export declare enum PluginContext {
3466
+ Asset = "asset",
3467
+ Album = "album",
3468
+ Person = "person"
3469
+ }
3206
3470
  export declare enum SearchSuggestionType {
3207
3471
  Country = "country",
3208
3472
  State = "state",
@@ -3354,3 +3618,11 @@ export declare enum OAuthTokenEndpointAuthMethod {
3354
3618
  ClientSecretPost = "client_secret_post",
3355
3619
  ClientSecretBasic = "client_secret_basic"
3356
3620
  }
3621
+ export declare enum TriggerType {
3622
+ AssetCreate = "AssetCreate",
3623
+ PersonRecognized = "PersonRecognized"
3624
+ }
3625
+ export declare enum PluginTriggerType {
3626
+ AssetCreate = "AssetCreate",
3627
+ PersonRecognized = "PersonRecognized"
3628
+ }