feat: better endpoint descriptions (#20439)

This commit is contained in:
Jason Rasmussen 2025-07-30 12:29:36 -04:00 committed by GitHub
parent d5a01c0310
commit 749f999f2a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
34 changed files with 1918 additions and 428 deletions

View File

@ -16,7 +16,10 @@ class ActivitiesApi {
final ApiClient apiClient; final ApiClient apiClient;
/// Performs an HTTP 'POST /activities' operation and returns the [Response]. /// This endpoint requires the `activity.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [ActivityCreateDto] activityCreateDto (required): /// * [ActivityCreateDto] activityCreateDto (required):
@ -45,6 +48,8 @@ class ActivitiesApi {
); );
} }
/// This endpoint requires the `activity.create` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [ActivityCreateDto] activityCreateDto (required): /// * [ActivityCreateDto] activityCreateDto (required):
@ -63,7 +68,10 @@ class ActivitiesApi {
return null; return null;
} }
/// Performs an HTTP 'DELETE /activities/{id}' operation and returns the [Response]. /// This endpoint requires the `activity.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -93,6 +101,8 @@ class ActivitiesApi {
); );
} }
/// This endpoint requires the `activity.delete` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -103,7 +113,10 @@ class ActivitiesApi {
} }
} }
/// Performs an HTTP 'GET /activities' operation and returns the [Response]. /// This endpoint requires the `activity.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] albumId (required): /// * [String] albumId (required):
@ -154,6 +167,8 @@ class ActivitiesApi {
); );
} }
/// This endpoint requires the `activity.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] albumId (required): /// * [String] albumId (required):
@ -183,7 +198,10 @@ class ActivitiesApi {
return null; return null;
} }
/// Performs an HTTP 'GET /activities/statistics' operation and returns the [Response]. /// This endpoint requires the `activity.statistics` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] albumId (required): /// * [String] albumId (required):
@ -219,6 +237,8 @@ class ActivitiesApi {
); );
} }
/// This endpoint requires the `activity.statistics` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] albumId (required): /// * [String] albumId (required):

View File

@ -16,7 +16,10 @@ class AlbumsApi {
final ApiClient apiClient; final ApiClient apiClient;
/// Performs an HTTP 'PUT /albums/{id}/assets' operation and returns the [Response]. /// This endpoint requires the `albumAsset.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -59,6 +62,8 @@ class AlbumsApi {
); );
} }
/// This endpoint requires the `albumAsset.create` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -86,7 +91,10 @@ class AlbumsApi {
return null; return null;
} }
/// Performs an HTTP 'PUT /albums/{id}/users' operation and returns the [Response]. /// This endpoint requires the `albumUser.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -118,6 +126,8 @@ class AlbumsApi {
); );
} }
/// This endpoint requires the `albumUser.create` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -138,7 +148,10 @@ class AlbumsApi {
return null; return null;
} }
/// Performs an HTTP 'POST /albums' operation and returns the [Response]. /// This endpoint requires the `album.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [CreateAlbumDto] createAlbumDto (required): /// * [CreateAlbumDto] createAlbumDto (required):
@ -167,6 +180,8 @@ class AlbumsApi {
); );
} }
/// This endpoint requires the `album.create` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [CreateAlbumDto] createAlbumDto (required): /// * [CreateAlbumDto] createAlbumDto (required):
@ -185,7 +200,10 @@ class AlbumsApi {
return null; return null;
} }
/// Performs an HTTP 'DELETE /albums/{id}' operation and returns the [Response]. /// This endpoint requires the `album.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -215,6 +233,8 @@ class AlbumsApi {
); );
} }
/// This endpoint requires the `album.delete` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -225,7 +245,10 @@ class AlbumsApi {
} }
} }
/// Performs an HTTP 'GET /albums/{id}' operation and returns the [Response]. /// This endpoint requires the `album.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -271,6 +294,8 @@ class AlbumsApi {
); );
} }
/// This endpoint requires the `album.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -295,7 +320,9 @@ class AlbumsApi {
return null; return null;
} }
/// Performs an HTTP 'GET /albums/statistics' operation and returns the [Response]. /// This endpoint requires the `album.statistics` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getAlbumStatisticsWithHttpInfo() async { Future<Response> getAlbumStatisticsWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/albums/statistics'; final apiPath = r'/albums/statistics';
@ -321,6 +348,7 @@ class AlbumsApi {
); );
} }
/// This endpoint requires the `album.statistics` permission.
Future<AlbumStatisticsResponseDto?> getAlbumStatistics() async { Future<AlbumStatisticsResponseDto?> getAlbumStatistics() async {
final response = await getAlbumStatisticsWithHttpInfo(); final response = await getAlbumStatisticsWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -336,7 +364,10 @@ class AlbumsApi {
return null; return null;
} }
/// Performs an HTTP 'GET /albums' operation and returns the [Response]. /// This endpoint requires the `album.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] assetId: /// * [String] assetId:
@ -375,6 +406,8 @@ class AlbumsApi {
); );
} }
/// This endpoint requires the `album.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] assetId: /// * [String] assetId:
@ -399,7 +432,10 @@ class AlbumsApi {
return null; return null;
} }
/// Performs an HTTP 'DELETE /albums/{id}/assets' operation and returns the [Response]. /// This endpoint requires the `albumAsset.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -431,6 +467,8 @@ class AlbumsApi {
); );
} }
/// This endpoint requires the `albumAsset.delete` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -454,7 +492,10 @@ class AlbumsApi {
return null; return null;
} }
/// Performs an HTTP 'DELETE /albums/{id}/user/{userId}' operation and returns the [Response]. /// This endpoint requires the `albumUser.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -487,6 +528,8 @@ class AlbumsApi {
); );
} }
/// This endpoint requires the `albumUser.delete` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -499,7 +542,10 @@ class AlbumsApi {
} }
} }
/// Performs an HTTP 'PATCH /albums/{id}' operation and returns the [Response]. /// This endpoint requires the `album.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -531,6 +577,8 @@ class AlbumsApi {
); );
} }
/// This endpoint requires the `album.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -551,7 +599,10 @@ class AlbumsApi {
return null; return null;
} }
/// Performs an HTTP 'PUT /albums/{id}/user/{userId}' operation and returns the [Response]. /// This endpoint requires the `albumUser.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -586,6 +637,8 @@ class AlbumsApi {
); );
} }
/// This endpoint requires the `albumUser.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):

View File

@ -16,7 +16,10 @@ class APIKeysApi {
final ApiClient apiClient; final ApiClient apiClient;
/// Performs an HTTP 'POST /api-keys' operation and returns the [Response]. /// This endpoint requires the `apiKey.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [APIKeyCreateDto] aPIKeyCreateDto (required): /// * [APIKeyCreateDto] aPIKeyCreateDto (required):
@ -45,6 +48,8 @@ class APIKeysApi {
); );
} }
/// This endpoint requires the `apiKey.create` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [APIKeyCreateDto] aPIKeyCreateDto (required): /// * [APIKeyCreateDto] aPIKeyCreateDto (required):
@ -63,7 +68,10 @@ class APIKeysApi {
return null; return null;
} }
/// Performs an HTTP 'DELETE /api-keys/{id}' operation and returns the [Response]. /// This endpoint requires the `apiKey.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -93,6 +101,8 @@ class APIKeysApi {
); );
} }
/// This endpoint requires the `apiKey.delete` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -103,7 +113,10 @@ class APIKeysApi {
} }
} }
/// Performs an HTTP 'GET /api-keys/{id}' operation and returns the [Response]. /// This endpoint requires the `apiKey.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -133,6 +146,8 @@ class APIKeysApi {
); );
} }
/// This endpoint requires the `apiKey.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -151,7 +166,9 @@ class APIKeysApi {
return null; return null;
} }
/// Performs an HTTP 'GET /api-keys' operation and returns the [Response]. /// This endpoint requires the `apiKey.read` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getApiKeysWithHttpInfo() async { Future<Response> getApiKeysWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/api-keys'; final apiPath = r'/api-keys';
@ -177,6 +194,7 @@ class APIKeysApi {
); );
} }
/// This endpoint requires the `apiKey.read` permission.
Future<List<APIKeyResponseDto>?> getApiKeys() async { Future<List<APIKeyResponseDto>?> getApiKeys() async {
final response = await getApiKeysWithHttpInfo(); final response = await getApiKeysWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -195,7 +213,10 @@ class APIKeysApi {
return null; return null;
} }
/// Performs an HTTP 'PUT /api-keys/{id}' operation and returns the [Response]. /// This endpoint requires the `apiKey.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -227,6 +248,8 @@ class APIKeysApi {
); );
} }
/// This endpoint requires the `apiKey.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):

View File

@ -128,7 +128,10 @@ class AssetsApi {
return null; return null;
} }
/// Performs an HTTP 'DELETE /assets' operation and returns the [Response]. /// This endpoint requires the `asset.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [AssetBulkDeleteDto] assetBulkDeleteDto (required): /// * [AssetBulkDeleteDto] assetBulkDeleteDto (required):
@ -157,6 +160,8 @@ class AssetsApi {
); );
} }
/// This endpoint requires the `asset.delete` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [AssetBulkDeleteDto] assetBulkDeleteDto (required): /// * [AssetBulkDeleteDto] assetBulkDeleteDto (required):
@ -167,7 +172,10 @@ class AssetsApi {
} }
} }
/// Performs an HTTP 'GET /assets/{id}/original' operation and returns the [Response]. /// This endpoint requires the `asset.download` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -208,6 +216,8 @@ class AssetsApi {
); );
} }
/// This endpoint requires the `asset.download` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -290,7 +300,10 @@ class AssetsApi {
return null; return null;
} }
/// Performs an HTTP 'GET /assets/{id}' operation and returns the [Response]. /// This endpoint requires the `asset.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -331,6 +344,8 @@ class AssetsApi {
); );
} }
/// This endpoint requires the `asset.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -353,7 +368,10 @@ class AssetsApi {
return null; return null;
} }
/// Performs an HTTP 'GET /assets/statistics' operation and returns the [Response]. /// This endpoint requires the `asset.statistics` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [bool] isFavorite: /// * [bool] isFavorite:
@ -396,6 +414,8 @@ class AssetsApi {
); );
} }
/// This endpoint requires the `asset.statistics` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [bool] isFavorite: /// * [bool] isFavorite:
@ -418,7 +438,7 @@ class AssetsApi {
return null; return null;
} }
/// This property was deprecated in v1.116.0 /// This property was deprecated in v1.116.0. This endpoint requires the `asset.read` permission.
/// ///
/// Note: This method returns the HTTP [Response]. /// Note: This method returns the HTTP [Response].
/// ///
@ -454,7 +474,7 @@ class AssetsApi {
); );
} }
/// This property was deprecated in v1.116.0 /// This property was deprecated in v1.116.0. This endpoint requires the `asset.read` permission.
/// ///
/// Parameters: /// Parameters:
/// ///
@ -477,7 +497,10 @@ class AssetsApi {
return null; return null;
} }
/// Performs an HTTP 'GET /assets/{id}/video/playback' operation and returns the [Response]. /// This endpoint requires the `asset.view` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -518,6 +541,8 @@ class AssetsApi {
); );
} }
/// This endpoint requires the `asset.view` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -542,7 +567,7 @@ class AssetsApi {
/// replaceAsset /// replaceAsset
/// ///
/// Replace the asset with new file, without changing its id /// Replace the asset with new file, without changing its id. This endpoint requires the `asset.replace` permission.
/// ///
/// Note: This method returns the HTTP [Response]. /// Note: This method returns the HTTP [Response].
/// ///
@ -636,7 +661,7 @@ class AssetsApi {
/// replaceAsset /// replaceAsset
/// ///
/// Replace the asset with new file, without changing its id /// Replace the asset with new file, without changing its id. This endpoint requires the `asset.replace` permission.
/// ///
/// Parameters: /// Parameters:
/// ///
@ -713,7 +738,10 @@ class AssetsApi {
} }
} }
/// Performs an HTTP 'PUT /assets/{id}' operation and returns the [Response]. /// This endpoint requires the `asset.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -745,6 +773,8 @@ class AssetsApi {
); );
} }
/// This endpoint requires the `asset.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -765,7 +795,10 @@ class AssetsApi {
return null; return null;
} }
/// Performs an HTTP 'PUT /assets' operation and returns the [Response]. /// This endpoint requires the `asset.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [AssetBulkUpdateDto] assetBulkUpdateDto (required): /// * [AssetBulkUpdateDto] assetBulkUpdateDto (required):
@ -794,6 +827,8 @@ class AssetsApi {
); );
} }
/// This endpoint requires the `asset.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [AssetBulkUpdateDto] assetBulkUpdateDto (required): /// * [AssetBulkUpdateDto] assetBulkUpdateDto (required):
@ -804,7 +839,10 @@ class AssetsApi {
} }
} }
/// Performs an HTTP 'POST /assets' operation and returns the [Response]. /// This endpoint requires the `asset.upload` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [MultipartFile] assetData (required): /// * [MultipartFile] assetData (required):
@ -922,6 +960,8 @@ class AssetsApi {
); );
} }
/// This endpoint requires the `asset.upload` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [MultipartFile] assetData (required): /// * [MultipartFile] assetData (required):
@ -967,7 +1007,10 @@ class AssetsApi {
return null; return null;
} }
/// Performs an HTTP 'GET /assets/{id}/thumbnail' operation and returns the [Response]. /// This endpoint requires the `asset.view` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -1013,6 +1056,8 @@ class AssetsApi {
); );
} }
/// This endpoint requires the `asset.view` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):

View File

@ -16,7 +16,10 @@ class AuthenticationApi {
final ApiClient apiClient; final ApiClient apiClient;
/// Performs an HTTP 'POST /auth/change-password' operation and returns the [Response]. /// This endpoint requires the `auth.changePassword` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [ChangePasswordDto] changePasswordDto (required): /// * [ChangePasswordDto] changePasswordDto (required):
@ -45,6 +48,8 @@ class AuthenticationApi {
); );
} }
/// This endpoint requires the `auth.changePassword` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [ChangePasswordDto] changePasswordDto (required): /// * [ChangePasswordDto] changePasswordDto (required):
@ -63,7 +68,10 @@ class AuthenticationApi {
return null; return null;
} }
/// Performs an HTTP 'PUT /auth/pin-code' operation and returns the [Response]. /// This endpoint requires the `pinCode.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [PinCodeChangeDto] pinCodeChangeDto (required): /// * [PinCodeChangeDto] pinCodeChangeDto (required):
@ -92,6 +100,8 @@ class AuthenticationApi {
); );
} }
/// This endpoint requires the `pinCode.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [PinCodeChangeDto] pinCodeChangeDto (required): /// * [PinCodeChangeDto] pinCodeChangeDto (required):
@ -264,7 +274,10 @@ class AuthenticationApi {
return null; return null;
} }
/// Performs an HTTP 'DELETE /auth/pin-code' operation and returns the [Response]. /// This endpoint requires the `pinCode.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [PinCodeResetDto] pinCodeResetDto (required): /// * [PinCodeResetDto] pinCodeResetDto (required):
@ -293,6 +306,8 @@ class AuthenticationApi {
); );
} }
/// This endpoint requires the `pinCode.delete` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [PinCodeResetDto] pinCodeResetDto (required): /// * [PinCodeResetDto] pinCodeResetDto (required):
@ -303,7 +318,10 @@ class AuthenticationApi {
} }
} }
/// Performs an HTTP 'POST /auth/pin-code' operation and returns the [Response]. /// This endpoint requires the `pinCode.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [PinCodeSetupDto] pinCodeSetupDto (required): /// * [PinCodeSetupDto] pinCodeSetupDto (required):
@ -332,6 +350,8 @@ class AuthenticationApi {
); );
} }
/// This endpoint requires the `pinCode.create` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [PinCodeSetupDto] pinCodeSetupDto (required): /// * [PinCodeSetupDto] pinCodeSetupDto (required):

View File

@ -16,7 +16,7 @@ class DeprecatedApi {
final ApiClient apiClient; final ApiClient apiClient;
/// This property was deprecated in v1.116.0 /// This property was deprecated in v1.116.0. This endpoint requires the `asset.read` permission.
/// ///
/// Note: This method returns the HTTP [Response]. /// Note: This method returns the HTTP [Response].
/// ///
@ -52,7 +52,7 @@ class DeprecatedApi {
); );
} }
/// This property was deprecated in v1.116.0 /// This property was deprecated in v1.116.0. This endpoint requires the `asset.read` permission.
/// ///
/// Parameters: /// Parameters:
/// ///

View File

@ -16,7 +16,10 @@ class DownloadApi {
final ApiClient apiClient; final ApiClient apiClient;
/// Performs an HTTP 'POST /download/archive' operation and returns the [Response]. /// This endpoint requires the `asset.download` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [AssetIdsDto] assetIdsDto (required): /// * [AssetIdsDto] assetIdsDto (required):
@ -56,6 +59,8 @@ class DownloadApi {
); );
} }
/// This endpoint requires the `asset.download` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [AssetIdsDto] assetIdsDto (required): /// * [AssetIdsDto] assetIdsDto (required):
@ -78,7 +83,10 @@ class DownloadApi {
return null; return null;
} }
/// Performs an HTTP 'POST /download/info' operation and returns the [Response]. /// This endpoint requires the `asset.download` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [DownloadInfoDto] downloadInfoDto (required): /// * [DownloadInfoDto] downloadInfoDto (required):
@ -118,6 +126,8 @@ class DownloadApi {
); );
} }
/// This endpoint requires the `asset.download` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [DownloadInfoDto] downloadInfoDto (required): /// * [DownloadInfoDto] downloadInfoDto (required):

View File

@ -16,7 +16,10 @@ class DuplicatesApi {
final ApiClient apiClient; final ApiClient apiClient;
/// Performs an HTTP 'DELETE /duplicates/{id}' operation and returns the [Response]. /// This endpoint requires the `duplicate.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -46,6 +49,8 @@ class DuplicatesApi {
); );
} }
/// This endpoint requires the `duplicate.delete` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -56,7 +61,10 @@ class DuplicatesApi {
} }
} }
/// Performs an HTTP 'DELETE /duplicates' operation and returns the [Response]. /// This endpoint requires the `duplicate.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [BulkIdsDto] bulkIdsDto (required): /// * [BulkIdsDto] bulkIdsDto (required):
@ -85,6 +93,8 @@ class DuplicatesApi {
); );
} }
/// This endpoint requires the `duplicate.delete` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [BulkIdsDto] bulkIdsDto (required): /// * [BulkIdsDto] bulkIdsDto (required):
@ -95,7 +105,9 @@ class DuplicatesApi {
} }
} }
/// Performs an HTTP 'GET /duplicates' operation and returns the [Response]. /// This endpoint requires the `duplicate.read` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getAssetDuplicatesWithHttpInfo() async { Future<Response> getAssetDuplicatesWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/duplicates'; final apiPath = r'/duplicates';
@ -121,6 +133,7 @@ class DuplicatesApi {
); );
} }
/// This endpoint requires the `duplicate.read` permission.
Future<List<DuplicateResponseDto>?> getAssetDuplicates() async { Future<List<DuplicateResponseDto>?> getAssetDuplicates() async {
final response = await getAssetDuplicatesWithHttpInfo(); final response = await getAssetDuplicatesWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {

View File

@ -16,7 +16,10 @@ class FacesApi {
final ApiClient apiClient; final ApiClient apiClient;
/// Performs an HTTP 'POST /faces' operation and returns the [Response]. /// This endpoint requires the `face.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [AssetFaceCreateDto] assetFaceCreateDto (required): /// * [AssetFaceCreateDto] assetFaceCreateDto (required):
@ -45,6 +48,8 @@ class FacesApi {
); );
} }
/// This endpoint requires the `face.create` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [AssetFaceCreateDto] assetFaceCreateDto (required): /// * [AssetFaceCreateDto] assetFaceCreateDto (required):
@ -55,7 +60,10 @@ class FacesApi {
} }
} }
/// Performs an HTTP 'DELETE /faces/{id}' operation and returns the [Response]. /// This endpoint requires the `face.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -87,6 +95,8 @@ class FacesApi {
); );
} }
/// This endpoint requires the `face.delete` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -99,7 +109,10 @@ class FacesApi {
} }
} }
/// Performs an HTTP 'GET /faces' operation and returns the [Response]. /// This endpoint requires the `face.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -130,6 +143,8 @@ class FacesApi {
); );
} }
/// This endpoint requires the `face.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -151,7 +166,10 @@ class FacesApi {
return null; return null;
} }
/// Performs an HTTP 'PUT /faces/{id}' operation and returns the [Response]. /// This endpoint requires the `face.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -183,6 +201,8 @@ class FacesApi {
); );
} }
/// This endpoint requires the `face.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):

View File

@ -16,7 +16,10 @@ class JobsApi {
final ApiClient apiClient; final ApiClient apiClient;
/// Performs an HTTP 'POST /jobs' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `job.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [JobCreateDto] jobCreateDto (required): /// * [JobCreateDto] jobCreateDto (required):
@ -45,6 +48,8 @@ class JobsApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `job.create` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [JobCreateDto] jobCreateDto (required): /// * [JobCreateDto] jobCreateDto (required):
@ -55,7 +60,9 @@ class JobsApi {
} }
} }
/// Performs an HTTP 'GET /jobs' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `job.read` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getAllJobsStatusWithHttpInfo() async { Future<Response> getAllJobsStatusWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/jobs'; final apiPath = r'/jobs';
@ -81,6 +88,7 @@ class JobsApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `job.read` permission.
Future<AllJobStatusResponseDto?> getAllJobsStatus() async { Future<AllJobStatusResponseDto?> getAllJobsStatus() async {
final response = await getAllJobsStatusWithHttpInfo(); final response = await getAllJobsStatusWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -96,7 +104,10 @@ class JobsApi {
return null; return null;
} }
/// Performs an HTTP 'PUT /jobs/{id}' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `job.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [JobName] id (required): /// * [JobName] id (required):
@ -128,6 +139,8 @@ class JobsApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `job.create` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [JobName] id (required): /// * [JobName] id (required):

View File

@ -16,7 +16,10 @@ class LibrariesApi {
final ApiClient apiClient; final ApiClient apiClient;
/// Performs an HTTP 'POST /libraries' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `library.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [CreateLibraryDto] createLibraryDto (required): /// * [CreateLibraryDto] createLibraryDto (required):
@ -45,6 +48,8 @@ class LibrariesApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `library.create` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [CreateLibraryDto] createLibraryDto (required): /// * [CreateLibraryDto] createLibraryDto (required):
@ -63,7 +68,10 @@ class LibrariesApi {
return null; return null;
} }
/// Performs an HTTP 'DELETE /libraries/{id}' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `library.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -93,6 +101,8 @@ class LibrariesApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `library.delete` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -103,7 +113,9 @@ class LibrariesApi {
} }
} }
/// Performs an HTTP 'GET /libraries' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `library.read` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getAllLibrariesWithHttpInfo() async { Future<Response> getAllLibrariesWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/libraries'; final apiPath = r'/libraries';
@ -129,6 +141,7 @@ class LibrariesApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `library.read` permission.
Future<List<LibraryResponseDto>?> getAllLibraries() async { Future<List<LibraryResponseDto>?> getAllLibraries() async {
final response = await getAllLibrariesWithHttpInfo(); final response = await getAllLibrariesWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -147,7 +160,10 @@ class LibrariesApi {
return null; return null;
} }
/// Performs an HTTP 'GET /libraries/{id}' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `library.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -177,6 +193,8 @@ class LibrariesApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `library.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -195,7 +213,10 @@ class LibrariesApi {
return null; return null;
} }
/// Performs an HTTP 'GET /libraries/{id}/statistics' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `library.statistics` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -225,6 +246,8 @@ class LibrariesApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `library.statistics` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -243,7 +266,10 @@ class LibrariesApi {
return null; return null;
} }
/// Performs an HTTP 'POST /libraries/{id}/scan' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `library.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -273,6 +299,8 @@ class LibrariesApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `library.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -283,7 +311,10 @@ class LibrariesApi {
} }
} }
/// Performs an HTTP 'PUT /libraries/{id}' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `library.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -315,6 +346,8 @@ class LibrariesApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `library.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):

View File

@ -19,18 +19,18 @@ class MapApi {
/// Performs an HTTP 'GET /map/markers' operation and returns the [Response]. /// Performs an HTTP 'GET /map/markers' operation and returns the [Response].
/// Parameters: /// Parameters:
/// ///
/// * [DateTime] fileCreatedAfter:
///
/// * [DateTime] fileCreatedBefore:
///
/// * [bool] isArchived: /// * [bool] isArchived:
/// ///
/// * [bool] isFavorite: /// * [bool] isFavorite:
/// ///
/// * [DateTime] fileCreatedAfter:
///
/// * [DateTime] fileCreatedBefore:
///
/// * [bool] withPartners: /// * [bool] withPartners:
/// ///
/// * [bool] withSharedAlbums: /// * [bool] withSharedAlbums:
Future<Response> getMapMarkersWithHttpInfo({ DateTime? fileCreatedAfter, DateTime? fileCreatedBefore, bool? isArchived, bool? isFavorite, bool? withPartners, bool? withSharedAlbums, }) async { Future<Response> getMapMarkersWithHttpInfo({ bool? isArchived, bool? isFavorite, DateTime? fileCreatedAfter, DateTime? fileCreatedBefore, bool? withPartners, bool? withSharedAlbums, }) async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/map/markers'; final apiPath = r'/map/markers';
@ -41,18 +41,18 @@ class MapApi {
final headerParams = <String, String>{}; final headerParams = <String, String>{};
final formParams = <String, String>{}; final formParams = <String, String>{};
if (fileCreatedAfter != null) {
queryParams.addAll(_queryParams('', 'fileCreatedAfter', fileCreatedAfter));
}
if (fileCreatedBefore != null) {
queryParams.addAll(_queryParams('', 'fileCreatedBefore', fileCreatedBefore));
}
if (isArchived != null) { if (isArchived != null) {
queryParams.addAll(_queryParams('', 'isArchived', isArchived)); queryParams.addAll(_queryParams('', 'isArchived', isArchived));
} }
if (isFavorite != null) { if (isFavorite != null) {
queryParams.addAll(_queryParams('', 'isFavorite', isFavorite)); queryParams.addAll(_queryParams('', 'isFavorite', isFavorite));
} }
if (fileCreatedAfter != null) {
queryParams.addAll(_queryParams('', 'fileCreatedAfter', fileCreatedAfter));
}
if (fileCreatedBefore != null) {
queryParams.addAll(_queryParams('', 'fileCreatedBefore', fileCreatedBefore));
}
if (withPartners != null) { if (withPartners != null) {
queryParams.addAll(_queryParams('', 'withPartners', withPartners)); queryParams.addAll(_queryParams('', 'withPartners', withPartners));
} }
@ -76,19 +76,19 @@ class MapApi {
/// Parameters: /// Parameters:
/// ///
/// * [DateTime] fileCreatedAfter:
///
/// * [DateTime] fileCreatedBefore:
///
/// * [bool] isArchived: /// * [bool] isArchived:
/// ///
/// * [bool] isFavorite: /// * [bool] isFavorite:
/// ///
/// * [DateTime] fileCreatedAfter:
///
/// * [DateTime] fileCreatedBefore:
///
/// * [bool] withPartners: /// * [bool] withPartners:
/// ///
/// * [bool] withSharedAlbums: /// * [bool] withSharedAlbums:
Future<List<MapMarkerResponseDto>?> getMapMarkers({ DateTime? fileCreatedAfter, DateTime? fileCreatedBefore, bool? isArchived, bool? isFavorite, bool? withPartners, bool? withSharedAlbums, }) async { Future<List<MapMarkerResponseDto>?> getMapMarkers({ bool? isArchived, bool? isFavorite, DateTime? fileCreatedAfter, DateTime? fileCreatedBefore, bool? withPartners, bool? withSharedAlbums, }) async {
final response = await getMapMarkersWithHttpInfo( fileCreatedAfter: fileCreatedAfter, fileCreatedBefore: fileCreatedBefore, isArchived: isArchived, isFavorite: isFavorite, withPartners: withPartners, withSharedAlbums: withSharedAlbums, ); final response = await getMapMarkersWithHttpInfo( isArchived: isArchived, isFavorite: isFavorite, fileCreatedAfter: fileCreatedAfter, fileCreatedBefore: fileCreatedBefore, withPartners: withPartners, withSharedAlbums: withSharedAlbums, );
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response)); throw ApiException(response.statusCode, await _decodeBodyBytes(response));
} }

View File

@ -16,7 +16,10 @@ class MemoriesApi {
final ApiClient apiClient; final ApiClient apiClient;
/// Performs an HTTP 'PUT /memories/{id}/assets' operation and returns the [Response]. /// This endpoint requires the `memoryAsset.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -48,6 +51,8 @@ class MemoriesApi {
); );
} }
/// This endpoint requires the `memoryAsset.create` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -71,7 +76,10 @@ class MemoriesApi {
return null; return null;
} }
/// Performs an HTTP 'POST /memories' operation and returns the [Response]. /// This endpoint requires the `memory.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [MemoryCreateDto] memoryCreateDto (required): /// * [MemoryCreateDto] memoryCreateDto (required):
@ -100,6 +108,8 @@ class MemoriesApi {
); );
} }
/// This endpoint requires the `memory.create` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [MemoryCreateDto] memoryCreateDto (required): /// * [MemoryCreateDto] memoryCreateDto (required):
@ -118,7 +128,10 @@ class MemoriesApi {
return null; return null;
} }
/// Performs an HTTP 'DELETE /memories/{id}' operation and returns the [Response]. /// This endpoint requires the `memory.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -148,6 +161,8 @@ class MemoriesApi {
); );
} }
/// This endpoint requires the `memory.delete` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -158,7 +173,10 @@ class MemoriesApi {
} }
} }
/// Performs an HTTP 'GET /memories/{id}' operation and returns the [Response]. /// This endpoint requires the `memory.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -188,6 +206,8 @@ class MemoriesApi {
); );
} }
/// This endpoint requires the `memory.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -206,7 +226,10 @@ class MemoriesApi {
return null; return null;
} }
/// Performs an HTTP 'GET /memories/statistics' operation and returns the [Response]. /// This endpoint requires the `memory.statistics` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [DateTime] for_: /// * [DateTime] for_:
@ -254,6 +277,8 @@ class MemoriesApi {
); );
} }
/// This endpoint requires the `memory.statistics` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [DateTime] for_: /// * [DateTime] for_:
@ -278,7 +303,10 @@ class MemoriesApi {
return null; return null;
} }
/// Performs an HTTP 'DELETE /memories/{id}/assets' operation and returns the [Response]. /// This endpoint requires the `memoryAsset.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -310,6 +338,8 @@ class MemoriesApi {
); );
} }
/// This endpoint requires the `memoryAsset.delete` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -333,7 +363,10 @@ class MemoriesApi {
return null; return null;
} }
/// Performs an HTTP 'GET /memories' operation and returns the [Response]. /// This endpoint requires the `memory.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [DateTime] for_: /// * [DateTime] for_:
@ -381,6 +414,8 @@ class MemoriesApi {
); );
} }
/// This endpoint requires the `memory.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [DateTime] for_: /// * [DateTime] for_:
@ -408,7 +443,10 @@ class MemoriesApi {
return null; return null;
} }
/// Performs an HTTP 'PUT /memories/{id}' operation and returns the [Response]. /// This endpoint requires the `memory.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -440,6 +478,8 @@ class MemoriesApi {
); );
} }
/// This endpoint requires the `memory.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):

View File

@ -16,7 +16,10 @@ class NotificationsApi {
final ApiClient apiClient; final ApiClient apiClient;
/// Performs an HTTP 'DELETE /notifications/{id}' operation and returns the [Response]. /// This endpoint requires the `notification.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -46,6 +49,8 @@ class NotificationsApi {
); );
} }
/// This endpoint requires the `notification.delete` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -56,7 +61,10 @@ class NotificationsApi {
} }
} }
/// Performs an HTTP 'DELETE /notifications' operation and returns the [Response]. /// This endpoint requires the `notification.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [NotificationDeleteAllDto] notificationDeleteAllDto (required): /// * [NotificationDeleteAllDto] notificationDeleteAllDto (required):
@ -85,6 +93,8 @@ class NotificationsApi {
); );
} }
/// This endpoint requires the `notification.delete` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [NotificationDeleteAllDto] notificationDeleteAllDto (required): /// * [NotificationDeleteAllDto] notificationDeleteAllDto (required):
@ -95,7 +105,10 @@ class NotificationsApi {
} }
} }
/// Performs an HTTP 'GET /notifications/{id}' operation and returns the [Response]. /// This endpoint requires the `notification.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -125,6 +138,8 @@ class NotificationsApi {
); );
} }
/// This endpoint requires the `notification.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -143,7 +158,10 @@ class NotificationsApi {
return null; return null;
} }
/// Performs an HTTP 'GET /notifications' operation and returns the [Response]. /// This endpoint requires the `notification.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id: /// * [String] id:
@ -191,6 +209,8 @@ class NotificationsApi {
); );
} }
/// This endpoint requires the `notification.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id: /// * [String] id:
@ -218,7 +238,10 @@ class NotificationsApi {
return null; return null;
} }
/// Performs an HTTP 'PUT /notifications/{id}' operation and returns the [Response]. /// This endpoint requires the `notification.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -250,6 +273,8 @@ class NotificationsApi {
); );
} }
/// This endpoint requires the `notification.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -270,7 +295,10 @@ class NotificationsApi {
return null; return null;
} }
/// Performs an HTTP 'PUT /notifications' operation and returns the [Response]. /// This endpoint requires the `notification.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [NotificationUpdateAllDto] notificationUpdateAllDto (required): /// * [NotificationUpdateAllDto] notificationUpdateAllDto (required):
@ -299,6 +327,8 @@ class NotificationsApi {
); );
} }
/// This endpoint requires the `notification.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [NotificationUpdateAllDto] notificationUpdateAllDto (required): /// * [NotificationUpdateAllDto] notificationUpdateAllDto (required):

View File

@ -16,7 +16,10 @@ class PartnersApi {
final ApiClient apiClient; final ApiClient apiClient;
/// Performs an HTTP 'POST /partners/{id}' operation and returns the [Response]. /// This endpoint requires the `partner.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -46,6 +49,8 @@ class PartnersApi {
); );
} }
/// This endpoint requires the `partner.create` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -64,7 +69,10 @@ class PartnersApi {
return null; return null;
} }
/// Performs an HTTP 'GET /partners' operation and returns the [Response]. /// This endpoint requires the `partner.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [PartnerDirection] direction (required): /// * [PartnerDirection] direction (required):
@ -95,6 +103,8 @@ class PartnersApi {
); );
} }
/// This endpoint requires the `partner.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [PartnerDirection] direction (required): /// * [PartnerDirection] direction (required):
@ -116,7 +126,10 @@ class PartnersApi {
return null; return null;
} }
/// Performs an HTTP 'DELETE /partners/{id}' operation and returns the [Response]. /// This endpoint requires the `partner.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -146,6 +159,8 @@ class PartnersApi {
); );
} }
/// This endpoint requires the `partner.delete` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -156,7 +171,10 @@ class PartnersApi {
} }
} }
/// Performs an HTTP 'PUT /partners/{id}' operation and returns the [Response]. /// This endpoint requires the `partner.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -188,6 +206,8 @@ class PartnersApi {
); );
} }
/// This endpoint requires the `partner.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):

View File

@ -16,7 +16,10 @@ class PeopleApi {
final ApiClient apiClient; final ApiClient apiClient;
/// Performs an HTTP 'POST /people' operation and returns the [Response]. /// This endpoint requires the `person.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [PersonCreateDto] personCreateDto (required): /// * [PersonCreateDto] personCreateDto (required):
@ -45,6 +48,8 @@ class PeopleApi {
); );
} }
/// This endpoint requires the `person.create` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [PersonCreateDto] personCreateDto (required): /// * [PersonCreateDto] personCreateDto (required):
@ -63,7 +68,10 @@ class PeopleApi {
return null; return null;
} }
/// Performs an HTTP 'DELETE /people' operation and returns the [Response]. /// This endpoint requires the `person.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [BulkIdsDto] bulkIdsDto (required): /// * [BulkIdsDto] bulkIdsDto (required):
@ -92,6 +100,8 @@ class PeopleApi {
); );
} }
/// This endpoint requires the `person.delete` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [BulkIdsDto] bulkIdsDto (required): /// * [BulkIdsDto] bulkIdsDto (required):
@ -102,7 +112,10 @@ class PeopleApi {
} }
} }
/// Performs an HTTP 'DELETE /people/{id}' operation and returns the [Response]. /// This endpoint requires the `person.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -132,6 +145,8 @@ class PeopleApi {
); );
} }
/// This endpoint requires the `person.delete` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -142,7 +157,10 @@ class PeopleApi {
} }
} }
/// Performs an HTTP 'GET /people' operation and returns the [Response]. /// This endpoint requires the `person.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] closestAssetId: /// * [String] closestAssetId:
@ -197,6 +215,8 @@ class PeopleApi {
); );
} }
/// This endpoint requires the `person.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] closestAssetId: /// * [String] closestAssetId:
@ -225,7 +245,10 @@ class PeopleApi {
return null; return null;
} }
/// Performs an HTTP 'GET /people/{id}' operation and returns the [Response]. /// This endpoint requires the `person.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -255,6 +278,8 @@ class PeopleApi {
); );
} }
/// This endpoint requires the `person.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -273,7 +298,10 @@ class PeopleApi {
return null; return null;
} }
/// Performs an HTTP 'GET /people/{id}/statistics' operation and returns the [Response]. /// This endpoint requires the `person.statistics` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -303,6 +331,8 @@ class PeopleApi {
); );
} }
/// This endpoint requires the `person.statistics` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -321,7 +351,10 @@ class PeopleApi {
return null; return null;
} }
/// Performs an HTTP 'GET /people/{id}/thumbnail' operation and returns the [Response]. /// This endpoint requires the `person.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -351,6 +384,8 @@ class PeopleApi {
); );
} }
/// This endpoint requires the `person.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -369,7 +404,10 @@ class PeopleApi {
return null; return null;
} }
/// Performs an HTTP 'POST /people/{id}/merge' operation and returns the [Response]. /// This endpoint requires the `person.merge` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -401,6 +439,8 @@ class PeopleApi {
); );
} }
/// This endpoint requires the `person.merge` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -424,7 +464,10 @@ class PeopleApi {
return null; return null;
} }
/// Performs an HTTP 'PUT /people/{id}/reassign' operation and returns the [Response]. /// This endpoint requires the `person.reassign` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -456,6 +499,8 @@ class PeopleApi {
); );
} }
/// This endpoint requires the `person.reassign` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -479,7 +524,10 @@ class PeopleApi {
return null; return null;
} }
/// Performs an HTTP 'PUT /people' operation and returns the [Response]. /// This endpoint requires the `person.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [PeopleUpdateDto] peopleUpdateDto (required): /// * [PeopleUpdateDto] peopleUpdateDto (required):
@ -508,6 +556,8 @@ class PeopleApi {
); );
} }
/// This endpoint requires the `person.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [PeopleUpdateDto] peopleUpdateDto (required): /// * [PeopleUpdateDto] peopleUpdateDto (required):
@ -529,7 +579,10 @@ class PeopleApi {
return null; return null;
} }
/// Performs an HTTP 'PUT /people/{id}' operation and returns the [Response]. /// This endpoint requires the `person.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -561,6 +614,8 @@ class PeopleApi {
); );
} }
/// This endpoint requires the `person.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):

View File

@ -16,7 +16,9 @@ class SearchApi {
final ApiClient apiClient; final ApiClient apiClient;
/// Performs an HTTP 'GET /search/cities' operation and returns the [Response]. /// This endpoint requires the `asset.read` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getAssetsByCityWithHttpInfo() async { Future<Response> getAssetsByCityWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/search/cities'; final apiPath = r'/search/cities';
@ -42,6 +44,7 @@ class SearchApi {
); );
} }
/// This endpoint requires the `asset.read` permission.
Future<List<AssetResponseDto>?> getAssetsByCity() async { Future<List<AssetResponseDto>?> getAssetsByCity() async {
final response = await getAssetsByCityWithHttpInfo(); final response = await getAssetsByCityWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -60,7 +63,9 @@ class SearchApi {
return null; return null;
} }
/// Performs an HTTP 'GET /search/explore' operation and returns the [Response]. /// This endpoint requires the `asset.read` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getExploreDataWithHttpInfo() async { Future<Response> getExploreDataWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/search/explore'; final apiPath = r'/search/explore';
@ -86,6 +91,7 @@ class SearchApi {
); );
} }
/// This endpoint requires the `asset.read` permission.
Future<List<SearchExploreResponseDto>?> getExploreData() async { Future<List<SearchExploreResponseDto>?> getExploreData() async {
final response = await getExploreDataWithHttpInfo(); final response = await getExploreDataWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -104,7 +110,10 @@ class SearchApi {
return null; return null;
} }
/// Performs an HTTP 'GET /search/suggestions' operation and returns the [Response]. /// This endpoint requires the `asset.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [SearchSuggestionType] type (required): /// * [SearchSuggestionType] type (required):
@ -161,6 +170,8 @@ class SearchApi {
); );
} }
/// This endpoint requires the `asset.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [SearchSuggestionType] type (required): /// * [SearchSuggestionType] type (required):
@ -193,7 +204,10 @@ class SearchApi {
return null; return null;
} }
/// Performs an HTTP 'POST /search/statistics' operation and returns the [Response]. /// This endpoint requires the `asset.statistics` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [StatisticsSearchDto] statisticsSearchDto (required): /// * [StatisticsSearchDto] statisticsSearchDto (required):
@ -222,6 +236,8 @@ class SearchApi {
); );
} }
/// This endpoint requires the `asset.statistics` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [StatisticsSearchDto] statisticsSearchDto (required): /// * [StatisticsSearchDto] statisticsSearchDto (required):
@ -240,7 +256,10 @@ class SearchApi {
return null; return null;
} }
/// Performs an HTTP 'POST /search/metadata' operation and returns the [Response]. /// This endpoint requires the `asset.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [MetadataSearchDto] metadataSearchDto (required): /// * [MetadataSearchDto] metadataSearchDto (required):
@ -269,6 +288,8 @@ class SearchApi {
); );
} }
/// This endpoint requires the `asset.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [MetadataSearchDto] metadataSearchDto (required): /// * [MetadataSearchDto] metadataSearchDto (required):
@ -287,7 +308,10 @@ class SearchApi {
return null; return null;
} }
/// Performs an HTTP 'POST /search/large-assets' operation and returns the [Response]. /// This endpoint requires the `asset.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [List<String>] albumIds: /// * [List<String>] albumIds:
@ -470,6 +494,8 @@ class SearchApi {
); );
} }
/// This endpoint requires the `asset.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [List<String>] albumIds: /// * [List<String>] albumIds:
@ -551,7 +577,10 @@ class SearchApi {
return null; return null;
} }
/// Performs an HTTP 'GET /search/person' operation and returns the [Response]. /// This endpoint requires the `person.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] name (required): /// * [String] name (required):
@ -587,6 +616,8 @@ class SearchApi {
); );
} }
/// This endpoint requires the `person.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] name (required): /// * [String] name (required):
@ -610,7 +641,10 @@ class SearchApi {
return null; return null;
} }
/// Performs an HTTP 'GET /search/places' operation and returns the [Response]. /// This endpoint requires the `asset.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] name (required): /// * [String] name (required):
@ -641,6 +675,8 @@ class SearchApi {
); );
} }
/// This endpoint requires the `asset.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] name (required): /// * [String] name (required):
@ -662,7 +698,10 @@ class SearchApi {
return null; return null;
} }
/// Performs an HTTP 'POST /search/random' operation and returns the [Response]. /// This endpoint requires the `asset.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [RandomSearchDto] randomSearchDto (required): /// * [RandomSearchDto] randomSearchDto (required):
@ -691,6 +730,8 @@ class SearchApi {
); );
} }
/// This endpoint requires the `asset.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [RandomSearchDto] randomSearchDto (required): /// * [RandomSearchDto] randomSearchDto (required):
@ -712,7 +753,10 @@ class SearchApi {
return null; return null;
} }
/// Performs an HTTP 'POST /search/smart' operation and returns the [Response]. /// This endpoint requires the `asset.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [SmartSearchDto] smartSearchDto (required): /// * [SmartSearchDto] smartSearchDto (required):
@ -741,6 +785,8 @@ class SearchApi {
); );
} }
/// This endpoint requires the `asset.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [SmartSearchDto] smartSearchDto (required): /// * [SmartSearchDto] smartSearchDto (required):

View File

@ -16,7 +16,9 @@ class ServerApi {
final ApiClient apiClient; final ApiClient apiClient;
/// Performs an HTTP 'DELETE /server/license' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `serverLicense.delete` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> deleteServerLicenseWithHttpInfo() async { Future<Response> deleteServerLicenseWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/server/license'; final apiPath = r'/server/license';
@ -42,6 +44,7 @@ class ServerApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `serverLicense.delete` permission.
Future<void> deleteServerLicense() async { Future<void> deleteServerLicense() async {
final response = await deleteServerLicenseWithHttpInfo(); final response = await deleteServerLicenseWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -49,7 +52,9 @@ class ServerApi {
} }
} }
/// Performs an HTTP 'GET /server/about' operation and returns the [Response]. /// This endpoint requires the `server.about` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getAboutInfoWithHttpInfo() async { Future<Response> getAboutInfoWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/server/about'; final apiPath = r'/server/about';
@ -75,6 +80,7 @@ class ServerApi {
); );
} }
/// This endpoint requires the `server.about` permission.
Future<ServerAboutResponseDto?> getAboutInfo() async { Future<ServerAboutResponseDto?> getAboutInfo() async {
final response = await getAboutInfoWithHttpInfo(); final response = await getAboutInfoWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -90,7 +96,9 @@ class ServerApi {
return null; return null;
} }
/// Performs an HTTP 'GET /server/apk-links' operation and returns the [Response]. /// This endpoint requires the `server.apkLinks` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getApkLinksWithHttpInfo() async { Future<Response> getApkLinksWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/server/apk-links'; final apiPath = r'/server/apk-links';
@ -116,6 +124,7 @@ class ServerApi {
); );
} }
/// This endpoint requires the `server.apkLinks` permission.
Future<ServerApkLinksDto?> getApkLinks() async { Future<ServerApkLinksDto?> getApkLinks() async {
final response = await getApkLinksWithHttpInfo(); final response = await getApkLinksWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -213,7 +222,9 @@ class ServerApi {
return null; return null;
} }
/// Performs an HTTP 'GET /server/license' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `serverLicense.read` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getServerLicenseWithHttpInfo() async { Future<Response> getServerLicenseWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/server/license'; final apiPath = r'/server/license';
@ -239,6 +250,7 @@ class ServerApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `serverLicense.read` permission.
Future<LicenseResponseDto?> getServerLicense() async { Future<LicenseResponseDto?> getServerLicense() async {
final response = await getServerLicenseWithHttpInfo(); final response = await getServerLicenseWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -254,7 +266,9 @@ class ServerApi {
return null; return null;
} }
/// Performs an HTTP 'GET /server/statistics' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `server.statistics` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getServerStatisticsWithHttpInfo() async { Future<Response> getServerStatisticsWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/server/statistics'; final apiPath = r'/server/statistics';
@ -280,6 +294,7 @@ class ServerApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `server.statistics` permission.
Future<ServerStatsResponseDto?> getServerStatistics() async { Future<ServerStatsResponseDto?> getServerStatistics() async {
final response = await getServerStatisticsWithHttpInfo(); final response = await getServerStatisticsWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -336,7 +351,9 @@ class ServerApi {
return null; return null;
} }
/// Performs an HTTP 'GET /server/storage' operation and returns the [Response]. /// This endpoint requires the `server.storage` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getStorageWithHttpInfo() async { Future<Response> getStorageWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/server/storage'; final apiPath = r'/server/storage';
@ -362,6 +379,7 @@ class ServerApi {
); );
} }
/// This endpoint requires the `server.storage` permission.
Future<ServerStorageResponseDto?> getStorage() async { Future<ServerStorageResponseDto?> getStorage() async {
final response = await getStorageWithHttpInfo(); final response = await getStorageWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -585,7 +603,10 @@ class ServerApi {
return null; return null;
} }
/// Performs an HTTP 'PUT /server/license' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `serverLicense.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [LicenseKeyDto] licenseKeyDto (required): /// * [LicenseKeyDto] licenseKeyDto (required):
@ -614,6 +635,8 @@ class ServerApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `serverLicense.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [LicenseKeyDto] licenseKeyDto (required): /// * [LicenseKeyDto] licenseKeyDto (required):

View File

@ -16,7 +16,10 @@ class SessionsApi {
final ApiClient apiClient; final ApiClient apiClient;
/// Performs an HTTP 'POST /sessions' operation and returns the [Response]. /// This endpoint requires the `session.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [SessionCreateDto] sessionCreateDto (required): /// * [SessionCreateDto] sessionCreateDto (required):
@ -45,6 +48,8 @@ class SessionsApi {
); );
} }
/// This endpoint requires the `session.create` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [SessionCreateDto] sessionCreateDto (required): /// * [SessionCreateDto] sessionCreateDto (required):
@ -63,7 +68,9 @@ class SessionsApi {
return null; return null;
} }
/// Performs an HTTP 'DELETE /sessions' operation and returns the [Response]. /// This endpoint requires the `session.delete` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> deleteAllSessionsWithHttpInfo() async { Future<Response> deleteAllSessionsWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/sessions'; final apiPath = r'/sessions';
@ -89,6 +96,7 @@ class SessionsApi {
); );
} }
/// This endpoint requires the `session.delete` permission.
Future<void> deleteAllSessions() async { Future<void> deleteAllSessions() async {
final response = await deleteAllSessionsWithHttpInfo(); final response = await deleteAllSessionsWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -96,7 +104,10 @@ class SessionsApi {
} }
} }
/// Performs an HTTP 'DELETE /sessions/{id}' operation and returns the [Response]. /// This endpoint requires the `session.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -126,6 +137,8 @@ class SessionsApi {
); );
} }
/// This endpoint requires the `session.delete` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -136,7 +149,9 @@ class SessionsApi {
} }
} }
/// Performs an HTTP 'GET /sessions' operation and returns the [Response]. /// This endpoint requires the `session.read` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getSessionsWithHttpInfo() async { Future<Response> getSessionsWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/sessions'; final apiPath = r'/sessions';
@ -162,6 +177,7 @@ class SessionsApi {
); );
} }
/// This endpoint requires the `session.read` permission.
Future<List<SessionResponseDto>?> getSessions() async { Future<List<SessionResponseDto>?> getSessions() async {
final response = await getSessionsWithHttpInfo(); final response = await getSessionsWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -180,7 +196,10 @@ class SessionsApi {
return null; return null;
} }
/// Performs an HTTP 'POST /sessions/{id}/lock' operation and returns the [Response]. /// This endpoint requires the `session.lock` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -210,6 +229,8 @@ class SessionsApi {
); );
} }
/// This endpoint requires the `session.lock` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -220,7 +241,10 @@ class SessionsApi {
} }
} }
/// Performs an HTTP 'PUT /sessions/{id}' operation and returns the [Response]. /// This endpoint requires the `session.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -252,6 +276,8 @@ class SessionsApi {
); );
} }
/// This endpoint requires the `session.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):

View File

@ -86,7 +86,10 @@ class SharedLinksApi {
return null; return null;
} }
/// Performs an HTTP 'POST /shared-links' operation and returns the [Response]. /// This endpoint requires the `sharedLink.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [SharedLinkCreateDto] sharedLinkCreateDto (required): /// * [SharedLinkCreateDto] sharedLinkCreateDto (required):
@ -115,6 +118,8 @@ class SharedLinksApi {
); );
} }
/// This endpoint requires the `sharedLink.create` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [SharedLinkCreateDto] sharedLinkCreateDto (required): /// * [SharedLinkCreateDto] sharedLinkCreateDto (required):
@ -133,7 +138,10 @@ class SharedLinksApi {
return null; return null;
} }
/// Performs an HTTP 'GET /shared-links' operation and returns the [Response]. /// This endpoint requires the `sharedLink.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] albumId: /// * [String] albumId:
@ -166,6 +174,8 @@ class SharedLinksApi {
); );
} }
/// This endpoint requires the `sharedLink.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] albumId: /// * [String] albumId:
@ -190,14 +200,14 @@ class SharedLinksApi {
/// Performs an HTTP 'GET /shared-links/me' operation and returns the [Response]. /// Performs an HTTP 'GET /shared-links/me' operation and returns the [Response].
/// Parameters: /// Parameters:
/// ///
/// * [String] key:
///
/// * [String] password: /// * [String] password:
/// ///
/// * [String] slug:
///
/// * [String] token: /// * [String] token:
Future<Response> getMySharedLinkWithHttpInfo({ String? key, String? password, String? slug, String? token, }) async { ///
/// * [String] key:
///
/// * [String] slug:
Future<Response> getMySharedLinkWithHttpInfo({ String? password, String? token, String? key, String? slug, }) async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/shared-links/me'; final apiPath = r'/shared-links/me';
@ -208,18 +218,18 @@ class SharedLinksApi {
final headerParams = <String, String>{}; final headerParams = <String, String>{};
final formParams = <String, String>{}; final formParams = <String, String>{};
if (key != null) {
queryParams.addAll(_queryParams('', 'key', key));
}
if (password != null) { if (password != null) {
queryParams.addAll(_queryParams('', 'password', password)); queryParams.addAll(_queryParams('', 'password', password));
} }
if (slug != null) {
queryParams.addAll(_queryParams('', 'slug', slug));
}
if (token != null) { if (token != null) {
queryParams.addAll(_queryParams('', 'token', token)); queryParams.addAll(_queryParams('', 'token', token));
} }
if (key != null) {
queryParams.addAll(_queryParams('', 'key', key));
}
if (slug != null) {
queryParams.addAll(_queryParams('', 'slug', slug));
}
const contentTypes = <String>[]; const contentTypes = <String>[];
@ -237,15 +247,15 @@ class SharedLinksApi {
/// Parameters: /// Parameters:
/// ///
/// * [String] key:
///
/// * [String] password: /// * [String] password:
/// ///
/// * [String] slug:
///
/// * [String] token: /// * [String] token:
Future<SharedLinkResponseDto?> getMySharedLink({ String? key, String? password, String? slug, String? token, }) async { ///
final response = await getMySharedLinkWithHttpInfo( key: key, password: password, slug: slug, token: token, ); /// * [String] key:
///
/// * [String] slug:
Future<SharedLinkResponseDto?> getMySharedLink({ String? password, String? token, String? key, String? slug, }) async {
final response = await getMySharedLinkWithHttpInfo( password: password, token: token, key: key, slug: slug, );
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response)); throw ApiException(response.statusCode, await _decodeBodyBytes(response));
} }
@ -259,7 +269,10 @@ class SharedLinksApi {
return null; return null;
} }
/// Performs an HTTP 'GET /shared-links/{id}' operation and returns the [Response]. /// This endpoint requires the `sharedLink.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -289,6 +302,8 @@ class SharedLinksApi {
); );
} }
/// This endpoint requires the `sharedLink.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -307,7 +322,10 @@ class SharedLinksApi {
return null; return null;
} }
/// Performs an HTTP 'DELETE /shared-links/{id}' operation and returns the [Response]. /// This endpoint requires the `sharedLink.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -337,6 +355,8 @@ class SharedLinksApi {
); );
} }
/// This endpoint requires the `sharedLink.delete` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -417,7 +437,10 @@ class SharedLinksApi {
return null; return null;
} }
/// Performs an HTTP 'PATCH /shared-links/{id}' operation and returns the [Response]. /// This endpoint requires the `sharedLink.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -449,6 +472,8 @@ class SharedLinksApi {
); );
} }
/// This endpoint requires the `sharedLink.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):

View File

@ -16,7 +16,10 @@ class StacksApi {
final ApiClient apiClient; final ApiClient apiClient;
/// Performs an HTTP 'POST /stacks' operation and returns the [Response]. /// This endpoint requires the `stack.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [StackCreateDto] stackCreateDto (required): /// * [StackCreateDto] stackCreateDto (required):
@ -45,6 +48,8 @@ class StacksApi {
); );
} }
/// This endpoint requires the `stack.create` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [StackCreateDto] stackCreateDto (required): /// * [StackCreateDto] stackCreateDto (required):
@ -63,7 +68,10 @@ class StacksApi {
return null; return null;
} }
/// Performs an HTTP 'DELETE /stacks/{id}' operation and returns the [Response]. /// This endpoint requires the `stack.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -93,6 +101,8 @@ class StacksApi {
); );
} }
/// This endpoint requires the `stack.delete` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -103,7 +113,10 @@ class StacksApi {
} }
} }
/// Performs an HTTP 'DELETE /stacks' operation and returns the [Response]. /// This endpoint requires the `stack.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [BulkIdsDto] bulkIdsDto (required): /// * [BulkIdsDto] bulkIdsDto (required):
@ -132,6 +145,8 @@ class StacksApi {
); );
} }
/// This endpoint requires the `stack.delete` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [BulkIdsDto] bulkIdsDto (required): /// * [BulkIdsDto] bulkIdsDto (required):
@ -142,7 +157,10 @@ class StacksApi {
} }
} }
/// Performs an HTTP 'GET /stacks/{id}' operation and returns the [Response]. /// This endpoint requires the `stack.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -172,6 +190,8 @@ class StacksApi {
); );
} }
/// This endpoint requires the `stack.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -190,7 +210,10 @@ class StacksApi {
return null; return null;
} }
/// Performs an HTTP 'DELETE /stacks/{id}/assets/{assetId}' operation and returns the [Response]. /// This endpoint requires the `stack.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] assetId (required): /// * [String] assetId (required):
@ -223,6 +246,8 @@ class StacksApi {
); );
} }
/// This endpoint requires the `stack.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] assetId (required): /// * [String] assetId (required):
@ -235,7 +260,10 @@ class StacksApi {
} }
} }
/// Performs an HTTP 'GET /stacks' operation and returns the [Response]. /// This endpoint requires the `stack.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] primaryAssetId: /// * [String] primaryAssetId:
@ -268,6 +296,8 @@ class StacksApi {
); );
} }
/// This endpoint requires the `stack.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] primaryAssetId: /// * [String] primaryAssetId:
@ -289,7 +319,10 @@ class StacksApi {
return null; return null;
} }
/// Performs an HTTP 'PUT /stacks/{id}' operation and returns the [Response]. /// This endpoint requires the `stack.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -321,6 +354,8 @@ class StacksApi {
); );
} }
/// This endpoint requires the `stack.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):

View File

@ -16,7 +16,10 @@ class SyncApi {
final ApiClient apiClient; final ApiClient apiClient;
/// Performs an HTTP 'DELETE /sync/ack' operation and returns the [Response]. /// This endpoint requires the `syncCheckpoint.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [SyncAckDeleteDto] syncAckDeleteDto (required): /// * [SyncAckDeleteDto] syncAckDeleteDto (required):
@ -45,6 +48,8 @@ class SyncApi {
); );
} }
/// This endpoint requires the `syncCheckpoint.delete` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [SyncAckDeleteDto] syncAckDeleteDto (required): /// * [SyncAckDeleteDto] syncAckDeleteDto (required):
@ -152,7 +157,9 @@ class SyncApi {
return null; return null;
} }
/// Performs an HTTP 'GET /sync/ack' operation and returns the [Response]. /// This endpoint requires the `syncCheckpoint.read` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getSyncAckWithHttpInfo() async { Future<Response> getSyncAckWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/sync/ack'; final apiPath = r'/sync/ack';
@ -178,6 +185,7 @@ class SyncApi {
); );
} }
/// This endpoint requires the `syncCheckpoint.read` permission.
Future<List<SyncAckDto>?> getSyncAck() async { Future<List<SyncAckDto>?> getSyncAck() async {
final response = await getSyncAckWithHttpInfo(); final response = await getSyncAckWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -196,7 +204,10 @@ class SyncApi {
return null; return null;
} }
/// Performs an HTTP 'POST /sync/stream' operation and returns the [Response]. /// This endpoint requires the `sync.stream` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [SyncStreamDto] syncStreamDto (required): /// * [SyncStreamDto] syncStreamDto (required):
@ -225,6 +236,8 @@ class SyncApi {
); );
} }
/// This endpoint requires the `sync.stream` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [SyncStreamDto] syncStreamDto (required): /// * [SyncStreamDto] syncStreamDto (required):
@ -235,7 +248,10 @@ class SyncApi {
} }
} }
/// Performs an HTTP 'POST /sync/ack' operation and returns the [Response]. /// This endpoint requires the `syncCheckpoint.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [SyncAckSetDto] syncAckSetDto (required): /// * [SyncAckSetDto] syncAckSetDto (required):
@ -264,6 +280,8 @@ class SyncApi {
); );
} }
/// This endpoint requires the `syncCheckpoint.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [SyncAckSetDto] syncAckSetDto (required): /// * [SyncAckSetDto] syncAckSetDto (required):

View File

@ -16,7 +16,9 @@ class SystemConfigApi {
final ApiClient apiClient; final ApiClient apiClient;
/// Performs an HTTP 'GET /system-config' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getConfigWithHttpInfo() async { Future<Response> getConfigWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/system-config'; final apiPath = r'/system-config';
@ -42,6 +44,7 @@ class SystemConfigApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
Future<SystemConfigDto?> getConfig() async { Future<SystemConfigDto?> getConfig() async {
final response = await getConfigWithHttpInfo(); final response = await getConfigWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -57,7 +60,9 @@ class SystemConfigApi {
return null; return null;
} }
/// Performs an HTTP 'GET /system-config/defaults' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getConfigDefaultsWithHttpInfo() async { Future<Response> getConfigDefaultsWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/system-config/defaults'; final apiPath = r'/system-config/defaults';
@ -83,6 +88,7 @@ class SystemConfigApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
Future<SystemConfigDto?> getConfigDefaults() async { Future<SystemConfigDto?> getConfigDefaults() async {
final response = await getConfigDefaultsWithHttpInfo(); final response = await getConfigDefaultsWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -98,7 +104,9 @@ class SystemConfigApi {
return null; return null;
} }
/// Performs an HTTP 'GET /system-config/storage-template-options' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getStorageTemplateOptionsWithHttpInfo() async { Future<Response> getStorageTemplateOptionsWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/system-config/storage-template-options'; final apiPath = r'/system-config/storage-template-options';
@ -124,6 +132,7 @@ class SystemConfigApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
Future<SystemConfigTemplateStorageOptionDto?> getStorageTemplateOptions() async { Future<SystemConfigTemplateStorageOptionDto?> getStorageTemplateOptions() async {
final response = await getStorageTemplateOptionsWithHttpInfo(); final response = await getStorageTemplateOptionsWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -139,7 +148,10 @@ class SystemConfigApi {
return null; return null;
} }
/// Performs an HTTP 'PUT /system-config' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `systemConfig.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [SystemConfigDto] systemConfigDto (required): /// * [SystemConfigDto] systemConfigDto (required):
@ -168,6 +180,8 @@ class SystemConfigApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `systemConfig.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [SystemConfigDto] systemConfigDto (required): /// * [SystemConfigDto] systemConfigDto (required):

View File

@ -16,7 +16,9 @@ class SystemMetadataApi {
final ApiClient apiClient; final ApiClient apiClient;
/// Performs an HTTP 'GET /system-metadata/admin-onboarding' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `systemMetadata.read` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getAdminOnboardingWithHttpInfo() async { Future<Response> getAdminOnboardingWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/system-metadata/admin-onboarding'; final apiPath = r'/system-metadata/admin-onboarding';
@ -42,6 +44,7 @@ class SystemMetadataApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `systemMetadata.read` permission.
Future<AdminOnboardingUpdateDto?> getAdminOnboarding() async { Future<AdminOnboardingUpdateDto?> getAdminOnboarding() async {
final response = await getAdminOnboardingWithHttpInfo(); final response = await getAdminOnboardingWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -57,7 +60,9 @@ class SystemMetadataApi {
return null; return null;
} }
/// Performs an HTTP 'GET /system-metadata/reverse-geocoding-state' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `systemMetadata.read` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getReverseGeocodingStateWithHttpInfo() async { Future<Response> getReverseGeocodingStateWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/system-metadata/reverse-geocoding-state'; final apiPath = r'/system-metadata/reverse-geocoding-state';
@ -83,6 +88,7 @@ class SystemMetadataApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `systemMetadata.read` permission.
Future<ReverseGeocodingStateResponseDto?> getReverseGeocodingState() async { Future<ReverseGeocodingStateResponseDto?> getReverseGeocodingState() async {
final response = await getReverseGeocodingStateWithHttpInfo(); final response = await getReverseGeocodingStateWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -98,7 +104,9 @@ class SystemMetadataApi {
return null; return null;
} }
/// Performs an HTTP 'GET /system-metadata/version-check-state' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `systemMetadata.read` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getVersionCheckStateWithHttpInfo() async { Future<Response> getVersionCheckStateWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/system-metadata/version-check-state'; final apiPath = r'/system-metadata/version-check-state';
@ -124,6 +132,7 @@ class SystemMetadataApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `systemMetadata.read` permission.
Future<VersionCheckStateResponseDto?> getVersionCheckState() async { Future<VersionCheckStateResponseDto?> getVersionCheckState() async {
final response = await getVersionCheckStateWithHttpInfo(); final response = await getVersionCheckStateWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -139,7 +148,10 @@ class SystemMetadataApi {
return null; return null;
} }
/// Performs an HTTP 'POST /system-metadata/admin-onboarding' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `systemMetadata.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [AdminOnboardingUpdateDto] adminOnboardingUpdateDto (required): /// * [AdminOnboardingUpdateDto] adminOnboardingUpdateDto (required):
@ -168,6 +180,8 @@ class SystemMetadataApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `systemMetadata.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [AdminOnboardingUpdateDto] adminOnboardingUpdateDto (required): /// * [AdminOnboardingUpdateDto] adminOnboardingUpdateDto (required):

View File

@ -16,7 +16,10 @@ class TagsApi {
final ApiClient apiClient; final ApiClient apiClient;
/// Performs an HTTP 'PUT /tags/assets' operation and returns the [Response]. /// This endpoint requires the `tag.asset` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [TagBulkAssetsDto] tagBulkAssetsDto (required): /// * [TagBulkAssetsDto] tagBulkAssetsDto (required):
@ -45,6 +48,8 @@ class TagsApi {
); );
} }
/// This endpoint requires the `tag.asset` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [TagBulkAssetsDto] tagBulkAssetsDto (required): /// * [TagBulkAssetsDto] tagBulkAssetsDto (required):
@ -63,7 +68,10 @@ class TagsApi {
return null; return null;
} }
/// Performs an HTTP 'POST /tags' operation and returns the [Response]. /// This endpoint requires the `tag.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [TagCreateDto] tagCreateDto (required): /// * [TagCreateDto] tagCreateDto (required):
@ -92,6 +100,8 @@ class TagsApi {
); );
} }
/// This endpoint requires the `tag.create` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [TagCreateDto] tagCreateDto (required): /// * [TagCreateDto] tagCreateDto (required):
@ -110,7 +120,10 @@ class TagsApi {
return null; return null;
} }
/// Performs an HTTP 'DELETE /tags/{id}' operation and returns the [Response]. /// This endpoint requires the `tag.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -140,6 +153,8 @@ class TagsApi {
); );
} }
/// This endpoint requires the `tag.delete` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -150,7 +165,9 @@ class TagsApi {
} }
} }
/// Performs an HTTP 'GET /tags' operation and returns the [Response]. /// This endpoint requires the `tag.read` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getAllTagsWithHttpInfo() async { Future<Response> getAllTagsWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/tags'; final apiPath = r'/tags';
@ -176,6 +193,7 @@ class TagsApi {
); );
} }
/// This endpoint requires the `tag.read` permission.
Future<List<TagResponseDto>?> getAllTags() async { Future<List<TagResponseDto>?> getAllTags() async {
final response = await getAllTagsWithHttpInfo(); final response = await getAllTagsWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -194,7 +212,10 @@ class TagsApi {
return null; return null;
} }
/// Performs an HTTP 'GET /tags/{id}' operation and returns the [Response]. /// This endpoint requires the `tag.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -224,6 +245,8 @@ class TagsApi {
); );
} }
/// This endpoint requires the `tag.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -242,7 +265,10 @@ class TagsApi {
return null; return null;
} }
/// Performs an HTTP 'PUT /tags/{id}/assets' operation and returns the [Response]. /// This endpoint requires the `tag.asset` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -274,6 +300,8 @@ class TagsApi {
); );
} }
/// This endpoint requires the `tag.asset` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -297,7 +325,10 @@ class TagsApi {
return null; return null;
} }
/// Performs an HTTP 'DELETE /tags/{id}/assets' operation and returns the [Response]. /// This endpoint requires the `tag.asset` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -329,6 +360,8 @@ class TagsApi {
); );
} }
/// This endpoint requires the `tag.asset` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -352,7 +385,10 @@ class TagsApi {
return null; return null;
} }
/// Performs an HTTP 'PUT /tags/{id}' operation and returns the [Response]. /// This endpoint requires the `tag.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -384,6 +420,8 @@ class TagsApi {
); );
} }
/// This endpoint requires the `tag.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -404,7 +442,10 @@ class TagsApi {
return null; return null;
} }
/// Performs an HTTP 'PUT /tags' operation and returns the [Response]. /// This endpoint requires the `tag.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [TagUpsertDto] tagUpsertDto (required): /// * [TagUpsertDto] tagUpsertDto (required):
@ -433,6 +474,8 @@ class TagsApi {
); );
} }
/// This endpoint requires the `tag.create` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [TagUpsertDto] tagUpsertDto (required): /// * [TagUpsertDto] tagUpsertDto (required):

View File

@ -16,7 +16,10 @@ class TimelineApi {
final ApiClient apiClient; final ApiClient apiClient;
/// Performs an HTTP 'GET /timeline/bucket' operation and returns the [Response]. /// This endpoint requires the `asset.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] timeBucket (required): /// * [String] timeBucket (required):
@ -118,6 +121,8 @@ class TimelineApi {
); );
} }
/// This endpoint requires the `asset.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] timeBucket (required): /// * [String] timeBucket (required):
@ -171,7 +176,10 @@ class TimelineApi {
return null; return null;
} }
/// Performs an HTTP 'GET /timeline/buckets' operation and returns the [Response]. /// This endpoint requires the `asset.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] albumId: /// * [String] albumId:
@ -269,6 +277,8 @@ class TimelineApi {
); );
} }
/// This endpoint requires the `asset.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] albumId: /// * [String] albumId:

View File

@ -16,7 +16,9 @@ class TrashApi {
final ApiClient apiClient; final ApiClient apiClient;
/// Performs an HTTP 'POST /trash/empty' operation and returns the [Response]. /// This endpoint requires the `asset.delete` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> emptyTrashWithHttpInfo() async { Future<Response> emptyTrashWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/trash/empty'; final apiPath = r'/trash/empty';
@ -42,6 +44,7 @@ class TrashApi {
); );
} }
/// This endpoint requires the `asset.delete` permission.
Future<TrashResponseDto?> emptyTrash() async { Future<TrashResponseDto?> emptyTrash() async {
final response = await emptyTrashWithHttpInfo(); final response = await emptyTrashWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -57,7 +60,10 @@ class TrashApi {
return null; return null;
} }
/// Performs an HTTP 'POST /trash/restore/assets' operation and returns the [Response]. /// This endpoint requires the `asset.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [BulkIdsDto] bulkIdsDto (required): /// * [BulkIdsDto] bulkIdsDto (required):
@ -86,6 +92,8 @@ class TrashApi {
); );
} }
/// This endpoint requires the `asset.delete` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [BulkIdsDto] bulkIdsDto (required): /// * [BulkIdsDto] bulkIdsDto (required):
@ -104,7 +112,9 @@ class TrashApi {
return null; return null;
} }
/// Performs an HTTP 'POST /trash/restore' operation and returns the [Response]. /// This endpoint requires the `asset.delete` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> restoreTrashWithHttpInfo() async { Future<Response> restoreTrashWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/trash/restore'; final apiPath = r'/trash/restore';
@ -130,6 +140,7 @@ class TrashApi {
); );
} }
/// This endpoint requires the `asset.delete` permission.
Future<TrashResponseDto?> restoreTrash() async { Future<TrashResponseDto?> restoreTrash() async {
final response = await restoreTrashWithHttpInfo(); final response = await restoreTrashWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {

View File

@ -16,7 +16,10 @@ class UsersAdminApi {
final ApiClient apiClient; final ApiClient apiClient;
/// Performs an HTTP 'POST /admin/users' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `adminUser.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [UserAdminCreateDto] userAdminCreateDto (required): /// * [UserAdminCreateDto] userAdminCreateDto (required):
@ -45,6 +48,8 @@ class UsersAdminApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `adminUser.create` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [UserAdminCreateDto] userAdminCreateDto (required): /// * [UserAdminCreateDto] userAdminCreateDto (required):
@ -63,7 +68,10 @@ class UsersAdminApi {
return null; return null;
} }
/// Performs an HTTP 'DELETE /admin/users/{id}' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `adminUser.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -95,6 +103,8 @@ class UsersAdminApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `adminUser.delete` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -115,7 +125,10 @@ class UsersAdminApi {
return null; return null;
} }
/// Performs an HTTP 'GET /admin/users/{id}' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `adminUser.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -145,6 +158,8 @@ class UsersAdminApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `adminUser.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -163,7 +178,10 @@ class UsersAdminApi {
return null; return null;
} }
/// Performs an HTTP 'GET /admin/users/{id}/preferences' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `adminUser.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -193,6 +211,8 @@ class UsersAdminApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `adminUser.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -211,7 +231,10 @@ class UsersAdminApi {
return null; return null;
} }
/// Performs an HTTP 'GET /admin/users/{id}/statistics' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `adminUser.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -257,6 +280,8 @@ class UsersAdminApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `adminUser.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -281,7 +306,10 @@ class UsersAdminApi {
return null; return null;
} }
/// Performs an HTTP 'POST /admin/users/{id}/restore' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `adminUser.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -311,6 +339,8 @@ class UsersAdminApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `adminUser.delete` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -329,7 +359,10 @@ class UsersAdminApi {
return null; return null;
} }
/// Performs an HTTP 'GET /admin/users' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `adminUser.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id: /// * [String] id:
@ -367,6 +400,8 @@ class UsersAdminApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `adminUser.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id: /// * [String] id:
@ -390,7 +425,10 @@ class UsersAdminApi {
return null; return null;
} }
/// Performs an HTTP 'PUT /admin/users/{id}' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `adminUser.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -422,6 +460,8 @@ class UsersAdminApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `adminUser.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -442,7 +482,10 @@ class UsersAdminApi {
return null; return null;
} }
/// Performs an HTTP 'PUT /admin/users/{id}/preferences' operation and returns the [Response]. /// This endpoint is an admin-only route, and requires the `adminUser.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -474,6 +517,8 @@ class UsersAdminApi {
); );
} }
/// This endpoint is an admin-only route, and requires the `adminUser.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):

View File

@ -16,7 +16,10 @@ class UsersApi {
final ApiClient apiClient; final ApiClient apiClient;
/// Performs an HTTP 'POST /users/profile-image' operation and returns the [Response]. /// This endpoint requires the `userProfileImage.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [MultipartFile] file (required): /// * [MultipartFile] file (required):
@ -55,6 +58,8 @@ class UsersApi {
); );
} }
/// This endpoint requires the `userProfileImage.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [MultipartFile] file (required): /// * [MultipartFile] file (required):
@ -73,7 +78,9 @@ class UsersApi {
return null; return null;
} }
/// Performs an HTTP 'DELETE /users/profile-image' operation and returns the [Response]. /// This endpoint requires the `userProfileImage.delete` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> deleteProfileImageWithHttpInfo() async { Future<Response> deleteProfileImageWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/users/profile-image'; final apiPath = r'/users/profile-image';
@ -99,6 +106,7 @@ class UsersApi {
); );
} }
/// This endpoint requires the `userProfileImage.delete` permission.
Future<void> deleteProfileImage() async { Future<void> deleteProfileImage() async {
final response = await deleteProfileImageWithHttpInfo(); final response = await deleteProfileImageWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -106,7 +114,9 @@ class UsersApi {
} }
} }
/// Performs an HTTP 'DELETE /users/me/license' operation and returns the [Response]. /// This endpoint requires the `userLicense.delete` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> deleteUserLicenseWithHttpInfo() async { Future<Response> deleteUserLicenseWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/users/me/license'; final apiPath = r'/users/me/license';
@ -132,6 +142,7 @@ class UsersApi {
); );
} }
/// This endpoint requires the `userLicense.delete` permission.
Future<void> deleteUserLicense() async { Future<void> deleteUserLicense() async {
final response = await deleteUserLicenseWithHttpInfo(); final response = await deleteUserLicenseWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -139,7 +150,9 @@ class UsersApi {
} }
} }
/// Performs an HTTP 'DELETE /users/me/onboarding' operation and returns the [Response]. /// This endpoint requires the `userOnboarding.delete` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> deleteUserOnboardingWithHttpInfo() async { Future<Response> deleteUserOnboardingWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/users/me/onboarding'; final apiPath = r'/users/me/onboarding';
@ -165,6 +178,7 @@ class UsersApi {
); );
} }
/// This endpoint requires the `userOnboarding.delete` permission.
Future<void> deleteUserOnboarding() async { Future<void> deleteUserOnboarding() async {
final response = await deleteUserOnboardingWithHttpInfo(); final response = await deleteUserOnboardingWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -172,7 +186,9 @@ class UsersApi {
} }
} }
/// Performs an HTTP 'GET /users/me/preferences' operation and returns the [Response]. /// This endpoint requires the `userPreference.read` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getMyPreferencesWithHttpInfo() async { Future<Response> getMyPreferencesWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/users/me/preferences'; final apiPath = r'/users/me/preferences';
@ -198,6 +214,7 @@ class UsersApi {
); );
} }
/// This endpoint requires the `userPreference.read` permission.
Future<UserPreferencesResponseDto?> getMyPreferences() async { Future<UserPreferencesResponseDto?> getMyPreferences() async {
final response = await getMyPreferencesWithHttpInfo(); final response = await getMyPreferencesWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -213,7 +230,9 @@ class UsersApi {
return null; return null;
} }
/// Performs an HTTP 'GET /users/me' operation and returns the [Response]. /// This endpoint requires the `user.read` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getMyUserWithHttpInfo() async { Future<Response> getMyUserWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/users/me'; final apiPath = r'/users/me';
@ -239,6 +258,7 @@ class UsersApi {
); );
} }
/// This endpoint requires the `user.read` permission.
Future<UserAdminResponseDto?> getMyUser() async { Future<UserAdminResponseDto?> getMyUser() async {
final response = await getMyUserWithHttpInfo(); final response = await getMyUserWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -254,7 +274,10 @@ class UsersApi {
return null; return null;
} }
/// Performs an HTTP 'GET /users/{id}/profile-image' operation and returns the [Response]. /// This endpoint requires the `userProfileImage.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -284,6 +307,8 @@ class UsersApi {
); );
} }
/// This endpoint requires the `userProfileImage.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -302,7 +327,10 @@ class UsersApi {
return null; return null;
} }
/// Performs an HTTP 'GET /users/{id}' operation and returns the [Response]. /// This endpoint requires the `user.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -332,6 +360,8 @@ class UsersApi {
); );
} }
/// This endpoint requires the `user.read` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [String] id (required): /// * [String] id (required):
@ -350,7 +380,9 @@ class UsersApi {
return null; return null;
} }
/// Performs an HTTP 'GET /users/me/license' operation and returns the [Response]. /// This endpoint requires the `userLicense.read` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getUserLicenseWithHttpInfo() async { Future<Response> getUserLicenseWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/users/me/license'; final apiPath = r'/users/me/license';
@ -376,6 +408,7 @@ class UsersApi {
); );
} }
/// This endpoint requires the `userLicense.read` permission.
Future<LicenseResponseDto?> getUserLicense() async { Future<LicenseResponseDto?> getUserLicense() async {
final response = await getUserLicenseWithHttpInfo(); final response = await getUserLicenseWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -391,7 +424,9 @@ class UsersApi {
return null; return null;
} }
/// Performs an HTTP 'GET /users/me/onboarding' operation and returns the [Response]. /// This endpoint requires the `userOnboarding.read` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getUserOnboardingWithHttpInfo() async { Future<Response> getUserOnboardingWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/users/me/onboarding'; final apiPath = r'/users/me/onboarding';
@ -417,6 +452,7 @@ class UsersApi {
); );
} }
/// This endpoint requires the `userOnboarding.read` permission.
Future<OnboardingResponseDto?> getUserOnboarding() async { Future<OnboardingResponseDto?> getUserOnboarding() async {
final response = await getUserOnboardingWithHttpInfo(); final response = await getUserOnboardingWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -432,7 +468,9 @@ class UsersApi {
return null; return null;
} }
/// Performs an HTTP 'GET /users' operation and returns the [Response]. /// This endpoint requires the `user.read` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> searchUsersWithHttpInfo() async { Future<Response> searchUsersWithHttpInfo() async {
// ignore: prefer_const_declarations // ignore: prefer_const_declarations
final apiPath = r'/users'; final apiPath = r'/users';
@ -458,6 +496,7 @@ class UsersApi {
); );
} }
/// This endpoint requires the `user.read` permission.
Future<List<UserResponseDto>?> searchUsers() async { Future<List<UserResponseDto>?> searchUsers() async {
final response = await searchUsersWithHttpInfo(); final response = await searchUsersWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) { if (response.statusCode >= HttpStatus.badRequest) {
@ -476,7 +515,10 @@ class UsersApi {
return null; return null;
} }
/// Performs an HTTP 'PUT /users/me/license' operation and returns the [Response]. /// This endpoint requires the `userLicense.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [LicenseKeyDto] licenseKeyDto (required): /// * [LicenseKeyDto] licenseKeyDto (required):
@ -505,6 +547,8 @@ class UsersApi {
); );
} }
/// This endpoint requires the `userLicense.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [LicenseKeyDto] licenseKeyDto (required): /// * [LicenseKeyDto] licenseKeyDto (required):
@ -523,7 +567,10 @@ class UsersApi {
return null; return null;
} }
/// Performs an HTTP 'PUT /users/me/onboarding' operation and returns the [Response]. /// This endpoint requires the `userOnboarding.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [OnboardingDto] onboardingDto (required): /// * [OnboardingDto] onboardingDto (required):
@ -552,6 +599,8 @@ class UsersApi {
); );
} }
/// This endpoint requires the `userOnboarding.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [OnboardingDto] onboardingDto (required): /// * [OnboardingDto] onboardingDto (required):
@ -570,7 +619,10 @@ class UsersApi {
return null; return null;
} }
/// Performs an HTTP 'PUT /users/me/preferences' operation and returns the [Response]. /// This endpoint requires the `userPreference.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [UserPreferencesUpdateDto] userPreferencesUpdateDto (required): /// * [UserPreferencesUpdateDto] userPreferencesUpdateDto (required):
@ -599,6 +651,8 @@ class UsersApi {
); );
} }
/// This endpoint requires the `userPreference.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [UserPreferencesUpdateDto] userPreferencesUpdateDto (required): /// * [UserPreferencesUpdateDto] userPreferencesUpdateDto (required):
@ -617,7 +671,10 @@ class UsersApi {
return null; return null;
} }
/// Performs an HTTP 'PUT /users/me' operation and returns the [Response]. /// This endpoint requires the `user.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters: /// Parameters:
/// ///
/// * [UserUpdateMeDto] userUpdateMeDto (required): /// * [UserUpdateMeDto] userUpdateMeDto (required):
@ -646,6 +703,8 @@ class UsersApi {
); );
} }
/// This endpoint requires the `user.update` permission.
///
/// Parameters: /// Parameters:
/// ///
/// * [UserUpdateMeDto] userUpdateMeDto (required): /// * [UserUpdateMeDto] userUpdateMeDto (required):

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -413,6 +413,11 @@ export enum LogLevel {
Fatal = 'fatal', Fatal = 'fatal',
} }
export enum ApiCustomExtension {
Permission = 'x-immich-permission',
AdminOnly = 'x-immich-admin-only',
}
export enum MetadataKey { export enum MetadataKey {
AuthRoute = 'auth_route', AuthRoute = 'auth_route',
AdminRoute = 'admin_route', AdminRoute = 'admin_route',

View File

@ -10,7 +10,7 @@ import { Reflector } from '@nestjs/core';
import { ApiBearerAuth, ApiCookieAuth, ApiExtension, ApiOkResponse, ApiQuery, ApiSecurity } from '@nestjs/swagger'; import { ApiBearerAuth, ApiCookieAuth, ApiExtension, ApiOkResponse, ApiQuery, ApiSecurity } from '@nestjs/swagger';
import { Request } from 'express'; import { Request } from 'express';
import { AuthDto } from 'src/dtos/auth.dto'; import { AuthDto } from 'src/dtos/auth.dto';
import { ImmichQuery, MetadataKey, Permission } from 'src/enum'; import { ApiCustomExtension, ImmichQuery, MetadataKey, Permission } from 'src/enum';
import { LoggingRepository } from 'src/repositories/logging.repository'; import { LoggingRepository } from 'src/repositories/logging.repository';
import { AuthService, LoginDetails } from 'src/services/auth.service'; import { AuthService, LoginDetails } from 'src/services/auth.service';
import { UAParser } from 'ua-parser-js'; import { UAParser } from 'ua-parser-js';
@ -19,16 +19,20 @@ type AdminRoute = { admin?: true };
type SharedLinkRoute = { sharedLink?: true }; type SharedLinkRoute = { sharedLink?: true };
type AuthenticatedOptions = { permission?: Permission } & (AdminRoute | SharedLinkRoute); type AuthenticatedOptions = { permission?: Permission } & (AdminRoute | SharedLinkRoute);
export const Authenticated = (options?: AuthenticatedOptions): MethodDecorator => { export const Authenticated = (options: AuthenticatedOptions = {}): MethodDecorator => {
const decorators: MethodDecorator[] = [ const decorators: MethodDecorator[] = [
ApiBearerAuth(), ApiBearerAuth(),
ApiCookieAuth(), ApiCookieAuth(),
ApiSecurity(MetadataKey.ApiKeySecurity), ApiSecurity(MetadataKey.ApiKeySecurity),
SetMetadata(MetadataKey.AuthRoute, options || {}), SetMetadata(MetadataKey.AuthRoute, options),
]; ];
if ((options as AdminRoute).admin) {
decorators.push(ApiExtension(ApiCustomExtension.AdminOnly, true));
}
if (options?.permission) { if (options?.permission) {
decorators.push(ApiExtension('x-immich-permission', options.permission)); decorators.push(ApiExtension(ApiCustomExtension.Permission, options.permission ?? Permission.All));
} }
if ((options as SharedLinkRoute)?.sharedLink) { if ((options as SharedLinkRoute)?.sharedLink) {

View File

@ -6,7 +6,11 @@ import {
SwaggerDocumentOptions, SwaggerDocumentOptions,
SwaggerModule, SwaggerModule,
} from '@nestjs/swagger'; } from '@nestjs/swagger';
import { ReferenceObject, SchemaObject } from '@nestjs/swagger/dist/interfaces/open-api-spec.interface'; import {
OperationObject,
ReferenceObject,
SchemaObject,
} from '@nestjs/swagger/dist/interfaces/open-api-spec.interface';
import _ from 'lodash'; import _ from 'lodash';
import { writeFileSync } from 'node:fs'; import { writeFileSync } from 'node:fs';
import path from 'node:path'; import path from 'node:path';
@ -15,7 +19,7 @@ import parse from 'picomatch/lib/parse';
import { SystemConfig } from 'src/config'; import { SystemConfig } from 'src/config';
import { CLIP_MODEL_INFO, serverVersion } from 'src/constants'; import { CLIP_MODEL_INFO, serverVersion } from 'src/constants';
import { extraSyncModels } from 'src/dtos/sync.dto'; import { extraSyncModels } from 'src/dtos/sync.dto';
import { ImmichCookie, ImmichHeader, MetadataKey } from 'src/enum'; import { ApiCustomExtension, ImmichCookie, ImmichHeader, MetadataKey } from 'src/enum';
import { LoggingRepository } from 'src/repositories/logging.repository'; import { LoggingRepository } from 'src/repositories/logging.repository';
export class ImmichStartupError extends Error {} export class ImmichStartupError extends Error {}
@ -198,7 +202,12 @@ const patchOpenAPI = (document: OpenAPIObject) => {
trace: path.trace, trace: path.trace,
}; };
for (const operation of Object.values(operations)) { for (const operation of Object.values(operations) as Array<
OperationObject & {
[ApiCustomExtension.AdminOnly]?: boolean;
[ApiCustomExtension.Permission]?: string;
}
>) {
if (!operation) { if (!operation) {
continue; continue;
} }
@ -211,12 +220,21 @@ const patchOpenAPI = (document: OpenAPIObject) => {
// console.log(`${routeToErrorMessage(operation.operationId).padEnd(40)} (${operation.operationId})`); // console.log(`${routeToErrorMessage(operation.operationId).padEnd(40)} (${operation.operationId})`);
} }
if (operation.description === '') { const adminOnly = operation[ApiCustomExtension.AdminOnly] ?? false;
delete operation.description; const permission = operation[ApiCustomExtension.Permission];
} if (permission) {
let description = (operation.description || '').trim();
if (description && !description.endsWith('.')) {
description += '. ';
}
if (operation.parameters) { operation.description =
operation.parameters = _.orderBy(operation.parameters, 'name'); description +
`This endpoint ${adminOnly ? 'is an admin-only route, and ' : ''}requires the \`${permission}\` permission.`;
if (operation.parameters) {
operation.parameters = _.orderBy(operation.parameters, 'name');
}
} }
} }
} }