immich/mobile/openapi/README.md

openapi

Immich API

This Dart package is automatically generated by the OpenAPI Generator project:

• API version: 1.17.0
• Build package: org.openapitools.codegen.languages.DartClientCodegen

Requirements

Dart 2.12 or later

Installation & Usage

Github

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  openapi:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git

Local

To use the package in your local drive, add the following dependency to your pubspec.yaml

dependencies:
  openapi:
    path: /path/to/openapi

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:openapi/api.dart';

// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);

final api_instance = AlbumApi();
final albumId = albumId_example; // String | 
final addAssetsDto = AddAssetsDto(); // AddAssetsDto | 

try {
    final result = api_instance.addAssetsToAlbum(albumId, addAssetsDto);
    print(result);
} catch (e) {
    print('Exception when calling AlbumApi->addAssetsToAlbum: $e\n');
}

Documentation for API Endpoints

All URIs are relative to /api

Class	Method	HTTP request	Description
AlbumApi	addAssetsToAlbum	PUT /album/{albumId}/assets
AlbumApi	addUsersToAlbum	PUT /album/{albumId}/users
AlbumApi	createAlbum	POST /album
AlbumApi	deleteAlbum	DELETE /album/{albumId}
AlbumApi	getAlbumCountByUserId	GET /album/count-by-user-id
AlbumApi	getAlbumInfo	GET /album/{albumId}
AlbumApi	getAllAlbums	GET /album
AlbumApi	removeAssetFromAlbum	DELETE /album/{albumId}/assets
AlbumApi	removeUserFromAlbum	DELETE /album/{albumId}/user/{userId}
AlbumApi	updateAlbumInfo	PATCH /album/{albumId}
AssetApi	checkDuplicateAsset	POST /asset/check
AssetApi	deleteAsset	DELETE /asset
AssetApi	downloadFile	GET /asset/download
AssetApi	getAllAssets	GET /asset
AssetApi	getAssetById	GET /asset/assetById/{assetId}
AssetApi	getAssetByTimeBucket	POST /asset/time-bucket
AssetApi	getAssetCountByTimeBucket	POST /asset/count-by-time-bucket
AssetApi	getAssetCountByUserId	GET /asset/count-by-user-id
AssetApi	getAssetSearchTerms	GET /asset/search-terms
AssetApi	getAssetThumbnail	GET /asset/thumbnail/{assetId}
AssetApi	getCuratedLocations	GET /asset/curated-locations
AssetApi	getCuratedObjects	GET /asset/curated-objects
AssetApi	getUserAssetsByDeviceId	GET /asset/{deviceId}
AssetApi	searchAsset	POST /asset/search
AssetApi	serveFile	GET /asset/file
AssetApi	uploadFile	POST /asset/upload
AuthenticationApi	adminSignUp	POST /auth/admin-sign-up
AuthenticationApi	login	POST /auth/login
AuthenticationApi	logout	POST /auth/logout
AuthenticationApi	validateAccessToken	POST /auth/validateToken
DeviceInfoApi	createDeviceInfo	POST /device-info
DeviceInfoApi	updateDeviceInfo	PATCH /device-info
ServerInfoApi	getServerInfo	GET /server-info
ServerInfoApi	getServerVersion	GET /server-info/version
ServerInfoApi	pingServer	GET /server-info/ping
UserApi	createProfileImage	POST /user/profile-image
UserApi	createUser	POST /user
UserApi	getAllUsers	GET /user
UserApi	getMyUserInfo	GET /user/me
UserApi	getProfileImage	GET /user/profile-image/{userId}
UserApi	getUserById	GET /user/info/{userId}
UserApi	getUserCount	GET /user/count
UserApi	updateUser	PUT /user

Documentation For Models

• AddAssetsDto
• AddUsersDto
• AdminSignupResponseDto
• AlbumCountResponseDto
• AlbumResponseDto
• AssetCountByTimeBucket
• AssetCountByTimeBucketResponseDto
• AssetCountByUserIdResponseDto
• AssetFileUploadResponseDto
• AssetResponseDto
• AssetTypeEnum
• CheckDuplicateAssetDto
• CheckDuplicateAssetResponseDto
• CreateAlbumDto
• CreateDeviceInfoDto
• CreateProfileImageResponseDto
• CreateUserDto
• CuratedLocationsResponseDto
• CuratedObjectsResponseDto
• DeleteAssetDto
• DeleteAssetResponseDto
• DeleteAssetStatus
• DeviceInfoResponseDto
• DeviceTypeEnum
• ExifResponseDto
• GetAssetByTimeBucketDto
• GetAssetCountByTimeBucketDto
• LoginCredentialDto
• LoginResponseDto
• LogoutResponseDto
• RemoveAssetsDto
• SearchAssetDto
• ServerInfoResponseDto
• ServerPingResponse
• ServerVersionReponseDto
• SignUpDto
• SmartInfoResponseDto
• ThumbnailFormat
• TimeGroupEnum
• UpdateAlbumDto
• UpdateDeviceInfoDto
• UpdateUserDto
• UserCountResponseDto
• UserResponseDto
• ValidateAccessTokenResponseDto

Documentation For Authorization

bearer

• Type: HTTP Bearer authentication

Author