mirror of
https://github.com/immich-app/immich.git
synced 2024-12-15 12:09:44 +02:00
5b87abb021
* refactor: remove isReadOnly and isExternal usages * chore: open api * fix: linting * remove mobile isReadOnly dependency --------- Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
1118 lines
35 KiB
Dart
Generated
1118 lines
35 KiB
Dart
Generated
//
|
|
// AUTO-GENERATED FILE, DO NOT MODIFY!
|
|
//
|
|
// @dart=2.12
|
|
|
|
// 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 AssetApi {
|
|
AssetApi([ApiClient? apiClient]) : apiClient = apiClient ?? defaultApiClient;
|
|
|
|
final ApiClient apiClient;
|
|
|
|
/// Checks if assets exist by checksums
|
|
///
|
|
/// Note: This method returns the HTTP [Response].
|
|
///
|
|
/// Parameters:
|
|
///
|
|
/// * [AssetBulkUploadCheckDto] assetBulkUploadCheckDto (required):
|
|
Future<Response> checkBulkUploadWithHttpInfo(AssetBulkUploadCheckDto assetBulkUploadCheckDto,) async {
|
|
// ignore: prefer_const_declarations
|
|
final path = r'/asset/bulk-upload-check';
|
|
|
|
// ignore: prefer_final_locals
|
|
Object? postBody = assetBulkUploadCheckDto;
|
|
|
|
final queryParams = <QueryParam>[];
|
|
final headerParams = <String, String>{};
|
|
final formParams = <String, String>{};
|
|
|
|
const contentTypes = <String>['application/json'];
|
|
|
|
|
|
return apiClient.invokeAPI(
|
|
path,
|
|
'POST',
|
|
queryParams,
|
|
postBody,
|
|
headerParams,
|
|
formParams,
|
|
contentTypes.isEmpty ? null : contentTypes.first,
|
|
);
|
|
}
|
|
|
|
/// Checks if assets exist by checksums
|
|
///
|
|
/// Parameters:
|
|
///
|
|
/// * [AssetBulkUploadCheckDto] assetBulkUploadCheckDto (required):
|
|
Future<AssetBulkUploadCheckResponseDto?> checkBulkUpload(AssetBulkUploadCheckDto assetBulkUploadCheckDto,) async {
|
|
final response = await checkBulkUploadWithHttpInfo(assetBulkUploadCheckDto,);
|
|
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), 'AssetBulkUploadCheckResponseDto',) as AssetBulkUploadCheckResponseDto;
|
|
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/// Checks if multiple assets exist on the server and returns all existing - used by background backup
|
|
///
|
|
/// Note: This method returns the HTTP [Response].
|
|
///
|
|
/// Parameters:
|
|
///
|
|
/// * [CheckExistingAssetsDto] checkExistingAssetsDto (required):
|
|
Future<Response> checkExistingAssetsWithHttpInfo(CheckExistingAssetsDto checkExistingAssetsDto,) async {
|
|
// ignore: prefer_const_declarations
|
|
final path = r'/asset/exist';
|
|
|
|
// ignore: prefer_final_locals
|
|
Object? postBody = checkExistingAssetsDto;
|
|
|
|
final queryParams = <QueryParam>[];
|
|
final headerParams = <String, String>{};
|
|
final formParams = <String, String>{};
|
|
|
|
const contentTypes = <String>['application/json'];
|
|
|
|
|
|
return apiClient.invokeAPI(
|
|
path,
|
|
'POST',
|
|
queryParams,
|
|
postBody,
|
|
headerParams,
|
|
formParams,
|
|
contentTypes.isEmpty ? null : contentTypes.first,
|
|
);
|
|
}
|
|
|
|
/// Checks if multiple assets exist on the server and returns all existing - used by background backup
|
|
///
|
|
/// Parameters:
|
|
///
|
|
/// * [CheckExistingAssetsDto] checkExistingAssetsDto (required):
|
|
Future<CheckExistingAssetsResponseDto?> checkExistingAssets(CheckExistingAssetsDto checkExistingAssetsDto,) async {
|
|
final response = await checkExistingAssetsWithHttpInfo(checkExistingAssetsDto,);
|
|
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), 'CheckExistingAssetsResponseDto',) as CheckExistingAssetsResponseDto;
|
|
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/// Performs an HTTP 'DELETE /asset' operation and returns the [Response].
|
|
/// Parameters:
|
|
///
|
|
/// * [AssetBulkDeleteDto] assetBulkDeleteDto (required):
|
|
Future<Response> deleteAssetsWithHttpInfo(AssetBulkDeleteDto assetBulkDeleteDto,) async {
|
|
// ignore: prefer_const_declarations
|
|
final path = r'/asset';
|
|
|
|
// ignore: prefer_final_locals
|
|
Object? postBody = assetBulkDeleteDto;
|
|
|
|
final queryParams = <QueryParam>[];
|
|
final headerParams = <String, String>{};
|
|
final formParams = <String, String>{};
|
|
|
|
const contentTypes = <String>['application/json'];
|
|
|
|
|
|
return apiClient.invokeAPI(
|
|
path,
|
|
'DELETE',
|
|
queryParams,
|
|
postBody,
|
|
headerParams,
|
|
formParams,
|
|
contentTypes.isEmpty ? null : contentTypes.first,
|
|
);
|
|
}
|
|
|
|
/// Parameters:
|
|
///
|
|
/// * [AssetBulkDeleteDto] assetBulkDeleteDto (required):
|
|
Future<void> deleteAssets(AssetBulkDeleteDto assetBulkDeleteDto,) async {
|
|
final response = await deleteAssetsWithHttpInfo(assetBulkDeleteDto,);
|
|
if (response.statusCode >= HttpStatus.badRequest) {
|
|
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
|
|
}
|
|
}
|
|
|
|
/// Get all AssetEntity belong to the user
|
|
///
|
|
/// Note: This method returns the HTTP [Response].
|
|
///
|
|
/// Parameters:
|
|
///
|
|
/// * [String] ifNoneMatch:
|
|
/// ETag of data already cached on the client
|
|
///
|
|
/// * [bool] isArchived:
|
|
///
|
|
/// * [bool] isFavorite:
|
|
///
|
|
/// * [int] skip:
|
|
///
|
|
/// * [int] take:
|
|
///
|
|
/// * [DateTime] updatedAfter:
|
|
///
|
|
/// * [DateTime] updatedBefore:
|
|
///
|
|
/// * [String] userId:
|
|
Future<Response> getAllAssetsWithHttpInfo({ String? ifNoneMatch, bool? isArchived, bool? isFavorite, int? skip, int? take, DateTime? updatedAfter, DateTime? updatedBefore, String? userId, }) async {
|
|
// ignore: prefer_const_declarations
|
|
final path = r'/asset';
|
|
|
|
// ignore: prefer_final_locals
|
|
Object? postBody;
|
|
|
|
final queryParams = <QueryParam>[];
|
|
final headerParams = <String, String>{};
|
|
final formParams = <String, String>{};
|
|
|
|
if (isArchived != null) {
|
|
queryParams.addAll(_queryParams('', 'isArchived', isArchived));
|
|
}
|
|
if (isFavorite != null) {
|
|
queryParams.addAll(_queryParams('', 'isFavorite', isFavorite));
|
|
}
|
|
if (skip != null) {
|
|
queryParams.addAll(_queryParams('', 'skip', skip));
|
|
}
|
|
if (take != null) {
|
|
queryParams.addAll(_queryParams('', 'take', take));
|
|
}
|
|
if (updatedAfter != null) {
|
|
queryParams.addAll(_queryParams('', 'updatedAfter', updatedAfter));
|
|
}
|
|
if (updatedBefore != null) {
|
|
queryParams.addAll(_queryParams('', 'updatedBefore', updatedBefore));
|
|
}
|
|
if (userId != null) {
|
|
queryParams.addAll(_queryParams('', 'userId', userId));
|
|
}
|
|
|
|
if (ifNoneMatch != null) {
|
|
headerParams[r'if-none-match'] = parameterToString(ifNoneMatch);
|
|
}
|
|
|
|
const contentTypes = <String>[];
|
|
|
|
|
|
return apiClient.invokeAPI(
|
|
path,
|
|
'GET',
|
|
queryParams,
|
|
postBody,
|
|
headerParams,
|
|
formParams,
|
|
contentTypes.isEmpty ? null : contentTypes.first,
|
|
);
|
|
}
|
|
|
|
/// Get all AssetEntity belong to the user
|
|
///
|
|
/// Parameters:
|
|
///
|
|
/// * [String] ifNoneMatch:
|
|
/// ETag of data already cached on the client
|
|
///
|
|
/// * [bool] isArchived:
|
|
///
|
|
/// * [bool] isFavorite:
|
|
///
|
|
/// * [int] skip:
|
|
///
|
|
/// * [int] take:
|
|
///
|
|
/// * [DateTime] updatedAfter:
|
|
///
|
|
/// * [DateTime] updatedBefore:
|
|
///
|
|
/// * [String] userId:
|
|
Future<List<AssetResponseDto>?> getAllAssets({ String? ifNoneMatch, bool? isArchived, bool? isFavorite, int? skip, int? take, DateTime? updatedAfter, DateTime? updatedBefore, String? userId, }) async {
|
|
final response = await getAllAssetsWithHttpInfo( ifNoneMatch: ifNoneMatch, isArchived: isArchived, isFavorite: isFavorite, skip: skip, take: take, updatedAfter: updatedAfter, updatedBefore: updatedBefore, userId: userId, );
|
|
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;
|
|
}
|
|
|
|
/// Get all asset of a device that are in the database, ID only.
|
|
///
|
|
/// Note: This method returns the HTTP [Response].
|
|
///
|
|
/// Parameters:
|
|
///
|
|
/// * [String] deviceId (required):
|
|
Future<Response> getAllUserAssetsByDeviceIdWithHttpInfo(String deviceId,) async {
|
|
// ignore: prefer_const_declarations
|
|
final path = r'/asset/device/{deviceId}'
|
|
.replaceAll('{deviceId}', deviceId);
|
|
|
|
// ignore: prefer_final_locals
|
|
Object? postBody;
|
|
|
|
final queryParams = <QueryParam>[];
|
|
final headerParams = <String, String>{};
|
|
final formParams = <String, String>{};
|
|
|
|
const contentTypes = <String>[];
|
|
|
|
|
|
return apiClient.invokeAPI(
|
|
path,
|
|
'GET',
|
|
queryParams,
|
|
postBody,
|
|
headerParams,
|
|
formParams,
|
|
contentTypes.isEmpty ? null : contentTypes.first,
|
|
);
|
|
}
|
|
|
|
/// Get all asset of a device that are in the database, ID only.
|
|
///
|
|
/// Parameters:
|
|
///
|
|
/// * [String] deviceId (required):
|
|
Future<List<String>?> getAllUserAssetsByDeviceId(String deviceId,) async {
|
|
final response = await getAllUserAssetsByDeviceIdWithHttpInfo(deviceId,);
|
|
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<String>') as List)
|
|
.cast<String>()
|
|
.toList(growable: false);
|
|
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/// Performs an HTTP 'GET /asset/{id}' operation and returns the [Response].
|
|
/// Parameters:
|
|
///
|
|
/// * [String] id (required):
|
|
///
|
|
/// * [String] key:
|
|
Future<Response> getAssetInfoWithHttpInfo(String id, { String? key, }) async {
|
|
// ignore: prefer_const_declarations
|
|
final path = r'/asset/{id}'
|
|
.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));
|
|
}
|
|
|
|
const contentTypes = <String>[];
|
|
|
|
|
|
return apiClient.invokeAPI(
|
|
path,
|
|
'GET',
|
|
queryParams,
|
|
postBody,
|
|
headerParams,
|
|
formParams,
|
|
contentTypes.isEmpty ? null : contentTypes.first,
|
|
);
|
|
}
|
|
|
|
/// Parameters:
|
|
///
|
|
/// * [String] id (required):
|
|
///
|
|
/// * [String] key:
|
|
Future<AssetResponseDto?> getAssetInfo(String id, { String? key, }) async {
|
|
final response = await getAssetInfoWithHttpInfo(id, key: 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), 'AssetResponseDto',) as AssetResponseDto;
|
|
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/// Performs an HTTP 'GET /asset/statistics' operation and returns the [Response].
|
|
/// Parameters:
|
|
///
|
|
/// * [bool] isArchived:
|
|
///
|
|
/// * [bool] isFavorite:
|
|
///
|
|
/// * [bool] isTrashed:
|
|
Future<Response> getAssetStatisticsWithHttpInfo({ bool? isArchived, bool? isFavorite, bool? isTrashed, }) async {
|
|
// ignore: prefer_const_declarations
|
|
final path = r'/asset/statistics';
|
|
|
|
// ignore: prefer_final_locals
|
|
Object? postBody;
|
|
|
|
final queryParams = <QueryParam>[];
|
|
final headerParams = <String, String>{};
|
|
final formParams = <String, String>{};
|
|
|
|
if (isArchived != null) {
|
|
queryParams.addAll(_queryParams('', 'isArchived', isArchived));
|
|
}
|
|
if (isFavorite != null) {
|
|
queryParams.addAll(_queryParams('', 'isFavorite', isFavorite));
|
|
}
|
|
if (isTrashed != null) {
|
|
queryParams.addAll(_queryParams('', 'isTrashed', isTrashed));
|
|
}
|
|
|
|
const contentTypes = <String>[];
|
|
|
|
|
|
return apiClient.invokeAPI(
|
|
path,
|
|
'GET',
|
|
queryParams,
|
|
postBody,
|
|
headerParams,
|
|
formParams,
|
|
contentTypes.isEmpty ? null : contentTypes.first,
|
|
);
|
|
}
|
|
|
|
/// Parameters:
|
|
///
|
|
/// * [bool] isArchived:
|
|
///
|
|
/// * [bool] isFavorite:
|
|
///
|
|
/// * [bool] isTrashed:
|
|
Future<AssetStatsResponseDto?> getAssetStatistics({ bool? isArchived, bool? isFavorite, bool? isTrashed, }) async {
|
|
final response = await getAssetStatisticsWithHttpInfo( isArchived: isArchived, isFavorite: isFavorite, isTrashed: isTrashed, );
|
|
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), 'AssetStatsResponseDto',) as AssetStatsResponseDto;
|
|
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/// Performs an HTTP 'GET /asset/thumbnail/{id}' operation and returns the [Response].
|
|
/// Parameters:
|
|
///
|
|
/// * [String] id (required):
|
|
///
|
|
/// * [ThumbnailFormat] format:
|
|
///
|
|
/// * [String] key:
|
|
Future<Response> getAssetThumbnailWithHttpInfo(String id, { ThumbnailFormat? format, String? key, }) async {
|
|
// ignore: prefer_const_declarations
|
|
final path = r'/asset/thumbnail/{id}'
|
|
.replaceAll('{id}', id);
|
|
|
|
// ignore: prefer_final_locals
|
|
Object? postBody;
|
|
|
|
final queryParams = <QueryParam>[];
|
|
final headerParams = <String, String>{};
|
|
final formParams = <String, String>{};
|
|
|
|
if (format != null) {
|
|
queryParams.addAll(_queryParams('', 'format', format));
|
|
}
|
|
if (key != null) {
|
|
queryParams.addAll(_queryParams('', 'key', key));
|
|
}
|
|
|
|
const contentTypes = <String>[];
|
|
|
|
|
|
return apiClient.invokeAPI(
|
|
path,
|
|
'GET',
|
|
queryParams,
|
|
postBody,
|
|
headerParams,
|
|
formParams,
|
|
contentTypes.isEmpty ? null : contentTypes.first,
|
|
);
|
|
}
|
|
|
|
/// Parameters:
|
|
///
|
|
/// * [String] id (required):
|
|
///
|
|
/// * [ThumbnailFormat] format:
|
|
///
|
|
/// * [String] key:
|
|
Future<MultipartFile?> getAssetThumbnail(String id, { ThumbnailFormat? format, String? key, }) async {
|
|
final response = await getAssetThumbnailWithHttpInfo(id, format: format, key: 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), 'MultipartFile',) as MultipartFile;
|
|
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/// Performs an HTTP 'GET /asset/map-marker' operation and returns the [Response].
|
|
/// Parameters:
|
|
///
|
|
/// * [DateTime] fileCreatedAfter:
|
|
///
|
|
/// * [DateTime] fileCreatedBefore:
|
|
///
|
|
/// * [bool] isArchived:
|
|
///
|
|
/// * [bool] isFavorite:
|
|
///
|
|
/// * [bool] withPartners:
|
|
Future<Response> getMapMarkersWithHttpInfo({ DateTime? fileCreatedAfter, DateTime? fileCreatedBefore, bool? isArchived, bool? isFavorite, bool? withPartners, }) async {
|
|
// ignore: prefer_const_declarations
|
|
final path = r'/asset/map-marker';
|
|
|
|
// ignore: prefer_final_locals
|
|
Object? postBody;
|
|
|
|
final queryParams = <QueryParam>[];
|
|
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 (withPartners != null) {
|
|
queryParams.addAll(_queryParams('', 'withPartners', withPartners));
|
|
}
|
|
|
|
const contentTypes = <String>[];
|
|
|
|
|
|
return apiClient.invokeAPI(
|
|
path,
|
|
'GET',
|
|
queryParams,
|
|
postBody,
|
|
headerParams,
|
|
formParams,
|
|
contentTypes.isEmpty ? null : contentTypes.first,
|
|
);
|
|
}
|
|
|
|
/// Parameters:
|
|
///
|
|
/// * [DateTime] fileCreatedAfter:
|
|
///
|
|
/// * [DateTime] fileCreatedBefore:
|
|
///
|
|
/// * [bool] isArchived:
|
|
///
|
|
/// * [bool] isFavorite:
|
|
///
|
|
/// * [bool] withPartners:
|
|
Future<List<MapMarkerResponseDto>?> getMapMarkers({ DateTime? fileCreatedAfter, DateTime? fileCreatedBefore, bool? isArchived, bool? isFavorite, bool? withPartners, }) async {
|
|
final response = await getMapMarkersWithHttpInfo( fileCreatedAfter: fileCreatedAfter, fileCreatedBefore: fileCreatedBefore, isArchived: isArchived, isFavorite: isFavorite, withPartners: withPartners, );
|
|
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<MapMarkerResponseDto>') as List)
|
|
.cast<MapMarkerResponseDto>()
|
|
.toList(growable: false);
|
|
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/// Performs an HTTP 'GET /asset/memory-lane' operation and returns the [Response].
|
|
/// Parameters:
|
|
///
|
|
/// * [int] day (required):
|
|
///
|
|
/// * [int] month (required):
|
|
Future<Response> getMemoryLaneWithHttpInfo(int day, int month,) async {
|
|
// ignore: prefer_const_declarations
|
|
final path = r'/asset/memory-lane';
|
|
|
|
// ignore: prefer_final_locals
|
|
Object? postBody;
|
|
|
|
final queryParams = <QueryParam>[];
|
|
final headerParams = <String, String>{};
|
|
final formParams = <String, String>{};
|
|
|
|
queryParams.addAll(_queryParams('', 'day', day));
|
|
queryParams.addAll(_queryParams('', 'month', month));
|
|
|
|
const contentTypes = <String>[];
|
|
|
|
|
|
return apiClient.invokeAPI(
|
|
path,
|
|
'GET',
|
|
queryParams,
|
|
postBody,
|
|
headerParams,
|
|
formParams,
|
|
contentTypes.isEmpty ? null : contentTypes.first,
|
|
);
|
|
}
|
|
|
|
/// Parameters:
|
|
///
|
|
/// * [int] day (required):
|
|
///
|
|
/// * [int] month (required):
|
|
Future<List<MemoryLaneResponseDto>?> getMemoryLane(int day, int month,) async {
|
|
final response = await getMemoryLaneWithHttpInfo(day, month,);
|
|
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<MemoryLaneResponseDto>') as List)
|
|
.cast<MemoryLaneResponseDto>()
|
|
.toList(growable: false);
|
|
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/// Performs an HTTP 'GET /asset/random' operation and returns the [Response].
|
|
/// Parameters:
|
|
///
|
|
/// * [num] count:
|
|
Future<Response> getRandomWithHttpInfo({ num? count, }) async {
|
|
// ignore: prefer_const_declarations
|
|
final path = r'/asset/random';
|
|
|
|
// ignore: prefer_final_locals
|
|
Object? postBody;
|
|
|
|
final queryParams = <QueryParam>[];
|
|
final headerParams = <String, String>{};
|
|
final formParams = <String, String>{};
|
|
|
|
if (count != null) {
|
|
queryParams.addAll(_queryParams('', 'count', count));
|
|
}
|
|
|
|
const contentTypes = <String>[];
|
|
|
|
|
|
return apiClient.invokeAPI(
|
|
path,
|
|
'GET',
|
|
queryParams,
|
|
postBody,
|
|
headerParams,
|
|
formParams,
|
|
contentTypes.isEmpty ? null : contentTypes.first,
|
|
);
|
|
}
|
|
|
|
/// Parameters:
|
|
///
|
|
/// * [num] count:
|
|
Future<List<AssetResponseDto>?> getRandom({ num? count, }) async {
|
|
final response = await getRandomWithHttpInfo( count: count, );
|
|
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;
|
|
}
|
|
|
|
/// Performs an HTTP 'POST /asset/jobs' operation and returns the [Response].
|
|
/// Parameters:
|
|
///
|
|
/// * [AssetJobsDto] assetJobsDto (required):
|
|
Future<Response> runAssetJobsWithHttpInfo(AssetJobsDto assetJobsDto,) async {
|
|
// ignore: prefer_const_declarations
|
|
final path = r'/asset/jobs';
|
|
|
|
// ignore: prefer_final_locals
|
|
Object? postBody = assetJobsDto;
|
|
|
|
final queryParams = <QueryParam>[];
|
|
final headerParams = <String, String>{};
|
|
final formParams = <String, String>{};
|
|
|
|
const contentTypes = <String>['application/json'];
|
|
|
|
|
|
return apiClient.invokeAPI(
|
|
path,
|
|
'POST',
|
|
queryParams,
|
|
postBody,
|
|
headerParams,
|
|
formParams,
|
|
contentTypes.isEmpty ? null : contentTypes.first,
|
|
);
|
|
}
|
|
|
|
/// Parameters:
|
|
///
|
|
/// * [AssetJobsDto] assetJobsDto (required):
|
|
Future<void> runAssetJobs(AssetJobsDto assetJobsDto,) async {
|
|
final response = await runAssetJobsWithHttpInfo(assetJobsDto,);
|
|
if (response.statusCode >= HttpStatus.badRequest) {
|
|
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
|
|
}
|
|
}
|
|
|
|
/// Performs an HTTP 'GET /asset/file/{id}' operation and returns the [Response].
|
|
/// Parameters:
|
|
///
|
|
/// * [String] id (required):
|
|
///
|
|
/// * [bool] isThumb:
|
|
///
|
|
/// * [bool] isWeb:
|
|
///
|
|
/// * [String] key:
|
|
Future<Response> serveFileWithHttpInfo(String id, { bool? isThumb, bool? isWeb, String? key, }) async {
|
|
// ignore: prefer_const_declarations
|
|
final path = r'/asset/file/{id}'
|
|
.replaceAll('{id}', id);
|
|
|
|
// ignore: prefer_final_locals
|
|
Object? postBody;
|
|
|
|
final queryParams = <QueryParam>[];
|
|
final headerParams = <String, String>{};
|
|
final formParams = <String, String>{};
|
|
|
|
if (isThumb != null) {
|
|
queryParams.addAll(_queryParams('', 'isThumb', isThumb));
|
|
}
|
|
if (isWeb != null) {
|
|
queryParams.addAll(_queryParams('', 'isWeb', isWeb));
|
|
}
|
|
if (key != null) {
|
|
queryParams.addAll(_queryParams('', 'key', key));
|
|
}
|
|
|
|
const contentTypes = <String>[];
|
|
|
|
|
|
return apiClient.invokeAPI(
|
|
path,
|
|
'GET',
|
|
queryParams,
|
|
postBody,
|
|
headerParams,
|
|
formParams,
|
|
contentTypes.isEmpty ? null : contentTypes.first,
|
|
);
|
|
}
|
|
|
|
/// Parameters:
|
|
///
|
|
/// * [String] id (required):
|
|
///
|
|
/// * [bool] isThumb:
|
|
///
|
|
/// * [bool] isWeb:
|
|
///
|
|
/// * [String] key:
|
|
Future<MultipartFile?> serveFile(String id, { bool? isThumb, bool? isWeb, String? key, }) async {
|
|
final response = await serveFileWithHttpInfo(id, isThumb: isThumb, isWeb: isWeb, key: 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), 'MultipartFile',) as MultipartFile;
|
|
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/// Performs an HTTP 'PUT /asset/{id}' operation and returns the [Response].
|
|
/// Parameters:
|
|
///
|
|
/// * [String] id (required):
|
|
///
|
|
/// * [UpdateAssetDto] updateAssetDto (required):
|
|
Future<Response> updateAssetWithHttpInfo(String id, UpdateAssetDto updateAssetDto,) async {
|
|
// ignore: prefer_const_declarations
|
|
final path = r'/asset/{id}'
|
|
.replaceAll('{id}', id);
|
|
|
|
// ignore: prefer_final_locals
|
|
Object? postBody = updateAssetDto;
|
|
|
|
final queryParams = <QueryParam>[];
|
|
final headerParams = <String, String>{};
|
|
final formParams = <String, String>{};
|
|
|
|
const contentTypes = <String>['application/json'];
|
|
|
|
|
|
return apiClient.invokeAPI(
|
|
path,
|
|
'PUT',
|
|
queryParams,
|
|
postBody,
|
|
headerParams,
|
|
formParams,
|
|
contentTypes.isEmpty ? null : contentTypes.first,
|
|
);
|
|
}
|
|
|
|
/// Parameters:
|
|
///
|
|
/// * [String] id (required):
|
|
///
|
|
/// * [UpdateAssetDto] updateAssetDto (required):
|
|
Future<AssetResponseDto?> updateAsset(String id, UpdateAssetDto updateAssetDto,) async {
|
|
final response = await updateAssetWithHttpInfo(id, updateAssetDto,);
|
|
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), 'AssetResponseDto',) as AssetResponseDto;
|
|
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/// Performs an HTTP 'PUT /asset' operation and returns the [Response].
|
|
/// Parameters:
|
|
///
|
|
/// * [AssetBulkUpdateDto] assetBulkUpdateDto (required):
|
|
Future<Response> updateAssetsWithHttpInfo(AssetBulkUpdateDto assetBulkUpdateDto,) async {
|
|
// ignore: prefer_const_declarations
|
|
final path = r'/asset';
|
|
|
|
// ignore: prefer_final_locals
|
|
Object? postBody = assetBulkUpdateDto;
|
|
|
|
final queryParams = <QueryParam>[];
|
|
final headerParams = <String, String>{};
|
|
final formParams = <String, String>{};
|
|
|
|
const contentTypes = <String>['application/json'];
|
|
|
|
|
|
return apiClient.invokeAPI(
|
|
path,
|
|
'PUT',
|
|
queryParams,
|
|
postBody,
|
|
headerParams,
|
|
formParams,
|
|
contentTypes.isEmpty ? null : contentTypes.first,
|
|
);
|
|
}
|
|
|
|
/// Parameters:
|
|
///
|
|
/// * [AssetBulkUpdateDto] assetBulkUpdateDto (required):
|
|
Future<void> updateAssets(AssetBulkUpdateDto assetBulkUpdateDto,) async {
|
|
final response = await updateAssetsWithHttpInfo(assetBulkUpdateDto,);
|
|
if (response.statusCode >= HttpStatus.badRequest) {
|
|
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
|
|
}
|
|
}
|
|
|
|
/// Performs an HTTP 'PUT /asset/stack/parent' operation and returns the [Response].
|
|
/// Parameters:
|
|
///
|
|
/// * [UpdateStackParentDto] updateStackParentDto (required):
|
|
Future<Response> updateStackParentWithHttpInfo(UpdateStackParentDto updateStackParentDto,) async {
|
|
// ignore: prefer_const_declarations
|
|
final path = r'/asset/stack/parent';
|
|
|
|
// ignore: prefer_final_locals
|
|
Object? postBody = updateStackParentDto;
|
|
|
|
final queryParams = <QueryParam>[];
|
|
final headerParams = <String, String>{};
|
|
final formParams = <String, String>{};
|
|
|
|
const contentTypes = <String>['application/json'];
|
|
|
|
|
|
return apiClient.invokeAPI(
|
|
path,
|
|
'PUT',
|
|
queryParams,
|
|
postBody,
|
|
headerParams,
|
|
formParams,
|
|
contentTypes.isEmpty ? null : contentTypes.first,
|
|
);
|
|
}
|
|
|
|
/// Parameters:
|
|
///
|
|
/// * [UpdateStackParentDto] updateStackParentDto (required):
|
|
Future<void> updateStackParent(UpdateStackParentDto updateStackParentDto,) async {
|
|
final response = await updateStackParentWithHttpInfo(updateStackParentDto,);
|
|
if (response.statusCode >= HttpStatus.badRequest) {
|
|
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
|
|
}
|
|
}
|
|
|
|
/// Performs an HTTP 'POST /asset/upload' operation and returns the [Response].
|
|
/// Parameters:
|
|
///
|
|
/// * [MultipartFile] assetData (required):
|
|
///
|
|
/// * [String] deviceAssetId (required):
|
|
///
|
|
/// * [String] deviceId (required):
|
|
///
|
|
/// * [DateTime] fileCreatedAt (required):
|
|
///
|
|
/// * [DateTime] fileModifiedAt (required):
|
|
///
|
|
/// * [String] key:
|
|
///
|
|
/// * [String] xImmichChecksum:
|
|
/// sha1 checksum that can be used for duplicate detection before the file is uploaded
|
|
///
|
|
/// * [String] duration:
|
|
///
|
|
/// * [bool] isArchived:
|
|
///
|
|
/// * [bool] isFavorite:
|
|
///
|
|
/// * [bool] isOffline:
|
|
///
|
|
/// * [bool] isVisible:
|
|
///
|
|
/// * [String] libraryId:
|
|
///
|
|
/// * [MultipartFile] livePhotoData:
|
|
///
|
|
/// * [MultipartFile] sidecarData:
|
|
Future<Response> uploadFileWithHttpInfo(MultipartFile assetData, String deviceAssetId, String deviceId, DateTime fileCreatedAt, DateTime fileModifiedAt, { String? key, String? xImmichChecksum, String? duration, bool? isArchived, bool? isFavorite, bool? isOffline, bool? isVisible, String? libraryId, MultipartFile? livePhotoData, MultipartFile? sidecarData, }) async {
|
|
// ignore: prefer_const_declarations
|
|
final path = r'/asset/upload';
|
|
|
|
// 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 (xImmichChecksum != null) {
|
|
headerParams[r'x-immich-checksum'] = parameterToString(xImmichChecksum);
|
|
}
|
|
|
|
const contentTypes = <String>['multipart/form-data'];
|
|
|
|
bool hasFields = false;
|
|
final mp = MultipartRequest('POST', Uri.parse(path));
|
|
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 (isArchived != null) {
|
|
hasFields = true;
|
|
mp.fields[r'isArchived'] = parameterToString(isArchived);
|
|
}
|
|
if (isFavorite != null) {
|
|
hasFields = true;
|
|
mp.fields[r'isFavorite'] = parameterToString(isFavorite);
|
|
}
|
|
if (isOffline != null) {
|
|
hasFields = true;
|
|
mp.fields[r'isOffline'] = parameterToString(isOffline);
|
|
}
|
|
if (isVisible != null) {
|
|
hasFields = true;
|
|
mp.fields[r'isVisible'] = parameterToString(isVisible);
|
|
}
|
|
if (libraryId != null) {
|
|
hasFields = true;
|
|
mp.fields[r'libraryId'] = parameterToString(libraryId);
|
|
}
|
|
if (livePhotoData != null) {
|
|
hasFields = true;
|
|
mp.fields[r'livePhotoData'] = livePhotoData.field;
|
|
mp.files.add(livePhotoData);
|
|
}
|
|
if (sidecarData != null) {
|
|
hasFields = true;
|
|
mp.fields[r'sidecarData'] = sidecarData.field;
|
|
mp.files.add(sidecarData);
|
|
}
|
|
if (hasFields) {
|
|
postBody = mp;
|
|
}
|
|
|
|
return apiClient.invokeAPI(
|
|
path,
|
|
'POST',
|
|
queryParams,
|
|
postBody,
|
|
headerParams,
|
|
formParams,
|
|
contentTypes.isEmpty ? null : contentTypes.first,
|
|
);
|
|
}
|
|
|
|
/// Parameters:
|
|
///
|
|
/// * [MultipartFile] assetData (required):
|
|
///
|
|
/// * [String] deviceAssetId (required):
|
|
///
|
|
/// * [String] deviceId (required):
|
|
///
|
|
/// * [DateTime] fileCreatedAt (required):
|
|
///
|
|
/// * [DateTime] fileModifiedAt (required):
|
|
///
|
|
/// * [String] key:
|
|
///
|
|
/// * [String] xImmichChecksum:
|
|
/// sha1 checksum that can be used for duplicate detection before the file is uploaded
|
|
///
|
|
/// * [String] duration:
|
|
///
|
|
/// * [bool] isArchived:
|
|
///
|
|
/// * [bool] isFavorite:
|
|
///
|
|
/// * [bool] isOffline:
|
|
///
|
|
/// * [bool] isVisible:
|
|
///
|
|
/// * [String] libraryId:
|
|
///
|
|
/// * [MultipartFile] livePhotoData:
|
|
///
|
|
/// * [MultipartFile] sidecarData:
|
|
Future<AssetFileUploadResponseDto?> uploadFile(MultipartFile assetData, String deviceAssetId, String deviceId, DateTime fileCreatedAt, DateTime fileModifiedAt, { String? key, String? xImmichChecksum, String? duration, bool? isArchived, bool? isFavorite, bool? isOffline, bool? isVisible, String? libraryId, MultipartFile? livePhotoData, MultipartFile? sidecarData, }) async {
|
|
final response = await uploadFileWithHttpInfo(assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, key: key, xImmichChecksum: xImmichChecksum, duration: duration, isArchived: isArchived, isFavorite: isFavorite, isOffline: isOffline, isVisible: isVisible, libraryId: libraryId, livePhotoData: livePhotoData, sidecarData: sidecarData, );
|
|
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), 'AssetFileUploadResponseDto',) as AssetFileUploadResponseDto;
|
|
|
|
}
|
|
return null;
|
|
}
|
|
}
|