helpy4/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich synced 2025-11-14 17:36:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge branch 'main' into feat/search-filter-album/web

Browse source
This commit is contained in:
CJPeckover 2025-10-08 23:36:08 -04:00
commit e2b5b30e30
2033 changed files with 182993 additions and 125013 deletions
Download patch file Download diff file Expand all files Collapse all files

28
mobile/openapi/lib/api/activities_api.dart generated
View file

@ -16,7 +16,10 @@ class ActivitiesApi {
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:
///
/// * [ActivityCreateDto] activityCreateDto (required):
@ -45,6 +48,8 @@ class ActivitiesApi {
);
}
/// This endpoint requires the `activity.create` permission.
///
/// Parameters:
///
/// * [ActivityCreateDto] activityCreateDto (required):
@ -63,7 +68,10 @@ class ActivitiesApi {
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:
///
/// * [String] id (required):
@ -93,6 +101,8 @@ class ActivitiesApi {
);
}
/// This endpoint requires the `activity.delete` permission.
///
/// Parameters:
///
/// * [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:
///
/// * [String] albumId (required):
@ -154,6 +167,8 @@ class ActivitiesApi {
);
}
/// This endpoint requires the `activity.read` permission.
///
/// Parameters:
///
/// * [String] albumId (required):
@ -183,7 +198,10 @@ class ActivitiesApi {
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:
///
/// * [String] albumId (required):
@ -219,6 +237,8 @@ class ActivitiesApi {
);
}
/// This endpoint requires the `activity.statistics` permission.
///
/// Parameters:
///
/// * [String] albumId (required):

74
mobile/openapi/lib/api/api_keys_api.dart generated
View file

@ -16,7 +16,10 @@ class APIKeysApi {
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:
///
/// * [APIKeyCreateDto] aPIKeyCreateDto (required):
@ -45,6 +48,8 @@ class APIKeysApi {
);
}
/// This endpoint requires the `apiKey.create` permission.
///
/// Parameters:
///
/// * [APIKeyCreateDto] aPIKeyCreateDto (required):
@ -63,7 +68,10 @@ class APIKeysApi {
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:
///
/// * [String] id (required):
@ -93,6 +101,8 @@ class APIKeysApi {
);
}
/// This endpoint requires the `apiKey.delete` permission.
///
/// Parameters:
///
/// * [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:
///
/// * [String] id (required):
@ -133,6 +146,8 @@ class APIKeysApi {
);
}
/// This endpoint requires the `apiKey.read` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -151,7 +166,9 @@ class APIKeysApi {
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 {
// ignore: prefer_const_declarations
final apiPath = r'/api-keys';
@ -177,6 +194,7 @@ class APIKeysApi {
);
}
/// This endpoint requires the `apiKey.read` permission.
Future<List<APIKeyResponseDto>?> getApiKeys() async {
final response = await getApiKeysWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -195,7 +213,51 @@ class APIKeysApi {
return null;
}
/// Performs an HTTP 'PUT /api-keys/{id}' operation and returns the [Response].
/// Performs an HTTP 'GET /api-keys/me' operation and returns the [Response].
Future<Response> getMyApiKeyWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = r'/api-keys/me';
// ignore: prefer_final_locals
Object? postBody;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>[];
return apiClient.invokeAPI(
apiPath,
'GET',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
Future<APIKeyResponseDto?> getMyApiKey() async {
final response = await getMyApiKeyWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'APIKeyResponseDto',) as APIKeyResponseDto;
}
return null;
}
/// This endpoint requires the `apiKey.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
@ -227,6 +289,8 @@ class APIKeysApi {
);
}
/// This endpoint requires the `apiKey.update` permission.
///
/// Parameters:
///
/// * [String] id (required):

389
mobile/openapi/lib/api/assets_api.dart generated
View file

@ -18,7 +18,7 @@ class AssetsApi {
/// checkBulkUpload
///
/// Checks if assets exist by checksums
/// Checks if assets exist by checksums. This endpoint requires the `asset.upload` permission.
///
/// Note: This method returns the HTTP [Response].
///
@ -52,7 +52,7 @@ class AssetsApi {
/// checkBulkUpload
///
/// Checks if assets exist by checksums
/// Checks if assets exist by checksums. This endpoint requires the `asset.upload` permission.
///
/// Parameters:
///
@ -128,7 +128,60 @@ class AssetsApi {
return null;
}
/// Performs an HTTP 'DELETE /assets' operation and returns the [Response].
/// This endpoint requires the `asset.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
///
/// * [AssetMetadataKey] key (required):
Future<Response> deleteAssetMetadataWithHttpInfo(String id, AssetMetadataKey key,) async {
// ignore: prefer_const_declarations
final apiPath = r'/assets/{id}/metadata/{key}'
.replaceAll('{id}', id)
.replaceAll('{key}', key.toString());
// ignore: prefer_final_locals
Object? postBody;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>[];
return apiClient.invokeAPI(
apiPath,
'DELETE',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
/// This endpoint requires the `asset.update` permission.
///
/// Parameters:
///
/// * [String] id (required):
///
/// * [AssetMetadataKey] key (required):
Future<void> deleteAssetMetadata(String id, AssetMetadataKey key,) async {
final response = await deleteAssetMetadataWithHttpInfo(id, key,);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
}
/// This endpoint requires the `asset.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [AssetBulkDeleteDto] assetBulkDeleteDto (required):
@ -157,6 +210,8 @@ class AssetsApi {
);
}
/// This endpoint requires the `asset.delete` permission.
///
/// Parameters:
///
/// * [AssetBulkDeleteDto] assetBulkDeleteDto (required):
@ -167,13 +222,18 @@ 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:
///
/// * [String] id (required):
///
/// * [String] key:
Future<Response> downloadAssetWithHttpInfo(String id, { String? key, }) async {
///
/// * [String] slug:
Future<Response> downloadAssetWithHttpInfo(String id, { String? key, String? slug, }) async {
// ignore: prefer_const_declarations
final apiPath = r'/assets/{id}/original'
.replaceAll('{id}', id);
@ -188,6 +248,9 @@ class AssetsApi {
if (key != null) {
queryParams.addAll(_queryParams('', 'key', key));
}
if (slug != null) {
queryParams.addAll(_queryParams('', 'slug', slug));
}
const contentTypes = <String>[];
@ -203,13 +266,17 @@ class AssetsApi {
);
}
/// This endpoint requires the `asset.download` permission.
///
/// Parameters:
///
/// * [String] id (required):
///
/// * [String] key:
Future<MultipartFile?> downloadAsset(String id, { String? key, }) async {
final response = await downloadAssetWithHttpInfo(id, key: key, );
///
/// * [String] slug:
Future<MultipartFile?> downloadAsset(String id, { String? key, String? slug, }) async {
final response = await downloadAssetWithHttpInfo(id, key: key, slug: slug, );
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
@ -283,13 +350,18 @@ class AssetsApi {
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:
///
/// * [String] id (required):
///
/// * [String] key:
Future<Response> getAssetInfoWithHttpInfo(String id, { String? key, }) async {
///
/// * [String] slug:
Future<Response> getAssetInfoWithHttpInfo(String id, { String? key, String? slug, }) async {
// ignore: prefer_const_declarations
final apiPath = r'/assets/{id}'
.replaceAll('{id}', id);
@ -304,6 +376,9 @@ class AssetsApi {
if (key != null) {
queryParams.addAll(_queryParams('', 'key', key));
}
if (slug != null) {
queryParams.addAll(_queryParams('', 'slug', slug));
}
const contentTypes = <String>[];
@ -319,13 +394,17 @@ class AssetsApi {
);
}
/// This endpoint requires the `asset.read` permission.
///
/// Parameters:
///
/// * [String] id (required):
///
/// * [String] key:
Future<AssetResponseDto?> getAssetInfo(String id, { String? key, }) async {
final response = await getAssetInfoWithHttpInfo(id, key: key, );
///
/// * [String] slug:
Future<AssetResponseDto?> getAssetInfo(String id, { String? key, String? slug, }) async {
final response = await getAssetInfoWithHttpInfo(id, key: key, slug: slug, );
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
@ -339,7 +418,124 @@ class AssetsApi {
return null;
}
/// Performs an HTTP 'GET /assets/statistics' operation and returns the [Response].
/// This endpoint requires the `asset.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
Future<Response> getAssetMetadataWithHttpInfo(String id,) async {
// ignore: prefer_const_declarations
final apiPath = r'/assets/{id}/metadata'
.replaceAll('{id}', id);
// ignore: prefer_final_locals
Object? postBody;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>[];
return apiClient.invokeAPI(
apiPath,
'GET',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
/// This endpoint requires the `asset.read` permission.
///
/// Parameters:
///
/// * [String] id (required):
Future<List<AssetMetadataResponseDto>?> getAssetMetadata(String id,) async {
final response = await getAssetMetadataWithHttpInfo(id,);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
final responseBody = await _decodeBodyBytes(response);
return (await apiClient.deserializeAsync(responseBody, 'List<AssetMetadataResponseDto>') as List)
.cast<AssetMetadataResponseDto>()
.toList(growable: false);
}
return null;
}
/// This endpoint requires the `asset.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
///
/// * [AssetMetadataKey] key (required):
Future<Response> getAssetMetadataByKeyWithHttpInfo(String id, AssetMetadataKey key,) async {
// ignore: prefer_const_declarations
final apiPath = r'/assets/{id}/metadata/{key}'
.replaceAll('{id}', id)
.replaceAll('{key}', key.toString());
// ignore: prefer_final_locals
Object? postBody;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>[];
return apiClient.invokeAPI(
apiPath,
'GET',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
/// This endpoint requires the `asset.read` permission.
///
/// Parameters:
///
/// * [String] id (required):
///
/// * [AssetMetadataKey] key (required):
Future<AssetMetadataResponseDto?> getAssetMetadataByKey(String id, AssetMetadataKey key,) async {
final response = await getAssetMetadataByKeyWithHttpInfo(id, key,);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'AssetMetadataResponseDto',) as AssetMetadataResponseDto;
}
return null;
}
/// This endpoint requires the `asset.statistics` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [bool] isFavorite:
@ -382,6 +578,8 @@ class AssetsApi {
);
}
/// This endpoint requires the `asset.statistics` permission.
///
/// Parameters:
///
/// * [bool] isFavorite:
@ -404,7 +602,7 @@ class AssetsApi {
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].
///
@ -440,7 +638,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:
///
@ -463,13 +661,18 @@ class AssetsApi {
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:
///
/// * [String] id (required):
///
/// * [String] key:
Future<Response> playAssetVideoWithHttpInfo(String id, { String? key, }) async {
///
/// * [String] slug:
Future<Response> playAssetVideoWithHttpInfo(String id, { String? key, String? slug, }) async {
// ignore: prefer_const_declarations
final apiPath = r'/assets/{id}/video/playback'
.replaceAll('{id}', id);
@ -484,6 +687,9 @@ class AssetsApi {
if (key != null) {
queryParams.addAll(_queryParams('', 'key', key));
}
if (slug != null) {
queryParams.addAll(_queryParams('', 'slug', slug));
}
const contentTypes = <String>[];
@ -499,13 +705,17 @@ class AssetsApi {
);
}
/// This endpoint requires the `asset.view` permission.
///
/// Parameters:
///
/// * [String] id (required):
///
/// * [String] key:
Future<MultipartFile?> playAssetVideo(String id, { String? key, }) async {
final response = await playAssetVideoWithHttpInfo(id, key: key, );
///
/// * [String] slug:
Future<MultipartFile?> playAssetVideo(String id, { String? key, String? slug, }) async {
final response = await playAssetVideoWithHttpInfo(id, key: key, slug: slug, );
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
@ -519,10 +729,10 @@ class AssetsApi {
return null;
}
/// replaceAsset
///
/// Replace the asset with new file, without changing its id
///
/// This property was deprecated in v1.142.0. Replace the asset with new file, without changing its id. This endpoint requires the `asset.replace` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
@ -541,10 +751,12 @@ class AssetsApi {
///
/// * [String] key:
///
/// * [String] slug:
///
/// * [String] duration:
///
/// * [String] filename:
Future<Response> replaceAssetWithHttpInfo(String id, MultipartFile assetData, String deviceAssetId, String deviceId, DateTime fileCreatedAt, DateTime fileModifiedAt, { String? key, String? duration, String? filename, }) async {
Future<Response> replaceAssetWithHttpInfo(String id, MultipartFile assetData, String deviceAssetId, String deviceId, DateTime fileCreatedAt, DateTime fileModifiedAt, { String? key, String? slug, String? duration, String? filename, }) async {
// ignore: prefer_const_declarations
final apiPath = r'/assets/{id}/original'
.replaceAll('{id}', id);
@ -559,6 +771,9 @@ class AssetsApi {
if (key != null) {
queryParams.addAll(_queryParams('', 'key', key));
}
if (slug != null) {
queryParams.addAll(_queryParams('', 'slug', slug));
}
const contentTypes = <String>['multipart/form-data'];
@ -608,10 +823,10 @@ class AssetsApi {
);
}
/// replaceAsset
///
/// Replace the asset with new file, without changing its id
///
/// This property was deprecated in v1.142.0. Replace the asset with new file, without changing its id. This endpoint requires the `asset.replace` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -628,11 +843,13 @@ class AssetsApi {
///
/// * [String] key:
///
/// * [String] slug:
///
/// * [String] duration:
///
/// * [String] filename:
Future<AssetMediaResponseDto?> replaceAsset(String id, MultipartFile assetData, String deviceAssetId, String deviceId, DateTime fileCreatedAt, DateTime fileModifiedAt, { String? key, String? duration, String? filename, }) async {
final response = await replaceAssetWithHttpInfo(id, assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, key: key, duration: duration, filename: filename, );
Future<AssetMediaResponseDto?> replaceAsset(String id, MultipartFile assetData, String deviceAssetId, String deviceId, DateTime fileCreatedAt, DateTime fileModifiedAt, { String? key, String? slug, String? duration, String? filename, }) async {
final response = await replaceAssetWithHttpInfo(id, assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, key: key, slug: slug, duration: duration, filename: filename, );
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
@ -685,7 +902,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:
///
/// * [String] id (required):
@ -717,6 +937,8 @@ class AssetsApi {
);
}
/// This endpoint requires the `asset.update` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -737,7 +959,70 @@ class AssetsApi {
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:
///
/// * [String] id (required):
///
/// * [AssetMetadataUpsertDto] assetMetadataUpsertDto (required):
Future<Response> updateAssetMetadataWithHttpInfo(String id, AssetMetadataUpsertDto assetMetadataUpsertDto,) async {
// ignore: prefer_const_declarations
final apiPath = r'/assets/{id}/metadata'
.replaceAll('{id}', id);
// ignore: prefer_final_locals
Object? postBody = assetMetadataUpsertDto;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>['application/json'];
return apiClient.invokeAPI(
apiPath,
'PUT',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
/// This endpoint requires the `asset.update` permission.
///
/// Parameters:
///
/// * [String] id (required):
///
/// * [AssetMetadataUpsertDto] assetMetadataUpsertDto (required):
Future<List<AssetMetadataResponseDto>?> updateAssetMetadata(String id, AssetMetadataUpsertDto assetMetadataUpsertDto,) async {
final response = await updateAssetMetadataWithHttpInfo(id, assetMetadataUpsertDto,);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
final responseBody = await _decodeBodyBytes(response);
return (await apiClient.deserializeAsync(responseBody, 'List<AssetMetadataResponseDto>') as List)
.cast<AssetMetadataResponseDto>()
.toList(growable: false);
}
return null;
}
/// This endpoint requires the `asset.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [AssetBulkUpdateDto] assetBulkUpdateDto (required):
@ -766,6 +1051,8 @@ class AssetsApi {
);
}
/// This endpoint requires the `asset.update` permission.
///
/// Parameters:
///
/// * [AssetBulkUpdateDto] assetBulkUpdateDto (required):
@ -776,7 +1063,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:
///
/// * [MultipartFile] assetData (required):
@ -789,8 +1079,12 @@ class AssetsApi {
///
/// * [DateTime] fileModifiedAt (required):
///
/// * [List<AssetMetadataUpsertItemDto>] metadata (required):
///
/// * [String] key:
///
/// * [String] slug:
///
/// * [String] xImmichChecksum:
/// sha1 checksum that can be used for duplicate detection before the file is uploaded
///
@ -805,7 +1099,7 @@ class AssetsApi {
/// * [MultipartFile] sidecarData:
///
/// * [AssetVisibility] visibility:
Future<Response> uploadAssetWithHttpInfo(MultipartFile assetData, String deviceAssetId, String deviceId, DateTime fileCreatedAt, DateTime fileModifiedAt, { String? key, String? xImmichChecksum, String? duration, String? filename, bool? isFavorite, String? livePhotoVideoId, MultipartFile? sidecarData, AssetVisibility? visibility, }) async {
Future<Response> uploadAssetWithHttpInfo(MultipartFile assetData, String deviceAssetId, String deviceId, DateTime fileCreatedAt, DateTime fileModifiedAt, List<AssetMetadataUpsertItemDto> metadata, { String? key, String? slug, String? xImmichChecksum, String? duration, String? filename, bool? isFavorite, String? livePhotoVideoId, MultipartFile? sidecarData, AssetVisibility? visibility, }) async {
// ignore: prefer_const_declarations
final apiPath = r'/assets';
@ -819,6 +1113,9 @@ class AssetsApi {
if (key != null) {
queryParams.addAll(_queryParams('', 'key', key));
}
if (slug != null) {
queryParams.addAll(_queryParams('', 'slug', slug));
}
if (xImmichChecksum != null) {
headerParams[r'x-immich-checksum'] = parameterToString(xImmichChecksum);
@ -865,6 +1162,10 @@ class AssetsApi {
hasFields = true;
mp.fields[r'livePhotoVideoId'] = parameterToString(livePhotoVideoId);
}
if (metadata != null) {
hasFields = true;
mp.fields[r'metadata'] = parameterToString(metadata);
}
if (sidecarData != null) {
hasFields = true;
mp.fields[r'sidecarData'] = sidecarData.field;
@ -889,6 +1190,8 @@ class AssetsApi {
);
}
/// This endpoint requires the `asset.upload` permission.
///
/// Parameters:
///
/// * [MultipartFile] assetData (required):
@ -901,8 +1204,12 @@ class AssetsApi {
///
/// * [DateTime] fileModifiedAt (required):
///
/// * [List<AssetMetadataUpsertItemDto>] metadata (required):
///
/// * [String] key:
///
/// * [String] slug:
///
/// * [String] xImmichChecksum:
/// sha1 checksum that can be used for duplicate detection before the file is uploaded
///
@ -917,8 +1224,8 @@ class AssetsApi {
/// * [MultipartFile] sidecarData:
///
/// * [AssetVisibility] visibility:
Future<AssetMediaResponseDto?> uploadAsset(MultipartFile assetData, String deviceAssetId, String deviceId, DateTime fileCreatedAt, DateTime fileModifiedAt, { String? key, String? xImmichChecksum, String? duration, String? filename, bool? isFavorite, String? livePhotoVideoId, MultipartFile? sidecarData, AssetVisibility? visibility, }) async {
final response = await uploadAssetWithHttpInfo(assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, key: key, xImmichChecksum: xImmichChecksum, duration: duration, filename: filename, isFavorite: isFavorite, livePhotoVideoId: livePhotoVideoId, sidecarData: sidecarData, visibility: visibility, );
Future<AssetMediaResponseDto?> uploadAsset(MultipartFile assetData, String deviceAssetId, String deviceId, DateTime fileCreatedAt, DateTime fileModifiedAt, List<AssetMetadataUpsertItemDto> metadata, { String? key, String? slug, String? xImmichChecksum, String? duration, String? filename, bool? isFavorite, String? livePhotoVideoId, MultipartFile? sidecarData, AssetVisibility? visibility, }) async {
final response = await uploadAssetWithHttpInfo(assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, metadata, key: key, slug: slug, xImmichChecksum: xImmichChecksum, duration: duration, filename: filename, isFavorite: isFavorite, livePhotoVideoId: livePhotoVideoId, sidecarData: sidecarData, visibility: visibility, );
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
@ -932,7 +1239,10 @@ class AssetsApi {
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:
///
/// * [String] id (required):
@ -940,7 +1250,9 @@ class AssetsApi {
/// * [String] key:
///
/// * [AssetMediaSize] size:
Future<Response> viewAssetWithHttpInfo(String id, { String? key, AssetMediaSize? size, }) async {
///
/// * [String] slug:
Future<Response> viewAssetWithHttpInfo(String id, { String? key, AssetMediaSize? size, String? slug, }) async {
// ignore: prefer_const_declarations
final apiPath = r'/assets/{id}/thumbnail'
.replaceAll('{id}', id);
@ -958,6 +1270,9 @@ class AssetsApi {
if (size != null) {
queryParams.addAll(_queryParams('', 'size', size));
}
if (slug != null) {
queryParams.addAll(_queryParams('', 'slug', slug));
}
const contentTypes = <String>[];
@ -973,6 +1288,8 @@ class AssetsApi {
);
}
/// This endpoint requires the `asset.view` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -980,8 +1297,10 @@ class AssetsApi {
/// * [String] key:
///
/// * [AssetMediaSize] size:
Future<MultipartFile?> viewAsset(String id, { String? key, AssetMediaSize? size, }) async {
final response = await viewAssetWithHttpInfo(id, key: key, size: size, );
///
/// * [String] slug:
Future<MultipartFile?> viewAsset(String id, { String? key, AssetMediaSize? size, String? slug, }) async {
final response = await viewAssetWithHttpInfo(id, key: key, size: size, slug: slug, );
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}

54
mobile/openapi/lib/api/auth_admin_api.dart generated Normal file
View file

@ -0,0 +1,54 @@
//
// AUTO-GENERATED FILE, DO NOT MODIFY!
//
// @dart=2.18
// ignore_for_file: unused_element, unused_import
// ignore_for_file: always_put_required_named_parameters_first
// ignore_for_file: constant_identifier_names
// ignore_for_file: lines_longer_than_80_chars
part of openapi.api;
class AuthAdminApi {
AuthAdminApi([ApiClient? apiClient]) : apiClient = apiClient ?? defaultApiClient;
final ApiClient apiClient;
/// This endpoint is an admin-only route, and requires the `adminAuth.unlinkAll` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> unlinkAllOAuthAccountsAdminWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = r'/admin/auth/unlink-all';
// ignore: prefer_final_locals
Object? postBody;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>[];
return apiClient.invokeAPI(
apiPath,
'POST',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
/// This endpoint is an admin-only route, and requires the `adminAuth.unlinkAll` permission.
Future<void> unlinkAllOAuthAccountsAdmin() async {
final response = await unlinkAllOAuthAccountsAdminWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
}
}

28
mobile/openapi/lib/api/authentication_api.dart generated
View file

@ -16,7 +16,10 @@ class AuthenticationApi {
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:
///
/// * [ChangePasswordDto] changePasswordDto (required):
@ -45,6 +48,8 @@ class AuthenticationApi {
);
}
/// This endpoint requires the `auth.changePassword` permission.
///
/// Parameters:
///
/// * [ChangePasswordDto] changePasswordDto (required):
@ -63,7 +68,10 @@ class AuthenticationApi {
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:
///
/// * [PinCodeChangeDto] pinCodeChangeDto (required):
@ -92,6 +100,8 @@ class AuthenticationApi {
);
}
/// This endpoint requires the `pinCode.update` permission.
///
/// Parameters:
///
/// * [PinCodeChangeDto] pinCodeChangeDto (required):
@ -264,7 +274,10 @@ class AuthenticationApi {
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:
///
/// * [PinCodeResetDto] pinCodeResetDto (required):
@ -293,6 +306,8 @@ class AuthenticationApi {
);
}
/// This endpoint requires the `pinCode.delete` permission.
///
/// Parameters:
///
/// * [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:
///
/// * [PinCodeSetupDto] pinCodeSetupDto (required):
@ -332,6 +350,8 @@ class AuthenticationApi {
);
}
/// This endpoint requires the `pinCode.create` permission.
///
/// Parameters:
///
/// * [PinCodeSetupDto] pinCodeSetupDto (required):

191
mobile/openapi/lib/api/deprecated_api.dart generated
View file

@ -16,7 +16,60 @@ class DeprecatedApi {
final ApiClient apiClient;
/// This property was deprecated in v1.116.0
/// This property was deprecated in v1.141.0. This endpoint requires the `partner.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
Future<Response> createPartnerDeprecatedWithHttpInfo(String id,) async {
// ignore: prefer_const_declarations
final apiPath = r'/partners/{id}'
.replaceAll('{id}', id);
// ignore: prefer_final_locals
Object? postBody;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>[];
return apiClient.invokeAPI(
apiPath,
'POST',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
/// This property was deprecated in v1.141.0. This endpoint requires the `partner.create` permission.
///
/// Parameters:
///
/// * [String] id (required):
Future<PartnerResponseDto?> createPartnerDeprecated(String id,) async {
final response = await createPartnerDeprecatedWithHttpInfo(id,);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'PartnerResponseDto',) as PartnerResponseDto;
}
return null;
}
/// This property was deprecated in v1.116.0. This endpoint requires the `asset.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
@ -52,7 +105,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:
///
@ -74,4 +127,138 @@ class DeprecatedApi {
}
return null;
}
/// Replace the asset with new file, without changing its id
///
/// This property was deprecated in v1.142.0. Replace the asset with new file, without changing its id. This endpoint requires the `asset.replace` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
///
/// * [MultipartFile] assetData (required):
///
/// * [String] deviceAssetId (required):
///
/// * [String] deviceId (required):
///
/// * [DateTime] fileCreatedAt (required):
///
/// * [DateTime] fileModifiedAt (required):
///
/// * [String] key:
///
/// * [String] slug:
///
/// * [String] duration:
///
/// * [String] filename:
Future<Response> replaceAssetWithHttpInfo(String id, MultipartFile assetData, String deviceAssetId, String deviceId, DateTime fileCreatedAt, DateTime fileModifiedAt, { String? key, String? slug, String? duration, String? filename, }) async {
// ignore: prefer_const_declarations
final apiPath = r'/assets/{id}/original'
.replaceAll('{id}', id);
// ignore: prefer_final_locals
Object? postBody;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
if (key != null) {
queryParams.addAll(_queryParams('', 'key', key));
}
if (slug != null) {
queryParams.addAll(_queryParams('', 'slug', slug));
}
const contentTypes = <String>['multipart/form-data'];
bool hasFields = false;
final mp = MultipartRequest('PUT', Uri.parse(apiPath));
if (assetData != null) {
hasFields = true;
mp.fields[r'assetData'] = assetData.field;
mp.files.add(assetData);
}
if (deviceAssetId != null) {
hasFields = true;
mp.fields[r'deviceAssetId'] = parameterToString(deviceAssetId);
}
if (deviceId != null) {
hasFields = true;
mp.fields[r'deviceId'] = parameterToString(deviceId);
}
if (duration != null) {
hasFields = true;
mp.fields[r'duration'] = parameterToString(duration);
}
if (fileCreatedAt != null) {
hasFields = true;
mp.fields[r'fileCreatedAt'] = parameterToString(fileCreatedAt);
}
if (fileModifiedAt != null) {
hasFields = true;
mp.fields[r'fileModifiedAt'] = parameterToString(fileModifiedAt);
}
if (filename != null) {
hasFields = true;
mp.fields[r'filename'] = parameterToString(filename);
}
if (hasFields) {
postBody = mp;
}
return apiClient.invokeAPI(
apiPath,
'PUT',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
/// Replace the asset with new file, without changing its id
///
/// This property was deprecated in v1.142.0. Replace the asset with new file, without changing its id. This endpoint requires the `asset.replace` permission.
///
/// Parameters:
///
/// * [String] id (required):
///
/// * [MultipartFile] assetData (required):
///
/// * [String] deviceAssetId (required):
///
/// * [String] deviceId (required):
///
/// * [DateTime] fileCreatedAt (required):
///
/// * [DateTime] fileModifiedAt (required):
///
/// * [String] key:
///
/// * [String] slug:
///
/// * [String] duration:
///
/// * [String] filename:
Future<AssetMediaResponseDto?> replaceAsset(String id, MultipartFile assetData, String deviceAssetId, String deviceId, DateTime fileCreatedAt, DateTime fileModifiedAt, { String? key, String? slug, String? duration, String? filename, }) async {
final response = await replaceAssetWithHttpInfo(id, assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, key: key, slug: slug, duration: duration, filename: filename, );
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'AssetMediaResponseDto',) as AssetMediaResponseDto;
}
return null;
}
}

40
mobile/openapi/lib/api/download_api.dart generated
View file

@ -16,13 +16,18 @@ class DownloadApi {
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:
///
/// * [AssetIdsDto] assetIdsDto (required):
///
/// * [String] key:
Future<Response> downloadArchiveWithHttpInfo(AssetIdsDto assetIdsDto, { String? key, }) async {
///
/// * [String] slug:
Future<Response> downloadArchiveWithHttpInfo(AssetIdsDto assetIdsDto, { String? key, String? slug, }) async {
// ignore: prefer_const_declarations
final apiPath = r'/download/archive';
@ -36,6 +41,9 @@ class DownloadApi {
if (key != null) {
queryParams.addAll(_queryParams('', 'key', key));
}
if (slug != null) {
queryParams.addAll(_queryParams('', 'slug', slug));
}
const contentTypes = <String>['application/json'];
@ -51,13 +59,17 @@ class DownloadApi {
);
}
/// This endpoint requires the `asset.download` permission.
///
/// Parameters:
///
/// * [AssetIdsDto] assetIdsDto (required):
///
/// * [String] key:
Future<MultipartFile?> downloadArchive(AssetIdsDto assetIdsDto, { String? key, }) async {
final response = await downloadArchiveWithHttpInfo(assetIdsDto, key: key, );
///
/// * [String] slug:
Future<MultipartFile?> downloadArchive(AssetIdsDto assetIdsDto, { String? key, String? slug, }) async {
final response = await downloadArchiveWithHttpInfo(assetIdsDto, key: key, slug: slug, );
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
@ -71,13 +83,18 @@ class DownloadApi {
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:
///
/// * [DownloadInfoDto] downloadInfoDto (required):
///
/// * [String] key:
Future<Response> getDownloadInfoWithHttpInfo(DownloadInfoDto downloadInfoDto, { String? key, }) async {
///
/// * [String] slug:
Future<Response> getDownloadInfoWithHttpInfo(DownloadInfoDto downloadInfoDto, { String? key, String? slug, }) async {
// ignore: prefer_const_declarations
final apiPath = r'/download/info';
@ -91,6 +108,9 @@ class DownloadApi {
if (key != null) {
queryParams.addAll(_queryParams('', 'key', key));
}
if (slug != null) {
queryParams.addAll(_queryParams('', 'slug', slug));
}
const contentTypes = <String>['application/json'];
@ -106,13 +126,17 @@ class DownloadApi {
);
}
/// This endpoint requires the `asset.download` permission.
///
/// Parameters:
///
/// * [DownloadInfoDto] downloadInfoDto (required):
///
/// * [String] key:
Future<DownloadResponseDto?> getDownloadInfo(DownloadInfoDto downloadInfoDto, { String? key, }) async {
final response = await getDownloadInfoWithHttpInfo(downloadInfoDto, key: key, );
///
/// * [String] slug:
Future<DownloadResponseDto?> getDownloadInfo(DownloadInfoDto downloadInfoDto, { String? key, String? slug, }) async {
final response = await getDownloadInfoWithHttpInfo(downloadInfoDto, key: key, slug: slug, );
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}

19
mobile/openapi/lib/api/duplicates_api.dart generated
View file

@ -16,7 +16,10 @@ class DuplicatesApi {
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:
///
/// * [String] id (required):
@ -46,6 +49,8 @@ class DuplicatesApi {
);
}
/// This endpoint requires the `duplicate.delete` permission.
///
/// Parameters:
///
/// * [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:
///
/// * [BulkIdsDto] bulkIdsDto (required):
@ -85,6 +93,8 @@ class DuplicatesApi {
);
}
/// This endpoint requires the `duplicate.delete` permission.
///
/// Parameters:
///
/// * [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 {
// ignore: prefer_const_declarations
final apiPath = r'/duplicates';
@ -121,6 +133,7 @@ class DuplicatesApi {
);
}
/// This endpoint requires the `duplicate.read` permission.
Future<List<DuplicateResponseDto>?> getAssetDuplicates() async {
final response = await getAssetDuplicatesWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {

28
mobile/openapi/lib/api/faces_api.dart generated
View file

@ -16,7 +16,10 @@ class FacesApi {
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:
///
/// * [AssetFaceCreateDto] assetFaceCreateDto (required):
@ -45,6 +48,8 @@ class FacesApi {
);
}
/// This endpoint requires the `face.create` permission.
///
/// Parameters:
///
/// * [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:
///
/// * [String] id (required):
@ -87,6 +95,8 @@ class FacesApi {
);
}
/// This endpoint requires the `face.delete` permission.
///
/// Parameters:
///
/// * [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:
///
/// * [String] id (required):
@ -130,6 +143,8 @@ class FacesApi {
);
}
/// This endpoint requires the `face.read` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -151,7 +166,10 @@ class FacesApi {
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:
///
/// * [String] id (required):
@ -183,6 +201,8 @@ class FacesApi {
);
}
/// This endpoint requires the `face.update` permission.
///
/// Parameters:
///
/// * [String] id (required):

19
mobile/openapi/lib/api/jobs_api.dart generated
View file

@ -16,7 +16,10 @@ class JobsApi {
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:
///
/// * [JobCreateDto] jobCreateDto (required):
@ -45,6 +48,8 @@ class JobsApi {
);
}
/// This endpoint is an admin-only route, and requires the `job.create` permission.
///
/// Parameters:
///
/// * [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 {
// ignore: prefer_const_declarations
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 {
final response = await getAllJobsStatusWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -96,7 +104,10 @@ class JobsApi {
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:
///
/// * [JobName] id (required):
@ -128,6 +139,8 @@ class JobsApi {
);
}
/// This endpoint is an admin-only route, and requires the `job.create` permission.
///
/// Parameters:
///
/// * [JobName] id (required):

47
mobile/openapi/lib/api/libraries_api.dart generated
View file

@ -16,7 +16,10 @@ class LibrariesApi {
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:
///
/// * [CreateLibraryDto] createLibraryDto (required):
@ -45,6 +48,8 @@ class LibrariesApi {
);
}
/// This endpoint is an admin-only route, and requires the `library.create` permission.
///
/// Parameters:
///
/// * [CreateLibraryDto] createLibraryDto (required):
@ -63,7 +68,10 @@ class LibrariesApi {
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:
///
/// * [String] id (required):
@ -93,6 +101,8 @@ class LibrariesApi {
);
}
/// This endpoint is an admin-only route, and requires the `library.delete` permission.
///
/// Parameters:
///
/// * [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 {
// ignore: prefer_const_declarations
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 {
final response = await getAllLibrariesWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -147,7 +160,10 @@ class LibrariesApi {
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:
///
/// * [String] id (required):
@ -177,6 +193,8 @@ class LibrariesApi {
);
}
/// This endpoint is an admin-only route, and requires the `library.read` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -195,7 +213,10 @@ class LibrariesApi {
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:
///
/// * [String] id (required):
@ -225,6 +246,8 @@ class LibrariesApi {
);
}
/// This endpoint is an admin-only route, and requires the `library.statistics` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -243,7 +266,10 @@ class LibrariesApi {
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:
///
/// * [String] id (required):
@ -273,6 +299,8 @@ class LibrariesApi {
);
}
/// This endpoint is an admin-only route, and requires the `library.update` permission.
///
/// Parameters:
///
/// * [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:
///
/// * [String] id (required):
@ -315,6 +346,8 @@ class LibrariesApi {
);
}
/// This endpoint is an admin-only route, and requires the `library.update` permission.
///
/// Parameters:
///
/// * [String] id (required):

34
mobile/openapi/lib/api/map_api.dart generated
View file

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

56
mobile/openapi/lib/api/memories_api.dart generated
View file

@ -16,7 +16,10 @@ class MemoriesApi {
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:
///
/// * [String] id (required):
@ -48,6 +51,8 @@ class MemoriesApi {
);
}
/// This endpoint requires the `memoryAsset.create` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -71,7 +76,10 @@ class MemoriesApi {
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:
///
/// * [MemoryCreateDto] memoryCreateDto (required):
@ -100,6 +108,8 @@ class MemoriesApi {
);
}
/// This endpoint requires the `memory.create` permission.
///
/// Parameters:
///
/// * [MemoryCreateDto] memoryCreateDto (required):
@ -118,7 +128,10 @@ class MemoriesApi {
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:
///
/// * [String] id (required):
@ -148,6 +161,8 @@ class MemoriesApi {
);
}
/// This endpoint requires the `memory.delete` permission.
///
/// Parameters:
///
/// * [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:
///
/// * [String] id (required):
@ -188,6 +206,8 @@ class MemoriesApi {
);
}
/// This endpoint requires the `memory.read` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -206,7 +226,10 @@ class MemoriesApi {
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:
///
/// * [DateTime] for_:
@ -254,6 +277,8 @@ class MemoriesApi {
);
}
/// This endpoint requires the `memory.statistics` permission.
///
/// Parameters:
///
/// * [DateTime] for_:
@ -278,7 +303,10 @@ class MemoriesApi {
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:
///
/// * [String] id (required):
@ -310,6 +338,8 @@ class MemoriesApi {
);
}
/// This endpoint requires the `memoryAsset.delete` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -333,7 +363,10 @@ class MemoriesApi {
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:
///
/// * [DateTime] for_:
@ -381,6 +414,8 @@ class MemoriesApi {
);
}
/// This endpoint requires the `memory.read` permission.
///
/// Parameters:
///
/// * [DateTime] for_:
@ -408,7 +443,10 @@ class MemoriesApi {
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:
///
/// * [String] id (required):
@ -440,6 +478,8 @@ class MemoriesApi {
);
}
/// This endpoint requires the `memory.update` permission.
///
/// Parameters:
///
/// * [String] id (required):

42
mobile/openapi/lib/api/notifications_api.dart generated
View file

@ -16,7 +16,10 @@ class NotificationsApi {
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:
///
/// * [String] id (required):
@ -46,6 +49,8 @@ class NotificationsApi {
);
}
/// This endpoint requires the `notification.delete` permission.
///
/// Parameters:
///
/// * [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:
///
/// * [NotificationDeleteAllDto] notificationDeleteAllDto (required):
@ -85,6 +93,8 @@ class NotificationsApi {
);
}
/// This endpoint requires the `notification.delete` permission.
///
/// Parameters:
///
/// * [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:
///
/// * [String] id (required):
@ -125,6 +138,8 @@ class NotificationsApi {
);
}
/// This endpoint requires the `notification.read` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -143,7 +158,10 @@ class NotificationsApi {
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:
///
/// * [String] id:
@ -191,6 +209,8 @@ class NotificationsApi {
);
}
/// This endpoint requires the `notification.read` permission.
///
/// Parameters:
///
/// * [String] id:
@ -218,7 +238,10 @@ class NotificationsApi {
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:
///
/// * [String] id (required):
@ -250,6 +273,8 @@ class NotificationsApi {
);
}
/// This endpoint requires the `notification.update` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -270,7 +295,10 @@ class NotificationsApi {
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:
///
/// * [NotificationUpdateAllDto] notificationUpdateAllDto (required):
@ -299,6 +327,8 @@ class NotificationsApi {
);
}
/// This endpoint requires the `notification.update` permission.
///
/// Parameters:
///
/// * [NotificationUpdateAllDto] notificationUpdateAllDto (required):

98
mobile/openapi/lib/api/partners_api.dart generated
View file

@ -16,11 +16,66 @@ class PartnersApi {
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:
///
/// * [PartnerCreateDto] partnerCreateDto (required):
Future<Response> createPartnerWithHttpInfo(PartnerCreateDto partnerCreateDto,) async {
// ignore: prefer_const_declarations
final apiPath = r'/partners';
// ignore: prefer_final_locals
Object? postBody = partnerCreateDto;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>['application/json'];
return apiClient.invokeAPI(
apiPath,
'POST',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
/// This endpoint requires the `partner.create` permission.
///
/// Parameters:
///
/// * [PartnerCreateDto] partnerCreateDto (required):
Future<PartnerResponseDto?> createPartner(PartnerCreateDto partnerCreateDto,) async {
final response = await createPartnerWithHttpInfo(partnerCreateDto,);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'PartnerResponseDto',) as PartnerResponseDto;
}
return null;
}
/// This property was deprecated in v1.141.0. This endpoint requires the `partner.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
Future<Response> createPartnerWithHttpInfo(String id,) async {
Future<Response> createPartnerDeprecatedWithHttpInfo(String id,) async {
// ignore: prefer_const_declarations
final apiPath = r'/partners/{id}'
.replaceAll('{id}', id);
@ -46,11 +101,13 @@ class PartnersApi {
);
}
/// This property was deprecated in v1.141.0. This endpoint requires the `partner.create` permission.
///
/// Parameters:
///
/// * [String] id (required):
Future<PartnerResponseDto?> createPartner(String id,) async {
final response = await createPartnerWithHttpInfo(id,);
Future<PartnerResponseDto?> createPartnerDeprecated(String id,) async {
final response = await createPartnerDeprecatedWithHttpInfo(id,);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
@ -64,7 +121,10 @@ class PartnersApi {
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:
///
/// * [PartnerDirection] direction (required):
@ -95,6 +155,8 @@ class PartnersApi {
);
}
/// This endpoint requires the `partner.read` permission.
///
/// Parameters:
///
/// * [PartnerDirection] direction (required):
@ -116,7 +178,10 @@ class PartnersApi {
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:
///
/// * [String] id (required):
@ -146,6 +211,8 @@ class PartnersApi {
);
}
/// This endpoint requires the `partner.delete` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -156,19 +223,22 @@ 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:
///
/// * [String] id (required):
///
/// * [UpdatePartnerDto] updatePartnerDto (required):
Future<Response> updatePartnerWithHttpInfo(String id, UpdatePartnerDto updatePartnerDto,) async {
/// * [PartnerUpdateDto] partnerUpdateDto (required):
Future<Response> updatePartnerWithHttpInfo(String id, PartnerUpdateDto partnerUpdateDto,) async {
// ignore: prefer_const_declarations
final apiPath = r'/partners/{id}'
.replaceAll('{id}', id);
// ignore: prefer_final_locals
Object? postBody = updatePartnerDto;
Object? postBody = partnerUpdateDto;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
@ -188,13 +258,15 @@ class PartnersApi {
);
}
/// This endpoint requires the `partner.update` permission.
///
/// Parameters:
///
/// * [String] id (required):
///
/// * [UpdatePartnerDto] updatePartnerDto (required):
Future<PartnerResponseDto?> updatePartner(String id, UpdatePartnerDto updatePartnerDto,) async {
final response = await updatePartnerWithHttpInfo(id, updatePartnerDto,);
/// * [PartnerUpdateDto] partnerUpdateDto (required):
Future<PartnerResponseDto?> updatePartner(String id, PartnerUpdateDto partnerUpdateDto,) async {
final response = await updatePartnerWithHttpInfo(id, partnerUpdateDto,);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}

77
mobile/openapi/lib/api/people_api.dart generated
View file

@ -16,7 +16,10 @@ class PeopleApi {
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:
///
/// * [PersonCreateDto] personCreateDto (required):
@ -45,6 +48,8 @@ class PeopleApi {
);
}
/// This endpoint requires the `person.create` permission.
///
/// Parameters:
///
/// * [PersonCreateDto] personCreateDto (required):
@ -63,7 +68,10 @@ class PeopleApi {
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:
///
/// * [BulkIdsDto] bulkIdsDto (required):
@ -92,6 +100,8 @@ class PeopleApi {
);
}
/// This endpoint requires the `person.delete` permission.
///
/// Parameters:
///
/// * [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:
///
/// * [String] id (required):
@ -132,6 +145,8 @@ class PeopleApi {
);
}
/// This endpoint requires the `person.delete` permission.
///
/// Parameters:
///
/// * [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:
///
/// * [String] closestAssetId:
@ -197,6 +215,8 @@ class PeopleApi {
);
}
/// This endpoint requires the `person.read` permission.
///
/// Parameters:
///
/// * [String] closestAssetId:
@ -225,7 +245,10 @@ class PeopleApi {
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:
///
/// * [String] id (required):
@ -255,6 +278,8 @@ class PeopleApi {
);
}
/// This endpoint requires the `person.read` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -273,7 +298,10 @@ class PeopleApi {
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:
///
/// * [String] id (required):
@ -303,6 +331,8 @@ class PeopleApi {
);
}
/// This endpoint requires the `person.statistics` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -321,7 +351,10 @@ class PeopleApi {
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:
///
/// * [String] id (required):
@ -351,6 +384,8 @@ class PeopleApi {
);
}
/// This endpoint requires the `person.read` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -369,7 +404,10 @@ class PeopleApi {
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:
///
/// * [String] id (required):
@ -401,6 +439,8 @@ class PeopleApi {
);
}
/// This endpoint requires the `person.merge` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -424,7 +464,10 @@ class PeopleApi {
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:
///
/// * [String] id (required):
@ -456,6 +499,8 @@ class PeopleApi {
);
}
/// This endpoint requires the `person.reassign` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -479,7 +524,10 @@ class PeopleApi {
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:
///
/// * [PeopleUpdateDto] peopleUpdateDto (required):
@ -508,6 +556,8 @@ class PeopleApi {
);
}
/// This endpoint requires the `person.update` permission.
///
/// Parameters:
///
/// * [PeopleUpdateDto] peopleUpdateDto (required):
@ -529,7 +579,10 @@ class PeopleApi {
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:
///
/// * [String] id (required):
@ -561,6 +614,8 @@ class PeopleApi {
);
}
/// This endpoint requires the `person.update` permission.
///
/// Parameters:
///
/// * [String] id (required):

328
mobile/openapi/lib/api/search_api.dart generated
View file

@ -16,7 +16,9 @@ class SearchApi {
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 {
// ignore: prefer_const_declarations
final apiPath = r'/search/cities';
@ -42,6 +44,7 @@ class SearchApi {
);
}
/// This endpoint requires the `asset.read` permission.
Future<List<AssetResponseDto>?> getAssetsByCity() async {
final response = await getAssetsByCityWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -60,7 +63,9 @@ class SearchApi {
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 {
// ignore: prefer_const_declarations
final apiPath = r'/search/explore';
@ -86,6 +91,7 @@ class SearchApi {
);
}
/// This endpoint requires the `asset.read` permission.
Future<List<SearchExploreResponseDto>?> getExploreData() async {
final response = await getExploreDataWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -104,7 +110,10 @@ class SearchApi {
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:
///
/// * [SearchSuggestionType] type (required):
@ -161,6 +170,8 @@ class SearchApi {
);
}
/// This endpoint requires the `asset.read` permission.
///
/// Parameters:
///
/// * [SearchSuggestionType] type (required):
@ -193,7 +204,10 @@ class SearchApi {
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:
///
/// * [StatisticsSearchDto] statisticsSearchDto (required):
@ -222,6 +236,8 @@ class SearchApi {
);
}
/// This endpoint requires the `asset.statistics` permission.
///
/// Parameters:
///
/// * [StatisticsSearchDto] statisticsSearchDto (required):
@ -240,7 +256,10 @@ class SearchApi {
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:
///
/// * [MetadataSearchDto] metadataSearchDto (required):
@ -269,6 +288,8 @@ class SearchApi {
);
}
/// This endpoint requires the `asset.read` permission.
///
/// Parameters:
///
/// * [MetadataSearchDto] metadataSearchDto (required):
@ -287,7 +308,279 @@ class SearchApi {
return null;
}
/// Performs an HTTP 'GET /search/person' operation and returns the [Response].
/// This endpoint requires the `asset.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [List<String>] albumIds:
///
/// * [String] city:
///
/// * [String] country:
///
/// * [DateTime] createdAfter:
///
/// * [DateTime] createdBefore:
///
/// * [String] deviceId:
///
/// * [bool] isEncoded:
///
/// * [bool] isFavorite:
///
/// * [bool] isMotion:
///
/// * [bool] isNotInAlbum:
///
/// * [bool] isOffline:
///
/// * [String] lensModel:
///
/// * [String] libraryId:
///
/// * [String] make:
///
/// * [int] minFileSize:
///
/// * [String] model:
///
/// * [List<String>] personIds:
///
/// * [num] rating:
///
/// * [num] size:
///
/// * [String] state:
///
/// * [List<String>] tagIds:
///
/// * [DateTime] takenAfter:
///
/// * [DateTime] takenBefore:
///
/// * [DateTime] trashedAfter:
///
/// * [DateTime] trashedBefore:
///
/// * [AssetTypeEnum] type:
///
/// * [DateTime] updatedAfter:
///
/// * [DateTime] updatedBefore:
///
/// * [AssetVisibility] visibility:
///
/// * [bool] withDeleted:
///
/// * [bool] withExif:
Future<Response> searchLargeAssetsWithHttpInfo({ List<String>? albumIds, String? city, String? country, DateTime? createdAfter, DateTime? createdBefore, String? deviceId, bool? isEncoded, bool? isFavorite, bool? isMotion, bool? isNotInAlbum, bool? isOffline, String? lensModel, String? libraryId, String? make, int? minFileSize, String? model, List<String>? personIds, num? rating, num? size, String? state, List<String>? tagIds, DateTime? takenAfter, DateTime? takenBefore, DateTime? trashedAfter, DateTime? trashedBefore, AssetTypeEnum? type, DateTime? updatedAfter, DateTime? updatedBefore, AssetVisibility? visibility, bool? withDeleted, bool? withExif, }) async {
// ignore: prefer_const_declarations
final apiPath = r'/search/large-assets';
// ignore: prefer_final_locals
Object? postBody;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
if (albumIds != null) {
queryParams.addAll(_queryParams('multi', 'albumIds', albumIds));
}
if (city != null) {
queryParams.addAll(_queryParams('', 'city', city));
}
if (country != null) {
queryParams.addAll(_queryParams('', 'country', country));
}
if (createdAfter != null) {
queryParams.addAll(_queryParams('', 'createdAfter', createdAfter));
}
if (createdBefore != null) {
queryParams.addAll(_queryParams('', 'createdBefore', createdBefore));
}
if (deviceId != null) {
queryParams.addAll(_queryParams('', 'deviceId', deviceId));
}
if (isEncoded != null) {
queryParams.addAll(_queryParams('', 'isEncoded', isEncoded));
}
if (isFavorite != null) {
queryParams.addAll(_queryParams('', 'isFavorite', isFavorite));
}
if (isMotion != null) {
queryParams.addAll(_queryParams('', 'isMotion', isMotion));
}
if (isNotInAlbum != null) {
queryParams.addAll(_queryParams('', 'isNotInAlbum', isNotInAlbum));
}
if (isOffline != null) {
queryParams.addAll(_queryParams('', 'isOffline', isOffline));
}
if (lensModel != null) {
queryParams.addAll(_queryParams('', 'lensModel', lensModel));
}
if (libraryId != null) {
queryParams.addAll(_queryParams('', 'libraryId', libraryId));
}
if (make != null) {
queryParams.addAll(_queryParams('', 'make', make));
}
if (minFileSize != null) {
queryParams.addAll(_queryParams('', 'minFileSize', minFileSize));
}
if (model != null) {
queryParams.addAll(_queryParams('', 'model', model));
}
if (personIds != null) {
queryParams.addAll(_queryParams('multi', 'personIds', personIds));
}
if (rating != null) {
queryParams.addAll(_queryParams('', 'rating', rating));
}
if (size != null) {
queryParams.addAll(_queryParams('', 'size', size));
}
if (state != null) {
queryParams.addAll(_queryParams('', 'state', state));
}
if (tagIds != null) {
queryParams.addAll(_queryParams('multi', 'tagIds', tagIds));
}
if (takenAfter != null) {
queryParams.addAll(_queryParams('', 'takenAfter', takenAfter));
}
if (takenBefore != null) {
queryParams.addAll(_queryParams('', 'takenBefore', takenBefore));
}
if (trashedAfter != null) {
queryParams.addAll(_queryParams('', 'trashedAfter', trashedAfter));
}
if (trashedBefore != null) {
queryParams.addAll(_queryParams('', 'trashedBefore', trashedBefore));
}
if (type != null) {
queryParams.addAll(_queryParams('', 'type', type));
}
if (updatedAfter != null) {
queryParams.addAll(_queryParams('', 'updatedAfter', updatedAfter));
}
if (updatedBefore != null) {
queryParams.addAll(_queryParams('', 'updatedBefore', updatedBefore));
}
if (visibility != null) {
queryParams.addAll(_queryParams('', 'visibility', visibility));
}
if (withDeleted != null) {
queryParams.addAll(_queryParams('', 'withDeleted', withDeleted));
}
if (withExif != null) {
queryParams.addAll(_queryParams('', 'withExif', withExif));
}
const contentTypes = <String>[];
return apiClient.invokeAPI(
apiPath,
'POST',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
/// This endpoint requires the `asset.read` permission.
///
/// Parameters:
///
/// * [List<String>] albumIds:
///
/// * [String] city:
///
/// * [String] country:
///
/// * [DateTime] createdAfter:
///
/// * [DateTime] createdBefore:
///
/// * [String] deviceId:
///
/// * [bool] isEncoded:
///
/// * [bool] isFavorite:
///
/// * [bool] isMotion:
///
/// * [bool] isNotInAlbum:
///
/// * [bool] isOffline:
///
/// * [String] lensModel:
///
/// * [String] libraryId:
///
/// * [String] make:
///
/// * [int] minFileSize:
///
/// * [String] model:
///
/// * [List<String>] personIds:
///
/// * [num] rating:
///
/// * [num] size:
///
/// * [String] state:
///
/// * [List<String>] tagIds:
///
/// * [DateTime] takenAfter:
///
/// * [DateTime] takenBefore:
///
/// * [DateTime] trashedAfter:
///
/// * [DateTime] trashedBefore:
///
/// * [AssetTypeEnum] type:
///
/// * [DateTime] updatedAfter:
///
/// * [DateTime] updatedBefore:
///
/// * [AssetVisibility] visibility:
///
/// * [bool] withDeleted:
///
/// * [bool] withExif:
Future<List<AssetResponseDto>?> searchLargeAssets({ List<String>? albumIds, String? city, String? country, DateTime? createdAfter, DateTime? createdBefore, String? deviceId, bool? isEncoded, bool? isFavorite, bool? isMotion, bool? isNotInAlbum, bool? isOffline, String? lensModel, String? libraryId, String? make, int? minFileSize, String? model, List<String>? personIds, num? rating, num? size, String? state, List<String>? tagIds, DateTime? takenAfter, DateTime? takenBefore, DateTime? trashedAfter, DateTime? trashedBefore, AssetTypeEnum? type, DateTime? updatedAfter, DateTime? updatedBefore, AssetVisibility? visibility, bool? withDeleted, bool? withExif, }) async {
final response = await searchLargeAssetsWithHttpInfo( albumIds: albumIds, city: city, country: country, createdAfter: createdAfter, createdBefore: createdBefore, deviceId: deviceId, isEncoded: isEncoded, isFavorite: isFavorite, isMotion: isMotion, isNotInAlbum: isNotInAlbum, isOffline: isOffline, lensModel: lensModel, libraryId: libraryId, make: make, minFileSize: minFileSize, model: model, personIds: personIds, rating: rating, size: size, state: state, tagIds: tagIds, takenAfter: takenAfter, takenBefore: takenBefore, trashedAfter: trashedAfter, trashedBefore: trashedBefore, type: type, updatedAfter: updatedAfter, updatedBefore: updatedBefore, visibility: visibility, withDeleted: withDeleted, withExif: withExif, );
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
final responseBody = await _decodeBodyBytes(response);
return (await apiClient.deserializeAsync(responseBody, 'List<AssetResponseDto>') as List)
.cast<AssetResponseDto>()
.toList(growable: false);
}
return null;
}
/// This endpoint requires the `person.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] name (required):
@ -323,6 +616,8 @@ class SearchApi {
);
}
/// This endpoint requires the `person.read` permission.
///
/// Parameters:
///
/// * [String] name (required):
@ -346,7 +641,10 @@ class SearchApi {
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:
///
/// * [String] name (required):
@ -377,6 +675,8 @@ class SearchApi {
);
}
/// This endpoint requires the `asset.read` permission.
///
/// Parameters:
///
/// * [String] name (required):
@ -398,7 +698,10 @@ class SearchApi {
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:
///
/// * [RandomSearchDto] randomSearchDto (required):
@ -427,6 +730,8 @@ class SearchApi {
);
}
/// This endpoint requires the `asset.read` permission.
///
/// Parameters:
///
/// * [RandomSearchDto] randomSearchDto (required):
@ -448,7 +753,10 @@ class SearchApi {
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:
///
/// * [SmartSearchDto] smartSearchDto (required):
@ -477,6 +785,8 @@ class SearchApi {
);
}
/// This endpoint requires the `asset.read` permission.
///
/// Parameters:
///
/// * [SmartSearchDto] smartSearchDto (required):

42
mobile/openapi/lib/api/server_api.dart generated
View file

@ -16,7 +16,9 @@ class ServerApi {
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 {
// ignore: prefer_const_declarations
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 {
final response = await deleteServerLicenseWithHttpInfo();
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 {
// ignore: prefer_const_declarations
final apiPath = r'/server/about';
@ -75,6 +80,7 @@ class ServerApi {
);
}
/// This endpoint requires the `server.about` permission.
Future<ServerAboutResponseDto?> getAboutInfo() async {
final response = await getAboutInfoWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -90,7 +96,9 @@ class ServerApi {
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 {
// ignore: prefer_const_declarations
final apiPath = r'/server/apk-links';
@ -116,6 +124,7 @@ class ServerApi {
);
}
/// This endpoint requires the `server.apkLinks` permission.
Future<ServerApkLinksDto?> getApkLinks() async {
final response = await getApkLinksWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -213,7 +222,9 @@ class ServerApi {
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 {
// ignore: prefer_const_declarations
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 {
final response = await getServerLicenseWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -254,7 +266,9 @@ class ServerApi {
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 {
// ignore: prefer_const_declarations
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 {
final response = await getServerStatisticsWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -336,7 +351,9 @@ class ServerApi {
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 {
// ignore: prefer_const_declarations
final apiPath = r'/server/storage';
@ -362,6 +379,7 @@ class ServerApi {
);
}
/// This endpoint requires the `server.storage` permission.
Future<ServerStorageResponseDto?> getStorage() async {
final response = await getStorageWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -459,7 +477,9 @@ class ServerApi {
return null;
}
/// Performs an HTTP 'GET /server/version-check' operation and returns the [Response].
/// This endpoint requires the `server.versionCheck` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getVersionCheckWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = r'/server/version-check';
@ -485,6 +505,7 @@ class ServerApi {
);
}
/// This endpoint requires the `server.versionCheck` permission.
Future<VersionCheckStateResponseDto?> getVersionCheck() async {
final response = await getVersionCheckWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -585,7 +606,10 @@ class ServerApi {
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:
///
/// * [LicenseKeyDto] licenseKeyDto (required):
@ -614,6 +638,8 @@ class ServerApi {
);
}
/// This endpoint is an admin-only route, and requires the `serverLicense.update` permission.
///
/// Parameters:
///
/// * [LicenseKeyDto] licenseKeyDto (required):

38
mobile/openapi/lib/api/sessions_api.dart generated
View file

@ -16,7 +16,10 @@ class SessionsApi {
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:
///
/// * [SessionCreateDto] sessionCreateDto (required):
@ -45,6 +48,8 @@ class SessionsApi {
);
}
/// This endpoint requires the `session.create` permission.
///
/// Parameters:
///
/// * [SessionCreateDto] sessionCreateDto (required):
@ -63,7 +68,9 @@ class SessionsApi {
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 {
// ignore: prefer_const_declarations
final apiPath = r'/sessions';
@ -89,6 +96,7 @@ class SessionsApi {
);
}
/// This endpoint requires the `session.delete` permission.
Future<void> deleteAllSessions() async {
final response = await deleteAllSessionsWithHttpInfo();
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:
///
/// * [String] id (required):
@ -126,6 +137,8 @@ class SessionsApi {
);
}
/// This endpoint requires the `session.delete` permission.
///
/// Parameters:
///
/// * [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 {
// ignore: prefer_const_declarations
final apiPath = r'/sessions';
@ -162,6 +177,7 @@ class SessionsApi {
);
}
/// This endpoint requires the `session.read` permission.
Future<List<SessionResponseDto>?> getSessions() async {
final response = await getSessionsWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -180,7 +196,10 @@ class SessionsApi {
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:
///
/// * [String] id (required):
@ -210,6 +229,8 @@ class SessionsApi {
);
}
/// This endpoint requires the `session.lock` permission.
///
/// Parameters:
///
/// * [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:
///
/// * [String] id (required):
@ -252,6 +276,8 @@ class SessionsApi {
);
}
/// This endpoint requires the `session.update` permission.
///
/// Parameters:
///
/// * [String] id (required):

88
mobile/openapi/lib/api/shared_links_api.dart generated
View file

@ -24,7 +24,9 @@ class SharedLinksApi {
/// * [AssetIdsDto] assetIdsDto (required):
///
/// * [String] key:
Future<Response> addSharedLinkAssetsWithHttpInfo(String id, AssetIdsDto assetIdsDto, { String? key, }) async {
///
/// * [String] slug:
Future<Response> addSharedLinkAssetsWithHttpInfo(String id, AssetIdsDto assetIdsDto, { String? key, String? slug, }) async {
// ignore: prefer_const_declarations
final apiPath = r'/shared-links/{id}/assets'
.replaceAll('{id}', id);
@ -39,6 +41,9 @@ class SharedLinksApi {
if (key != null) {
queryParams.addAll(_queryParams('', 'key', key));
}
if (slug != null) {
queryParams.addAll(_queryParams('', 'slug', slug));
}
const contentTypes = <String>['application/json'];
@ -61,8 +66,10 @@ class SharedLinksApi {
/// * [AssetIdsDto] assetIdsDto (required):
///
/// * [String] key:
Future<List<AssetIdsResponseDto>?> addSharedLinkAssets(String id, AssetIdsDto assetIdsDto, { String? key, }) async {
final response = await addSharedLinkAssetsWithHttpInfo(id, assetIdsDto, key: key, );
///
/// * [String] slug:
Future<List<AssetIdsResponseDto>?> addSharedLinkAssets(String id, AssetIdsDto assetIdsDto, { String? key, String? slug, }) async {
final response = await addSharedLinkAssetsWithHttpInfo(id, assetIdsDto, key: key, slug: slug, );
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
@ -79,7 +86,10 @@ class SharedLinksApi {
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:
///
/// * [SharedLinkCreateDto] sharedLinkCreateDto (required):
@ -108,6 +118,8 @@ class SharedLinksApi {
);
}
/// This endpoint requires the `sharedLink.create` permission.
///
/// Parameters:
///
/// * [SharedLinkCreateDto] sharedLinkCreateDto (required):
@ -126,7 +138,10 @@ class SharedLinksApi {
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:
///
/// * [String] albumId:
@ -159,6 +174,8 @@ class SharedLinksApi {
);
}
/// This endpoint requires the `sharedLink.read` permission.
///
/// Parameters:
///
/// * [String] albumId:
@ -183,12 +200,14 @@ class SharedLinksApi {
/// Performs an HTTP 'GET /shared-links/me' operation and returns the [Response].
/// Parameters:
///
/// * [String] key:
///
/// * [String] password:
///
/// * [String] token:
Future<Response> getMySharedLinkWithHttpInfo({ String? key, String? password, String? token, }) async {
///
/// * [String] key:
///
/// * [String] slug:
Future<Response> getMySharedLinkWithHttpInfo({ String? password, String? token, String? key, String? slug, }) async {
// ignore: prefer_const_declarations
final apiPath = r'/shared-links/me';
@ -199,15 +218,18 @@ class SharedLinksApi {
final headerParams = <String, String>{};
final formParams = <String, String>{};
if (key != null) {
queryParams.addAll(_queryParams('', 'key', key));
}
if (password != null) {
queryParams.addAll(_queryParams('', 'password', password));
}
if (token != null) {
queryParams.addAll(_queryParams('', 'token', token));
}
if (key != null) {
queryParams.addAll(_queryParams('', 'key', key));
}
if (slug != null) {
queryParams.addAll(_queryParams('', 'slug', slug));
}
const contentTypes = <String>[];
@ -225,13 +247,15 @@ class SharedLinksApi {
/// Parameters:
///
/// * [String] key:
///
/// * [String] password:
///
/// * [String] token:
Future<SharedLinkResponseDto?> getMySharedLink({ String? key, String? password, String? token, }) async {
final response = await getMySharedLinkWithHttpInfo( key: key, password: password, 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) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
@ -245,7 +269,10 @@ class SharedLinksApi {
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:
///
/// * [String] id (required):
@ -275,6 +302,8 @@ class SharedLinksApi {
);
}
/// This endpoint requires the `sharedLink.read` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -293,7 +322,10 @@ class SharedLinksApi {
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:
///
/// * [String] id (required):
@ -323,6 +355,8 @@ class SharedLinksApi {
);
}
/// This endpoint requires the `sharedLink.delete` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -341,7 +375,9 @@ class SharedLinksApi {
/// * [AssetIdsDto] assetIdsDto (required):
///
/// * [String] key:
Future<Response> removeSharedLinkAssetsWithHttpInfo(String id, AssetIdsDto assetIdsDto, { String? key, }) async {
///
/// * [String] slug:
Future<Response> removeSharedLinkAssetsWithHttpInfo(String id, AssetIdsDto assetIdsDto, { String? key, String? slug, }) async {
// ignore: prefer_const_declarations
final apiPath = r'/shared-links/{id}/assets'
.replaceAll('{id}', id);
@ -356,6 +392,9 @@ class SharedLinksApi {
if (key != null) {
queryParams.addAll(_queryParams('', 'key', key));
}
if (slug != null) {
queryParams.addAll(_queryParams('', 'slug', slug));
}
const contentTypes = <String>['application/json'];
@ -378,8 +417,10 @@ class SharedLinksApi {
/// * [AssetIdsDto] assetIdsDto (required):
///
/// * [String] key:
Future<List<AssetIdsResponseDto>?> removeSharedLinkAssets(String id, AssetIdsDto assetIdsDto, { String? key, }) async {
final response = await removeSharedLinkAssetsWithHttpInfo(id, assetIdsDto, key: key, );
///
/// * [String] slug:
Future<List<AssetIdsResponseDto>?> removeSharedLinkAssets(String id, AssetIdsDto assetIdsDto, { String? key, String? slug, }) async {
final response = await removeSharedLinkAssetsWithHttpInfo(id, assetIdsDto, key: key, slug: slug, );
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
@ -396,7 +437,10 @@ class SharedLinksApi {
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:
///
/// * [String] id (required):
@ -428,6 +472,8 @@ class SharedLinksApi {
);
}
/// This endpoint requires the `sharedLink.update` permission.
///
/// Parameters:
///
/// * [String] id (required):

92
mobile/openapi/lib/api/stacks_api.dart generated
View file

@ -16,7 +16,10 @@ class StacksApi {
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:
///
/// * [StackCreateDto] stackCreateDto (required):
@ -45,6 +48,8 @@ class StacksApi {
);
}
/// This endpoint requires the `stack.create` permission.
///
/// Parameters:
///
/// * [StackCreateDto] stackCreateDto (required):
@ -63,7 +68,10 @@ class StacksApi {
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:
///
/// * [String] id (required):
@ -93,6 +101,8 @@ class StacksApi {
);
}
/// This endpoint requires the `stack.delete` permission.
///
/// Parameters:
///
/// * [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:
///
/// * [BulkIdsDto] bulkIdsDto (required):
@ -132,6 +145,8 @@ class StacksApi {
);
}
/// This endpoint requires the `stack.delete` permission.
///
/// Parameters:
///
/// * [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:
///
/// * [String] id (required):
@ -172,6 +190,8 @@ class StacksApi {
);
}
/// This endpoint requires the `stack.read` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -190,7 +210,60 @@ class StacksApi {
return null;
}
/// Performs an HTTP 'GET /stacks' operation and returns the [Response].
/// This endpoint requires the `stack.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] assetId (required):
///
/// * [String] id (required):
Future<Response> removeAssetFromStackWithHttpInfo(String assetId, String id,) async {
// ignore: prefer_const_declarations
final apiPath = r'/stacks/{id}/assets/{assetId}'
.replaceAll('{assetId}', assetId)
.replaceAll('{id}', id);
// ignore: prefer_final_locals
Object? postBody;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>[];
return apiClient.invokeAPI(
apiPath,
'DELETE',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
/// This endpoint requires the `stack.update` permission.
///
/// Parameters:
///
/// * [String] assetId (required):
///
/// * [String] id (required):
Future<void> removeAssetFromStack(String assetId, String id,) async {
final response = await removeAssetFromStackWithHttpInfo(assetId, id,);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
}
/// This endpoint requires the `stack.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] primaryAssetId:
@ -223,6 +296,8 @@ class StacksApi {
);
}
/// This endpoint requires the `stack.read` permission.
///
/// Parameters:
///
/// * [String] primaryAssetId:
@ -244,7 +319,10 @@ class StacksApi {
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:
///
/// * [String] id (required):
@ -276,6 +354,8 @@ class StacksApi {
);
}
/// This endpoint requires the `stack.update` permission.
///
/// Parameters:
///
/// * [String] id (required):

26
mobile/openapi/lib/api/sync_api.dart generated
View file

@ -16,7 +16,10 @@ class SyncApi {
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:
///
/// * [SyncAckDeleteDto] syncAckDeleteDto (required):
@ -45,6 +48,8 @@ class SyncApi {
);
}
/// This endpoint requires the `syncCheckpoint.delete` permission.
///
/// Parameters:
///
/// * [SyncAckDeleteDto] syncAckDeleteDto (required):
@ -152,7 +157,9 @@ class SyncApi {
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 {
// ignore: prefer_const_declarations
final apiPath = r'/sync/ack';
@ -178,6 +185,7 @@ class SyncApi {
);
}
/// This endpoint requires the `syncCheckpoint.read` permission.
Future<List<SyncAckDto>?> getSyncAck() async {
final response = await getSyncAckWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -196,7 +204,10 @@ class SyncApi {
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:
///
/// * [SyncStreamDto] syncStreamDto (required):
@ -225,6 +236,8 @@ class SyncApi {
);
}
/// This endpoint requires the `sync.stream` permission.
///
/// Parameters:
///
/// * [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:
///
/// * [SyncAckSetDto] syncAckSetDto (required):
@ -264,6 +280,8 @@ class SyncApi {
);
}
/// This endpoint requires the `syncCheckpoint.update` permission.
///
/// Parameters:
///
/// * [SyncAckSetDto] syncAckSetDto (required):

22
mobile/openapi/lib/api/system_config_api.dart generated
View file

@ -16,7 +16,9 @@ class SystemConfigApi {
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 {
// ignore: prefer_const_declarations
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 {
final response = await getConfigWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -57,7 +60,9 @@ class SystemConfigApi {
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 {
// ignore: prefer_const_declarations
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 {
final response = await getConfigDefaultsWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -98,7 +104,9 @@ class SystemConfigApi {
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 {
// ignore: prefer_const_declarations
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 {
final response = await getStorageTemplateOptionsWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -139,7 +148,10 @@ class SystemConfigApi {
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:
///
/// * [SystemConfigDto] systemConfigDto (required):
@ -168,6 +180,8 @@ class SystemConfigApi {
);
}
/// This endpoint is an admin-only route, and requires the `systemConfig.update` permission.
///
/// Parameters:
///
/// * [SystemConfigDto] systemConfigDto (required):

22
mobile/openapi/lib/api/system_metadata_api.dart generated
View file

@ -16,7 +16,9 @@ class SystemMetadataApi {
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 {
// ignore: prefer_const_declarations
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 {
final response = await getAdminOnboardingWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -57,7 +60,9 @@ class SystemMetadataApi {
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 {
// ignore: prefer_const_declarations
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 {
final response = await getReverseGeocodingStateWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -98,7 +104,9 @@ class SystemMetadataApi {
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 {
// ignore: prefer_const_declarations
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 {
final response = await getVersionCheckStateWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -139,7 +148,10 @@ class SystemMetadataApi {
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:
///
/// * [AdminOnboardingUpdateDto] adminOnboardingUpdateDto (required):
@ -168,6 +180,8 @@ class SystemMetadataApi {
);
}
/// This endpoint is an admin-only route, and requires the `systemMetadata.update` permission.
///
/// Parameters:
///
/// * [AdminOnboardingUpdateDto] adminOnboardingUpdateDto (required):

61
mobile/openapi/lib/api/tags_api.dart generated
View file

@ -16,7 +16,10 @@ class TagsApi {
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:
///
/// * [TagBulkAssetsDto] tagBulkAssetsDto (required):
@ -45,6 +48,8 @@ class TagsApi {
);
}
/// This endpoint requires the `tag.asset` permission.
///
/// Parameters:
///
/// * [TagBulkAssetsDto] tagBulkAssetsDto (required):
@ -63,7 +68,10 @@ class TagsApi {
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:
///
/// * [TagCreateDto] tagCreateDto (required):
@ -92,6 +100,8 @@ class TagsApi {
);
}
/// This endpoint requires the `tag.create` permission.
///
/// Parameters:
///
/// * [TagCreateDto] tagCreateDto (required):
@ -110,7 +120,10 @@ class TagsApi {
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:
///
/// * [String] id (required):
@ -140,6 +153,8 @@ class TagsApi {
);
}
/// This endpoint requires the `tag.delete` permission.
///
/// Parameters:
///
/// * [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 {
// ignore: prefer_const_declarations
final apiPath = r'/tags';
@ -176,6 +193,7 @@ class TagsApi {
);
}
/// This endpoint requires the `tag.read` permission.
Future<List<TagResponseDto>?> getAllTags() async {
final response = await getAllTagsWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -194,7 +212,10 @@ class TagsApi {
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:
///
/// * [String] id (required):
@ -224,6 +245,8 @@ class TagsApi {
);
}
/// This endpoint requires the `tag.read` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -242,7 +265,10 @@ class TagsApi {
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:
///
/// * [String] id (required):
@ -274,6 +300,8 @@ class TagsApi {
);
}
/// This endpoint requires the `tag.asset` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -297,7 +325,10 @@ class TagsApi {
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:
///
/// * [String] id (required):
@ -329,6 +360,8 @@ class TagsApi {
);
}
/// This endpoint requires the `tag.asset` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -352,7 +385,10 @@ class TagsApi {
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:
///
/// * [String] id (required):
@ -384,6 +420,8 @@ class TagsApi {
);
}
/// This endpoint requires the `tag.update` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -404,7 +442,10 @@ class TagsApi {
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:
///
/// * [TagUpsertDto] tagUpsertDto (required):
@ -433,6 +474,8 @@ class TagsApi {
);
}
/// This endpoint requires the `tag.create` permission.
///
/// Parameters:
///
/// * [TagUpsertDto] tagUpsertDto (required):

58
mobile/openapi/lib/api/timeline_api.dart generated
View file

@ -16,7 +16,10 @@ class TimelineApi {
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:
///
/// * [String] timeBucket (required):
@ -39,6 +42,8 @@ class TimelineApi {
/// * [String] personId:
/// Filter assets containing a specific person (face recognition)
///
/// * [String] slug:
///
/// * [String] tagId:
/// Filter assets with a specific tag
///
@ -48,12 +53,15 @@ class TimelineApi {
/// * [AssetVisibility] visibility:
/// Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED)
///
/// * [bool] withCoordinates:
/// Include location data in the response
///
/// * [bool] withPartners:
/// Include assets shared by partners
///
/// * [bool] withStacked:
/// Include stacked assets in the response. When true, only primary assets from stacks are returned.
Future<Response> getTimeBucketWithHttpInfo(String timeBucket, { String? albumId, bool? isFavorite, bool? isTrashed, String? key, AssetOrder? order, String? personId, String? tagId, String? userId, AssetVisibility? visibility, bool? withPartners, bool? withStacked, }) async {
Future<Response> getTimeBucketWithHttpInfo(String timeBucket, { String? albumId, bool? isFavorite, bool? isTrashed, String? key, AssetOrder? order, String? personId, String? slug, String? tagId, String? userId, AssetVisibility? visibility, bool? withCoordinates, bool? withPartners, bool? withStacked, }) async {
// ignore: prefer_const_declarations
final apiPath = r'/timeline/bucket';
@ -82,6 +90,9 @@ class TimelineApi {
if (personId != null) {
queryParams.addAll(_queryParams('', 'personId', personId));
}
if (slug != null) {
queryParams.addAll(_queryParams('', 'slug', slug));
}
if (tagId != null) {
queryParams.addAll(_queryParams('', 'tagId', tagId));
}
@ -92,6 +103,9 @@ class TimelineApi {
if (visibility != null) {
queryParams.addAll(_queryParams('', 'visibility', visibility));
}
if (withCoordinates != null) {
queryParams.addAll(_queryParams('', 'withCoordinates', withCoordinates));
}
if (withPartners != null) {
queryParams.addAll(_queryParams('', 'withPartners', withPartners));
}
@ -113,6 +127,8 @@ class TimelineApi {
);
}
/// This endpoint requires the `asset.read` permission.
///
/// Parameters:
///
/// * [String] timeBucket (required):
@ -135,6 +151,8 @@ class TimelineApi {
/// * [String] personId:
/// Filter assets containing a specific person (face recognition)
///
/// * [String] slug:
///
/// * [String] tagId:
/// Filter assets with a specific tag
///
@ -144,13 +162,16 @@ class TimelineApi {
/// * [AssetVisibility] visibility:
/// Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED)
///
/// * [bool] withCoordinates:
/// Include location data in the response
///
/// * [bool] withPartners:
/// Include assets shared by partners
///
/// * [bool] withStacked:
/// Include stacked assets in the response. When true, only primary assets from stacks are returned.
Future<TimeBucketAssetResponseDto?> getTimeBucket(String timeBucket, { String? albumId, bool? isFavorite, bool? isTrashed, String? key, AssetOrder? order, String? personId, String? tagId, String? userId, AssetVisibility? visibility, bool? withPartners, bool? withStacked, }) async {
final response = await getTimeBucketWithHttpInfo(timeBucket, albumId: albumId, isFavorite: isFavorite, isTrashed: isTrashed, key: key, order: order, personId: personId, tagId: tagId, userId: userId, visibility: visibility, withPartners: withPartners, withStacked: withStacked, );
Future<TimeBucketAssetResponseDto?> getTimeBucket(String timeBucket, { String? albumId, bool? isFavorite, bool? isTrashed, String? key, AssetOrder? order, String? personId, String? slug, String? tagId, String? userId, AssetVisibility? visibility, bool? withCoordinates, bool? withPartners, bool? withStacked, }) async {
final response = await getTimeBucketWithHttpInfo(timeBucket, albumId: albumId, isFavorite: isFavorite, isTrashed: isTrashed, key: key, order: order, personId: personId, slug: slug, tagId: tagId, userId: userId, visibility: visibility, withCoordinates: withCoordinates, withPartners: withPartners, withStacked: withStacked, );
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
@ -164,7 +185,10 @@ class TimelineApi {
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:
///
/// * [String] albumId:
@ -184,6 +208,8 @@ class TimelineApi {
/// * [String] personId:
/// Filter assets containing a specific person (face recognition)
///
/// * [String] slug:
///
/// * [String] tagId:
/// Filter assets with a specific tag
///
@ -193,12 +219,15 @@ class TimelineApi {
/// * [AssetVisibility] visibility:
/// Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED)
///
/// * [bool] withCoordinates:
/// Include location data in the response
///
/// * [bool] withPartners:
/// Include assets shared by partners
///
/// * [bool] withStacked:
/// Include stacked assets in the response. When true, only primary assets from stacks are returned.
Future<Response> getTimeBucketsWithHttpInfo({ String? albumId, bool? isFavorite, bool? isTrashed, String? key, AssetOrder? order, String? personId, String? tagId, String? userId, AssetVisibility? visibility, bool? withPartners, bool? withStacked, }) async {
Future<Response> getTimeBucketsWithHttpInfo({ String? albumId, bool? isFavorite, bool? isTrashed, String? key, AssetOrder? order, String? personId, String? slug, String? tagId, String? userId, AssetVisibility? visibility, bool? withCoordinates, bool? withPartners, bool? withStacked, }) async {
// ignore: prefer_const_declarations
final apiPath = r'/timeline/buckets';
@ -227,6 +256,9 @@ class TimelineApi {
if (personId != null) {
queryParams.addAll(_queryParams('', 'personId', personId));
}
if (slug != null) {
queryParams.addAll(_queryParams('', 'slug', slug));
}
if (tagId != null) {
queryParams.addAll(_queryParams('', 'tagId', tagId));
}
@ -236,6 +268,9 @@ class TimelineApi {
if (visibility != null) {
queryParams.addAll(_queryParams('', 'visibility', visibility));
}
if (withCoordinates != null) {
queryParams.addAll(_queryParams('', 'withCoordinates', withCoordinates));
}
if (withPartners != null) {
queryParams.addAll(_queryParams('', 'withPartners', withPartners));
}
@ -257,6 +292,8 @@ class TimelineApi {
);
}
/// This endpoint requires the `asset.read` permission.
///
/// Parameters:
///
/// * [String] albumId:
@ -276,6 +313,8 @@ class TimelineApi {
/// * [String] personId:
/// Filter assets containing a specific person (face recognition)
///
/// * [String] slug:
///
/// * [String] tagId:
/// Filter assets with a specific tag
///
@ -285,13 +324,16 @@ class TimelineApi {
/// * [AssetVisibility] visibility:
/// Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED)
///
/// * [bool] withCoordinates:
/// Include location data in the response
///
/// * [bool] withPartners:
/// Include assets shared by partners
///
/// * [bool] withStacked:
/// Include stacked assets in the response. When true, only primary assets from stacks are returned.
Future<List<TimeBucketsResponseDto>?> getTimeBuckets({ String? albumId, bool? isFavorite, bool? isTrashed, String? key, AssetOrder? order, String? personId, String? tagId, String? userId, AssetVisibility? visibility, bool? withPartners, bool? withStacked, }) async {
final response = await getTimeBucketsWithHttpInfo( albumId: albumId, isFavorite: isFavorite, isTrashed: isTrashed, key: key, order: order, personId: personId, tagId: tagId, userId: userId, visibility: visibility, withPartners: withPartners, withStacked: withStacked, );
Future<List<TimeBucketsResponseDto>?> getTimeBuckets({ String? albumId, bool? isFavorite, bool? isTrashed, String? key, AssetOrder? order, String? personId, String? slug, String? tagId, String? userId, AssetVisibility? visibility, bool? withCoordinates, bool? withPartners, bool? withStacked, }) async {
final response = await getTimeBucketsWithHttpInfo( albumId: albumId, isFavorite: isFavorite, isTrashed: isTrashed, key: key, order: order, personId: personId, slug: slug, tagId: tagId, userId: userId, visibility: visibility, withCoordinates: withCoordinates, withPartners: withPartners, withStacked: withStacked, );
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}

17
mobile/openapi/lib/api/trash_api.dart generated
View file

@ -16,7 +16,9 @@ class TrashApi {
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 {
// ignore: prefer_const_declarations
final apiPath = r'/trash/empty';
@ -42,6 +44,7 @@ class TrashApi {
);
}
/// This endpoint requires the `asset.delete` permission.
Future<TrashResponseDto?> emptyTrash() async {
final response = await emptyTrashWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -57,7 +60,10 @@ class TrashApi {
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:
///
/// * [BulkIdsDto] bulkIdsDto (required):
@ -86,6 +92,8 @@ class TrashApi {
);
}
/// This endpoint requires the `asset.delete` permission.
///
/// Parameters:
///
/// * [BulkIdsDto] bulkIdsDto (required):
@ -104,7 +112,9 @@ class TrashApi {
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 {
// ignore: prefer_const_declarations
final apiPath = r'/trash/restore';
@ -130,6 +140,7 @@ class TrashApi {
);
}
/// This endpoint requires the `asset.delete` permission.
Future<TrashResponseDto?> restoreTrash() async {
final response = await restoreTrashWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {

63
mobile/openapi/lib/api/users_admin_api.dart generated
View file

@ -16,7 +16,10 @@ class UsersAdminApi {
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:
///
/// * [UserAdminCreateDto] userAdminCreateDto (required):
@ -45,6 +48,8 @@ class UsersAdminApi {
);
}
/// This endpoint is an admin-only route, and requires the `adminUser.create` permission.
///
/// Parameters:
///
/// * [UserAdminCreateDto] userAdminCreateDto (required):
@ -63,7 +68,10 @@ class UsersAdminApi {
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:
///
/// * [String] id (required):
@ -95,6 +103,8 @@ class UsersAdminApi {
);
}
/// This endpoint is an admin-only route, and requires the `adminUser.delete` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -115,7 +125,10 @@ class UsersAdminApi {
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:
///
/// * [String] id (required):
@ -145,6 +158,8 @@ class UsersAdminApi {
);
}
/// This endpoint is an admin-only route, and requires the `adminUser.read` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -163,7 +178,10 @@ class UsersAdminApi {
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:
///
/// * [String] id (required):
@ -193,6 +211,8 @@ class UsersAdminApi {
);
}
/// This endpoint is an admin-only route, and requires the `adminUser.read` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -211,7 +231,10 @@ class UsersAdminApi {
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:
///
/// * [String] id (required):
@ -257,6 +280,8 @@ class UsersAdminApi {
);
}
/// This endpoint is an admin-only route, and requires the `adminUser.read` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -281,7 +306,10 @@ class UsersAdminApi {
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:
///
/// * [String] id (required):
@ -311,6 +339,8 @@ class UsersAdminApi {
);
}
/// This endpoint is an admin-only route, and requires the `adminUser.delete` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -329,7 +359,10 @@ class UsersAdminApi {
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:
///
/// * [String] id:
@ -367,6 +400,8 @@ class UsersAdminApi {
);
}
/// This endpoint is an admin-only route, and requires the `adminUser.read` permission.
///
/// Parameters:
///
/// * [String] id:
@ -390,7 +425,10 @@ class UsersAdminApi {
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:
///
/// * [String] id (required):
@ -422,6 +460,8 @@ class UsersAdminApi {
);
}
/// This endpoint is an admin-only route, and requires the `adminUser.update` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -442,7 +482,10 @@ class UsersAdminApi {
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:
///
/// * [String] id (required):
@ -474,6 +517,8 @@ class UsersAdminApi {
);
}
/// This endpoint is an admin-only route, and requires the `adminUser.update` permission.
///
/// Parameters:
///
/// * [String] id (required):

89
mobile/openapi/lib/api/users_api.dart generated
View file

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