plexgo

Feb 11, 2025

Changes in this version

type Library

+ func (s *Library) GetAllMediaLibrary(ctx context.Context, request operations.GetAllMediaLibraryRequest, ...) (*operations.GetAllMediaLibraryResponse, error)

Feb 8, 2025

Changes in this version

type Library

+ func (s *Library) GetActorsLibrary(ctx context.Context, sectionKey int, ...) (*operations.GetActorsLibraryResponse, error)

+ func (s *Library) GetMediaMetaData(ctx context.Context, request operations.GetMediaMetaDataRequest, ...) (*operations.GetMediaMetaDataResponse, error)

Feb 7, 2025

Changes in this version

type PlexAPI

+ Users *Users

+ type Users struct

+ func (s *Users) GetUsers(ctx context.Context, request operations.GetUsersRequest, ...) (*operations.GetUsersResponse, error)

Feb 6, 2025

Changes in this version

type Library

+ func (s *Library) GetCountriesLibrary(ctx context.Context, sectionKey int, opts ...operations.Option) (*operations.GetCountriesLibraryResponse, error)

+ func (s *Library) GetGenresLibrary(ctx context.Context, sectionKey int, opts ...operations.Option) (*operations.GetGenresLibraryResponse, error)

Oct 3, 2024

Changes in this version

type Library

+ func (s *Library) GetSearchAllLibraries(ctx context.Context, request operations.GetSearchAllLibrariesRequest, ...) (*operations.GetSearchAllLibrariesResponse, error)

type SDKOption

+ func WithDeviceNickname(deviceNickname string) SDKOption

+ func WithPlatform(platform string) SDKOption

Sep 26, 2024

Changes in this version

type Hubs

+ func (s *Hubs) GetRecentlyAdded(ctx context.Context, request operations.GetRecentlyAddedRequest, ...) (*operations.GetRecentlyAddedResponse, error)

type Library

+ func (s *Library) GetRecentlyAddedLibrary(ctx context.Context, request operations.GetRecentlyAddedLibraryRequest, ...) (*operations.GetRecentlyAddedLibraryResponse, error)

Sep 18, 2024

Changes in this version

type SDKOption

+ func WithClientPlatform(clientPlatform string) SDKOption

Sep 18, 2024

Changes in this version

type SDKOption

+ func WithClientID(clientID string) SDKOption

+ func WithClientName(clientName string) SDKOption

+ func WithClientVersion(clientVersion string) SDKOption

+ func WithDeviceName(deviceName string) SDKOption

+ func WithXPlexPlatform(xPlexPlatform string) SDKOption

Sep 13, 2024

Changes in this version

+ func Pointer[T any](v T) *T

Sep 9, 2024

Changes in this version

type Authentication

+ func (s *Authentication) GetTokenDetails(ctx context.Context, opts ...operations.Option) (*operations.GetTokenDetailsResponse, error)

Sep 9, 2024

Changes in this version

type Authentication

+ func (s *Authentication) GetUserDetails(ctx context.Context, xPlexToken string, opts ...operations.Option) (*operations.GetUserDetailsResponse, error)

+ func (s *Authentication) PostUsersSignInData(ctx context.Context, xPlexClientIdentifier *string, ...) (*operations.PostUsersSignInDataResponse, error)

type Library

+ func (s *Library) GetAllLibraries(ctx context.Context, opts ...operations.Option) (*operations.GetAllLibrariesResponse, error)

+ func (s *Library) GetLibraryDetails(ctx context.Context, sectionKey int, includeDetails *operations.IncludeDetails, ...) (*operations.GetLibraryDetailsResponse, error)

+ func (s *Library) GetMetaDataByRatingKey(ctx context.Context, ratingKey int64, opts ...operations.Option) (*operations.GetMetaDataByRatingKeyResponse, error)

+ func (s *Library) GetRefreshLibraryMetadata(ctx context.Context, sectionKey int, force *operations.Force, ...) (*operations.GetRefreshLibraryMetadataResponse, error)

+ func (s *Library) GetSearchLibrary(ctx context.Context, sectionKey int, type_ operations.QueryParamType, ...) (*operations.GetSearchLibraryResponse, error)

type Media

+ func (s *Media) GetBannerImage(ctx context.Context, request operations.GetBannerImageRequest, ...) (*operations.GetBannerImageResponse, error)

+ func (s *Media) GetThumbImage(ctx context.Context, request operations.GetThumbImageRequest, ...) (*operations.GetThumbImageResponse, error)

type Plex

+ func (s *Plex) GetCompanionsData(ctx context.Context, opts ...operations.Option) (*operations.GetCompanionsDataResponse, error)

+ func (s *Plex) GetGeoData(ctx context.Context, opts ...operations.Option) (*operations.GetGeoDataResponse, error)

+ func (s *Plex) GetServerResources(ctx context.Context, request operations.GetServerResourcesRequest, ...) (*operations.GetServerResourcesResponse, error)

+ func (s *Plex) GetTokenByPinID(ctx context.Context, pinID int64, xPlexClientIdentifier *string, ...) (*operations.GetTokenByPinIDResponse, error)

+ func (s *Plex) GetUserFriends(ctx context.Context, opts ...operations.Option) (*operations.GetUserFriendsResponse, error)

type SDKOption

+ func WithTimeout(timeout time.Duration) SDKOption

type Server

+ func (s *Server) GetMediaProviders(ctx context.Context, xPlexToken string, opts ...operations.Option) (*operations.GetMediaProvidersResponse, error)

type Watchlist

+ func (s *Watchlist) GetWatchList(ctx context.Context, request operations.GetWatchListRequest, ...) (*operations.GetWatchListResponse, error)

Jun 22, 2024

Changes in this version

type Library

+ func (s *Library) GetTopWatchedContent(ctx context.Context, type_ int64, includeGuids *int64) (*operations.GetTopWatchedContentResponse, error)

type Statistics

+ func (s *Statistics) GetBandwidthStatistics(ctx context.Context, timespan *int64) (*operations.GetBandwidthStatisticsResponse, error)

+ func (s *Statistics) GetResourcesStatistics(ctx context.Context, timespan *int64) (*operations.GetResourcesStatisticsResponse, error)

Jun 15, 2024

Changes in this version

type Plex

+ func (s *Plex) GetHomeData(ctx context.Context) (*operations.GetHomeDataResponse, error)

type PlexAPI

+ Watchlist *Watchlist

+ type Watchlist struct

+ func (s *Watchlist) GetWatchlist(ctx context.Context, request operations.GetWatchlistRequest, ...) (*operations.GetWatchlistResponse, error)

Mar 29, 2024

Changes in this version

type SDKOption

+ func WithXPlexClientIdentifier(xPlexClientIdentifier string) SDKOption

Feb 24, 2024

Changes in this version

+ type Authentication struct

+ func (s *Authentication) GetSourceConnectionInformation(ctx context.Context, source string) (*operations.GetSourceConnectionInformationResponse, error)

+ func (s *Authentication) GetTransientToken(ctx context.Context, type_ operations.GetTransientTokenQueryParamType, ...) (*operations.GetTransientTokenResponse, error)

type PlexAPI

+ Authentication *Authentication

Feb 23, 2024

Changes in this version

type PlexAPI

+ Statistics *Statistics

+ type Statistics struct

+ func (s *Statistics) GetStatistics(ctx context.Context, timespan *int64) (*operations.GetStatisticsResponse, error)

Feb 5, 2024

Changes in this version

type Plex

+ func (s *Plex) GetPin(ctx context.Context, xPlexClientIdentifier string, strong *bool, ...) (*operations.GetPinResponse, error)

+ func (s *Plex) GetToken(ctx context.Context, pinID string, xPlexClientIdentifier string, ...) (*operations.GetTokenResponse, error)

Feb 1, 2024

Changes in this version

type SDKOption

+ func WithSecuritySource(security func(context.Context) (components.Security, error)) SDKOption

Jan 31, 2024

Changes in this version

+ type Plex struct

+ Tv *Tv

type PlexAPI

+ Plex *Plex

+ type Tv struct

+ func (s *Tv) GetPin(ctx context.Context, xPlexClientIdentifier string, strong *bool, ...) (*operations.GetPinResponse, error)

+ func (s *Tv) GetToken(ctx context.Context, pinID string, xPlexClientIdentifier string, ...) (*operations.GetTokenResponse, error)

Jan 23, 2024

Changes in this version

type Library

+ func (s *Library) SearchLibrary(ctx context.Context, sectionID int64, type_ operations.Type) (*operations.SearchLibraryResponse, error)

Jan 5, 2024

Changes in this version

+ var ServerList = []string

+ func Bool(b bool) *bool

+ func Float32(f float32) *float32

+ func Float64(f float64) *float64

+ func Int(i int) *int

+ func Int64(i int64) *int64

+ func String(s string) *string

+ type Activities struct

+ func (s *Activities) CancelServerActivities(ctx context.Context, activityUUID string) (*operations.CancelServerActivitiesResponse, error)

+ func (s *Activities) GetServerActivities(ctx context.Context) (*operations.GetServerActivitiesResponse, error)

+ type Butler struct

+ func (s *Butler) GetButlerTasks(ctx context.Context) (*operations.GetButlerTasksResponse, error)

+ func (s *Butler) StartAllTasks(ctx context.Context) (*operations.StartAllTasksResponse, error)

+ func (s *Butler) StartTask(ctx context.Context, taskName operations.TaskName) (*operations.StartTaskResponse, error)

+ func (s *Butler) StopAllTasks(ctx context.Context) (*operations.StopAllTasksResponse, error)

+ func (s *Butler) StopTask(ctx context.Context, taskName operations.PathParamTaskName) (*operations.StopTaskResponse, error)

+ type HTTPClient interface

+ Do func(req *http.Request) (*http.Response, error)

+ type Hubs struct

+ func (s *Hubs) GetGlobalHubs(ctx context.Context, count *float64, onlyTransient *operations.OnlyTransient) (*operations.GetGlobalHubsResponse, error)

+ func (s *Hubs) GetLibraryHubs(ctx context.Context, sectionID float64, count *float64, ...) (*operations.GetLibraryHubsResponse, error)

+ type Library struct

+ func (s *Library) DeleteLibrary(ctx context.Context, sectionID float64) (*operations.DeleteLibraryResponse, error)

+ func (s *Library) GetCommonLibraryItems(ctx context.Context, sectionID float64, type_ float64, filter *string) (*operations.GetCommonLibraryItemsResponse, error)

+ func (s *Library) GetFileHash(ctx context.Context, url_ string, type_ *float64) (*operations.GetFileHashResponse, error)

+ func (s *Library) GetLatestLibraryItems(ctx context.Context, sectionID float64, type_ float64, filter *string) (*operations.GetLatestLibraryItemsResponse, error)

+ func (s *Library) GetLibraries(ctx context.Context) (*operations.GetLibrariesResponse, error)

+ func (s *Library) GetLibrary(ctx context.Context, sectionID float64, ...) (*operations.GetLibraryResponse, error)

+ func (s *Library) GetLibraryItems(ctx context.Context, sectionID float64, type_ *float64, filter *string) (*operations.GetLibraryItemsResponse, error)

+ func (s *Library) GetMetadata(ctx context.Context, ratingKey float64) (*operations.GetMetadataResponse, error)

+ func (s *Library) GetMetadataChildren(ctx context.Context, ratingKey float64) (*operations.GetMetadataChildrenResponse, error)

+ func (s *Library) GetOnDeck(ctx context.Context) (*operations.GetOnDeckResponse, error)

+ func (s *Library) GetRecentlyAdded(ctx context.Context) (*operations.GetRecentlyAddedResponse, error)

+ func (s *Library) RefreshLibrary(ctx context.Context, sectionID float64) (*operations.RefreshLibraryResponse, error)

+ type Log struct

+ func (s *Log) EnablePaperTrail(ctx context.Context) (*operations.EnablePaperTrailResponse, error)

+ func (s *Log) LogLine(ctx context.Context, level operations.Level, message string, source string) (*operations.LogLineResponse, error)

+ func (s *Log) LogMultiLine(ctx context.Context) (*operations.LogMultiLineResponse, error)

+ type Media struct

+ func (s *Media) MarkPlayed(ctx context.Context, key float64) (*operations.MarkPlayedResponse, error)

+ func (s *Media) MarkUnplayed(ctx context.Context, key float64) (*operations.MarkUnplayedResponse, error)

+ func (s *Media) UpdatePlayProgress(ctx context.Context, key string, time float64, state string) (*operations.UpdatePlayProgressResponse, error)

+ type Playlists struct

+ func (s *Playlists) AddPlaylistContents(ctx context.Context, playlistID float64, uri string, playQueueID float64) (*operations.AddPlaylistContentsResponse, error)

+ func (s *Playlists) ClearPlaylistContents(ctx context.Context, playlistID float64) (*operations.ClearPlaylistContentsResponse, error)

+ func (s *Playlists) CreatePlaylist(ctx context.Context, request operations.CreatePlaylistRequest) (*operations.CreatePlaylistResponse, error)

+ func (s *Playlists) DeletePlaylist(ctx context.Context, playlistID float64) (*operations.DeletePlaylistResponse, error)

+ func (s *Playlists) GetPlaylist(ctx context.Context, playlistID float64) (*operations.GetPlaylistResponse, error)

+ func (s *Playlists) GetPlaylistContents(ctx context.Context, playlistID float64, type_ float64) (*operations.GetPlaylistContentsResponse, error)

+ func (s *Playlists) GetPlaylists(ctx context.Context, playlistType *operations.PlaylistType, ...) (*operations.GetPlaylistsResponse, error)

+ func (s *Playlists) UpdatePlaylist(ctx context.Context, playlistID float64) (*operations.UpdatePlaylistResponse, error)

+ func (s *Playlists) UploadPlaylist(ctx context.Context, path string, force operations.Force) (*operations.UploadPlaylistResponse, error)

+ type PlexAPI struct

+ Activities *Activities

+ Butler *Butler

+ Hubs *Hubs

+ Library *Library

+ Log *Log

+ Media *Media

+ Playlists *Playlists

+ Search *Search

+ Security *Security

+ Server *Server

+ Sessions *Sessions

+ Updater *Updater

+ Video *Video

+ func New(opts ...SDKOption) *PlexAPI

+ type SDKOption func(*PlexAPI)

+ func WithClient(client HTTPClient) SDKOption

+ func WithIP(ip string) SDKOption

+ func WithPort(port string) SDKOption

+ func WithProtocol(protocol ServerProtocol) SDKOption

+ func WithRetryConfig(retryConfig utils.RetryConfig) SDKOption

+ func WithSecurity(accessToken string) SDKOption

+ func WithServerIndex(serverIndex int) SDKOption

+ func WithServerURL(serverURL string) SDKOption

+ func WithTemplatedServerURL(serverURL string, params map[string]string) SDKOption

+ type Search struct

+ func (s *Search) GetSearchResults(ctx context.Context, query string) (*operations.GetSearchResultsResponse, error)

+ func (s *Search) PerformSearch(ctx context.Context, query string, sectionID *float64, limit *float64) (*operations.PerformSearchResponse, error)

+ func (s *Search) PerformVoiceSearch(ctx context.Context, query string, sectionID *float64, limit *float64) (*operations.PerformVoiceSearchResponse, error)

+ type Security struct

+ func (s *Security) GetSourceConnectionInformation(ctx context.Context, source string) (*operations.GetSourceConnectionInformationResponse, error)

+ func (s *Security) GetTransientToken(ctx context.Context, type_ operations.QueryParamType, scope operations.Scope) (*operations.GetTransientTokenResponse, error)

+ type Server struct

+ func (s *Server) GetAvailableClients(ctx context.Context) (*operations.GetAvailableClientsResponse, error)

+ func (s *Server) GetDevices(ctx context.Context) (*operations.GetDevicesResponse, error)

+ func (s *Server) GetMyPlexAccount(ctx context.Context) (*operations.GetMyPlexAccountResponse, error)

+ func (s *Server) GetResizedPhoto(ctx context.Context, request operations.GetResizedPhotoRequest) (*operations.GetResizedPhotoResponse, error)

+ func (s *Server) GetServerCapabilities(ctx context.Context) (*operations.GetServerCapabilitiesResponse, error)

+ func (s *Server) GetServerIdentity(ctx context.Context) (*operations.GetServerIdentityResponse, error)

+ func (s *Server) GetServerList(ctx context.Context) (*operations.GetServerListResponse, error)

+ func (s *Server) GetServerPreferences(ctx context.Context) (*operations.GetServerPreferencesResponse, error)

+ type ServerProtocol string

+ const ServerProtocolHTTP

+ const ServerProtocolHTTPS

+ func (e *ServerProtocol) UnmarshalJSON(data []byte) error

+ func (e ServerProtocol) ToPointer() *ServerProtocol

+ type Sessions struct

+ func (s *Sessions) GetSessionHistory(ctx context.Context) (*operations.GetSessionHistoryResponse, error)

+ func (s *Sessions) GetSessions(ctx context.Context) (*operations.GetSessionsResponse, error)

+ func (s *Sessions) GetTranscodeSessions(ctx context.Context) (*operations.GetTranscodeSessionsResponse, error)

+ func (s *Sessions) StopTranscodeSession(ctx context.Context, sessionKey string) (*operations.StopTranscodeSessionResponse, error)

+ type Updater struct

+ func (s *Updater) ApplyUpdates(ctx context.Context, tonight *operations.Tonight, skip *operations.Skip) (*operations.ApplyUpdatesResponse, error)

+ func (s *Updater) CheckForUpdates(ctx context.Context, download *operations.Download) (*operations.CheckForUpdatesResponse, error)

+ func (s *Updater) GetUpdateStatus(ctx context.Context) (*operations.GetUpdateStatusResponse, error)

+ type Video struct

+ func (s *Video) GetTimeline(ctx context.Context, request operations.GetTimelineRequest) (*operations.GetTimelineResponse, error)

+ func (s *Video) StartUniversalTranscode(ctx context.Context, request operations.StartUniversalTranscodeRequest) (*operations.StartUniversalTranscodeResponse, error)