UNPKG

immich-sdk

Version:
2,704 lines 184 kB
/** * Immich * Immich API * * The version of the OpenAPI document: 1.62.1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { Configuration } from './configuration'; import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; import { RequestArgs, BaseAPI } from './base'; /** * * @export * @interface APIKeyCreateDto */ export interface APIKeyCreateDto { /** * * @type {string} * @memberof APIKeyCreateDto */ 'name'?: string; } /** * * @export * @interface APIKeyCreateResponseDto */ export interface APIKeyCreateResponseDto { /** * * @type {string} * @memberof APIKeyCreateResponseDto */ 'secret': string; /** * * @type {APIKeyResponseDto} * @memberof APIKeyCreateResponseDto */ 'apiKey': APIKeyResponseDto; } /** * * @export * @interface APIKeyResponseDto */ export interface APIKeyResponseDto { /** * * @type {string} * @memberof APIKeyResponseDto */ 'id': string; /** * * @type {string} * @memberof APIKeyResponseDto */ 'name': string; /** * * @type {string} * @memberof APIKeyResponseDto */ 'createdAt': string; /** * * @type {string} * @memberof APIKeyResponseDto */ 'updatedAt': string; } /** * * @export * @interface APIKeyUpdateDto */ export interface APIKeyUpdateDto { /** * * @type {string} * @memberof APIKeyUpdateDto */ 'name': string; } /** * * @export * @interface AddAssetsDto */ export interface AddAssetsDto { /** * * @type {Array<string>} * @memberof AddAssetsDto */ 'assetIds': Array<string>; } /** * * @export * @interface AddAssetsResponseDto */ export interface AddAssetsResponseDto { /** * * @type {number} * @memberof AddAssetsResponseDto */ 'successfullyAdded': number; /** * * @type {Array<string>} * @memberof AddAssetsResponseDto */ 'alreadyInAlbum': Array<string>; /** * * @type {AlbumResponseDto} * @memberof AddAssetsResponseDto */ 'album'?: AlbumResponseDto; } /** * * @export * @interface AddUsersDto */ export interface AddUsersDto { /** * * @type {Array<string>} * @memberof AddUsersDto */ 'sharedUserIds': Array<string>; } /** * * @export * @interface AdminSignupResponseDto */ export interface AdminSignupResponseDto { /** * * @type {string} * @memberof AdminSignupResponseDto */ 'id': string; /** * * @type {string} * @memberof AdminSignupResponseDto */ 'email': string; /** * * @type {string} * @memberof AdminSignupResponseDto */ 'firstName': string; /** * * @type {string} * @memberof AdminSignupResponseDto */ 'lastName': string; /** * * @type {string} * @memberof AdminSignupResponseDto */ 'createdAt': string; } /** * * @export * @interface AlbumCountResponseDto */ export interface AlbumCountResponseDto { /** * * @type {number} * @memberof AlbumCountResponseDto */ 'owned': number; /** * * @type {number} * @memberof AlbumCountResponseDto */ 'shared': number; /** * * @type {number} * @memberof AlbumCountResponseDto */ 'notShared': number; } /** * * @export * @interface AlbumResponseDto */ export interface AlbumResponseDto { /** * * @type {number} * @memberof AlbumResponseDto */ 'assetCount': number; /** * * @type {string} * @memberof AlbumResponseDto */ 'id': string; /** * * @type {string} * @memberof AlbumResponseDto */ 'ownerId': string; /** * * @type {string} * @memberof AlbumResponseDto */ 'albumName': string; /** * * @type {string} * @memberof AlbumResponseDto */ 'createdAt': string; /** * * @type {string} * @memberof AlbumResponseDto */ 'updatedAt': string; /** * * @type {string} * @memberof AlbumResponseDto */ 'albumThumbnailAssetId': string | null; /** * * @type {boolean} * @memberof AlbumResponseDto */ 'shared': boolean; /** * * @type {Array<UserResponseDto>} * @memberof AlbumResponseDto */ 'sharedUsers': Array<UserResponseDto>; /** * * @type {Array<AssetResponseDto>} * @memberof AlbumResponseDto */ 'assets': Array<AssetResponseDto>; /** * * @type {UserResponseDto} * @memberof AlbumResponseDto */ 'owner': UserResponseDto; } /** * * @export * @interface AllJobStatusResponseDto */ export interface AllJobStatusResponseDto { /** * * @type {JobStatusDto} * @memberof AllJobStatusResponseDto */ 'thumbnailGeneration': JobStatusDto; /** * * @type {JobStatusDto} * @memberof AllJobStatusResponseDto */ 'metadataExtraction': JobStatusDto; /** * * @type {JobStatusDto} * @memberof AllJobStatusResponseDto */ 'videoConversion': JobStatusDto; /** * * @type {JobStatusDto} * @memberof AllJobStatusResponseDto */ 'objectTagging': JobStatusDto; /** * * @type {JobStatusDto} * @memberof AllJobStatusResponseDto */ 'clipEncoding': JobStatusDto; /** * * @type {JobStatusDto} * @memberof AllJobStatusResponseDto */ 'storageTemplateMigration': JobStatusDto; /** * * @type {JobStatusDto} * @memberof AllJobStatusResponseDto */ 'backgroundTask': JobStatusDto; /** * * @type {JobStatusDto} * @memberof AllJobStatusResponseDto */ 'search': JobStatusDto; /** * * @type {JobStatusDto} * @memberof AllJobStatusResponseDto */ 'recognizeFaces': JobStatusDto; /** * * @type {JobStatusDto} * @memberof AllJobStatusResponseDto */ 'sidecar': JobStatusDto; } /** * * @export * @interface AssetBulkUploadCheckDto */ export interface AssetBulkUploadCheckDto { /** * * @type {Array<AssetBulkUploadCheckItem>} * @memberof AssetBulkUploadCheckDto */ 'assets': Array<AssetBulkUploadCheckItem>; } /** * * @export * @interface AssetBulkUploadCheckItem */ export interface AssetBulkUploadCheckItem { /** * * @type {string} * @memberof AssetBulkUploadCheckItem */ 'id': string; /** * base64 or hex encoded sha1 hash * @type {string} * @memberof AssetBulkUploadCheckItem */ 'checksum': string; } /** * * @export * @interface AssetBulkUploadCheckResponseDto */ export interface AssetBulkUploadCheckResponseDto { /** * * @type {Array<AssetBulkUploadCheckResult>} * @memberof AssetBulkUploadCheckResponseDto */ 'results': Array<AssetBulkUploadCheckResult>; } /** * * @export * @interface AssetBulkUploadCheckResult */ export interface AssetBulkUploadCheckResult { /** * * @type {string} * @memberof AssetBulkUploadCheckResult */ 'id': string; /** * * @type {string} * @memberof AssetBulkUploadCheckResult */ 'action': AssetBulkUploadCheckResultActionEnum; /** * * @type {string} * @memberof AssetBulkUploadCheckResult */ 'reason'?: AssetBulkUploadCheckResultReasonEnum; /** * * @type {string} * @memberof AssetBulkUploadCheckResult */ 'assetId'?: string; } export declare const AssetBulkUploadCheckResultActionEnum: { readonly Accept: "accept"; readonly Reject: "reject"; }; export declare type AssetBulkUploadCheckResultActionEnum = typeof AssetBulkUploadCheckResultActionEnum[keyof typeof AssetBulkUploadCheckResultActionEnum]; export declare const AssetBulkUploadCheckResultReasonEnum: { readonly Duplicate: "duplicate"; readonly UnsupportedFormat: "unsupported-format"; }; export declare type AssetBulkUploadCheckResultReasonEnum = typeof AssetBulkUploadCheckResultReasonEnum[keyof typeof AssetBulkUploadCheckResultReasonEnum]; /** * * @export * @interface AssetCountByTimeBucket */ export interface AssetCountByTimeBucket { /** * * @type {string} * @memberof AssetCountByTimeBucket */ 'timeBucket': string; /** * * @type {number} * @memberof AssetCountByTimeBucket */ 'count': number; } /** * * @export * @interface AssetCountByTimeBucketResponseDto */ export interface AssetCountByTimeBucketResponseDto { /** * * @type {number} * @memberof AssetCountByTimeBucketResponseDto */ 'totalCount': number; /** * * @type {Array<AssetCountByTimeBucket>} * @memberof AssetCountByTimeBucketResponseDto */ 'buckets': Array<AssetCountByTimeBucket>; } /** * * @export * @interface AssetCountByUserIdResponseDto */ export interface AssetCountByUserIdResponseDto { /** * * @type {number} * @memberof AssetCountByUserIdResponseDto */ 'audio': number; /** * * @type {number} * @memberof AssetCountByUserIdResponseDto */ 'photos': number; /** * * @type {number} * @memberof AssetCountByUserIdResponseDto */ 'videos': number; /** * * @type {number} * @memberof AssetCountByUserIdResponseDto */ 'other': number; /** * * @type {number} * @memberof AssetCountByUserIdResponseDto */ 'total': number; } /** * * @export * @interface AssetFileUploadResponseDto */ export interface AssetFileUploadResponseDto { /** * * @type {string} * @memberof AssetFileUploadResponseDto */ 'id': string; /** * * @type {boolean} * @memberof AssetFileUploadResponseDto */ 'duplicate': boolean; } /** * * @export * @interface AssetIdsDto */ export interface AssetIdsDto { /** * * @type {Array<string>} * @memberof AssetIdsDto */ 'assetIds': Array<string>; } /** * * @export * @interface AssetIdsResponseDto */ export interface AssetIdsResponseDto { /** * * @type {string} * @memberof AssetIdsResponseDto */ 'assetId': string; /** * * @type {boolean} * @memberof AssetIdsResponseDto */ 'success': boolean; /** * * @type {string} * @memberof AssetIdsResponseDto */ 'error'?: AssetIdsResponseDtoErrorEnum; } export declare const AssetIdsResponseDtoErrorEnum: { readonly Duplicate: "duplicate"; readonly NoPermission: "no_permission"; readonly NotFound: "not_found"; }; export declare type AssetIdsResponseDtoErrorEnum = typeof AssetIdsResponseDtoErrorEnum[keyof typeof AssetIdsResponseDtoErrorEnum]; /** * * @export * @interface AssetResponseDto */ export interface AssetResponseDto { /** * * @type {AssetTypeEnum} * @memberof AssetResponseDto */ 'type': AssetTypeEnum; /** * * @type {string} * @memberof AssetResponseDto */ 'id': string; /** * * @type {string} * @memberof AssetResponseDto */ 'deviceAssetId': string; /** * * @type {string} * @memberof AssetResponseDto */ 'ownerId': string; /** * * @type {string} * @memberof AssetResponseDto */ 'deviceId': string; /** * * @type {string} * @memberof AssetResponseDto */ 'originalPath': string; /** * * @type {string} * @memberof AssetResponseDto */ 'originalFileName': string; /** * * @type {boolean} * @memberof AssetResponseDto */ 'resized': boolean; /** * base64 encoded thumbhash * @type {string} * @memberof AssetResponseDto */ 'thumbhash': string | null; /** * * @type {string} * @memberof AssetResponseDto */ 'fileCreatedAt': string; /** * * @type {string} * @memberof AssetResponseDto */ 'fileModifiedAt': string; /** * * @type {string} * @memberof AssetResponseDto */ 'updatedAt': string; /** * * @type {boolean} * @memberof AssetResponseDto */ 'isFavorite': boolean; /** * * @type {boolean} * @memberof AssetResponseDto */ 'isArchived': boolean; /** * * @type {string} * @memberof AssetResponseDto */ 'mimeType': string | null; /** * * @type {string} * @memberof AssetResponseDto */ 'duration': string; /** * * @type {ExifResponseDto} * @memberof AssetResponseDto */ 'exifInfo'?: ExifResponseDto; /** * * @type {SmartInfoResponseDto} * @memberof AssetResponseDto */ 'smartInfo'?: SmartInfoResponseDto; /** * * @type {string} * @memberof AssetResponseDto */ 'livePhotoVideoId'?: string | null; /** * * @type {Array<TagResponseDto>} * @memberof AssetResponseDto */ 'tags'?: Array<TagResponseDto>; /** * * @type {Array<PersonResponseDto>} * @memberof AssetResponseDto */ 'people'?: Array<PersonResponseDto>; /** * base64 encoded sha1 hash * @type {string} * @memberof AssetResponseDto */ 'checksum': string; } /** * * @export * @enum {string} */ export declare const AssetTypeEnum: { readonly Image: "IMAGE"; readonly Video: "VIDEO"; readonly Audio: "AUDIO"; readonly Other: "OTHER"; }; export declare type AssetTypeEnum = typeof AssetTypeEnum[keyof typeof AssetTypeEnum]; /** * * @export * @interface AuthDeviceResponseDto */ export interface AuthDeviceResponseDto { /** * * @type {string} * @memberof AuthDeviceResponseDto */ 'id': string; /** * * @type {string} * @memberof AuthDeviceResponseDto */ 'createdAt': string; /** * * @type {string} * @memberof AuthDeviceResponseDto */ 'updatedAt': string; /** * * @type {boolean} * @memberof AuthDeviceResponseDto */ 'current': boolean; /** * * @type {string} * @memberof AuthDeviceResponseDto */ 'deviceType': string; /** * * @type {string} * @memberof AuthDeviceResponseDto */ 'deviceOS': string; } /** * * @export * @interface ChangePasswordDto */ export interface ChangePasswordDto { /** * * @type {string} * @memberof ChangePasswordDto */ 'password': string; /** * * @type {string} * @memberof ChangePasswordDto */ 'newPassword': string; } /** * * @export * @interface CheckDuplicateAssetDto */ export interface CheckDuplicateAssetDto { /** * * @type {string} * @memberof CheckDuplicateAssetDto */ 'deviceAssetId': string; /** * * @type {string} * @memberof CheckDuplicateAssetDto */ 'deviceId': string; } /** * * @export * @interface CheckDuplicateAssetResponseDto */ export interface CheckDuplicateAssetResponseDto { /** * * @type {boolean} * @memberof CheckDuplicateAssetResponseDto */ 'isExist': boolean; /** * * @type {string} * @memberof CheckDuplicateAssetResponseDto */ 'id'?: string; } /** * * @export * @interface CheckExistingAssetsDto */ export interface CheckExistingAssetsDto { /** * * @type {Array<string>} * @memberof CheckExistingAssetsDto */ 'deviceAssetIds': Array<string>; /** * * @type {string} * @memberof CheckExistingAssetsDto */ 'deviceId': string; } /** * * @export * @interface CheckExistingAssetsResponseDto */ export interface CheckExistingAssetsResponseDto { /** * * @type {Array<string>} * @memberof CheckExistingAssetsResponseDto */ 'existingIds': Array<string>; } /** * * @export * @interface CreateAlbumDto */ export interface CreateAlbumDto { /** * * @type {string} * @memberof CreateAlbumDto */ 'albumName': string; /** * * @type {Array<string>} * @memberof CreateAlbumDto */ 'sharedWithUserIds'?: Array<string>; /** * * @type {Array<string>} * @memberof CreateAlbumDto */ 'assetIds'?: Array<string>; } /** * * @export * @interface CreateAlbumShareLinkDto */ export interface CreateAlbumShareLinkDto { /** * * @type {string} * @memberof CreateAlbumShareLinkDto */ 'albumId': string; /** * * @type {string} * @memberof CreateAlbumShareLinkDto */ 'expiresAt'?: string; /** * * @type {boolean} * @memberof CreateAlbumShareLinkDto */ 'allowUpload'?: boolean; /** * * @type {boolean} * @memberof CreateAlbumShareLinkDto */ 'allowDownload'?: boolean; /** * * @type {boolean} * @memberof CreateAlbumShareLinkDto */ 'showExif'?: boolean; /** * * @type {string} * @memberof CreateAlbumShareLinkDto */ 'description'?: string; } /** * * @export * @interface CreateAssetsShareLinkDto */ export interface CreateAssetsShareLinkDto { /** * * @type {Array<string>} * @memberof CreateAssetsShareLinkDto */ 'assetIds': Array<string>; /** * * @type {string} * @memberof CreateAssetsShareLinkDto */ 'expiresAt'?: string; /** * * @type {boolean} * @memberof CreateAssetsShareLinkDto */ 'allowUpload'?: boolean; /** * * @type {boolean} * @memberof CreateAssetsShareLinkDto */ 'allowDownload'?: boolean; /** * * @type {boolean} * @memberof CreateAssetsShareLinkDto */ 'showExif'?: boolean; /** * * @type {string} * @memberof CreateAssetsShareLinkDto */ 'description'?: string; } /** * * @export * @interface CreateProfileImageResponseDto */ export interface CreateProfileImageResponseDto { /** * * @type {string} * @memberof CreateProfileImageResponseDto */ 'userId': string; /** * * @type {string} * @memberof CreateProfileImageResponseDto */ 'profileImagePath': string; } /** * * @export * @interface CreateTagDto */ export interface CreateTagDto { /** * * @type {TagTypeEnum} * @memberof CreateTagDto */ 'type': TagTypeEnum; /** * * @type {string} * @memberof CreateTagDto */ 'name': string; } /** * * @export * @interface CreateUserDto */ export interface CreateUserDto { /** * * @type {string} * @memberof CreateUserDto */ 'email': string; /** * * @type {string} * @memberof CreateUserDto */ 'password': string; /** * * @type {string} * @memberof CreateUserDto */ 'firstName': string; /** * * @type {string} * @memberof CreateUserDto */ 'lastName': string; /** * * @type {string} * @memberof CreateUserDto */ 'storageLabel'?: string | null; } /** * * @export * @interface CuratedLocationsResponseDto */ export interface CuratedLocationsResponseDto { /** * * @type {string} * @memberof CuratedLocationsResponseDto */ 'id': string; /** * * @type {string} * @memberof CuratedLocationsResponseDto */ 'city': string; /** * * @type {string} * @memberof CuratedLocationsResponseDto */ 'resizePath': string; /** * * @type {string} * @memberof CuratedLocationsResponseDto */ 'deviceAssetId': string; /** * * @type {string} * @memberof CuratedLocationsResponseDto */ 'deviceId': string; } /** * * @export * @interface CuratedObjectsResponseDto */ export interface CuratedObjectsResponseDto { /** * * @type {string} * @memberof CuratedObjectsResponseDto */ 'id': string; /** * * @type {string} * @memberof CuratedObjectsResponseDto */ 'object': string; /** * * @type {string} * @memberof CuratedObjectsResponseDto */ 'resizePath': string; /** * * @type {string} * @memberof CuratedObjectsResponseDto */ 'deviceAssetId': string; /** * * @type {string} * @memberof CuratedObjectsResponseDto */ 'deviceId': string; } /** * * @export * @interface DeleteAssetDto */ export interface DeleteAssetDto { /** * * @type {Array<string>} * @memberof DeleteAssetDto */ 'ids': Array<string>; } /** * * @export * @interface DeleteAssetResponseDto */ export interface DeleteAssetResponseDto { /** * * @type {DeleteAssetStatus} * @memberof DeleteAssetResponseDto */ 'status': DeleteAssetStatus; /** * * @type {string} * @memberof DeleteAssetResponseDto */ 'id': string; } /** * * @export * @enum {string} */ export declare const DeleteAssetStatus: { readonly Success: "SUCCESS"; readonly Failed: "FAILED"; }; export declare type DeleteAssetStatus = typeof DeleteAssetStatus[keyof typeof DeleteAssetStatus]; /** * * @export * @interface DownloadFilesDto */ export interface DownloadFilesDto { /** * * @type {Array<string>} * @memberof DownloadFilesDto */ 'assetIds': Array<string>; } /** * * @export * @interface EditSharedLinkDto */ export interface EditSharedLinkDto { /** * * @type {string} * @memberof EditSharedLinkDto */ 'description'?: string; /** * * @type {string} * @memberof EditSharedLinkDto */ 'expiresAt'?: string | null; /** * * @type {boolean} * @memberof EditSharedLinkDto */ 'allowUpload'?: boolean; /** * * @type {boolean} * @memberof EditSharedLinkDto */ 'allowDownload'?: boolean; /** * * @type {boolean} * @memberof EditSharedLinkDto */ 'showExif'?: boolean; } /** * * @export * @interface ExifResponseDto */ export interface ExifResponseDto { /** * * @type {number} * @memberof ExifResponseDto */ 'fileSizeInByte'?: number | null; /** * * @type {string} * @memberof ExifResponseDto */ 'make'?: string | null; /** * * @type {string} * @memberof ExifResponseDto */ 'model'?: string | null; /** * * @type {number} * @memberof ExifResponseDto */ 'exifImageWidth'?: number | null; /** * * @type {number} * @memberof ExifResponseDto */ 'exifImageHeight'?: number | null; /** * * @type {string} * @memberof ExifResponseDto */ 'orientation'?: string | null; /** * * @type {string} * @memberof ExifResponseDto */ 'dateTimeOriginal'?: string | null; /** * * @type {string} * @memberof ExifResponseDto */ 'modifyDate'?: string | null; /** * * @type {string} * @memberof ExifResponseDto */ 'timeZone'?: string | null; /** * * @type {string} * @memberof ExifResponseDto */ 'lensModel'?: string | null; /** * * @type {number} * @memberof ExifResponseDto */ 'fNumber'?: number | null; /** * * @type {number} * @memberof ExifResponseDto */ 'focalLength'?: number | null; /** * * @type {number} * @memberof ExifResponseDto */ 'iso'?: number | null; /** * * @type {string} * @memberof ExifResponseDto */ 'exposureTime'?: string | null; /** * * @type {number} * @memberof ExifResponseDto */ 'latitude'?: number | null; /** * * @type {number} * @memberof ExifResponseDto */ 'longitude'?: number | null; /** * * @type {string} * @memberof ExifResponseDto */ 'city'?: string | null; /** * * @type {string} * @memberof ExifResponseDto */ 'state'?: string | null; /** * * @type {string} * @memberof ExifResponseDto */ 'country'?: string | null; /** * * @type {string} * @memberof ExifResponseDto */ 'description'?: string | null; } /** * * @export * @interface GetAssetByTimeBucketDto */ export interface GetAssetByTimeBucketDto { /** * * @type {Array<string>} * @memberof GetAssetByTimeBucketDto */ 'timeBucket': Array<string>; /** * * @type {string} * @memberof GetAssetByTimeBucketDto */ 'userId'?: string; /** * Include assets without thumbnails * @type {boolean} * @memberof GetAssetByTimeBucketDto */ 'withoutThumbs'?: boolean; } /** * * @export * @interface GetAssetCountByTimeBucketDto */ export interface GetAssetCountByTimeBucketDto { /** * * @type {TimeGroupEnum} * @memberof GetAssetCountByTimeBucketDto */ 'timeGroup': TimeGroupEnum; /** * * @type {string} * @memberof GetAssetCountByTimeBucketDto */ 'userId'?: string; /** * Include assets without thumbnails * @type {boolean} * @memberof GetAssetCountByTimeBucketDto */ 'withoutThumbs'?: boolean; } /** * * @export * @enum {string} */ export declare const JobCommand: { readonly Start: "start"; readonly Pause: "pause"; readonly Resume: "resume"; readonly Empty: "empty"; }; export declare type JobCommand = typeof JobCommand[keyof typeof JobCommand]; /** * * @export * @interface JobCommandDto */ export interface JobCommandDto { /** * * @type {JobCommand} * @memberof JobCommandDto */ 'command': JobCommand; /** * * @type {boolean} * @memberof JobCommandDto */ 'force': boolean; } /** * * @export * @interface JobCountsDto */ export interface JobCountsDto { /** * * @type {number} * @memberof JobCountsDto */ 'active': number; /** * * @type {number} * @memberof JobCountsDto */ 'completed': number; /** * * @type {number} * @memberof JobCountsDto */ 'failed': number; /** * * @type {number} * @memberof JobCountsDto */ 'delayed': number; /** * * @type {number} * @memberof JobCountsDto */ 'waiting': number; /** * * @type {number} * @memberof JobCountsDto */ 'paused': number; } /** * * @export * @enum {string} */ export declare const JobName: { readonly ThumbnailGeneration: "thumbnailGeneration"; readonly MetadataExtraction: "metadataExtraction"; readonly VideoConversion: "videoConversion"; readonly ObjectTagging: "objectTagging"; readonly RecognizeFaces: "recognizeFaces"; readonly ClipEncoding: "clipEncoding"; readonly BackgroundTask: "backgroundTask"; readonly StorageTemplateMigration: "storageTemplateMigration"; readonly Search: "search"; readonly Sidecar: "sidecar"; }; export declare type JobName = typeof JobName[keyof typeof JobName]; /** * * @export * @interface JobSettingsDto */ export interface JobSettingsDto { /** * * @type {number} * @memberof JobSettingsDto */ 'concurrency': number; } /** * * @export * @interface JobStatusDto */ export interface JobStatusDto { /** * * @type {JobCountsDto} * @memberof JobStatusDto */ 'jobCounts': JobCountsDto; /** * * @type {QueueStatusDto} * @memberof JobStatusDto */ 'queueStatus': QueueStatusDto; } /** * * @export * @interface LoginCredentialDto */ export interface LoginCredentialDto { /** * * @type {string} * @memberof LoginCredentialDto */ 'email': string; /** * * @type {string} * @memberof LoginCredentialDto */ 'password': string; } /** * * @export * @interface LoginResponseDto */ export interface LoginResponseDto { /** * * @type {string} * @memberof LoginResponseDto */ 'accessToken': string; /** * * @type {string} * @memberof LoginResponseDto */ 'userId': string; /** * * @type {string} * @memberof LoginResponseDto */ 'userEmail': string; /** * * @type {string} * @memberof LoginResponseDto */ 'firstName': string; /** * * @type {string} * @memberof LoginResponseDto */ 'lastName': string; /** * * @type {string} * @memberof LoginResponseDto */ 'profileImagePath': string; /** * * @type {boolean} * @memberof LoginResponseDto */ 'isAdmin': boolean; /** * * @type {boolean} * @memberof LoginResponseDto */ 'shouldChangePassword': boolean; } /** * * @export * @interface LogoutResponseDto */ export interface LogoutResponseDto { /** * * @type {boolean} * @memberof LogoutResponseDto */ 'successful': boolean; /** * * @type {string} * @memberof LogoutResponseDto */ 'redirectUri': string; } /** * * @export * @interface MapMarkerResponseDto */ export interface MapMarkerResponseDto { /** * * @type {string} * @memberof MapMarkerResponseDto */ 'id': string; /** * * @type {number} * @memberof MapMarkerResponseDto */ 'lat': number; /** * * @type {number} * @memberof MapMarkerResponseDto */ 'lon': number; } /** * * @export * @interface MemoryLaneResponseDto */ export interface MemoryLaneResponseDto { /** * * @type {string} * @memberof MemoryLaneResponseDto */ 'title': string; /** * * @type {Array<AssetResponseDto>} * @memberof MemoryLaneResponseDto */ 'assets': Array<AssetResponseDto>; } /** * * @export * @interface OAuthCallbackDto */ export interface OAuthCallbackDto { /** * * @type {string} * @memberof OAuthCallbackDto */ 'url': string; } /** * * @export * @interface OAuthConfigDto */ export interface OAuthConfigDto { /** * * @type {string} * @memberof OAuthConfigDto */ 'redirectUri': string; } /** * * @export * @interface OAuthConfigResponseDto */ export interface OAuthConfigResponseDto { /** * * @type {boolean} * @memberof OAuthConfigResponseDto */ 'enabled': boolean; /** * * @type {boolean} * @memberof OAuthConfigResponseDto */ 'passwordLoginEnabled': boolean; /** * * @type {string} * @memberof OAuthConfigResponseDto */ 'url'?: string; /** * * @type {string} * @memberof OAuthConfigResponseDto */ 'buttonText'?: string; /** * * @type {boolean} * @memberof OAuthConfigResponseDto */ 'autoLaunch'?: boolean; } /** * * @export * @interface PersonResponseDto */ export interface PersonResponseDto { /** * * @type {string} * @memberof PersonResponseDto */ 'id': string; /** * * @type {string} * @memberof PersonResponseDto */ 'name': string; /** * * @type {string} * @memberof PersonResponseDto */ 'thumbnailPath': string; } /** * * @export * @interface PersonUpdateDto */ export interface PersonUpdateDto { /** * * @type {string} * @memberof PersonUpdateDto */ 'name': string; } /** * * @export * @interface QueueStatusDto */ export interface QueueStatusDto { /** * * @type {boolean} * @memberof QueueStatusDto */ 'isActive': boolean; /** * * @type {boolean} * @memberof QueueStatusDto */ 'isPaused': boolean; } /** * * @export * @interface RemoveAssetsDto */ export interface RemoveAssetsDto { /** * * @type {Array<string>} * @memberof RemoveAssetsDto */ 'assetIds': Array<string>; } /** * * @export * @interface SearchAlbumResponseDto */ export interface SearchAlbumResponseDto { /** * * @type {number} * @memberof SearchAlbumResponseDto */ 'total': number; /** * * @type {number} * @memberof SearchAlbumResponseDto */ 'count': number; /** * * @type {Array<AlbumResponseDto>} * @memberof SearchAlbumResponseDto */ 'items': Array<AlbumResponseDto>; /** * * @type {Array<SearchFacetResponseDto>} * @memberof SearchAlbumResponseDto */ 'facets': Array<SearchFacetResponseDto>; } /** * * @export * @interface SearchAssetDto */ export interface SearchAssetDto { /** * * @type {string} * @memberof SearchAssetDto */ 'searchTerm': string; } /** * * @export * @interface SearchAssetResponseDto */ export interface SearchAssetResponseDto { /** * * @type {number} * @memberof SearchAssetResponseDto */ 'total': number; /** * * @type {number} * @memberof SearchAssetResponseDto */ 'count': number; /** * * @type {Array<AssetResponseDto>} * @memberof SearchAssetResponseDto */ 'items': Array<AssetResponseDto>; /** * * @type {Array<SearchFacetResponseDto>} * @memberof SearchAssetResponseDto */ 'facets': Array<SearchFacetResponseDto>; } /** * * @export * @interface SearchConfigResponseDto */ export interface SearchConfigResponseDto { /** * * @type {boolean} * @memberof SearchConfigResponseDto */ 'enabled': boolean; } /** * * @export * @interface SearchExploreItem */ export interface SearchExploreItem { /** * * @type {string} * @memberof SearchExploreItem */ 'value': string; /** * * @type {AssetResponseDto} * @memberof SearchExploreItem */ 'data': AssetResponseDto; } /** * * @export * @interface SearchExploreResponseDto */ export interface SearchExploreResponseDto { /** * * @type {string} * @memberof SearchExploreResponseDto */ 'fieldName': string; /** * * @type {Array<SearchExploreItem>} * @memberof SearchExploreResponseDto */ 'items': Array<SearchExploreItem>; } /** * * @export * @interface SearchFacetCountResponseDto */ export interface SearchFacetCountResponseDto { /** * * @type {number} * @memberof SearchFacetCountResponseDto */ 'count': number; /** * * @type {string} * @memberof SearchFacetCountResponseDto */ 'value': string; } /** * * @export * @interface SearchFacetResponseDto */ export interface SearchFacetResponseDto { /** * * @type {string} * @memberof SearchFacetResponseDto */ 'fieldName': string; /** * * @type {Array<SearchFacetCountResponseDto>} * @memberof SearchFacetResponseDto */ 'counts': Array<SearchFacetCountResponseDto>; } /** * * @export * @interface SearchResponseDto */ export interface SearchResponseDto { /** * * @type {SearchAlbumResponseDto} * @memberof SearchResponseDto */ 'albums': SearchAlbumResponseDto; /** * * @type {SearchAssetResponseDto} * @memberof SearchResponseDto */ 'assets': SearchAssetResponseDto; } /** * * @export * @interface ServerInfoResponseDto */ export interface ServerInfoResponseDto { /** * * @type {number} * @memberof ServerInfoResponseDto */ 'diskSizeRaw': number; /** * * @type {number} * @memberof ServerInfoResponseDto */ 'diskUseRaw': number; /** * * @type {number} * @memberof ServerInfoResponseDto */ 'diskAvailableRaw': number; /** * * @type {number} * @memberof ServerInfoResponseDto */ 'diskUsagePercentage': number; /** * * @type {string} * @memberof ServerInfoResponseDto */ 'diskSize': string; /** * * @type {string} * @memberof ServerInfoResponseDto */ 'diskUse': string; /** * * @type {string} * @memberof ServerInfoResponseDto */ 'diskAvailable': string; } /** * * @export * @interface ServerPingResponse */ export interface ServerPingResponse { /** * * @type {string} * @memberof ServerPingResponse */ 'res': string; } /** * * @export * @interface ServerStatsResponseDto */ export interface ServerStatsResponseDto { /** * * @type {number} * @memberof ServerStatsResponseDto */ 'photos': number; /** * * @type {number} * @memberof ServerStatsResponseDto */ 'videos': number; /** * * @type {number} * @memberof ServerStatsResponseDto */ 'usage': number; /** * * @type {Array<UsageByUserDto>} * @memberof ServerStatsResponseDto */ 'usageByUser': Array<UsageByUserDto>; } /** * * @export * @interface ServerVersionReponseDto */ export interface ServerVersionReponseDto { /** * * @type {number} * @memberof ServerVersionReponseDto */ 'major': number; /** * * @type {number} * @memberof ServerVersionReponseDto */ 'minor': number; /** * * @type {number} * @memberof ServerVersionReponseDto */ 'patch': number; } /** * * @export * @interface SharedLinkResponseDto */ export interface SharedLinkResponseDto { /** * * @type {SharedLinkType} * @memberof SharedLinkResponseDto */ 'type': SharedLinkType; /** * * @type {string} * @memberof SharedLinkResponseDto */ 'id': string; /** * * @type {string} * @memberof SharedLinkResponseDto */ 'description'?: string; /** * * @type {string} * @memberof SharedLinkResponseDto */ 'userId': string; /** * * @type {string} * @memberof SharedLinkResponseDto */ 'key': string; /** * * @type {string} * @memberof SharedLinkResponseDto */ 'createdAt': string; /** * * @type {string} * @memberof SharedLinkResponseDto */ 'expiresAt': string | null; /** * * @type {Array<AssetResponseDto>} * @memberof SharedLinkResponseDto */ 'assets': Array<AssetResponseDto>; /** * * @type {AlbumResponseDto} * @memberof SharedLinkResponseDto */ 'album'?: AlbumResponseDto; /** * * @type {boolean} * @memberof SharedLinkResponseDto */ 'allowUpload': boolean; /** * * @type {boolean} * @memberof SharedLinkResponseDto */ 'allowDownload': boolean; /** * * @type {boolean} * @memberof SharedLinkResponseDto */ 'showExif': boolean; } /** * * @export * @enum {string} */ export declare const SharedLinkType: { readonly Album: "ALBUM"; readonly Individual: "INDIVIDUAL"; }; export declare type SharedLinkType = typeof SharedLinkType[keyof typeof SharedLinkType]; /** * * @export * @interface SignUpDto */ export interface SignUpDto { /** * * @type {string} * @memberof SignUpDto */ 'email': string; /** * * @type {string} * @memberof SignUpDto */ 'password': string; /** * * @type {string} * @memberof SignUpDto */ 'firstName': string; /** * * @type {string} * @memberof SignUpDto */ 'lastName': string; } /** * * @export * @interface SmartInfoResponseDto */ export interface SmartInfoResponseDto { /** * * @type {Array<string>} * @memberof SmartInfoResponseDto */ 'tags'?: Array<string> | null; /** * * @type {Array<string>} * @memberof SmartInfoResponseDto */ 'objects'?: Array<string> | null; } /** * * @export * @interface SystemConfigDto */ export interface SystemConfigDto { /** * * @type {SystemConfigFFmpegDto} * @memberof SystemConfigDto */ 'ffmpeg': SystemConfigFFmpegDto; /** * * @type {SystemConfigOAuthDto} * @memberof SystemConfigDto */ 'oauth': SystemConfigOAuthDto; /** * * @type {SystemConfigPasswordLoginDto} * @memberof SystemConfigDto */ 'passwordLogin': SystemConfigPasswordLoginDto; /** * * @type {SystemConfigStorageTemplateDto} * @memberof SystemConfigDto */ 'storageTemplate': SystemConfigStorageTemplateDto; /** * * @type {SystemConfigJobDto} * @memberof SystemConfigDto */ 'job': SystemConfigJobDto; } /** * * @export * @interface SystemConfigFFmpegDto */ export interface SystemConfigFFmpegDto { /** * * @type {number} * @memberof SystemConfigFFmpegDto */ 'crf': number; /** * * @type {number} * @memberof SystemConfigFFmpegDto */ 'threads': number; /** * * @type {string} * @memberof SystemConfigFFmpegDto */ 'preset': string; /** * * @type {string} * @memberof SystemConfigFFmpegDto */ 'targetVideoCodec': string; /** * * @type {string} * @memberof SystemConfigFFmpegDto */ 'targetAudioCodec': string; /** * * @type {string} * @memberof SystemConfigFFmpegDto */ 'targetResolution': string; /** * * @type {string} * @memberof SystemConfigFFmpegDto */ 'maxBitrate': string; /** * * @type {boolean} * @memberof SystemConfigFFmpegDto */ 'twoPass': boolean; /** * * @type {string} * @memberof SystemConfigFFmpegDto */ 'transcode': SystemConfigFFmpegDtoTranscodeEnum; } export declare const SystemConfigFFmpegDtoTranscodeEnum: { readonly All: "all"; readonly Optimal: "optimal"; readonly Required: "required"; readonly Disabled: "disabled"; }; export declare type SystemConfigFFmpegDtoTranscodeEnum = typeof SystemConfigFFmpegDtoTranscodeEnum[keyof typeof SystemConfigFFmpegDtoTranscodeEnum]; /** * * @export * @interface SystemConfigJobDto */ export interface SystemConfigJobDto { /** * * @type {JobSettingsDto} * @memberof SystemConfigJobDto */ 'thumbnailGeneration': JobSettingsDto; /** * * @type {JobSettingsDto} * @memberof SystemConfigJobDto */ 'metadataExtraction': JobSettingsDto; /** * * @type {JobSettingsDto} * @memberof SystemConfigJobDto */ 'videoConversion': JobSettingsDto; /** * * @type {JobSettingsDto} * @memberof SystemConfigJobDto */ 'objectTagging': JobSettingsDto; /** * * @type {JobSettingsDto} * @memberof SystemConfigJobDto */ 'clipEncoding': JobSettingsDto; /** * * @type {JobSettingsDto} * @memberof SystemConfigJobDto */ 'storageTemplateMigration': JobSettingsDto; /** * * @type {JobSettingsDto} * @memberof SystemConfigJobDto */ 'backgroundTask': JobSettingsDto; /** * * @type {JobSettingsDto} * @memberof SystemConfigJobDto */ 'search': JobSettingsDto; /** * * @type {JobSettingsDto} * @memberof SystemConfigJobDto */ 'recognizeFaces': JobSettingsDto; /** * * @type {JobSettingsDto} * @memberof SystemConfigJobDto */ 'sidecar': JobSettingsDto; } /** * * @export * @interface SystemConfigOAuthDto */ export interface SystemConfigOAuthDto { /** * * @type {boolean} * @memberof SystemConfigOAuthDto */ 'enabled': boolean; /** * * @type {string} * @memberof SystemConfigOAuthDto */ 'issuerUrl': string; /** * * @type {string} * @memberof SystemConfigOAuthDto */ 'clientId': string; /** * * @type {string} * @memberof SystemConfigOAuthDto */ 'clientSecret': string; /** * * @type {string} * @memberof SystemConfigOAuthDto */ 'scope': string; /** * * @type {string} * @memberof SystemConfigOAuthDto */ 'buttonText': string; /** * * @type {boolean} * @memberof SystemConfigOAuthDto */ 'autoRegister': boolean; /** * * @type {boolean} * @memberof SystemConfigOAuthDto */ 'autoLaunch': boolean; /** * * @type {boolean} * @memberof SystemConfigOAuthDto */ 'mobileOverrideEnabled': boolean; /** * * @type {string} * @memberof SystemConfigOAuthDto */ 'mobileRedirectUri': string; } /** * * @export * @interface SystemConfigPasswordLoginDto */ export interface SystemConfigPasswordLoginDto { /** * * @type {boolean} * @memberof SystemConfigPasswordLoginDto */ 'enabled': boolean; } /** * * @export * @interface SystemConfigStorageTemplateDto */ export interface SystemConfigStorageTemplateDto { /** * * @type {string} * @memberof SystemConfigStorageTemplateDto */ 'template': string; } /** * * @export * @interface SystemConfigTemplateStorageOptionDto */ export interface SystemConfigTemplateStorageOptionDto { /** * * @type {Array<string>} * @memberof SystemConfigTemplateStorageOptionDto */ 'yearOptions': Array<string>; /** * * @type {Array<string>} * @memberof SystemConfigTemplateStorageOptionDto */ 'monthOptions': Array<string>; /** * * @type {Array<string>} * @memberof SystemConfigTemplateStorageOptionDto */ 'dayOptions': Array<string>; /** * * @type {Array<string>} * @memberof SystemConfigTemplateStorageOptionDto */ 'hourOptions': Array<string>; /** * * @type {Array<string>} * @memberof SystemConfigTemplateStorageOptionDto */ 'minuteOptions': Array<string>; /** * * @type {Array<string>} * @memberof SystemConfigTemplateStorageOptionDto */ 'secondOptions': Array<string>; /** * * @type {Array<string>} * @memberof SystemConfigTemplateStorageOptionDto */ 'presetOptions': Array<string>; } /** * * @export * @interface TagResponseDto */ export interface TagResponseDto { /** * * @type {TagTypeEnum} * @memberof TagResponseDto */ 'type': TagTypeEnum; /** * * @type {string} * @memberof TagResponseDto */ 'id': string; /** * * @type {string} * @memberof TagResponseDto */ 'name': string; /** * * @type {string} * @memberof TagResponseDto */ 'userId': string; } /** * * @export * @enum {string} */ export declare const TagTypeEnum: { readonly Object: "OBJECT"; readonly Face: "FACE"; readonly Custom: "CUSTOM"; }; export declare type TagTypeEnum = typeof TagTypeEnum[keyof typeof TagTypeEnum]; /** * * @export * @enum {string} */ export declare const ThumbnailFormat: { readonly Jpeg: "JPEG"; readonly Webp: "WEBP"; }; export declare type ThumbnailFormat = typeof ThumbnailFormat[keyof typeof ThumbnailFormat]; /** * * @export * @enum {string} */ export declare const TimeGroupEnum: { readonly Day: "day"; readonly Month: "month"; }; export declare type TimeGroupEnum = typeof TimeGroupEnum[keyof typeof TimeGroupEnum]; /** * * @export * @interface UpdateAlbumDto */ export interface UpdateAlbumDto { /** * * @type {string} * @memberof UpdateAlbumDto */ 'albumName'?: string; /** * * @type {string} * @memberof UpdateAlbumDto */ 'albumThumbnailAssetId'?: string; } /** * * @export * @interface UpdateAssetDto */ export interface UpdateAssetDto { /** * * @type {Array<string>} * @memberof UpdateAssetDto */ 'tagIds'?: Array<string>; /** * * @type {boolean} * @memberof UpdateAssetDto */ 'isFavorite'?: boolean; /** * * @type {boolean} * @memberof UpdateAssetDto */ 'isArchived'?: boolean; /** * * @type {string} * @memberof UpdateAssetDto */ 'description'?: string; } /** * * @export * @interface UpdateTagDto */ export interface UpdateTagDto { /** * * @type {string} * @memberof UpdateTagDto */ 'name'?: string; } /** * * @export * @interface UpdateUserDto */ export interface UpdateUserDto { /** * * @type {string} * @memberof UpdateUserDto */ 'id': string; /** * * @type {string} * @memberof UpdateUserDto */ 'email'?: string; /** * * @type {string} * @memberof UpdateUserDto */ 'password'?: string; /** * * @type {string} * @memberof UpdateUserDto */ 'firstName'?: string; /** * * @type {string} * @memberof UpdateUserDto */ 'lastName'?: string; /** * * @type {string} * @memberof UpdateUserDto */ 'storageLabel'?: string; /** * * @type {boolean} * @memberof UpdateUserDto */ 'isAdmin'?: boolean; /** * * @type {boolean} * @memberof Update