client

package
v0.0.24 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 26, 2026 License: GPL-3.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func StringPtr added in v0.0.9 

func StringPtr(s string) *string

Types

type ActivityCreateDto 

type ActivityCreateDto struct {
	AlbumId string       `json:"albumId"`
	AssetId *string      `json:"assetId,omitempty"`
	Comment *string      `json:"comment,omitempty"`
	Type    ReactionType `json:"type"`
}

type ActivityResponseDto 

type ActivityResponseDto struct {
	AssetId   string          `json:"assetId"`
	Comment   string          `json:"comment"`
	CreatedAt string          `json:"createdAt"`
	Id        string          `json:"id"`
	Type      ReactionType    `json:"type"`
	User      UserResponseDto `json:"user"`
}

type ActivityStatisticsResponseDto 

type ActivityStatisticsResponseDto struct {
	Comments int64 `json:"comments"`
	Likes    int64 `json:"likes"`
}

type AddUsersDto added in v0.0.3 

type AddUsersDto struct {
	AlbumUsers []AlbumUserAddDto `json:"albumUsers"`
}

type AdminOnboardingUpdateDto added in v0.0.8 

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

type AlbumResponseDto 

type AlbumResponseDto struct {
	AlbumName                  string                        `json:"albumName"`
	AlbumThumbnailAssetId      string                        `json:"albumThumbnailAssetId"`
	AlbumUsers                 []AlbumUserResponseDto        `json:"albumUsers"`
	AssetCount                 int64                         `json:"assetCount"`
	ContributorCounts          []ContributorCountResponseDto `json:"contributorCounts"`
	CreatedAt                  string                        `json:"createdAt"`
	Description                string                        `json:"description"`
	EndDate                    string                        `json:"endDate"`
	HasSharedLink              bool                          `json:"hasSharedLink"`
	Id                         string                        `json:"id"`
	IsActivityEnabled          bool                          `json:"isActivityEnabled"`
	LastModifiedAssetTimestamp string                        `json:"lastModifiedAssetTimestamp"`
	Order                      string                        `json:"order"`
	Shared                     bool                          `json:"shared"`
	StartDate                  string                        `json:"startDate"`
	UpdatedAt                  string                        `json:"updatedAt"`
}

type AlbumStatisticsResponseDto added in v0.0.3 

type AlbumStatisticsResponseDto struct {
	NotShared int64 `json:"notShared"`
	Owned     int64 `json:"owned"`
	Shared    int64 `json:"shared"`
}

type AlbumUserAddDto added in v0.0.3 

type AlbumUserAddDto struct {
	Role   string `json:"role"`
	UserId string `json:"userId"`
}

type AlbumUserCreateDto 

type AlbumUserCreateDto struct {
	Role   string `json:"role"`
	UserId string `json:"userId"`
}

type AlbumUserResponseDto 

type AlbumUserResponseDto struct {
	Role string          `json:"role"`
	User UserResponseDto `json:"user"`
}

type AlbumsAddAssetsDto added in v0.0.2 

type AlbumsAddAssetsDto struct {
	AlbumIds []string `json:"albumIds"`
	AssetIds []string `json:"assetIds"`
}

type AlbumsAddAssetsResponseDto added in v0.0.2 

type AlbumsAddAssetsResponseDto struct {
	Error   string `json:"error"`
	Success bool   `json:"success"`
}

type AlbumsResponse added in v0.0.15 

type AlbumsResponse struct {
	DefaultAssetOrder AssetOrder `json:"defaultAssetOrder"`
}

type AlbumsUpdate added in v0.0.15 

type AlbumsUpdate struct {
	DefaultAssetOrder AssetOrder `json:"defaultAssetOrder"`
}

type ApiKeyCreateDto 

type ApiKeyCreateDto struct {
	Name        string   `json:"name"`        // API key name
	Permissions []string `json:"permissions"` // List of permissions
}

type ApiKeyCreateResponseDto 

type ApiKeyCreateResponseDto struct {
	ApiKey ApiKeyResponseDto `json:"apiKey"` // API key response
	Secret string            `json:"secret"` // API key secret
}

type ApiKeyResponseDto 

type ApiKeyResponseDto struct {
	CreatedAt   string   `json:"createdAt"`   // Creation date
	Id          string   `json:"id"`          // API key ID
	Name        string   `json:"name"`        // API key name
	Permissions []string `json:"permissions"` // List of permissions
	UpdatedAt   string   `json:"updatedAt"`   // Last update date
}

An ApiKeyResponseDto returns details of an Immich API Key.

type ApiKeyUpdateDto 

type ApiKeyUpdateDto struct {
	Name        string   `json:"name,omitempty"`        // API key name
	Permissions []string `json:"permissions,omitempty"` // List of permissions
}

type AssetBulkDeleteDto added in v0.0.9 

type AssetBulkDeleteDto struct {
	Force bool     `json:"force"`
	Ids   []string `json:"ids"`
}

type AssetBulkUpdateDto added in v0.0.9 

type AssetBulkUpdateDto struct {
	DateTimeOriginal *string  `json:"dateTimeOriginal,omitempty"`
	DateTimeRelative *int64   `json:"dateTimeRelative,omitempty"`
	Description      *string  `json:"description,omitempty"`
	DuplicateId      *string  `json:"duplicateId,omitempty"`
	Ids              []string `json:"ids"`
	IsFavorite       *bool    `json:"isFavorite,omitempty"`
	Latitude         *float64 `json:"latitude,omitempty"`
	Longitude        *float64 `json:"longitude,omitempty"`
	Rating           *int64   `json:"rating,omitempty"`
	TimeZone         *string  `json:"timeZone,omitempty"`
	Visibility       *string  `json:"visibility,omitempty"`
}

type AssetBulkUploadCheckDto added in v0.0.9 

type AssetBulkUploadCheckDto struct {
	Assets []AssetBulkUploadCheckItem `json:"assets"`
}

type AssetBulkUploadCheckItem added in v0.0.9 

type AssetBulkUploadCheckItem struct {
	Checksum string `json:"checksum"`
	Id       string `json:"id"`
}

type AssetBulkUploadCheckResponseDto added in v0.0.9 

type AssetBulkUploadCheckResponseDto struct {
	Results []AssetBulkUploadCheckResult `json:"results"`
}

type AssetBulkUploadCheckResult added in v0.0.9 

type AssetBulkUploadCheckResult struct {
	Action    string `json:"action"`
	AssetId   string `json:"assetId"`
	Id        string `json:"id"`
	IsTrashed bool   `json:"isTrashed"`
	Reason    string `json:"reason"`
}

type AssetCopyDto added in v0.0.9 

type AssetCopyDto struct {
	Albums      bool   `json:"albums"`
	Favorite    bool   `json:"favorite"`
	SharedLinks bool   `json:"sharedLinks"`
	Sidecar     bool   `json:"sidecar"`
	SourceId    string `json:"sourceId"`
	Stack       bool   `json:"stack"`
	TargetId    string `json:"targetId"`
}

type AssetEditActionItemDto added in v0.0.9 

type AssetEditActionItemDto struct {
	Action     string                 `json:"action"`
	Parameters map[string]interface{} `json:"parameters"`
}

type AssetEditActionItemResponseDto added in v0.0.9 

type AssetEditActionItemResponseDto struct {
	Action     string                 `json:"action"`
	Id         string                 `json:"id"`
	Parameters map[string]interface{} `json:"parameters"`
}

type AssetEditsCreateDto added in v0.0.9 

type AssetEditsCreateDto struct {
	Edits []AssetEditActionItemDto `json:"edits"`
}

type AssetEditsResponseDto added in v0.0.9 

type AssetEditsResponseDto struct {
	AssetId string                           `json:"assetId"`
	Edits   []AssetEditActionItemResponseDto `json:"edits"`
}

type AssetFaceCreateDto 

type AssetFaceCreateDto struct {
	AssetId     string `json:"assetId"`
	Height      int64  `json:"height"`
	ImageHeight int64  `json:"imageHeight"`
	ImageWidth  int64  `json:"imageWidth"`
	PersonId    string `json:"personId"`
	Width       int64  `json:"width"`
	X           int64  `json:"x"`
	Y           int64  `json:"y"`
}

type AssetFaceDeleteDto 

type AssetFaceDeleteDto struct {
	Force bool `json:"force"`
}

type AssetFaceResponseDto 

type AssetFaceResponseDto struct {
	BoundingBoxX1 int64             `json:"boundingBoxX1"`
	BoundingBoxX2 int64             `json:"boundingBoxX2"`
	BoundingBoxY1 int64             `json:"boundingBoxY1"`
	BoundingBoxY2 int64             `json:"boundingBoxY2"`
	Id            string            `json:"id"`
	ImageHeight   int64             `json:"imageHeight"`
	ImageWidth    int64             `json:"imageWidth"`
	Person        PersonResponseDto `json:"person"`
	SourceType    string            `json:"sourceType"`
}

type AssetFaceUpdateDto added in v0.0.21 

type AssetFaceUpdateDto struct {
	Data []AssetFaceUpdateItem `json:"data"`
}

type AssetFaceUpdateItem added in v0.0.21 

type AssetFaceUpdateItem struct {
	AssetId  string `json:"assetId"`
	PersonId string `json:"personId"`
}

type AssetIdErrorReason added in v0.0.24 

type AssetIdErrorReason string
const (
	AssetIdErrorReasonduplicate     AssetIdErrorReason = "duplicate"
	AssetIdErrorReasonno_permission AssetIdErrorReason = "no_permission"
	AssetIdErrorReasonnot_found     AssetIdErrorReason = "not_found"
)

type AssetIdsDto added in v0.0.24 

type AssetIdsDto struct {
	AssetIds []string `json:"assetIds"`
}

type AssetIdsResponseDto added in v0.0.24 

type AssetIdsResponseDto struct {
	AssetId string             `json:"assetId"`
	Error   AssetIdErrorReason `json:"error"`
	Success bool               `json:"success"`
}

type AssetJobsDto added in v0.0.9 

type AssetJobsDto struct {
	AssetIds []string `json:"assetIds"`
	Name     string   `json:"name"`
}

type AssetMediaCreateDto 

type AssetMediaCreateDto struct {
	AssetData        []byte                       `json:"assetData"`
	Duration         int64                        `json:"duration,omitempty"`
	FileCreatedAt    string                       `json:"fileCreatedAt"`
	FileModifiedAt   string                       `json:"fileModifiedAt"`
	Filename         string                       `json:"filename,omitempty"`
	IsFavorite       bool                         `json:"isFavorite,omitempty"`
	LivePhotoVideoId string                       `json:"livePhotoVideoId,omitempty"`
	Metadata         []AssetMetadataUpsertItemDto `json:"metadata,omitempty"`
	SidecarData      string                       `json:"sidecarData,omitempty"`
	Visibility       string                       `json:"visibility,omitempty"`
}

type AssetMediaResponseDto 

type AssetMediaResponseDto struct {
	Id     string `json:"id"`
	Status string `json:"status"`
}

type AssetMetadataBulkDeleteDto added in v0.0.9 

type AssetMetadataBulkDeleteDto struct {
	Items []AssetMetadataBulkDeleteItemDto `json:"items"`
}

type AssetMetadataBulkDeleteItemDto added in v0.0.9 

type AssetMetadataBulkDeleteItemDto struct {
	AssetId string `json:"assetId"`
	Key     string `json:"key"`
}

type AssetMetadataBulkResponseDto added in v0.0.9 

type AssetMetadataBulkResponseDto struct {
	AssetId   string                 `json:"assetId"`
	Key       string                 `json:"key"`
	UpdatedAt string                 `json:"updatedAt"`
	Value     map[string]interface{} `json:"value"`
}

type AssetMetadataBulkUpsertDto added in v0.0.9 

type AssetMetadataBulkUpsertDto struct {
	Items []AssetMetadataBulkUpsertItemDto `json:"items"`
}

type AssetMetadataBulkUpsertItemDto added in v0.0.9 

type AssetMetadataBulkUpsertItemDto struct {
	AssetId string                 `json:"assetId"`
	Key     string                 `json:"key"`
	Value   map[string]interface{} `json:"value"`
}

type AssetMetadataResponseDto added in v0.0.9 

type AssetMetadataResponseDto struct {
	Key       string                 `json:"key"`
	UpdatedAt string                 `json:"updatedAt"`
	Value     map[string]interface{} `json:"value"`
}

type AssetMetadataUpsertDto added in v0.0.9 

type AssetMetadataUpsertDto struct {
	Items []AssetMetadataUpsertItemDto `json:"items"`
}

type AssetMetadataUpsertItemDto 

type AssetMetadataUpsertItemDto struct {
	Key   string                 `json:"key"`
	Value map[string]interface{} `json:"value"`
}

type AssetOcrResponseDto added in v0.0.9 

type AssetOcrResponseDto struct {
	AssetId   string  `json:"assetId"`
	BoxScore  float64 `json:"boxScore"`
	Id        string  `json:"id"`
	Text      string  `json:"text"`
	TextScore float64 `json:"textScore"`
	X1        float64 `json:"x1"`
	X2        float64 `json:"x2"`
	X3        float64 `json:"x3"`
	X4        float64 `json:"x4"`
	Y1        float64 `json:"y1"`
	Y2        float64 `json:"y2"`
	Y3        float64 `json:"y3"`
	Y4        float64 `json:"y4"`
}

type AssetOrder added in v0.0.15 

type AssetOrder string
const (
	AssetOrderasc  AssetOrder = "asc"
	AssetOrderdesc AssetOrder = "desc"
)

type AssetResponseDto 

type AssetResponseDto struct {
	Checksum         string                `json:"checksum"`
	CreatedAt        string                `json:"createdAt"`
	DuplicateId      string                `json:"duplicateId"`
	Duration         int64                 `json:"duration"`
	ExifInfo         ExifResponseDto       `json:"exifInfo"`
	FileCreatedAt    string                `json:"fileCreatedAt"`
	FileModifiedAt   string                `json:"fileModifiedAt"`
	HasMetadata      bool                  `json:"hasMetadata"`
	Height           int64                 `json:"height"`
	Id               string                `json:"id"`
	IsArchived       bool                  `json:"isArchived"`
	IsEdited         bool                  `json:"isEdited"`
	IsFavorite       bool                  `json:"isFavorite"`
	IsOffline        bool                  `json:"isOffline"`
	IsTrashed        bool                  `json:"isTrashed"`
	LibraryId        string                `json:"libraryId"`
	LivePhotoVideoId string                `json:"livePhotoVideoId"`
	LocalDateTime    string                `json:"localDateTime"`
	OriginalFileName string                `json:"originalFileName"`
	OriginalMimeType string                `json:"originalMimeType"`
	OriginalPath     string                `json:"originalPath"`
	Owner            UserResponseDto       `json:"owner"`
	OwnerId          string                `json:"ownerId"`
	People           []PersonResponseDto   `json:"people"`
	Resized          bool                  `json:"resized"`
	Stack            AssetStackResponseDto `json:"stack"`
	Tags             []TagResponseDto      `json:"tags"`
	Thumbhash        string                `json:"thumbhash"`
	Type             string                `json:"type"`
	UpdatedAt        string                `json:"updatedAt"`
	Visibility       string                `json:"visibility"`
	Width            int64                 `json:"width"`
}

type AssetStackResponseDto 

type AssetStackResponseDto struct {
	AssetCount     int64  `json:"assetCount"`
	Id             string `json:"id"`
	PrimaryAssetId string `json:"primaryAssetId"`
}

type AssetStatsResponseDto 

type AssetStatsResponseDto struct {
	Images int64 `json:"images"`
	Total  int64 `json:"total"`
	Videos int64 `json:"videos"`
}

type AssetVisibility added in v0.0.16 

type AssetVisibility string
const (
	AssetVisibilityarchive  AssetVisibility = "archive"
	AssetVisibilitytimeline AssetVisibility = "timeline"
	AssetVisibilityhidden   AssetVisibility = "hidden"
	AssetVisibilitylocked   AssetVisibility = "locked"
)

type AvatarUpdate added in v0.0.15 

type AvatarUpdate struct {
	Color UserAvatarColor `json:"color"`
}

type BulkIdResponseDto added in v0.0.3 

type BulkIdResponseDto struct {
	Error        string `json:"error"`
	ErrorMessage string `json:"errorMessage"`
	Id           string `json:"id"`
	Success      bool   `json:"success"`
}

type BulkIdsDto added in v0.0.3 

type BulkIdsDto struct {
	Ids []string `json:"ids"`
}

type CalendarHeatmapResponseDto added in v0.0.5 

type CalendarHeatmapResponseDto struct {
	From       string                  `json:"from"`
	Series     []CalendarHeatmapSeries `json:"series"`
	To         string                  `json:"to"`
	TotalCount int64                   `json:"totalCount"`
}

type CalendarHeatmapSeries added in v0.0.15 

type CalendarHeatmapSeries struct {
	Date  string `json:"date"`
	Count int64  `json:"count"`
}

type CalendarHeatmapType added in v0.0.15 

type CalendarHeatmapType string
const (
	CalendarHeatmapTypeUpload CalendarHeatmapType = "Upload"
	CalendarHeatmapTypeTaken  CalendarHeatmapType = "Taken"
)

type CastResponse added in v0.0.15 

type CastResponse struct {
	GCastEnabled bool `json:"gCastEnabled"`
}

type CastUpdate added in v0.0.15 

type CastUpdate struct {
	GCastEnabled bool `json:"gCastEnabled"`
}

type Client 

type Client struct {
	Endpoint   string
	HTTPClient *http.Client
	ApiKey     string
	Token      string
}

func NewClient 

func NewClient(endpoint *string, apikey *string) (*Client, error)

func (*Client) AddAssetsToAlbum added in v0.0.3 

func (c *Client) AddAssetsToAlbum(albumId string, assets BulkIdsDto) ([]BulkIdResponseDto, error)

func (*Client) AddAssetsToAlbums added in v0.0.2 

func (c *Client) AddAssetsToAlbums(data AlbumsAddAssetsDto) (*AlbumsAddAssetsResponseDto, error)

func (*Client) AddSharedLinkAssets added in v0.0.24 

func (c *Client) AddSharedLinkAssets(id string, request AssetIdsDto) ([]AssetIdsResponseDto, error)

func (*Client) AddToken added in v0.0.12 

func (c *Client) AddToken(token string)

func (*Client) AddUsersToAlbum added in v0.0.3 

func (c *Client) AddUsersToAlbum(albumId string, albumUsers AddUsersDto) (*AlbumResponseDto, error)

func (*Client) BulkTagAssets added in v0.0.7 

func (c *Client) BulkTagAssets(request TagBulkAssetsDto) (*TagBulkAssetsResponseDto, error)

func (*Client) CheckBulkUpload added in v0.0.9 

func (c *Client) CheckBulkUpload(request AssetBulkUploadCheckDto) (*AssetBulkUploadCheckResponseDto, error)

func (*Client) CopyAsset added in v0.0.9 

func (c *Client) CopyAsset(request AssetCopyDto) error

func (*Client) CreateActivity 

func (c *Client) CreateActivity(activity ActivityCreateDto) (*ActivityResponseDto, error)

func (*Client) CreateAlbum 

func (c *Client) CreateAlbum(album CreateAlbumDto) (*AlbumResponseDto, error)

func (*Client) CreateApiKey 

func (c *Client) CreateApiKey(apiKey ApiKeyCreateDto) (*ApiKeyCreateResponseDto, error)

func (*Client) CreateFace 

func (c *Client) CreateFace(face AssetFaceCreateDto) (*AssetFaceResponseDto, error)

func (*Client) CreateJob added in v0.0.19 

func (c *Client) CreateJob(request JobCreateDto) error

func (*Client) CreateLibrary 

func (c *Client) CreateLibrary(library CreateLibraryDto) (*LibraryResponseDto, error)

func (*Client) CreatePartner 

func (c *Client) CreatePartner(partner PartnerCreateDto) (*PartnerResponseDto, error)

func (*Client) CreatePerson 

func (c *Client) CreatePerson(person PersonCreateDto) (*PersonResponseDto, error)

func (*Client) CreateProfileImage added in v0.0.15 

func (c *Client) CreateProfileImage(request CreateProfileImageDto) (*CreateProfileImageResponseDto, error)

func (*Client) CreateSession added in v0.0.8 

func (c *Client) CreateSession(request SessionCreateDto) (*SessionResponseDto, error)
func (c *Client) CreateSharedLink(request SharedLinkCreateDto) (*SharedLinkResponseDto, error)

func (*Client) CreateTag 

func (c *Client) CreateTag(tag TagCreateDto) (*TagResponseDto, error)

func (*Client) CreateUserAdmin added in v0.0.5 

func (c *Client) CreateUserAdmin(user UserAdminCreateDto) (*UserAdminResponseDto, error)

func (*Client) CreateWorkflow added in v0.0.7 

func (c *Client) CreateWorkflow(workflow WorkflowCreateDto) (*WorkflowResponseDto, error)

func (*Client) DeleteActivity 

func (c *Client) DeleteActivity(activityId string) error

func (*Client) DeleteAlbum 

func (c *Client) DeleteAlbum(albumId string) error

func (*Client) DeleteAllSessions added in v0.0.8 

func (c *Client) DeleteAllSessions() error

func (*Client) DeleteApiKey 

func (c *Client) DeleteApiKey(apiKeyId string) error

func (*Client) DeleteAssetEdits added in v0.0.9 

func (c *Client) DeleteAssetEdits(assetId string) error

func (*Client) DeleteAssetMetadata added in v0.0.9 

func (c *Client) DeleteAssetMetadata(id string, key string) error

func (*Client) DeleteAssets added in v0.0.9 

func (c *Client) DeleteAssets(request AssetBulkDeleteDto) error

func (*Client) DeleteBulkAssetMetadata added in v0.0.9 

func (c *Client) DeleteBulkAssetMetadata(request AssetMetadataBulkDeleteDto) error

func (*Client) DeleteDatabaseBackups added in v0.0.8 

func (c *Client) DeleteDatabaseBackups(backups DatabaseBackupDeleteDto) error

func (*Client) DeleteDuplicate added in v0.0.19 

func (c *Client) DeleteDuplicate(id string) error

func (*Client) DeleteDuplicates added in v0.0.19 

func (c *Client) DeleteDuplicates(ids BulkIdsDto) error

func (*Client) DeleteFace 

func (c *Client) DeleteFace(faceId string) error

func (*Client) DeleteLibrary 

func (c *Client) DeleteLibrary(libraryId string) error

func (*Client) DeletePartner 

func (c *Client) DeletePartner(partnerId string) error

func (*Client) DeletePeople added in v0.0.21 

func (c *Client) DeletePeople(ids BulkIdsDto) error

func (*Client) DeletePerson 

func (c *Client) DeletePerson(personId string) error

func (*Client) DeleteProfileImage added in v0.0.15 

func (c *Client) DeleteProfileImage() error

func (*Client) DeleteSession added in v0.0.8 

func (c *Client) DeleteSession(id string) error

func (*Client) DeleteSyncAck added in v0.0.12 

func (c *Client) DeleteSyncAck(types SyncAckDeleteDto) error

func (*Client) DeleteTag 

func (c *Client) DeleteTag(tagId string) error

func (*Client) DeleteUserAdmin added in v0.0.5 

func (c *Client) DeleteUserAdmin(Id string) error

func (*Client) DeleteUserLicense added in v0.0.15 

func (c *Client) DeleteUserLicense() error

func (*Client) DeleteUserOnboarding added in v0.0.15 

func (c *Client) DeleteUserOnboarding() error

func (*Client) DeleteWorkflow added in v0.0.7 

func (c *Client) DeleteWorkflow(id string) error

func (*Client) DownloadArchive added in v0.0.8 

func (c *Client) DownloadArchive(request DownloadArchiveDto, key *string, slug *string) ([]byte, error)

func (*Client) DownloadAsset added in v0.0.9 

func (c *Client) DownloadAsset(id string, edited *bool, key string, slug string) ([]byte, error)

func (*Client) DownloadDatabaseBackup added in v0.0.8 

func (c *Client) DownloadDatabaseBackup(id string) error

func (*Client) EditAsset added in v0.0.9 

func (c *Client) EditAsset(assetId string, asset AssetEditsCreateDto) (*AssetEditsResponseDto, error)

func (*Client) EmptyQueue added in v0.0.13 

func (c *Client) EmptyQueue(name QueueName, request QueueDeleteDto) error

func (*Client) EmptyTrash added in v0.0.7 

func (c *Client) EmptyTrash() (*TrashResponseDto, error)

func (*Client) EndSession added in v0.0.9 

func (c *Client) EndSession(id string, sessionId string, key string, slug string) error

func (*Client) GetActivities 

func (c *Client) GetActivities(albumId string, assetId *string, level *ReactionLevel, rtype *ReactionType, userId *string) ([]ActivityResponseDto, error)

func (*Client) GetActivityStatistics 

func (c *Client) GetActivityStatistics(albumId string, assetId *string) (*ActivityStatisticsResponseDto, error)

func (*Client) GetAdminOnboarding added in v0.0.8 

func (c *Client) GetAdminOnboarding(id string) (*AdminOnboardingUpdateDto, error)

func (*Client) GetAlbumInfo added in v0.0.2 

func (c *Client) GetAlbumInfo(albumId string) (*AlbumResponseDto, error)

func (*Client) GetAlbumMapMarkers added in v0.0.3 

func (c *Client) GetAlbumMapMarkers(albumId string, key string, slug string) ([]MapMarkerResponseDto, error)

func (*Client) GetAlbumStatistics added in v0.0.3 

func (c *Client) GetAlbumStatistics() (*AlbumStatisticsResponseDto, error)

func (*Client) GetAllAlbums added in v0.0.2 

func (c *Client) GetAllAlbums() ([]AlbumResponseDto, error)

func (*Client) GetAllLibraries added in v0.0.6 

func (c *Client) GetAllLibraries() ([]LibraryResponseDto, error)

func (*Client) GetAllPeople added in v0.0.21 

func (c *Client) GetAllPeople(closestAssetId *string, closestPersonId *string, page *int64, size *int64, withHidden *bool) (PeopleResponseDto, error)

XXX Update this to handle pages 

func (c *Client) GetAllSharedLinks(albumId *string, id *string) ([]SharedLinkResponseDto, error)

func (*Client) GetAllTags added in v0.0.7 

func (c *Client) GetAllTags() ([]TagResponseDto, error)

func (*Client) GetApiKey 

func (c *Client) GetApiKey(apiKeyId string) (*ApiKeyResponseDto, error)

func (*Client) GetApiKeys 

func (c *Client) GetApiKeys() ([]ApiKeyResponseDto, error)

func (*Client) GetAssetDuplicates added in v0.0.19 

func (c *Client) GetAssetDuplicates() ([]DuplicateResponseDto, error)

func (*Client) GetAssetEdits added in v0.0.9 

func (c *Client) GetAssetEdits(assetId string) (*AssetEditsResponseDto, error)

func (*Client) GetAssetInfo 

func (c *Client) GetAssetInfo(assetId string, key string, slug string) (*AssetResponseDto, error)

func (*Client) GetAssetMetadata added in v0.0.9 

func (c *Client) GetAssetMetadata(id string) ([]AssetMetadataResponseDto, error)

func (*Client) GetAssetMetadataByKey added in v0.0.9 

func (c *Client) GetAssetMetadataByKey(id string, key string) (*AssetMetadataResponseDto, error)

func (*Client) GetAssetOcr added in v0.0.9 

func (c *Client) GetAssetOcr(id string) ([]AssetOcrResponseDto, error)

func (*Client) GetAssetStatistics 

func (c *Client) GetAssetStatistics(isFavorite *bool, isTrashed *bool, visibility string) (*AssetStatsResponseDto, error)

func (*Client) GetAssetsByOriginalPath 

func (c *Client) GetAssetsByOriginalPath(path string) ([]AssetResponseDto, error)

func (*Client) GetDownloadInfo added in v0.0.8 

func (c *Client) GetDownloadInfo(request DownloadInfoDto, key *string, slug *string) (*DownloadResponseDto, error)

func (*Client) GetFaces 

func (c *Client) GetFaces(id string) ([]AssetFaceResponseDto, error)

func (*Client) GetLibrary 

func (c *Client) GetLibrary(libraryId string) (*LibraryResponseDto, error)

func (*Client) GetLibraryStatistics added in v0.0.6 

func (c *Client) GetLibraryStatistics(libraryId string) (*LibraryStatsResponseDto, error)

func (*Client) GetMainPlaylist added in v0.0.9 

func (c *Client) GetMainPlaylist(id string, key string, slug string) ([]byte, error)

func (*Client) GetMapMarkers 

func (c *Client) GetMapMarkers() ([]MapMarkerResponseDto, error)

func (*Client) GetMediaPlaylist added in v0.0.9 

func (c *Client) GetMediaPlaylist(id string, sessionId string, variantIndex int64, key string, slug string) ([]byte, error)

func (*Client) GetMyApiKey 

func (c *Client) GetMyApiKey() (*ApiKeyResponseDto, error)

func (*Client) GetMyCalendarHeatmap added in v0.0.15 

func (c *Client) GetMyCalendarHeatmap(from *string, to *string, ctype *CalendarHeatmapType) (*CalendarHeatmapResponseDto, error)

func (*Client) GetMyPrefences added in v0.0.15 

func (c *Client) GetMyPrefences() (*UserPreferencesResponseDto, error)
func (c *Client) GetMySharedLink(key *string, slug *string) (*SharedLinkResponseDto, error)

func (*Client) GetMyUser added in v0.0.14 

func (c *Client) GetMyUser() (*UserAdminResponseDto, error)

func (*Client) GetPartners 

func (c *Client) GetPartners(direction PartnerDirection) ([]PartnerResponseDto, error)

func (*Client) GetPerson 

func (c *Client) GetPerson(personId string) (*PersonResponseDto, error)

func (*Client) GetPersonStatistics added in v0.0.21 

func (c *Client) GetPersonStatistics(id string) (*PersonStatisticsResponseDto, error)

func (*Client) GetPersonThumbnail added in v0.0.21 

func (c *Client) GetPersonThumbnail(id string) ([]byte, error)

func (*Client) GetPlugin added in v0.0.22 

func (c *Client) GetPlugin(id string) (*PluginResponseDto, error)

func (*Client) GetProfileImage added in v0.0.15 

func (c *Client) GetProfileImage(id string) ([]byte, error)

func (*Client) GetQueue added in v0.0.13 

func (c *Client) GetQueue(name QueueName) (*QueueResponseDto, error)

func (*Client) GetQueueJobs added in v0.0.13 

func (c *Client) GetQueueJobs(name QueueName, statuses []QueueJobStatus) ([]QueueJobResponseDto, error)

func (*Client) GetQueues added in v0.0.13 

func (c *Client) GetQueues() ([]QueueResponseDto, error)

func (*Client) GetReverseGeocode 

func (c *Client) GetReverseGeocode(lat float64, lon float64) ([]MapReverseGeocodeResponseDto, error)

func (*Client) GetReverseGeocodingState added in v0.0.8 

func (c *Client) GetReverseGeocodingState() (*ReverseGeocodingStateResponseDto, error)

func (*Client) GetSegment added in v0.0.9 

func (c *Client) GetSegment(filename string, id string, sessionId string, variantIndex int64, key string, slug string) ([]byte, error)

func (*Client) GetServerAbout 

func (c *Client) GetServerAbout() (*ServerAboutResponseDto, error)

func (*Client) GetServerConfig 

func (c *Client) GetServerConfig() (*ServerConfigDto, error)

func (*Client) GetServerFeatures 

func (c *Client) GetServerFeatures() (*ServerFeaturesDto, error)

func (*Client) GetServerLicense 

func (c *Client) GetServerLicense() (*ServerStorageResponseDto, error)

func (*Client) GetServerStorage 

func (c *Client) GetServerStorage() (*ServerStorageResponseDto, error)

func (*Client) GetSessions added in v0.0.8 

func (c *Client) GetSessions() ([]SessionResponseDto, error)

func (*Client) GetSharedLinkById added in v0.0.24 

func (c *Client) GetSharedLinkById(id string) (*SharedLinkResponseDto, error)

func (*Client) GetSyncAck added in v0.0.12 

func (c *Client) GetSyncAck() ([]SyncAckDto, error)

func (*Client) GetSyncStream added in v0.0.12 

func (c *Client) GetSyncStream(request SyncStreamDto) (*nulltype, error)

func (*Client) GetTagById added in v0.0.7 

func (c *Client) GetTagById(tagId string) (*TagResponseDto, error)

func (*Client) GetUniqueOriginalPaths 

func (c *Client) GetUniqueOriginalPaths() ([]string, error)

func (*Client) GetUser 

func (c *Client) GetUser(id string) (*UserResponseDto, error)

func (*Client) GetUserAdmin added in v0.0.5 

func (c *Client) GetUserAdmin(userId string) (*UserAdminResponseDto, error)

func (*Client) GetUserCalendarHeatmapAdmin added in v0.0.5 

func (c *Client) GetUserCalendarHeatmapAdmin(userId string, from *string, to *string, ctype *CalendarHeatmapType) (*CalendarHeatmapResponseDto, error)

func (*Client) GetUserLicense added in v0.0.15 

func (c *Client) GetUserLicense() (*UserLicense, error)

func (*Client) GetUserOnboarding added in v0.0.15 

func (c *Client) GetUserOnboarding() (*OnboardingResponseDto, error)

func (*Client) GetUserPreferencesAdmin added in v0.0.16 

func (c *Client) GetUserPreferencesAdmin(id string) (*UserPreferencesResponseDto, error)

func (*Client) GetUserSessionsAdmin added in v0.0.16 

func (c *Client) GetUserSessionsAdmin(id string) ([]SessionResponseDto, error)

func (*Client) GetUserStatisticsAdmin added in v0.0.16 

func (c *Client) GetUserStatisticsAdmin(id string, isFavorite *bool, isTrashed *bool, visibility *AssetVisibility) (*AssetStatsResponseDto, error)

func (*Client) GetVersionCheckState added in v0.0.8 

func (c *Client) GetVersionCheckState() (*VersionCheckStateResponseDto, error)

func (*Client) GetWorkflow added in v0.0.7 

func (c *Client) GetWorkflow(id string) (*WorkflowResponseDto, error)

func (*Client) GetWorkflowForShare added in v0.0.7 

func (c *Client) GetWorkflowForShare(id string) (*WorkflowShareResponseDto, error)

func (*Client) GetWorkflowTriggers added in v0.0.7 

func (c *Client) GetWorkflowTriggers() ([]WorkflowTriggerResponseDto, error)

func (*Client) ListDatabaseBackups added in v0.0.8 

func (c *Client) ListDatabaseBackups(id string) (DatabaseBackupListResponseDto, error)

func (*Client) LockSession added in v0.0.8 

func (c *Client) LockSession(id string) error

func (*Client) Login added in v0.0.12 

func (c *Client) Login(request LoginCredentialDto) (*LoginResponseDto, error)

func (*Client) MergePerson added in v0.0.21 

func (c *Client) MergePerson(id string, request MergePersonDto) ([]BulkIdResponseDto, error)

func (*Client) PlayAssetVideo added in v0.0.9 

func (c *Client) PlayAssetVideo(id string, key string, slug string) ([]byte, error)

func (*Client) ReassignFaces added in v0.0.21 

func (c *Client) ReassignFaces(id string, request AssetFaceUpdateDto) ([]PersonResponseDto, error)

func (*Client) RemoveAssetFromAlbum added in v0.0.11 

func (c *Client) RemoveAssetFromAlbum(albumId string, assets BulkIdsDto) ([]BulkIdResponseDto, error)
func (c *Client) RemoveSharedLink(id string) error

func (*Client) RemoveSharedLinkAssets added in v0.0.24 

func (c *Client) RemoveSharedLinkAssets(id string, request AssetIdsDto) ([]AssetIdsResponseDto, error)

func (*Client) RemoveUserFromAlbum added in v0.0.3 

func (c *Client) RemoveUserFromAlbum(albumId string, userId string) error

func (*Client) ResolveDuplicates added in v0.0.19 

func (c *Client) ResolveDuplicates(groups DuplicateResolveDto) ([]BulkIdResponseDto, error)

func (*Client) RestoreAssets added in v0.0.7 

func (c *Client) RestoreAssets(request BulkIdsDto) (*TrashResponseDto, error)

func (*Client) RestoreTrash added in v0.0.7 

func (c *Client) RestoreTrash() (*TrashResponseDto, error)

func (*Client) RestoreUserAdmin added in v0.0.16 

func (c *Client) RestoreUserAdmin(id string) (*UserAdminResponseDto, error)

func (*Client) RunAssetJobs added in v0.0.9 

func (c *Client) RunAssetJobs(request AssetJobsDto) error

func (*Client) ScanLibrary added in v0.0.6 

func (c *Client) ScanLibrary(libraryId string) error

func (*Client) SearchPluginMethods added in v0.0.22 

func (c *Client) SearchPluginMethods(description *string, enabled *bool, id *string, name *string, pluginName *string, pluginVersion *string, title *string, trigger *WorkflowTrigger, wtype *WorkflowType) ([]PluginMethodResponseDto, error)

func (*Client) SearchPluginTemplates added in v0.0.22 

func (c *Client) SearchPluginTemplates() ([]PluginTemplateResponseDto, error)

func (*Client) SearchPlugins added in v0.0.22 

func (c *Client) SearchPlugins(description *string, enabled *bool, id *string, name *string, title *string, version *string) ([]PluginResponseDto, error)

func (*Client) SearchUsers added in v0.0.15 

func (c *Client) SearchUsers() ([]UserResponseDto, error)

func (*Client) SearchUsersAdmin added in v0.0.5 

func (c *Client) SearchUsersAdmin() ([]UserAdminResponseDto, error)

func (*Client) SearchWorkflows added in v0.0.7 

func (c *Client) SearchWorkflows(description string, enabled bool, id string, name string, trigger string) ([]WorkflowResponseDto, error)

XXX none of the functions below have been tested yet

func (*Client) SendSyncAck added in v0.0.12 

func (c *Client) SendSyncAck(request SyncAckSetDto) error

func (*Client) SetUserLicense added in v0.0.15 

func (c *Client) SetUserLicense(request LicenseKeyDto) (*UserLicense, error)

func (*Client) SetUserOnboarding added in v0.0.15 

func (c *Client) SetUserOnboarding(request OnboardingDto) (*OnboardingResponseDto, error)

func (*Client) SharedLinkLogin added in v0.0.24 

func (c *Client) SharedLinkLogin(request SharedLinkLoginDto, key *string, slug *string) (*SharedLinkResponseDto, error)

func (*Client) StartDatabaseRestoreFlow added in v0.0.8 

func (c *Client) StartDatabaseRestoreFlow() error

func (*Client) TagAssets added in v0.0.7 

func (c *Client) TagAssets(id string, request BulkIdsDto) ([]BulkIdResponseDto, error)

func (*Client) UntagAssets added in v0.0.7 

func (c *Client) UntagAssets(id string, request BulkIdsDto) ([]BulkIdResponseDto, error)

func (*Client) UpdateAdminOnboarding added in v0.0.8 

func (c *Client) UpdateAdminOnboarding(request AdminOnboardingUpdateDto) error

func (*Client) UpdateAlbumInfo added in v0.0.2 

func (c *Client) UpdateAlbumInfo(albumId string, album UpdateAlbumDto) (*AlbumResponseDto, error)

func (*Client) UpdateAlbumUser added in v0.0.3 

func (c *Client) UpdateAlbumUser(albumId string, userId string, role UpdateAlbumUserDto) error

func (*Client) UpdateApiKey 

func (c *Client) UpdateApiKey(apiKeyId string, apiKey ApiKeyUpdateDto) (*ApiKeyResponseDto, error)

func (*Client) UpdateAsset 

func (c *Client) UpdateAsset(assetId string, asset UpdateAssetDto) (*AssetResponseDto, error)

func (*Client) UpdateAssetMetadata added in v0.0.9 

func (c *Client) UpdateAssetMetadata(id string, request AssetMetadataUpsertDto) ([]AssetMetadataResponseDto, error)

func (*Client) UpdateAssets added in v0.0.9 

func (c *Client) UpdateAssets(request AssetBulkUpdateDto) error

func (*Client) UpdateBulkAssetMetadata added in v0.0.9 

func (c *Client) UpdateBulkAssetMetadata(request AssetMetadataBulkUpsertDto) ([]AssetMetadataBulkResponseDto, error)

func (*Client) UpdateFace 

func (c *Client) UpdateFace(faceId string, face FaceDto) (*AssetFaceResponseDto, error)

func (*Client) UpdateLibrary 

func (c *Client) UpdateLibrary(libraryId string, library UpdateLibraryDto) (*LibraryResponseDto, error)

func (*Client) UpdateMyPrefences added in v0.0.15 

func (c *Client) UpdateMyPrefences(request UserPreferencesUpdateDto) (*UserPreferencesResponseDto, error)

func (*Client) UpdateMyUser added in v0.0.15 

func (c *Client) UpdateMyUser(request UserUpdateMeDto) (*UserAdminResponseDto, error)

func (*Client) UpdatePartner 

func (c *Client) UpdatePartner(partnerId string, partner PartnerUpdateDto) (*PartnerResponseDto, error)

func (*Client) UpdatePeople added in v0.0.21 

func (c *Client) UpdatePeople(request PeopleUpdateDto) ([]BulkIdResponseDto, error)

func (*Client) UpdatePerson 

func (c *Client) UpdatePerson(personId string, person PersonUpdateDto) (*PersonResponseDto, error)

func (*Client) UpdateQueue added in v0.0.13 

func (c *Client) UpdateQueue(name QueueName, request QueueUpdateDto) (*QueueResponseDto, error)

func (*Client) UpdateSession added in v0.0.8 

func (c *Client) UpdateSession(id string, request SessionUpdateDto) (*SessionCreateResponseDto, error)
func (c *Client) UpdateSharedLink(id string, request SharedLinkEditDto) (*SharedLinkResponseDto, error)

func (*Client) UpdateTag 

func (c *Client) UpdateTag(tagId string, tag TagUpdateDto) (*TagResponseDto, error)

func (*Client) UpdateUserAdmin added in v0.0.5 

func (c *Client) UpdateUserAdmin(userId string, user UserAdminUpdateDto) (*UserAdminResponseDto, error)

func (*Client) UpdateUserPreferencesAdmin added in v0.0.16 

func (c *Client) UpdateUserPreferencesAdmin(id string, request UserPreferencesUpdateDto) (*UserPreferencesResponseDto, error)

func (*Client) UpdateWorkflow added in v0.0.7 

func (c *Client) UpdateWorkflow(id string, request WorkflowUpdateDto) (*WorkflowResponseDto, error)

func (*Client) UploadAsset added in v0.0.9 

func (c *Client) UploadAsset(asset AssetMediaCreateDto) (*AssetMediaResponseDto, error)

func (*Client) UploadDatabaseBackup added in v0.0.8 

func (c *Client) UploadDatabaseBackup(request DatabaseBackupUploadDto) error

func (*Client) UpsertTags added in v0.0.7 

func (c *Client) UpsertTags(request TagUpsertDto) ([]TagResponseDto, error)

func (*Client) ValidateLibrary added in v0.0.6 

func (c *Client) ValidateLibrary(libraryId string, request ValidateLibraryDto) (*ValidateLibraryResponseDto, error)

XXX currently untested

func (*Client) ViewAsset added in v0.0.9 

func (c *Client) ViewAsset(id string, isFavorite *bool, edited *bool, key string, size string, slug string) ([]byte, error)

type ContributorCountResponseDto 

type ContributorCountResponseDto struct {
	AssetCount int64  `json:"assetCount"`
	UserId     string `json:"userId"`
}

type CreateAlbumDto 

type CreateAlbumDto struct {
	AlbumName   string               `json:"albumName"`
	AlbumUsers  []AlbumUserCreateDto `json:"albumUsers,omitempty"`
	AssetIds    []string             `json:"assetIds,omitempty"`
	Description string               `json:"description"`
}

type CreateLibraryDto 

type CreateLibraryDto struct {
	ExclusionPatterns []string `json:"exclusionPatterns,omitempty"`
	ImportPaths       []string `json:"importPaths,omitempty"`
	Name              string   `json:"name,omitempty"`
	OwnerId           string   `json:"ownerId,omitempty"`
}

type CreateProfileImageDto added in v0.0.15 

type CreateProfileImageDto struct {
	File []byte `json:"file"`
}

type CreateProfileImageResponseDto added in v0.0.15 

type CreateProfileImageResponseDto struct {
	ProfileChangedAt string `json:"profileChangedAt"`
	ProfileImagePath string `json:"profileImagePath"`
	UserId           string `json:"userId"`
}

type DatabaseBackupConfig added in v0.0.8 

type DatabaseBackupConfig struct {
	CronExpression string `json:"cronExpression"`
	Enabled        bool   `json:"enabled"`
	KeepLastAmount int64  `json:"keepLastAmount"`
}

type DatabaseBackupDeleteDto added in v0.0.8 

type DatabaseBackupDeleteDto struct {
	Backups []string `json:"backups"`
}

type DatabaseBackupDto added in v0.0.8 

type DatabaseBackupDto struct {
	Filename string `json:"filename"`
	Filesize int64  `json:"filesize"`
	Timezone string `json:"timezone"`
}

type DatabaseBackupListResponseDto added in v0.0.8 

type DatabaseBackupListResponseDto struct {
	Backups []DatabaseBackupDto `json:"backups"`
}

type DatabaseBackupUploadDto added in v0.0.8 

type DatabaseBackupUploadDto struct {
	File string `json:"file"`
}

type DownloadArchiveDto added in v0.0.8 

type DownloadArchiveDto struct {
	AssetIds []string `json:"assetIds"`
	Edited   *bool    `json:"edited,omitempty"`
}

type DownloadArchiveInfo added in v0.0.8 

type DownloadArchiveInfo struct {
	AssetIds []string `json:"assetIds"`
	Size     int64    `json:"size"`
}

type DownloadInfoDto added in v0.0.8 

type DownloadInfoDto struct {
	AlbumId     *string  `json:"albumId,omitempty"`
	ArchiveSize *int64   `json:"archiveSize,omitempty"`
	AssetIds    []string `json:"assetIds,omitempty"`
	UserId      *string  `json:"userId,omitempty"`
}

type DownloadResponse added in v0.0.15 

type DownloadResponse struct {
	ArchiveSize           int64 `json:"archiveSize"`
	IncludeEmbeddedVideos bool  `json:"includeEmbeddedVideos"`
}

type DownloadResponseDto added in v0.0.8 

type DownloadResponseDto struct {
	Archives  []DownloadArchiveInfo `json:"archives"`
	TotalSize int64                 `json:"totalSize"`
}

type DownloadUpdate added in v0.0.15 

type DownloadUpdate struct {
	ArchiveSize           int64 `json:"archiveSize"`
	IncludeEmbeddedVideos bool  `json:"includeEmbeddedVideos"`
}

type DuplicateResolveDto added in v0.0.19 

type DuplicateResolveDto struct {
	Groups []DuplicateResolveGroupDto `json:"groups"`
}

type DuplicateResolveGroupDto added in v0.0.19 

type DuplicateResolveGroupDto struct {
	DuplicateId   string   `json:"duplicateId"`
	KeepAssetIds  []string `json:"keepAssetIds"`
	TrashAssetIds []string `json:"trashAssetIds"`
}

type DuplicateResponseDto added in v0.0.19 

type DuplicateResponseDto struct {
	Assets                []AssetResponseDto `json:"assets"`
	DuplicateId           string             `json:"duplicateId"`
	SuggestedKeepAssetIds []string           `json:"suggestedKeepAssetIds"`
}

type EmailNotificationsResponse added in v0.0.15 

type EmailNotificationsResponse struct {
	AlbumInvite bool `json:"albumInvite"`
	AlbumUpdate bool `json:"albumUpdate"`
	Enabled     bool `json:"enabled"`
}

type EmailNotificationsUpdate added in v0.0.15 

type EmailNotificationsUpdate struct {
	AlbumInvite bool `json:"albumInvite"`
	AlbumUpdate bool `json:"albumUpdate"`
	Enabled     bool `json:"enabled"`
}

type ExifResponseDto 

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

type FaceDto 

type FaceDto struct {
	Id string `json:"id"`
}

type FoldersResponse added in v0.0.15 

type FoldersResponse struct {
	Enabled    bool `json:"enabled"`
	SidebarWeb bool `json:"sidebarWeb"`
}

type FoldersUpdate added in v0.0.15 

type FoldersUpdate struct {
	Enabled    bool `json:"enabled"`
	SidebarWeb bool `json:"sidebarWeb"`
}

type JobCreateDto added in v0.0.19 

type JobCreateDto struct {
	Name ManualJobName `json:"name"`
}

type JobName added in v0.0.13 

type JobName string
const (
	JobNameAssetDelete                     JobName = "AssetDelete"
	JobNameAssetDeleteCheck                JobName = "AssetDeleteCheck"
	JobNameAssetDetectFacesQueueAll        JobName = "AssetDetectFacesQueueAll"
	JobNameAssetDetectFaces                JobName = "AssetDetectFaces"
	JobNameAssetDetectDuplicatesQueueAll   JobName = "AssetDetectDuplicatesQueueAll"
	JobNameAssetDetectDuplicates           JobName = "AssetDetectDuplicates"
	JobNameAssetEditThumbnailGeneration    JobName = "AssetEditThumbnailGeneration"
	JobNameAssetEncodeVideoQueueAll        JobName = "AssetEncodeVideoQueueAll"
	JobNameAssetEncodeVideo                JobName = "AssetEncodeVideo"
	JobNameAssetEmptyTrash                 JobName = "AssetEmptyTrash"
	JobNameAssetExtractMetadataQueueAll    JobName = "AssetExtractMetadataQueueAll"
	JobNameAssetExtractMetadata            JobName = "AssetExtractMetadata"
	JobNameAssetFileMigration              JobName = "AssetFileMigration"
	JobNameAssetGenerateThumbnailsQueueAll JobName = "AssetGenerateThumbnailsQueueAll"
	JobNameAssetGenerateThumbnails         JobName = "AssetGenerateThumbnails"
	JobNameAuditTableCleanup               JobName = "AuditTableCleanup"
	JobNameDatabaseBackup                  JobName = "DatabaseBackup"
	JobNameFacialRecognitionQueueAll       JobName = "FacialRecognitionQueueAll"
	JobNameFacialRecognition               JobName = "FacialRecognition"
	JobNameFileDelete                      JobName = "FileDelete"
	JobNameFileMigrationQueueAll           JobName = "FileMigrationQueueAll"
	JobNameLibraryDeleteCheck              JobName = "LibraryDeleteCheck"
	JobNameLibraryDelete                   JobName = "LibraryDelete"
	JobNameLibraryRemoveAsset              JobName = "LibraryRemoveAsset"
	JobNameLibraryScanAssetsQueueAll       JobName = "LibraryScanAssetsQueueAll"
	JobNameLibrarySyncAssets               JobName = "LibrarySyncAssets"
	JobNameLibrarySyncFilesQueueAll        JobName = "LibrarySyncFilesQueueAll"
	JobNameLibrarySyncFiles                JobName = "LibrarySyncFiles"
	JobNameLibraryScanQueueAll             JobName = "LibraryScanQueueAll"
	JobNameHlsSessionCleanup               JobName = "HlsSessionCleanup"
	JobNameMemoryCleanup                   JobName = "MemoryCleanup"
	JobNameMemoryGenerate                  JobName = "MemoryGenerate"
	JobNameNotificationsCleanup            JobName = "NotificationsCleanup"
	JobNameNotifyUserSignup                JobName = "NotifyUserSignup"
	JobNameNotifyAlbumInvite               JobName = "NotifyAlbumInvite"
	JobNameNotifyAlbumUpdate               JobName = "NotifyAlbumUpdate"
	JobNameUserDelete                      JobName = "UserDelete"
	JobNameUserDeleteCheck                 JobName = "UserDeleteCheck"
	JobNameUserSyncUsage                   JobName = "UserSyncUsage"
	JobNamePersonCleanup                   JobName = "PersonCleanup"
	JobNamePersonFileMigration             JobName = "PersonFileMigration"
	JobNamePersonGenerateThumbnail         JobName = "PersonGenerateThumbnail"
	JobNameSessionCleanup                  JobName = "SessionCleanup"
	JobNameSendMail                        JobName = "SendMail"
	JobNameSidecarQueueAll                 JobName = "SidecarQueueAll"
	JobNameSidecarCheck                    JobName = "SidecarCheck"
	JobNameSidecarWrite                    JobName = "SidecarWrite"
	JobNameSmartSearchQueueAll             JobName = "SmartSearchQueueAll"
	JobNameSmartSearch                     JobName = "SmartSearch"
	JobNameStorageTemplateMigration        JobName = "StorageTemplateMigration"
	JobNameStorageTemplateMigrationSingle  JobName = "StorageTemplateMigrationSingle"
	JobNameTagCleanup                      JobName = "TagCleanup"
	JobNameVersionCheck                    JobName = "VersionCheck"
	JobNameOcrQueueAll                     JobName = "OcrQueueAll"
	JobNameOcr                             JobName = "Ocr"
	JobNameWorkflowAssetTrigger            JobName = "WorkflowAssetTrigger"
	JobNameIntegrityUntrackedFilesQueueAll JobName = "IntegrityUntrackedFilesQueueAll"
	JobNameIntegrityUntrackedFiles         JobName = "IntegrityUntrackedFiles"
	JobNameIntegrityUntrackedRefresh       JobName = "IntegrityUntrackedRefresh"
	JobNameIntegrityMissingFilesQueueAll   JobName = "IntegrityMissingFilesQueueAll"
	JobNameIntegrityMissingFiles           JobName = "IntegrityMissingFiles"
	JobNameIntegrityMissingFilesRefresh    JobName = "IntegrityMissingFilesRefresh"
	JobNameIntegrityChecksumFiles          JobName = "IntegrityChecksumFiles"
	JobNameIntegrityChecksumFilesRefresh   JobName = "IntegrityChecksumFilesRefresh"
	JobNameIntegrityDeleteReportType       JobName = "IntegrityDeleteReportType"
	JobNameIntegrityDeleteReports          JobName = "IntegrityDeleteReports"
)

type LibraryResponseDto 

type LibraryResponseDto struct {
	AssetCount        int64    `json:"assetCount"`
	CreatedAt         string   `json:"createdAt"`
	ExclusionPatterns []string `json:"exclusionPatterns"`
	Id                string   `json:"id"`
	ImportPaths       []string `json:"importPaths"`
	Name              string   `json:"name"`
	OwnerId           string   `json:"ownerId"`
	RefreshedAt       string   `json:"refreshedAt"`
	UpdatedAt         string   `json:"updatedAt"`
}

type LibraryStatsResponseDto added in v0.0.6 

type LibraryStatsResponseDto struct {
	Photos int64 `json:"photos"`
	Total  int64 `json:"total"`
	Usage  int64 `json:"usage"`
	Videos int64 `json:"videos"`
}

type LicenseKeyDto added in v0.0.15 

type LicenseKeyDto struct {
	ActivationKey string `json:"activationKey"`
	LicenseKey    string `json:"licenseKey"`
}

type LoginCredentialDto added in v0.0.12 

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

type LoginResponseDto added in v0.0.12 

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 ManualJobName added in v0.0.19 

type ManualJobName string
const (
	ManualJobNamepersoncleanup                      ManualJobName = "person-cleanup"
	ManualJobNametagcleanup                         ManualJobName = "tag-cleanup"
	ManualJobNameusercleanup                        ManualJobName = "user-cleanup"
	ManualJobNamememorycleanup                      ManualJobName = "memory-cleanup"
	ManualJobNamememorycreate                       ManualJobName = "memory-create"
	ManualJobNamebackupdatabase                     ManualJobName = "backup-database"
	ManualJobNameintegritymissingfiles              ManualJobName = "integrity-missing-files"
	ManualJobNameintegrityuntrackedfiles            ManualJobName = "integrity-untracked-files"
	ManualJobNameintegritychecksummismatch          ManualJobName = "integrity-checksum-mismatch"
	ManualJobNameintegritymissingfilesrefresh       ManualJobName = "integrity-missing-files-refresh"
	ManualJobNameintegrityuntrackedfilesrefresh     ManualJobName = "integrity-untracked-files-refresh"
	ManualJobNameintegritychecksummismatchrefresh   ManualJobName = "integrity-checksum-mismatch-refresh"
	ManualJobNameintegritymissingfilesdeleteall     ManualJobName = "integrity-missing-files-delete-all"
	ManualJobNameintegrityuntrackedfilesdeleteall   ManualJobName = "integrity-untracked-files-delete-all"
	ManualJobNameintegritychecksummismatchdeleteall ManualJobName = "integrity-checksum-mismatch-delete-all"
)

type MapMarkerResponseDto 

type MapMarkerResponseDto struct {
	City    string  `json:"city"`
	Country string  `json:"country"`
	Id      string  `json:"id"`
	Lat     float64 `json:"lat"`
	Lon     float64 `json:"lon"`
	State   string  `json:"state"`
}

type MapReverseGeocodeResponseDto 

type MapReverseGeocodeResponseDto struct {
	City    string `json:"city"`
	Country string `json:"country"`
	State   string `json:"state"`
}

type MemoriesResponse added in v0.0.15 

type MemoriesResponse struct {
	Duration int64 `json:"duration"`
	Enabled  bool  `json:"enabled"`
}

type MemoriesUpdate added in v0.0.15 

type MemoriesUpdate struct {
	Duration int64 `json:"duration"`
	Enabled  bool  `json:"enabled"`
}

type MergePersonDto added in v0.0.21 

type MergePersonDto struct {
	Ids []string `json:"ids"`
}

type OnboardingDto added in v0.0.15 

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

type OnboardingResponseDto added in v0.0.15 

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

type Owner 

type Owner struct {
	ID               string `json:"id"`
	Email            string `json:"email"`
	Name             string `json:"name"`
	ProfileImagePath string `json:"profileImagePath"`
	AvatarColor      string `json:"avatarColor"`
	ProfileChangedAt string `json:"profileChangedAt"`
}

type PartnerCreateDto 

type PartnerCreateDto struct {
	SharedWithId string `json:"sharedWithId"`
}

type PartnerDirection added in v0.0.14 

type PartnerDirection string
const (
	PartnerDirectionsharedby   PartnerDirection = "shared-by"
	PartnerDirectionsharedwith PartnerDirection = "shared-with"
)

type PartnerResponseDto 

type PartnerResponseDto struct {
	AvatarColor      UserAvatarColor `json:"avatarColor"`
	Email            string          `json:"email"`
	Id               string          `json:"id"`
	InTimeline       bool            `json:"inTimeline"`
	Name             string          `json:"name"`
	ProfileChangedAt string          `json:"profileChangedAt"`
	ProfileImagePath string          `json:"profileImagePath"`
}

type PartnerUpdateDto 

type PartnerUpdateDto struct {
	InTimeline bool `json:"inTimeline"`
}

type PeopleResponse added in v0.0.15 

type PeopleResponse struct {
	Enabled      bool  `json:"enabled"`
	MinimumFaces int64 `json:"minimumFaces"`
	SidebarWeb   bool  `json:"sidebarWeb"`
}

type PeopleResponseDto 

type PeopleResponseDto struct {
	HasNextPage bool                `json:"hasNextPage"`
	Hidden      int64               `json:"hidden"`
	People      []PersonResponseDto `json:"people"`
	Total       int64               `json:"total"`
}

type PeopleUpdate added in v0.0.15 

type PeopleUpdate struct {
	Enabled      bool  `json:"enabled"`
	MinimumFaces int64 `json:"minimumFaces"`
	SidebarWeb   bool  `json:"sidebarWeb"`
}

type PeopleUpdateDto added in v0.0.21 

type PeopleUpdateDto struct {
	People []PeopleUpdateItem `json:"people"`
}

type PeopleUpdateItem 

type PeopleUpdateItem struct {
	BirthDate          *string `json:"birthDate,omitempty"`
	Color              *string `json:"color,omitempty"`
	FeatureFaceAssetId *string `json:"featureFaceAssetId,omitempty"`
	Id                 string  `json:"id"`
	IsFavorite         *bool   `json:"isFavorite,omitempty"`
	IsHidden           *bool   `json:"isHidden,omitempty"`
	Name               *string `json:"name,omitempty"`
}

type PersonCreateDto 

type PersonCreateDto struct {
	BirthDate  *string `json:"birthDate,omitempty"`
	Color      *string `json:"color,omitempty"`
	IsFavorite *bool   `json:"isFavorite,omitempty"`
	IsHidden   *bool   `json:"isHidden,omitempty"`
	Name       *string `json:"name,omitempty"`
}

type PersonResponseDto 

type PersonResponseDto struct {
	BirthDate     string `json:"birthDate"`
	Color         string `json:"color"`
	Id            string `json:"id"`
	IsFavorite    bool   `json:"isFavorite"`
	IsHidden      bool   `json:"isHidden"`
	Name          string `json:"name"`
	ThumbnailPath string `json:"thumbnailPath"`
	UpdatedAt     string `json:"updatedAt"`
}

type PersonStatisticsResponseDto added in v0.0.21 

type PersonStatisticsResponseDto struct {
	Assets int64 `json:"assets"`
}

type PersonUpdateDto 

type PersonUpdateDto struct {
	BirthDate          *string `json:"birthDate,omitempty"`
	Color              *string `json:"color,omitempty"`
	FeatureFaceAssetId *string `json:"featureFaceAssetId,omitempty"`
	IsFavorite         *bool   `json:"isFavorite,omitempty"`
	IsHidden           *bool   `json:"isHidden,omitempty"`
	Name               *string `json:"name,omitempty"`
}

type PluginMethodResponseDto added in v0.0.22 

type PluginMethodResponseDto struct {
	Description   string                 `json:"description"`
	HostFunctions bool                   `json:"hostFunctions"`
	Key           string                 `json:"key"`
	Name          string                 `json:"name"`
	Schema        map[string]interface{} `json:"schema"`
	Title         string                 `json:"title"`
	Types         []WorkflowType         `json:"types"`
	UiHints       []string               `json:"uiHints"`
}

type PluginResponseDto added in v0.0.22 

type PluginResponseDto struct {
	Author      string                    `json:"author"`
	CreatedAt   string                    `json:"createdAt"`
	Description string                    `json:"description"`
	Id          string                    `json:"id"`
	Methods     []PluginMethodResponseDto `json:"methods"`
	Name        string                    `json:"name"`
	Title       string                    `json:"title"`
	UpdatedAt   string                    `json:"updatedAt"`
	Version     string                    `json:"version"`
}

type PluginTemplateResponseDto added in v0.0.22 

type PluginTemplateResponseDto struct {
	Description string                          `json:"description"`
	Key         string                          `json:"key"`
	Steps       []PluginTemplateStepResponseDto `json:"steps"`
	Title       string                          `json:"title"`
	Trigger     WorkflowTrigger                 `json:"trigger"`
	UiHints     []string                        `json:"uiHints"`
}

type PluginTemplateStepResponseDto added in v0.0.22 

type PluginTemplateStepResponseDto struct {
	Config  map[string]interface{} `json:"config"`
	Enabled bool                   `json:"enabled"`
	Method  string                 `json:"method"`
}

type PurchaseResponse added in v0.0.15 

type PurchaseResponse struct {
	HideBuyButtonUntil string `json:"hideBuyButtonUntil"`
	ShowSupportBadge   bool   `json:"showSupportBadge"`
}

type PurchaseUpdate added in v0.0.15 

type PurchaseUpdate struct {
	HideBuyButtonUntil string `json:"hideBuyButtonUntil"`
	ShowSupportBadge   bool   `json:"showSupportBadge"`
}

type QueueDeleteDto added in v0.0.13 

type QueueDeleteDto struct {
	Failed bool `json:"failed"`
}

type QueueJobResponseDto added in v0.0.13 

type QueueJobResponseDto struct {
	Data      map[string]interface{} `json:"data"`
	Id        string                 `json:"id"`
	Name      JobName                `json:"name"`
	Timestamp int64                  `json:"timestamp"`
}

type QueueJobStatus added in v0.0.13 

type QueueJobStatus string
const (
	QueueJobStatusactive    QueueJobStatus = "active"
	QueueJobStatusfailed    QueueJobStatus = "failed"
	QueueJobStatuscompleted QueueJobStatus = "completed"
	QueueJobStatusdelayed   QueueJobStatus = "delayed"
	QueueJobStatuswaiting   QueueJobStatus = "waiting"
	QueueJobStatuspaused    QueueJobStatus = "paused"
)

type QueueName added in v0.0.13 

type QueueName string
const (
	QueueNamethumbnailGeneration      QueueName = "thumbnailGeneration"
	QueueNamemetadataExtraction       QueueName = "metadataExtraction"
	QueueNamevideoConversion          QueueName = "videoConversion"
	QueueNamefaceDetection            QueueName = "faceDetection"
	QueueNamefacialRecognition        QueueName = "facialRecognition"
	QueueNamesmartSearch              QueueName = "smartSearch"
	QueueNameduplicateDetection       QueueName = "duplicateDetection"
	QueueNamebackgroundTask           QueueName = "backgroundTask"
	QueueNamestorageTemplateMigration QueueName = "storageTemplateMigration"
	QueueNamemigration                QueueName = "migration"
	QueueNamesearch                   QueueName = "search"
	QueueNamesidecar                  QueueName = "sidecar"
	QueueNamelibrary                  QueueName = "library"
	QueueNamenotifications            QueueName = "notifications"
	QueueNamebackupDatabase           QueueName = "backupDatabase"
	QueueNameocr                      QueueName = "ocr"
	QueueNameworkflow                 QueueName = "workflow"
	QueueNameintegrityCheck           QueueName = "integrityCheck"
	QueueNameeditor                   QueueName = "editor"
)

type QueueResponseDto added in v0.0.13 

type QueueResponseDto struct {
	IsPaused   bool               `json:"isPaused"`
	Name       QueueName          `json:"name"`
	Statistics QueueStatisticsDto `json:"statistics"`
}

type QueueStatisticsDto added in v0.0.13 

type QueueStatisticsDto struct {
	Active    int64 `json:"active"`
	Completed int64 `json:"completed"`
	Delayed   int64 `json:"delayed"`
	Failed    int64 `json:"failed"`
	Paused    int64 `json:"paused"`
	Waiting   int64 `json:"waiting"`
}

type QueueUpdateDto added in v0.0.13 

type QueueUpdateDto struct {
	IsPaused bool `json:"isPaused"`
}

type RatingsResponse added in v0.0.15 

type RatingsResponse struct {
	Enabled bool `json:"enabled"`
}

type RatingsUpdate added in v0.0.15 

type RatingsUpdate struct {
	Enabled bool `json:"enabled"`
}

type ReactionLevel added in v0.0.18 

type ReactionLevel string
const (
	ReactionLevelalbum ReactionLevel = "album"
	ReactionLevelasset ReactionLevel = "asset"
)

type ReactionType added in v0.0.18 

type ReactionType string
const (
	ReactionTypecomment ReactionType = "comment"
	ReactionTypelike    ReactionType = "like"
)

type RecentlyAddedResponse added in v0.0.15 

type RecentlyAddedResponse struct {
	SidebarWeb bool `json:"sidebarWeb"`
}

type RecentlyAddedUpdate added in v0.0.15 

type RecentlyAddedUpdate struct {
	SidebarWeb bool `json:"sidebarWeb"`
}

type ReverseGeocodingStateResponseDto added in v0.0.8 

type ReverseGeocodingStateResponseDto struct {
	LastImportFileName string `json:"lastImportFileName"`
	LastUpdate         string `json:"lastUpdate"`
}

type ServerAboutResponseDto 

type ServerAboutResponseDto struct {
	Build                      string `json:"build"`
	BuildImage                 string `json:"buildImage"`
	BuildImageUrl              string `json:"buildImageUrl"`
	BuildUrl                   string `json:"buildUrl"`
	Exiftool                   string `json:"exiftool"`
	Ffmpeg                     string `json:"ffmpeg"`
	Imagemagick                string `json:"imagemagick"`
	Libvips                    string `json:"libvips"`
	Licensed                   bool   `json:"licensed"`
	Nodejs                     string `json:"nodejs"`
	Repository                 string `json:"repository"`
	RepositoryUrl              string `json:"repositoryUrl"`
	SourceCommit               string `json:"sourceCommit"`
	SourceRef                  string `json:"sourceRef"`
	SourceUrl                  string `json:"sourceUrl"`
	ThirdPartyBugFeatureUrl    string `json:"thirdPartyBugFeatureUrl"`
	ThirdPartyDocumentationUrl string `json:"thirdPartyDocumentationUrl"`
	ThirdPartySourceUrl        string `json:"thirdPartySourceUrl"`
	ThirdPartySupportUrl       string `json:"thirdPartySupportUrl"`
	Version                    string `json:"version"`
	VersionUrl                 string `json:"versionUrl"`
}

type ServerConfigDto 

type ServerConfigDto struct {
	ExternalDomain   string `json:"externalDomain"`
	IsInitialized    bool   `json:"isInitialized"`
	IsOnboarded      bool   `json:"isOnboarded"`
	LoginPageMessage string `json:"loginPageMessage"`
	MaintenanceMode  bool   `json:"maintenanceMode"`
	MapDarkStyleUrl  string `json:"mapDarkStyleUrl"`
	MapLightStyleUrl string `json:"mapLightStyleUrl"`
	MinFaces         int64  `json:"minFaces"`
	OauthButtonText  string `json:"oauthButtonText"`
	PublicUsers      bool   `json:"publicUsers"`
	TrashDays        int64  `json:"trashDays"`
	UserDeleteDelay  int64  `json:"userDeleteDelay"`
}

type ServerFeaturesDto 

type ServerFeaturesDto struct {
	ConfigFile          bool `json:"configFile"`
	DuplicateDetection  bool `json:"duplicateDetection"`
	Email               bool `json:"email"`
	FacialRecognition   bool `json:"facialRecognition"`
	ImportFaces         bool `json:"importFaces"`
	Map                 bool `json:"map"`
	Oauth               bool `json:"oauth"`
	OauthAutoLaunch     bool `json:"oauthAutoLaunch"`
	Ocr                 bool `json:"ocr"`
	PasswordLogin       bool `json:"passwordLogin"`
	RealtimeTranscoding bool `json:"realtimeTranscoding"`
	ReverseGeocoding    bool `json:"reverseGeocoding"`
	Search              bool `json:"search"`
	Sidecar             bool `json:"sidecar"`
	SmartSearch         bool `json:"smartSearch"`
	Trash               bool `json:"trash"`
}

type ServerStorageResponseDto 

type ServerStorageResponseDto struct {
	DiskAvailable       string `json:"diskAvailable"`
	DiskAvailableRaw    int64  `json:"diskAvailableRaw"`
	DiskSize            string `json:"diskSize"`
	DiskSizeRaw         int64  `json:"diskSizeRaw"`
	DiskUsagePercentage int64  `json:"diskUsagePercentage"`
	DiskUse             string `json:"diskUse"`
	DiskUseRaw          int64  `json:"diskUseRaw"`
}

type SessionCreateDto added in v0.0.8 

type SessionCreateDto struct {
	DeviceOS   string `json:"deviceOS"`
	DeviceType string `json:"deviceType"`
	Duration   int64  `json:"duration"`
}

type SessionCreateResponseDto added in v0.0.8 

type SessionCreateResponseDto struct {
	AppVersion         string `json:"appVersion"`
	CreatedAt          string `json:"createdAt"`
	Current            bool   `json:"current"`
	DeviceOS           string `json:"deviceOS"`
	DeviceType         string `json:"deviceType"`
	ExpiresAt          string `json:"expiresAt"`
	Id                 string `json:"id"`
	IsPendingSyncReset bool   `json:"isPendingSyncReset"`
	Token              string `json:"token"`
	UpdatedAt          string `json:"updatedAt"`
}

type SessionResponseDto added in v0.0.8 

type SessionResponseDto struct {
	AppVersion         string `json:"appVersion"`
	CreatedAt          string `json:"createdAt"`
	Current            bool   `json:"current"`
	DeviceOS           string `json:"deviceOS"`
	DeviceType         string `json:"deviceType"`
	ExpiresAt          string `json:"expiresAt"`
	Id                 string `json:"id"`
	IsPendingSyncReset bool   `json:"isPendingSyncReset"`
	UpdatedAt          string `json:"updatedAt"`
}

type SessionUpdateDto added in v0.0.8 

type SessionUpdateDto struct {
	IsPendingSyncReset bool `json:"isPendingSyncReset"`
}

type SharedLinkCreateDto added in v0.0.24 

type SharedLinkCreateDto struct {
	AlbumId       *string        `json:"albumId,omitempty"`
	AllowDownload *bool          `json:"allowDownload,omitempty"`
	AllowUpload   *bool          `json:"allowUpload,omitempty"`
	AssetIds      []string       `json:"assetIds,omitempty"`
	Description   *string        `json:"description,omitempty"`
	ExpiresAt     *string        `json:"expiresAt,omitempty"`
	Password      *string        `json:"password,omitempty"`
	ShowMetadata  *bool          `json:"showMetadata,omitempty"`
	Slug          *string        `json:"slug,omitempty"`
	Type          SharedLinkType `json:"type"`
}

type SharedLinkEditDto added in v0.0.24 

type SharedLinkEditDto struct {
	AllowDownload *bool   `json:"allowDownload,omitempty"`
	AllowUpload   *bool   `json:"allowUpload,omitempty"`
	Description   *string `json:"description,omitempty"`
	ExpiresAt     *string `json:"expiresAt,omitempty"`
	Password      *string `json:"password,omitempty"`
	ShowMetadata  *bool   `json:"showMetadata,omitempty"`
	Slug          *string `json:"slug,omitempty"`
}

type SharedLinkLoginDto added in v0.0.24 

type SharedLinkLoginDto struct {
	Password string `json:"password"`
}

type SharedLinkResponseDto added in v0.0.24 

type SharedLinkResponseDto struct {
	Album         AlbumResponseDto   `json:"album"`
	AllowDownload bool               `json:"allowDownload"`
	AllowUpload   bool               `json:"allowUpload"`
	Assets        []AssetResponseDto `json:"assets"`
	CreatedAt     string             `json:"createdAt"`
	Description   string             `json:"description"`
	ExpiresAt     string             `json:"expiresAt"`
	Id            string             `json:"id"`
	Key           string             `json:"key"`
	Password      string             `json:"password"`
	ShowMetadata  bool               `json:"showMetadata"`
	Slug          string             `json:"slug"`
	Type          SharedLinkType     `json:"type"`
	UserId        string             `json:"userId"`
}

type SharedLinkType added in v0.0.24 

type SharedLinkType string
const (
	SharedLinkTypeALBUM      SharedLinkType = "ALBUM"
	SharedLinkTypeINDIVIDUAL SharedLinkType = "INDIVIDUAL"
)

type SharedLinksResponse added in v0.0.15 

type SharedLinksResponse struct {
	Enabled    bool `json:"enabled"`
	SidebarWeb bool `json:"sidebarWeb"`
}

type SharedLinksUpdate added in v0.0.15 

type SharedLinksUpdate struct {
	Enabled    bool `json:"enabled"`
	SidebarWeb bool `json:"sidebarWeb"`
}

type SyncAckDeleteDto added in v0.0.12 

type SyncAckDeleteDto struct {
	Types []SyncEntityType `json:"types"`
}

type SyncAckDto added in v0.0.12 

type SyncAckDto struct {
	Ack  string         `json:"ack"`
	Type SyncEntityType `json:"type"`
}

type SyncAckSetDto added in v0.0.12 

type SyncAckSetDto struct {
	Acks []string `json:"acks"`
}

type SyncEntityType added in v0.0.12 

type SyncEntityType string
const (
	SyncEntityTypeAuthUserV1                 SyncEntityType = "AuthUserV1"
	SyncEntityTypeUserV1                     SyncEntityType = "UserV1"
	SyncEntityTypeUserDeleteV1               SyncEntityType = "UserDeleteV1"
	SyncEntityTypeAssetV1                    SyncEntityType = "AssetV1"
	SyncEntityTypeAssetV2                    SyncEntityType = "AssetV2"
	SyncEntityTypeAssetDeleteV1              SyncEntityType = "AssetDeleteV1"
	SyncEntityTypeAssetExifV1                SyncEntityType = "AssetExifV1"
	SyncEntityTypeAssetEditV1                SyncEntityType = "AssetEditV1"
	SyncEntityTypeAssetEditDeleteV1          SyncEntityType = "AssetEditDeleteV1"
	SyncEntityTypeAssetMetadataV1            SyncEntityType = "AssetMetadataV1"
	SyncEntityTypeAssetMetadataDeleteV1      SyncEntityType = "AssetMetadataDeleteV1"
	SyncEntityTypeAssetOcrV1                 SyncEntityType = "AssetOcrV1"
	SyncEntityTypeAssetOcrDeleteV1           SyncEntityType = "AssetOcrDeleteV1"
	SyncEntityTypePartnerV1                  SyncEntityType = "PartnerV1"
	SyncEntityTypePartnerDeleteV1            SyncEntityType = "PartnerDeleteV1"
	SyncEntityTypePartnerAssetV1             SyncEntityType = "PartnerAssetV1"
	SyncEntityTypePartnerAssetV2             SyncEntityType = "PartnerAssetV2"
	SyncEntityTypePartnerAssetBackfillV1     SyncEntityType = "PartnerAssetBackfillV1"
	SyncEntityTypePartnerAssetBackfillV2     SyncEntityType = "PartnerAssetBackfillV2"
	SyncEntityTypePartnerAssetDeleteV1       SyncEntityType = "PartnerAssetDeleteV1"
	SyncEntityTypePartnerAssetExifV1         SyncEntityType = "PartnerAssetExifV1"
	SyncEntityTypePartnerAssetExifBackfillV1 SyncEntityType = "PartnerAssetExifBackfillV1"
	SyncEntityTypePartnerStackBackfillV1     SyncEntityType = "PartnerStackBackfillV1"
	SyncEntityTypePartnerStackDeleteV1       SyncEntityType = "PartnerStackDeleteV1"
	SyncEntityTypePartnerStackV1             SyncEntityType = "PartnerStackV1"
	SyncEntityTypeAlbumV1                    SyncEntityType = "AlbumV1"
	SyncEntityTypeAlbumV2                    SyncEntityType = "AlbumV2"
	SyncEntityTypeAlbumDeleteV1              SyncEntityType = "AlbumDeleteV1"
	SyncEntityTypeAlbumUserV1                SyncEntityType = "AlbumUserV1"
	SyncEntityTypeAlbumUserBackfillV1        SyncEntityType = "AlbumUserBackfillV1"
	SyncEntityTypeAlbumUserDeleteV1          SyncEntityType = "AlbumUserDeleteV1"
	SyncEntityTypeAlbumAssetCreateV1         SyncEntityType = "AlbumAssetCreateV1"
	SyncEntityTypeAlbumAssetCreateV2         SyncEntityType = "AlbumAssetCreateV2"
	SyncEntityTypeAlbumAssetUpdateV1         SyncEntityType = "AlbumAssetUpdateV1"
	SyncEntityTypeAlbumAssetUpdateV2         SyncEntityType = "AlbumAssetUpdateV2"
	SyncEntityTypeAlbumAssetBackfillV1       SyncEntityType = "AlbumAssetBackfillV1"
	SyncEntityTypeAlbumAssetBackfillV2       SyncEntityType = "AlbumAssetBackfillV2"
	SyncEntityTypeAlbumAssetExifCreateV1     SyncEntityType = "AlbumAssetExifCreateV1"
	SyncEntityTypeAlbumAssetExifUpdateV1     SyncEntityType = "AlbumAssetExifUpdateV1"
	SyncEntityTypeAlbumAssetExifBackfillV1   SyncEntityType = "AlbumAssetExifBackfillV1"
	SyncEntityTypeAlbumToAssetV1             SyncEntityType = "AlbumToAssetV1"
	SyncEntityTypeAlbumToAssetDeleteV1       SyncEntityType = "AlbumToAssetDeleteV1"
	SyncEntityTypeAlbumToAssetBackfillV1     SyncEntityType = "AlbumToAssetBackfillV1"
	SyncEntityTypeMemoryV1                   SyncEntityType = "MemoryV1"
	SyncEntityTypeMemoryDeleteV1             SyncEntityType = "MemoryDeleteV1"
	SyncEntityTypeMemoryToAssetV1            SyncEntityType = "MemoryToAssetV1"
	SyncEntityTypeMemoryToAssetDeleteV1      SyncEntityType = "MemoryToAssetDeleteV1"
	SyncEntityTypeStackV1                    SyncEntityType = "StackV1"
	SyncEntityTypeStackDeleteV1              SyncEntityType = "StackDeleteV1"
	SyncEntityTypePersonV1                   SyncEntityType = "PersonV1"
	SyncEntityTypePersonDeleteV1             SyncEntityType = "PersonDeleteV1"
	SyncEntityTypeAssetFaceV1                SyncEntityType = "AssetFaceV1"
	SyncEntityTypeAssetFaceV2                SyncEntityType = "AssetFaceV2"
	SyncEntityTypeAssetFaceDeleteV1          SyncEntityType = "AssetFaceDeleteV1"
	SyncEntityTypeUserMetadataV1             SyncEntityType = "UserMetadataV1"
	SyncEntityTypeUserMetadataDeleteV1       SyncEntityType = "UserMetadataDeleteV1"
	SyncEntityTypeSyncAckV1                  SyncEntityType = "SyncAckV1"
	SyncEntityTypeSyncResetV1                SyncEntityType = "SyncResetV1"
	SyncEntityTypeSyncCompleteV1             SyncEntityType = "SyncCompleteV1"
)

type SyncRequestType added in v0.0.12 

type SyncRequestType string
const (
	SyncRequestTypeAlbumsV1            SyncRequestType = "AlbumsV1"
	SyncRequestTypeAlbumsV2            SyncRequestType = "AlbumsV2"
	SyncRequestTypeAlbumUsersV1        SyncRequestType = "AlbumUsersV1"
	SyncRequestTypeAlbumToAssetsV1     SyncRequestType = "AlbumToAssetsV1"
	SyncRequestTypeAlbumAssetsV1       SyncRequestType = "AlbumAssetsV1"
	SyncRequestTypeAlbumAssetsV2       SyncRequestType = "AlbumAssetsV2"
	SyncRequestTypeAlbumAssetExifsV1   SyncRequestType = "AlbumAssetExifsV1"
	SyncRequestTypeAssetsV1            SyncRequestType = "AssetsV1"
	SyncRequestTypeAssetsV2            SyncRequestType = "AssetsV2"
	SyncRequestTypeAssetExifsV1        SyncRequestType = "AssetExifsV1"
	SyncRequestTypeAssetEditsV1        SyncRequestType = "AssetEditsV1"
	SyncRequestTypeAssetMetadataV1     SyncRequestType = "AssetMetadataV1"
	SyncRequestTypeAssetOcrV1          SyncRequestType = "AssetOcrV1"
	SyncRequestTypeAuthUsersV1         SyncRequestType = "AuthUsersV1"
	SyncRequestTypeMemoriesV1          SyncRequestType = "MemoriesV1"
	SyncRequestTypeMemoryToAssetsV1    SyncRequestType = "MemoryToAssetsV1"
	SyncRequestTypePartnersV1          SyncRequestType = "PartnersV1"
	SyncRequestTypePartnerAssetsV1     SyncRequestType = "PartnerAssetsV1"
	SyncRequestTypePartnerAssetsV2     SyncRequestType = "PartnerAssetsV2"
	SyncRequestTypePartnerAssetExifsV1 SyncRequestType = "PartnerAssetExifsV1"
	SyncRequestTypePartnerStacksV1     SyncRequestType = "PartnerStacksV1"
	SyncRequestTypeStacksV1            SyncRequestType = "StacksV1"
	SyncRequestTypeUsersV1             SyncRequestType = "UsersV1"
	SyncRequestTypePeopleV1            SyncRequestType = "PeopleV1"
	SyncRequestTypeAssetFacesV1        SyncRequestType = "AssetFacesV1"
	SyncRequestTypeAssetFacesV2        SyncRequestType = "AssetFacesV2"
	SyncRequestTypeUserMetadataV1      SyncRequestType = "UserMetadataV1"
)

type SyncStreamDto added in v0.0.12 

type SyncStreamDto struct {
	Reset bool              `json:"reset"`
	Types []SyncRequestType `json:"types"`
}

type TagBulkAssetsDto added in v0.0.7 

type TagBulkAssetsDto struct {
	AssetIds []string `json:"assetIds"`
	TagIds   []string `json:"tagIds"`
}

type TagBulkAssetsResponseDto added in v0.0.7 

type TagBulkAssetsResponseDto struct {
	Count int64 `json:"count"`
}

type TagCreateDto 

type TagCreateDto struct {
	Color    string `json:"color"`
	Name     string `json:"name"`
	ParentId string `json:"parentId,omitempty"`
}

type TagResponseDto 

type TagResponseDto struct {
	Color     string `json:"color"`
	CreatedAt string `json:"createdAt"`
	Id        string `json:"id"`
	Name      string `json:"name"`
	ParentId  string `json:"parentId"`
	UpdatedAt string `json:"updatedAt"`
	Value     string `json:"value"`
}

type TagUpdateDto 

type TagUpdateDto struct {
	Color string `json:"color"`
}

type TagUpsertDto added in v0.0.7 

type TagUpsertDto struct {
	Tags []string `json:"tags"`
}

type TagsResponse added in v0.0.15 

type TagsResponse struct {
	Enabled    bool `json:"enabled"`
	SidebarWeb bool `json:"sidebarWeb"`
}

type TagsUpdate added in v0.0.15 

type TagsUpdate struct {
	Enabled    bool `json:"enabled"`
	SidebarWeb bool `json:"sidebarWeb"`
}

type TrashResponseDto added in v0.0.7 

type TrashResponseDto struct {
	Count int64 `json:"count"`
}

These methods are untested

type UpdateAlbumDto 

type UpdateAlbumDto struct {
	AlbumName             string `json:"albumName,omitempty"`
	AlbumThumbnailAssetId string `json:"albumThumbnailAssetId,omitempty"`
	Description           string `json:"description,omitempty"`
	IsActivityEnabled     bool   `json:"isActivityEnabled,omitempty"`
	Order                 string `json:"order,omitempty"`
}

type UpdateAlbumUserDto added in v0.0.3 

type UpdateAlbumUserDto struct {
	Role string `json:"role"`
}

type UpdateAssetDto 

type UpdateAssetDto struct {
	DateTimeOriginal string `json:"dateTimeOriginal,omitempty"`
	Description      string `json:"description,omitempty"`
	IsFavorite       *bool  `json:"isFavorite,omitempty"`
	Latitude         int64  `json:"latitude,omitempty"`
	LivePhotoVideoId string `json:"livePhotoVideoId,omitempty"`
	Longitude        int64  `json:"longitude,omitempty"`
	Rating           int64  `json:"rating,omitempty"`
	Visibility       string `json:"visibility,omitempty"`
}

type UpdateLibraryDto 

type UpdateLibraryDto struct {
	ExclusionPatterns []string `json:"exclusionPatterns,omitempty"`
	ImportPaths       []string `json:"importPaths,omitempty"`
	Name              string   `json:"name,omitempty"`
}

type UserAdminCreateDto 

type UserAdminCreateDto struct {
	AvatarColor          string `json:"avatarColor,omitempty"`
	Email                string `json:"email"`
	IsAdmin              bool   `json:"isAdmin"`
	Name                 string `json:"name"`
	Notify               bool   `json:"notify"`
	Password             string `json:"password"`
	PinCode              string `json:"pinCode,omitempty"`
	QuotaSizeInBytes     int64  `json:"quotaSizeInBytes,omitempty"`
	ShouldChangePassword bool   `json:"shouldChangePassword"`
	StorageLabel         string `json:"storageLabel,omitempty"`
}

type UserAdminDeleteDto 

type UserAdminDeleteDto struct {
	Force bool `json:"force"`
}

type UserAdminResponseDto 

type UserAdminResponseDto struct {
	AvatarColor          string      `json:"avatarColor"`
	CreatedAt            string      `json:"createdAt"`
	DeletedAt            string      `json:"deletedAt"`
	Email                string      `json:"email"`
	Id                   string      `json:"id"`
	IsAdmin              bool        `json:"isAdmin"`
	License              UserLicense `json:"license"`
	Name                 string      `json:"name"`
	OauthId              string      `json:"oauthId"`
	ProfileChangedAt     string      `json:"profileChangedAt"`
	ProfileImagePath     string      `json:"profileImagePath"`
	QuotaSizeInBytes     int64       `json:"quotaSizeInBytes"`
	QuotaUsageInBytes    int64       `json:"quotaUsageInBytes"`
	ShouldChangePassword bool        `json:"shouldChangePassword"`
	Status               string      `json:"status"`
	StorageLabel         string      `json:"storageLabel"`
	UpdatedAt            string      `json:"updatedAt"`
}

type UserAdminUpdateDto 

type UserAdminUpdateDto struct {
	AvatarColor          string `json:"avatarColor,omitempty"`
	Email                string `json:"email,omitempty"`
	IsAdmin              bool   `json:"isAdmin,omitempty"`
	Name                 string `json:"name,omitempty"`
	Password             string `json:"password,omitempty"`
	PinCode              string `json:"pinCode,omitempty"`
	QuotaSizeInBytes     int64  `json:"quotaSizeInBytes,omitempty"`
	ShouldChangePassword bool   `json:"shouldChangePassword,omitempty"`
	StorageLabel         string `json:"storageLabel,omitempty"`
}

type UserAvatarColor added in v0.0.14 

type UserAvatarColor string
const (
	UserAvatarColorprimary UserAvatarColor = "primary"
	UserAvatarColorpink    UserAvatarColor = "pink"
	UserAvatarColorred     UserAvatarColor = "red"
	UserAvatarColoryellow  UserAvatarColor = "yellow"
	UserAvatarColorblue    UserAvatarColor = "blue"
	UserAvatarColorgreen   UserAvatarColor = "green"
	UserAvatarColorpurple  UserAvatarColor = "purple"
	UserAvatarColororange  UserAvatarColor = "orange"
	UserAvatarColorgray    UserAvatarColor = "gray"
	UserAvatarColoramber   UserAvatarColor = "amber"
)

type UserLicense 

type UserLicense struct {
	ActivatedAt   string `json:"activatedAt"`
	ActivationKey string `json:"activationKey"`
	LicenseKey    string `json:"licenseKey"`
}

type UserPreferencesResponseDto added in v0.0.15 

type UserPreferencesResponseDto struct {
	Albums             AlbumsResponse             `json:"albums"`
	Cast               CastResponse               `json:"cast"`
	Download           DownloadResponse           `json:"download"`
	EmailNotifications EmailNotificationsResponse `json:"emailNotifications"`
	Folders            FoldersResponse            `json:"folders"`
	Memories           MemoriesResponse           `json:"memories"`
	People             PeopleResponse             `json:"people"`
	Purchase           PurchaseResponse           `json:"purchase"`
	Ratings            RatingsResponse            `json:"ratings"`
	RecentlyAdded      RecentlyAddedResponse      `json:"recentlyAdded"`
	SharedLinks        SharedLinksResponse        `json:"sharedLinks"`
	Tags               TagsResponse               `json:"tags"`
}

type UserPreferencesUpdateDto added in v0.0.15 

type UserPreferencesUpdateDto struct {
	Albums             *AlbumsUpdate             `json:"albums,omitempty"`
	Avatar             *AvatarUpdate             `json:"avatar,omitempty"`
	Cast               *CastUpdate               `json:"cast,omitempty"`
	Download           *DownloadUpdate           `json:"download,omitempty"`
	EmailNotifications *EmailNotificationsUpdate `json:"emailNotifications,omitempty"`
	Folders            *FoldersUpdate            `json:"folders,omitempty"`
	Memories           *MemoriesUpdate           `json:"memories,omitempty"`
	People             *PeopleUpdate             `json:"people,omitempty"`
	Purchase           *PurchaseUpdate           `json:"purchase,omitempty"`
	Ratings            *RatingsUpdate            `json:"ratings,omitempty"`
	RecentlyAdded      *RecentlyAddedUpdate      `json:"recentlyAdded,omitempty"`
	SharedLinks        *SharedLinksUpdate        `json:"sharedLinks,omitempty"`
	Tags               *TagsUpdate               `json:"tags,omitempty"`
}

type UserResponseDto 

type UserResponseDto struct {
	AvatarColor      UserAvatarColor `json:"avatarColor"`
	Email            string          `json:"email"`
	Id               string          `json:"id"`
	Name             string          `json:"name"`
	ProfileChangedAt string          `json:"profileChangedAt"`
	ProfileImagePath string          `json:"profileImagePath"`
}

type UserUpdateMeDto added in v0.0.15 

type UserUpdateMeDto struct {
	AvatarColor UserAvatarColor `json:"avatarColor,omitempty"`
	Email       string          `json:"email,omitempty"`
	Name        string          `json:"name,omitempty"`
	Password    string          `json:"password,omitempty"`
}

type ValidateLibraryDto added in v0.0.6 

type ValidateLibraryDto struct {
	ExclusionPatterns []string `json:"exclusionPatterns"`
	ImportPaths       []string `json:"importPaths"`
}

type ValidateLibraryImportPathResponseDto added in v0.0.6 

type ValidateLibraryImportPathResponseDto struct {
	ImportPath string `json:"importPath"`
	IsValid    bool   `json:"isValid"`
	Message    string `json:"message"`
}

type ValidateLibraryResponseDto added in v0.0.6 

type ValidateLibraryResponseDto struct {
	ImportPaths []ValidateLibraryImportPathResponseDto `json:"importPaths"`
}

type VersionCheckStateResponseDto added in v0.0.8 

type VersionCheckStateResponseDto struct {
	CheckedAt      string `json:"checkedAt"`
	ReleaseVersion string `json:"releaseVersion"`
}

type WorkflowCreateDto added in v0.0.7 

type WorkflowCreateDto struct {
	Description string            `json:"description"`
	Enabled     bool              `json:"enabled"`
	Name        string            `json:"name"`
	Steps       []WorkflowStepDto `json:"steps"`
	Trigger     string            `json:"trigger"`
}

type WorkflowResponseDto added in v0.0.7 

type WorkflowResponseDto struct {
	CreatedAt   string            `json:"createdAt"`
	Description string            `json:"description"`
	Enabled     bool              `json:"enabled"`
	Id          string            `json:"id"`
	Name        string            `json:"name"`
	Steps       []WorkflowStepDto `json:"steps"`
	Trigger     string            `json:"trigger"`
	UpdatedAt   string            `json:"updatedAt"`
}

type WorkflowShareResponseDto added in v0.0.7 

type WorkflowShareResponseDto struct {
	Description string                 `json:"description"`
	Name        string                 `json:"name"`
	Steps       []WorkflowShareStepDto `json:"steps"`
	Trigger     string                 `json:"trigger"`
}

type WorkflowShareStepDto added in v0.0.7 

type WorkflowShareStepDto struct {
	Config  string `json:"config"`
	Enabled bool   `json:"enabled"`
	Method  string `json:"method"`
}

type WorkflowStepDto added in v0.0.7 

type WorkflowStepDto struct {
	Config  string `json:"config"`
	Enabled bool   `json:"enabled"`
	Method  string `json:"method"`
}

type WorkflowTrigger added in v0.0.22 

type WorkflowTrigger string
const (
	WorkflowTriggerAssetCreate             WorkflowTrigger = "AssetCreate"
	WorkflowTriggerAssetMetadataExtraction WorkflowTrigger = "AssetMetadataExtraction"
)

type WorkflowTriggerResponseDto added in v0.0.7 

type WorkflowTriggerResponseDto struct {
	Trigger string   `json:"trigger"`
	Types   []string `json:"types"`
}

type WorkflowType added in v0.0.22 

type WorkflowType string
const (
	WorkflowTypeAssetV1 WorkflowType = "AssetV1"
)

type WorkflowUpdateDto added in v0.0.7 

type WorkflowUpdateDto struct {
	Description string            `json:"description"`
	Enabled     bool              `json:"enabled"`
	Name        string            `json:"name"`
	Steps       []WorkflowStepDto `json:"steps"`
	Trigger     string            `json:"trigger"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.