mirror of
				https://github.com/immich-app/immich.git
				synced 2025-10-30 18:22:37 -04:00 
			
		
		
		
	* rename api tags to follow plural nomenclature of endpoints * chore: open api * fix mobile
		
			
				
	
	
		
			434 lines
		
	
	
		
			13 KiB
		
	
	
	
		
			Dart
		
	
	
	
	
		
			Generated
		
	
	
			
		
		
	
	
			434 lines
		
	
	
		
			13 KiB
		
	
	
	
		
			Dart
		
	
	
	
	
		
			Generated
		
	
	
| //
 | |
| // 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 LibrariesApi {
 | |
|   LibrariesApi([ApiClient? apiClient]) : apiClient = apiClient ?? defaultApiClient;
 | |
| 
 | |
|   final ApiClient apiClient;
 | |
| 
 | |
|   /// Performs an HTTP 'POST /libraries' operation and returns the [Response].
 | |
|   /// Parameters:
 | |
|   ///
 | |
|   /// * [CreateLibraryDto] createLibraryDto (required):
 | |
|   Future<Response> createLibraryWithHttpInfo(CreateLibraryDto createLibraryDto,) async {
 | |
|     // ignore: prefer_const_declarations
 | |
|     final path = r'/libraries';
 | |
| 
 | |
|     // ignore: prefer_final_locals
 | |
|     Object? postBody = createLibraryDto;
 | |
| 
 | |
|     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:
 | |
|   ///
 | |
|   /// * [CreateLibraryDto] createLibraryDto (required):
 | |
|   Future<LibraryResponseDto?> createLibrary(CreateLibraryDto createLibraryDto,) async {
 | |
|     final response = await createLibraryWithHttpInfo(createLibraryDto,);
 | |
|     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), 'LibraryResponseDto',) as LibraryResponseDto;
 | |
|     
 | |
|     }
 | |
|     return null;
 | |
|   }
 | |
| 
 | |
|   /// Performs an HTTP 'DELETE /libraries/{id}' operation and returns the [Response].
 | |
|   /// Parameters:
 | |
|   ///
 | |
|   /// * [String] id (required):
 | |
|   Future<Response> deleteLibraryWithHttpInfo(String id,) async {
 | |
|     // ignore: prefer_const_declarations
 | |
|     final path = r'/libraries/{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(
 | |
|       path,
 | |
|       'DELETE',
 | |
|       queryParams,
 | |
|       postBody,
 | |
|       headerParams,
 | |
|       formParams,
 | |
|       contentTypes.isEmpty ? null : contentTypes.first,
 | |
|     );
 | |
|   }
 | |
| 
 | |
|   /// Parameters:
 | |
|   ///
 | |
|   /// * [String] id (required):
 | |
|   Future<void> deleteLibrary(String id,) async {
 | |
|     final response = await deleteLibraryWithHttpInfo(id,);
 | |
|     if (response.statusCode >= HttpStatus.badRequest) {
 | |
|       throw ApiException(response.statusCode, await _decodeBodyBytes(response));
 | |
|     }
 | |
|   }
 | |
| 
 | |
|   /// Performs an HTTP 'GET /libraries' operation and returns the [Response].
 | |
|   Future<Response> getAllLibrariesWithHttpInfo() async {
 | |
|     // ignore: prefer_const_declarations
 | |
|     final path = r'/libraries';
 | |
| 
 | |
|     // 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,
 | |
|     );
 | |
|   }
 | |
| 
 | |
|   Future<List<LibraryResponseDto>?> getAllLibraries() async {
 | |
|     final response = await getAllLibrariesWithHttpInfo();
 | |
|     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<LibraryResponseDto>') as List)
 | |
|         .cast<LibraryResponseDto>()
 | |
|         .toList(growable: false);
 | |
| 
 | |
|     }
 | |
|     return null;
 | |
|   }
 | |
| 
 | |
|   /// Performs an HTTP 'GET /libraries/{id}' operation and returns the [Response].
 | |
|   /// Parameters:
 | |
|   ///
 | |
|   /// * [String] id (required):
 | |
|   Future<Response> getLibraryWithHttpInfo(String id,) async {
 | |
|     // ignore: prefer_const_declarations
 | |
|     final path = r'/libraries/{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(
 | |
|       path,
 | |
|       'GET',
 | |
|       queryParams,
 | |
|       postBody,
 | |
|       headerParams,
 | |
|       formParams,
 | |
|       contentTypes.isEmpty ? null : contentTypes.first,
 | |
|     );
 | |
|   }
 | |
| 
 | |
|   /// Parameters:
 | |
|   ///
 | |
|   /// * [String] id (required):
 | |
|   Future<LibraryResponseDto?> getLibrary(String id,) async {
 | |
|     final response = await getLibraryWithHttpInfo(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), 'LibraryResponseDto',) as LibraryResponseDto;
 | |
|     
 | |
|     }
 | |
|     return null;
 | |
|   }
 | |
| 
 | |
|   /// Performs an HTTP 'GET /libraries/{id}/statistics' operation and returns the [Response].
 | |
|   /// Parameters:
 | |
|   ///
 | |
|   /// * [String] id (required):
 | |
|   Future<Response> getLibraryStatisticsWithHttpInfo(String id,) async {
 | |
|     // ignore: prefer_const_declarations
 | |
|     final path = r'/libraries/{id}/statistics'
 | |
|       .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(
 | |
|       path,
 | |
|       'GET',
 | |
|       queryParams,
 | |
|       postBody,
 | |
|       headerParams,
 | |
|       formParams,
 | |
|       contentTypes.isEmpty ? null : contentTypes.first,
 | |
|     );
 | |
|   }
 | |
| 
 | |
|   /// Parameters:
 | |
|   ///
 | |
|   /// * [String] id (required):
 | |
|   Future<LibraryStatsResponseDto?> getLibraryStatistics(String id,) async {
 | |
|     final response = await getLibraryStatisticsWithHttpInfo(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), 'LibraryStatsResponseDto',) as LibraryStatsResponseDto;
 | |
|     
 | |
|     }
 | |
|     return null;
 | |
|   }
 | |
| 
 | |
|   /// Performs an HTTP 'POST /libraries/{id}/removeOffline' operation and returns the [Response].
 | |
|   /// Parameters:
 | |
|   ///
 | |
|   /// * [String] id (required):
 | |
|   Future<Response> removeOfflineFilesWithHttpInfo(String id,) async {
 | |
|     // ignore: prefer_const_declarations
 | |
|     final path = r'/libraries/{id}/removeOffline'
 | |
|       .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(
 | |
|       path,
 | |
|       'POST',
 | |
|       queryParams,
 | |
|       postBody,
 | |
|       headerParams,
 | |
|       formParams,
 | |
|       contentTypes.isEmpty ? null : contentTypes.first,
 | |
|     );
 | |
|   }
 | |
| 
 | |
|   /// Parameters:
 | |
|   ///
 | |
|   /// * [String] id (required):
 | |
|   Future<void> removeOfflineFiles(String id,) async {
 | |
|     final response = await removeOfflineFilesWithHttpInfo(id,);
 | |
|     if (response.statusCode >= HttpStatus.badRequest) {
 | |
|       throw ApiException(response.statusCode, await _decodeBodyBytes(response));
 | |
|     }
 | |
|   }
 | |
| 
 | |
|   /// Performs an HTTP 'POST /libraries/{id}/scan' operation and returns the [Response].
 | |
|   /// Parameters:
 | |
|   ///
 | |
|   /// * [String] id (required):
 | |
|   ///
 | |
|   /// * [ScanLibraryDto] scanLibraryDto (required):
 | |
|   Future<Response> scanLibraryWithHttpInfo(String id, ScanLibraryDto scanLibraryDto,) async {
 | |
|     // ignore: prefer_const_declarations
 | |
|     final path = r'/libraries/{id}/scan'
 | |
|       .replaceAll('{id}', id);
 | |
| 
 | |
|     // ignore: prefer_final_locals
 | |
|     Object? postBody = scanLibraryDto;
 | |
| 
 | |
|     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:
 | |
|   ///
 | |
|   /// * [String] id (required):
 | |
|   ///
 | |
|   /// * [ScanLibraryDto] scanLibraryDto (required):
 | |
|   Future<void> scanLibrary(String id, ScanLibraryDto scanLibraryDto,) async {
 | |
|     final response = await scanLibraryWithHttpInfo(id, scanLibraryDto,);
 | |
|     if (response.statusCode >= HttpStatus.badRequest) {
 | |
|       throw ApiException(response.statusCode, await _decodeBodyBytes(response));
 | |
|     }
 | |
|   }
 | |
| 
 | |
|   /// Performs an HTTP 'PUT /libraries/{id}' operation and returns the [Response].
 | |
|   /// Parameters:
 | |
|   ///
 | |
|   /// * [String] id (required):
 | |
|   ///
 | |
|   /// * [UpdateLibraryDto] updateLibraryDto (required):
 | |
|   Future<Response> updateLibraryWithHttpInfo(String id, UpdateLibraryDto updateLibraryDto,) async {
 | |
|     // ignore: prefer_const_declarations
 | |
|     final path = r'/libraries/{id}'
 | |
|       .replaceAll('{id}', id);
 | |
| 
 | |
|     // ignore: prefer_final_locals
 | |
|     Object? postBody = updateLibraryDto;
 | |
| 
 | |
|     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):
 | |
|   ///
 | |
|   /// * [UpdateLibraryDto] updateLibraryDto (required):
 | |
|   Future<LibraryResponseDto?> updateLibrary(String id, UpdateLibraryDto updateLibraryDto,) async {
 | |
|     final response = await updateLibraryWithHttpInfo(id, updateLibraryDto,);
 | |
|     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), 'LibraryResponseDto',) as LibraryResponseDto;
 | |
|     
 | |
|     }
 | |
|     return null;
 | |
|   }
 | |
| 
 | |
|   /// Performs an HTTP 'POST /libraries/{id}/validate' operation and returns the [Response].
 | |
|   /// Parameters:
 | |
|   ///
 | |
|   /// * [String] id (required):
 | |
|   ///
 | |
|   /// * [ValidateLibraryDto] validateLibraryDto (required):
 | |
|   Future<Response> validateWithHttpInfo(String id, ValidateLibraryDto validateLibraryDto,) async {
 | |
|     // ignore: prefer_const_declarations
 | |
|     final path = r'/libraries/{id}/validate'
 | |
|       .replaceAll('{id}', id);
 | |
| 
 | |
|     // ignore: prefer_final_locals
 | |
|     Object? postBody = validateLibraryDto;
 | |
| 
 | |
|     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:
 | |
|   ///
 | |
|   /// * [String] id (required):
 | |
|   ///
 | |
|   /// * [ValidateLibraryDto] validateLibraryDto (required):
 | |
|   Future<ValidateLibraryResponseDto?> validate(String id, ValidateLibraryDto validateLibraryDto,) async {
 | |
|     final response = await validateWithHttpInfo(id, validateLibraryDto,);
 | |
|     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), 'ValidateLibraryResponseDto',) as ValidateLibraryResponseDto;
 | |
|     
 | |
|     }
 | |
|     return null;
 | |
|   }
 | |
| }
 |