@immich/sdk 1.136.0 → 1.137.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Immich
3
- * 1.136.0
3
+ * 1.137.1
4
4
  * DO NOT MODIFY - This file has been generated using oazapfts.
5
5
  * See https://www.npmjs.com/package/oazapfts
6
6
  */
@@ -14,6 +14,9 @@ const oazapfts = Oazapfts.runtime(defaults);
14
14
  export const servers = {
15
15
  server1: "/api"
16
16
  };
17
+ /**
18
+ * This endpoint requires the `activity.read` permission.
19
+ */
17
20
  export function getActivities({ albumId, assetId, level, $type, userId }, opts) {
18
21
  return oazapfts.ok(oazapfts.fetchJson(`/activities${QS.query(QS.explode({
19
22
  albumId,
@@ -25,6 +28,9 @@ export function getActivities({ albumId, assetId, level, $type, userId }, opts)
25
28
  ...opts
26
29
  }));
27
30
  }
31
+ /**
32
+ * This endpoint requires the `activity.create` permission.
33
+ */
28
34
  export function createActivity({ activityCreateDto }, opts) {
29
35
  return oazapfts.ok(oazapfts.fetchJson("/activities", oazapfts.json({
30
36
  ...opts,
@@ -32,6 +38,9 @@ export function createActivity({ activityCreateDto }, opts) {
32
38
  body: activityCreateDto
33
39
  })));
34
40
  }
41
+ /**
42
+ * This endpoint requires the `activity.statistics` permission.
43
+ */
35
44
  export function getActivityStatistics({ albumId, assetId }, opts) {
36
45
  return oazapfts.ok(oazapfts.fetchJson(`/activities/statistics${QS.query(QS.explode({
37
46
  albumId,
@@ -40,6 +49,9 @@ export function getActivityStatistics({ albumId, assetId }, opts) {
40
49
  ...opts
41
50
  }));
42
51
  }
52
+ /**
53
+ * This endpoint requires the `activity.delete` permission.
54
+ */
43
55
  export function deleteActivity({ id }, opts) {
44
56
  return oazapfts.ok(oazapfts.fetchText(`/activities/${encodeURIComponent(id)}`, {
45
57
  ...opts,
@@ -67,6 +79,9 @@ export function sendTestEmailAdmin({ systemConfigSmtpDto }, opts) {
67
79
  body: systemConfigSmtpDto
68
80
  })));
69
81
  }
82
+ /**
83
+ * This endpoint is an admin-only route, and requires the `adminUser.read` permission.
84
+ */
70
85
  export function searchUsersAdmin({ id, withDeleted }, opts) {
71
86
  return oazapfts.ok(oazapfts.fetchJson(`/admin/users${QS.query(QS.explode({
72
87
  id,
@@ -75,6 +90,9 @@ export function searchUsersAdmin({ id, withDeleted }, opts) {
75
90
  ...opts
76
91
  }));
77
92
  }
93
+ /**
94
+ * This endpoint is an admin-only route, and requires the `adminUser.create` permission.
95
+ */
78
96
  export function createUserAdmin({ userAdminCreateDto }, opts) {
79
97
  return oazapfts.ok(oazapfts.fetchJson("/admin/users", oazapfts.json({
80
98
  ...opts,
@@ -82,6 +100,9 @@ export function createUserAdmin({ userAdminCreateDto }, opts) {
82
100
  body: userAdminCreateDto
83
101
  })));
84
102
  }
103
+ /**
104
+ * This endpoint is an admin-only route, and requires the `adminUser.delete` permission.
105
+ */
85
106
  export function deleteUserAdmin({ id, userAdminDeleteDto }, opts) {
86
107
  return oazapfts.ok(oazapfts.fetchJson(`/admin/users/${encodeURIComponent(id)}`, oazapfts.json({
87
108
  ...opts,
@@ -89,11 +110,17 @@ export function deleteUserAdmin({ id, userAdminDeleteDto }, opts) {
89
110
  body: userAdminDeleteDto
90
111
  })));
91
112
  }
113
+ /**
114
+ * This endpoint is an admin-only route, and requires the `adminUser.read` permission.
115
+ */
92
116
  export function getUserAdmin({ id }, opts) {
93
117
  return oazapfts.ok(oazapfts.fetchJson(`/admin/users/${encodeURIComponent(id)}`, {
94
118
  ...opts
95
119
  }));
96
120
  }
121
+ /**
122
+ * This endpoint is an admin-only route, and requires the `adminUser.update` permission.
123
+ */
97
124
  export function updateUserAdmin({ id, userAdminUpdateDto }, opts) {
98
125
  return oazapfts.ok(oazapfts.fetchJson(`/admin/users/${encodeURIComponent(id)}`, oazapfts.json({
99
126
  ...opts,
@@ -101,11 +128,17 @@ export function updateUserAdmin({ id, userAdminUpdateDto }, opts) {
101
128
  body: userAdminUpdateDto
102
129
  })));
103
130
  }
131
+ /**
132
+ * This endpoint is an admin-only route, and requires the `adminUser.read` permission.
133
+ */
104
134
  export function getUserPreferencesAdmin({ id }, opts) {
105
135
  return oazapfts.ok(oazapfts.fetchJson(`/admin/users/${encodeURIComponent(id)}/preferences`, {
106
136
  ...opts
107
137
  }));
108
138
  }
139
+ /**
140
+ * This endpoint is an admin-only route, and requires the `adminUser.update` permission.
141
+ */
109
142
  export function updateUserPreferencesAdmin({ id, userPreferencesUpdateDto }, opts) {
110
143
  return oazapfts.ok(oazapfts.fetchJson(`/admin/users/${encodeURIComponent(id)}/preferences`, oazapfts.json({
111
144
  ...opts,
@@ -113,12 +146,18 @@ export function updateUserPreferencesAdmin({ id, userPreferencesUpdateDto }, opt
113
146
  body: userPreferencesUpdateDto
114
147
  })));
115
148
  }
149
+ /**
150
+ * This endpoint is an admin-only route, and requires the `adminUser.delete` permission.
151
+ */
116
152
  export function restoreUserAdmin({ id }, opts) {
117
153
  return oazapfts.ok(oazapfts.fetchJson(`/admin/users/${encodeURIComponent(id)}/restore`, {
118
154
  ...opts,
119
155
  method: "POST"
120
156
  }));
121
157
  }
158
+ /**
159
+ * This endpoint is an admin-only route, and requires the `adminUser.read` permission.
160
+ */
122
161
  export function getUserStatisticsAdmin({ id, isFavorite, isTrashed, visibility }, opts) {
123
162
  return oazapfts.ok(oazapfts.fetchJson(`/admin/users/${encodeURIComponent(id)}/statistics${QS.query(QS.explode({
124
163
  isFavorite,
@@ -128,6 +167,9 @@ export function getUserStatisticsAdmin({ id, isFavorite, isTrashed, visibility }
128
167
  ...opts
129
168
  }));
130
169
  }
170
+ /**
171
+ * This endpoint requires the `album.read` permission.
172
+ */
131
173
  export function getAllAlbums({ assetId, shared }, opts) {
132
174
  return oazapfts.ok(oazapfts.fetchJson(`/albums${QS.query(QS.explode({
133
175
  assetId,
@@ -136,6 +178,9 @@ export function getAllAlbums({ assetId, shared }, opts) {
136
178
  ...opts
137
179
  }));
138
180
  }
181
+ /**
182
+ * This endpoint requires the `album.create` permission.
183
+ */
139
184
  export function createAlbum({ createAlbumDto }, opts) {
140
185
  return oazapfts.ok(oazapfts.fetchJson("/albums", oazapfts.json({
141
186
  ...opts,
@@ -143,25 +188,38 @@ export function createAlbum({ createAlbumDto }, opts) {
143
188
  body: createAlbumDto
144
189
  })));
145
190
  }
191
+ /**
192
+ * This endpoint requires the `album.statistics` permission.
193
+ */
146
194
  export function getAlbumStatistics(opts) {
147
195
  return oazapfts.ok(oazapfts.fetchJson("/albums/statistics", {
148
196
  ...opts
149
197
  }));
150
198
  }
199
+ /**
200
+ * This endpoint requires the `album.delete` permission.
201
+ */
151
202
  export function deleteAlbum({ id }, opts) {
152
203
  return oazapfts.ok(oazapfts.fetchText(`/albums/${encodeURIComponent(id)}`, {
153
204
  ...opts,
154
205
  method: "DELETE"
155
206
  }));
156
207
  }
157
- export function getAlbumInfo({ id, key, withoutAssets }, opts) {
208
+ /**
209
+ * This endpoint requires the `album.read` permission.
210
+ */
211
+ export function getAlbumInfo({ id, key, slug, withoutAssets }, opts) {
158
212
  return oazapfts.ok(oazapfts.fetchJson(`/albums/${encodeURIComponent(id)}${QS.query(QS.explode({
159
213
  key,
214
+ slug,
160
215
  withoutAssets
161
216
  }))}`, {
162
217
  ...opts
163
218
  }));
164
219
  }
220
+ /**
221
+ * This endpoint requires the `album.update` permission.
222
+ */
165
223
  export function updateAlbumInfo({ id, updateAlbumDto }, opts) {
166
224
  return oazapfts.ok(oazapfts.fetchJson(`/albums/${encodeURIComponent(id)}`, oazapfts.json({
167
225
  ...opts,
@@ -169,6 +227,9 @@ export function updateAlbumInfo({ id, updateAlbumDto }, opts) {
169
227
  body: updateAlbumDto
170
228
  })));
171
229
  }
230
+ /**
231
+ * This endpoint requires the `albumAsset.delete` permission.
232
+ */
172
233
  export function removeAssetFromAlbum({ id, bulkIdsDto }, opts) {
173
234
  return oazapfts.ok(oazapfts.fetchJson(`/albums/${encodeURIComponent(id)}/assets`, oazapfts.json({
174
235
  ...opts,
@@ -176,21 +237,31 @@ export function removeAssetFromAlbum({ id, bulkIdsDto }, opts) {
176
237
  body: bulkIdsDto
177
238
  })));
178
239
  }
179
- export function addAssetsToAlbum({ id, key, bulkIdsDto }, opts) {
240
+ /**
241
+ * This endpoint requires the `albumAsset.create` permission.
242
+ */
243
+ export function addAssetsToAlbum({ id, key, slug, bulkIdsDto }, opts) {
180
244
  return oazapfts.ok(oazapfts.fetchJson(`/albums/${encodeURIComponent(id)}/assets${QS.query(QS.explode({
181
- key
245
+ key,
246
+ slug
182
247
  }))}`, oazapfts.json({
183
248
  ...opts,
184
249
  method: "PUT",
185
250
  body: bulkIdsDto
186
251
  })));
187
252
  }
253
+ /**
254
+ * This endpoint requires the `albumUser.delete` permission.
255
+ */
188
256
  export function removeUserFromAlbum({ id, userId }, opts) {
189
257
  return oazapfts.ok(oazapfts.fetchText(`/albums/${encodeURIComponent(id)}/user/${encodeURIComponent(userId)}`, {
190
258
  ...opts,
191
259
  method: "DELETE"
192
260
  }));
193
261
  }
262
+ /**
263
+ * This endpoint requires the `albumUser.update` permission.
264
+ */
194
265
  export function updateAlbumUser({ id, userId, updateAlbumUserDto }, opts) {
195
266
  return oazapfts.ok(oazapfts.fetchText(`/albums/${encodeURIComponent(id)}/user/${encodeURIComponent(userId)}`, oazapfts.json({
196
267
  ...opts,
@@ -198,6 +269,9 @@ export function updateAlbumUser({ id, userId, updateAlbumUserDto }, opts) {
198
269
  body: updateAlbumUserDto
199
270
  })));
200
271
  }
272
+ /**
273
+ * This endpoint requires the `albumUser.create` permission.
274
+ */
201
275
  export function addUsersToAlbum({ id, addUsersDto }, opts) {
202
276
  return oazapfts.ok(oazapfts.fetchJson(`/albums/${encodeURIComponent(id)}/users`, oazapfts.json({
203
277
  ...opts,
@@ -205,11 +279,17 @@ export function addUsersToAlbum({ id, addUsersDto }, opts) {
205
279
  body: addUsersDto
206
280
  })));
207
281
  }
282
+ /**
283
+ * This endpoint requires the `apiKey.read` permission.
284
+ */
208
285
  export function getApiKeys(opts) {
209
286
  return oazapfts.ok(oazapfts.fetchJson("/api-keys", {
210
287
  ...opts
211
288
  }));
212
289
  }
290
+ /**
291
+ * This endpoint requires the `apiKey.create` permission.
292
+ */
213
293
  export function createApiKey({ apiKeyCreateDto }, opts) {
214
294
  return oazapfts.ok(oazapfts.fetchJson("/api-keys", oazapfts.json({
215
295
  ...opts,
@@ -217,17 +297,26 @@ export function createApiKey({ apiKeyCreateDto }, opts) {
217
297
  body: apiKeyCreateDto
218
298
  })));
219
299
  }
300
+ /**
301
+ * This endpoint requires the `apiKey.delete` permission.
302
+ */
220
303
  export function deleteApiKey({ id }, opts) {
221
304
  return oazapfts.ok(oazapfts.fetchText(`/api-keys/${encodeURIComponent(id)}`, {
222
305
  ...opts,
223
306
  method: "DELETE"
224
307
  }));
225
308
  }
309
+ /**
310
+ * This endpoint requires the `apiKey.read` permission.
311
+ */
226
312
  export function getApiKey({ id }, opts) {
227
313
  return oazapfts.ok(oazapfts.fetchJson(`/api-keys/${encodeURIComponent(id)}`, {
228
314
  ...opts
229
315
  }));
230
316
  }
317
+ /**
318
+ * This endpoint requires the `apiKey.update` permission.
319
+ */
231
320
  export function updateApiKey({ id, apiKeyUpdateDto }, opts) {
232
321
  return oazapfts.ok(oazapfts.fetchJson(`/api-keys/${encodeURIComponent(id)}`, oazapfts.json({
233
322
  ...opts,
@@ -235,6 +324,9 @@ export function updateApiKey({ id, apiKeyUpdateDto }, opts) {
235
324
  body: apiKeyUpdateDto
236
325
  })));
237
326
  }
327
+ /**
328
+ * This endpoint requires the `asset.delete` permission.
329
+ */
238
330
  export function deleteAssets({ assetBulkDeleteDto }, opts) {
239
331
  return oazapfts.ok(oazapfts.fetchText("/assets", oazapfts.json({
240
332
  ...opts,
@@ -242,9 +334,13 @@ export function deleteAssets({ assetBulkDeleteDto }, opts) {
242
334
  body: assetBulkDeleteDto
243
335
  })));
244
336
  }
245
- export function uploadAsset({ key, xImmichChecksum, assetMediaCreateDto }, opts) {
337
+ /**
338
+ * This endpoint requires the `asset.upload` permission.
339
+ */
340
+ export function uploadAsset({ key, slug, xImmichChecksum, assetMediaCreateDto }, opts) {
246
341
  return oazapfts.ok(oazapfts.fetchJson(`/assets${QS.query(QS.explode({
247
- key
342
+ key,
343
+ slug
248
344
  }))}`, oazapfts.multipart({
249
345
  ...opts,
250
346
  method: "POST",
@@ -254,6 +350,9 @@ export function uploadAsset({ key, xImmichChecksum, assetMediaCreateDto }, opts)
254
350
  })
255
351
  })));
256
352
  }
353
+ /**
354
+ * This endpoint requires the `asset.update` permission.
355
+ */
257
356
  export function updateAssets({ assetBulkUpdateDto }, opts) {
258
357
  return oazapfts.ok(oazapfts.fetchText("/assets", oazapfts.json({
259
358
  ...opts,
@@ -297,7 +396,7 @@ export function runAssetJobs({ assetJobsDto }, opts) {
297
396
  })));
298
397
  }
299
398
  /**
300
- * This property was deprecated in v1.116.0
399
+ * This property was deprecated in v1.116.0. This endpoint requires the `asset.read` permission.
301
400
  */
302
401
  export function getRandom({ count }, opts) {
303
402
  return oazapfts.ok(oazapfts.fetchJson(`/assets/random${QS.query(QS.explode({
@@ -306,6 +405,9 @@ export function getRandom({ count }, opts) {
306
405
  ...opts
307
406
  }));
308
407
  }
408
+ /**
409
+ * This endpoint requires the `asset.statistics` permission.
410
+ */
309
411
  export function getAssetStatistics({ isFavorite, isTrashed, visibility }, opts) {
310
412
  return oazapfts.ok(oazapfts.fetchJson(`/assets/statistics${QS.query(QS.explode({
311
413
  isFavorite,
@@ -315,13 +417,20 @@ export function getAssetStatistics({ isFavorite, isTrashed, visibility }, opts)
315
417
  ...opts
316
418
  }));
317
419
  }
318
- export function getAssetInfo({ id, key }, opts) {
420
+ /**
421
+ * This endpoint requires the `asset.read` permission.
422
+ */
423
+ export function getAssetInfo({ id, key, slug }, opts) {
319
424
  return oazapfts.ok(oazapfts.fetchJson(`/assets/${encodeURIComponent(id)}${QS.query(QS.explode({
320
- key
425
+ key,
426
+ slug
321
427
  }))}`, {
322
428
  ...opts
323
429
  }));
324
430
  }
431
+ /**
432
+ * This endpoint requires the `asset.update` permission.
433
+ */
325
434
  export function updateAsset({ id, updateAssetDto }, opts) {
326
435
  return oazapfts.ok(oazapfts.fetchJson(`/assets/${encodeURIComponent(id)}`, oazapfts.json({
327
436
  ...opts,
@@ -329,9 +438,13 @@ export function updateAsset({ id, updateAssetDto }, opts) {
329
438
  body: updateAssetDto
330
439
  })));
331
440
  }
332
- export function downloadAsset({ id, key }, opts) {
441
+ /**
442
+ * This endpoint requires the `asset.download` permission.
443
+ */
444
+ export function downloadAsset({ id, key, slug }, opts) {
333
445
  return oazapfts.ok(oazapfts.fetchBlob(`/assets/${encodeURIComponent(id)}/original${QS.query(QS.explode({
334
- key
446
+ key,
447
+ slug
335
448
  }))}`, {
336
449
  ...opts
337
450
  }));
@@ -339,26 +452,35 @@ export function downloadAsset({ id, key }, opts) {
339
452
  /**
340
453
  * replaceAsset
341
454
  */
342
- export function replaceAsset({ id, key, assetMediaReplaceDto }, opts) {
455
+ export function replaceAsset({ id, key, slug, assetMediaReplaceDto }, opts) {
343
456
  return oazapfts.ok(oazapfts.fetchJson(`/assets/${encodeURIComponent(id)}/original${QS.query(QS.explode({
344
- key
457
+ key,
458
+ slug
345
459
  }))}`, oazapfts.multipart({
346
460
  ...opts,
347
461
  method: "PUT",
348
462
  body: assetMediaReplaceDto
349
463
  })));
350
464
  }
351
- export function viewAsset({ id, key, size }, opts) {
465
+ /**
466
+ * This endpoint requires the `asset.view` permission.
467
+ */
468
+ export function viewAsset({ id, key, size, slug }, opts) {
352
469
  return oazapfts.ok(oazapfts.fetchBlob(`/assets/${encodeURIComponent(id)}/thumbnail${QS.query(QS.explode({
353
470
  key,
354
- size
471
+ size,
472
+ slug
355
473
  }))}`, {
356
474
  ...opts
357
475
  }));
358
476
  }
359
- export function playAssetVideo({ id, key }, opts) {
477
+ /**
478
+ * This endpoint requires the `asset.view` permission.
479
+ */
480
+ export function playAssetVideo({ id, key, slug }, opts) {
360
481
  return oazapfts.ok(oazapfts.fetchBlob(`/assets/${encodeURIComponent(id)}/video/playback${QS.query(QS.explode({
361
- key
482
+ key,
483
+ slug
362
484
  }))}`, {
363
485
  ...opts
364
486
  }));
@@ -370,6 +492,9 @@ export function signUpAdmin({ signUpDto }, opts) {
370
492
  body: signUpDto
371
493
  })));
372
494
  }
495
+ /**
496
+ * This endpoint requires the `auth.changePassword` permission.
497
+ */
373
498
  export function changePassword({ changePasswordDto }, opts) {
374
499
  return oazapfts.ok(oazapfts.fetchJson("/auth/change-password", oazapfts.json({
375
500
  ...opts,
@@ -390,6 +515,9 @@ export function logout(opts) {
390
515
  method: "POST"
391
516
  }));
392
517
  }
518
+ /**
519
+ * This endpoint requires the `pinCode.delete` permission.
520
+ */
393
521
  export function resetPinCode({ pinCodeResetDto }, opts) {
394
522
  return oazapfts.ok(oazapfts.fetchText("/auth/pin-code", oazapfts.json({
395
523
  ...opts,
@@ -397,6 +525,9 @@ export function resetPinCode({ pinCodeResetDto }, opts) {
397
525
  body: pinCodeResetDto
398
526
  })));
399
527
  }
528
+ /**
529
+ * This endpoint requires the `pinCode.create` permission.
530
+ */
400
531
  export function setupPinCode({ pinCodeSetupDto }, opts) {
401
532
  return oazapfts.ok(oazapfts.fetchText("/auth/pin-code", oazapfts.json({
402
533
  ...opts,
@@ -404,6 +535,9 @@ export function setupPinCode({ pinCodeSetupDto }, opts) {
404
535
  body: pinCodeSetupDto
405
536
  })));
406
537
  }
538
+ /**
539
+ * This endpoint requires the `pinCode.update` permission.
540
+ */
407
541
  export function changePinCode({ pinCodeChangeDto }, opts) {
408
542
  return oazapfts.ok(oazapfts.fetchText("/auth/pin-code", oazapfts.json({
409
543
  ...opts,
@@ -435,24 +569,35 @@ export function validateAccessToken(opts) {
435
569
  method: "POST"
436
570
  }));
437
571
  }
438
- export function downloadArchive({ key, assetIdsDto }, opts) {
572
+ /**
573
+ * This endpoint requires the `asset.download` permission.
574
+ */
575
+ export function downloadArchive({ key, slug, assetIdsDto }, opts) {
439
576
  return oazapfts.ok(oazapfts.fetchBlob(`/download/archive${QS.query(QS.explode({
440
- key
577
+ key,
578
+ slug
441
579
  }))}`, oazapfts.json({
442
580
  ...opts,
443
581
  method: "POST",
444
582
  body: assetIdsDto
445
583
  })));
446
584
  }
447
- export function getDownloadInfo({ key, downloadInfoDto }, opts) {
585
+ /**
586
+ * This endpoint requires the `asset.download` permission.
587
+ */
588
+ export function getDownloadInfo({ key, slug, downloadInfoDto }, opts) {
448
589
  return oazapfts.ok(oazapfts.fetchJson(`/download/info${QS.query(QS.explode({
449
- key
590
+ key,
591
+ slug
450
592
  }))}`, oazapfts.json({
451
593
  ...opts,
452
594
  method: "POST",
453
595
  body: downloadInfoDto
454
596
  })));
455
597
  }
598
+ /**
599
+ * This endpoint requires the `duplicate.delete` permission.
600
+ */
456
601
  export function deleteDuplicates({ bulkIdsDto }, opts) {
457
602
  return oazapfts.ok(oazapfts.fetchText("/duplicates", oazapfts.json({
458
603
  ...opts,
@@ -460,17 +605,26 @@ export function deleteDuplicates({ bulkIdsDto }, opts) {
460
605
  body: bulkIdsDto
461
606
  })));
462
607
  }
608
+ /**
609
+ * This endpoint requires the `duplicate.read` permission.
610
+ */
463
611
  export function getAssetDuplicates(opts) {
464
612
  return oazapfts.ok(oazapfts.fetchJson("/duplicates", {
465
613
  ...opts
466
614
  }));
467
615
  }
616
+ /**
617
+ * This endpoint requires the `duplicate.delete` permission.
618
+ */
468
619
  export function deleteDuplicate({ id }, opts) {
469
620
  return oazapfts.ok(oazapfts.fetchText(`/duplicates/${encodeURIComponent(id)}`, {
470
621
  ...opts,
471
622
  method: "DELETE"
472
623
  }));
473
624
  }
625
+ /**
626
+ * This endpoint requires the `face.read` permission.
627
+ */
474
628
  export function getFaces({ id }, opts) {
475
629
  return oazapfts.ok(oazapfts.fetchJson(`/faces${QS.query(QS.explode({
476
630
  id
@@ -478,6 +632,9 @@ export function getFaces({ id }, opts) {
478
632
  ...opts
479
633
  }));
480
634
  }
635
+ /**
636
+ * This endpoint requires the `face.create` permission.
637
+ */
481
638
  export function createFace({ assetFaceCreateDto }, opts) {
482
639
  return oazapfts.ok(oazapfts.fetchText("/faces", oazapfts.json({
483
640
  ...opts,
@@ -485,6 +642,9 @@ export function createFace({ assetFaceCreateDto }, opts) {
485
642
  body: assetFaceCreateDto
486
643
  })));
487
644
  }
645
+ /**
646
+ * This endpoint requires the `face.delete` permission.
647
+ */
488
648
  export function deleteFace({ id, assetFaceDeleteDto }, opts) {
489
649
  return oazapfts.ok(oazapfts.fetchText(`/faces/${encodeURIComponent(id)}`, oazapfts.json({
490
650
  ...opts,
@@ -492,6 +652,9 @@ export function deleteFace({ id, assetFaceDeleteDto }, opts) {
492
652
  body: assetFaceDeleteDto
493
653
  })));
494
654
  }
655
+ /**
656
+ * This endpoint requires the `face.update` permission.
657
+ */
495
658
  export function reassignFacesById({ id, faceDto }, opts) {
496
659
  return oazapfts.ok(oazapfts.fetchJson(`/faces/${encodeURIComponent(id)}`, oazapfts.json({
497
660
  ...opts,
@@ -499,11 +662,17 @@ export function reassignFacesById({ id, faceDto }, opts) {
499
662
  body: faceDto
500
663
  })));
501
664
  }
665
+ /**
666
+ * This endpoint is an admin-only route, and requires the `job.read` permission.
667
+ */
502
668
  export function getAllJobsStatus(opts) {
503
669
  return oazapfts.ok(oazapfts.fetchJson("/jobs", {
504
670
  ...opts
505
671
  }));
506
672
  }
673
+ /**
674
+ * This endpoint is an admin-only route, and requires the `job.create` permission.
675
+ */
507
676
  export function createJob({ jobCreateDto }, opts) {
508
677
  return oazapfts.ok(oazapfts.fetchText("/jobs", oazapfts.json({
509
678
  ...opts,
@@ -511,6 +680,9 @@ export function createJob({ jobCreateDto }, opts) {
511
680
  body: jobCreateDto
512
681
  })));
513
682
  }
683
+ /**
684
+ * This endpoint is an admin-only route, and requires the `job.create` permission.
685
+ */
514
686
  export function sendJobCommand({ id, jobCommandDto }, opts) {
515
687
  return oazapfts.ok(oazapfts.fetchJson(`/jobs/${encodeURIComponent(id)}`, oazapfts.json({
516
688
  ...opts,
@@ -518,11 +690,17 @@ export function sendJobCommand({ id, jobCommandDto }, opts) {
518
690
  body: jobCommandDto
519
691
  })));
520
692
  }
693
+ /**
694
+ * This endpoint is an admin-only route, and requires the `library.read` permission.
695
+ */
521
696
  export function getAllLibraries(opts) {
522
697
  return oazapfts.ok(oazapfts.fetchJson("/libraries", {
523
698
  ...opts
524
699
  }));
525
700
  }
701
+ /**
702
+ * This endpoint is an admin-only route, and requires the `library.create` permission.
703
+ */
526
704
  export function createLibrary({ createLibraryDto }, opts) {
527
705
  return oazapfts.ok(oazapfts.fetchJson("/libraries", oazapfts.json({
528
706
  ...opts,
@@ -530,17 +708,26 @@ export function createLibrary({ createLibraryDto }, opts) {
530
708
  body: createLibraryDto
531
709
  })));
532
710
  }
711
+ /**
712
+ * This endpoint is an admin-only route, and requires the `library.delete` permission.
713
+ */
533
714
  export function deleteLibrary({ id }, opts) {
534
715
  return oazapfts.ok(oazapfts.fetchText(`/libraries/${encodeURIComponent(id)}`, {
535
716
  ...opts,
536
717
  method: "DELETE"
537
718
  }));
538
719
  }
720
+ /**
721
+ * This endpoint is an admin-only route, and requires the `library.read` permission.
722
+ */
539
723
  export function getLibrary({ id }, opts) {
540
724
  return oazapfts.ok(oazapfts.fetchJson(`/libraries/${encodeURIComponent(id)}`, {
541
725
  ...opts
542
726
  }));
543
727
  }
728
+ /**
729
+ * This endpoint is an admin-only route, and requires the `library.update` permission.
730
+ */
544
731
  export function updateLibrary({ id, updateLibraryDto }, opts) {
545
732
  return oazapfts.ok(oazapfts.fetchJson(`/libraries/${encodeURIComponent(id)}`, oazapfts.json({
546
733
  ...opts,
@@ -548,12 +735,18 @@ export function updateLibrary({ id, updateLibraryDto }, opts) {
548
735
  body: updateLibraryDto
549
736
  })));
550
737
  }
738
+ /**
739
+ * This endpoint is an admin-only route, and requires the `library.update` permission.
740
+ */
551
741
  export function scanLibrary({ id }, opts) {
552
742
  return oazapfts.ok(oazapfts.fetchText(`/libraries/${encodeURIComponent(id)}/scan`, {
553
743
  ...opts,
554
744
  method: "POST"
555
745
  }));
556
746
  }
747
+ /**
748
+ * This endpoint is an admin-only route, and requires the `library.statistics` permission.
749
+ */
557
750
  export function getLibraryStatistics({ id }, opts) {
558
751
  return oazapfts.ok(oazapfts.fetchJson(`/libraries/${encodeURIComponent(id)}/statistics`, {
559
752
  ...opts
@@ -566,12 +759,12 @@ export function validate({ id, validateLibraryDto }, opts) {
566
759
  body: validateLibraryDto
567
760
  })));
568
761
  }
569
- export function getMapMarkers({ fileCreatedAfter, fileCreatedBefore, isArchived, isFavorite, withPartners, withSharedAlbums }, opts) {
762
+ export function getMapMarkers({ isArchived, isFavorite, fileCreatedAfter, fileCreatedBefore, withPartners, withSharedAlbums }, opts) {
570
763
  return oazapfts.ok(oazapfts.fetchJson(`/map/markers${QS.query(QS.explode({
571
- fileCreatedAfter,
572
- fileCreatedBefore,
573
764
  isArchived,
574
765
  isFavorite,
766
+ fileCreatedAfter,
767
+ fileCreatedBefore,
575
768
  withPartners,
576
769
  withSharedAlbums
577
770
  }))}`, {
@@ -586,6 +779,9 @@ export function reverseGeocode({ lat, lon }, opts) {
586
779
  ...opts
587
780
  }));
588
781
  }
782
+ /**
783
+ * This endpoint requires the `memory.read` permission.
784
+ */
589
785
  export function searchMemories({ $for, isSaved, isTrashed, $type }, opts) {
590
786
  return oazapfts.ok(oazapfts.fetchJson(`/memories${QS.query(QS.explode({
591
787
  "for": $for,
@@ -596,6 +792,9 @@ export function searchMemories({ $for, isSaved, isTrashed, $type }, opts) {
596
792
  ...opts
597
793
  }));
598
794
  }
795
+ /**
796
+ * This endpoint requires the `memory.create` permission.
797
+ */
599
798
  export function createMemory({ memoryCreateDto }, opts) {
600
799
  return oazapfts.ok(oazapfts.fetchJson("/memories", oazapfts.json({
601
800
  ...opts,
@@ -603,6 +802,9 @@ export function createMemory({ memoryCreateDto }, opts) {
603
802
  body: memoryCreateDto
604
803
  })));
605
804
  }
805
+ /**
806
+ * This endpoint requires the `memory.statistics` permission.
807
+ */
606
808
  export function memoriesStatistics({ $for, isSaved, isTrashed, $type }, opts) {
607
809
  return oazapfts.ok(oazapfts.fetchJson(`/memories/statistics${QS.query(QS.explode({
608
810
  "for": $for,
@@ -613,17 +815,26 @@ export function memoriesStatistics({ $for, isSaved, isTrashed, $type }, opts) {
613
815
  ...opts
614
816
  }));
615
817
  }
818
+ /**
819
+ * This endpoint requires the `memory.delete` permission.
820
+ */
616
821
  export function deleteMemory({ id }, opts) {
617
822
  return oazapfts.ok(oazapfts.fetchText(`/memories/${encodeURIComponent(id)}`, {
618
823
  ...opts,
619
824
  method: "DELETE"
620
825
  }));
621
826
  }
827
+ /**
828
+ * This endpoint requires the `memory.read` permission.
829
+ */
622
830
  export function getMemory({ id }, opts) {
623
831
  return oazapfts.ok(oazapfts.fetchJson(`/memories/${encodeURIComponent(id)}`, {
624
832
  ...opts
625
833
  }));
626
834
  }
835
+ /**
836
+ * This endpoint requires the `memory.update` permission.
837
+ */
627
838
  export function updateMemory({ id, memoryUpdateDto }, opts) {
628
839
  return oazapfts.ok(oazapfts.fetchJson(`/memories/${encodeURIComponent(id)}`, oazapfts.json({
629
840
  ...opts,
@@ -631,6 +842,9 @@ export function updateMemory({ id, memoryUpdateDto }, opts) {
631
842
  body: memoryUpdateDto
632
843
  })));
633
844
  }
845
+ /**
846
+ * This endpoint requires the `memoryAsset.delete` permission.
847
+ */
634
848
  export function removeMemoryAssets({ id, bulkIdsDto }, opts) {
635
849
  return oazapfts.ok(oazapfts.fetchJson(`/memories/${encodeURIComponent(id)}/assets`, oazapfts.json({
636
850
  ...opts,
@@ -638,6 +852,9 @@ export function removeMemoryAssets({ id, bulkIdsDto }, opts) {
638
852
  body: bulkIdsDto
639
853
  })));
640
854
  }
855
+ /**
856
+ * This endpoint requires the `memoryAsset.create` permission.
857
+ */
641
858
  export function addMemoryAssets({ id, bulkIdsDto }, opts) {
642
859
  return oazapfts.ok(oazapfts.fetchJson(`/memories/${encodeURIComponent(id)}/assets`, oazapfts.json({
643
860
  ...opts,
@@ -645,6 +862,9 @@ export function addMemoryAssets({ id, bulkIdsDto }, opts) {
645
862
  body: bulkIdsDto
646
863
  })));
647
864
  }
865
+ /**
866
+ * This endpoint requires the `notification.delete` permission.
867
+ */
648
868
  export function deleteNotifications({ notificationDeleteAllDto }, opts) {
649
869
  return oazapfts.ok(oazapfts.fetchText("/notifications", oazapfts.json({
650
870
  ...opts,
@@ -652,6 +872,9 @@ export function deleteNotifications({ notificationDeleteAllDto }, opts) {
652
872
  body: notificationDeleteAllDto
653
873
  })));
654
874
  }
875
+ /**
876
+ * This endpoint requires the `notification.read` permission.
877
+ */
655
878
  export function getNotifications({ id, level, $type, unread }, opts) {
656
879
  return oazapfts.ok(oazapfts.fetchJson(`/notifications${QS.query(QS.explode({
657
880
  id,
@@ -662,6 +885,9 @@ export function getNotifications({ id, level, $type, unread }, opts) {
662
885
  ...opts
663
886
  }));
664
887
  }
888
+ /**
889
+ * This endpoint requires the `notification.update` permission.
890
+ */
665
891
  export function updateNotifications({ notificationUpdateAllDto }, opts) {
666
892
  return oazapfts.ok(oazapfts.fetchText("/notifications", oazapfts.json({
667
893
  ...opts,
@@ -669,17 +895,26 @@ export function updateNotifications({ notificationUpdateAllDto }, opts) {
669
895
  body: notificationUpdateAllDto
670
896
  })));
671
897
  }
898
+ /**
899
+ * This endpoint requires the `notification.delete` permission.
900
+ */
672
901
  export function deleteNotification({ id }, opts) {
673
902
  return oazapfts.ok(oazapfts.fetchText(`/notifications/${encodeURIComponent(id)}`, {
674
903
  ...opts,
675
904
  method: "DELETE"
676
905
  }));
677
906
  }
907
+ /**
908
+ * This endpoint requires the `notification.read` permission.
909
+ */
678
910
  export function getNotification({ id }, opts) {
679
911
  return oazapfts.ok(oazapfts.fetchJson(`/notifications/${encodeURIComponent(id)}`, {
680
912
  ...opts
681
913
  }));
682
914
  }
915
+ /**
916
+ * This endpoint requires the `notification.update` permission.
917
+ */
683
918
  export function updateNotification({ id, notificationUpdateDto }, opts) {
684
919
  return oazapfts.ok(oazapfts.fetchJson(`/notifications/${encodeURIComponent(id)}`, oazapfts.json({
685
920
  ...opts,
@@ -719,6 +954,9 @@ export function unlinkOAuthAccount(opts) {
719
954
  method: "POST"
720
955
  }));
721
956
  }
957
+ /**
958
+ * This endpoint requires the `partner.read` permission.
959
+ */
722
960
  export function getPartners({ direction }, opts) {
723
961
  return oazapfts.ok(oazapfts.fetchJson(`/partners${QS.query(QS.explode({
724
962
  direction
@@ -726,18 +964,27 @@ export function getPartners({ direction }, opts) {
726
964
  ...opts
727
965
  }));
728
966
  }
967
+ /**
968
+ * This endpoint requires the `partner.delete` permission.
969
+ */
729
970
  export function removePartner({ id }, opts) {
730
971
  return oazapfts.ok(oazapfts.fetchText(`/partners/${encodeURIComponent(id)}`, {
731
972
  ...opts,
732
973
  method: "DELETE"
733
974
  }));
734
975
  }
976
+ /**
977
+ * This endpoint requires the `partner.create` permission.
978
+ */
735
979
  export function createPartner({ id }, opts) {
736
980
  return oazapfts.ok(oazapfts.fetchJson(`/partners/${encodeURIComponent(id)}`, {
737
981
  ...opts,
738
982
  method: "POST"
739
983
  }));
740
984
  }
985
+ /**
986
+ * This endpoint requires the `partner.update` permission.
987
+ */
741
988
  export function updatePartner({ id, updatePartnerDto }, opts) {
742
989
  return oazapfts.ok(oazapfts.fetchJson(`/partners/${encodeURIComponent(id)}`, oazapfts.json({
743
990
  ...opts,
@@ -745,6 +992,9 @@ export function updatePartner({ id, updatePartnerDto }, opts) {
745
992
  body: updatePartnerDto
746
993
  })));
747
994
  }
995
+ /**
996
+ * This endpoint requires the `person.delete` permission.
997
+ */
748
998
  export function deletePeople({ bulkIdsDto }, opts) {
749
999
  return oazapfts.ok(oazapfts.fetchText("/people", oazapfts.json({
750
1000
  ...opts,
@@ -752,6 +1002,9 @@ export function deletePeople({ bulkIdsDto }, opts) {
752
1002
  body: bulkIdsDto
753
1003
  })));
754
1004
  }
1005
+ /**
1006
+ * This endpoint requires the `person.read` permission.
1007
+ */
755
1008
  export function getAllPeople({ closestAssetId, closestPersonId, page, size, withHidden }, opts) {
756
1009
  return oazapfts.ok(oazapfts.fetchJson(`/people${QS.query(QS.explode({
757
1010
  closestAssetId,
@@ -763,6 +1016,9 @@ export function getAllPeople({ closestAssetId, closestPersonId, page, size, with
763
1016
  ...opts
764
1017
  }));
765
1018
  }
1019
+ /**
1020
+ * This endpoint requires the `person.create` permission.
1021
+ */
766
1022
  export function createPerson({ personCreateDto }, opts) {
767
1023
  return oazapfts.ok(oazapfts.fetchJson("/people", oazapfts.json({
768
1024
  ...opts,
@@ -770,6 +1026,9 @@ export function createPerson({ personCreateDto }, opts) {
770
1026
  body: personCreateDto
771
1027
  })));
772
1028
  }
1029
+ /**
1030
+ * This endpoint requires the `person.update` permission.
1031
+ */
773
1032
  export function updatePeople({ peopleUpdateDto }, opts) {
774
1033
  return oazapfts.ok(oazapfts.fetchJson("/people", oazapfts.json({
775
1034
  ...opts,
@@ -777,17 +1036,26 @@ export function updatePeople({ peopleUpdateDto }, opts) {
777
1036
  body: peopleUpdateDto
778
1037
  })));
779
1038
  }
1039
+ /**
1040
+ * This endpoint requires the `person.delete` permission.
1041
+ */
780
1042
  export function deletePerson({ id }, opts) {
781
1043
  return oazapfts.ok(oazapfts.fetchText(`/people/${encodeURIComponent(id)}`, {
782
1044
  ...opts,
783
1045
  method: "DELETE"
784
1046
  }));
785
1047
  }
1048
+ /**
1049
+ * This endpoint requires the `person.read` permission.
1050
+ */
786
1051
  export function getPerson({ id }, opts) {
787
1052
  return oazapfts.ok(oazapfts.fetchJson(`/people/${encodeURIComponent(id)}`, {
788
1053
  ...opts
789
1054
  }));
790
1055
  }
1056
+ /**
1057
+ * This endpoint requires the `person.update` permission.
1058
+ */
791
1059
  export function updatePerson({ id, personUpdateDto }, opts) {
792
1060
  return oazapfts.ok(oazapfts.fetchJson(`/people/${encodeURIComponent(id)}`, oazapfts.json({
793
1061
  ...opts,
@@ -795,6 +1063,9 @@ export function updatePerson({ id, personUpdateDto }, opts) {
795
1063
  body: personUpdateDto
796
1064
  })));
797
1065
  }
1066
+ /**
1067
+ * This endpoint requires the `person.merge` permission.
1068
+ */
798
1069
  export function mergePerson({ id, mergePersonDto }, opts) {
799
1070
  return oazapfts.ok(oazapfts.fetchJson(`/people/${encodeURIComponent(id)}/merge`, oazapfts.json({
800
1071
  ...opts,
@@ -802,6 +1073,9 @@ export function mergePerson({ id, mergePersonDto }, opts) {
802
1073
  body: mergePersonDto
803
1074
  })));
804
1075
  }
1076
+ /**
1077
+ * This endpoint requires the `person.reassign` permission.
1078
+ */
805
1079
  export function reassignFaces({ id, assetFaceUpdateDto }, opts) {
806
1080
  return oazapfts.ok(oazapfts.fetchJson(`/people/${encodeURIComponent(id)}/reassign`, oazapfts.json({
807
1081
  ...opts,
@@ -809,26 +1083,82 @@ export function reassignFaces({ id, assetFaceUpdateDto }, opts) {
809
1083
  body: assetFaceUpdateDto
810
1084
  })));
811
1085
  }
1086
+ /**
1087
+ * This endpoint requires the `person.statistics` permission.
1088
+ */
812
1089
  export function getPersonStatistics({ id }, opts) {
813
1090
  return oazapfts.ok(oazapfts.fetchJson(`/people/${encodeURIComponent(id)}/statistics`, {
814
1091
  ...opts
815
1092
  }));
816
1093
  }
1094
+ /**
1095
+ * This endpoint requires the `person.read` permission.
1096
+ */
817
1097
  export function getPersonThumbnail({ id }, opts) {
818
1098
  return oazapfts.ok(oazapfts.fetchBlob(`/people/${encodeURIComponent(id)}/thumbnail`, {
819
1099
  ...opts
820
1100
  }));
821
1101
  }
1102
+ /**
1103
+ * This endpoint requires the `asset.read` permission.
1104
+ */
822
1105
  export function getAssetsByCity(opts) {
823
1106
  return oazapfts.ok(oazapfts.fetchJson("/search/cities", {
824
1107
  ...opts
825
1108
  }));
826
1109
  }
1110
+ /**
1111
+ * This endpoint requires the `asset.read` permission.
1112
+ */
827
1113
  export function getExploreData(opts) {
828
1114
  return oazapfts.ok(oazapfts.fetchJson("/search/explore", {
829
1115
  ...opts
830
1116
  }));
831
1117
  }
1118
+ /**
1119
+ * This endpoint requires the `asset.read` permission.
1120
+ */
1121
+ export function searchLargeAssets({ albumIds, city, country, createdAfter, createdBefore, deviceId, isEncoded, isFavorite, isMotion, isNotInAlbum, isOffline, lensModel, libraryId, make, minFileSize, model, personIds, rating, size, state, tagIds, takenAfter, takenBefore, trashedAfter, trashedBefore, $type, updatedAfter, updatedBefore, visibility, withDeleted, withExif }, opts) {
1122
+ return oazapfts.ok(oazapfts.fetchJson(`/search/large-assets${QS.query(QS.explode({
1123
+ albumIds,
1124
+ city,
1125
+ country,
1126
+ createdAfter,
1127
+ createdBefore,
1128
+ deviceId,
1129
+ isEncoded,
1130
+ isFavorite,
1131
+ isMotion,
1132
+ isNotInAlbum,
1133
+ isOffline,
1134
+ lensModel,
1135
+ libraryId,
1136
+ make,
1137
+ minFileSize,
1138
+ model,
1139
+ personIds,
1140
+ rating,
1141
+ size,
1142
+ state,
1143
+ tagIds,
1144
+ takenAfter,
1145
+ takenBefore,
1146
+ trashedAfter,
1147
+ trashedBefore,
1148
+ "type": $type,
1149
+ updatedAfter,
1150
+ updatedBefore,
1151
+ visibility,
1152
+ withDeleted,
1153
+ withExif
1154
+ }))}`, {
1155
+ ...opts,
1156
+ method: "POST"
1157
+ }));
1158
+ }
1159
+ /**
1160
+ * This endpoint requires the `asset.read` permission.
1161
+ */
832
1162
  export function searchAssets({ metadataSearchDto }, opts) {
833
1163
  return oazapfts.ok(oazapfts.fetchJson("/search/metadata", oazapfts.json({
834
1164
  ...opts,
@@ -836,6 +1166,9 @@ export function searchAssets({ metadataSearchDto }, opts) {
836
1166
  body: metadataSearchDto
837
1167
  })));
838
1168
  }
1169
+ /**
1170
+ * This endpoint requires the `person.read` permission.
1171
+ */
839
1172
  export function searchPerson({ name, withHidden }, opts) {
840
1173
  return oazapfts.ok(oazapfts.fetchJson(`/search/person${QS.query(QS.explode({
841
1174
  name,
@@ -844,6 +1177,9 @@ export function searchPerson({ name, withHidden }, opts) {
844
1177
  ...opts
845
1178
  }));
846
1179
  }
1180
+ /**
1181
+ * This endpoint requires the `asset.read` permission.
1182
+ */
847
1183
  export function searchPlaces({ name }, opts) {
848
1184
  return oazapfts.ok(oazapfts.fetchJson(`/search/places${QS.query(QS.explode({
849
1185
  name
@@ -851,6 +1187,9 @@ export function searchPlaces({ name }, opts) {
851
1187
  ...opts
852
1188
  }));
853
1189
  }
1190
+ /**
1191
+ * This endpoint requires the `asset.read` permission.
1192
+ */
854
1193
  export function searchRandom({ randomSearchDto }, opts) {
855
1194
  return oazapfts.ok(oazapfts.fetchJson("/search/random", oazapfts.json({
856
1195
  ...opts,
@@ -858,6 +1197,9 @@ export function searchRandom({ randomSearchDto }, opts) {
858
1197
  body: randomSearchDto
859
1198
  })));
860
1199
  }
1200
+ /**
1201
+ * This endpoint requires the `asset.read` permission.
1202
+ */
861
1203
  export function searchSmart({ smartSearchDto }, opts) {
862
1204
  return oazapfts.ok(oazapfts.fetchJson("/search/smart", oazapfts.json({
863
1205
  ...opts,
@@ -865,6 +1207,9 @@ export function searchSmart({ smartSearchDto }, opts) {
865
1207
  body: smartSearchDto
866
1208
  })));
867
1209
  }
1210
+ /**
1211
+ * This endpoint requires the `asset.statistics` permission.
1212
+ */
868
1213
  export function searchAssetStatistics({ statisticsSearchDto }, opts) {
869
1214
  return oazapfts.ok(oazapfts.fetchJson("/search/statistics", oazapfts.json({
870
1215
  ...opts,
@@ -872,6 +1217,9 @@ export function searchAssetStatistics({ statisticsSearchDto }, opts) {
872
1217
  body: statisticsSearchDto
873
1218
  })));
874
1219
  }
1220
+ /**
1221
+ * This endpoint requires the `asset.read` permission.
1222
+ */
875
1223
  export function getSearchSuggestions({ country, includeNull, make, model, state, $type }, opts) {
876
1224
  return oazapfts.ok(oazapfts.fetchJson(`/search/suggestions${QS.query(QS.explode({
877
1225
  country,
@@ -884,11 +1232,17 @@ export function getSearchSuggestions({ country, includeNull, make, model, state,
884
1232
  ...opts
885
1233
  }));
886
1234
  }
1235
+ /**
1236
+ * This endpoint requires the `server.about` permission.
1237
+ */
887
1238
  export function getAboutInfo(opts) {
888
1239
  return oazapfts.ok(oazapfts.fetchJson("/server/about", {
889
1240
  ...opts
890
1241
  }));
891
1242
  }
1243
+ /**
1244
+ * This endpoint requires the `server.apkLinks` permission.
1245
+ */
892
1246
  export function getApkLinks(opts) {
893
1247
  return oazapfts.ok(oazapfts.fetchJson("/server/apk-links", {
894
1248
  ...opts
@@ -904,17 +1258,26 @@ export function getServerFeatures(opts) {
904
1258
  ...opts
905
1259
  }));
906
1260
  }
1261
+ /**
1262
+ * This endpoint is an admin-only route, and requires the `serverLicense.delete` permission.
1263
+ */
907
1264
  export function deleteServerLicense(opts) {
908
1265
  return oazapfts.ok(oazapfts.fetchText("/server/license", {
909
1266
  ...opts,
910
1267
  method: "DELETE"
911
1268
  }));
912
1269
  }
1270
+ /**
1271
+ * This endpoint is an admin-only route, and requires the `serverLicense.read` permission.
1272
+ */
913
1273
  export function getServerLicense(opts) {
914
1274
  return oazapfts.ok(oazapfts.fetchJson("/server/license", {
915
1275
  ...opts
916
1276
  }));
917
1277
  }
1278
+ /**
1279
+ * This endpoint is an admin-only route, and requires the `serverLicense.update` permission.
1280
+ */
918
1281
  export function setServerLicense({ licenseKeyDto }, opts) {
919
1282
  return oazapfts.ok(oazapfts.fetchJson("/server/license", oazapfts.json({
920
1283
  ...opts,
@@ -932,11 +1295,17 @@ export function pingServer(opts) {
932
1295
  ...opts
933
1296
  }));
934
1297
  }
1298
+ /**
1299
+ * This endpoint is an admin-only route, and requires the `server.statistics` permission.
1300
+ */
935
1301
  export function getServerStatistics(opts) {
936
1302
  return oazapfts.ok(oazapfts.fetchJson("/server/statistics", {
937
1303
  ...opts
938
1304
  }));
939
1305
  }
1306
+ /**
1307
+ * This endpoint requires the `server.storage` permission.
1308
+ */
940
1309
  export function getStorage(opts) {
941
1310
  return oazapfts.ok(oazapfts.fetchJson("/server/storage", {
942
1311
  ...opts
@@ -962,17 +1331,26 @@ export function getVersionHistory(opts) {
962
1331
  ...opts
963
1332
  }));
964
1333
  }
1334
+ /**
1335
+ * This endpoint requires the `session.delete` permission.
1336
+ */
965
1337
  export function deleteAllSessions(opts) {
966
1338
  return oazapfts.ok(oazapfts.fetchText("/sessions", {
967
1339
  ...opts,
968
1340
  method: "DELETE"
969
1341
  }));
970
1342
  }
1343
+ /**
1344
+ * This endpoint requires the `session.read` permission.
1345
+ */
971
1346
  export function getSessions(opts) {
972
1347
  return oazapfts.ok(oazapfts.fetchJson("/sessions", {
973
1348
  ...opts
974
1349
  }));
975
1350
  }
1351
+ /**
1352
+ * This endpoint requires the `session.create` permission.
1353
+ */
976
1354
  export function createSession({ sessionCreateDto }, opts) {
977
1355
  return oazapfts.ok(oazapfts.fetchJson("/sessions", oazapfts.json({
978
1356
  ...opts,
@@ -980,12 +1358,18 @@ export function createSession({ sessionCreateDto }, opts) {
980
1358
  body: sessionCreateDto
981
1359
  })));
982
1360
  }
1361
+ /**
1362
+ * This endpoint requires the `session.delete` permission.
1363
+ */
983
1364
  export function deleteSession({ id }, opts) {
984
1365
  return oazapfts.ok(oazapfts.fetchText(`/sessions/${encodeURIComponent(id)}`, {
985
1366
  ...opts,
986
1367
  method: "DELETE"
987
1368
  }));
988
1369
  }
1370
+ /**
1371
+ * This endpoint requires the `session.update` permission.
1372
+ */
989
1373
  export function updateSession({ id, sessionUpdateDto }, opts) {
990
1374
  return oazapfts.ok(oazapfts.fetchJson(`/sessions/${encodeURIComponent(id)}`, oazapfts.json({
991
1375
  ...opts,
@@ -993,12 +1377,18 @@ export function updateSession({ id, sessionUpdateDto }, opts) {
993
1377
  body: sessionUpdateDto
994
1378
  })));
995
1379
  }
1380
+ /**
1381
+ * This endpoint requires the `session.lock` permission.
1382
+ */
996
1383
  export function lockSession({ id }, opts) {
997
1384
  return oazapfts.ok(oazapfts.fetchText(`/sessions/${encodeURIComponent(id)}/lock`, {
998
1385
  ...opts,
999
1386
  method: "POST"
1000
1387
  }));
1001
1388
  }
1389
+ /**
1390
+ * This endpoint requires the `sharedLink.read` permission.
1391
+ */
1002
1392
  export function getAllSharedLinks({ albumId }, opts) {
1003
1393
  return oazapfts.ok(oazapfts.fetchJson(`/shared-links${QS.query(QS.explode({
1004
1394
  albumId
@@ -1006,6 +1396,9 @@ export function getAllSharedLinks({ albumId }, opts) {
1006
1396
  ...opts
1007
1397
  }));
1008
1398
  }
1399
+ /**
1400
+ * This endpoint requires the `sharedLink.create` permission.
1401
+ */
1009
1402
  export function createSharedLink({ sharedLinkCreateDto }, opts) {
1010
1403
  return oazapfts.ok(oazapfts.fetchJson("/shared-links", oazapfts.json({
1011
1404
  ...opts,
@@ -1013,26 +1406,36 @@ export function createSharedLink({ sharedLinkCreateDto }, opts) {
1013
1406
  body: sharedLinkCreateDto
1014
1407
  })));
1015
1408
  }
1016
- export function getMySharedLink({ key, password, token }, opts) {
1409
+ export function getMySharedLink({ password, token, key, slug }, opts) {
1017
1410
  return oazapfts.ok(oazapfts.fetchJson(`/shared-links/me${QS.query(QS.explode({
1018
- key,
1019
1411
  password,
1020
- token
1412
+ token,
1413
+ key,
1414
+ slug
1021
1415
  }))}`, {
1022
1416
  ...opts
1023
1417
  }));
1024
1418
  }
1419
+ /**
1420
+ * This endpoint requires the `sharedLink.delete` permission.
1421
+ */
1025
1422
  export function removeSharedLink({ id }, opts) {
1026
1423
  return oazapfts.ok(oazapfts.fetchText(`/shared-links/${encodeURIComponent(id)}`, {
1027
1424
  ...opts,
1028
1425
  method: "DELETE"
1029
1426
  }));
1030
1427
  }
1428
+ /**
1429
+ * This endpoint requires the `sharedLink.read` permission.
1430
+ */
1031
1431
  export function getSharedLinkById({ id }, opts) {
1032
1432
  return oazapfts.ok(oazapfts.fetchJson(`/shared-links/${encodeURIComponent(id)}`, {
1033
1433
  ...opts
1034
1434
  }));
1035
1435
  }
1436
+ /**
1437
+ * This endpoint requires the `sharedLink.update` permission.
1438
+ */
1036
1439
  export function updateSharedLink({ id, sharedLinkEditDto }, opts) {
1037
1440
  return oazapfts.ok(oazapfts.fetchJson(`/shared-links/${encodeURIComponent(id)}`, oazapfts.json({
1038
1441
  ...opts,
@@ -1040,24 +1443,29 @@ export function updateSharedLink({ id, sharedLinkEditDto }, opts) {
1040
1443
  body: sharedLinkEditDto
1041
1444
  })));
1042
1445
  }
1043
- export function removeSharedLinkAssets({ id, key, assetIdsDto }, opts) {
1446
+ export function removeSharedLinkAssets({ id, key, slug, assetIdsDto }, opts) {
1044
1447
  return oazapfts.ok(oazapfts.fetchJson(`/shared-links/${encodeURIComponent(id)}/assets${QS.query(QS.explode({
1045
- key
1448
+ key,
1449
+ slug
1046
1450
  }))}`, oazapfts.json({
1047
1451
  ...opts,
1048
1452
  method: "DELETE",
1049
1453
  body: assetIdsDto
1050
1454
  })));
1051
1455
  }
1052
- export function addSharedLinkAssets({ id, key, assetIdsDto }, opts) {
1456
+ export function addSharedLinkAssets({ id, key, slug, assetIdsDto }, opts) {
1053
1457
  return oazapfts.ok(oazapfts.fetchJson(`/shared-links/${encodeURIComponent(id)}/assets${QS.query(QS.explode({
1054
- key
1458
+ key,
1459
+ slug
1055
1460
  }))}`, oazapfts.json({
1056
1461
  ...opts,
1057
1462
  method: "PUT",
1058
1463
  body: assetIdsDto
1059
1464
  })));
1060
1465
  }
1466
+ /**
1467
+ * This endpoint requires the `stack.delete` permission.
1468
+ */
1061
1469
  export function deleteStacks({ bulkIdsDto }, opts) {
1062
1470
  return oazapfts.ok(oazapfts.fetchText("/stacks", oazapfts.json({
1063
1471
  ...opts,
@@ -1065,6 +1473,9 @@ export function deleteStacks({ bulkIdsDto }, opts) {
1065
1473
  body: bulkIdsDto
1066
1474
  })));
1067
1475
  }
1476
+ /**
1477
+ * This endpoint requires the `stack.read` permission.
1478
+ */
1068
1479
  export function searchStacks({ primaryAssetId }, opts) {
1069
1480
  return oazapfts.ok(oazapfts.fetchJson(`/stacks${QS.query(QS.explode({
1070
1481
  primaryAssetId
@@ -1072,6 +1483,9 @@ export function searchStacks({ primaryAssetId }, opts) {
1072
1483
  ...opts
1073
1484
  }));
1074
1485
  }
1486
+ /**
1487
+ * This endpoint requires the `stack.create` permission.
1488
+ */
1075
1489
  export function createStack({ stackCreateDto }, opts) {
1076
1490
  return oazapfts.ok(oazapfts.fetchJson("/stacks", oazapfts.json({
1077
1491
  ...opts,
@@ -1079,17 +1493,26 @@ export function createStack({ stackCreateDto }, opts) {
1079
1493
  body: stackCreateDto
1080
1494
  })));
1081
1495
  }
1496
+ /**
1497
+ * This endpoint requires the `stack.delete` permission.
1498
+ */
1082
1499
  export function deleteStack({ id }, opts) {
1083
1500
  return oazapfts.ok(oazapfts.fetchText(`/stacks/${encodeURIComponent(id)}`, {
1084
1501
  ...opts,
1085
1502
  method: "DELETE"
1086
1503
  }));
1087
1504
  }
1505
+ /**
1506
+ * This endpoint requires the `stack.read` permission.
1507
+ */
1088
1508
  export function getStack({ id }, opts) {
1089
1509
  return oazapfts.ok(oazapfts.fetchJson(`/stacks/${encodeURIComponent(id)}`, {
1090
1510
  ...opts
1091
1511
  }));
1092
1512
  }
1513
+ /**
1514
+ * This endpoint requires the `stack.update` permission.
1515
+ */
1093
1516
  export function updateStack({ id, stackUpdateDto }, opts) {
1094
1517
  return oazapfts.ok(oazapfts.fetchJson(`/stacks/${encodeURIComponent(id)}`, oazapfts.json({
1095
1518
  ...opts,
@@ -1097,12 +1520,18 @@ export function updateStack({ id, stackUpdateDto }, opts) {
1097
1520
  body: stackUpdateDto
1098
1521
  })));
1099
1522
  }
1523
+ /**
1524
+ * This endpoint requires the `stack.update` permission.
1525
+ */
1100
1526
  export function removeAssetFromStack({ assetId, id }, opts) {
1101
1527
  return oazapfts.ok(oazapfts.fetchText(`/stacks/${encodeURIComponent(id)}/assets/${encodeURIComponent(assetId)}`, {
1102
1528
  ...opts,
1103
1529
  method: "DELETE"
1104
1530
  }));
1105
1531
  }
1532
+ /**
1533
+ * This endpoint requires the `syncCheckpoint.delete` permission.
1534
+ */
1106
1535
  export function deleteSyncAck({ syncAckDeleteDto }, opts) {
1107
1536
  return oazapfts.ok(oazapfts.fetchText("/sync/ack", oazapfts.json({
1108
1537
  ...opts,
@@ -1110,11 +1539,17 @@ export function deleteSyncAck({ syncAckDeleteDto }, opts) {
1110
1539
  body: syncAckDeleteDto
1111
1540
  })));
1112
1541
  }
1542
+ /**
1543
+ * This endpoint requires the `syncCheckpoint.read` permission.
1544
+ */
1113
1545
  export function getSyncAck(opts) {
1114
1546
  return oazapfts.ok(oazapfts.fetchJson("/sync/ack", {
1115
1547
  ...opts
1116
1548
  }));
1117
1549
  }
1550
+ /**
1551
+ * This endpoint requires the `syncCheckpoint.update` permission.
1552
+ */
1118
1553
  export function sendSyncAck({ syncAckSetDto }, opts) {
1119
1554
  return oazapfts.ok(oazapfts.fetchText("/sync/ack", oazapfts.json({
1120
1555
  ...opts,
@@ -1136,6 +1571,9 @@ export function getFullSyncForUser({ assetFullSyncDto }, opts) {
1136
1571
  body: assetFullSyncDto
1137
1572
  })));
1138
1573
  }
1574
+ /**
1575
+ * This endpoint requires the `sync.stream` permission.
1576
+ */
1139
1577
  export function getSyncStream({ syncStreamDto }, opts) {
1140
1578
  return oazapfts.ok(oazapfts.fetchText("/sync/stream", oazapfts.json({
1141
1579
  ...opts,
@@ -1143,11 +1581,17 @@ export function getSyncStream({ syncStreamDto }, opts) {
1143
1581
  body: syncStreamDto
1144
1582
  })));
1145
1583
  }
1584
+ /**
1585
+ * This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
1586
+ */
1146
1587
  export function getConfig(opts) {
1147
1588
  return oazapfts.ok(oazapfts.fetchJson("/system-config", {
1148
1589
  ...opts
1149
1590
  }));
1150
1591
  }
1592
+ /**
1593
+ * This endpoint is an admin-only route, and requires the `systemConfig.update` permission.
1594
+ */
1151
1595
  export function updateConfig({ systemConfigDto }, opts) {
1152
1596
  return oazapfts.ok(oazapfts.fetchJson("/system-config", oazapfts.json({
1153
1597
  ...opts,
@@ -1155,21 +1599,33 @@ export function updateConfig({ systemConfigDto }, opts) {
1155
1599
  body: systemConfigDto
1156
1600
  })));
1157
1601
  }
1602
+ /**
1603
+ * This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
1604
+ */
1158
1605
  export function getConfigDefaults(opts) {
1159
1606
  return oazapfts.ok(oazapfts.fetchJson("/system-config/defaults", {
1160
1607
  ...opts
1161
1608
  }));
1162
1609
  }
1610
+ /**
1611
+ * This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
1612
+ */
1163
1613
  export function getStorageTemplateOptions(opts) {
1164
1614
  return oazapfts.ok(oazapfts.fetchJson("/system-config/storage-template-options", {
1165
1615
  ...opts
1166
1616
  }));
1167
1617
  }
1618
+ /**
1619
+ * This endpoint is an admin-only route, and requires the `systemMetadata.read` permission.
1620
+ */
1168
1621
  export function getAdminOnboarding(opts) {
1169
1622
  return oazapfts.ok(oazapfts.fetchJson("/system-metadata/admin-onboarding", {
1170
1623
  ...opts
1171
1624
  }));
1172
1625
  }
1626
+ /**
1627
+ * This endpoint is an admin-only route, and requires the `systemMetadata.update` permission.
1628
+ */
1173
1629
  export function updateAdminOnboarding({ adminOnboardingUpdateDto }, opts) {
1174
1630
  return oazapfts.ok(oazapfts.fetchText("/system-metadata/admin-onboarding", oazapfts.json({
1175
1631
  ...opts,
@@ -1177,21 +1633,33 @@ export function updateAdminOnboarding({ adminOnboardingUpdateDto }, opts) {
1177
1633
  body: adminOnboardingUpdateDto
1178
1634
  })));
1179
1635
  }
1636
+ /**
1637
+ * This endpoint is an admin-only route, and requires the `systemMetadata.read` permission.
1638
+ */
1180
1639
  export function getReverseGeocodingState(opts) {
1181
1640
  return oazapfts.ok(oazapfts.fetchJson("/system-metadata/reverse-geocoding-state", {
1182
1641
  ...opts
1183
1642
  }));
1184
1643
  }
1644
+ /**
1645
+ * This endpoint is an admin-only route, and requires the `systemMetadata.read` permission.
1646
+ */
1185
1647
  export function getVersionCheckState(opts) {
1186
1648
  return oazapfts.ok(oazapfts.fetchJson("/system-metadata/version-check-state", {
1187
1649
  ...opts
1188
1650
  }));
1189
1651
  }
1652
+ /**
1653
+ * This endpoint requires the `tag.read` permission.
1654
+ */
1190
1655
  export function getAllTags(opts) {
1191
1656
  return oazapfts.ok(oazapfts.fetchJson("/tags", {
1192
1657
  ...opts
1193
1658
  }));
1194
1659
  }
1660
+ /**
1661
+ * This endpoint requires the `tag.create` permission.
1662
+ */
1195
1663
  export function createTag({ tagCreateDto }, opts) {
1196
1664
  return oazapfts.ok(oazapfts.fetchJson("/tags", oazapfts.json({
1197
1665
  ...opts,
@@ -1199,6 +1667,9 @@ export function createTag({ tagCreateDto }, opts) {
1199
1667
  body: tagCreateDto
1200
1668
  })));
1201
1669
  }
1670
+ /**
1671
+ * This endpoint requires the `tag.create` permission.
1672
+ */
1202
1673
  export function upsertTags({ tagUpsertDto }, opts) {
1203
1674
  return oazapfts.ok(oazapfts.fetchJson("/tags", oazapfts.json({
1204
1675
  ...opts,
@@ -1206,6 +1677,9 @@ export function upsertTags({ tagUpsertDto }, opts) {
1206
1677
  body: tagUpsertDto
1207
1678
  })));
1208
1679
  }
1680
+ /**
1681
+ * This endpoint requires the `tag.asset` permission.
1682
+ */
1209
1683
  export function bulkTagAssets({ tagBulkAssetsDto }, opts) {
1210
1684
  return oazapfts.ok(oazapfts.fetchJson("/tags/assets", oazapfts.json({
1211
1685
  ...opts,
@@ -1213,17 +1687,26 @@ export function bulkTagAssets({ tagBulkAssetsDto }, opts) {
1213
1687
  body: tagBulkAssetsDto
1214
1688
  })));
1215
1689
  }
1690
+ /**
1691
+ * This endpoint requires the `tag.delete` permission.
1692
+ */
1216
1693
  export function deleteTag({ id }, opts) {
1217
1694
  return oazapfts.ok(oazapfts.fetchText(`/tags/${encodeURIComponent(id)}`, {
1218
1695
  ...opts,
1219
1696
  method: "DELETE"
1220
1697
  }));
1221
1698
  }
1699
+ /**
1700
+ * This endpoint requires the `tag.read` permission.
1701
+ */
1222
1702
  export function getTagById({ id }, opts) {
1223
1703
  return oazapfts.ok(oazapfts.fetchJson(`/tags/${encodeURIComponent(id)}`, {
1224
1704
  ...opts
1225
1705
  }));
1226
1706
  }
1707
+ /**
1708
+ * This endpoint requires the `tag.update` permission.
1709
+ */
1227
1710
  export function updateTag({ id, tagUpdateDto }, opts) {
1228
1711
  return oazapfts.ok(oazapfts.fetchJson(`/tags/${encodeURIComponent(id)}`, oazapfts.json({
1229
1712
  ...opts,
@@ -1231,6 +1714,9 @@ export function updateTag({ id, tagUpdateDto }, opts) {
1231
1714
  body: tagUpdateDto
1232
1715
  })));
1233
1716
  }
1717
+ /**
1718
+ * This endpoint requires the `tag.asset` permission.
1719
+ */
1234
1720
  export function untagAssets({ id, bulkIdsDto }, opts) {
1235
1721
  return oazapfts.ok(oazapfts.fetchJson(`/tags/${encodeURIComponent(id)}/assets`, oazapfts.json({
1236
1722
  ...opts,
@@ -1238,6 +1724,9 @@ export function untagAssets({ id, bulkIdsDto }, opts) {
1238
1724
  body: bulkIdsDto
1239
1725
  })));
1240
1726
  }
1727
+ /**
1728
+ * This endpoint requires the `tag.asset` permission.
1729
+ */
1241
1730
  export function tagAssets({ id, bulkIdsDto }, opts) {
1242
1731
  return oazapfts.ok(oazapfts.fetchJson(`/tags/${encodeURIComponent(id)}/assets`, oazapfts.json({
1243
1732
  ...opts,
@@ -1245,7 +1734,10 @@ export function tagAssets({ id, bulkIdsDto }, opts) {
1245
1734
  body: bulkIdsDto
1246
1735
  })));
1247
1736
  }
1248
- export function getTimeBucket({ albumId, isFavorite, isTrashed, key, order, personId, tagId, timeBucket, userId, visibility, withPartners, withStacked }, opts) {
1737
+ /**
1738
+ * This endpoint requires the `asset.read` permission.
1739
+ */
1740
+ export function getTimeBucket({ albumId, isFavorite, isTrashed, key, order, personId, slug, tagId, timeBucket, userId, visibility, withPartners, withStacked }, opts) {
1249
1741
  return oazapfts.ok(oazapfts.fetchJson(`/timeline/bucket${QS.query(QS.explode({
1250
1742
  albumId,
1251
1743
  isFavorite,
@@ -1253,6 +1745,7 @@ export function getTimeBucket({ albumId, isFavorite, isTrashed, key, order, pers
1253
1745
  key,
1254
1746
  order,
1255
1747
  personId,
1748
+ slug,
1256
1749
  tagId,
1257
1750
  timeBucket,
1258
1751
  userId,
@@ -1263,7 +1756,10 @@ export function getTimeBucket({ albumId, isFavorite, isTrashed, key, order, pers
1263
1756
  ...opts
1264
1757
  }));
1265
1758
  }
1266
- export function getTimeBuckets({ albumId, isFavorite, isTrashed, key, order, personId, tagId, userId, visibility, withPartners, withStacked }, opts) {
1759
+ /**
1760
+ * This endpoint requires the `asset.read` permission.
1761
+ */
1762
+ export function getTimeBuckets({ albumId, isFavorite, isTrashed, key, order, personId, slug, tagId, userId, visibility, withPartners, withStacked }, opts) {
1267
1763
  return oazapfts.ok(oazapfts.fetchJson(`/timeline/buckets${QS.query(QS.explode({
1268
1764
  albumId,
1269
1765
  isFavorite,
@@ -1271,6 +1767,7 @@ export function getTimeBuckets({ albumId, isFavorite, isTrashed, key, order, per
1271
1767
  key,
1272
1768
  order,
1273
1769
  personId,
1770
+ slug,
1274
1771
  tagId,
1275
1772
  userId,
1276
1773
  visibility,
@@ -1280,18 +1777,27 @@ export function getTimeBuckets({ albumId, isFavorite, isTrashed, key, order, per
1280
1777
  ...opts
1281
1778
  }));
1282
1779
  }
1780
+ /**
1781
+ * This endpoint requires the `asset.delete` permission.
1782
+ */
1283
1783
  export function emptyTrash(opts) {
1284
1784
  return oazapfts.ok(oazapfts.fetchJson("/trash/empty", {
1285
1785
  ...opts,
1286
1786
  method: "POST"
1287
1787
  }));
1288
1788
  }
1789
+ /**
1790
+ * This endpoint requires the `asset.delete` permission.
1791
+ */
1289
1792
  export function restoreTrash(opts) {
1290
1793
  return oazapfts.ok(oazapfts.fetchJson("/trash/restore", {
1291
1794
  ...opts,
1292
1795
  method: "POST"
1293
1796
  }));
1294
1797
  }
1798
+ /**
1799
+ * This endpoint requires the `asset.delete` permission.
1800
+ */
1295
1801
  export function restoreAssets({ bulkIdsDto }, opts) {
1296
1802
  return oazapfts.ok(oazapfts.fetchJson("/trash/restore/assets", oazapfts.json({
1297
1803
  ...opts,
@@ -1299,16 +1805,25 @@ export function restoreAssets({ bulkIdsDto }, opts) {
1299
1805
  body: bulkIdsDto
1300
1806
  })));
1301
1807
  }
1808
+ /**
1809
+ * This endpoint requires the `user.read` permission.
1810
+ */
1302
1811
  export function searchUsers(opts) {
1303
1812
  return oazapfts.ok(oazapfts.fetchJson("/users", {
1304
1813
  ...opts
1305
1814
  }));
1306
1815
  }
1816
+ /**
1817
+ * This endpoint requires the `user.read` permission.
1818
+ */
1307
1819
  export function getMyUser(opts) {
1308
1820
  return oazapfts.ok(oazapfts.fetchJson("/users/me", {
1309
1821
  ...opts
1310
1822
  }));
1311
1823
  }
1824
+ /**
1825
+ * This endpoint requires the `user.update` permission.
1826
+ */
1312
1827
  export function updateMyUser({ userUpdateMeDto }, opts) {
1313
1828
  return oazapfts.ok(oazapfts.fetchJson("/users/me", oazapfts.json({
1314
1829
  ...opts,
@@ -1316,17 +1831,26 @@ export function updateMyUser({ userUpdateMeDto }, opts) {
1316
1831
  body: userUpdateMeDto
1317
1832
  })));
1318
1833
  }
1834
+ /**
1835
+ * This endpoint requires the `userLicense.delete` permission.
1836
+ */
1319
1837
  export function deleteUserLicense(opts) {
1320
1838
  return oazapfts.ok(oazapfts.fetchText("/users/me/license", {
1321
1839
  ...opts,
1322
1840
  method: "DELETE"
1323
1841
  }));
1324
1842
  }
1843
+ /**
1844
+ * This endpoint requires the `userLicense.read` permission.
1845
+ */
1325
1846
  export function getUserLicense(opts) {
1326
1847
  return oazapfts.ok(oazapfts.fetchJson("/users/me/license", {
1327
1848
  ...opts
1328
1849
  }));
1329
1850
  }
1851
+ /**
1852
+ * This endpoint requires the `userLicense.update` permission.
1853
+ */
1330
1854
  export function setUserLicense({ licenseKeyDto }, opts) {
1331
1855
  return oazapfts.ok(oazapfts.fetchJson("/users/me/license", oazapfts.json({
1332
1856
  ...opts,
@@ -1334,17 +1858,26 @@ export function setUserLicense({ licenseKeyDto }, opts) {
1334
1858
  body: licenseKeyDto
1335
1859
  })));
1336
1860
  }
1861
+ /**
1862
+ * This endpoint requires the `userOnboarding.delete` permission.
1863
+ */
1337
1864
  export function deleteUserOnboarding(opts) {
1338
1865
  return oazapfts.ok(oazapfts.fetchText("/users/me/onboarding", {
1339
1866
  ...opts,
1340
1867
  method: "DELETE"
1341
1868
  }));
1342
1869
  }
1870
+ /**
1871
+ * This endpoint requires the `userOnboarding.read` permission.
1872
+ */
1343
1873
  export function getUserOnboarding(opts) {
1344
1874
  return oazapfts.ok(oazapfts.fetchJson("/users/me/onboarding", {
1345
1875
  ...opts
1346
1876
  }));
1347
1877
  }
1878
+ /**
1879
+ * This endpoint requires the `userOnboarding.update` permission.
1880
+ */
1348
1881
  export function setUserOnboarding({ onboardingDto }, opts) {
1349
1882
  return oazapfts.ok(oazapfts.fetchJson("/users/me/onboarding", oazapfts.json({
1350
1883
  ...opts,
@@ -1352,11 +1885,17 @@ export function setUserOnboarding({ onboardingDto }, opts) {
1352
1885
  body: onboardingDto
1353
1886
  })));
1354
1887
  }
1888
+ /**
1889
+ * This endpoint requires the `userPreference.read` permission.
1890
+ */
1355
1891
  export function getMyPreferences(opts) {
1356
1892
  return oazapfts.ok(oazapfts.fetchJson("/users/me/preferences", {
1357
1893
  ...opts
1358
1894
  }));
1359
1895
  }
1896
+ /**
1897
+ * This endpoint requires the `userPreference.update` permission.
1898
+ */
1360
1899
  export function updateMyPreferences({ userPreferencesUpdateDto }, opts) {
1361
1900
  return oazapfts.ok(oazapfts.fetchJson("/users/me/preferences", oazapfts.json({
1362
1901
  ...opts,
@@ -1364,12 +1903,18 @@ export function updateMyPreferences({ userPreferencesUpdateDto }, opts) {
1364
1903
  body: userPreferencesUpdateDto
1365
1904
  })));
1366
1905
  }
1906
+ /**
1907
+ * This endpoint requires the `userProfileImage.delete` permission.
1908
+ */
1367
1909
  export function deleteProfileImage(opts) {
1368
1910
  return oazapfts.ok(oazapfts.fetchText("/users/profile-image", {
1369
1911
  ...opts,
1370
1912
  method: "DELETE"
1371
1913
  }));
1372
1914
  }
1915
+ /**
1916
+ * This endpoint requires the `userProfileImage.update` permission.
1917
+ */
1373
1918
  export function createProfileImage({ createProfileImageDto }, opts) {
1374
1919
  return oazapfts.ok(oazapfts.fetchJson("/users/profile-image", oazapfts.multipart({
1375
1920
  ...opts,
@@ -1377,11 +1922,17 @@ export function createProfileImage({ createProfileImageDto }, opts) {
1377
1922
  body: createProfileImageDto
1378
1923
  })));
1379
1924
  }
1925
+ /**
1926
+ * This endpoint requires the `user.read` permission.
1927
+ */
1380
1928
  export function getUser({ id }, opts) {
1381
1929
  return oazapfts.ok(oazapfts.fetchJson(`/users/${encodeURIComponent(id)}`, {
1382
1930
  ...opts
1383
1931
  }));
1384
1932
  }
1933
+ /**
1934
+ * This endpoint requires the `userProfileImage.read` permission.
1935
+ */
1385
1936
  export function getProfileImage({ id }, opts) {
1386
1937
  return oazapfts.ok(oazapfts.fetchBlob(`/users/${encodeURIComponent(id)}/profile-image`, {
1387
1938
  ...opts
@@ -1494,25 +2045,35 @@ export var Permission;
1494
2045
  Permission["AssetRead"] = "asset.read";
1495
2046
  Permission["AssetUpdate"] = "asset.update";
1496
2047
  Permission["AssetDelete"] = "asset.delete";
2048
+ Permission["AssetStatistics"] = "asset.statistics";
1497
2049
  Permission["AssetShare"] = "asset.share";
1498
2050
  Permission["AssetView"] = "asset.view";
1499
2051
  Permission["AssetDownload"] = "asset.download";
1500
2052
  Permission["AssetUpload"] = "asset.upload";
2053
+ Permission["AssetReplace"] = "asset.replace";
1501
2054
  Permission["AlbumCreate"] = "album.create";
1502
2055
  Permission["AlbumRead"] = "album.read";
1503
2056
  Permission["AlbumUpdate"] = "album.update";
1504
2057
  Permission["AlbumDelete"] = "album.delete";
1505
2058
  Permission["AlbumStatistics"] = "album.statistics";
1506
- Permission["AlbumAddAsset"] = "album.addAsset";
1507
- Permission["AlbumRemoveAsset"] = "album.removeAsset";
1508
2059
  Permission["AlbumShare"] = "album.share";
1509
2060
  Permission["AlbumDownload"] = "album.download";
2061
+ Permission["AlbumAssetCreate"] = "albumAsset.create";
2062
+ Permission["AlbumAssetDelete"] = "albumAsset.delete";
2063
+ Permission["AlbumUserCreate"] = "albumUser.create";
2064
+ Permission["AlbumUserUpdate"] = "albumUser.update";
2065
+ Permission["AlbumUserDelete"] = "albumUser.delete";
2066
+ Permission["AuthChangePassword"] = "auth.changePassword";
1510
2067
  Permission["AuthDeviceDelete"] = "authDevice.delete";
1511
2068
  Permission["ArchiveRead"] = "archive.read";
2069
+ Permission["DuplicateRead"] = "duplicate.read";
2070
+ Permission["DuplicateDelete"] = "duplicate.delete";
1512
2071
  Permission["FaceCreate"] = "face.create";
1513
2072
  Permission["FaceRead"] = "face.read";
1514
2073
  Permission["FaceUpdate"] = "face.update";
1515
2074
  Permission["FaceDelete"] = "face.delete";
2075
+ Permission["JobCreate"] = "job.create";
2076
+ Permission["JobRead"] = "job.read";
1516
2077
  Permission["LibraryCreate"] = "library.create";
1517
2078
  Permission["LibraryRead"] = "library.read";
1518
2079
  Permission["LibraryUpdate"] = "library.update";
@@ -1524,6 +2085,9 @@ export var Permission;
1524
2085
  Permission["MemoryRead"] = "memory.read";
1525
2086
  Permission["MemoryUpdate"] = "memory.update";
1526
2087
  Permission["MemoryDelete"] = "memory.delete";
2088
+ Permission["MemoryStatistics"] = "memory.statistics";
2089
+ Permission["MemoryAssetCreate"] = "memoryAsset.create";
2090
+ Permission["MemoryAssetDelete"] = "memoryAsset.delete";
1527
2091
  Permission["NotificationCreate"] = "notification.create";
1528
2092
  Permission["NotificationRead"] = "notification.read";
1529
2093
  Permission["NotificationUpdate"] = "notification.update";
@@ -1539,6 +2103,16 @@ export var Permission;
1539
2103
  Permission["PersonStatistics"] = "person.statistics";
1540
2104
  Permission["PersonMerge"] = "person.merge";
1541
2105
  Permission["PersonReassign"] = "person.reassign";
2106
+ Permission["PinCodeCreate"] = "pinCode.create";
2107
+ Permission["PinCodeUpdate"] = "pinCode.update";
2108
+ Permission["PinCodeDelete"] = "pinCode.delete";
2109
+ Permission["ServerAbout"] = "server.about";
2110
+ Permission["ServerApkLinks"] = "server.apkLinks";
2111
+ Permission["ServerStorage"] = "server.storage";
2112
+ Permission["ServerStatistics"] = "server.statistics";
2113
+ Permission["ServerLicenseRead"] = "serverLicense.read";
2114
+ Permission["ServerLicenseUpdate"] = "serverLicense.update";
2115
+ Permission["ServerLicenseDelete"] = "serverLicense.delete";
1542
2116
  Permission["SessionCreate"] = "session.create";
1543
2117
  Permission["SessionRead"] = "session.read";
1544
2118
  Permission["SessionUpdate"] = "session.update";
@@ -1552,6 +2126,10 @@ export var Permission;
1552
2126
  Permission["StackRead"] = "stack.read";
1553
2127
  Permission["StackUpdate"] = "stack.update";
1554
2128
  Permission["StackDelete"] = "stack.delete";
2129
+ Permission["SyncStream"] = "sync.stream";
2130
+ Permission["SyncCheckpointRead"] = "syncCheckpoint.read";
2131
+ Permission["SyncCheckpointUpdate"] = "syncCheckpoint.update";
2132
+ Permission["SyncCheckpointDelete"] = "syncCheckpoint.delete";
1555
2133
  Permission["SystemConfigRead"] = "systemConfig.read";
1556
2134
  Permission["SystemConfigUpdate"] = "systemConfig.update";
1557
2135
  Permission["SystemMetadataRead"] = "systemMetadata.read";
@@ -1561,10 +2139,25 @@ export var Permission;
1561
2139
  Permission["TagUpdate"] = "tag.update";
1562
2140
  Permission["TagDelete"] = "tag.delete";
1563
2141
  Permission["TagAsset"] = "tag.asset";
1564
- Permission["AdminUserCreate"] = "admin.user.create";
1565
- Permission["AdminUserRead"] = "admin.user.read";
1566
- Permission["AdminUserUpdate"] = "admin.user.update";
1567
- Permission["AdminUserDelete"] = "admin.user.delete";
2142
+ Permission["UserRead"] = "user.read";
2143
+ Permission["UserUpdate"] = "user.update";
2144
+ Permission["UserLicenseCreate"] = "userLicense.create";
2145
+ Permission["UserLicenseRead"] = "userLicense.read";
2146
+ Permission["UserLicenseUpdate"] = "userLicense.update";
2147
+ Permission["UserLicenseDelete"] = "userLicense.delete";
2148
+ Permission["UserOnboardingRead"] = "userOnboarding.read";
2149
+ Permission["UserOnboardingUpdate"] = "userOnboarding.update";
2150
+ Permission["UserOnboardingDelete"] = "userOnboarding.delete";
2151
+ Permission["UserPreferenceRead"] = "userPreference.read";
2152
+ Permission["UserPreferenceUpdate"] = "userPreference.update";
2153
+ Permission["UserProfileImageCreate"] = "userProfileImage.create";
2154
+ Permission["UserProfileImageRead"] = "userProfileImage.read";
2155
+ Permission["UserProfileImageUpdate"] = "userProfileImage.update";
2156
+ Permission["UserProfileImageDelete"] = "userProfileImage.delete";
2157
+ Permission["AdminUserCreate"] = "adminUser.create";
2158
+ Permission["AdminUserRead"] = "adminUser.read";
2159
+ Permission["AdminUserUpdate"] = "adminUser.update";
2160
+ Permission["AdminUserDelete"] = "adminUser.delete";
1568
2161
  })(Permission || (Permission = {}));
1569
2162
  export var AssetMediaStatus;
1570
2163
  (function (AssetMediaStatus) {