c-l/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2024-12-29 15:11:58 +00:00
Code Releases Activity
immich/mobile/openapi
History
martabal e36b7240c7
fix: merge main
2024-05-28 00:42:52 +02:00
..
.openapi-generator chore: gitignore open api docs/tests (#9643) 2024-05-21 16:35:20 +01:00
doc merge main 2024-05-26 22:14:36 +02:00
lib fix: merge main 2024-05-28 00:42:52 +02:00
test chore: regenarate api 2024-05-26 22:15:28 +02:00
.gitignore Refactor mobile to use OpenApi generated SDK (#336) 2022-07-13 07:23:48 -05:00
.openapi-generator-ignore Refactor mobile to use OpenApi generated SDK (#336) 2022-07-13 07:23:48 -05:00
.travis.yml Refactor mobile to use OpenApi generated SDK (#336) 2022-07-13 07:23:48 -05:00
git_push.sh Refactor mobile to use OpenApi generated SDK (#336) 2022-07-13 07:23:48 -05:00
pubspec.yaml chore: bump open-api (#9522) 2024-05-15 16:52:52 -05:00
README.md fix: merge main 2024-05-28 00:42:52 +02:00

README.md

openapi

Immich API

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

  • API version: 1.105.1
  • Generator version: 7.5.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 API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// 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 = APIKeyApi();
final aPIKeyCreateDto = APIKeyCreateDto(); // APIKeyCreateDto | 

try {
    final result = api_instance.createApiKey(aPIKeyCreateDto);
    print(result);
} catch (e) {
    print('Exception when calling APIKeyApi->createApiKey: $e\n');
}

Documentation for API Endpoints

All URIs are relative to /api

Class Method HTTP request Description
APIKeyApi createApiKey POST /api-keys
APIKeyApi deleteApiKey DELETE /api-keys/{id}
APIKeyApi getApiKey GET /api-keys/{id}
APIKeyApi getApiKeys GET /api-keys
APIKeyApi updateApiKey PUT /api-keys/{id}
ActivityApi createActivity POST /activities
ActivityApi deleteActivity DELETE /activities/{id}
ActivityApi getActivities GET /activities
ActivityApi getActivityStatistics GET /activities/statistics
AlbumApi addAssetsToAlbum PUT /albums/{id}/assets
AlbumApi addUsersToAlbum PUT /albums/{id}/users
AlbumApi createAlbum POST /albums
AlbumApi deleteAlbum DELETE /albums/{id}
AlbumApi getAlbumCount GET /albums/count
AlbumApi getAlbumInfo GET /albums/{id}
AlbumApi getAllAlbums GET /albums
AlbumApi removeAssetFromAlbum DELETE /albums/{id}/assets
AlbumApi removeUserFromAlbum DELETE /albums/{id}/user/{userId}
AlbumApi updateAlbumInfo PATCH /albums/{id}
AlbumApi updateAlbumUser PUT /albums/{id}/user/{userId}
AssetApi checkBulkUpload POST /asset/bulk-upload-check
AssetApi checkExistingAssets POST /asset/exist
AssetApi deleteAssets DELETE /asset
AssetApi getAllUserAssetsByDeviceId GET /asset/device/{deviceId}
AssetApi getAssetInfo GET /asset/{id}
AssetApi getAssetStatistics GET /asset/statistics
AssetApi getAssetThumbnail GET /asset/thumbnail/{id}
AssetApi getMapMarkers GET /asset/map-marker
AssetApi getMemoryLane GET /asset/memory-lane
AssetApi getRandom GET /asset/random
AssetApi replaceAsset PUT /asset/{id}/file
AssetApi runAssetJobs POST /asset/jobs
AssetApi serveFile GET /asset/file/{id}
AssetApi updateAsset PUT /asset/{id}
AssetApi updateAssets PUT /asset
AssetApi updateStackParent PUT /asset/stack/parent
AssetApi uploadFile POST /asset/upload
AuditApi getAuditDeletes GET /audit/deletes
AuthenticationApi changePassword POST /auth/change-password
AuthenticationApi login POST /auth/login
AuthenticationApi logout POST /auth/logout
AuthenticationApi signUpAdmin POST /auth/admin-sign-up
AuthenticationApi validateAccessToken POST /auth/validateToken
DownloadApi downloadArchive POST /download/archive
DownloadApi downloadFile POST /download/asset/{id}
DownloadApi getDownloadInfo POST /download/info
DuplicateApi getAssetDuplicates GET /duplicates
FaceApi getFaces GET /faces
FaceApi reassignFacesById PUT /faces/{id}
FaceApi unassignFace DELETE /faces/{id}
FileReportApi fixAuditFiles POST /reports/fix
FileReportApi getAuditFiles GET /reports
FileReportApi getFileChecksums POST /reports/checksum
JobApi getAllJobsStatus GET /jobs
JobApi sendJobCommand PUT /jobs/{id}
LibraryApi createLibrary POST /libraries
LibraryApi deleteLibrary DELETE /libraries/{id}
LibraryApi getAllLibraries GET /libraries
LibraryApi getLibrary GET /libraries/{id}
LibraryApi getLibraryStatistics GET /libraries/{id}/statistics
LibraryApi removeOfflineFiles POST /libraries/{id}/removeOffline
LibraryApi scanLibrary POST /libraries/{id}/scan
LibraryApi updateLibrary PUT /libraries/{id}
LibraryApi validate POST /libraries/{id}/validate
MemoryApi addMemoryAssets PUT /memories/{id}/assets
MemoryApi createMemory POST /memories
MemoryApi deleteMemory DELETE /memories/{id}
MemoryApi getMemory GET /memories/{id}
MemoryApi removeMemoryAssets DELETE /memories/{id}/assets
MemoryApi searchMemories GET /memories
MemoryApi updateMemory PUT /memories/{id}
OAuthApi finishOAuth POST /oauth/callback
OAuthApi linkOAuthAccount POST /oauth/link
OAuthApi redirectOAuthToMobile GET /oauth/mobile-redirect
OAuthApi startOAuth POST /oauth/authorize
OAuthApi unlinkOAuthAccount POST /oauth/unlink
PartnerApi createPartner POST /partners/{id}
PartnerApi getPartners GET /partners
PartnerApi removePartner DELETE /partners/{id}
PartnerApi updatePartner PUT /partners/{id}
PersonApi createPerson POST /people
PersonApi getAllPeople GET /people
PersonApi getPerson GET /people/{id}
PersonApi getPersonAssets GET /people/{id}/assets
PersonApi getPersonStatistics GET /people/{id}/statistics
PersonApi getPersonThumbnail GET /people/{id}/thumbnail
PersonApi mergePerson POST /people/{id}/merge
PersonApi reassignFaces PUT /people/{id}/reassign
PersonApi unassignFaces DELETE /people
PersonApi updatePeople PUT /people
PersonApi updatePerson PUT /people/{id}
SearchApi getAssetsByCity GET /search/cities
SearchApi getExploreData GET /search/explore
SearchApi getSearchSuggestions GET /search/suggestions
SearchApi searchMetadata POST /search/metadata
SearchApi searchPerson GET /search/person
SearchApi searchPlaces GET /search/places
SearchApi searchSmart POST /search/smart
ServerInfoApi getServerConfig GET /server-info/config
ServerInfoApi getServerFeatures GET /server-info/features
ServerInfoApi getServerStatistics GET /server-info/statistics
ServerInfoApi getServerVersion GET /server-info/version
ServerInfoApi getStorage GET /server-info/storage
ServerInfoApi getSupportedMediaTypes GET /server-info/media-types
ServerInfoApi getTheme GET /server-info/theme
ServerInfoApi pingServer GET /server-info/ping
SessionsApi deleteAllSessions DELETE /sessions
SessionsApi deleteSession DELETE /sessions/{id}
SessionsApi getSessions GET /sessions
SharedLinkApi addSharedLinkAssets PUT /shared-links/{id}/assets
SharedLinkApi createSharedLink POST /shared-links
SharedLinkApi getAllSharedLinks GET /shared-links
SharedLinkApi getMySharedLink GET /shared-links/me
SharedLinkApi getSharedLinkById GET /shared-links/{id}
SharedLinkApi removeSharedLink DELETE /shared-links/{id}
SharedLinkApi removeSharedLinkAssets DELETE /shared-links/{id}/assets
SharedLinkApi updateSharedLink PATCH /shared-links/{id}
SyncApi getDeltaSync POST /sync/delta-sync
SyncApi getFullSyncForUser POST /sync/full-sync
SystemConfigApi getConfig GET /system-config
SystemConfigApi getConfigDefaults GET /system-config/defaults
SystemConfigApi getMapStyle GET /system-config/map/style.json
SystemConfigApi getStorageTemplateOptions GET /system-config/storage-template-options
SystemConfigApi updateConfig PUT /system-config
SystemMetadataApi getAdminOnboarding GET /system-metadata/admin-onboarding
SystemMetadataApi getReverseGeocodingState GET /system-metadata/reverse-geocoding-state
SystemMetadataApi updateAdminOnboarding POST /system-metadata/admin-onboarding
TagApi createTag POST /tags
TagApi deleteTag DELETE /tags/{id}
TagApi getAllTags GET /tags
TagApi getTagAssets GET /tags/{id}/assets
TagApi getTagById GET /tags/{id}
TagApi tagAssets PUT /tags/{id}/assets
TagApi untagAssets DELETE /tags/{id}/assets
TagApi updateTag PATCH /tags/{id}
TimelineApi getTimeBucket GET /timeline/bucket
TimelineApi getTimeBuckets GET /timeline/buckets
TrashApi emptyTrash POST /trash/empty
TrashApi restoreAssets POST /trash/restore/assets
TrashApi restoreTrash POST /trash/restore
UserApi createProfileImage POST /users/profile-image
UserApi createUserAdmin POST /admin/users
UserApi deleteProfileImage DELETE /users/profile-image
UserApi deleteUserAdmin DELETE /admin/users/{id}
UserApi getMyUser GET /users/me
UserApi getProfileImage GET /users/{id}/profile-image
UserApi getUser GET /users/{id}
UserApi getUserAdmin GET /admin/users/{id}
UserApi restoreUserAdmin POST /admin/users/{id}/restore
UserApi searchUsers GET /users
UserApi searchUsersAdmin GET /admin/users
UserApi updateMyUser PUT /users/me
UserApi updateUserAdmin PUT /admin/users/{id}

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearer

  • Type: HTTP Bearer authentication

cookie

  • Type: API key
  • API key parameter name: immich_access_token
  • Location:

api_key

  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header

Author