Cutlery/immich
1
0
Fork 1
mirror of https://github.com/immich-app/immich.git synced 2026-06-04 13:55:19 -04:00
Code Issues Packages Projects Releases Wiki Activity

dart generator

Browse Source
This commit is contained in:
shenlong-tanwen
2026-05-31 08:54:33 +05:30
parent da8505f61d
commit 43e0cc7392
508 changed files with 36570 additions and 52955 deletions
Download Patch File Download Diff File Expand all files Collapse all files
mobile/openapi/lib/api/libraries_api.dart
Generated
+245 -279
View File
@@ -1,52 +1,120 @@
//
// 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;
static const ApiVersion getAllLibrariesAddedIn = .new(1, 0, 0);
static const ApiState getAllLibrariesState = .stable;
static const ApiVersion createLibraryAddedIn = .new(1, 0, 0);
static const ApiState createLibraryState = .stable;
static const ApiVersion deleteLibraryAddedIn = .new(1, 0, 0);
static const ApiState deleteLibraryState = .stable;
static const ApiVersion getLibraryAddedIn = .new(1, 0, 0);
static const ApiState getLibraryState = .stable;
static const ApiVersion updateLibraryAddedIn = .new(1, 0, 0);
static const ApiState updateLibraryState = .stable;
static const ApiVersion scanLibraryAddedIn = .new(1, 0, 0);
static const ApiState scanLibraryState = .stable;
static const ApiVersion getLibraryStatisticsAddedIn = .new(1, 0, 0);
static const ApiState getLibraryStatisticsState = .stable;
static const ApiVersion validateAddedIn = .new(1, 0, 0);
static const ApiState validateState = .stable;
/// Retrieve libraries
///
/// Retrieve a list of external libraries.
///
/// Available since server v1.0.0.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getAllLibrariesWithHttpInfo({Future<void>? abortTrigger}) async {
final apiPath = r'/libraries';
Object? postBody;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>[];
return apiClient.invokeAPI(
apiPath,
r'GET',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
abortTrigger: abortTrigger,
);
}
/// Retrieve libraries
///
/// Retrieve a list of external libraries.
///
/// Available since server v1.0.0.
Future<List<LibraryResponseDto>> getAllLibraries({Future<void>? abortTrigger}) async {
final response = await getAllLibrariesWithHttpInfo(abortTrigger: abortTrigger);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
final responseBody = await _decodeBodyBytes(response);
return (await apiClient.deserializeAsync(responseBody, r'List<LibraryResponseDto>') as List)
.cast<LibraryResponseDto>()
.toList(growable: false);
}
throw ApiException(response.statusCode, r'Unexpected empty response body');
}
/// Create a library
///
/// Create a new external library.
///
/// Available since server v1.0.0.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [CreateLibraryDto] createLibraryDto (required):
Future<Response> createLibraryWithHttpInfo(CreateLibraryDto createLibraryDto,) async {
// ignore: prefer_const_declarations
Future<Response> createLibraryWithHttpInfo(CreateLibraryDto createLibraryDto, {Future<void>? abortTrigger}) async {
final apiPath = 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'];
const contentTypes = <String>[r'application/json'];
return apiClient.invokeAPI(
apiPath,
'POST',
r'POST',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
abortTrigger: abortTrigger,
);
}
@@ -54,39 +122,29 @@ class LibrariesApi {
///
/// Create a new external library.
///
/// Parameters:
///
/// * [CreateLibraryDto] createLibraryDto (required):
Future<LibraryResponseDto?> createLibrary(CreateLibraryDto createLibraryDto,) async {
final response = await createLibraryWithHttpInfo(createLibraryDto,);
/// Available since server v1.0.0.
Future<LibraryResponseDto> createLibrary(CreateLibraryDto createLibraryDto, {Future<void>? abortTrigger}) async {
final response = await createLibraryWithHttpInfo(createLibraryDto, abortTrigger: abortTrigger);
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 await apiClient.deserializeAsync(await _decodeBodyBytes(response), r'LibraryResponseDto')
as LibraryResponseDto;
}
return null;
throw ApiException(response.statusCode, r'Unexpected empty response body');
}
/// Delete a library
///
/// Delete an external library by its ID.
///
/// Available since server v1.0.0.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
Future<Response> deleteLibraryWithHttpInfo(String id,) async {
// ignore: prefer_const_declarations
final apiPath = r'/libraries/{id}'
.replaceAll('{id}', id);
Future<Response> deleteLibraryWithHttpInfo(String id, {Future<void>? abortTrigger}) async {
final apiPath = r'/libraries/{id}'.replaceAll('{id}', id);
// ignore: prefer_final_locals
Object? postBody;
final queryParams = <QueryParam>[];
@@ -95,15 +153,15 @@ class LibrariesApi {
const contentTypes = <String>[];
return apiClient.invokeAPI(
apiPath,
'DELETE',
r'DELETE',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
abortTrigger: abortTrigger,
);
}
@@ -111,82 +169,24 @@ class LibrariesApi {
///
/// Delete an external library by its ID.
///
/// Parameters:
///
/// * [String] id (required):
Future<void> deleteLibrary(String id,) async {
final response = await deleteLibraryWithHttpInfo(id,);
/// Available since server v1.0.0.
Future<void> deleteLibrary(String id, {Future<void>? abortTrigger}) async {
final response = await deleteLibraryWithHttpInfo(id, abortTrigger: abortTrigger);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
}
/// Retrieve libraries
///
/// Retrieve a list of external libraries.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getAllLibrariesWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = 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(
apiPath,
'GET',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
/// Retrieve libraries
///
/// Retrieve a list of external libraries.
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;
}
/// Retrieve a library
///
/// Retrieve an external library by its ID.
///
/// Available since server v1.0.0.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
Future<Response> getLibraryWithHttpInfo(String id,) async {
// ignore: prefer_const_declarations
final apiPath = r'/libraries/{id}'
.replaceAll('{id}', id);
Future<Response> getLibraryWithHttpInfo(String id, {Future<void>? abortTrigger}) async {
final apiPath = r'/libraries/{id}'.replaceAll('{id}', id);
// ignore: prefer_final_locals
Object? postBody;
final queryParams = <QueryParam>[];
@@ -195,15 +195,15 @@ class LibrariesApi {
const contentTypes = <String>[];
return apiClient.invokeAPI(
apiPath,
'GET',
r'GET',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
abortTrigger: abortTrigger,
);
}
@@ -211,164 +211,50 @@ class LibrariesApi {
///
/// Retrieve an external library by its ID.
///
/// Parameters:
///
/// * [String] id (required):
Future<LibraryResponseDto?> getLibrary(String id,) async {
final response = await getLibraryWithHttpInfo(id,);
/// Available since server v1.0.0.
Future<LibraryResponseDto> getLibrary(String id, {Future<void>? abortTrigger}) async {
final response = await getLibraryWithHttpInfo(id, abortTrigger: abortTrigger);
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;
}
/// Retrieve library statistics
///
/// Retrieve statistics for a specific external library, including number of videos, images, and storage usage.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
Future<Response> getLibraryStatisticsWithHttpInfo(String id,) async {
// ignore: prefer_const_declarations
final apiPath = 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(
apiPath,
'GET',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
/// Retrieve library statistics
///
/// Retrieve statistics for a specific external library, including number of videos, images, and storage usage.
///
/// 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;
}
/// Scan a library
///
/// Queue a scan for the external library to find and import new assets.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
Future<Response> scanLibraryWithHttpInfo(String id,) async {
// ignore: prefer_const_declarations
final apiPath = r'/libraries/{id}/scan'
.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,
);
}
/// Scan a library
///
/// Queue a scan for the external library to find and import new assets.
///
/// Parameters:
///
/// * [String] id (required):
Future<void> scanLibrary(String id,) async {
final response = await scanLibraryWithHttpInfo(id,);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
return await apiClient.deserializeAsync(await _decodeBodyBytes(response), r'LibraryResponseDto')
as LibraryResponseDto;
}
throw ApiException(response.statusCode, r'Unexpected empty response body');
}
/// Update a library
///
/// Update an existing external library.
///
/// Available since server v1.0.0.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
///
/// * [UpdateLibraryDto] updateLibraryDto (required):
Future<Response> updateLibraryWithHttpInfo(String id, UpdateLibraryDto updateLibraryDto,) async {
// ignore: prefer_const_declarations
final apiPath = r'/libraries/{id}'
.replaceAll('{id}', id);
Future<Response> updateLibraryWithHttpInfo(
String id,
UpdateLibraryDto updateLibraryDto, {
Future<void>? abortTrigger,
}) async {
final apiPath = 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'];
const contentTypes = <String>[r'application/json'];
return apiClient.invokeAPI(
apiPath,
'PUT',
r'PUT',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
abortTrigger: abortTrigger,
);
}
@@ -376,60 +262,143 @@ class LibrariesApi {
///
/// Update an existing external library.
///
/// Parameters:
///
/// * [String] id (required):
///
/// * [UpdateLibraryDto] updateLibraryDto (required):
Future<LibraryResponseDto?> updateLibrary(String id, UpdateLibraryDto updateLibraryDto,) async {
final response = await updateLibraryWithHttpInfo(id, updateLibraryDto,);
/// Available since server v1.0.0.
Future<LibraryResponseDto> updateLibrary(
String id,
UpdateLibraryDto updateLibraryDto, {
Future<void>? abortTrigger,
}) async {
final response = await updateLibraryWithHttpInfo(id, updateLibraryDto, abortTrigger: abortTrigger);
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 await apiClient.deserializeAsync(await _decodeBodyBytes(response), r'LibraryResponseDto')
as LibraryResponseDto;
}
return null;
throw ApiException(response.statusCode, r'Unexpected empty response body');
}
/// Scan a library
///
/// Queue a scan for the external library to find and import new assets.
///
/// Available since server v1.0.0.
///
/// Note: This method returns the HTTP [Response].
Future<Response> scanLibraryWithHttpInfo(String id, {Future<void>? abortTrigger}) async {
final apiPath = r'/libraries/{id}/scan'.replaceAll('{id}', id);
Object? postBody;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>[];
return apiClient.invokeAPI(
apiPath,
r'POST',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
abortTrigger: abortTrigger,
);
}
/// Scan a library
///
/// Queue a scan for the external library to find and import new assets.
///
/// Available since server v1.0.0.
Future<void> scanLibrary(String id, {Future<void>? abortTrigger}) async {
final response = await scanLibraryWithHttpInfo(id, abortTrigger: abortTrigger);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
}
/// Retrieve library statistics
///
/// Retrieve statistics for a specific external library, including number of videos, images, and storage usage.
///
/// Available since server v1.0.0.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getLibraryStatisticsWithHttpInfo(String id, {Future<void>? abortTrigger}) async {
final apiPath = r'/libraries/{id}/statistics'.replaceAll('{id}', id);
Object? postBody;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>[];
return apiClient.invokeAPI(
apiPath,
r'GET',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
abortTrigger: abortTrigger,
);
}
/// Retrieve library statistics
///
/// Retrieve statistics for a specific external library, including number of videos, images, and storage usage.
///
/// Available since server v1.0.0.
Future<LibraryStatsResponseDto> getLibraryStatistics(String id, {Future<void>? abortTrigger}) async {
final response = await getLibraryStatisticsWithHttpInfo(id, abortTrigger: abortTrigger);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
return await apiClient.deserializeAsync(await _decodeBodyBytes(response), r'LibraryStatsResponseDto')
as LibraryStatsResponseDto;
}
throw ApiException(response.statusCode, r'Unexpected empty response body');
}
/// Validate library settings
///
/// Validate the settings of an external library.
///
/// Available since server v1.0.0.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
///
/// * [ValidateLibraryDto] validateLibraryDto (required):
Future<Response> validateWithHttpInfo(String id, ValidateLibraryDto validateLibraryDto,) async {
// ignore: prefer_const_declarations
final apiPath = r'/libraries/{id}/validate'
.replaceAll('{id}', id);
Future<Response> validateWithHttpInfo(
String id,
ValidateLibraryDto validateLibraryDto, {
Future<void>? abortTrigger,
}) async {
final apiPath = 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'];
const contentTypes = <String>[r'application/json'];
return apiClient.invokeAPI(
apiPath,
'POST',
r'POST',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
abortTrigger: abortTrigger,
);
}
@@ -437,23 +406,20 @@ class LibrariesApi {
///
/// Validate the settings of an external library.
///
/// Parameters:
///
/// * [String] id (required):
///
/// * [ValidateLibraryDto] validateLibraryDto (required):
Future<ValidateLibraryResponseDto?> validate(String id, ValidateLibraryDto validateLibraryDto,) async {
final response = await validateWithHttpInfo(id, validateLibraryDto,);
/// Available since server v1.0.0.
Future<ValidateLibraryResponseDto> validate(
String id,
ValidateLibraryDto validateLibraryDto, {
Future<void>? abortTrigger,
}) async {
final response = await validateWithHttpInfo(id, validateLibraryDto, abortTrigger: abortTrigger);
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 await apiClient.deserializeAsync(await _decodeBodyBytes(response), r'ValidateLibraryResponseDto')
as ValidateLibraryResponseDto;
}
return null;
throw ApiException(response.statusCode, r'Unexpected empty response body');
}
}