PSImmich

Author(s)

• Hannes Palmquist

Tags

Windows Linux MacOS

Functions

Add-IMActivity Get-IMActivity Get-IMActivityStatistic Remove-IMActivity Add-IMAlbumUser Get-IMAlbum Get-IMAlbumCount New-IMAlbum Remove-IMAlbum Remove-IMAlbumUser Rename-IMAlbum Set-IMAlbum Set-IMAlbumUser Get-IMAPIKey New-IMAPIKey Remove-IMAPIKey Rename-IMAPIKey Export-IMAssetThumbnail Get-IMAsset Get-IMAssetMemoryLane Get-IMAssetStatistic Import-IMAsset Remove-IMAsset Restore-IMAsset Save-IMAsset Set-IMAsset Start-IMVideoTranscode Update-IMAssetMetadata Update-IMAssetThumbnail Get-IMAuditDelete Test-IMAccessToken Get-IMAuthSession Remove-IMAuthSession Get-IMFace Get-IMAuditFile Get-IMFileChecksum Clear-IMJob Get-IMJob Resume-IMJob Start-IMJob Suspend-IMJob Get-IMLibrary New-IMLibrary Remove-IMLibrary Remove-IMOfflineLibraryFile Set-IMLibrary Sync-IMLibrary Test-IMLibrary Get-IMMapMarker Get-IMMapStyle Get-IMMemory New-IMMemory Remove-IMMemory Set-IMMemory Send-IMTestMessage Add-IMPartner Get-IMPartner Remove-IMPartner Set-IMPartner Export-IMPersonThumbnail Get-IMPerson Merge-IMPerson New-IMPerson Set-IMPerson Find-IMAsset Find-IMCity Find-IMExploreData Find-IMPerson Find-IMPlace Get-IMConfig Set-IMConfig Get-IMServer Get-IMServerConfig Get-IMServerFeature Get-IMServerStatistic Get-IMServerStorage Get-IMServerVersion Get-IMSupportedMediaType Get-IMTheme Test-IMPing Connect-Immich Disconnect-Immich Get-IMSession Invoke-ImmichMethod Add-IMSharedLinkAsset Get-IMSharedLink New-IMSharedLink Remove-IMSharedLink Remove-IMSharedLinkAsset Set-IMSharedLink Get-IMTag New-IMTag Remove-IMTag Rename-IMTag Set-IMTag Get-IMTimeBucket Add-IMMyProfilePicture Export-IMProfilePicture Get-IMUser New-IMUser Remove-IMMyProfilePicture Remove-IMUser Restore-IMUser Set-IMUser

PSEditions

Desktop Core

Dependencies

This module has no dependencies.

Release Notes

## [1.2.0-preview0001] - 2024-06-12

### Changed

- Versioning of the PSImmich module will follow the Immich version. For instance v1.105.X will correspond to the API version of Immich 1.105.X. The third number (patch) will be used to track releases/fixes for the PSImmich module specifically. This makes it much easier to find the correct PSImmich version that has feature parity with the version of Immich that is used. If Immich releases a new version that does not require an update to the PSImmich module, that version number will simply be skipped. So the version of PSImmich might not be sequentially incremented.

### Added

- Added new cmdlet Send-IMTestMessage
- Added new cmdlet Get-IMMemory
- Added new cmdlet New-IMMemory
- Added new cmdlet Remove-IMMemory
- Added new cmdlet Set-IMMemory
- New cmdlet Get-IMServerStorage
- New cmdlet Get-IMProfilePicture
- New cmdlet Get-IMAssetThumbnail
- New cmdlet Set-IMAlbumUser to allow changing the user role for an album.
- Set-IMAsset now has a parameter for AddToFace to incorporate the /face/{id} API
- New cmdlet Marge-IMPerson to incorporate the /person/{id}/merge API
- Get-IMPerson now has a new switch IncludeStatistics to incorporate the /person/{id}/statistics API. The switch is not currently available with the list parameter set. However one could use the following to produce the same result Get-IMPerson | Get-IMPerson -IncludeStatistics
- New cmdlet Export-IMPersonThumbnail

### Fixed

- Updated Get-IMAssetMapMarker to the new API location under map and renamed to Get-IMMapMarker
- Updated Get-IMAssetMapStyle to the new API location under map and renamed to GetIMAssetMarker
- Updated Get-IMAuthDevice to the new API location under session and renamed to Get-IMAuthSession.
- Updated Remove-IMAuthDevice to the new API location under session and renamed to Remove-IMAuthSession
- Updated Get-IMAuditFile to the new API location under report
- Updated Get-IMFileChecksum to the new API location under report
- Updated Add-IMAlbumUser to use the new albumUsers property instead of the deprecated sharedUserIds.
- Updated Add-IMAlbumUser to allow configuring the user role.
- Updated Get-IMTimeBucket to the new API location under timeline
- Updated test suite for Get-IMServerFeature now returning the email attribute
- Updated Get-IMServer to also include the result from Get-IMServerStorage

### Removed

- Get-IMAsset will no longer enumerate assets as a search (with optional filters), this API endpoint has been removed from Immich. Instead Find-IMAsset should be used.
- Removed Get-IMSearchTerms due to API deprecation
- Removed Get-IMCuratedLocation due to API deprecation
- Removed Get-IMCuratedObject due to API deprecation