immich

type AboutInfo struct {
	Version       string `json:"version"`
	VersionURL    string `json:"versionUrl"`
	Licensed      bool   `json:"licensed"`
	Build         string `json:"build"`
	BuildURL      string `json:"buildUrl"`
	BuildImage    string `json:"buildImage"`
	BuildImageURL string `json:"buildImageUrl"`
	Repository    string `json:"repository"`
	RepositoryURL string `json:"repositoryUrl"`
	SourceRef     string `json:"sourceRef"`
	SourceCommit  string `json:"sourceCommit"`
	SourceURL     string `json:"sourceUrl"`
	Nodejs        string `json:"nodejs"`
	Exiftool      string `json:"exiftool"`
	Ffmpeg        string `json:"ffmpeg"`
	Libvips       string `json:"libvips"`
	Imagemagick   string `json:"imagemagick"`
}

type AdminOnboardingUpdateDto struct {
	IsOnboarded bool `json:"isOnboarded"`
}

type AlbumContent struct {
	ID string `json:"id,omitempty"`
	// OwnerID                    string    `json:"ownerId"`
	AlbumName   string   `json:"albumName"`
	Description string   `json:"description"`
	Shared      bool     `json:"shared"`
	Assets      []*Asset `json:"assets,omitempty"`
	AssetIDs    []string `json:"assetIds,omitempty"`
}

type AlbumSimplified struct {
	ID          string `json:"id,omitempty"`
	AlbumName   string `json:"albumName"`
	Description string `json:"description,omitempty"`
	// OwnerID                    string    `json:"ownerId"`
	// CreatedAt                  time.Time `json:"createdAt"`
	// UpdatedAt                  time.Time `json:"updatedAt"`
	// AlbumThumbnailAssetID      string    `json:"albumThumbnailAssetId"`
	// SharedUsers                []string  `json:"sharedUsers"`
	// Owner                      User      `json:"owner"`
	// Shared                     bool      `json:"shared"`
	// AssetCount                 int       `json:"assetCount"`
	// LastModifiedAssetTimestamp time.Time `json:"lastModifiedAssetTimestamp"
	AssetIds []string `json:"assetIds,omitempty"`
}

type Asset struct {
	Checksum string `json:"checksum"`
	// createdAt
	DeviceAssetID string `json:"deviceAssetId"`
	DeviceID      string `json:"deviceId"`
	// duplicateId
	Duration       string     `json:"duration"`
	ExifInfo       ExifInfo   `json:"exifInfo"`
	FileCreatedAt  ImmichTime `json:"fileCreatedAt"`
	FileModifiedAt ImmichTime `json:"fileModifiedAt"`
	// hasMetadata
	ID         string `json:"id"`
	IsArchived bool   `json:"isArchived"`
	IsFavorite bool   `json:"isFavorite"`
	// isOffline
	IsTrashed        bool   `json:"isTrashed"`
	LibraryID        string `json:"libraryId,omitempty"`
	LivePhotoVideoID string `json:"livePhotoVideoId"`

	// The local date and time when the photo/video was taken,
	// derived from EXIF metadata. This represents the
	// photographer's local time regardless of timezone,
	// stored as a timezone-agnostic timestamp.
	// Used for timeline grouping by "local" days and months.
	LocalDateTime    ImmichTime `json:"localDateTime"`
	OriginalFileName string     `json:"originalFileName"`
	// originalMimeType
	OriginalPath string `json:"originalPath"`
	// owner
	OwnerID string `json:"ownerId"`
	// people
	Resized bool `json:"resized"`
	// stack
	Tags      []TagSimplified `json:"tags"`
	Thumbhash string          `json:"thumbhash"`
	Type      string          `json:"type"`
	// unassignedFaces
	UpdatedAt ImmichTime `json:"updatedAt"`
	// rating not listed on the API page?
	Rating int `json:"rating"`
	// StackParentID string            `json:"stackParentId"`
	Visibility string `json:"visibility"`

	Albums []AlbumSimplified `json:"-"` // Albums that asset belong to, not in the API
}

type AssetResponse struct {
	ID     string `json:"id"`
	Status string `json:"status"`
}

type AssetSimplified struct {
	ID            string `json:"id"`
	DeviceAssetID string `json:"deviceAssetId"`
}

type ExifInfo struct {
	Make             string         `json:"make"`
	Model            string         `json:"model"`
	ExifImageWidth   int            `json:"exifImageWidth"`
	ExifImageHeight  int            `json:"exifImageHeight"`
	FileSizeInByte   int64          `json:"fileSizeInByte"`
	Orientation      string         `json:"orientation"`
	DateTimeOriginal ImmichExifTime `json:"dateTimeOriginal,omitempty"`
	// 	ModifyDate       time.Time `json:"modifyDate"`
	TimeZone string `json:"timeZone"`
	// LensModel        string    `json:"lensModel"`
	// 	FNumber          float64   `json:"fNumber"`
	// 	FocalLength      float64   `json:"focalLength"`
	// 	Iso              int       `json:"iso"`
	// 	ExposureTime     string    `json:"exposureTime"`
	Latitude  float64 `json:"latitude,omitempty"`
	Longitude float64 `json:"longitude,omitempty"`
	// 	City             string    `json:"city"`
	// 	State            string    `json:"state"`
	// 	Country          string    `json:"country"`
	Description string `json:"description"`
	Rating      int    `json:"rating"`
}

type GetAllPeopleOptions struct {
	ClosestAssetId  string // UUID of the closest asset
	ClosestPersonId string // UUID of the closest person
	Page            int    // Page number for pagination (default: 1, minimum: 1)
	Size            int    // Number of items per page (default: 500, minimum: 1, maximum: 1000)
	WithHidden      *bool  // Whether to include hidden people
}

type GetAssetOptions struct {
	UserID        string
	IsFavorite    bool
	IsArchived    bool
	WithoutThumbs bool
	Skip          string
}

type ImmichAlbumInterface interface {
	GetAllAlbums(ctx context.Context) ([]AlbumSimplified, error)
	GetAlbumInfo(ctx context.Context, id string, withoutAssets bool) (AlbumContent, error)
	CreateAlbum(
		ctx context.Context,
		tilte string,
		description string,
		ids []string,
	) (assets.Album, error)

	// GetAssetAlbums get all albums that an asset belongs to
	GetAssetAlbums(ctx context.Context, assetID string) ([]AlbumSimplified, error)
	DeleteAlbum(ctx context.Context, id string) error
}

type ImmichAssetInterface interface {
	GetAssetInfo(ctx context.Context, id string) (*Asset, error)
	DownloadAsset(ctx context.Context, id string) (io.ReadCloser, error)
	UpdateAsset(ctx context.Context, id string, param UpdAssetField) (*Asset, error)
	ReplaceAsset(ctx context.Context, ID string, la *assets.Asset) (AssetResponse, error) // Deprecated
	CopyAsset(ctx context.Context, sourceID string, targetID string) error
	GetAllAssets(ctx context.Context, fn func(*Asset) error) error
	AddAssetToAlbum(context.Context, string, []string) ([]UpdateAlbumResult, error)
	UpdateAssets(
		ctx context.Context,
		IDs []string,
		isArchived bool,
		isFavorite bool,
		latitude float64,
		longitude float64,
		removeParent bool,
		stackParentID string,
	) error
	GetFilteredAssetsFn(ctx context.Context, so *searchOptions, filter func(*Asset) error) error
	// GetAllAssetsWithFilter(context.Context, *SearchMetadataQuery, func(*Asset) error) error
	GetAssetsByHash(ctx context.Context, hash string) ([]*Asset, error)
	GetAssetsByImageName(ctx context.Context, name string) ([]*Asset, error)

	AssetUpload(context.Context, *assets.Asset) (AssetResponse, error)
	DeleteAssets(ctx context.Context, IDs []string, force bool) error
}

type ImmichClient struct {
	DeviceUUID   string        // Device
	Retries      int           // Number of attempts on 500 errors
	RetriesDelay time.Duration // Duration between retries
	// contains filtered or unexported fields
}

type ImmichClientInterface interface {
	SetEndPoint(string)
	// EnableAppTrace by decorating the client's transport with round tripper that logs queries
	EnableAppTrace(rtd RoundTripperDecorator)
	SetDeviceUUID(string)
	PingServer(ctx context.Context) error
	ValidateConnection(ctx context.Context) (User, error)
	GetServerStatistics(ctx context.Context) (ServerStatistics, error)
	GetAssetStatistics(ctx context.Context) (UserStatistics, error)
	SupportedMedia() filetypes.SupportedMedia
	GetAboutInfo(ctx context.Context) (AboutInfo, error)
}

type ImmichExifTime struct {
	time.Time
}

type ImmichGetSuggestion interface {
	GetSearchSuggestions(ctx context.Context, req SearchSuggestionRequest) (SearchSuggestions, error)
}

type ImmichInterface interface {
	ImmichAssetInterface
	ImmichClientInterface
	ImmichAlbumInterface
	ImmichTagInterface
	ImmichStackInterface
	ImmichJobInterface
}

type ImmichJobInterface interface {
	GetJobs(ctx context.Context) (map[string]Job, error)
	SendJobCommand(
		ctx context.Context,
		jobID string,
		command JobCommand,
		force bool,
	) (SendJobCommandResponse, error)
	CreateJob(ctx context.Context, name JobName) error
}

type ImmichPeopleInterface interface {
	GetAllPeople(ctx context.Context, opts ...GetAllPeopleOptions) (*PeopleResponseDto, error)
	GetAllPeopleIterator(ctx context.Context, fn func(*PersonResponseDto) error, opts ...GetAllPeopleOptions) error
	GetPersonByName(ctx context.Context, name string, opts ...GetAllPeopleOptions) (*PersonResponseDto, error)
	GetPeopleByNames(ctx context.Context, names []string, opts ...GetAllPeopleOptions) (map[string]*PersonResponseDto, error)
}

type ImmichStackInterface interface {
	// CreateStack create a stack with the given assets, the 1st asset is the cover, return the stack ID
	CreateStack(ctx context.Context, ids []string) (string, error)
}

type ImmichTagInterface interface {
	GetAllTags(ctx context.Context) ([]TagSimplified, error)
	UpsertTags(ctx context.Context, tags []string) ([]TagSimplified, error)
	TagAssets(
		ctx context.Context,
		tagID string,
		assetIDs []string,
	) ([]TagAssetsResponse, error)
	BulkTagAssets(
		ctx context.Context,
		tagIDs []string,
		assetIDs []string,
	) (struct {
		Count int `json:"count"`
	}, error)
}

type ImmichTime struct {
	time.Time
}

type Job struct {
	JobCounts struct {
		Active    int `json:"active"`
		Completed int `json:"completed"`
		Failed    int `json:"failed"`
		Delayed   int `json:"delayed"`
		Waiting   int `json:"waiting"`
		Paused    int `json:"paused"`
	} `json:"jobCounts"`
	QueueStatus struct {
		IsActive bool `json:"isActive"`
		IsPaused bool `json:"isPaused"`
	} `json:"queueStatus"`
}

type JobCommand string

type JobID string

type JobName string

type LoginCredentialDto struct {
	Email    string `json:"email"`
	Password string `json:"password"`
}

type LoginResponseDto struct {
	AccessToken          string `json:"accessToken"`
	IsAdmin              bool   `json:"isAdmin"`
	IsOnboarded          bool   `json:"isOnboarded"`
	Name                 string `json:"name"`
	ProfileImagePath     string `json:"profileImagePath"`
	ShouldChangePassword bool   `json:"shouldChangePassword"`
	UserEmail            string `json:"userEmail"`
	UserID               string `json:"userId"`
}

type PeopleResponseDto struct {
	HasNextPage bool                `json:"hasNextPage,omitempty"` // Added in v1.110.0
	Hidden      int                 `json:"hidden"`
	Total       int                 `json:"total"`
	People      []PersonResponseDto `json:"people"`
}

type PersonResponseDto struct {
	ID            string     `json:"id"`
	Name          string     `json:"name"`
	BirthDate     ImmichTime `json:"birthDate,omitzero"`
	Color         string     `json:"color,omitempty"`      // Added in v1.126.0
	IsFavorite    bool       `json:"isFavorite,omitempty"` // Added in v1.126.0
	IsHidden      bool       `json:"isHidden"`
	ThumbnailPath string     `json:"thumbnailPath"`
	UpdatedAt     ImmichTime `json:"updatedAt,omitempty"` // Added in v1.107.0
}

type PingResponse struct {
	Res string `json:"res"`
}

type RoundTripperDecorator func(rt http.RoundTripper) http.RoundTripper

type SearchMetadataQuery struct {
	// pagination
	Page int `json:"page"`
	Size int `json:"size,omitempty"`

	// filters
	WithExif         bool              `json:"withExif,omitempty"`
	IsFavorite       bool              `json:"isFavorite,omitempty"`
	IsNotInAlbum     bool              `json:"isNotInAlbum,omitempty"`
	WithDeleted      bool              `json:"withDeleted,omitempty"`
	AlbumIds         []string          `json:"albumIds,omitempty"`
	TagIds           []string          `json:"tagIds,omitempty"`
	PersonIds        []string          `json:"personIds,omitempty"`
	TakenBefore      string            `json:"takenBefore,omitzero"`
	TakenAfter       string            `json:"takenAfter,omitzero"`
	TrashedAfter     string            `json:"trashedAfter,omitzero"`
	TrashedBefore    string            `json:"trashedBefore,omitzero"`
	Model            string            `json:"model,omitempty"`
	Make             string            `json:"make,omitempty"`
	Country          string            `json:"country,omitempty"`
	State            string            `json:"state,omitempty"`
	City             string            `json:"city,omitempty"`
	Checksum         string            `json:"checksum,omitempty"`
	OriginalFileName string            `json:"originalFileName,omitempty"`
	Rating           int               `json:"rating,omitzero"`
	Visibility       assets.Visibility `json:"visibility,omitempty"`
	Order            string            `json:"order,omitempty"`
}

type SearchSuggestionRequest struct {
	Type        SearchSuggestionType `json:"type"`
	Country     string               `json:"country,omitempty"`
	State       string               `json:"state,omitempty"`
	Make        string               `json:"make,omitempty"`
	Model       string               `json:"model,omitempty"`
	IncludeNull bool                 `json:"includeNull,omitzero"`
}

type SearchSuggestionType string

type SearchSuggestions []string

type SendJobCommandResponse struct {
	JobCounts struct {
		Active    int `json:"active"`
		Completed int `json:"completed"`
		Delayed   int `json:"delayed"`
		Failed    int `json:"failed"`
		Paused    int `json:"paused"`
		Waiting   int `json:"waiting"`
	} `json:"jobCounts"`
	QueueStatus struct {
		IsActive bool `json:"isActive"`
		IsPause  bool `json:"isPause"`
	}
}

type ServerErrorMessage struct {
	Error         string `json:"error"`
	StatusCode    int    `json:"statusCode"`
	Message       string `json:"message"`
	CorrelationID string `json:"correlationId"`
}

type ServerStatistics struct {
	Photos      int   `json:"photos"`
	Videos      int   `json:"videos"`
	Usage       int64 `json:"usage"`
	UsageByUser []struct {
		UserID           string `json:"userId"`
		UserName         string `json:"userName"`
		Photos           int    `json:"photos"`
		Videos           int    `json:"videos"`
		Usage            int64  `json:"usage"`
		QuotaSizeInBytes any    `json:"quotaSizeInBytes"`
	} `json:"usageByUser"`
}

type SignupDto struct {
	Email    string `json:"email"`
	Password string `json:"password"`
	Name     string `json:"name"`
}

type TagAssetsResponse struct {
	Error   string `json:"error,omitempty"` // [duplicate, no_permission, not_found, unknown]
	ID      string `json:"id"`
	Success bool   `json:"success"`
}

type TagSimplified struct {
	ID    string `json:"id"`
	Name  string `json:"name"`
	Value string `json:"value"`
}

type TooManyInternalError struct {
	// contains filtered or unexported fields
}

type URLRequester interface {
	SetURL(u *url.URL) error
}

type UnsupportedMedia struct {
	// contains filtered or unexported fields
}

type UpdAssetField struct {
	IsArchived       bool      `json:"isArchived,omitempty"`
	IsFavorite       bool      `json:"isFavorite,omitempty"`
	Latitude         float64   `json:"latitude,omitempty"`
	Longitude        float64   `json:"longitude,omitempty"`
	Description      string    `json:"description,omitempty"`
	Rating           int       `json:"rating,omitempty"`
	DateTimeOriginal time.Time `json:"dateTimeOriginal,omitempty"`
}

type UpdateAlbum struct {
	IDS []string `json:"ids"`
}

type UpdateAlbumResult struct {
	ID      string `json:"id"`
	Success bool   `json:"success"`
	Error   string `json:"error,omitempty"`
}

type User struct {
	ID                   string    `json:"id"`
	Email                string    `json:"email"`
	FirstName            string    `json:"firstName"`
	LastName             string    `json:"lastName"`
	StorageLabel         string    `json:"storageLabel"`
	ExternalPath         string    `json:"externalPath"`
	ProfileImagePath     string    `json:"profileImagePath"`
	ShouldChangePassword bool      `json:"shouldChangePassword"`
	IsAdmin              bool      `json:"isAdmin"`
	CreatedAt            time.Time `json:"createdAt"`
	DeletedAt            time.Time `json:"deletedAt"`
	UpdatedAt            time.Time `json:"updatedAt"`
	OauthID              string    `json:"oauthId"`
}

type UserAdminResponseDto struct {
	CreatedAt            string     `json:"createdAt"`
	DeletedAt            string     `json:"deletedAt,omitempty"`
	Email                string     `json:"email"`
	ID                   string     `json:"id"`
	IsAdmin              bool       `json:"isAdmin"`
	Name                 string     `json:"name"`
	OauthID              string     `json:"oauthId"`
	ProfileChangedAt     string     `json:"profileChangedAt"`
	ProfileImagePath     string     `json:"profileImagePath"`
	QuotaSizeInBytes     int64      `json:"quotaSizeInBytes,omitempty"`
	QuotaUsageInBytes    int64      `json:"quotaUsageInBytes,omitempty"`
	ShouldChangePassword bool       `json:"shouldChangePassword"`
	Status               UserStatus `json:"status"`
	StorageLabel         string     `json:"storageLabel,omitempty"`
	UpdatedAt            string     `json:"updatedAt"`
}

type UserStatistics struct {
	Images int `json:"images"`
	Videos int `json:"videos"`
	Total  int `json:"total"`
}

type UserStatus string