@immich/sdk 1.136.0 → 1.137.1
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.
- package/build/fetch-client.d.ts +622 -31
- package/build/fetch-client.js +632 -39
- package/package.json +2 -2
package/build/fetch-client.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Immich
|
|
3
|
-
* 1.
|
|
3
|
+
* 1.137.1
|
|
4
4
|
* DO NOT MODIFY - This file has been generated using oazapfts.
|
|
5
5
|
* See https://www.npmjs.com/package/oazapfts
|
|
6
6
|
*/
|
|
@@ -1194,6 +1194,7 @@ export type SharedLinkResponseDto = {
|
|
|
1194
1194
|
key: string;
|
|
1195
1195
|
password: string | null;
|
|
1196
1196
|
showMetadata: boolean;
|
|
1197
|
+
slug: string | null;
|
|
1197
1198
|
token?: string | null;
|
|
1198
1199
|
"type": SharedLinkType;
|
|
1199
1200
|
userId: string;
|
|
@@ -1203,10 +1204,11 @@ export type SharedLinkCreateDto = {
|
|
|
1203
1204
|
allowDownload?: boolean;
|
|
1204
1205
|
allowUpload?: boolean;
|
|
1205
1206
|
assetIds?: string[];
|
|
1206
|
-
description?: string;
|
|
1207
|
+
description?: string | null;
|
|
1207
1208
|
expiresAt?: string | null;
|
|
1208
|
-
password?: string;
|
|
1209
|
+
password?: string | null;
|
|
1209
1210
|
showMetadata?: boolean;
|
|
1211
|
+
slug?: string | null;
|
|
1210
1212
|
"type": SharedLinkType;
|
|
1211
1213
|
};
|
|
1212
1214
|
export type SharedLinkEditDto = {
|
|
@@ -1216,10 +1218,11 @@ export type SharedLinkEditDto = {
|
|
|
1216
1218
|
Setting this flag and not sending expiryAt is considered as null instead.
|
|
1217
1219
|
Clients that can send null values can ignore this. */
|
|
1218
1220
|
changeExpiryTime?: boolean;
|
|
1219
|
-
description?: string;
|
|
1221
|
+
description?: string | null;
|
|
1220
1222
|
expiresAt?: string | null;
|
|
1221
|
-
password?: string;
|
|
1223
|
+
password?: string | null;
|
|
1222
1224
|
showMetadata?: boolean;
|
|
1225
|
+
slug?: string | null;
|
|
1223
1226
|
};
|
|
1224
1227
|
export type AssetIdsResponseDto = {
|
|
1225
1228
|
assetId: string;
|
|
@@ -1570,6 +1573,9 @@ export type CreateProfileImageResponseDto = {
|
|
|
1570
1573
|
profileImagePath: string;
|
|
1571
1574
|
userId: string;
|
|
1572
1575
|
};
|
|
1576
|
+
/**
|
|
1577
|
+
* This endpoint requires the `activity.read` permission.
|
|
1578
|
+
*/
|
|
1573
1579
|
export declare function getActivities({ albumId, assetId, level, $type, userId }: {
|
|
1574
1580
|
albumId: string;
|
|
1575
1581
|
assetId?: string;
|
|
@@ -1577,13 +1583,22 @@ export declare function getActivities({ albumId, assetId, level, $type, userId }
|
|
|
1577
1583
|
$type?: ReactionType;
|
|
1578
1584
|
userId?: string;
|
|
1579
1585
|
}, opts?: Oazapfts.RequestOpts): Promise<ActivityResponseDto[]>;
|
|
1586
|
+
/**
|
|
1587
|
+
* This endpoint requires the `activity.create` permission.
|
|
1588
|
+
*/
|
|
1580
1589
|
export declare function createActivity({ activityCreateDto }: {
|
|
1581
1590
|
activityCreateDto: ActivityCreateDto;
|
|
1582
1591
|
}, opts?: Oazapfts.RequestOpts): Promise<ActivityResponseDto>;
|
|
1592
|
+
/**
|
|
1593
|
+
* This endpoint requires the `activity.statistics` permission.
|
|
1594
|
+
*/
|
|
1583
1595
|
export declare function getActivityStatistics({ albumId, assetId }: {
|
|
1584
1596
|
albumId: string;
|
|
1585
1597
|
assetId?: string;
|
|
1586
1598
|
}, opts?: Oazapfts.RequestOpts): Promise<ActivityStatisticsResponseDto>;
|
|
1599
|
+
/**
|
|
1600
|
+
* This endpoint requires the `activity.delete` permission.
|
|
1601
|
+
*/
|
|
1587
1602
|
export declare function deleteActivity({ id }: {
|
|
1588
1603
|
id: string;
|
|
1589
1604
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
@@ -1597,104 +1612,191 @@ export declare function getNotificationTemplateAdmin({ name, templateDto }: {
|
|
|
1597
1612
|
export declare function sendTestEmailAdmin({ systemConfigSmtpDto }: {
|
|
1598
1613
|
systemConfigSmtpDto: SystemConfigSmtpDto;
|
|
1599
1614
|
}, opts?: Oazapfts.RequestOpts): Promise<TestEmailResponseDto>;
|
|
1615
|
+
/**
|
|
1616
|
+
* This endpoint is an admin-only route, and requires the `adminUser.read` permission.
|
|
1617
|
+
*/
|
|
1600
1618
|
export declare function searchUsersAdmin({ id, withDeleted }: {
|
|
1601
1619
|
id?: string;
|
|
1602
1620
|
withDeleted?: boolean;
|
|
1603
1621
|
}, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto[]>;
|
|
1622
|
+
/**
|
|
1623
|
+
* This endpoint is an admin-only route, and requires the `adminUser.create` permission.
|
|
1624
|
+
*/
|
|
1604
1625
|
export declare function createUserAdmin({ userAdminCreateDto }: {
|
|
1605
1626
|
userAdminCreateDto: UserAdminCreateDto;
|
|
1606
1627
|
}, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
|
|
1628
|
+
/**
|
|
1629
|
+
* This endpoint is an admin-only route, and requires the `adminUser.delete` permission.
|
|
1630
|
+
*/
|
|
1607
1631
|
export declare function deleteUserAdmin({ id, userAdminDeleteDto }: {
|
|
1608
1632
|
id: string;
|
|
1609
1633
|
userAdminDeleteDto: UserAdminDeleteDto;
|
|
1610
1634
|
}, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
|
|
1635
|
+
/**
|
|
1636
|
+
* This endpoint is an admin-only route, and requires the `adminUser.read` permission.
|
|
1637
|
+
*/
|
|
1611
1638
|
export declare function getUserAdmin({ id }: {
|
|
1612
1639
|
id: string;
|
|
1613
1640
|
}, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
|
|
1641
|
+
/**
|
|
1642
|
+
* This endpoint is an admin-only route, and requires the `adminUser.update` permission.
|
|
1643
|
+
*/
|
|
1614
1644
|
export declare function updateUserAdmin({ id, userAdminUpdateDto }: {
|
|
1615
1645
|
id: string;
|
|
1616
1646
|
userAdminUpdateDto: UserAdminUpdateDto;
|
|
1617
1647
|
}, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
|
|
1648
|
+
/**
|
|
1649
|
+
* This endpoint is an admin-only route, and requires the `adminUser.read` permission.
|
|
1650
|
+
*/
|
|
1618
1651
|
export declare function getUserPreferencesAdmin({ id }: {
|
|
1619
1652
|
id: string;
|
|
1620
1653
|
}, opts?: Oazapfts.RequestOpts): Promise<UserPreferencesResponseDto>;
|
|
1654
|
+
/**
|
|
1655
|
+
* This endpoint is an admin-only route, and requires the `adminUser.update` permission.
|
|
1656
|
+
*/
|
|
1621
1657
|
export declare function updateUserPreferencesAdmin({ id, userPreferencesUpdateDto }: {
|
|
1622
1658
|
id: string;
|
|
1623
1659
|
userPreferencesUpdateDto: UserPreferencesUpdateDto;
|
|
1624
1660
|
}, opts?: Oazapfts.RequestOpts): Promise<UserPreferencesResponseDto>;
|
|
1661
|
+
/**
|
|
1662
|
+
* This endpoint is an admin-only route, and requires the `adminUser.delete` permission.
|
|
1663
|
+
*/
|
|
1625
1664
|
export declare function restoreUserAdmin({ id }: {
|
|
1626
1665
|
id: string;
|
|
1627
1666
|
}, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
|
|
1667
|
+
/**
|
|
1668
|
+
* This endpoint is an admin-only route, and requires the `adminUser.read` permission.
|
|
1669
|
+
*/
|
|
1628
1670
|
export declare function getUserStatisticsAdmin({ id, isFavorite, isTrashed, visibility }: {
|
|
1629
1671
|
id: string;
|
|
1630
1672
|
isFavorite?: boolean;
|
|
1631
1673
|
isTrashed?: boolean;
|
|
1632
1674
|
visibility?: AssetVisibility;
|
|
1633
1675
|
}, opts?: Oazapfts.RequestOpts): Promise<AssetStatsResponseDto>;
|
|
1676
|
+
/**
|
|
1677
|
+
* This endpoint requires the `album.read` permission.
|
|
1678
|
+
*/
|
|
1634
1679
|
export declare function getAllAlbums({ assetId, shared }: {
|
|
1635
1680
|
assetId?: string;
|
|
1636
1681
|
shared?: boolean;
|
|
1637
1682
|
}, opts?: Oazapfts.RequestOpts): Promise<AlbumResponseDto[]>;
|
|
1683
|
+
/**
|
|
1684
|
+
* This endpoint requires the `album.create` permission.
|
|
1685
|
+
*/
|
|
1638
1686
|
export declare function createAlbum({ createAlbumDto }: {
|
|
1639
1687
|
createAlbumDto: CreateAlbumDto;
|
|
1640
1688
|
}, opts?: Oazapfts.RequestOpts): Promise<AlbumResponseDto>;
|
|
1689
|
+
/**
|
|
1690
|
+
* This endpoint requires the `album.statistics` permission.
|
|
1691
|
+
*/
|
|
1641
1692
|
export declare function getAlbumStatistics(opts?: Oazapfts.RequestOpts): Promise<AlbumStatisticsResponseDto>;
|
|
1693
|
+
/**
|
|
1694
|
+
* This endpoint requires the `album.delete` permission.
|
|
1695
|
+
*/
|
|
1642
1696
|
export declare function deleteAlbum({ id }: {
|
|
1643
1697
|
id: string;
|
|
1644
1698
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
1645
|
-
|
|
1699
|
+
/**
|
|
1700
|
+
* This endpoint requires the `album.read` permission.
|
|
1701
|
+
*/
|
|
1702
|
+
export declare function getAlbumInfo({ id, key, slug, withoutAssets }: {
|
|
1646
1703
|
id: string;
|
|
1647
1704
|
key?: string;
|
|
1705
|
+
slug?: string;
|
|
1648
1706
|
withoutAssets?: boolean;
|
|
1649
1707
|
}, opts?: Oazapfts.RequestOpts): Promise<AlbumResponseDto>;
|
|
1708
|
+
/**
|
|
1709
|
+
* This endpoint requires the `album.update` permission.
|
|
1710
|
+
*/
|
|
1650
1711
|
export declare function updateAlbumInfo({ id, updateAlbumDto }: {
|
|
1651
1712
|
id: string;
|
|
1652
1713
|
updateAlbumDto: UpdateAlbumDto;
|
|
1653
1714
|
}, opts?: Oazapfts.RequestOpts): Promise<AlbumResponseDto>;
|
|
1715
|
+
/**
|
|
1716
|
+
* This endpoint requires the `albumAsset.delete` permission.
|
|
1717
|
+
*/
|
|
1654
1718
|
export declare function removeAssetFromAlbum({ id, bulkIdsDto }: {
|
|
1655
1719
|
id: string;
|
|
1656
1720
|
bulkIdsDto: BulkIdsDto;
|
|
1657
1721
|
}, opts?: Oazapfts.RequestOpts): Promise<BulkIdResponseDto[]>;
|
|
1658
|
-
|
|
1722
|
+
/**
|
|
1723
|
+
* This endpoint requires the `albumAsset.create` permission.
|
|
1724
|
+
*/
|
|
1725
|
+
export declare function addAssetsToAlbum({ id, key, slug, bulkIdsDto }: {
|
|
1659
1726
|
id: string;
|
|
1660
1727
|
key?: string;
|
|
1728
|
+
slug?: string;
|
|
1661
1729
|
bulkIdsDto: BulkIdsDto;
|
|
1662
1730
|
}, opts?: Oazapfts.RequestOpts): Promise<BulkIdResponseDto[]>;
|
|
1731
|
+
/**
|
|
1732
|
+
* This endpoint requires the `albumUser.delete` permission.
|
|
1733
|
+
*/
|
|
1663
1734
|
export declare function removeUserFromAlbum({ id, userId }: {
|
|
1664
1735
|
id: string;
|
|
1665
1736
|
userId: string;
|
|
1666
1737
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
1738
|
+
/**
|
|
1739
|
+
* This endpoint requires the `albumUser.update` permission.
|
|
1740
|
+
*/
|
|
1667
1741
|
export declare function updateAlbumUser({ id, userId, updateAlbumUserDto }: {
|
|
1668
1742
|
id: string;
|
|
1669
1743
|
userId: string;
|
|
1670
1744
|
updateAlbumUserDto: UpdateAlbumUserDto;
|
|
1671
1745
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
1746
|
+
/**
|
|
1747
|
+
* This endpoint requires the `albumUser.create` permission.
|
|
1748
|
+
*/
|
|
1672
1749
|
export declare function addUsersToAlbum({ id, addUsersDto }: {
|
|
1673
1750
|
id: string;
|
|
1674
1751
|
addUsersDto: AddUsersDto;
|
|
1675
1752
|
}, opts?: Oazapfts.RequestOpts): Promise<AlbumResponseDto>;
|
|
1753
|
+
/**
|
|
1754
|
+
* This endpoint requires the `apiKey.read` permission.
|
|
1755
|
+
*/
|
|
1676
1756
|
export declare function getApiKeys(opts?: Oazapfts.RequestOpts): Promise<ApiKeyResponseDto[]>;
|
|
1757
|
+
/**
|
|
1758
|
+
* This endpoint requires the `apiKey.create` permission.
|
|
1759
|
+
*/
|
|
1677
1760
|
export declare function createApiKey({ apiKeyCreateDto }: {
|
|
1678
1761
|
apiKeyCreateDto: ApiKeyCreateDto;
|
|
1679
1762
|
}, opts?: Oazapfts.RequestOpts): Promise<ApiKeyCreateResponseDto>;
|
|
1763
|
+
/**
|
|
1764
|
+
* This endpoint requires the `apiKey.delete` permission.
|
|
1765
|
+
*/
|
|
1680
1766
|
export declare function deleteApiKey({ id }: {
|
|
1681
1767
|
id: string;
|
|
1682
1768
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
1769
|
+
/**
|
|
1770
|
+
* This endpoint requires the `apiKey.read` permission.
|
|
1771
|
+
*/
|
|
1683
1772
|
export declare function getApiKey({ id }: {
|
|
1684
1773
|
id: string;
|
|
1685
1774
|
}, opts?: Oazapfts.RequestOpts): Promise<ApiKeyResponseDto>;
|
|
1775
|
+
/**
|
|
1776
|
+
* This endpoint requires the `apiKey.update` permission.
|
|
1777
|
+
*/
|
|
1686
1778
|
export declare function updateApiKey({ id, apiKeyUpdateDto }: {
|
|
1687
1779
|
id: string;
|
|
1688
1780
|
apiKeyUpdateDto: ApiKeyUpdateDto;
|
|
1689
1781
|
}, opts?: Oazapfts.RequestOpts): Promise<ApiKeyResponseDto>;
|
|
1782
|
+
/**
|
|
1783
|
+
* This endpoint requires the `asset.delete` permission.
|
|
1784
|
+
*/
|
|
1690
1785
|
export declare function deleteAssets({ assetBulkDeleteDto }: {
|
|
1691
1786
|
assetBulkDeleteDto: AssetBulkDeleteDto;
|
|
1692
1787
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
1693
|
-
|
|
1788
|
+
/**
|
|
1789
|
+
* This endpoint requires the `asset.upload` permission.
|
|
1790
|
+
*/
|
|
1791
|
+
export declare function uploadAsset({ key, slug, xImmichChecksum, assetMediaCreateDto }: {
|
|
1694
1792
|
key?: string;
|
|
1793
|
+
slug?: string;
|
|
1695
1794
|
xImmichChecksum?: string;
|
|
1696
1795
|
assetMediaCreateDto: AssetMediaCreateDto;
|
|
1697
1796
|
}, opts?: Oazapfts.RequestOpts): Promise<AssetMediaResponseDto>;
|
|
1797
|
+
/**
|
|
1798
|
+
* This endpoint requires the `asset.update` permission.
|
|
1799
|
+
*/
|
|
1698
1800
|
export declare function updateAssets({ assetBulkUpdateDto }: {
|
|
1699
1801
|
assetBulkUpdateDto: AssetBulkUpdateDto;
|
|
1700
1802
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
@@ -1720,48 +1822,74 @@ export declare function runAssetJobs({ assetJobsDto }: {
|
|
|
1720
1822
|
assetJobsDto: AssetJobsDto;
|
|
1721
1823
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
1722
1824
|
/**
|
|
1723
|
-
* This property was deprecated in v1.116.0
|
|
1825
|
+
* This property was deprecated in v1.116.0. This endpoint requires the `asset.read` permission.
|
|
1724
1826
|
*/
|
|
1725
1827
|
export declare function getRandom({ count }: {
|
|
1726
1828
|
count?: number;
|
|
1727
1829
|
}, opts?: Oazapfts.RequestOpts): Promise<AssetResponseDto[]>;
|
|
1830
|
+
/**
|
|
1831
|
+
* This endpoint requires the `asset.statistics` permission.
|
|
1832
|
+
*/
|
|
1728
1833
|
export declare function getAssetStatistics({ isFavorite, isTrashed, visibility }: {
|
|
1729
1834
|
isFavorite?: boolean;
|
|
1730
1835
|
isTrashed?: boolean;
|
|
1731
1836
|
visibility?: AssetVisibility;
|
|
1732
1837
|
}, opts?: Oazapfts.RequestOpts): Promise<AssetStatsResponseDto>;
|
|
1733
|
-
|
|
1838
|
+
/**
|
|
1839
|
+
* This endpoint requires the `asset.read` permission.
|
|
1840
|
+
*/
|
|
1841
|
+
export declare function getAssetInfo({ id, key, slug }: {
|
|
1734
1842
|
id: string;
|
|
1735
1843
|
key?: string;
|
|
1844
|
+
slug?: string;
|
|
1736
1845
|
}, opts?: Oazapfts.RequestOpts): Promise<AssetResponseDto>;
|
|
1846
|
+
/**
|
|
1847
|
+
* This endpoint requires the `asset.update` permission.
|
|
1848
|
+
*/
|
|
1737
1849
|
export declare function updateAsset({ id, updateAssetDto }: {
|
|
1738
1850
|
id: string;
|
|
1739
1851
|
updateAssetDto: UpdateAssetDto;
|
|
1740
1852
|
}, opts?: Oazapfts.RequestOpts): Promise<AssetResponseDto>;
|
|
1741
|
-
|
|
1853
|
+
/**
|
|
1854
|
+
* This endpoint requires the `asset.download` permission.
|
|
1855
|
+
*/
|
|
1856
|
+
export declare function downloadAsset({ id, key, slug }: {
|
|
1742
1857
|
id: string;
|
|
1743
1858
|
key?: string;
|
|
1859
|
+
slug?: string;
|
|
1744
1860
|
}, opts?: Oazapfts.RequestOpts): Promise<Blob>;
|
|
1745
1861
|
/**
|
|
1746
1862
|
* replaceAsset
|
|
1747
1863
|
*/
|
|
1748
|
-
export declare function replaceAsset({ id, key, assetMediaReplaceDto }: {
|
|
1864
|
+
export declare function replaceAsset({ id, key, slug, assetMediaReplaceDto }: {
|
|
1749
1865
|
id: string;
|
|
1750
1866
|
key?: string;
|
|
1867
|
+
slug?: string;
|
|
1751
1868
|
assetMediaReplaceDto: AssetMediaReplaceDto;
|
|
1752
1869
|
}, opts?: Oazapfts.RequestOpts): Promise<AssetMediaResponseDto>;
|
|
1753
|
-
|
|
1870
|
+
/**
|
|
1871
|
+
* This endpoint requires the `asset.view` permission.
|
|
1872
|
+
*/
|
|
1873
|
+
export declare function viewAsset({ id, key, size, slug }: {
|
|
1754
1874
|
id: string;
|
|
1755
1875
|
key?: string;
|
|
1756
1876
|
size?: AssetMediaSize;
|
|
1877
|
+
slug?: string;
|
|
1757
1878
|
}, opts?: Oazapfts.RequestOpts): Promise<Blob>;
|
|
1758
|
-
|
|
1879
|
+
/**
|
|
1880
|
+
* This endpoint requires the `asset.view` permission.
|
|
1881
|
+
*/
|
|
1882
|
+
export declare function playAssetVideo({ id, key, slug }: {
|
|
1759
1883
|
id: string;
|
|
1760
1884
|
key?: string;
|
|
1885
|
+
slug?: string;
|
|
1761
1886
|
}, opts?: Oazapfts.RequestOpts): Promise<Blob>;
|
|
1762
1887
|
export declare function signUpAdmin({ signUpDto }: {
|
|
1763
1888
|
signUpDto: SignUpDto;
|
|
1764
1889
|
}, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
|
|
1890
|
+
/**
|
|
1891
|
+
* This endpoint requires the `auth.changePassword` permission.
|
|
1892
|
+
*/
|
|
1765
1893
|
export declare function changePassword({ changePasswordDto }: {
|
|
1766
1894
|
changePasswordDto: ChangePasswordDto;
|
|
1767
1895
|
}, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
|
|
@@ -1769,12 +1897,21 @@ export declare function login({ loginCredentialDto }: {
|
|
|
1769
1897
|
loginCredentialDto: LoginCredentialDto;
|
|
1770
1898
|
}, opts?: Oazapfts.RequestOpts): Promise<LoginResponseDto>;
|
|
1771
1899
|
export declare function logout(opts?: Oazapfts.RequestOpts): Promise<LogoutResponseDto>;
|
|
1900
|
+
/**
|
|
1901
|
+
* This endpoint requires the `pinCode.delete` permission.
|
|
1902
|
+
*/
|
|
1772
1903
|
export declare function resetPinCode({ pinCodeResetDto }: {
|
|
1773
1904
|
pinCodeResetDto: PinCodeResetDto;
|
|
1774
1905
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
1906
|
+
/**
|
|
1907
|
+
* This endpoint requires the `pinCode.create` permission.
|
|
1908
|
+
*/
|
|
1775
1909
|
export declare function setupPinCode({ pinCodeSetupDto }: {
|
|
1776
1910
|
pinCodeSetupDto: PinCodeSetupDto;
|
|
1777
1911
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
1912
|
+
/**
|
|
1913
|
+
* This endpoint requires the `pinCode.update` permission.
|
|
1914
|
+
*/
|
|
1778
1915
|
export declare function changePinCode({ pinCodeChangeDto }: {
|
|
1779
1916
|
pinCodeChangeDto: PinCodeChangeDto;
|
|
1780
1917
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
@@ -1784,60 +1921,119 @@ export declare function unlockAuthSession({ sessionUnlockDto }: {
|
|
|
1784
1921
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
1785
1922
|
export declare function getAuthStatus(opts?: Oazapfts.RequestOpts): Promise<AuthStatusResponseDto>;
|
|
1786
1923
|
export declare function validateAccessToken(opts?: Oazapfts.RequestOpts): Promise<ValidateAccessTokenResponseDto>;
|
|
1787
|
-
|
|
1924
|
+
/**
|
|
1925
|
+
* This endpoint requires the `asset.download` permission.
|
|
1926
|
+
*/
|
|
1927
|
+
export declare function downloadArchive({ key, slug, assetIdsDto }: {
|
|
1788
1928
|
key?: string;
|
|
1929
|
+
slug?: string;
|
|
1789
1930
|
assetIdsDto: AssetIdsDto;
|
|
1790
1931
|
}, opts?: Oazapfts.RequestOpts): Promise<Blob>;
|
|
1791
|
-
|
|
1932
|
+
/**
|
|
1933
|
+
* This endpoint requires the `asset.download` permission.
|
|
1934
|
+
*/
|
|
1935
|
+
export declare function getDownloadInfo({ key, slug, downloadInfoDto }: {
|
|
1792
1936
|
key?: string;
|
|
1937
|
+
slug?: string;
|
|
1793
1938
|
downloadInfoDto: DownloadInfoDto;
|
|
1794
1939
|
}, opts?: Oazapfts.RequestOpts): Promise<DownloadResponseDto>;
|
|
1940
|
+
/**
|
|
1941
|
+
* This endpoint requires the `duplicate.delete` permission.
|
|
1942
|
+
*/
|
|
1795
1943
|
export declare function deleteDuplicates({ bulkIdsDto }: {
|
|
1796
1944
|
bulkIdsDto: BulkIdsDto;
|
|
1797
1945
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
1946
|
+
/**
|
|
1947
|
+
* This endpoint requires the `duplicate.read` permission.
|
|
1948
|
+
*/
|
|
1798
1949
|
export declare function getAssetDuplicates(opts?: Oazapfts.RequestOpts): Promise<DuplicateResponseDto[]>;
|
|
1950
|
+
/**
|
|
1951
|
+
* This endpoint requires the `duplicate.delete` permission.
|
|
1952
|
+
*/
|
|
1799
1953
|
export declare function deleteDuplicate({ id }: {
|
|
1800
1954
|
id: string;
|
|
1801
1955
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
1956
|
+
/**
|
|
1957
|
+
* This endpoint requires the `face.read` permission.
|
|
1958
|
+
*/
|
|
1802
1959
|
export declare function getFaces({ id }: {
|
|
1803
1960
|
id: string;
|
|
1804
1961
|
}, opts?: Oazapfts.RequestOpts): Promise<AssetFaceResponseDto[]>;
|
|
1962
|
+
/**
|
|
1963
|
+
* This endpoint requires the `face.create` permission.
|
|
1964
|
+
*/
|
|
1805
1965
|
export declare function createFace({ assetFaceCreateDto }: {
|
|
1806
1966
|
assetFaceCreateDto: AssetFaceCreateDto;
|
|
1807
1967
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
1968
|
+
/**
|
|
1969
|
+
* This endpoint requires the `face.delete` permission.
|
|
1970
|
+
*/
|
|
1808
1971
|
export declare function deleteFace({ id, assetFaceDeleteDto }: {
|
|
1809
1972
|
id: string;
|
|
1810
1973
|
assetFaceDeleteDto: AssetFaceDeleteDto;
|
|
1811
1974
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
1975
|
+
/**
|
|
1976
|
+
* This endpoint requires the `face.update` permission.
|
|
1977
|
+
*/
|
|
1812
1978
|
export declare function reassignFacesById({ id, faceDto }: {
|
|
1813
1979
|
id: string;
|
|
1814
1980
|
faceDto: FaceDto;
|
|
1815
1981
|
}, opts?: Oazapfts.RequestOpts): Promise<PersonResponseDto>;
|
|
1982
|
+
/**
|
|
1983
|
+
* This endpoint is an admin-only route, and requires the `job.read` permission.
|
|
1984
|
+
*/
|
|
1816
1985
|
export declare function getAllJobsStatus(opts?: Oazapfts.RequestOpts): Promise<AllJobStatusResponseDto>;
|
|
1986
|
+
/**
|
|
1987
|
+
* This endpoint is an admin-only route, and requires the `job.create` permission.
|
|
1988
|
+
*/
|
|
1817
1989
|
export declare function createJob({ jobCreateDto }: {
|
|
1818
1990
|
jobCreateDto: JobCreateDto;
|
|
1819
1991
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
1992
|
+
/**
|
|
1993
|
+
* This endpoint is an admin-only route, and requires the `job.create` permission.
|
|
1994
|
+
*/
|
|
1820
1995
|
export declare function sendJobCommand({ id, jobCommandDto }: {
|
|
1821
1996
|
id: JobName;
|
|
1822
1997
|
jobCommandDto: JobCommandDto;
|
|
1823
1998
|
}, opts?: Oazapfts.RequestOpts): Promise<JobStatusDto>;
|
|
1999
|
+
/**
|
|
2000
|
+
* This endpoint is an admin-only route, and requires the `library.read` permission.
|
|
2001
|
+
*/
|
|
1824
2002
|
export declare function getAllLibraries(opts?: Oazapfts.RequestOpts): Promise<LibraryResponseDto[]>;
|
|
2003
|
+
/**
|
|
2004
|
+
* This endpoint is an admin-only route, and requires the `library.create` permission.
|
|
2005
|
+
*/
|
|
1825
2006
|
export declare function createLibrary({ createLibraryDto }: {
|
|
1826
2007
|
createLibraryDto: CreateLibraryDto;
|
|
1827
2008
|
}, opts?: Oazapfts.RequestOpts): Promise<LibraryResponseDto>;
|
|
2009
|
+
/**
|
|
2010
|
+
* This endpoint is an admin-only route, and requires the `library.delete` permission.
|
|
2011
|
+
*/
|
|
1828
2012
|
export declare function deleteLibrary({ id }: {
|
|
1829
2013
|
id: string;
|
|
1830
2014
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
2015
|
+
/**
|
|
2016
|
+
* This endpoint is an admin-only route, and requires the `library.read` permission.
|
|
2017
|
+
*/
|
|
1831
2018
|
export declare function getLibrary({ id }: {
|
|
1832
2019
|
id: string;
|
|
1833
2020
|
}, opts?: Oazapfts.RequestOpts): Promise<LibraryResponseDto>;
|
|
2021
|
+
/**
|
|
2022
|
+
* This endpoint is an admin-only route, and requires the `library.update` permission.
|
|
2023
|
+
*/
|
|
1834
2024
|
export declare function updateLibrary({ id, updateLibraryDto }: {
|
|
1835
2025
|
id: string;
|
|
1836
2026
|
updateLibraryDto: UpdateLibraryDto;
|
|
1837
2027
|
}, opts?: Oazapfts.RequestOpts): Promise<LibraryResponseDto>;
|
|
2028
|
+
/**
|
|
2029
|
+
* This endpoint is an admin-only route, and requires the `library.update` permission.
|
|
2030
|
+
*/
|
|
1838
2031
|
export declare function scanLibrary({ id }: {
|
|
1839
2032
|
id: string;
|
|
1840
2033
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
2034
|
+
/**
|
|
2035
|
+
* This endpoint is an admin-only route, and requires the `library.statistics` permission.
|
|
2036
|
+
*/
|
|
1841
2037
|
export declare function getLibraryStatistics({ id }: {
|
|
1842
2038
|
id: string;
|
|
1843
2039
|
}, opts?: Oazapfts.RequestOpts): Promise<LibraryStatsResponseDto>;
|
|
@@ -1845,11 +2041,11 @@ export declare function validate({ id, validateLibraryDto }: {
|
|
|
1845
2041
|
id: string;
|
|
1846
2042
|
validateLibraryDto: ValidateLibraryDto;
|
|
1847
2043
|
}, opts?: Oazapfts.RequestOpts): Promise<ValidateLibraryResponseDto>;
|
|
1848
|
-
export declare function getMapMarkers({
|
|
1849
|
-
fileCreatedAfter?: string;
|
|
1850
|
-
fileCreatedBefore?: string;
|
|
2044
|
+
export declare function getMapMarkers({ isArchived, isFavorite, fileCreatedAfter, fileCreatedBefore, withPartners, withSharedAlbums }: {
|
|
1851
2045
|
isArchived?: boolean;
|
|
1852
2046
|
isFavorite?: boolean;
|
|
2047
|
+
fileCreatedAfter?: string;
|
|
2048
|
+
fileCreatedBefore?: string;
|
|
1853
2049
|
withPartners?: boolean;
|
|
1854
2050
|
withSharedAlbums?: boolean;
|
|
1855
2051
|
}, opts?: Oazapfts.RequestOpts): Promise<MapMarkerResponseDto[]>;
|
|
@@ -1857,57 +2053,99 @@ export declare function reverseGeocode({ lat, lon }: {
|
|
|
1857
2053
|
lat: number;
|
|
1858
2054
|
lon: number;
|
|
1859
2055
|
}, opts?: Oazapfts.RequestOpts): Promise<MapReverseGeocodeResponseDto[]>;
|
|
2056
|
+
/**
|
|
2057
|
+
* This endpoint requires the `memory.read` permission.
|
|
2058
|
+
*/
|
|
1860
2059
|
export declare function searchMemories({ $for, isSaved, isTrashed, $type }: {
|
|
1861
2060
|
$for?: string;
|
|
1862
2061
|
isSaved?: boolean;
|
|
1863
2062
|
isTrashed?: boolean;
|
|
1864
2063
|
$type?: MemoryType;
|
|
1865
2064
|
}, opts?: Oazapfts.RequestOpts): Promise<MemoryResponseDto[]>;
|
|
2065
|
+
/**
|
|
2066
|
+
* This endpoint requires the `memory.create` permission.
|
|
2067
|
+
*/
|
|
1866
2068
|
export declare function createMemory({ memoryCreateDto }: {
|
|
1867
2069
|
memoryCreateDto: MemoryCreateDto;
|
|
1868
2070
|
}, opts?: Oazapfts.RequestOpts): Promise<MemoryResponseDto>;
|
|
2071
|
+
/**
|
|
2072
|
+
* This endpoint requires the `memory.statistics` permission.
|
|
2073
|
+
*/
|
|
1869
2074
|
export declare function memoriesStatistics({ $for, isSaved, isTrashed, $type }: {
|
|
1870
2075
|
$for?: string;
|
|
1871
2076
|
isSaved?: boolean;
|
|
1872
2077
|
isTrashed?: boolean;
|
|
1873
2078
|
$type?: MemoryType;
|
|
1874
2079
|
}, opts?: Oazapfts.RequestOpts): Promise<MemoryStatisticsResponseDto>;
|
|
2080
|
+
/**
|
|
2081
|
+
* This endpoint requires the `memory.delete` permission.
|
|
2082
|
+
*/
|
|
1875
2083
|
export declare function deleteMemory({ id }: {
|
|
1876
2084
|
id: string;
|
|
1877
2085
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
2086
|
+
/**
|
|
2087
|
+
* This endpoint requires the `memory.read` permission.
|
|
2088
|
+
*/
|
|
1878
2089
|
export declare function getMemory({ id }: {
|
|
1879
2090
|
id: string;
|
|
1880
2091
|
}, opts?: Oazapfts.RequestOpts): Promise<MemoryResponseDto>;
|
|
2092
|
+
/**
|
|
2093
|
+
* This endpoint requires the `memory.update` permission.
|
|
2094
|
+
*/
|
|
1881
2095
|
export declare function updateMemory({ id, memoryUpdateDto }: {
|
|
1882
2096
|
id: string;
|
|
1883
2097
|
memoryUpdateDto: MemoryUpdateDto;
|
|
1884
2098
|
}, opts?: Oazapfts.RequestOpts): Promise<MemoryResponseDto>;
|
|
2099
|
+
/**
|
|
2100
|
+
* This endpoint requires the `memoryAsset.delete` permission.
|
|
2101
|
+
*/
|
|
1885
2102
|
export declare function removeMemoryAssets({ id, bulkIdsDto }: {
|
|
1886
2103
|
id: string;
|
|
1887
2104
|
bulkIdsDto: BulkIdsDto;
|
|
1888
2105
|
}, opts?: Oazapfts.RequestOpts): Promise<BulkIdResponseDto[]>;
|
|
2106
|
+
/**
|
|
2107
|
+
* This endpoint requires the `memoryAsset.create` permission.
|
|
2108
|
+
*/
|
|
1889
2109
|
export declare function addMemoryAssets({ id, bulkIdsDto }: {
|
|
1890
2110
|
id: string;
|
|
1891
2111
|
bulkIdsDto: BulkIdsDto;
|
|
1892
2112
|
}, opts?: Oazapfts.RequestOpts): Promise<BulkIdResponseDto[]>;
|
|
2113
|
+
/**
|
|
2114
|
+
* This endpoint requires the `notification.delete` permission.
|
|
2115
|
+
*/
|
|
1893
2116
|
export declare function deleteNotifications({ notificationDeleteAllDto }: {
|
|
1894
2117
|
notificationDeleteAllDto: NotificationDeleteAllDto;
|
|
1895
2118
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
2119
|
+
/**
|
|
2120
|
+
* This endpoint requires the `notification.read` permission.
|
|
2121
|
+
*/
|
|
1896
2122
|
export declare function getNotifications({ id, level, $type, unread }: {
|
|
1897
2123
|
id?: string;
|
|
1898
2124
|
level?: NotificationLevel;
|
|
1899
2125
|
$type?: NotificationType;
|
|
1900
2126
|
unread?: boolean;
|
|
1901
2127
|
}, opts?: Oazapfts.RequestOpts): Promise<NotificationDto[]>;
|
|
2128
|
+
/**
|
|
2129
|
+
* This endpoint requires the `notification.update` permission.
|
|
2130
|
+
*/
|
|
1902
2131
|
export declare function updateNotifications({ notificationUpdateAllDto }: {
|
|
1903
2132
|
notificationUpdateAllDto: NotificationUpdateAllDto;
|
|
1904
2133
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
2134
|
+
/**
|
|
2135
|
+
* This endpoint requires the `notification.delete` permission.
|
|
2136
|
+
*/
|
|
1905
2137
|
export declare function deleteNotification({ id }: {
|
|
1906
2138
|
id: string;
|
|
1907
2139
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
2140
|
+
/**
|
|
2141
|
+
* This endpoint requires the `notification.read` permission.
|
|
2142
|
+
*/
|
|
1908
2143
|
export declare function getNotification({ id }: {
|
|
1909
2144
|
id: string;
|
|
1910
2145
|
}, opts?: Oazapfts.RequestOpts): Promise<NotificationDto>;
|
|
2146
|
+
/**
|
|
2147
|
+
* This endpoint requires the `notification.update` permission.
|
|
2148
|
+
*/
|
|
1911
2149
|
export declare function updateNotification({ id, notificationUpdateDto }: {
|
|
1912
2150
|
id: string;
|
|
1913
2151
|
notificationUpdateDto: NotificationUpdateDto;
|
|
@@ -1923,22 +2161,40 @@ export declare function linkOAuthAccount({ oAuthCallbackDto }: {
|
|
|
1923
2161
|
}, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
|
|
1924
2162
|
export declare function redirectOAuthToMobile(opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
1925
2163
|
export declare function unlinkOAuthAccount(opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
|
|
2164
|
+
/**
|
|
2165
|
+
* This endpoint requires the `partner.read` permission.
|
|
2166
|
+
*/
|
|
1926
2167
|
export declare function getPartners({ direction }: {
|
|
1927
2168
|
direction: PartnerDirection;
|
|
1928
2169
|
}, opts?: Oazapfts.RequestOpts): Promise<PartnerResponseDto[]>;
|
|
2170
|
+
/**
|
|
2171
|
+
* This endpoint requires the `partner.delete` permission.
|
|
2172
|
+
*/
|
|
1929
2173
|
export declare function removePartner({ id }: {
|
|
1930
2174
|
id: string;
|
|
1931
2175
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
2176
|
+
/**
|
|
2177
|
+
* This endpoint requires the `partner.create` permission.
|
|
2178
|
+
*/
|
|
1932
2179
|
export declare function createPartner({ id }: {
|
|
1933
2180
|
id: string;
|
|
1934
2181
|
}, opts?: Oazapfts.RequestOpts): Promise<PartnerResponseDto>;
|
|
2182
|
+
/**
|
|
2183
|
+
* This endpoint requires the `partner.update` permission.
|
|
2184
|
+
*/
|
|
1935
2185
|
export declare function updatePartner({ id, updatePartnerDto }: {
|
|
1936
2186
|
id: string;
|
|
1937
2187
|
updatePartnerDto: UpdatePartnerDto;
|
|
1938
2188
|
}, opts?: Oazapfts.RequestOpts): Promise<PartnerResponseDto>;
|
|
2189
|
+
/**
|
|
2190
|
+
* This endpoint requires the `person.delete` permission.
|
|
2191
|
+
*/
|
|
1939
2192
|
export declare function deletePeople({ bulkIdsDto }: {
|
|
1940
2193
|
bulkIdsDto: BulkIdsDto;
|
|
1941
2194
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
2195
|
+
/**
|
|
2196
|
+
* This endpoint requires the `person.read` permission.
|
|
2197
|
+
*/
|
|
1942
2198
|
export declare function getAllPeople({ closestAssetId, closestPersonId, page, size, withHidden }: {
|
|
1943
2199
|
closestAssetId?: string;
|
|
1944
2200
|
closestPersonId?: string;
|
|
@@ -1946,57 +2202,147 @@ export declare function getAllPeople({ closestAssetId, closestPersonId, page, si
|
|
|
1946
2202
|
size?: number;
|
|
1947
2203
|
withHidden?: boolean;
|
|
1948
2204
|
}, opts?: Oazapfts.RequestOpts): Promise<PeopleResponseDto>;
|
|
2205
|
+
/**
|
|
2206
|
+
* This endpoint requires the `person.create` permission.
|
|
2207
|
+
*/
|
|
1949
2208
|
export declare function createPerson({ personCreateDto }: {
|
|
1950
2209
|
personCreateDto: PersonCreateDto;
|
|
1951
2210
|
}, opts?: Oazapfts.RequestOpts): Promise<PersonResponseDto>;
|
|
2211
|
+
/**
|
|
2212
|
+
* This endpoint requires the `person.update` permission.
|
|
2213
|
+
*/
|
|
1952
2214
|
export declare function updatePeople({ peopleUpdateDto }: {
|
|
1953
2215
|
peopleUpdateDto: PeopleUpdateDto;
|
|
1954
2216
|
}, opts?: Oazapfts.RequestOpts): Promise<BulkIdResponseDto[]>;
|
|
2217
|
+
/**
|
|
2218
|
+
* This endpoint requires the `person.delete` permission.
|
|
2219
|
+
*/
|
|
1955
2220
|
export declare function deletePerson({ id }: {
|
|
1956
2221
|
id: string;
|
|
1957
2222
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
2223
|
+
/**
|
|
2224
|
+
* This endpoint requires the `person.read` permission.
|
|
2225
|
+
*/
|
|
1958
2226
|
export declare function getPerson({ id }: {
|
|
1959
2227
|
id: string;
|
|
1960
2228
|
}, opts?: Oazapfts.RequestOpts): Promise<PersonResponseDto>;
|
|
2229
|
+
/**
|
|
2230
|
+
* This endpoint requires the `person.update` permission.
|
|
2231
|
+
*/
|
|
1961
2232
|
export declare function updatePerson({ id, personUpdateDto }: {
|
|
1962
2233
|
id: string;
|
|
1963
2234
|
personUpdateDto: PersonUpdateDto;
|
|
1964
2235
|
}, opts?: Oazapfts.RequestOpts): Promise<PersonResponseDto>;
|
|
2236
|
+
/**
|
|
2237
|
+
* This endpoint requires the `person.merge` permission.
|
|
2238
|
+
*/
|
|
1965
2239
|
export declare function mergePerson({ id, mergePersonDto }: {
|
|
1966
2240
|
id: string;
|
|
1967
2241
|
mergePersonDto: MergePersonDto;
|
|
1968
2242
|
}, opts?: Oazapfts.RequestOpts): Promise<BulkIdResponseDto[]>;
|
|
2243
|
+
/**
|
|
2244
|
+
* This endpoint requires the `person.reassign` permission.
|
|
2245
|
+
*/
|
|
1969
2246
|
export declare function reassignFaces({ id, assetFaceUpdateDto }: {
|
|
1970
2247
|
id: string;
|
|
1971
2248
|
assetFaceUpdateDto: AssetFaceUpdateDto;
|
|
1972
2249
|
}, opts?: Oazapfts.RequestOpts): Promise<PersonResponseDto[]>;
|
|
2250
|
+
/**
|
|
2251
|
+
* This endpoint requires the `person.statistics` permission.
|
|
2252
|
+
*/
|
|
1973
2253
|
export declare function getPersonStatistics({ id }: {
|
|
1974
2254
|
id: string;
|
|
1975
2255
|
}, opts?: Oazapfts.RequestOpts): Promise<PersonStatisticsResponseDto>;
|
|
2256
|
+
/**
|
|
2257
|
+
* This endpoint requires the `person.read` permission.
|
|
2258
|
+
*/
|
|
1976
2259
|
export declare function getPersonThumbnail({ id }: {
|
|
1977
2260
|
id: string;
|
|
1978
2261
|
}, opts?: Oazapfts.RequestOpts): Promise<Blob>;
|
|
2262
|
+
/**
|
|
2263
|
+
* This endpoint requires the `asset.read` permission.
|
|
2264
|
+
*/
|
|
1979
2265
|
export declare function getAssetsByCity(opts?: Oazapfts.RequestOpts): Promise<AssetResponseDto[]>;
|
|
2266
|
+
/**
|
|
2267
|
+
* This endpoint requires the `asset.read` permission.
|
|
2268
|
+
*/
|
|
1980
2269
|
export declare function getExploreData(opts?: Oazapfts.RequestOpts): Promise<SearchExploreResponseDto[]>;
|
|
2270
|
+
/**
|
|
2271
|
+
* This endpoint requires the `asset.read` permission.
|
|
2272
|
+
*/
|
|
2273
|
+
export declare function searchLargeAssets({ albumIds, city, country, createdAfter, createdBefore, deviceId, isEncoded, isFavorite, isMotion, isNotInAlbum, isOffline, lensModel, libraryId, make, minFileSize, model, personIds, rating, size, state, tagIds, takenAfter, takenBefore, trashedAfter, trashedBefore, $type, updatedAfter, updatedBefore, visibility, withDeleted, withExif }: {
|
|
2274
|
+
albumIds?: string[];
|
|
2275
|
+
city?: string | null;
|
|
2276
|
+
country?: string | null;
|
|
2277
|
+
createdAfter?: string;
|
|
2278
|
+
createdBefore?: string;
|
|
2279
|
+
deviceId?: string;
|
|
2280
|
+
isEncoded?: boolean;
|
|
2281
|
+
isFavorite?: boolean;
|
|
2282
|
+
isMotion?: boolean;
|
|
2283
|
+
isNotInAlbum?: boolean;
|
|
2284
|
+
isOffline?: boolean;
|
|
2285
|
+
lensModel?: string | null;
|
|
2286
|
+
libraryId?: string | null;
|
|
2287
|
+
make?: string;
|
|
2288
|
+
minFileSize?: number;
|
|
2289
|
+
model?: string | null;
|
|
2290
|
+
personIds?: string[];
|
|
2291
|
+
rating?: number;
|
|
2292
|
+
size?: number;
|
|
2293
|
+
state?: string | null;
|
|
2294
|
+
tagIds?: string[] | null;
|
|
2295
|
+
takenAfter?: string;
|
|
2296
|
+
takenBefore?: string;
|
|
2297
|
+
trashedAfter?: string;
|
|
2298
|
+
trashedBefore?: string;
|
|
2299
|
+
$type?: AssetTypeEnum;
|
|
2300
|
+
updatedAfter?: string;
|
|
2301
|
+
updatedBefore?: string;
|
|
2302
|
+
visibility?: AssetVisibility;
|
|
2303
|
+
withDeleted?: boolean;
|
|
2304
|
+
withExif?: boolean;
|
|
2305
|
+
}, opts?: Oazapfts.RequestOpts): Promise<AssetResponseDto[]>;
|
|
2306
|
+
/**
|
|
2307
|
+
* This endpoint requires the `asset.read` permission.
|
|
2308
|
+
*/
|
|
1981
2309
|
export declare function searchAssets({ metadataSearchDto }: {
|
|
1982
2310
|
metadataSearchDto: MetadataSearchDto;
|
|
1983
2311
|
}, opts?: Oazapfts.RequestOpts): Promise<SearchResponseDto>;
|
|
2312
|
+
/**
|
|
2313
|
+
* This endpoint requires the `person.read` permission.
|
|
2314
|
+
*/
|
|
1984
2315
|
export declare function searchPerson({ name, withHidden }: {
|
|
1985
2316
|
name: string;
|
|
1986
2317
|
withHidden?: boolean;
|
|
1987
2318
|
}, opts?: Oazapfts.RequestOpts): Promise<PersonResponseDto[]>;
|
|
2319
|
+
/**
|
|
2320
|
+
* This endpoint requires the `asset.read` permission.
|
|
2321
|
+
*/
|
|
1988
2322
|
export declare function searchPlaces({ name }: {
|
|
1989
2323
|
name: string;
|
|
1990
2324
|
}, opts?: Oazapfts.RequestOpts): Promise<PlacesResponseDto[]>;
|
|
2325
|
+
/**
|
|
2326
|
+
* This endpoint requires the `asset.read` permission.
|
|
2327
|
+
*/
|
|
1991
2328
|
export declare function searchRandom({ randomSearchDto }: {
|
|
1992
2329
|
randomSearchDto: RandomSearchDto;
|
|
1993
2330
|
}, opts?: Oazapfts.RequestOpts): Promise<AssetResponseDto[]>;
|
|
2331
|
+
/**
|
|
2332
|
+
* This endpoint requires the `asset.read` permission.
|
|
2333
|
+
*/
|
|
1994
2334
|
export declare function searchSmart({ smartSearchDto }: {
|
|
1995
2335
|
smartSearchDto: SmartSearchDto;
|
|
1996
2336
|
}, opts?: Oazapfts.RequestOpts): Promise<SearchResponseDto>;
|
|
2337
|
+
/**
|
|
2338
|
+
* This endpoint requires the `asset.statistics` permission.
|
|
2339
|
+
*/
|
|
1997
2340
|
export declare function searchAssetStatistics({ statisticsSearchDto }: {
|
|
1998
2341
|
statisticsSearchDto: StatisticsSearchDto;
|
|
1999
2342
|
}, opts?: Oazapfts.RequestOpts): Promise<SearchStatisticsResponseDto>;
|
|
2343
|
+
/**
|
|
2344
|
+
* This endpoint requires the `asset.read` permission.
|
|
2345
|
+
*/
|
|
2000
2346
|
export declare function getSearchSuggestions({ country, includeNull, make, model, state, $type }: {
|
|
2001
2347
|
country?: string;
|
|
2002
2348
|
includeNull?: boolean;
|
|
@@ -2005,96 +2351,183 @@ export declare function getSearchSuggestions({ country, includeNull, make, model
|
|
|
2005
2351
|
state?: string;
|
|
2006
2352
|
$type: SearchSuggestionType;
|
|
2007
2353
|
}, opts?: Oazapfts.RequestOpts): Promise<string[]>;
|
|
2354
|
+
/**
|
|
2355
|
+
* This endpoint requires the `server.about` permission.
|
|
2356
|
+
*/
|
|
2008
2357
|
export declare function getAboutInfo(opts?: Oazapfts.RequestOpts): Promise<ServerAboutResponseDto>;
|
|
2358
|
+
/**
|
|
2359
|
+
* This endpoint requires the `server.apkLinks` permission.
|
|
2360
|
+
*/
|
|
2009
2361
|
export declare function getApkLinks(opts?: Oazapfts.RequestOpts): Promise<ServerApkLinksDto>;
|
|
2010
2362
|
export declare function getServerConfig(opts?: Oazapfts.RequestOpts): Promise<ServerConfigDto>;
|
|
2011
2363
|
export declare function getServerFeatures(opts?: Oazapfts.RequestOpts): Promise<ServerFeaturesDto>;
|
|
2364
|
+
/**
|
|
2365
|
+
* This endpoint is an admin-only route, and requires the `serverLicense.delete` permission.
|
|
2366
|
+
*/
|
|
2012
2367
|
export declare function deleteServerLicense(opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
2368
|
+
/**
|
|
2369
|
+
* This endpoint is an admin-only route, and requires the `serverLicense.read` permission.
|
|
2370
|
+
*/
|
|
2013
2371
|
export declare function getServerLicense(opts?: Oazapfts.RequestOpts): Promise<LicenseResponseDto>;
|
|
2372
|
+
/**
|
|
2373
|
+
* This endpoint is an admin-only route, and requires the `serverLicense.update` permission.
|
|
2374
|
+
*/
|
|
2014
2375
|
export declare function setServerLicense({ licenseKeyDto }: {
|
|
2015
2376
|
licenseKeyDto: LicenseKeyDto;
|
|
2016
2377
|
}, opts?: Oazapfts.RequestOpts): Promise<LicenseResponseDto>;
|
|
2017
2378
|
export declare function getSupportedMediaTypes(opts?: Oazapfts.RequestOpts): Promise<ServerMediaTypesResponseDto>;
|
|
2018
2379
|
export declare function pingServer(opts?: Oazapfts.RequestOpts): Promise<ServerPingResponseRead>;
|
|
2380
|
+
/**
|
|
2381
|
+
* This endpoint is an admin-only route, and requires the `server.statistics` permission.
|
|
2382
|
+
*/
|
|
2019
2383
|
export declare function getServerStatistics(opts?: Oazapfts.RequestOpts): Promise<ServerStatsResponseDto>;
|
|
2384
|
+
/**
|
|
2385
|
+
* This endpoint requires the `server.storage` permission.
|
|
2386
|
+
*/
|
|
2020
2387
|
export declare function getStorage(opts?: Oazapfts.RequestOpts): Promise<ServerStorageResponseDto>;
|
|
2021
2388
|
export declare function getTheme(opts?: Oazapfts.RequestOpts): Promise<ServerThemeDto>;
|
|
2022
2389
|
export declare function getServerVersion(opts?: Oazapfts.RequestOpts): Promise<ServerVersionResponseDto>;
|
|
2023
2390
|
export declare function getVersionCheck(opts?: Oazapfts.RequestOpts): Promise<VersionCheckStateResponseDto>;
|
|
2024
2391
|
export declare function getVersionHistory(opts?: Oazapfts.RequestOpts): Promise<ServerVersionHistoryResponseDto[]>;
|
|
2392
|
+
/**
|
|
2393
|
+
* This endpoint requires the `session.delete` permission.
|
|
2394
|
+
*/
|
|
2025
2395
|
export declare function deleteAllSessions(opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
2396
|
+
/**
|
|
2397
|
+
* This endpoint requires the `session.read` permission.
|
|
2398
|
+
*/
|
|
2026
2399
|
export declare function getSessions(opts?: Oazapfts.RequestOpts): Promise<SessionResponseDto[]>;
|
|
2400
|
+
/**
|
|
2401
|
+
* This endpoint requires the `session.create` permission.
|
|
2402
|
+
*/
|
|
2027
2403
|
export declare function createSession({ sessionCreateDto }: {
|
|
2028
2404
|
sessionCreateDto: SessionCreateDto;
|
|
2029
2405
|
}, opts?: Oazapfts.RequestOpts): Promise<SessionCreateResponseDto>;
|
|
2406
|
+
/**
|
|
2407
|
+
* This endpoint requires the `session.delete` permission.
|
|
2408
|
+
*/
|
|
2030
2409
|
export declare function deleteSession({ id }: {
|
|
2031
2410
|
id: string;
|
|
2032
2411
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
2412
|
+
/**
|
|
2413
|
+
* This endpoint requires the `session.update` permission.
|
|
2414
|
+
*/
|
|
2033
2415
|
export declare function updateSession({ id, sessionUpdateDto }: {
|
|
2034
2416
|
id: string;
|
|
2035
2417
|
sessionUpdateDto: SessionUpdateDto;
|
|
2036
2418
|
}, opts?: Oazapfts.RequestOpts): Promise<SessionResponseDto>;
|
|
2419
|
+
/**
|
|
2420
|
+
* This endpoint requires the `session.lock` permission.
|
|
2421
|
+
*/
|
|
2037
2422
|
export declare function lockSession({ id }: {
|
|
2038
2423
|
id: string;
|
|
2039
2424
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
2425
|
+
/**
|
|
2426
|
+
* This endpoint requires the `sharedLink.read` permission.
|
|
2427
|
+
*/
|
|
2040
2428
|
export declare function getAllSharedLinks({ albumId }: {
|
|
2041
2429
|
albumId?: string;
|
|
2042
2430
|
}, opts?: Oazapfts.RequestOpts): Promise<SharedLinkResponseDto[]>;
|
|
2431
|
+
/**
|
|
2432
|
+
* This endpoint requires the `sharedLink.create` permission.
|
|
2433
|
+
*/
|
|
2043
2434
|
export declare function createSharedLink({ sharedLinkCreateDto }: {
|
|
2044
2435
|
sharedLinkCreateDto: SharedLinkCreateDto;
|
|
2045
2436
|
}, opts?: Oazapfts.RequestOpts): Promise<SharedLinkResponseDto>;
|
|
2046
|
-
export declare function getMySharedLink({
|
|
2047
|
-
key?: string;
|
|
2437
|
+
export declare function getMySharedLink({ password, token, key, slug }: {
|
|
2048
2438
|
password?: string;
|
|
2049
2439
|
token?: string;
|
|
2440
|
+
key?: string;
|
|
2441
|
+
slug?: string;
|
|
2050
2442
|
}, opts?: Oazapfts.RequestOpts): Promise<SharedLinkResponseDto>;
|
|
2443
|
+
/**
|
|
2444
|
+
* This endpoint requires the `sharedLink.delete` permission.
|
|
2445
|
+
*/
|
|
2051
2446
|
export declare function removeSharedLink({ id }: {
|
|
2052
2447
|
id: string;
|
|
2053
2448
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
2449
|
+
/**
|
|
2450
|
+
* This endpoint requires the `sharedLink.read` permission.
|
|
2451
|
+
*/
|
|
2054
2452
|
export declare function getSharedLinkById({ id }: {
|
|
2055
2453
|
id: string;
|
|
2056
2454
|
}, opts?: Oazapfts.RequestOpts): Promise<SharedLinkResponseDto>;
|
|
2455
|
+
/**
|
|
2456
|
+
* This endpoint requires the `sharedLink.update` permission.
|
|
2457
|
+
*/
|
|
2057
2458
|
export declare function updateSharedLink({ id, sharedLinkEditDto }: {
|
|
2058
2459
|
id: string;
|
|
2059
2460
|
sharedLinkEditDto: SharedLinkEditDto;
|
|
2060
2461
|
}, opts?: Oazapfts.RequestOpts): Promise<SharedLinkResponseDto>;
|
|
2061
|
-
export declare function removeSharedLinkAssets({ id, key, assetIdsDto }: {
|
|
2462
|
+
export declare function removeSharedLinkAssets({ id, key, slug, assetIdsDto }: {
|
|
2062
2463
|
id: string;
|
|
2063
2464
|
key?: string;
|
|
2465
|
+
slug?: string;
|
|
2064
2466
|
assetIdsDto: AssetIdsDto;
|
|
2065
2467
|
}, opts?: Oazapfts.RequestOpts): Promise<AssetIdsResponseDto[]>;
|
|
2066
|
-
export declare function addSharedLinkAssets({ id, key, assetIdsDto }: {
|
|
2468
|
+
export declare function addSharedLinkAssets({ id, key, slug, assetIdsDto }: {
|
|
2067
2469
|
id: string;
|
|
2068
2470
|
key?: string;
|
|
2471
|
+
slug?: string;
|
|
2069
2472
|
assetIdsDto: AssetIdsDto;
|
|
2070
2473
|
}, opts?: Oazapfts.RequestOpts): Promise<AssetIdsResponseDto[]>;
|
|
2474
|
+
/**
|
|
2475
|
+
* This endpoint requires the `stack.delete` permission.
|
|
2476
|
+
*/
|
|
2071
2477
|
export declare function deleteStacks({ bulkIdsDto }: {
|
|
2072
2478
|
bulkIdsDto: BulkIdsDto;
|
|
2073
2479
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
2480
|
+
/**
|
|
2481
|
+
* This endpoint requires the `stack.read` permission.
|
|
2482
|
+
*/
|
|
2074
2483
|
export declare function searchStacks({ primaryAssetId }: {
|
|
2075
2484
|
primaryAssetId?: string;
|
|
2076
2485
|
}, opts?: Oazapfts.RequestOpts): Promise<StackResponseDto[]>;
|
|
2486
|
+
/**
|
|
2487
|
+
* This endpoint requires the `stack.create` permission.
|
|
2488
|
+
*/
|
|
2077
2489
|
export declare function createStack({ stackCreateDto }: {
|
|
2078
2490
|
stackCreateDto: StackCreateDto;
|
|
2079
2491
|
}, opts?: Oazapfts.RequestOpts): Promise<StackResponseDto>;
|
|
2492
|
+
/**
|
|
2493
|
+
* This endpoint requires the `stack.delete` permission.
|
|
2494
|
+
*/
|
|
2080
2495
|
export declare function deleteStack({ id }: {
|
|
2081
2496
|
id: string;
|
|
2082
2497
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
2498
|
+
/**
|
|
2499
|
+
* This endpoint requires the `stack.read` permission.
|
|
2500
|
+
*/
|
|
2083
2501
|
export declare function getStack({ id }: {
|
|
2084
2502
|
id: string;
|
|
2085
2503
|
}, opts?: Oazapfts.RequestOpts): Promise<StackResponseDto>;
|
|
2504
|
+
/**
|
|
2505
|
+
* This endpoint requires the `stack.update` permission.
|
|
2506
|
+
*/
|
|
2086
2507
|
export declare function updateStack({ id, stackUpdateDto }: {
|
|
2087
2508
|
id: string;
|
|
2088
2509
|
stackUpdateDto: StackUpdateDto;
|
|
2089
2510
|
}, opts?: Oazapfts.RequestOpts): Promise<StackResponseDto>;
|
|
2511
|
+
/**
|
|
2512
|
+
* This endpoint requires the `stack.update` permission.
|
|
2513
|
+
*/
|
|
2090
2514
|
export declare function removeAssetFromStack({ assetId, id }: {
|
|
2091
2515
|
assetId: string;
|
|
2092
2516
|
id: string;
|
|
2093
2517
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
2518
|
+
/**
|
|
2519
|
+
* This endpoint requires the `syncCheckpoint.delete` permission.
|
|
2520
|
+
*/
|
|
2094
2521
|
export declare function deleteSyncAck({ syncAckDeleteDto }: {
|
|
2095
2522
|
syncAckDeleteDto: SyncAckDeleteDto;
|
|
2096
2523
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
2524
|
+
/**
|
|
2525
|
+
* This endpoint requires the `syncCheckpoint.read` permission.
|
|
2526
|
+
*/
|
|
2097
2527
|
export declare function getSyncAck(opts?: Oazapfts.RequestOpts): Promise<SyncAckDto[]>;
|
|
2528
|
+
/**
|
|
2529
|
+
* This endpoint requires the `syncCheckpoint.update` permission.
|
|
2530
|
+
*/
|
|
2098
2531
|
export declare function sendSyncAck({ syncAckSetDto }: {
|
|
2099
2532
|
syncAckSetDto: SyncAckSetDto;
|
|
2100
2533
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
@@ -2104,56 +2537,114 @@ export declare function getDeltaSync({ assetDeltaSyncDto }: {
|
|
|
2104
2537
|
export declare function getFullSyncForUser({ assetFullSyncDto }: {
|
|
2105
2538
|
assetFullSyncDto: AssetFullSyncDto;
|
|
2106
2539
|
}, opts?: Oazapfts.RequestOpts): Promise<AssetResponseDto[]>;
|
|
2540
|
+
/**
|
|
2541
|
+
* This endpoint requires the `sync.stream` permission.
|
|
2542
|
+
*/
|
|
2107
2543
|
export declare function getSyncStream({ syncStreamDto }: {
|
|
2108
2544
|
syncStreamDto: SyncStreamDto;
|
|
2109
2545
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
2546
|
+
/**
|
|
2547
|
+
* This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
|
|
2548
|
+
*/
|
|
2110
2549
|
export declare function getConfig(opts?: Oazapfts.RequestOpts): Promise<SystemConfigDto>;
|
|
2550
|
+
/**
|
|
2551
|
+
* This endpoint is an admin-only route, and requires the `systemConfig.update` permission.
|
|
2552
|
+
*/
|
|
2111
2553
|
export declare function updateConfig({ systemConfigDto }: {
|
|
2112
2554
|
systemConfigDto: SystemConfigDto;
|
|
2113
2555
|
}, opts?: Oazapfts.RequestOpts): Promise<SystemConfigDto>;
|
|
2556
|
+
/**
|
|
2557
|
+
* This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
|
|
2558
|
+
*/
|
|
2114
2559
|
export declare function getConfigDefaults(opts?: Oazapfts.RequestOpts): Promise<SystemConfigDto>;
|
|
2560
|
+
/**
|
|
2561
|
+
* This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
|
|
2562
|
+
*/
|
|
2115
2563
|
export declare function getStorageTemplateOptions(opts?: Oazapfts.RequestOpts): Promise<SystemConfigTemplateStorageOptionDto>;
|
|
2564
|
+
/**
|
|
2565
|
+
* This endpoint is an admin-only route, and requires the `systemMetadata.read` permission.
|
|
2566
|
+
*/
|
|
2116
2567
|
export declare function getAdminOnboarding(opts?: Oazapfts.RequestOpts): Promise<AdminOnboardingUpdateDto>;
|
|
2568
|
+
/**
|
|
2569
|
+
* This endpoint is an admin-only route, and requires the `systemMetadata.update` permission.
|
|
2570
|
+
*/
|
|
2117
2571
|
export declare function updateAdminOnboarding({ adminOnboardingUpdateDto }: {
|
|
2118
2572
|
adminOnboardingUpdateDto: AdminOnboardingUpdateDto;
|
|
2119
2573
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
2574
|
+
/**
|
|
2575
|
+
* This endpoint is an admin-only route, and requires the `systemMetadata.read` permission.
|
|
2576
|
+
*/
|
|
2120
2577
|
export declare function getReverseGeocodingState(opts?: Oazapfts.RequestOpts): Promise<ReverseGeocodingStateResponseDto>;
|
|
2578
|
+
/**
|
|
2579
|
+
* This endpoint is an admin-only route, and requires the `systemMetadata.read` permission.
|
|
2580
|
+
*/
|
|
2121
2581
|
export declare function getVersionCheckState(opts?: Oazapfts.RequestOpts): Promise<VersionCheckStateResponseDto>;
|
|
2582
|
+
/**
|
|
2583
|
+
* This endpoint requires the `tag.read` permission.
|
|
2584
|
+
*/
|
|
2122
2585
|
export declare function getAllTags(opts?: Oazapfts.RequestOpts): Promise<TagResponseDto[]>;
|
|
2586
|
+
/**
|
|
2587
|
+
* This endpoint requires the `tag.create` permission.
|
|
2588
|
+
*/
|
|
2123
2589
|
export declare function createTag({ tagCreateDto }: {
|
|
2124
2590
|
tagCreateDto: TagCreateDto;
|
|
2125
2591
|
}, opts?: Oazapfts.RequestOpts): Promise<TagResponseDto>;
|
|
2592
|
+
/**
|
|
2593
|
+
* This endpoint requires the `tag.create` permission.
|
|
2594
|
+
*/
|
|
2126
2595
|
export declare function upsertTags({ tagUpsertDto }: {
|
|
2127
2596
|
tagUpsertDto: TagUpsertDto;
|
|
2128
2597
|
}, opts?: Oazapfts.RequestOpts): Promise<TagResponseDto[]>;
|
|
2598
|
+
/**
|
|
2599
|
+
* This endpoint requires the `tag.asset` permission.
|
|
2600
|
+
*/
|
|
2129
2601
|
export declare function bulkTagAssets({ tagBulkAssetsDto }: {
|
|
2130
2602
|
tagBulkAssetsDto: TagBulkAssetsDto;
|
|
2131
2603
|
}, opts?: Oazapfts.RequestOpts): Promise<TagBulkAssetsResponseDto>;
|
|
2604
|
+
/**
|
|
2605
|
+
* This endpoint requires the `tag.delete` permission.
|
|
2606
|
+
*/
|
|
2132
2607
|
export declare function deleteTag({ id }: {
|
|
2133
2608
|
id: string;
|
|
2134
2609
|
}, opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
2610
|
+
/**
|
|
2611
|
+
* This endpoint requires the `tag.read` permission.
|
|
2612
|
+
*/
|
|
2135
2613
|
export declare function getTagById({ id }: {
|
|
2136
2614
|
id: string;
|
|
2137
2615
|
}, opts?: Oazapfts.RequestOpts): Promise<TagResponseDto>;
|
|
2616
|
+
/**
|
|
2617
|
+
* This endpoint requires the `tag.update` permission.
|
|
2618
|
+
*/
|
|
2138
2619
|
export declare function updateTag({ id, tagUpdateDto }: {
|
|
2139
2620
|
id: string;
|
|
2140
2621
|
tagUpdateDto: TagUpdateDto;
|
|
2141
2622
|
}, opts?: Oazapfts.RequestOpts): Promise<TagResponseDto>;
|
|
2623
|
+
/**
|
|
2624
|
+
* This endpoint requires the `tag.asset` permission.
|
|
2625
|
+
*/
|
|
2142
2626
|
export declare function untagAssets({ id, bulkIdsDto }: {
|
|
2143
2627
|
id: string;
|
|
2144
2628
|
bulkIdsDto: BulkIdsDto;
|
|
2145
2629
|
}, opts?: Oazapfts.RequestOpts): Promise<BulkIdResponseDto[]>;
|
|
2630
|
+
/**
|
|
2631
|
+
* This endpoint requires the `tag.asset` permission.
|
|
2632
|
+
*/
|
|
2146
2633
|
export declare function tagAssets({ id, bulkIdsDto }: {
|
|
2147
2634
|
id: string;
|
|
2148
2635
|
bulkIdsDto: BulkIdsDto;
|
|
2149
2636
|
}, opts?: Oazapfts.RequestOpts): Promise<BulkIdResponseDto[]>;
|
|
2150
|
-
|
|
2637
|
+
/**
|
|
2638
|
+
* This endpoint requires the `asset.read` permission.
|
|
2639
|
+
*/
|
|
2640
|
+
export declare function getTimeBucket({ albumId, isFavorite, isTrashed, key, order, personId, slug, tagId, timeBucket, userId, visibility, withPartners, withStacked }: {
|
|
2151
2641
|
albumId?: string;
|
|
2152
2642
|
isFavorite?: boolean;
|
|
2153
2643
|
isTrashed?: boolean;
|
|
2154
2644
|
key?: string;
|
|
2155
2645
|
order?: AssetOrder;
|
|
2156
2646
|
personId?: string;
|
|
2647
|
+
slug?: string;
|
|
2157
2648
|
tagId?: string;
|
|
2158
2649
|
timeBucket: string;
|
|
2159
2650
|
userId?: string;
|
|
@@ -2161,50 +2652,108 @@ export declare function getTimeBucket({ albumId, isFavorite, isTrashed, key, ord
|
|
|
2161
2652
|
withPartners?: boolean;
|
|
2162
2653
|
withStacked?: boolean;
|
|
2163
2654
|
}, opts?: Oazapfts.RequestOpts): Promise<TimeBucketAssetResponseDto>;
|
|
2164
|
-
|
|
2655
|
+
/**
|
|
2656
|
+
* This endpoint requires the `asset.read` permission.
|
|
2657
|
+
*/
|
|
2658
|
+
export declare function getTimeBuckets({ albumId, isFavorite, isTrashed, key, order, personId, slug, tagId, userId, visibility, withPartners, withStacked }: {
|
|
2165
2659
|
albumId?: string;
|
|
2166
2660
|
isFavorite?: boolean;
|
|
2167
2661
|
isTrashed?: boolean;
|
|
2168
2662
|
key?: string;
|
|
2169
2663
|
order?: AssetOrder;
|
|
2170
2664
|
personId?: string;
|
|
2665
|
+
slug?: string;
|
|
2171
2666
|
tagId?: string;
|
|
2172
2667
|
userId?: string;
|
|
2173
2668
|
visibility?: AssetVisibility;
|
|
2174
2669
|
withPartners?: boolean;
|
|
2175
2670
|
withStacked?: boolean;
|
|
2176
2671
|
}, opts?: Oazapfts.RequestOpts): Promise<TimeBucketsResponseDto[]>;
|
|
2672
|
+
/**
|
|
2673
|
+
* This endpoint requires the `asset.delete` permission.
|
|
2674
|
+
*/
|
|
2177
2675
|
export declare function emptyTrash(opts?: Oazapfts.RequestOpts): Promise<TrashResponseDto>;
|
|
2676
|
+
/**
|
|
2677
|
+
* This endpoint requires the `asset.delete` permission.
|
|
2678
|
+
*/
|
|
2178
2679
|
export declare function restoreTrash(opts?: Oazapfts.RequestOpts): Promise<TrashResponseDto>;
|
|
2680
|
+
/**
|
|
2681
|
+
* This endpoint requires the `asset.delete` permission.
|
|
2682
|
+
*/
|
|
2179
2683
|
export declare function restoreAssets({ bulkIdsDto }: {
|
|
2180
2684
|
bulkIdsDto: BulkIdsDto;
|
|
2181
2685
|
}, opts?: Oazapfts.RequestOpts): Promise<TrashResponseDto>;
|
|
2686
|
+
/**
|
|
2687
|
+
* This endpoint requires the `user.read` permission.
|
|
2688
|
+
*/
|
|
2182
2689
|
export declare function searchUsers(opts?: Oazapfts.RequestOpts): Promise<UserResponseDto[]>;
|
|
2690
|
+
/**
|
|
2691
|
+
* This endpoint requires the `user.read` permission.
|
|
2692
|
+
*/
|
|
2183
2693
|
export declare function getMyUser(opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
|
|
2694
|
+
/**
|
|
2695
|
+
* This endpoint requires the `user.update` permission.
|
|
2696
|
+
*/
|
|
2184
2697
|
export declare function updateMyUser({ userUpdateMeDto }: {
|
|
2185
2698
|
userUpdateMeDto: UserUpdateMeDto;
|
|
2186
2699
|
}, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
|
|
2700
|
+
/**
|
|
2701
|
+
* This endpoint requires the `userLicense.delete` permission.
|
|
2702
|
+
*/
|
|
2187
2703
|
export declare function deleteUserLicense(opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
2704
|
+
/**
|
|
2705
|
+
* This endpoint requires the `userLicense.read` permission.
|
|
2706
|
+
*/
|
|
2188
2707
|
export declare function getUserLicense(opts?: Oazapfts.RequestOpts): Promise<LicenseResponseDto>;
|
|
2708
|
+
/**
|
|
2709
|
+
* This endpoint requires the `userLicense.update` permission.
|
|
2710
|
+
*/
|
|
2189
2711
|
export declare function setUserLicense({ licenseKeyDto }: {
|
|
2190
2712
|
licenseKeyDto: LicenseKeyDto;
|
|
2191
2713
|
}, opts?: Oazapfts.RequestOpts): Promise<LicenseResponseDto>;
|
|
2714
|
+
/**
|
|
2715
|
+
* This endpoint requires the `userOnboarding.delete` permission.
|
|
2716
|
+
*/
|
|
2192
2717
|
export declare function deleteUserOnboarding(opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
2718
|
+
/**
|
|
2719
|
+
* This endpoint requires the `userOnboarding.read` permission.
|
|
2720
|
+
*/
|
|
2193
2721
|
export declare function getUserOnboarding(opts?: Oazapfts.RequestOpts): Promise<OnboardingResponseDto>;
|
|
2722
|
+
/**
|
|
2723
|
+
* This endpoint requires the `userOnboarding.update` permission.
|
|
2724
|
+
*/
|
|
2194
2725
|
export declare function setUserOnboarding({ onboardingDto }: {
|
|
2195
2726
|
onboardingDto: OnboardingDto;
|
|
2196
2727
|
}, opts?: Oazapfts.RequestOpts): Promise<OnboardingResponseDto>;
|
|
2728
|
+
/**
|
|
2729
|
+
* This endpoint requires the `userPreference.read` permission.
|
|
2730
|
+
*/
|
|
2197
2731
|
export declare function getMyPreferences(opts?: Oazapfts.RequestOpts): Promise<UserPreferencesResponseDto>;
|
|
2732
|
+
/**
|
|
2733
|
+
* This endpoint requires the `userPreference.update` permission.
|
|
2734
|
+
*/
|
|
2198
2735
|
export declare function updateMyPreferences({ userPreferencesUpdateDto }: {
|
|
2199
2736
|
userPreferencesUpdateDto: UserPreferencesUpdateDto;
|
|
2200
2737
|
}, opts?: Oazapfts.RequestOpts): Promise<UserPreferencesResponseDto>;
|
|
2738
|
+
/**
|
|
2739
|
+
* This endpoint requires the `userProfileImage.delete` permission.
|
|
2740
|
+
*/
|
|
2201
2741
|
export declare function deleteProfileImage(opts?: Oazapfts.RequestOpts): Promise<never>;
|
|
2742
|
+
/**
|
|
2743
|
+
* This endpoint requires the `userProfileImage.update` permission.
|
|
2744
|
+
*/
|
|
2202
2745
|
export declare function createProfileImage({ createProfileImageDto }: {
|
|
2203
2746
|
createProfileImageDto: CreateProfileImageDto;
|
|
2204
2747
|
}, opts?: Oazapfts.RequestOpts): Promise<CreateProfileImageResponseDto>;
|
|
2748
|
+
/**
|
|
2749
|
+
* This endpoint requires the `user.read` permission.
|
|
2750
|
+
*/
|
|
2205
2751
|
export declare function getUser({ id }: {
|
|
2206
2752
|
id: string;
|
|
2207
2753
|
}, opts?: Oazapfts.RequestOpts): Promise<UserResponseDto>;
|
|
2754
|
+
/**
|
|
2755
|
+
* This endpoint requires the `userProfileImage.read` permission.
|
|
2756
|
+
*/
|
|
2208
2757
|
export declare function getProfileImage({ id }: {
|
|
2209
2758
|
id: string;
|
|
2210
2759
|
}, opts?: Oazapfts.RequestOpts): Promise<Blob>;
|
|
@@ -2294,25 +2843,35 @@ export declare enum Permission {
|
|
|
2294
2843
|
AssetRead = "asset.read",
|
|
2295
2844
|
AssetUpdate = "asset.update",
|
|
2296
2845
|
AssetDelete = "asset.delete",
|
|
2846
|
+
AssetStatistics = "asset.statistics",
|
|
2297
2847
|
AssetShare = "asset.share",
|
|
2298
2848
|
AssetView = "asset.view",
|
|
2299
2849
|
AssetDownload = "asset.download",
|
|
2300
2850
|
AssetUpload = "asset.upload",
|
|
2851
|
+
AssetReplace = "asset.replace",
|
|
2301
2852
|
AlbumCreate = "album.create",
|
|
2302
2853
|
AlbumRead = "album.read",
|
|
2303
2854
|
AlbumUpdate = "album.update",
|
|
2304
2855
|
AlbumDelete = "album.delete",
|
|
2305
2856
|
AlbumStatistics = "album.statistics",
|
|
2306
|
-
AlbumAddAsset = "album.addAsset",
|
|
2307
|
-
AlbumRemoveAsset = "album.removeAsset",
|
|
2308
2857
|
AlbumShare = "album.share",
|
|
2309
2858
|
AlbumDownload = "album.download",
|
|
2859
|
+
AlbumAssetCreate = "albumAsset.create",
|
|
2860
|
+
AlbumAssetDelete = "albumAsset.delete",
|
|
2861
|
+
AlbumUserCreate = "albumUser.create",
|
|
2862
|
+
AlbumUserUpdate = "albumUser.update",
|
|
2863
|
+
AlbumUserDelete = "albumUser.delete",
|
|
2864
|
+
AuthChangePassword = "auth.changePassword",
|
|
2310
2865
|
AuthDeviceDelete = "authDevice.delete",
|
|
2311
2866
|
ArchiveRead = "archive.read",
|
|
2867
|
+
DuplicateRead = "duplicate.read",
|
|
2868
|
+
DuplicateDelete = "duplicate.delete",
|
|
2312
2869
|
FaceCreate = "face.create",
|
|
2313
2870
|
FaceRead = "face.read",
|
|
2314
2871
|
FaceUpdate = "face.update",
|
|
2315
2872
|
FaceDelete = "face.delete",
|
|
2873
|
+
JobCreate = "job.create",
|
|
2874
|
+
JobRead = "job.read",
|
|
2316
2875
|
LibraryCreate = "library.create",
|
|
2317
2876
|
LibraryRead = "library.read",
|
|
2318
2877
|
LibraryUpdate = "library.update",
|
|
@@ -2324,6 +2883,9 @@ export declare enum Permission {
|
|
|
2324
2883
|
MemoryRead = "memory.read",
|
|
2325
2884
|
MemoryUpdate = "memory.update",
|
|
2326
2885
|
MemoryDelete = "memory.delete",
|
|
2886
|
+
MemoryStatistics = "memory.statistics",
|
|
2887
|
+
MemoryAssetCreate = "memoryAsset.create",
|
|
2888
|
+
MemoryAssetDelete = "memoryAsset.delete",
|
|
2327
2889
|
NotificationCreate = "notification.create",
|
|
2328
2890
|
NotificationRead = "notification.read",
|
|
2329
2891
|
NotificationUpdate = "notification.update",
|
|
@@ -2339,6 +2901,16 @@ export declare enum Permission {
|
|
|
2339
2901
|
PersonStatistics = "person.statistics",
|
|
2340
2902
|
PersonMerge = "person.merge",
|
|
2341
2903
|
PersonReassign = "person.reassign",
|
|
2904
|
+
PinCodeCreate = "pinCode.create",
|
|
2905
|
+
PinCodeUpdate = "pinCode.update",
|
|
2906
|
+
PinCodeDelete = "pinCode.delete",
|
|
2907
|
+
ServerAbout = "server.about",
|
|
2908
|
+
ServerApkLinks = "server.apkLinks",
|
|
2909
|
+
ServerStorage = "server.storage",
|
|
2910
|
+
ServerStatistics = "server.statistics",
|
|
2911
|
+
ServerLicenseRead = "serverLicense.read",
|
|
2912
|
+
ServerLicenseUpdate = "serverLicense.update",
|
|
2913
|
+
ServerLicenseDelete = "serverLicense.delete",
|
|
2342
2914
|
SessionCreate = "session.create",
|
|
2343
2915
|
SessionRead = "session.read",
|
|
2344
2916
|
SessionUpdate = "session.update",
|
|
@@ -2352,6 +2924,10 @@ export declare enum Permission {
|
|
|
2352
2924
|
StackRead = "stack.read",
|
|
2353
2925
|
StackUpdate = "stack.update",
|
|
2354
2926
|
StackDelete = "stack.delete",
|
|
2927
|
+
SyncStream = "sync.stream",
|
|
2928
|
+
SyncCheckpointRead = "syncCheckpoint.read",
|
|
2929
|
+
SyncCheckpointUpdate = "syncCheckpoint.update",
|
|
2930
|
+
SyncCheckpointDelete = "syncCheckpoint.delete",
|
|
2355
2931
|
SystemConfigRead = "systemConfig.read",
|
|
2356
2932
|
SystemConfigUpdate = "systemConfig.update",
|
|
2357
2933
|
SystemMetadataRead = "systemMetadata.read",
|
|
@@ -2361,10 +2937,25 @@ export declare enum Permission {
|
|
|
2361
2937
|
TagUpdate = "tag.update",
|
|
2362
2938
|
TagDelete = "tag.delete",
|
|
2363
2939
|
TagAsset = "tag.asset",
|
|
2364
|
-
|
|
2365
|
-
|
|
2366
|
-
|
|
2367
|
-
|
|
2940
|
+
UserRead = "user.read",
|
|
2941
|
+
UserUpdate = "user.update",
|
|
2942
|
+
UserLicenseCreate = "userLicense.create",
|
|
2943
|
+
UserLicenseRead = "userLicense.read",
|
|
2944
|
+
UserLicenseUpdate = "userLicense.update",
|
|
2945
|
+
UserLicenseDelete = "userLicense.delete",
|
|
2946
|
+
UserOnboardingRead = "userOnboarding.read",
|
|
2947
|
+
UserOnboardingUpdate = "userOnboarding.update",
|
|
2948
|
+
UserOnboardingDelete = "userOnboarding.delete",
|
|
2949
|
+
UserPreferenceRead = "userPreference.read",
|
|
2950
|
+
UserPreferenceUpdate = "userPreference.update",
|
|
2951
|
+
UserProfileImageCreate = "userProfileImage.create",
|
|
2952
|
+
UserProfileImageRead = "userProfileImage.read",
|
|
2953
|
+
UserProfileImageUpdate = "userProfileImage.update",
|
|
2954
|
+
UserProfileImageDelete = "userProfileImage.delete",
|
|
2955
|
+
AdminUserCreate = "adminUser.create",
|
|
2956
|
+
AdminUserRead = "adminUser.read",
|
|
2957
|
+
AdminUserUpdate = "adminUser.update",
|
|
2958
|
+
AdminUserDelete = "adminUser.delete"
|
|
2368
2959
|
}
|
|
2369
2960
|
export declare enum AssetMediaStatus {
|
|
2370
2961
|
Created = "created",
|