immortaly007/immich-to-cloud-exporter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
86ad92e1aa652a241ec99c2b76af9b40568fe7e9
immich-to-cloud-exporter/generated/immich/openapi_client_README.md

48 KiB
Raw Blame History

generated.immich.openapi-client

Immich API

The generated.immich.openapi_client package is automatically generated by the OpenAPI Generator project:

  • API version: 1.131.3
  • Package version: 1.0.0
  • Generator version: 7.13.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.8+

Installation & Usage

This python library package is generated without supporting files like setup.py or requirements files

To be able to use it, you will need these dependencies in your own package that uses this library:

  • urllib3 >= 1.25.3, < 3.0.0
  • python-dateutil >= 2.8.2
  • pydantic >= 2
  • typing-extensions >= 4.7.1

Getting Started

In your own code, to use this library to connect and interact with generated.immich.openapi-client, you can run the following:


import generated.immich.openapi_client
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
    host = "https://github.com/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'

# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = generated.immich.openapi_client.APIKeysApi(api_client)
    api_key_create_dto = generated.immich.openapi_client.APIKeyCreateDto() # APIKeyCreateDto | 

    try:
        api_response = api_instance.create_api_key(api_key_create_dto)
        print("The response of APIKeysApi->create_api_key:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling APIKeysApi->create_api_key: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://github.com/api

Class Method HTTP request Description
APIKeysApi create_api_key POST /api-keys
APIKeysApi delete_api_key DELETE /api-keys/{id}
APIKeysApi get_api_key GET /api-keys/{id}
APIKeysApi get_api_keys GET /api-keys
APIKeysApi update_api_key PUT /api-keys/{id}
ActivitiesApi create_activity POST /activities
ActivitiesApi delete_activity DELETE /activities/{id}
ActivitiesApi get_activities GET /activities
ActivitiesApi get_activity_statistics GET /activities/statistics
AlbumsApi add_assets_to_album PUT /albums/{id}/assets
AlbumsApi add_users_to_album PUT /albums/{id}/users
AlbumsApi create_album POST /albums
AlbumsApi delete_album DELETE /albums/{id}
AlbumsApi get_album_info GET /albums/{id}
AlbumsApi get_album_statistics GET /albums/statistics
AlbumsApi get_all_albums GET /albums
AlbumsApi remove_asset_from_album DELETE /albums/{id}/assets
AlbumsApi remove_user_from_album DELETE /albums/{id}/user/{userId}
AlbumsApi update_album_info PATCH /albums/{id}
AlbumsApi update_album_user PUT /albums/{id}/user/{userId}
AssetsApi check_bulk_upload POST /assets/bulk-upload-check checkBulkUpload
AssetsApi check_existing_assets POST /assets/exist checkExistingAssets
AssetsApi delete_assets DELETE /assets
AssetsApi download_asset GET /assets/{id}/original
AssetsApi get_all_user_assets_by_device_id GET /assets/device/{deviceId} getAllUserAssetsByDeviceId
AssetsApi get_asset_info GET /assets/{id}
AssetsApi get_asset_statistics GET /assets/statistics
AssetsApi get_memory_lane GET /assets/memory-lane
AssetsApi get_random GET /assets/random
AssetsApi play_asset_video GET /assets/{id}/video/playback
AssetsApi replace_asset PUT /assets/{id}/original replaceAsset
AssetsApi run_asset_jobs POST /assets/jobs
AssetsApi update_asset PUT /assets/{id}
AssetsApi update_assets PUT /assets
AssetsApi upload_asset POST /assets
AssetsApi view_asset GET /assets/{id}/thumbnail
AuthenticationApi change_password POST /auth/change-password
AuthenticationApi login POST /auth/login
AuthenticationApi logout POST /auth/logout
AuthenticationApi sign_up_admin POST /auth/admin-sign-up
AuthenticationApi validate_access_token POST /auth/validateToken
DeprecatedApi get_random GET /assets/random
DownloadApi download_archive POST /download/archive
DownloadApi get_download_info POST /download/info
DuplicatesApi get_asset_duplicates GET /duplicates
FacesApi create_face POST /faces
FacesApi delete_face DELETE /faces/{id}
FacesApi get_faces GET /faces
FacesApi reassign_faces_by_id PUT /faces/{id}
FileReportsApi fix_audit_files POST /reports/fix
FileReportsApi get_audit_files GET /reports
FileReportsApi get_file_checksums POST /reports/checksum
JobsApi create_job POST /jobs
JobsApi get_all_jobs_status GET /jobs
JobsApi send_job_command PUT /jobs/{id}
LibrariesApi create_library POST /libraries
LibrariesApi delete_library DELETE /libraries/{id}
LibrariesApi get_all_libraries GET /libraries
LibrariesApi get_library GET /libraries/{id}
LibrariesApi get_library_statistics GET /libraries/{id}/statistics
LibrariesApi scan_library POST /libraries/{id}/scan
LibrariesApi update_library PUT /libraries/{id}
LibrariesApi validate POST /libraries/{id}/validate
MapApi get_map_markers GET /map/markers
MapApi reverse_geocode GET /map/reverse-geocode
MemoriesApi add_memory_assets PUT /memories/{id}/assets
MemoriesApi create_memory POST /memories
MemoriesApi delete_memory DELETE /memories/{id}
MemoriesApi get_memory GET /memories/{id}
MemoriesApi remove_memory_assets DELETE /memories/{id}/assets
MemoriesApi search_memories GET /memories
MemoriesApi update_memory PUT /memories/{id}
NotificationsApi get_notification_template POST /notifications/templates/{name}
NotificationsApi send_test_email POST /notifications/test-email
OAuthApi finish_o_auth POST /oauth/callback
OAuthApi link_o_auth_account POST /oauth/link
OAuthApi redirect_o_auth_to_mobile GET /oauth/mobile-redirect
OAuthApi start_o_auth POST /oauth/authorize
OAuthApi unlink_o_auth_account POST /oauth/unlink
PartnersApi create_partner POST /partners/{id}
PartnersApi get_partners GET /partners
PartnersApi remove_partner DELETE /partners/{id}
PartnersApi update_partner PUT /partners/{id}
PeopleApi create_person POST /people
PeopleApi get_all_people GET /people
PeopleApi get_person GET /people/{id}
PeopleApi get_person_statistics GET /people/{id}/statistics
PeopleApi get_person_thumbnail GET /people/{id}/thumbnail
PeopleApi merge_person POST /people/{id}/merge
PeopleApi reassign_faces PUT /people/{id}/reassign
PeopleApi update_people PUT /people
PeopleApi update_person PUT /people/{id}
SearchApi get_assets_by_city GET /search/cities
SearchApi get_explore_data GET /search/explore
SearchApi get_search_suggestions GET /search/suggestions
SearchApi search_assets POST /search/metadata
SearchApi search_person GET /search/person
SearchApi search_places GET /search/places
SearchApi search_random POST /search/random
SearchApi search_smart POST /search/smart
ServerApi delete_server_license DELETE /server/license
ServerApi get_about_info GET /server/about
ServerApi get_server_config GET /server/config
ServerApi get_server_features GET /server/features
ServerApi get_server_license GET /server/license
ServerApi get_server_statistics GET /server/statistics
ServerApi get_server_version GET /server/version
ServerApi get_storage GET /server/storage
ServerApi get_supported_media_types GET /server/media-types
ServerApi get_theme GET /server/theme
ServerApi get_version_history GET /server/version-history
ServerApi ping_server GET /server/ping
ServerApi set_server_license PUT /server/license
SessionsApi delete_all_sessions DELETE /sessions
SessionsApi delete_session DELETE /sessions/{id}
SessionsApi get_sessions GET /sessions
SharedLinksApi add_shared_link_assets PUT /shared-links/{id}/assets
SharedLinksApi create_shared_link POST /shared-links
SharedLinksApi get_all_shared_links GET /shared-links
SharedLinksApi get_my_shared_link GET /shared-links/me
SharedLinksApi get_shared_link_by_id GET /shared-links/{id}
SharedLinksApi remove_shared_link DELETE /shared-links/{id}
SharedLinksApi remove_shared_link_assets DELETE /shared-links/{id}/assets
SharedLinksApi update_shared_link PATCH /shared-links/{id}
StacksApi create_stack POST /stacks
StacksApi delete_stack DELETE /stacks/{id}
StacksApi delete_stacks DELETE /stacks
StacksApi get_stack GET /stacks/{id}
StacksApi search_stacks GET /stacks
StacksApi update_stack PUT /stacks/{id}
SyncApi delete_sync_ack DELETE /sync/ack
SyncApi get_delta_sync POST /sync/delta-sync
SyncApi get_full_sync_for_user POST /sync/full-sync
SyncApi get_sync_ack GET /sync/ack
SyncApi get_sync_stream POST /sync/stream
SyncApi send_sync_ack POST /sync/ack
SystemConfigApi get_config GET /system-config
SystemConfigApi get_config_defaults GET /system-config/defaults
SystemConfigApi get_storage_template_options GET /system-config/storage-template-options
SystemConfigApi update_config PUT /system-config
SystemMetadataApi get_admin_onboarding GET /system-metadata/admin-onboarding
SystemMetadataApi get_reverse_geocoding_state GET /system-metadata/reverse-geocoding-state
SystemMetadataApi update_admin_onboarding POST /system-metadata/admin-onboarding
TagsApi bulk_tag_assets PUT /tags/assets
TagsApi create_tag POST /tags
TagsApi delete_tag DELETE /tags/{id}
TagsApi get_all_tags GET /tags
TagsApi get_tag_by_id GET /tags/{id}
TagsApi tag_assets PUT /tags/{id}/assets
TagsApi untag_assets DELETE /tags/{id}/assets
TagsApi update_tag PUT /tags/{id}
TagsApi upsert_tags PUT /tags
TimelineApi get_time_bucket GET /timeline/bucket
TimelineApi get_time_buckets GET /timeline/buckets
TrashApi empty_trash POST /trash/empty
TrashApi restore_assets POST /trash/restore/assets
TrashApi restore_trash POST /trash/restore
UsersApi create_profile_image POST /users/profile-image
UsersApi delete_profile_image DELETE /users/profile-image
UsersApi delete_user_license DELETE /users/me/license
UsersApi get_my_preferences GET /users/me/preferences
UsersApi get_my_user GET /users/me
UsersApi get_profile_image GET /users/{id}/profile-image
UsersApi get_user GET /users/{id}
UsersApi get_user_license GET /users/me/license
UsersApi search_users GET /users
UsersApi set_user_license PUT /users/me/license
UsersApi update_my_preferences PUT /users/me/preferences
UsersApi update_my_user PUT /users/me
UsersAdminApi create_user_admin POST /admin/users
UsersAdminApi delete_user_admin DELETE /admin/users/{id}
UsersAdminApi get_user_admin GET /admin/users/{id}
UsersAdminApi get_user_preferences_admin GET /admin/users/{id}/preferences
UsersAdminApi restore_user_admin POST /admin/users/{id}/restore
UsersAdminApi search_users_admin GET /admin/users
UsersAdminApi update_user_admin PUT /admin/users/{id}
UsersAdminApi update_user_preferences_admin PUT /admin/users/{id}/preferences
ViewApi get_assets_by_original_path GET /view/folder
ViewApi get_unique_original_paths GET /view/folder/unique-paths

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearer

  • Type: Bearer authentication (JWT)

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

Reference in New Issue View Git Blame Copy Permalink