@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
  */
@@ -15,7 +15,7 @@ export const servers = {
15
15
  server1: "/api"
16
16
  };
17
17
  /**
18
- * This endpoint requires the `activity.read` permission.
18
+ * List all activities
19
19
  */
20
20
  export function getActivities({ albumId, assetId, level, $type, userId }, opts) {
21
21
  return oazapfts.ok(oazapfts.fetchJson(`/activities${QS.query(QS.explode({
@@ -29,7 +29,7 @@ export function getActivities({ albumId, assetId, level, $type, userId }, opts)
29
29
  }));
30
30
  }
31
31
  /**
32
- * This endpoint requires the `activity.create` permission.
32
+ * Create an activity
33
33
  */
34
34
  export function createActivity({ activityCreateDto }, opts) {
35
35
  return oazapfts.ok(oazapfts.fetchJson("/activities", oazapfts.json({
@@ -39,7 +39,7 @@ export function createActivity({ activityCreateDto }, opts) {
39
39
  })));
40
40
  }
41
41
  /**
42
- * This endpoint requires the `activity.statistics` permission.
42
+ * Retrieve activity statistics
43
43
  */
44
44
  export function getActivityStatistics({ albumId, assetId }, opts) {
45
45
  return oazapfts.ok(oazapfts.fetchJson(`/activities/statistics${QS.query(QS.explode({
@@ -50,7 +50,7 @@ export function getActivityStatistics({ albumId, assetId }, opts) {
50
50
  }));
51
51
  }
52
52
  /**
53
- * This endpoint requires the `activity.delete` permission.
53
+ * Delete an activity
54
54
  */
55
55
  export function deleteActivity({ id }, opts) {
56
56
  return oazapfts.ok(oazapfts.fetchText(`/activities/${encodeURIComponent(id)}`, {
@@ -59,7 +59,7 @@ export function deleteActivity({ id }, opts) {
59
59
  }));
60
60
  }
61
61
  /**
62
- * This endpoint is an admin-only route, and requires the `adminAuth.unlinkAll` permission.
62
+ * Unlink all OAuth accounts
63
63
  */
64
64
  export function unlinkAllOAuthAccountsAdmin(opts) {
65
65
  return oazapfts.ok(oazapfts.fetchText("/admin/auth/unlink-all", {
@@ -67,6 +67,29 @@ export function unlinkAllOAuthAccountsAdmin(opts) {
67
67
  method: "POST"
68
68
  }));
69
69
  }
70
+ /**
71
+ * Set maintenance mode
72
+ */
73
+ export function setMaintenanceMode({ setMaintenanceModeDto }, opts) {
74
+ return oazapfts.ok(oazapfts.fetchText("/admin/maintenance", oazapfts.json({
75
+ ...opts,
76
+ method: "POST",
77
+ body: setMaintenanceModeDto
78
+ })));
79
+ }
80
+ /**
81
+ * Log into maintenance mode
82
+ */
83
+ export function maintenanceLogin({ maintenanceLoginDto }, opts) {
84
+ return oazapfts.ok(oazapfts.fetchJson("/admin/maintenance/login", oazapfts.json({
85
+ ...opts,
86
+ method: "POST",
87
+ body: maintenanceLoginDto
88
+ })));
89
+ }
90
+ /**
91
+ * Create a notification
92
+ */
70
93
  export function createNotification({ notificationCreateDto }, opts) {
71
94
  return oazapfts.ok(oazapfts.fetchJson("/admin/notifications", oazapfts.json({
72
95
  ...opts,
@@ -74,6 +97,9 @@ export function createNotification({ notificationCreateDto }, opts) {
74
97
  body: notificationCreateDto
75
98
  })));
76
99
  }
100
+ /**
101
+ * Render email template
102
+ */
77
103
  export function getNotificationTemplateAdmin({ name, templateDto }, opts) {
78
104
  return oazapfts.ok(oazapfts.fetchJson(`/admin/notifications/templates/${encodeURIComponent(name)}`, oazapfts.json({
79
105
  ...opts,
@@ -81,6 +107,9 @@ export function getNotificationTemplateAdmin({ name, templateDto }, opts) {
81
107
  body: templateDto
82
108
  })));
83
109
  }
110
+ /**
111
+ * Send test email
112
+ */
84
113
  export function sendTestEmailAdmin({ systemConfigSmtpDto }, opts) {
85
114
  return oazapfts.ok(oazapfts.fetchJson("/admin/notifications/test-email", oazapfts.json({
86
115
  ...opts,
@@ -89,7 +118,7 @@ export function sendTestEmailAdmin({ systemConfigSmtpDto }, opts) {
89
118
  })));
90
119
  }
91
120
  /**
92
- * This endpoint is an admin-only route, and requires the `adminUser.read` permission.
121
+ * Search users
93
122
  */
94
123
  export function searchUsersAdmin({ id, withDeleted }, opts) {
95
124
  return oazapfts.ok(oazapfts.fetchJson(`/admin/users${QS.query(QS.explode({
@@ -100,7 +129,7 @@ export function searchUsersAdmin({ id, withDeleted }, opts) {
100
129
  }));
101
130
  }
102
131
  /**
103
- * This endpoint is an admin-only route, and requires the `adminUser.create` permission.
132
+ * Create a user
104
133
  */
105
134
  export function createUserAdmin({ userAdminCreateDto }, opts) {
106
135
  return oazapfts.ok(oazapfts.fetchJson("/admin/users", oazapfts.json({
@@ -110,7 +139,7 @@ export function createUserAdmin({ userAdminCreateDto }, opts) {
110
139
  })));
111
140
  }
112
141
  /**
113
- * This endpoint is an admin-only route, and requires the `adminUser.delete` permission.
142
+ * Delete a user
114
143
  */
115
144
  export function deleteUserAdmin({ id, userAdminDeleteDto }, opts) {
116
145
  return oazapfts.ok(oazapfts.fetchJson(`/admin/users/${encodeURIComponent(id)}`, oazapfts.json({
@@ -120,7 +149,7 @@ export function deleteUserAdmin({ id, userAdminDeleteDto }, opts) {
120
149
  })));
121
150
  }
122
151
  /**
123
- * This endpoint is an admin-only route, and requires the `adminUser.read` permission.
152
+ * Retrieve a user
124
153
  */
125
154
  export function getUserAdmin({ id }, opts) {
126
155
  return oazapfts.ok(oazapfts.fetchJson(`/admin/users/${encodeURIComponent(id)}`, {
@@ -128,7 +157,7 @@ export function getUserAdmin({ id }, opts) {
128
157
  }));
129
158
  }
130
159
  /**
131
- * This endpoint is an admin-only route, and requires the `adminUser.update` permission.
160
+ * Update a user
132
161
  */
133
162
  export function updateUserAdmin({ id, userAdminUpdateDto }, opts) {
134
163
  return oazapfts.ok(oazapfts.fetchJson(`/admin/users/${encodeURIComponent(id)}`, oazapfts.json({
@@ -138,7 +167,7 @@ export function updateUserAdmin({ id, userAdminUpdateDto }, opts) {
138
167
  })));
139
168
  }
140
169
  /**
141
- * This endpoint is an admin-only route, and requires the `adminUser.read` permission.
170
+ * Retrieve user preferences
142
171
  */
143
172
  export function getUserPreferencesAdmin({ id }, opts) {
144
173
  return oazapfts.ok(oazapfts.fetchJson(`/admin/users/${encodeURIComponent(id)}/preferences`, {
@@ -146,7 +175,7 @@ export function getUserPreferencesAdmin({ id }, opts) {
146
175
  }));
147
176
  }
148
177
  /**
149
- * This endpoint is an admin-only route, and requires the `adminUser.update` permission.
178
+ * Update user preferences
150
179
  */
151
180
  export function updateUserPreferencesAdmin({ id, userPreferencesUpdateDto }, opts) {
152
181
  return oazapfts.ok(oazapfts.fetchJson(`/admin/users/${encodeURIComponent(id)}/preferences`, oazapfts.json({
@@ -156,7 +185,7 @@ export function updateUserPreferencesAdmin({ id, userPreferencesUpdateDto }, opt
156
185
  })));
157
186
  }
158
187
  /**
159
- * This endpoint is an admin-only route, and requires the `adminUser.delete` permission.
188
+ * Restore a deleted user
160
189
  */
161
190
  export function restoreUserAdmin({ id }, opts) {
162
191
  return oazapfts.ok(oazapfts.fetchJson(`/admin/users/${encodeURIComponent(id)}/restore`, {
@@ -165,7 +194,7 @@ export function restoreUserAdmin({ id }, opts) {
165
194
  }));
166
195
  }
167
196
  /**
168
- * This endpoint is an admin-only route, and requires the `adminSession.read` permission.
197
+ * Retrieve user sessions
169
198
  */
170
199
  export function getUserSessionsAdmin({ id }, opts) {
171
200
  return oazapfts.ok(oazapfts.fetchJson(`/admin/users/${encodeURIComponent(id)}/sessions`, {
@@ -173,7 +202,7 @@ export function getUserSessionsAdmin({ id }, opts) {
173
202
  }));
174
203
  }
175
204
  /**
176
- * This endpoint is an admin-only route, and requires the `adminUser.read` permission.
205
+ * Retrieve user statistics
177
206
  */
178
207
  export function getUserStatisticsAdmin({ id, isFavorite, isTrashed, visibility }, opts) {
179
208
  return oazapfts.ok(oazapfts.fetchJson(`/admin/users/${encodeURIComponent(id)}/statistics${QS.query(QS.explode({
@@ -185,7 +214,7 @@ export function getUserStatisticsAdmin({ id, isFavorite, isTrashed, visibility }
185
214
  }));
186
215
  }
187
216
  /**
188
- * This endpoint requires the `album.read` permission.
217
+ * List all albums
189
218
  */
190
219
  export function getAllAlbums({ assetId, shared }, opts) {
191
220
  return oazapfts.ok(oazapfts.fetchJson(`/albums${QS.query(QS.explode({
@@ -196,7 +225,7 @@ export function getAllAlbums({ assetId, shared }, opts) {
196
225
  }));
197
226
  }
198
227
  /**
199
- * This endpoint requires the `album.create` permission.
228
+ * Create an album
200
229
  */
201
230
  export function createAlbum({ createAlbumDto }, opts) {
202
231
  return oazapfts.ok(oazapfts.fetchJson("/albums", oazapfts.json({
@@ -206,7 +235,7 @@ export function createAlbum({ createAlbumDto }, opts) {
206
235
  })));
207
236
  }
208
237
  /**
209
- * This endpoint requires the `albumAsset.create` permission.
238
+ * Add assets to albums
210
239
  */
211
240
  export function addAssetsToAlbums({ key, slug, albumsAddAssetsDto }, opts) {
212
241
  return oazapfts.ok(oazapfts.fetchJson(`/albums/assets${QS.query(QS.explode({
@@ -219,7 +248,7 @@ export function addAssetsToAlbums({ key, slug, albumsAddAssetsDto }, opts) {
219
248
  })));
220
249
  }
221
250
  /**
222
- * This endpoint requires the `album.statistics` permission.
251
+ * Retrieve album statistics
223
252
  */
224
253
  export function getAlbumStatistics(opts) {
225
254
  return oazapfts.ok(oazapfts.fetchJson("/albums/statistics", {
@@ -227,7 +256,7 @@ export function getAlbumStatistics(opts) {
227
256
  }));
228
257
  }
229
258
  /**
230
- * This endpoint requires the `album.delete` permission.
259
+ * Delete an album
231
260
  */
232
261
  export function deleteAlbum({ id }, opts) {
233
262
  return oazapfts.ok(oazapfts.fetchText(`/albums/${encodeURIComponent(id)}`, {
@@ -236,7 +265,7 @@ export function deleteAlbum({ id }, opts) {
236
265
  }));
237
266
  }
238
267
  /**
239
- * This endpoint requires the `album.read` permission.
268
+ * Retrieve an album
240
269
  */
241
270
  export function getAlbumInfo({ id, key, slug, withoutAssets }, opts) {
242
271
  return oazapfts.ok(oazapfts.fetchJson(`/albums/${encodeURIComponent(id)}${QS.query(QS.explode({
@@ -248,7 +277,7 @@ export function getAlbumInfo({ id, key, slug, withoutAssets }, opts) {
248
277
  }));
249
278
  }
250
279
  /**
251
- * This endpoint requires the `album.update` permission.
280
+ * Update an album
252
281
  */
253
282
  export function updateAlbumInfo({ id, updateAlbumDto }, opts) {
254
283
  return oazapfts.ok(oazapfts.fetchJson(`/albums/${encodeURIComponent(id)}`, oazapfts.json({
@@ -258,7 +287,7 @@ export function updateAlbumInfo({ id, updateAlbumDto }, opts) {
258
287
  })));
259
288
  }
260
289
  /**
261
- * This endpoint requires the `albumAsset.delete` permission.
290
+ * Remove assets from an album
262
291
  */
263
292
  export function removeAssetFromAlbum({ id, bulkIdsDto }, opts) {
264
293
  return oazapfts.ok(oazapfts.fetchJson(`/albums/${encodeURIComponent(id)}/assets`, oazapfts.json({
@@ -268,7 +297,7 @@ export function removeAssetFromAlbum({ id, bulkIdsDto }, opts) {
268
297
  })));
269
298
  }
270
299
  /**
271
- * This endpoint requires the `albumAsset.create` permission.
300
+ * Add assets to an album
272
301
  */
273
302
  export function addAssetsToAlbum({ id, key, slug, bulkIdsDto }, opts) {
274
303
  return oazapfts.ok(oazapfts.fetchJson(`/albums/${encodeURIComponent(id)}/assets${QS.query(QS.explode({
@@ -281,7 +310,7 @@ export function addAssetsToAlbum({ id, key, slug, bulkIdsDto }, opts) {
281
310
  })));
282
311
  }
283
312
  /**
284
- * This endpoint requires the `albumUser.delete` permission.
313
+ * Remove user from album
285
314
  */
286
315
  export function removeUserFromAlbum({ id, userId }, opts) {
287
316
  return oazapfts.ok(oazapfts.fetchText(`/albums/${encodeURIComponent(id)}/user/${encodeURIComponent(userId)}`, {
@@ -290,7 +319,7 @@ export function removeUserFromAlbum({ id, userId }, opts) {
290
319
  }));
291
320
  }
292
321
  /**
293
- * This endpoint requires the `albumUser.update` permission.
322
+ * Update user role
294
323
  */
295
324
  export function updateAlbumUser({ id, userId, updateAlbumUserDto }, opts) {
296
325
  return oazapfts.ok(oazapfts.fetchText(`/albums/${encodeURIComponent(id)}/user/${encodeURIComponent(userId)}`, oazapfts.json({
@@ -300,7 +329,7 @@ export function updateAlbumUser({ id, userId, updateAlbumUserDto }, opts) {
300
329
  })));
301
330
  }
302
331
  /**
303
- * This endpoint requires the `albumUser.create` permission.
332
+ * Share album with users
304
333
  */
305
334
  export function addUsersToAlbum({ id, addUsersDto }, opts) {
306
335
  return oazapfts.ok(oazapfts.fetchJson(`/albums/${encodeURIComponent(id)}/users`, oazapfts.json({
@@ -310,7 +339,7 @@ export function addUsersToAlbum({ id, addUsersDto }, opts) {
310
339
  })));
311
340
  }
312
341
  /**
313
- * This endpoint requires the `apiKey.read` permission.
342
+ * List all API keys
314
343
  */
315
344
  export function getApiKeys(opts) {
316
345
  return oazapfts.ok(oazapfts.fetchJson("/api-keys", {
@@ -318,7 +347,7 @@ export function getApiKeys(opts) {
318
347
  }));
319
348
  }
320
349
  /**
321
- * This endpoint requires the `apiKey.create` permission.
350
+ * Create an API key
322
351
  */
323
352
  export function createApiKey({ apiKeyCreateDto }, opts) {
324
353
  return oazapfts.ok(oazapfts.fetchJson("/api-keys", oazapfts.json({
@@ -327,13 +356,16 @@ export function createApiKey({ apiKeyCreateDto }, opts) {
327
356
  body: apiKeyCreateDto
328
357
  })));
329
358
  }
359
+ /**
360
+ * Retrieve the current API key
361
+ */
330
362
  export function getMyApiKey(opts) {
331
363
  return oazapfts.ok(oazapfts.fetchJson("/api-keys/me", {
332
364
  ...opts
333
365
  }));
334
366
  }
335
367
  /**
336
- * This endpoint requires the `apiKey.delete` permission.
368
+ * Delete an API key
337
369
  */
338
370
  export function deleteApiKey({ id }, opts) {
339
371
  return oazapfts.ok(oazapfts.fetchText(`/api-keys/${encodeURIComponent(id)}`, {
@@ -342,7 +374,7 @@ export function deleteApiKey({ id }, opts) {
342
374
  }));
343
375
  }
344
376
  /**
345
- * This endpoint requires the `apiKey.read` permission.
377
+ * Retrieve an API key
346
378
  */
347
379
  export function getApiKey({ id }, opts) {
348
380
  return oazapfts.ok(oazapfts.fetchJson(`/api-keys/${encodeURIComponent(id)}`, {
@@ -350,7 +382,7 @@ export function getApiKey({ id }, opts) {
350
382
  }));
351
383
  }
352
384
  /**
353
- * This endpoint requires the `apiKey.update` permission.
385
+ * Update an API key
354
386
  */
355
387
  export function updateApiKey({ id, apiKeyUpdateDto }, opts) {
356
388
  return oazapfts.ok(oazapfts.fetchJson(`/api-keys/${encodeURIComponent(id)}`, oazapfts.json({
@@ -360,7 +392,7 @@ export function updateApiKey({ id, apiKeyUpdateDto }, opts) {
360
392
  })));
361
393
  }
362
394
  /**
363
- * This endpoint requires the `asset.delete` permission.
395
+ * Delete assets
364
396
  */
365
397
  export function deleteAssets({ assetBulkDeleteDto }, opts) {
366
398
  return oazapfts.ok(oazapfts.fetchText("/assets", oazapfts.json({
@@ -370,7 +402,7 @@ export function deleteAssets({ assetBulkDeleteDto }, opts) {
370
402
  })));
371
403
  }
372
404
  /**
373
- * This endpoint requires the `asset.upload` permission.
405
+ * Upload asset
374
406
  */
375
407
  export function uploadAsset({ key, slug, xImmichChecksum, assetMediaCreateDto }, opts) {
376
408
  return oazapfts.ok(oazapfts.fetchJson(`/assets${QS.query(QS.explode({
@@ -386,7 +418,7 @@ export function uploadAsset({ key, slug, xImmichChecksum, assetMediaCreateDto },
386
418
  })));
387
419
  }
388
420
  /**
389
- * This endpoint requires the `asset.update` permission.
421
+ * Update assets
390
422
  */
391
423
  export function updateAssets({ assetBulkUpdateDto }, opts) {
392
424
  return oazapfts.ok(oazapfts.fetchText("/assets", oazapfts.json({
@@ -396,7 +428,7 @@ export function updateAssets({ assetBulkUpdateDto }, opts) {
396
428
  })));
397
429
  }
398
430
  /**
399
- * checkBulkUpload
431
+ * Check bulk upload
400
432
  */
401
433
  export function checkBulkUpload({ assetBulkUploadCheckDto }, opts) {
402
434
  return oazapfts.ok(oazapfts.fetchJson("/assets/bulk-upload-check", oazapfts.json({
@@ -406,7 +438,7 @@ export function checkBulkUpload({ assetBulkUploadCheckDto }, opts) {
406
438
  })));
407
439
  }
408
440
  /**
409
- * This endpoint requires the `asset.copy` permission.
441
+ * Copy asset
410
442
  */
411
443
  export function copyAsset({ assetCopyDto }, opts) {
412
444
  return oazapfts.ok(oazapfts.fetchText("/assets/copy", oazapfts.json({
@@ -416,7 +448,7 @@ export function copyAsset({ assetCopyDto }, opts) {
416
448
  })));
417
449
  }
418
450
  /**
419
- * getAllUserAssetsByDeviceId
451
+ * Retrieve assets by device ID
420
452
  */
421
453
  export function getAllUserAssetsByDeviceId({ deviceId }, opts) {
422
454
  return oazapfts.ok(oazapfts.fetchJson(`/assets/device/${encodeURIComponent(deviceId)}`, {
@@ -424,7 +456,7 @@ export function getAllUserAssetsByDeviceId({ deviceId }, opts) {
424
456
  }));
425
457
  }
426
458
  /**
427
- * checkExistingAssets
459
+ * Check existing assets
428
460
  */
429
461
  export function checkExistingAssets({ checkExistingAssetsDto }, opts) {
430
462
  return oazapfts.ok(oazapfts.fetchJson("/assets/exist", oazapfts.json({
@@ -433,6 +465,9 @@ export function checkExistingAssets({ checkExistingAssetsDto }, opts) {
433
465
  body: checkExistingAssetsDto
434
466
  })));
435
467
  }
468
+ /**
469
+ * Run an asset job
470
+ */
436
471
  export function runAssetJobs({ assetJobsDto }, opts) {
437
472
  return oazapfts.ok(oazapfts.fetchText("/assets/jobs", oazapfts.json({
438
473
  ...opts,
@@ -441,7 +476,7 @@ export function runAssetJobs({ assetJobsDto }, opts) {
441
476
  })));
442
477
  }
443
478
  /**
444
- * This property was deprecated in v1.116.0. This endpoint requires the `asset.read` permission.
479
+ * Get random assets
445
480
  */
446
481
  export function getRandom({ count }, opts) {
447
482
  return oazapfts.ok(oazapfts.fetchJson(`/assets/random${QS.query(QS.explode({
@@ -451,7 +486,7 @@ export function getRandom({ count }, opts) {
451
486
  }));
452
487
  }
453
488
  /**
454
- * This endpoint requires the `asset.statistics` permission.
489
+ * Get asset statistics
455
490
  */
456
491
  export function getAssetStatistics({ isFavorite, isTrashed, visibility }, opts) {
457
492
  return oazapfts.ok(oazapfts.fetchJson(`/assets/statistics${QS.query(QS.explode({
@@ -463,7 +498,7 @@ export function getAssetStatistics({ isFavorite, isTrashed, visibility }, opts)
463
498
  }));
464
499
  }
465
500
  /**
466
- * This endpoint requires the `asset.read` permission.
501
+ * Retrieve an asset
467
502
  */
468
503
  export function getAssetInfo({ id, key, slug }, opts) {
469
504
  return oazapfts.ok(oazapfts.fetchJson(`/assets/${encodeURIComponent(id)}${QS.query(QS.explode({
@@ -474,7 +509,7 @@ export function getAssetInfo({ id, key, slug }, opts) {
474
509
  }));
475
510
  }
476
511
  /**
477
- * This endpoint requires the `asset.update` permission.
512
+ * Update an asset
478
513
  */
479
514
  export function updateAsset({ id, updateAssetDto }, opts) {
480
515
  return oazapfts.ok(oazapfts.fetchJson(`/assets/${encodeURIComponent(id)}`, oazapfts.json({
@@ -484,7 +519,7 @@ export function updateAsset({ id, updateAssetDto }, opts) {
484
519
  })));
485
520
  }
486
521
  /**
487
- * This endpoint requires the `asset.read` permission.
522
+ * Get asset metadata
488
523
  */
489
524
  export function getAssetMetadata({ id }, opts) {
490
525
  return oazapfts.ok(oazapfts.fetchJson(`/assets/${encodeURIComponent(id)}/metadata`, {
@@ -492,7 +527,7 @@ export function getAssetMetadata({ id }, opts) {
492
527
  }));
493
528
  }
494
529
  /**
495
- * This endpoint requires the `asset.update` permission.
530
+ * Update asset metadata
496
531
  */
497
532
  export function updateAssetMetadata({ id, assetMetadataUpsertDto }, opts) {
498
533
  return oazapfts.ok(oazapfts.fetchJson(`/assets/${encodeURIComponent(id)}/metadata`, oazapfts.json({
@@ -502,7 +537,7 @@ export function updateAssetMetadata({ id, assetMetadataUpsertDto }, opts) {
502
537
  })));
503
538
  }
504
539
  /**
505
- * This endpoint requires the `asset.update` permission.
540
+ * Delete asset metadata by key
506
541
  */
507
542
  export function deleteAssetMetadata({ id, key }, opts) {
508
543
  return oazapfts.ok(oazapfts.fetchText(`/assets/${encodeURIComponent(id)}/metadata/${encodeURIComponent(key)}`, {
@@ -511,7 +546,7 @@ export function deleteAssetMetadata({ id, key }, opts) {
511
546
  }));
512
547
  }
513
548
  /**
514
- * This endpoint requires the `asset.read` permission.
549
+ * Retrieve asset metadata by key
515
550
  */
516
551
  export function getAssetMetadataByKey({ id, key }, opts) {
517
552
  return oazapfts.ok(oazapfts.fetchJson(`/assets/${encodeURIComponent(id)}/metadata/${encodeURIComponent(key)}`, {
@@ -519,7 +554,7 @@ export function getAssetMetadataByKey({ id, key }, opts) {
519
554
  }));
520
555
  }
521
556
  /**
522
- * This endpoint requires the `asset.read` permission.
557
+ * Retrieve asset OCR data
523
558
  */
524
559
  export function getAssetOcr({ id }, opts) {
525
560
  return oazapfts.ok(oazapfts.fetchJson(`/assets/${encodeURIComponent(id)}/ocr`, {
@@ -527,7 +562,7 @@ export function getAssetOcr({ id }, opts) {
527
562
  }));
528
563
  }
529
564
  /**
530
- * This endpoint requires the `asset.download` permission.
565
+ * Download original asset
531
566
  */
532
567
  export function downloadAsset({ id, key, slug }, opts) {
533
568
  return oazapfts.ok(oazapfts.fetchBlob(`/assets/${encodeURIComponent(id)}/original${QS.query(QS.explode({
@@ -538,7 +573,7 @@ export function downloadAsset({ id, key, slug }, opts) {
538
573
  }));
539
574
  }
540
575
  /**
541
- * Replace the asset with new file, without changing its id
576
+ * Replace asset
542
577
  */
543
578
  export function replaceAsset({ id, key, slug, assetMediaReplaceDto }, opts) {
544
579
  return oazapfts.ok(oazapfts.fetchJson(`/assets/${encodeURIComponent(id)}/original${QS.query(QS.explode({
@@ -551,7 +586,7 @@ export function replaceAsset({ id, key, slug, assetMediaReplaceDto }, opts) {
551
586
  })));
552
587
  }
553
588
  /**
554
- * This endpoint requires the `asset.view` permission.
589
+ * View asset thumbnail
555
590
  */
556
591
  export function viewAsset({ id, key, size, slug }, opts) {
557
592
  return oazapfts.ok(oazapfts.fetchBlob(`/assets/${encodeURIComponent(id)}/thumbnail${QS.query(QS.explode({
@@ -563,7 +598,7 @@ export function viewAsset({ id, key, size, slug }, opts) {
563
598
  }));
564
599
  }
565
600
  /**
566
- * This endpoint requires the `asset.view` permission.
601
+ * Play asset video
567
602
  */
568
603
  export function playAssetVideo({ id, key, slug }, opts) {
569
604
  return oazapfts.ok(oazapfts.fetchBlob(`/assets/${encodeURIComponent(id)}/video/playback${QS.query(QS.explode({
@@ -573,6 +608,9 @@ export function playAssetVideo({ id, key, slug }, opts) {
573
608
  ...opts
574
609
  }));
575
610
  }
611
+ /**
612
+ * Register admin
613
+ */
576
614
  export function signUpAdmin({ signUpDto }, opts) {
577
615
  return oazapfts.ok(oazapfts.fetchJson("/auth/admin-sign-up", oazapfts.json({
578
616
  ...opts,
@@ -581,7 +619,7 @@ export function signUpAdmin({ signUpDto }, opts) {
581
619
  })));
582
620
  }
583
621
  /**
584
- * This endpoint requires the `auth.changePassword` permission.
622
+ * Change password
585
623
  */
586
624
  export function changePassword({ changePasswordDto }, opts) {
587
625
  return oazapfts.ok(oazapfts.fetchJson("/auth/change-password", oazapfts.json({
@@ -590,6 +628,9 @@ export function changePassword({ changePasswordDto }, opts) {
590
628
  body: changePasswordDto
591
629
  })));
592
630
  }
631
+ /**
632
+ * Login
633
+ */
593
634
  export function login({ loginCredentialDto }, opts) {
594
635
  return oazapfts.ok(oazapfts.fetchJson("/auth/login", oazapfts.json({
595
636
  ...opts,
@@ -597,6 +638,9 @@ export function login({ loginCredentialDto }, opts) {
597
638
  body: loginCredentialDto
598
639
  })));
599
640
  }
641
+ /**
642
+ * Logout
643
+ */
600
644
  export function logout(opts) {
601
645
  return oazapfts.ok(oazapfts.fetchJson("/auth/logout", {
602
646
  ...opts,
@@ -604,7 +648,7 @@ export function logout(opts) {
604
648
  }));
605
649
  }
606
650
  /**
607
- * This endpoint requires the `pinCode.delete` permission.
651
+ * Reset pin code
608
652
  */
609
653
  export function resetPinCode({ pinCodeResetDto }, opts) {
610
654
  return oazapfts.ok(oazapfts.fetchText("/auth/pin-code", oazapfts.json({
@@ -614,7 +658,7 @@ export function resetPinCode({ pinCodeResetDto }, opts) {
614
658
  })));
615
659
  }
616
660
  /**
617
- * This endpoint requires the `pinCode.create` permission.
661
+ * Setup pin code
618
662
  */
619
663
  export function setupPinCode({ pinCodeSetupDto }, opts) {
620
664
  return oazapfts.ok(oazapfts.fetchText("/auth/pin-code", oazapfts.json({
@@ -624,7 +668,7 @@ export function setupPinCode({ pinCodeSetupDto }, opts) {
624
668
  })));
625
669
  }
626
670
  /**
627
- * This endpoint requires the `pinCode.update` permission.
671
+ * Change pin code
628
672
  */
629
673
  export function changePinCode({ pinCodeChangeDto }, opts) {
630
674
  return oazapfts.ok(oazapfts.fetchText("/auth/pin-code", oazapfts.json({
@@ -633,12 +677,18 @@ export function changePinCode({ pinCodeChangeDto }, opts) {
633
677
  body: pinCodeChangeDto
634
678
  })));
635
679
  }
680
+ /**
681
+ * Lock auth session
682
+ */
636
683
  export function lockAuthSession(opts) {
637
684
  return oazapfts.ok(oazapfts.fetchText("/auth/session/lock", {
638
685
  ...opts,
639
686
  method: "POST"
640
687
  }));
641
688
  }
689
+ /**
690
+ * Unlock auth session
691
+ */
642
692
  export function unlockAuthSession({ sessionUnlockDto }, opts) {
643
693
  return oazapfts.ok(oazapfts.fetchText("/auth/session/unlock", oazapfts.json({
644
694
  ...opts,
@@ -646,11 +696,17 @@ export function unlockAuthSession({ sessionUnlockDto }, opts) {
646
696
  body: sessionUnlockDto
647
697
  })));
648
698
  }
699
+ /**
700
+ * Retrieve auth status
701
+ */
649
702
  export function getAuthStatus(opts) {
650
703
  return oazapfts.ok(oazapfts.fetchJson("/auth/status", {
651
704
  ...opts
652
705
  }));
653
706
  }
707
+ /**
708
+ * Validate access token
709
+ */
654
710
  export function validateAccessToken(opts) {
655
711
  return oazapfts.ok(oazapfts.fetchJson("/auth/validateToken", {
656
712
  ...opts,
@@ -658,7 +714,7 @@ export function validateAccessToken(opts) {
658
714
  }));
659
715
  }
660
716
  /**
661
- * This endpoint requires the `asset.download` permission.
717
+ * Download asset archive
662
718
  */
663
719
  export function downloadArchive({ key, slug, assetIdsDto }, opts) {
664
720
  return oazapfts.ok(oazapfts.fetchBlob(`/download/archive${QS.query(QS.explode({
@@ -671,7 +727,7 @@ export function downloadArchive({ key, slug, assetIdsDto }, opts) {
671
727
  })));
672
728
  }
673
729
  /**
674
- * This endpoint requires the `asset.download` permission.
730
+ * Retrieve download information
675
731
  */
676
732
  export function getDownloadInfo({ key, slug, downloadInfoDto }, opts) {
677
733
  return oazapfts.ok(oazapfts.fetchJson(`/download/info${QS.query(QS.explode({
@@ -684,7 +740,7 @@ export function getDownloadInfo({ key, slug, downloadInfoDto }, opts) {
684
740
  })));
685
741
  }
686
742
  /**
687
- * This endpoint requires the `duplicate.delete` permission.
743
+ * Delete duplicates
688
744
  */
689
745
  export function deleteDuplicates({ bulkIdsDto }, opts) {
690
746
  return oazapfts.ok(oazapfts.fetchText("/duplicates", oazapfts.json({
@@ -694,7 +750,7 @@ export function deleteDuplicates({ bulkIdsDto }, opts) {
694
750
  })));
695
751
  }
696
752
  /**
697
- * This endpoint requires the `duplicate.read` permission.
753
+ * Retrieve duplicates
698
754
  */
699
755
  export function getAssetDuplicates(opts) {
700
756
  return oazapfts.ok(oazapfts.fetchJson("/duplicates", {
@@ -702,7 +758,7 @@ export function getAssetDuplicates(opts) {
702
758
  }));
703
759
  }
704
760
  /**
705
- * This endpoint requires the `duplicate.delete` permission.
761
+ * Delete a duplicate
706
762
  */
707
763
  export function deleteDuplicate({ id }, opts) {
708
764
  return oazapfts.ok(oazapfts.fetchText(`/duplicates/${encodeURIComponent(id)}`, {
@@ -711,7 +767,7 @@ export function deleteDuplicate({ id }, opts) {
711
767
  }));
712
768
  }
713
769
  /**
714
- * This endpoint requires the `face.read` permission.
770
+ * Retrieve faces for asset
715
771
  */
716
772
  export function getFaces({ id }, opts) {
717
773
  return oazapfts.ok(oazapfts.fetchJson(`/faces${QS.query(QS.explode({
@@ -721,7 +777,7 @@ export function getFaces({ id }, opts) {
721
777
  }));
722
778
  }
723
779
  /**
724
- * This endpoint requires the `face.create` permission.
780
+ * Create a face
725
781
  */
726
782
  export function createFace({ assetFaceCreateDto }, opts) {
727
783
  return oazapfts.ok(oazapfts.fetchText("/faces", oazapfts.json({
@@ -731,7 +787,7 @@ export function createFace({ assetFaceCreateDto }, opts) {
731
787
  })));
732
788
  }
733
789
  /**
734
- * This endpoint requires the `face.delete` permission.
790
+ * Delete a face
735
791
  */
736
792
  export function deleteFace({ id, assetFaceDeleteDto }, opts) {
737
793
  return oazapfts.ok(oazapfts.fetchText(`/faces/${encodeURIComponent(id)}`, oazapfts.json({
@@ -741,7 +797,7 @@ export function deleteFace({ id, assetFaceDeleteDto }, opts) {
741
797
  })));
742
798
  }
743
799
  /**
744
- * This endpoint requires the `face.update` permission.
800
+ * Re-assign a face to another person
745
801
  */
746
802
  export function reassignFacesById({ id, faceDto }, opts) {
747
803
  return oazapfts.ok(oazapfts.fetchJson(`/faces/${encodeURIComponent(id)}`, oazapfts.json({
@@ -751,15 +807,15 @@ export function reassignFacesById({ id, faceDto }, opts) {
751
807
  })));
752
808
  }
753
809
  /**
754
- * This endpoint is an admin-only route, and requires the `job.read` permission.
810
+ * Retrieve queue counts and status
755
811
  */
756
- export function getAllJobsStatus(opts) {
812
+ export function getQueuesLegacy(opts) {
757
813
  return oazapfts.ok(oazapfts.fetchJson("/jobs", {
758
814
  ...opts
759
815
  }));
760
816
  }
761
817
  /**
762
- * This endpoint is an admin-only route, and requires the `job.create` permission.
818
+ * Create a manual job
763
819
  */
764
820
  export function createJob({ jobCreateDto }, opts) {
765
821
  return oazapfts.ok(oazapfts.fetchText("/jobs", oazapfts.json({
@@ -769,17 +825,17 @@ export function createJob({ jobCreateDto }, opts) {
769
825
  })));
770
826
  }
771
827
  /**
772
- * This endpoint is an admin-only route, and requires the `job.create` permission.
828
+ * Run jobs
773
829
  */
774
- export function sendJobCommand({ id, jobCommandDto }, opts) {
775
- return oazapfts.ok(oazapfts.fetchJson(`/jobs/${encodeURIComponent(id)}`, oazapfts.json({
830
+ export function runQueueCommandLegacy({ name, queueCommandDto }, opts) {
831
+ return oazapfts.ok(oazapfts.fetchJson(`/jobs/${encodeURIComponent(name)}`, oazapfts.json({
776
832
  ...opts,
777
833
  method: "PUT",
778
- body: jobCommandDto
834
+ body: queueCommandDto
779
835
  })));
780
836
  }
781
837
  /**
782
- * This endpoint is an admin-only route, and requires the `library.read` permission.
838
+ * Retrieve libraries
783
839
  */
784
840
  export function getAllLibraries(opts) {
785
841
  return oazapfts.ok(oazapfts.fetchJson("/libraries", {
@@ -787,7 +843,7 @@ export function getAllLibraries(opts) {
787
843
  }));
788
844
  }
789
845
  /**
790
- * This endpoint is an admin-only route, and requires the `library.create` permission.
846
+ * Create a library
791
847
  */
792
848
  export function createLibrary({ createLibraryDto }, opts) {
793
849
  return oazapfts.ok(oazapfts.fetchJson("/libraries", oazapfts.json({
@@ -797,7 +853,7 @@ export function createLibrary({ createLibraryDto }, opts) {
797
853
  })));
798
854
  }
799
855
  /**
800
- * This endpoint is an admin-only route, and requires the `library.delete` permission.
856
+ * Delete a library
801
857
  */
802
858
  export function deleteLibrary({ id }, opts) {
803
859
  return oazapfts.ok(oazapfts.fetchText(`/libraries/${encodeURIComponent(id)}`, {
@@ -806,7 +862,7 @@ export function deleteLibrary({ id }, opts) {
806
862
  }));
807
863
  }
808
864
  /**
809
- * This endpoint is an admin-only route, and requires the `library.read` permission.
865
+ * Retrieve a library
810
866
  */
811
867
  export function getLibrary({ id }, opts) {
812
868
  return oazapfts.ok(oazapfts.fetchJson(`/libraries/${encodeURIComponent(id)}`, {
@@ -814,7 +870,7 @@ export function getLibrary({ id }, opts) {
814
870
  }));
815
871
  }
816
872
  /**
817
- * This endpoint is an admin-only route, and requires the `library.update` permission.
873
+ * Update a library
818
874
  */
819
875
  export function updateLibrary({ id, updateLibraryDto }, opts) {
820
876
  return oazapfts.ok(oazapfts.fetchJson(`/libraries/${encodeURIComponent(id)}`, oazapfts.json({
@@ -824,7 +880,7 @@ export function updateLibrary({ id, updateLibraryDto }, opts) {
824
880
  })));
825
881
  }
826
882
  /**
827
- * This endpoint is an admin-only route, and requires the `library.update` permission.
883
+ * Scan a library
828
884
  */
829
885
  export function scanLibrary({ id }, opts) {
830
886
  return oazapfts.ok(oazapfts.fetchText(`/libraries/${encodeURIComponent(id)}/scan`, {
@@ -833,13 +889,16 @@ export function scanLibrary({ id }, opts) {
833
889
  }));
834
890
  }
835
891
  /**
836
- * This endpoint is an admin-only route, and requires the `library.statistics` permission.
892
+ * Retrieve library statistics
837
893
  */
838
894
  export function getLibraryStatistics({ id }, opts) {
839
895
  return oazapfts.ok(oazapfts.fetchJson(`/libraries/${encodeURIComponent(id)}/statistics`, {
840
896
  ...opts
841
897
  }));
842
898
  }
899
+ /**
900
+ * Validate library settings
901
+ */
843
902
  export function validate({ id, validateLibraryDto }, opts) {
844
903
  return oazapfts.ok(oazapfts.fetchJson(`/libraries/${encodeURIComponent(id)}/validate`, oazapfts.json({
845
904
  ...opts,
@@ -847,18 +906,24 @@ export function validate({ id, validateLibraryDto }, opts) {
847
906
  body: validateLibraryDto
848
907
  })));
849
908
  }
850
- export function getMapMarkers({ isArchived, isFavorite, fileCreatedAfter, fileCreatedBefore, withPartners, withSharedAlbums }, opts) {
909
+ /**
910
+ * Retrieve map markers
911
+ */
912
+ export function getMapMarkers({ fileCreatedAfter, fileCreatedBefore, isArchived, isFavorite, withPartners, withSharedAlbums }, opts) {
851
913
  return oazapfts.ok(oazapfts.fetchJson(`/map/markers${QS.query(QS.explode({
852
- isArchived,
853
- isFavorite,
854
914
  fileCreatedAfter,
855
915
  fileCreatedBefore,
916
+ isArchived,
917
+ isFavorite,
856
918
  withPartners,
857
919
  withSharedAlbums
858
920
  }))}`, {
859
921
  ...opts
860
922
  }));
861
923
  }
924
+ /**
925
+ * Reverse geocode coordinates
926
+ */
862
927
  export function reverseGeocode({ lat, lon }, opts) {
863
928
  return oazapfts.ok(oazapfts.fetchJson(`/map/reverse-geocode${QS.query(QS.explode({
864
929
  lat,
@@ -868,20 +933,22 @@ export function reverseGeocode({ lat, lon }, opts) {
868
933
  }));
869
934
  }
870
935
  /**
871
- * This endpoint requires the `memory.read` permission.
936
+ * Retrieve memories
872
937
  */
873
- export function searchMemories({ $for, isSaved, isTrashed, $type }, opts) {
938
+ export function searchMemories({ $for, isSaved, isTrashed, order, size, $type }, opts) {
874
939
  return oazapfts.ok(oazapfts.fetchJson(`/memories${QS.query(QS.explode({
875
940
  "for": $for,
876
941
  isSaved,
877
942
  isTrashed,
943
+ order,
944
+ size,
878
945
  "type": $type
879
946
  }))}`, {
880
947
  ...opts
881
948
  }));
882
949
  }
883
950
  /**
884
- * This endpoint requires the `memory.create` permission.
951
+ * Create a memory
885
952
  */
886
953
  export function createMemory({ memoryCreateDto }, opts) {
887
954
  return oazapfts.ok(oazapfts.fetchJson("/memories", oazapfts.json({
@@ -891,20 +958,22 @@ export function createMemory({ memoryCreateDto }, opts) {
891
958
  })));
892
959
  }
893
960
  /**
894
- * This endpoint requires the `memory.statistics` permission.
961
+ * Retrieve memories statistics
895
962
  */
896
- export function memoriesStatistics({ $for, isSaved, isTrashed, $type }, opts) {
963
+ export function memoriesStatistics({ $for, isSaved, isTrashed, order, size, $type }, opts) {
897
964
  return oazapfts.ok(oazapfts.fetchJson(`/memories/statistics${QS.query(QS.explode({
898
965
  "for": $for,
899
966
  isSaved,
900
967
  isTrashed,
968
+ order,
969
+ size,
901
970
  "type": $type
902
971
  }))}`, {
903
972
  ...opts
904
973
  }));
905
974
  }
906
975
  /**
907
- * This endpoint requires the `memory.delete` permission.
976
+ * Delete a memory
908
977
  */
909
978
  export function deleteMemory({ id }, opts) {
910
979
  return oazapfts.ok(oazapfts.fetchText(`/memories/${encodeURIComponent(id)}`, {
@@ -913,7 +982,7 @@ export function deleteMemory({ id }, opts) {
913
982
  }));
914
983
  }
915
984
  /**
916
- * This endpoint requires the `memory.read` permission.
985
+ * Retrieve a memory
917
986
  */
918
987
  export function getMemory({ id }, opts) {
919
988
  return oazapfts.ok(oazapfts.fetchJson(`/memories/${encodeURIComponent(id)}`, {
@@ -921,7 +990,7 @@ export function getMemory({ id }, opts) {
921
990
  }));
922
991
  }
923
992
  /**
924
- * This endpoint requires the `memory.update` permission.
993
+ * Update a memory
925
994
  */
926
995
  export function updateMemory({ id, memoryUpdateDto }, opts) {
927
996
  return oazapfts.ok(oazapfts.fetchJson(`/memories/${encodeURIComponent(id)}`, oazapfts.json({
@@ -931,7 +1000,7 @@ export function updateMemory({ id, memoryUpdateDto }, opts) {
931
1000
  })));
932
1001
  }
933
1002
  /**
934
- * This endpoint requires the `memoryAsset.delete` permission.
1003
+ * Remove assets from a memory
935
1004
  */
936
1005
  export function removeMemoryAssets({ id, bulkIdsDto }, opts) {
937
1006
  return oazapfts.ok(oazapfts.fetchJson(`/memories/${encodeURIComponent(id)}/assets`, oazapfts.json({
@@ -941,7 +1010,7 @@ export function removeMemoryAssets({ id, bulkIdsDto }, opts) {
941
1010
  })));
942
1011
  }
943
1012
  /**
944
- * This endpoint requires the `memoryAsset.create` permission.
1013
+ * Add assets to a memory
945
1014
  */
946
1015
  export function addMemoryAssets({ id, bulkIdsDto }, opts) {
947
1016
  return oazapfts.ok(oazapfts.fetchJson(`/memories/${encodeURIComponent(id)}/assets`, oazapfts.json({
@@ -951,7 +1020,7 @@ export function addMemoryAssets({ id, bulkIdsDto }, opts) {
951
1020
  })));
952
1021
  }
953
1022
  /**
954
- * This endpoint requires the `notification.delete` permission.
1023
+ * Delete notifications
955
1024
  */
956
1025
  export function deleteNotifications({ notificationDeleteAllDto }, opts) {
957
1026
  return oazapfts.ok(oazapfts.fetchText("/notifications", oazapfts.json({
@@ -961,7 +1030,7 @@ export function deleteNotifications({ notificationDeleteAllDto }, opts) {
961
1030
  })));
962
1031
  }
963
1032
  /**
964
- * This endpoint requires the `notification.read` permission.
1033
+ * Retrieve notifications
965
1034
  */
966
1035
  export function getNotifications({ id, level, $type, unread }, opts) {
967
1036
  return oazapfts.ok(oazapfts.fetchJson(`/notifications${QS.query(QS.explode({
@@ -974,7 +1043,7 @@ export function getNotifications({ id, level, $type, unread }, opts) {
974
1043
  }));
975
1044
  }
976
1045
  /**
977
- * This endpoint requires the `notification.update` permission.
1046
+ * Update notifications
978
1047
  */
979
1048
  export function updateNotifications({ notificationUpdateAllDto }, opts) {
980
1049
  return oazapfts.ok(oazapfts.fetchText("/notifications", oazapfts.json({
@@ -984,7 +1053,7 @@ export function updateNotifications({ notificationUpdateAllDto }, opts) {
984
1053
  })));
985
1054
  }
986
1055
  /**
987
- * This endpoint requires the `notification.delete` permission.
1056
+ * Delete a notification
988
1057
  */
989
1058
  export function deleteNotification({ id }, opts) {
990
1059
  return oazapfts.ok(oazapfts.fetchText(`/notifications/${encodeURIComponent(id)}`, {
@@ -993,7 +1062,7 @@ export function deleteNotification({ id }, opts) {
993
1062
  }));
994
1063
  }
995
1064
  /**
996
- * This endpoint requires the `notification.read` permission.
1065
+ * Get a notification
997
1066
  */
998
1067
  export function getNotification({ id }, opts) {
999
1068
  return oazapfts.ok(oazapfts.fetchJson(`/notifications/${encodeURIComponent(id)}`, {
@@ -1001,7 +1070,7 @@ export function getNotification({ id }, opts) {
1001
1070
  }));
1002
1071
  }
1003
1072
  /**
1004
- * This endpoint requires the `notification.update` permission.
1073
+ * Update a notification
1005
1074
  */
1006
1075
  export function updateNotification({ id, notificationUpdateDto }, opts) {
1007
1076
  return oazapfts.ok(oazapfts.fetchJson(`/notifications/${encodeURIComponent(id)}`, oazapfts.json({
@@ -1010,6 +1079,9 @@ export function updateNotification({ id, notificationUpdateDto }, opts) {
1010
1079
  body: notificationUpdateDto
1011
1080
  })));
1012
1081
  }
1082
+ /**
1083
+ * Start OAuth
1084
+ */
1013
1085
  export function startOAuth({ oAuthConfigDto }, opts) {
1014
1086
  return oazapfts.ok(oazapfts.fetchJson("/oauth/authorize", oazapfts.json({
1015
1087
  ...opts,
@@ -1017,6 +1089,9 @@ export function startOAuth({ oAuthConfigDto }, opts) {
1017
1089
  body: oAuthConfigDto
1018
1090
  })));
1019
1091
  }
1092
+ /**
1093
+ * Finish OAuth
1094
+ */
1020
1095
  export function finishOAuth({ oAuthCallbackDto }, opts) {
1021
1096
  return oazapfts.ok(oazapfts.fetchJson("/oauth/callback", oazapfts.json({
1022
1097
  ...opts,
@@ -1024,6 +1099,9 @@ export function finishOAuth({ oAuthCallbackDto }, opts) {
1024
1099
  body: oAuthCallbackDto
1025
1100
  })));
1026
1101
  }
1102
+ /**
1103
+ * Link OAuth account
1104
+ */
1027
1105
  export function linkOAuthAccount({ oAuthCallbackDto }, opts) {
1028
1106
  return oazapfts.ok(oazapfts.fetchJson("/oauth/link", oazapfts.json({
1029
1107
  ...opts,
@@ -1031,11 +1109,17 @@ export function linkOAuthAccount({ oAuthCallbackDto }, opts) {
1031
1109
  body: oAuthCallbackDto
1032
1110
  })));
1033
1111
  }
1112
+ /**
1113
+ * Redirect OAuth to mobile
1114
+ */
1034
1115
  export function redirectOAuthToMobile(opts) {
1035
1116
  return oazapfts.ok(oazapfts.fetchText("/oauth/mobile-redirect", {
1036
1117
  ...opts
1037
1118
  }));
1038
1119
  }
1120
+ /**
1121
+ * Unlink OAuth account
1122
+ */
1039
1123
  export function unlinkOAuthAccount(opts) {
1040
1124
  return oazapfts.ok(oazapfts.fetchJson("/oauth/unlink", {
1041
1125
  ...opts,
@@ -1043,7 +1127,7 @@ export function unlinkOAuthAccount(opts) {
1043
1127
  }));
1044
1128
  }
1045
1129
  /**
1046
- * This endpoint requires the `partner.read` permission.
1130
+ * Retrieve partners
1047
1131
  */
1048
1132
  export function getPartners({ direction }, opts) {
1049
1133
  return oazapfts.ok(oazapfts.fetchJson(`/partners${QS.query(QS.explode({
@@ -1053,7 +1137,7 @@ export function getPartners({ direction }, opts) {
1053
1137
  }));
1054
1138
  }
1055
1139
  /**
1056
- * This endpoint requires the `partner.create` permission.
1140
+ * Create a partner
1057
1141
  */
1058
1142
  export function createPartner({ partnerCreateDto }, opts) {
1059
1143
  return oazapfts.ok(oazapfts.fetchJson("/partners", oazapfts.json({
@@ -1063,7 +1147,7 @@ export function createPartner({ partnerCreateDto }, opts) {
1063
1147
  })));
1064
1148
  }
1065
1149
  /**
1066
- * This endpoint requires the `partner.delete` permission.
1150
+ * Remove a partner
1067
1151
  */
1068
1152
  export function removePartner({ id }, opts) {
1069
1153
  return oazapfts.ok(oazapfts.fetchText(`/partners/${encodeURIComponent(id)}`, {
@@ -1072,7 +1156,7 @@ export function removePartner({ id }, opts) {
1072
1156
  }));
1073
1157
  }
1074
1158
  /**
1075
- * This property was deprecated in v1.141.0. This endpoint requires the `partner.create` permission.
1159
+ * Create a partner
1076
1160
  */
1077
1161
  export function createPartnerDeprecated({ id }, opts) {
1078
1162
  return oazapfts.ok(oazapfts.fetchJson(`/partners/${encodeURIComponent(id)}`, {
@@ -1081,7 +1165,7 @@ export function createPartnerDeprecated({ id }, opts) {
1081
1165
  }));
1082
1166
  }
1083
1167
  /**
1084
- * This endpoint requires the `partner.update` permission.
1168
+ * Update a partner
1085
1169
  */
1086
1170
  export function updatePartner({ id, partnerUpdateDto }, opts) {
1087
1171
  return oazapfts.ok(oazapfts.fetchJson(`/partners/${encodeURIComponent(id)}`, oazapfts.json({
@@ -1091,7 +1175,7 @@ export function updatePartner({ id, partnerUpdateDto }, opts) {
1091
1175
  })));
1092
1176
  }
1093
1177
  /**
1094
- * This endpoint requires the `person.delete` permission.
1178
+ * Delete people
1095
1179
  */
1096
1180
  export function deletePeople({ bulkIdsDto }, opts) {
1097
1181
  return oazapfts.ok(oazapfts.fetchText("/people", oazapfts.json({
@@ -1101,7 +1185,7 @@ export function deletePeople({ bulkIdsDto }, opts) {
1101
1185
  })));
1102
1186
  }
1103
1187
  /**
1104
- * This endpoint requires the `person.read` permission.
1188
+ * Get all people
1105
1189
  */
1106
1190
  export function getAllPeople({ closestAssetId, closestPersonId, page, size, withHidden }, opts) {
1107
1191
  return oazapfts.ok(oazapfts.fetchJson(`/people${QS.query(QS.explode({
@@ -1115,7 +1199,7 @@ export function getAllPeople({ closestAssetId, closestPersonId, page, size, with
1115
1199
  }));
1116
1200
  }
1117
1201
  /**
1118
- * This endpoint requires the `person.create` permission.
1202
+ * Create a person
1119
1203
  */
1120
1204
  export function createPerson({ personCreateDto }, opts) {
1121
1205
  return oazapfts.ok(oazapfts.fetchJson("/people", oazapfts.json({
@@ -1125,7 +1209,7 @@ export function createPerson({ personCreateDto }, opts) {
1125
1209
  })));
1126
1210
  }
1127
1211
  /**
1128
- * This endpoint requires the `person.update` permission.
1212
+ * Update people
1129
1213
  */
1130
1214
  export function updatePeople({ peopleUpdateDto }, opts) {
1131
1215
  return oazapfts.ok(oazapfts.fetchJson("/people", oazapfts.json({
@@ -1135,7 +1219,7 @@ export function updatePeople({ peopleUpdateDto }, opts) {
1135
1219
  })));
1136
1220
  }
1137
1221
  /**
1138
- * This endpoint requires the `person.delete` permission.
1222
+ * Delete person
1139
1223
  */
1140
1224
  export function deletePerson({ id }, opts) {
1141
1225
  return oazapfts.ok(oazapfts.fetchText(`/people/${encodeURIComponent(id)}`, {
@@ -1144,7 +1228,7 @@ export function deletePerson({ id }, opts) {
1144
1228
  }));
1145
1229
  }
1146
1230
  /**
1147
- * This endpoint requires the `person.read` permission.
1231
+ * Get a person
1148
1232
  */
1149
1233
  export function getPerson({ id }, opts) {
1150
1234
  return oazapfts.ok(oazapfts.fetchJson(`/people/${encodeURIComponent(id)}`, {
@@ -1152,7 +1236,7 @@ export function getPerson({ id }, opts) {
1152
1236
  }));
1153
1237
  }
1154
1238
  /**
1155
- * This endpoint requires the `person.update` permission.
1239
+ * Update person
1156
1240
  */
1157
1241
  export function updatePerson({ id, personUpdateDto }, opts) {
1158
1242
  return oazapfts.ok(oazapfts.fetchJson(`/people/${encodeURIComponent(id)}`, oazapfts.json({
@@ -1162,7 +1246,7 @@ export function updatePerson({ id, personUpdateDto }, opts) {
1162
1246
  })));
1163
1247
  }
1164
1248
  /**
1165
- * This endpoint requires the `person.merge` permission.
1249
+ * Merge people
1166
1250
  */
1167
1251
  export function mergePerson({ id, mergePersonDto }, opts) {
1168
1252
  return oazapfts.ok(oazapfts.fetchJson(`/people/${encodeURIComponent(id)}/merge`, oazapfts.json({
@@ -1172,7 +1256,7 @@ export function mergePerson({ id, mergePersonDto }, opts) {
1172
1256
  })));
1173
1257
  }
1174
1258
  /**
1175
- * This endpoint requires the `person.reassign` permission.
1259
+ * Reassign faces
1176
1260
  */
1177
1261
  export function reassignFaces({ id, assetFaceUpdateDto }, opts) {
1178
1262
  return oazapfts.ok(oazapfts.fetchJson(`/people/${encodeURIComponent(id)}/reassign`, oazapfts.json({
@@ -1182,7 +1266,7 @@ export function reassignFaces({ id, assetFaceUpdateDto }, opts) {
1182
1266
  })));
1183
1267
  }
1184
1268
  /**
1185
- * This endpoint requires the `person.statistics` permission.
1269
+ * Get person statistics
1186
1270
  */
1187
1271
  export function getPersonStatistics({ id }, opts) {
1188
1272
  return oazapfts.ok(oazapfts.fetchJson(`/people/${encodeURIComponent(id)}/statistics`, {
@@ -1190,7 +1274,7 @@ export function getPersonStatistics({ id }, opts) {
1190
1274
  }));
1191
1275
  }
1192
1276
  /**
1193
- * This endpoint requires the `person.read` permission.
1277
+ * Get person thumbnail
1194
1278
  */
1195
1279
  export function getPersonThumbnail({ id }, opts) {
1196
1280
  return oazapfts.ok(oazapfts.fetchBlob(`/people/${encodeURIComponent(id)}/thumbnail`, {
@@ -1198,7 +1282,23 @@ export function getPersonThumbnail({ id }, opts) {
1198
1282
  }));
1199
1283
  }
1200
1284
  /**
1201
- * This endpoint requires the `asset.read` permission.
1285
+ * List all plugins
1286
+ */
1287
+ export function getPlugins(opts) {
1288
+ return oazapfts.ok(oazapfts.fetchJson("/plugins", {
1289
+ ...opts
1290
+ }));
1291
+ }
1292
+ /**
1293
+ * Retrieve a plugin
1294
+ */
1295
+ export function getPlugin({ id }, opts) {
1296
+ return oazapfts.ok(oazapfts.fetchJson(`/plugins/${encodeURIComponent(id)}`, {
1297
+ ...opts
1298
+ }));
1299
+ }
1300
+ /**
1301
+ * Retrieve assets by city
1202
1302
  */
1203
1303
  export function getAssetsByCity(opts) {
1204
1304
  return oazapfts.ok(oazapfts.fetchJson("/search/cities", {
@@ -1206,7 +1306,7 @@ export function getAssetsByCity(opts) {
1206
1306
  }));
1207
1307
  }
1208
1308
  /**
1209
- * This endpoint requires the `asset.read` permission.
1309
+ * Retrieve explore data
1210
1310
  */
1211
1311
  export function getExploreData(opts) {
1212
1312
  return oazapfts.ok(oazapfts.fetchJson("/search/explore", {
@@ -1214,7 +1314,7 @@ export function getExploreData(opts) {
1214
1314
  }));
1215
1315
  }
1216
1316
  /**
1217
- * This endpoint requires the `asset.read` permission.
1317
+ * Search large assets
1218
1318
  */
1219
1319
  export function searchLargeAssets({ albumIds, city, country, createdAfter, createdBefore, deviceId, isEncoded, isFavorite, isMotion, isNotInAlbum, isOffline, lensModel, libraryId, make, minFileSize, model, ocr, personIds, rating, size, state, tagIds, takenAfter, takenBefore, trashedAfter, trashedBefore, $type, updatedAfter, updatedBefore, visibility, withDeleted, withExif }, opts) {
1220
1320
  return oazapfts.ok(oazapfts.fetchJson(`/search/large-assets${QS.query(QS.explode({
@@ -1256,7 +1356,7 @@ export function searchLargeAssets({ albumIds, city, country, createdAfter, creat
1256
1356
  }));
1257
1357
  }
1258
1358
  /**
1259
- * This endpoint requires the `asset.read` permission.
1359
+ * Search assets by metadata
1260
1360
  */
1261
1361
  export function searchAssets({ metadataSearchDto }, opts) {
1262
1362
  return oazapfts.ok(oazapfts.fetchJson("/search/metadata", oazapfts.json({
@@ -1266,7 +1366,7 @@ export function searchAssets({ metadataSearchDto }, opts) {
1266
1366
  })));
1267
1367
  }
1268
1368
  /**
1269
- * This endpoint requires the `person.read` permission.
1369
+ * Search people
1270
1370
  */
1271
1371
  export function searchPerson({ name, withHidden }, opts) {
1272
1372
  return oazapfts.ok(oazapfts.fetchJson(`/search/person${QS.query(QS.explode({
@@ -1277,7 +1377,7 @@ export function searchPerson({ name, withHidden }, opts) {
1277
1377
  }));
1278
1378
  }
1279
1379
  /**
1280
- * This endpoint requires the `asset.read` permission.
1380
+ * Search places
1281
1381
  */
1282
1382
  export function searchPlaces({ name }, opts) {
1283
1383
  return oazapfts.ok(oazapfts.fetchJson(`/search/places${QS.query(QS.explode({
@@ -1287,7 +1387,7 @@ export function searchPlaces({ name }, opts) {
1287
1387
  }));
1288
1388
  }
1289
1389
  /**
1290
- * This endpoint requires the `asset.read` permission.
1390
+ * Search random assets
1291
1391
  */
1292
1392
  export function searchRandom({ randomSearchDto }, opts) {
1293
1393
  return oazapfts.ok(oazapfts.fetchJson("/search/random", oazapfts.json({
@@ -1297,7 +1397,7 @@ export function searchRandom({ randomSearchDto }, opts) {
1297
1397
  })));
1298
1398
  }
1299
1399
  /**
1300
- * This endpoint requires the `asset.read` permission.
1400
+ * Smart asset search
1301
1401
  */
1302
1402
  export function searchSmart({ smartSearchDto }, opts) {
1303
1403
  return oazapfts.ok(oazapfts.fetchJson("/search/smart", oazapfts.json({
@@ -1307,7 +1407,7 @@ export function searchSmart({ smartSearchDto }, opts) {
1307
1407
  })));
1308
1408
  }
1309
1409
  /**
1310
- * This endpoint requires the `asset.statistics` permission.
1410
+ * Search asset statistics
1311
1411
  */
1312
1412
  export function searchAssetStatistics({ statisticsSearchDto }, opts) {
1313
1413
  return oazapfts.ok(oazapfts.fetchJson("/search/statistics", oazapfts.json({
@@ -1317,7 +1417,7 @@ export function searchAssetStatistics({ statisticsSearchDto }, opts) {
1317
1417
  })));
1318
1418
  }
1319
1419
  /**
1320
- * This endpoint requires the `asset.read` permission.
1420
+ * Retrieve search suggestions
1321
1421
  */
1322
1422
  export function getSearchSuggestions({ country, includeNull, lensModel, make, model, state, $type }, opts) {
1323
1423
  return oazapfts.ok(oazapfts.fetchJson(`/search/suggestions${QS.query(QS.explode({
@@ -1333,7 +1433,7 @@ export function getSearchSuggestions({ country, includeNull, lensModel, make, mo
1333
1433
  }));
1334
1434
  }
1335
1435
  /**
1336
- * This endpoint requires the `server.about` permission.
1436
+ * Get server information
1337
1437
  */
1338
1438
  export function getAboutInfo(opts) {
1339
1439
  return oazapfts.ok(oazapfts.fetchJson("/server/about", {
@@ -1341,25 +1441,31 @@ export function getAboutInfo(opts) {
1341
1441
  }));
1342
1442
  }
1343
1443
  /**
1344
- * This endpoint requires the `server.apkLinks` permission.
1444
+ * Get APK links
1345
1445
  */
1346
1446
  export function getApkLinks(opts) {
1347
1447
  return oazapfts.ok(oazapfts.fetchJson("/server/apk-links", {
1348
1448
  ...opts
1349
1449
  }));
1350
1450
  }
1451
+ /**
1452
+ * Get config
1453
+ */
1351
1454
  export function getServerConfig(opts) {
1352
1455
  return oazapfts.ok(oazapfts.fetchJson("/server/config", {
1353
1456
  ...opts
1354
1457
  }));
1355
1458
  }
1459
+ /**
1460
+ * Get features
1461
+ */
1356
1462
  export function getServerFeatures(opts) {
1357
1463
  return oazapfts.ok(oazapfts.fetchJson("/server/features", {
1358
1464
  ...opts
1359
1465
  }));
1360
1466
  }
1361
1467
  /**
1362
- * This endpoint is an admin-only route, and requires the `serverLicense.delete` permission.
1468
+ * Delete server product key
1363
1469
  */
1364
1470
  export function deleteServerLicense(opts) {
1365
1471
  return oazapfts.ok(oazapfts.fetchText("/server/license", {
@@ -1368,7 +1474,7 @@ export function deleteServerLicense(opts) {
1368
1474
  }));
1369
1475
  }
1370
1476
  /**
1371
- * This endpoint is an admin-only route, and requires the `serverLicense.read` permission.
1477
+ * Get product key
1372
1478
  */
1373
1479
  export function getServerLicense(opts) {
1374
1480
  return oazapfts.ok(oazapfts.fetchJson("/server/license", {
@@ -1376,7 +1482,7 @@ export function getServerLicense(opts) {
1376
1482
  }));
1377
1483
  }
1378
1484
  /**
1379
- * This endpoint is an admin-only route, and requires the `serverLicense.update` permission.
1485
+ * Set server product key
1380
1486
  */
1381
1487
  export function setServerLicense({ licenseKeyDto }, opts) {
1382
1488
  return oazapfts.ok(oazapfts.fetchJson("/server/license", oazapfts.json({
@@ -1385,18 +1491,24 @@ export function setServerLicense({ licenseKeyDto }, opts) {
1385
1491
  body: licenseKeyDto
1386
1492
  })));
1387
1493
  }
1494
+ /**
1495
+ * Get supported media types
1496
+ */
1388
1497
  export function getSupportedMediaTypes(opts) {
1389
1498
  return oazapfts.ok(oazapfts.fetchJson("/server/media-types", {
1390
1499
  ...opts
1391
1500
  }));
1392
1501
  }
1502
+ /**
1503
+ * Ping
1504
+ */
1393
1505
  export function pingServer(opts) {
1394
1506
  return oazapfts.ok(oazapfts.fetchJson("/server/ping", {
1395
1507
  ...opts
1396
1508
  }));
1397
1509
  }
1398
1510
  /**
1399
- * This endpoint is an admin-only route, and requires the `server.statistics` permission.
1511
+ * Get statistics
1400
1512
  */
1401
1513
  export function getServerStatistics(opts) {
1402
1514
  return oazapfts.ok(oazapfts.fetchJson("/server/statistics", {
@@ -1404,38 +1516,47 @@ export function getServerStatistics(opts) {
1404
1516
  }));
1405
1517
  }
1406
1518
  /**
1407
- * This endpoint requires the `server.storage` permission.
1519
+ * Get storage
1408
1520
  */
1409
1521
  export function getStorage(opts) {
1410
1522
  return oazapfts.ok(oazapfts.fetchJson("/server/storage", {
1411
1523
  ...opts
1412
1524
  }));
1413
1525
  }
1526
+ /**
1527
+ * Get theme
1528
+ */
1414
1529
  export function getTheme(opts) {
1415
1530
  return oazapfts.ok(oazapfts.fetchJson("/server/theme", {
1416
1531
  ...opts
1417
1532
  }));
1418
1533
  }
1534
+ /**
1535
+ * Get server version
1536
+ */
1419
1537
  export function getServerVersion(opts) {
1420
1538
  return oazapfts.ok(oazapfts.fetchJson("/server/version", {
1421
1539
  ...opts
1422
1540
  }));
1423
1541
  }
1424
1542
  /**
1425
- * This endpoint requires the `server.versionCheck` permission.
1543
+ * Get version check status
1426
1544
  */
1427
1545
  export function getVersionCheck(opts) {
1428
1546
  return oazapfts.ok(oazapfts.fetchJson("/server/version-check", {
1429
1547
  ...opts
1430
1548
  }));
1431
1549
  }
1550
+ /**
1551
+ * Get version history
1552
+ */
1432
1553
  export function getVersionHistory(opts) {
1433
1554
  return oazapfts.ok(oazapfts.fetchJson("/server/version-history", {
1434
1555
  ...opts
1435
1556
  }));
1436
1557
  }
1437
1558
  /**
1438
- * This endpoint requires the `session.delete` permission.
1559
+ * Delete all sessions
1439
1560
  */
1440
1561
  export function deleteAllSessions(opts) {
1441
1562
  return oazapfts.ok(oazapfts.fetchText("/sessions", {
@@ -1444,7 +1565,7 @@ export function deleteAllSessions(opts) {
1444
1565
  }));
1445
1566
  }
1446
1567
  /**
1447
- * This endpoint requires the `session.read` permission.
1568
+ * Retrieve sessions
1448
1569
  */
1449
1570
  export function getSessions(opts) {
1450
1571
  return oazapfts.ok(oazapfts.fetchJson("/sessions", {
@@ -1452,7 +1573,7 @@ export function getSessions(opts) {
1452
1573
  }));
1453
1574
  }
1454
1575
  /**
1455
- * This endpoint requires the `session.create` permission.
1576
+ * Create a session
1456
1577
  */
1457
1578
  export function createSession({ sessionCreateDto }, opts) {
1458
1579
  return oazapfts.ok(oazapfts.fetchJson("/sessions", oazapfts.json({
@@ -1462,7 +1583,7 @@ export function createSession({ sessionCreateDto }, opts) {
1462
1583
  })));
1463
1584
  }
1464
1585
  /**
1465
- * This endpoint requires the `session.delete` permission.
1586
+ * Delete a session
1466
1587
  */
1467
1588
  export function deleteSession({ id }, opts) {
1468
1589
  return oazapfts.ok(oazapfts.fetchText(`/sessions/${encodeURIComponent(id)}`, {
@@ -1471,7 +1592,7 @@ export function deleteSession({ id }, opts) {
1471
1592
  }));
1472
1593
  }
1473
1594
  /**
1474
- * This endpoint requires the `session.update` permission.
1595
+ * Update a session
1475
1596
  */
1476
1597
  export function updateSession({ id, sessionUpdateDto }, opts) {
1477
1598
  return oazapfts.ok(oazapfts.fetchJson(`/sessions/${encodeURIComponent(id)}`, oazapfts.json({
@@ -1481,7 +1602,7 @@ export function updateSession({ id, sessionUpdateDto }, opts) {
1481
1602
  })));
1482
1603
  }
1483
1604
  /**
1484
- * This endpoint requires the `session.lock` permission.
1605
+ * Lock a session
1485
1606
  */
1486
1607
  export function lockSession({ id }, opts) {
1487
1608
  return oazapfts.ok(oazapfts.fetchText(`/sessions/${encodeURIComponent(id)}/lock`, {
@@ -1490,7 +1611,7 @@ export function lockSession({ id }, opts) {
1490
1611
  }));
1491
1612
  }
1492
1613
  /**
1493
- * This endpoint requires the `sharedLink.read` permission.
1614
+ * Retrieve all shared links
1494
1615
  */
1495
1616
  export function getAllSharedLinks({ albumId }, opts) {
1496
1617
  return oazapfts.ok(oazapfts.fetchJson(`/shared-links${QS.query(QS.explode({
@@ -1500,7 +1621,7 @@ export function getAllSharedLinks({ albumId }, opts) {
1500
1621
  }));
1501
1622
  }
1502
1623
  /**
1503
- * This endpoint requires the `sharedLink.create` permission.
1624
+ * Create a shared link
1504
1625
  */
1505
1626
  export function createSharedLink({ sharedLinkCreateDto }, opts) {
1506
1627
  return oazapfts.ok(oazapfts.fetchJson("/shared-links", oazapfts.json({
@@ -1509,18 +1630,21 @@ export function createSharedLink({ sharedLinkCreateDto }, opts) {
1509
1630
  body: sharedLinkCreateDto
1510
1631
  })));
1511
1632
  }
1512
- export function getMySharedLink({ password, token, key, slug }, opts) {
1633
+ /**
1634
+ * Retrieve current shared link
1635
+ */
1636
+ export function getMySharedLink({ key, password, slug, token }, opts) {
1513
1637
  return oazapfts.ok(oazapfts.fetchJson(`/shared-links/me${QS.query(QS.explode({
1514
- password,
1515
- token,
1516
1638
  key,
1517
- slug
1639
+ password,
1640
+ slug,
1641
+ token
1518
1642
  }))}`, {
1519
1643
  ...opts
1520
1644
  }));
1521
1645
  }
1522
1646
  /**
1523
- * This endpoint requires the `sharedLink.delete` permission.
1647
+ * Delete a shared link
1524
1648
  */
1525
1649
  export function removeSharedLink({ id }, opts) {
1526
1650
  return oazapfts.ok(oazapfts.fetchText(`/shared-links/${encodeURIComponent(id)}`, {
@@ -1529,7 +1653,7 @@ export function removeSharedLink({ id }, opts) {
1529
1653
  }));
1530
1654
  }
1531
1655
  /**
1532
- * This endpoint requires the `sharedLink.read` permission.
1656
+ * Retrieve a shared link
1533
1657
  */
1534
1658
  export function getSharedLinkById({ id }, opts) {
1535
1659
  return oazapfts.ok(oazapfts.fetchJson(`/shared-links/${encodeURIComponent(id)}`, {
@@ -1537,7 +1661,7 @@ export function getSharedLinkById({ id }, opts) {
1537
1661
  }));
1538
1662
  }
1539
1663
  /**
1540
- * This endpoint requires the `sharedLink.update` permission.
1664
+ * Update a shared link
1541
1665
  */
1542
1666
  export function updateSharedLink({ id, sharedLinkEditDto }, opts) {
1543
1667
  return oazapfts.ok(oazapfts.fetchJson(`/shared-links/${encodeURIComponent(id)}`, oazapfts.json({
@@ -1546,6 +1670,9 @@ export function updateSharedLink({ id, sharedLinkEditDto }, opts) {
1546
1670
  body: sharedLinkEditDto
1547
1671
  })));
1548
1672
  }
1673
+ /**
1674
+ * Remove assets from a shared link
1675
+ */
1549
1676
  export function removeSharedLinkAssets({ id, key, slug, assetIdsDto }, opts) {
1550
1677
  return oazapfts.ok(oazapfts.fetchJson(`/shared-links/${encodeURIComponent(id)}/assets${QS.query(QS.explode({
1551
1678
  key,
@@ -1556,6 +1683,9 @@ export function removeSharedLinkAssets({ id, key, slug, assetIdsDto }, opts) {
1556
1683
  body: assetIdsDto
1557
1684
  })));
1558
1685
  }
1686
+ /**
1687
+ * Add assets to a shared link
1688
+ */
1559
1689
  export function addSharedLinkAssets({ id, key, slug, assetIdsDto }, opts) {
1560
1690
  return oazapfts.ok(oazapfts.fetchJson(`/shared-links/${encodeURIComponent(id)}/assets${QS.query(QS.explode({
1561
1691
  key,
@@ -1567,7 +1697,7 @@ export function addSharedLinkAssets({ id, key, slug, assetIdsDto }, opts) {
1567
1697
  })));
1568
1698
  }
1569
1699
  /**
1570
- * This endpoint requires the `stack.delete` permission.
1700
+ * Delete stacks
1571
1701
  */
1572
1702
  export function deleteStacks({ bulkIdsDto }, opts) {
1573
1703
  return oazapfts.ok(oazapfts.fetchText("/stacks", oazapfts.json({
@@ -1577,7 +1707,7 @@ export function deleteStacks({ bulkIdsDto }, opts) {
1577
1707
  })));
1578
1708
  }
1579
1709
  /**
1580
- * This endpoint requires the `stack.read` permission.
1710
+ * Retrieve stacks
1581
1711
  */
1582
1712
  export function searchStacks({ primaryAssetId }, opts) {
1583
1713
  return oazapfts.ok(oazapfts.fetchJson(`/stacks${QS.query(QS.explode({
@@ -1587,7 +1717,7 @@ export function searchStacks({ primaryAssetId }, opts) {
1587
1717
  }));
1588
1718
  }
1589
1719
  /**
1590
- * This endpoint requires the `stack.create` permission.
1720
+ * Create a stack
1591
1721
  */
1592
1722
  export function createStack({ stackCreateDto }, opts) {
1593
1723
  return oazapfts.ok(oazapfts.fetchJson("/stacks", oazapfts.json({
@@ -1597,7 +1727,7 @@ export function createStack({ stackCreateDto }, opts) {
1597
1727
  })));
1598
1728
  }
1599
1729
  /**
1600
- * This endpoint requires the `stack.delete` permission.
1730
+ * Delete a stack
1601
1731
  */
1602
1732
  export function deleteStack({ id }, opts) {
1603
1733
  return oazapfts.ok(oazapfts.fetchText(`/stacks/${encodeURIComponent(id)}`, {
@@ -1606,7 +1736,7 @@ export function deleteStack({ id }, opts) {
1606
1736
  }));
1607
1737
  }
1608
1738
  /**
1609
- * This endpoint requires the `stack.read` permission.
1739
+ * Retrieve a stack
1610
1740
  */
1611
1741
  export function getStack({ id }, opts) {
1612
1742
  return oazapfts.ok(oazapfts.fetchJson(`/stacks/${encodeURIComponent(id)}`, {
@@ -1614,7 +1744,7 @@ export function getStack({ id }, opts) {
1614
1744
  }));
1615
1745
  }
1616
1746
  /**
1617
- * This endpoint requires the `stack.update` permission.
1747
+ * Update a stack
1618
1748
  */
1619
1749
  export function updateStack({ id, stackUpdateDto }, opts) {
1620
1750
  return oazapfts.ok(oazapfts.fetchJson(`/stacks/${encodeURIComponent(id)}`, oazapfts.json({
@@ -1624,7 +1754,7 @@ export function updateStack({ id, stackUpdateDto }, opts) {
1624
1754
  })));
1625
1755
  }
1626
1756
  /**
1627
- * This endpoint requires the `stack.update` permission.
1757
+ * Remove an asset from a stack
1628
1758
  */
1629
1759
  export function removeAssetFromStack({ assetId, id }, opts) {
1630
1760
  return oazapfts.ok(oazapfts.fetchText(`/stacks/${encodeURIComponent(id)}/assets/${encodeURIComponent(assetId)}`, {
@@ -1633,7 +1763,7 @@ export function removeAssetFromStack({ assetId, id }, opts) {
1633
1763
  }));
1634
1764
  }
1635
1765
  /**
1636
- * This endpoint requires the `syncCheckpoint.delete` permission.
1766
+ * Delete acknowledgements
1637
1767
  */
1638
1768
  export function deleteSyncAck({ syncAckDeleteDto }, opts) {
1639
1769
  return oazapfts.ok(oazapfts.fetchText("/sync/ack", oazapfts.json({
@@ -1643,7 +1773,7 @@ export function deleteSyncAck({ syncAckDeleteDto }, opts) {
1643
1773
  })));
1644
1774
  }
1645
1775
  /**
1646
- * This endpoint requires the `syncCheckpoint.read` permission.
1776
+ * Retrieve acknowledgements
1647
1777
  */
1648
1778
  export function getSyncAck(opts) {
1649
1779
  return oazapfts.ok(oazapfts.fetchJson("/sync/ack", {
@@ -1651,7 +1781,7 @@ export function getSyncAck(opts) {
1651
1781
  }));
1652
1782
  }
1653
1783
  /**
1654
- * This endpoint requires the `syncCheckpoint.update` permission.
1784
+ * Acknowledge changes
1655
1785
  */
1656
1786
  export function sendSyncAck({ syncAckSetDto }, opts) {
1657
1787
  return oazapfts.ok(oazapfts.fetchText("/sync/ack", oazapfts.json({
@@ -1660,6 +1790,9 @@ export function sendSyncAck({ syncAckSetDto }, opts) {
1660
1790
  body: syncAckSetDto
1661
1791
  })));
1662
1792
  }
1793
+ /**
1794
+ * Get delta sync for user
1795
+ */
1663
1796
  export function getDeltaSync({ assetDeltaSyncDto }, opts) {
1664
1797
  return oazapfts.ok(oazapfts.fetchJson("/sync/delta-sync", oazapfts.json({
1665
1798
  ...opts,
@@ -1667,6 +1800,9 @@ export function getDeltaSync({ assetDeltaSyncDto }, opts) {
1667
1800
  body: assetDeltaSyncDto
1668
1801
  })));
1669
1802
  }
1803
+ /**
1804
+ * Get full sync for user
1805
+ */
1670
1806
  export function getFullSyncForUser({ assetFullSyncDto }, opts) {
1671
1807
  return oazapfts.ok(oazapfts.fetchJson("/sync/full-sync", oazapfts.json({
1672
1808
  ...opts,
@@ -1675,7 +1811,7 @@ export function getFullSyncForUser({ assetFullSyncDto }, opts) {
1675
1811
  })));
1676
1812
  }
1677
1813
  /**
1678
- * This endpoint requires the `sync.stream` permission.
1814
+ * Stream sync changes
1679
1815
  */
1680
1816
  export function getSyncStream({ syncStreamDto }, opts) {
1681
1817
  return oazapfts.ok(oazapfts.fetchText("/sync/stream", oazapfts.json({
@@ -1685,7 +1821,7 @@ export function getSyncStream({ syncStreamDto }, opts) {
1685
1821
  })));
1686
1822
  }
1687
1823
  /**
1688
- * This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
1824
+ * Get system configuration
1689
1825
  */
1690
1826
  export function getConfig(opts) {
1691
1827
  return oazapfts.ok(oazapfts.fetchJson("/system-config", {
@@ -1693,7 +1829,7 @@ export function getConfig(opts) {
1693
1829
  }));
1694
1830
  }
1695
1831
  /**
1696
- * This endpoint is an admin-only route, and requires the `systemConfig.update` permission.
1832
+ * Update system configuration
1697
1833
  */
1698
1834
  export function updateConfig({ systemConfigDto }, opts) {
1699
1835
  return oazapfts.ok(oazapfts.fetchJson("/system-config", oazapfts.json({
@@ -1703,7 +1839,7 @@ export function updateConfig({ systemConfigDto }, opts) {
1703
1839
  })));
1704
1840
  }
1705
1841
  /**
1706
- * This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
1842
+ * Get system configuration defaults
1707
1843
  */
1708
1844
  export function getConfigDefaults(opts) {
1709
1845
  return oazapfts.ok(oazapfts.fetchJson("/system-config/defaults", {
@@ -1711,7 +1847,7 @@ export function getConfigDefaults(opts) {
1711
1847
  }));
1712
1848
  }
1713
1849
  /**
1714
- * This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
1850
+ * Get storage template options
1715
1851
  */
1716
1852
  export function getStorageTemplateOptions(opts) {
1717
1853
  return oazapfts.ok(oazapfts.fetchJson("/system-config/storage-template-options", {
@@ -1719,7 +1855,7 @@ export function getStorageTemplateOptions(opts) {
1719
1855
  }));
1720
1856
  }
1721
1857
  /**
1722
- * This endpoint is an admin-only route, and requires the `systemMetadata.read` permission.
1858
+ * Retrieve admin onboarding
1723
1859
  */
1724
1860
  export function getAdminOnboarding(opts) {
1725
1861
  return oazapfts.ok(oazapfts.fetchJson("/system-metadata/admin-onboarding", {
@@ -1727,7 +1863,7 @@ export function getAdminOnboarding(opts) {
1727
1863
  }));
1728
1864
  }
1729
1865
  /**
1730
- * This endpoint is an admin-only route, and requires the `systemMetadata.update` permission.
1866
+ * Update admin onboarding
1731
1867
  */
1732
1868
  export function updateAdminOnboarding({ adminOnboardingUpdateDto }, opts) {
1733
1869
  return oazapfts.ok(oazapfts.fetchText("/system-metadata/admin-onboarding", oazapfts.json({
@@ -1737,7 +1873,7 @@ export function updateAdminOnboarding({ adminOnboardingUpdateDto }, opts) {
1737
1873
  })));
1738
1874
  }
1739
1875
  /**
1740
- * This endpoint is an admin-only route, and requires the `systemMetadata.read` permission.
1876
+ * Retrieve reverse geocoding state
1741
1877
  */
1742
1878
  export function getReverseGeocodingState(opts) {
1743
1879
  return oazapfts.ok(oazapfts.fetchJson("/system-metadata/reverse-geocoding-state", {
@@ -1745,7 +1881,7 @@ export function getReverseGeocodingState(opts) {
1745
1881
  }));
1746
1882
  }
1747
1883
  /**
1748
- * This endpoint is an admin-only route, and requires the `systemMetadata.read` permission.
1884
+ * Retrieve version check state
1749
1885
  */
1750
1886
  export function getVersionCheckState(opts) {
1751
1887
  return oazapfts.ok(oazapfts.fetchJson("/system-metadata/version-check-state", {
@@ -1753,7 +1889,7 @@ export function getVersionCheckState(opts) {
1753
1889
  }));
1754
1890
  }
1755
1891
  /**
1756
- * This endpoint requires the `tag.read` permission.
1892
+ * Retrieve tags
1757
1893
  */
1758
1894
  export function getAllTags(opts) {
1759
1895
  return oazapfts.ok(oazapfts.fetchJson("/tags", {
@@ -1761,7 +1897,7 @@ export function getAllTags(opts) {
1761
1897
  }));
1762
1898
  }
1763
1899
  /**
1764
- * This endpoint requires the `tag.create` permission.
1900
+ * Create a tag
1765
1901
  */
1766
1902
  export function createTag({ tagCreateDto }, opts) {
1767
1903
  return oazapfts.ok(oazapfts.fetchJson("/tags", oazapfts.json({
@@ -1771,7 +1907,7 @@ export function createTag({ tagCreateDto }, opts) {
1771
1907
  })));
1772
1908
  }
1773
1909
  /**
1774
- * This endpoint requires the `tag.create` permission.
1910
+ * Upsert tags
1775
1911
  */
1776
1912
  export function upsertTags({ tagUpsertDto }, opts) {
1777
1913
  return oazapfts.ok(oazapfts.fetchJson("/tags", oazapfts.json({
@@ -1781,7 +1917,7 @@ export function upsertTags({ tagUpsertDto }, opts) {
1781
1917
  })));
1782
1918
  }
1783
1919
  /**
1784
- * This endpoint requires the `tag.asset` permission.
1920
+ * Tag assets
1785
1921
  */
1786
1922
  export function bulkTagAssets({ tagBulkAssetsDto }, opts) {
1787
1923
  return oazapfts.ok(oazapfts.fetchJson("/tags/assets", oazapfts.json({
@@ -1791,7 +1927,7 @@ export function bulkTagAssets({ tagBulkAssetsDto }, opts) {
1791
1927
  })));
1792
1928
  }
1793
1929
  /**
1794
- * This endpoint requires the `tag.delete` permission.
1930
+ * Delete a tag
1795
1931
  */
1796
1932
  export function deleteTag({ id }, opts) {
1797
1933
  return oazapfts.ok(oazapfts.fetchText(`/tags/${encodeURIComponent(id)}`, {
@@ -1800,7 +1936,7 @@ export function deleteTag({ id }, opts) {
1800
1936
  }));
1801
1937
  }
1802
1938
  /**
1803
- * This endpoint requires the `tag.read` permission.
1939
+ * Retrieve a tag
1804
1940
  */
1805
1941
  export function getTagById({ id }, opts) {
1806
1942
  return oazapfts.ok(oazapfts.fetchJson(`/tags/${encodeURIComponent(id)}`, {
@@ -1808,7 +1944,7 @@ export function getTagById({ id }, opts) {
1808
1944
  }));
1809
1945
  }
1810
1946
  /**
1811
- * This endpoint requires the `tag.update` permission.
1947
+ * Update a tag
1812
1948
  */
1813
1949
  export function updateTag({ id, tagUpdateDto }, opts) {
1814
1950
  return oazapfts.ok(oazapfts.fetchJson(`/tags/${encodeURIComponent(id)}`, oazapfts.json({
@@ -1818,7 +1954,7 @@ export function updateTag({ id, tagUpdateDto }, opts) {
1818
1954
  })));
1819
1955
  }
1820
1956
  /**
1821
- * This endpoint requires the `tag.asset` permission.
1957
+ * Untag assets
1822
1958
  */
1823
1959
  export function untagAssets({ id, bulkIdsDto }, opts) {
1824
1960
  return oazapfts.ok(oazapfts.fetchJson(`/tags/${encodeURIComponent(id)}/assets`, oazapfts.json({
@@ -1828,7 +1964,7 @@ export function untagAssets({ id, bulkIdsDto }, opts) {
1828
1964
  })));
1829
1965
  }
1830
1966
  /**
1831
- * This endpoint requires the `tag.asset` permission.
1967
+ * Tag assets
1832
1968
  */
1833
1969
  export function tagAssets({ id, bulkIdsDto }, opts) {
1834
1970
  return oazapfts.ok(oazapfts.fetchJson(`/tags/${encodeURIComponent(id)}/assets`, oazapfts.json({
@@ -1838,7 +1974,7 @@ export function tagAssets({ id, bulkIdsDto }, opts) {
1838
1974
  })));
1839
1975
  }
1840
1976
  /**
1841
- * This endpoint requires the `asset.read` permission.
1977
+ * Get time bucket
1842
1978
  */
1843
1979
  export function getTimeBucket({ albumId, isFavorite, isTrashed, key, order, personId, slug, tagId, timeBucket, userId, visibility, withCoordinates, withPartners, withStacked }, opts) {
1844
1980
  return oazapfts.ok(oazapfts.fetchJson(`/timeline/bucket${QS.query(QS.explode({
@@ -1861,7 +1997,7 @@ export function getTimeBucket({ albumId, isFavorite, isTrashed, key, order, pers
1861
1997
  }));
1862
1998
  }
1863
1999
  /**
1864
- * This endpoint requires the `asset.read` permission.
2000
+ * Get time buckets
1865
2001
  */
1866
2002
  export function getTimeBuckets({ albumId, isFavorite, isTrashed, key, order, personId, slug, tagId, userId, visibility, withCoordinates, withPartners, withStacked }, opts) {
1867
2003
  return oazapfts.ok(oazapfts.fetchJson(`/timeline/buckets${QS.query(QS.explode({
@@ -1883,7 +2019,7 @@ export function getTimeBuckets({ albumId, isFavorite, isTrashed, key, order, per
1883
2019
  }));
1884
2020
  }
1885
2021
  /**
1886
- * This endpoint requires the `asset.delete` permission.
2022
+ * Empty trash
1887
2023
  */
1888
2024
  export function emptyTrash(opts) {
1889
2025
  return oazapfts.ok(oazapfts.fetchJson("/trash/empty", {
@@ -1892,7 +2028,7 @@ export function emptyTrash(opts) {
1892
2028
  }));
1893
2029
  }
1894
2030
  /**
1895
- * This endpoint requires the `asset.delete` permission.
2031
+ * Restore trash
1896
2032
  */
1897
2033
  export function restoreTrash(opts) {
1898
2034
  return oazapfts.ok(oazapfts.fetchJson("/trash/restore", {
@@ -1901,7 +2037,7 @@ export function restoreTrash(opts) {
1901
2037
  }));
1902
2038
  }
1903
2039
  /**
1904
- * This endpoint requires the `asset.delete` permission.
2040
+ * Restore assets
1905
2041
  */
1906
2042
  export function restoreAssets({ bulkIdsDto }, opts) {
1907
2043
  return oazapfts.ok(oazapfts.fetchJson("/trash/restore/assets", oazapfts.json({
@@ -1911,7 +2047,7 @@ export function restoreAssets({ bulkIdsDto }, opts) {
1911
2047
  })));
1912
2048
  }
1913
2049
  /**
1914
- * This endpoint requires the `user.read` permission.
2050
+ * Get all users
1915
2051
  */
1916
2052
  export function searchUsers(opts) {
1917
2053
  return oazapfts.ok(oazapfts.fetchJson("/users", {
@@ -1919,7 +2055,7 @@ export function searchUsers(opts) {
1919
2055
  }));
1920
2056
  }
1921
2057
  /**
1922
- * This endpoint requires the `user.read` permission.
2058
+ * Get current user
1923
2059
  */
1924
2060
  export function getMyUser(opts) {
1925
2061
  return oazapfts.ok(oazapfts.fetchJson("/users/me", {
@@ -1927,7 +2063,7 @@ export function getMyUser(opts) {
1927
2063
  }));
1928
2064
  }
1929
2065
  /**
1930
- * This endpoint requires the `user.update` permission.
2066
+ * Update current user
1931
2067
  */
1932
2068
  export function updateMyUser({ userUpdateMeDto }, opts) {
1933
2069
  return oazapfts.ok(oazapfts.fetchJson("/users/me", oazapfts.json({
@@ -1937,7 +2073,7 @@ export function updateMyUser({ userUpdateMeDto }, opts) {
1937
2073
  })));
1938
2074
  }
1939
2075
  /**
1940
- * This endpoint requires the `userLicense.delete` permission.
2076
+ * Delete user product key
1941
2077
  */
1942
2078
  export function deleteUserLicense(opts) {
1943
2079
  return oazapfts.ok(oazapfts.fetchText("/users/me/license", {
@@ -1946,7 +2082,7 @@ export function deleteUserLicense(opts) {
1946
2082
  }));
1947
2083
  }
1948
2084
  /**
1949
- * This endpoint requires the `userLicense.read` permission.
2085
+ * Retrieve user product key
1950
2086
  */
1951
2087
  export function getUserLicense(opts) {
1952
2088
  return oazapfts.ok(oazapfts.fetchJson("/users/me/license", {
@@ -1954,7 +2090,7 @@ export function getUserLicense(opts) {
1954
2090
  }));
1955
2091
  }
1956
2092
  /**
1957
- * This endpoint requires the `userLicense.update` permission.
2093
+ * Set user product key
1958
2094
  */
1959
2095
  export function setUserLicense({ licenseKeyDto }, opts) {
1960
2096
  return oazapfts.ok(oazapfts.fetchJson("/users/me/license", oazapfts.json({
@@ -1964,7 +2100,7 @@ export function setUserLicense({ licenseKeyDto }, opts) {
1964
2100
  })));
1965
2101
  }
1966
2102
  /**
1967
- * This endpoint requires the `userOnboarding.delete` permission.
2103
+ * Delete user onboarding
1968
2104
  */
1969
2105
  export function deleteUserOnboarding(opts) {
1970
2106
  return oazapfts.ok(oazapfts.fetchText("/users/me/onboarding", {
@@ -1973,7 +2109,7 @@ export function deleteUserOnboarding(opts) {
1973
2109
  }));
1974
2110
  }
1975
2111
  /**
1976
- * This endpoint requires the `userOnboarding.read` permission.
2112
+ * Retrieve user onboarding
1977
2113
  */
1978
2114
  export function getUserOnboarding(opts) {
1979
2115
  return oazapfts.ok(oazapfts.fetchJson("/users/me/onboarding", {
@@ -1981,7 +2117,7 @@ export function getUserOnboarding(opts) {
1981
2117
  }));
1982
2118
  }
1983
2119
  /**
1984
- * This endpoint requires the `userOnboarding.update` permission.
2120
+ * Update user onboarding
1985
2121
  */
1986
2122
  export function setUserOnboarding({ onboardingDto }, opts) {
1987
2123
  return oazapfts.ok(oazapfts.fetchJson("/users/me/onboarding", oazapfts.json({
@@ -1991,7 +2127,7 @@ export function setUserOnboarding({ onboardingDto }, opts) {
1991
2127
  })));
1992
2128
  }
1993
2129
  /**
1994
- * This endpoint requires the `userPreference.read` permission.
2130
+ * Get my preferences
1995
2131
  */
1996
2132
  export function getMyPreferences(opts) {
1997
2133
  return oazapfts.ok(oazapfts.fetchJson("/users/me/preferences", {
@@ -1999,7 +2135,7 @@ export function getMyPreferences(opts) {
1999
2135
  }));
2000
2136
  }
2001
2137
  /**
2002
- * This endpoint requires the `userPreference.update` permission.
2138
+ * Update my preferences
2003
2139
  */
2004
2140
  export function updateMyPreferences({ userPreferencesUpdateDto }, opts) {
2005
2141
  return oazapfts.ok(oazapfts.fetchJson("/users/me/preferences", oazapfts.json({
@@ -2009,7 +2145,7 @@ export function updateMyPreferences({ userPreferencesUpdateDto }, opts) {
2009
2145
  })));
2010
2146
  }
2011
2147
  /**
2012
- * This endpoint requires the `userProfileImage.delete` permission.
2148
+ * Delete user profile image
2013
2149
  */
2014
2150
  export function deleteProfileImage(opts) {
2015
2151
  return oazapfts.ok(oazapfts.fetchText("/users/profile-image", {
@@ -2018,7 +2154,7 @@ export function deleteProfileImage(opts) {
2018
2154
  }));
2019
2155
  }
2020
2156
  /**
2021
- * This endpoint requires the `userProfileImage.update` permission.
2157
+ * Create user profile image
2022
2158
  */
2023
2159
  export function createProfileImage({ createProfileImageDto }, opts) {
2024
2160
  return oazapfts.ok(oazapfts.fetchJson("/users/profile-image", oazapfts.multipart({
@@ -2028,7 +2164,7 @@ export function createProfileImage({ createProfileImageDto }, opts) {
2028
2164
  })));
2029
2165
  }
2030
2166
  /**
2031
- * This endpoint requires the `user.read` permission.
2167
+ * Retrieve a user
2032
2168
  */
2033
2169
  export function getUser({ id }, opts) {
2034
2170
  return oazapfts.ok(oazapfts.fetchJson(`/users/${encodeURIComponent(id)}`, {
@@ -2036,13 +2172,16 @@ export function getUser({ id }, opts) {
2036
2172
  }));
2037
2173
  }
2038
2174
  /**
2039
- * This endpoint requires the `userProfileImage.read` permission.
2175
+ * Retrieve user profile image
2040
2176
  */
2041
2177
  export function getProfileImage({ id }, opts) {
2042
2178
  return oazapfts.ok(oazapfts.fetchBlob(`/users/${encodeURIComponent(id)}/profile-image`, {
2043
2179
  ...opts
2044
2180
  }));
2045
2181
  }
2182
+ /**
2183
+ * Retrieve assets by original path
2184
+ */
2046
2185
  export function getAssetsByOriginalPath({ path }, opts) {
2047
2186
  return oazapfts.ok(oazapfts.fetchJson(`/view/folder${QS.query(QS.explode({
2048
2187
  path
@@ -2050,11 +2189,59 @@ export function getAssetsByOriginalPath({ path }, opts) {
2050
2189
  ...opts
2051
2190
  }));
2052
2191
  }
2192
+ /**
2193
+ * Retrieve unique paths
2194
+ */
2053
2195
  export function getUniqueOriginalPaths(opts) {
2054
2196
  return oazapfts.ok(oazapfts.fetchJson("/view/folder/unique-paths", {
2055
2197
  ...opts
2056
2198
  }));
2057
2199
  }
2200
+ /**
2201
+ * List all workflows
2202
+ */
2203
+ export function getWorkflows(opts) {
2204
+ return oazapfts.ok(oazapfts.fetchJson("/workflows", {
2205
+ ...opts
2206
+ }));
2207
+ }
2208
+ /**
2209
+ * Create a workflow
2210
+ */
2211
+ export function createWorkflow({ workflowCreateDto }, opts) {
2212
+ return oazapfts.ok(oazapfts.fetchJson("/workflows", oazapfts.json({
2213
+ ...opts,
2214
+ method: "POST",
2215
+ body: workflowCreateDto
2216
+ })));
2217
+ }
2218
+ /**
2219
+ * Delete a workflow
2220
+ */
2221
+ export function deleteWorkflow({ id }, opts) {
2222
+ return oazapfts.ok(oazapfts.fetchText(`/workflows/${encodeURIComponent(id)}`, {
2223
+ ...opts,
2224
+ method: "DELETE"
2225
+ }));
2226
+ }
2227
+ /**
2228
+ * Retrieve a workflow
2229
+ */
2230
+ export function getWorkflow({ id }, opts) {
2231
+ return oazapfts.ok(oazapfts.fetchJson(`/workflows/${encodeURIComponent(id)}`, {
2232
+ ...opts
2233
+ }));
2234
+ }
2235
+ /**
2236
+ * Update a workflow
2237
+ */
2238
+ export function updateWorkflow({ id, workflowUpdateDto }, opts) {
2239
+ return oazapfts.ok(oazapfts.fetchJson(`/workflows/${encodeURIComponent(id)}`, oazapfts.json({
2240
+ ...opts,
2241
+ method: "PUT",
2242
+ body: workflowUpdateDto
2243
+ })));
2244
+ }
2058
2245
  export var ReactionLevel;
2059
2246
  (function (ReactionLevel) {
2060
2247
  ReactionLevel["Album"] = "album";
@@ -2078,6 +2265,11 @@ export var UserAvatarColor;
2078
2265
  UserAvatarColor["Gray"] = "gray";
2079
2266
  UserAvatarColor["Amber"] = "amber";
2080
2267
  })(UserAvatarColor || (UserAvatarColor = {}));
2268
+ export var MaintenanceAction;
2269
+ (function (MaintenanceAction) {
2270
+ MaintenanceAction["Start"] = "start";
2271
+ MaintenanceAction["End"] = "end";
2272
+ })(MaintenanceAction || (MaintenanceAction = {}));
2081
2273
  export var NotificationLevel;
2082
2274
  (function (NotificationLevel) {
2083
2275
  NotificationLevel["Success"] = "success";
@@ -2196,6 +2388,7 @@ export var Permission;
2196
2388
  Permission["LibraryStatistics"] = "library.statistics";
2197
2389
  Permission["TimelineRead"] = "timeline.read";
2198
2390
  Permission["TimelineDownload"] = "timeline.download";
2391
+ Permission["Maintenance"] = "maintenance";
2199
2392
  Permission["MemoryCreate"] = "memory.create";
2200
2393
  Permission["MemoryRead"] = "memory.read";
2201
2394
  Permission["MemoryUpdate"] = "memory.update";
@@ -2221,6 +2414,10 @@ export var Permission;
2221
2414
  Permission["PinCodeCreate"] = "pinCode.create";
2222
2415
  Permission["PinCodeUpdate"] = "pinCode.update";
2223
2416
  Permission["PinCodeDelete"] = "pinCode.delete";
2417
+ Permission["PluginCreate"] = "plugin.create";
2418
+ Permission["PluginRead"] = "plugin.read";
2419
+ Permission["PluginUpdate"] = "plugin.update";
2420
+ Permission["PluginDelete"] = "plugin.delete";
2224
2421
  Permission["ServerAbout"] = "server.about";
2225
2422
  Permission["ServerApkLinks"] = "server.apkLinks";
2226
2423
  Permission["ServerStorage"] = "server.storage";
@@ -2270,6 +2467,10 @@ export var Permission;
2270
2467
  Permission["UserProfileImageRead"] = "userProfileImage.read";
2271
2468
  Permission["UserProfileImageUpdate"] = "userProfileImage.update";
2272
2469
  Permission["UserProfileImageDelete"] = "userProfileImage.delete";
2470
+ Permission["WorkflowCreate"] = "workflow.create";
2471
+ Permission["WorkflowRead"] = "workflow.read";
2472
+ Permission["WorkflowUpdate"] = "workflow.update";
2473
+ Permission["WorkflowDelete"] = "workflow.delete";
2273
2474
  Permission["AdminUserCreate"] = "adminUser.create";
2274
2475
  Permission["AdminUserRead"] = "adminUser.read";
2275
2476
  Permission["AdminUserUpdate"] = "adminUser.update";
@@ -2319,33 +2520,40 @@ export var ManualJobName;
2319
2520
  ManualJobName["MemoryCreate"] = "memory-create";
2320
2521
  ManualJobName["BackupDatabase"] = "backup-database";
2321
2522
  })(ManualJobName || (ManualJobName = {}));
2322
- export var JobName;
2323
- (function (JobName) {
2324
- JobName["ThumbnailGeneration"] = "thumbnailGeneration";
2325
- JobName["MetadataExtraction"] = "metadataExtraction";
2326
- JobName["VideoConversion"] = "videoConversion";
2327
- JobName["FaceDetection"] = "faceDetection";
2328
- JobName["FacialRecognition"] = "facialRecognition";
2329
- JobName["SmartSearch"] = "smartSearch";
2330
- JobName["DuplicateDetection"] = "duplicateDetection";
2331
- JobName["BackgroundTask"] = "backgroundTask";
2332
- JobName["StorageTemplateMigration"] = "storageTemplateMigration";
2333
- JobName["Migration"] = "migration";
2334
- JobName["Search"] = "search";
2335
- JobName["Sidecar"] = "sidecar";
2336
- JobName["Library"] = "library";
2337
- JobName["Notifications"] = "notifications";
2338
- JobName["BackupDatabase"] = "backupDatabase";
2339
- JobName["Ocr"] = "ocr";
2340
- })(JobName || (JobName = {}));
2341
- export var JobCommand;
2342
- (function (JobCommand) {
2343
- JobCommand["Start"] = "start";
2344
- JobCommand["Pause"] = "pause";
2345
- JobCommand["Resume"] = "resume";
2346
- JobCommand["Empty"] = "empty";
2347
- JobCommand["ClearFailed"] = "clear-failed";
2348
- })(JobCommand || (JobCommand = {}));
2523
+ export var QueueName;
2524
+ (function (QueueName) {
2525
+ QueueName["ThumbnailGeneration"] = "thumbnailGeneration";
2526
+ QueueName["MetadataExtraction"] = "metadataExtraction";
2527
+ QueueName["VideoConversion"] = "videoConversion";
2528
+ QueueName["FaceDetection"] = "faceDetection";
2529
+ QueueName["FacialRecognition"] = "facialRecognition";
2530
+ QueueName["SmartSearch"] = "smartSearch";
2531
+ QueueName["DuplicateDetection"] = "duplicateDetection";
2532
+ QueueName["BackgroundTask"] = "backgroundTask";
2533
+ QueueName["StorageTemplateMigration"] = "storageTemplateMigration";
2534
+ QueueName["Migration"] = "migration";
2535
+ QueueName["Search"] = "search";
2536
+ QueueName["Sidecar"] = "sidecar";
2537
+ QueueName["Library"] = "library";
2538
+ QueueName["Notifications"] = "notifications";
2539
+ QueueName["BackupDatabase"] = "backupDatabase";
2540
+ QueueName["Ocr"] = "ocr";
2541
+ QueueName["Workflow"] = "workflow";
2542
+ })(QueueName || (QueueName = {}));
2543
+ export var QueueCommand;
2544
+ (function (QueueCommand) {
2545
+ QueueCommand["Start"] = "start";
2546
+ QueueCommand["Pause"] = "pause";
2547
+ QueueCommand["Resume"] = "resume";
2548
+ QueueCommand["Empty"] = "empty";
2549
+ QueueCommand["ClearFailed"] = "clear-failed";
2550
+ })(QueueCommand || (QueueCommand = {}));
2551
+ export var MemorySearchOrder;
2552
+ (function (MemorySearchOrder) {
2553
+ MemorySearchOrder["Asc"] = "asc";
2554
+ MemorySearchOrder["Desc"] = "desc";
2555
+ MemorySearchOrder["Random"] = "random";
2556
+ })(MemorySearchOrder || (MemorySearchOrder = {}));
2349
2557
  export var MemoryType;
2350
2558
  (function (MemoryType) {
2351
2559
  MemoryType["OnThisDay"] = "on_this_day";
@@ -2355,6 +2563,12 @@ export var PartnerDirection;
2355
2563
  PartnerDirection["SharedBy"] = "shared-by";
2356
2564
  PartnerDirection["SharedWith"] = "shared-with";
2357
2565
  })(PartnerDirection || (PartnerDirection = {}));
2566
+ export var PluginContext;
2567
+ (function (PluginContext) {
2568
+ PluginContext["Asset"] = "asset";
2569
+ PluginContext["Album"] = "album";
2570
+ PluginContext["Person"] = "person";
2571
+ })(PluginContext || (PluginContext = {}));
2358
2572
  export var SearchSuggestionType;
2359
2573
  (function (SearchSuggestionType) {
2360
2574
  SearchSuggestionType["Country"] = "country";
@@ -2522,3 +2736,13 @@ export var OAuthTokenEndpointAuthMethod;
2522
2736
  OAuthTokenEndpointAuthMethod["ClientSecretPost"] = "client_secret_post";
2523
2737
  OAuthTokenEndpointAuthMethod["ClientSecretBasic"] = "client_secret_basic";
2524
2738
  })(OAuthTokenEndpointAuthMethod || (OAuthTokenEndpointAuthMethod = {}));
2739
+ export var TriggerType;
2740
+ (function (TriggerType) {
2741
+ TriggerType["AssetCreate"] = "AssetCreate";
2742
+ TriggerType["PersonRecognized"] = "PersonRecognized";
2743
+ })(TriggerType || (TriggerType = {}));
2744
+ export var PluginTriggerType;
2745
+ (function (PluginTriggerType) {
2746
+ PluginTriggerType["AssetCreate"] = "AssetCreate";
2747
+ PluginTriggerType["PersonRecognized"] = "PersonRecognized";
2748
+ })(PluginTriggerType || (PluginTriggerType = {}));