sonarr

package
v0.0.0-...-4f3a07d Latest Latest
Warning

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

 Go to latest Published: Jun 25, 2024 License: GPL-3.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddSeriesOptions 

type AddSeriesOptions struct {
	IgnoreEpisodesWithFiles      bool        `json:"ignoreEpisodesWithFiles"`
	IgnoreEpisodesWithoutFiles   bool        `json:"ignoreEpisodesWithoutFiles"`
	Monitor                      MonitorType `json:"monitor"`
	SearchForMissingEpisodes     bool        `json:"searchForMissingEpisodes"`
	SearchForCutoffUnmetEpisodes bool        `json:"searchForCutoffUnmetEpisodes"`
}

type AlternativeTitleResource 

type AlternativeTitleResource struct {
	Title             string `json:"title"`
	SeasonNumber      int32  `json:"seasonNumber"`
	SceneSeasonNumber int32  `json:"sceneSeasonNumber"`
	SceneOrigin       string `json:"sceneOrigin"`
	Comment           string `json:"comment"`
}

type CivilTime 

type CivilTime time.Time

CivilTime implements a custom time format for JSON marshalling/unmarshalling

func (CivilTime) MarshalJSON 

func (c CivilTime) MarshalJSON() ([]byte, error)

func (*CivilTime) UnmarshalJSON 

func (c *CivilTime) UnmarshalJSON(b []byte) (err error)

type Client 

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

Client represents a sonarr client

func New 

func New(httpClient httpclient.Client, cfg *config.SonarrConfig) *Client

New creates a new sonarr client

func (*Client) DeleteEpisodeFile 

func (c *Client) DeleteEpisodeFile(ctx context.Context, episodeFileID int32) error

DeleteEpisodeFile deletes an episode file by its ID

func (*Client) DeleteSerie 

func (c *Client) DeleteSerie(ctx context.Context, serieID int32, opts ...httpclient.RequestOpts) error

func (*Client) GetAllEpisodes 

func (c *Client) GetAllEpisodes(ctx context.Context, seriesID int32) ([]*EpisodeResource, error)

GetAllEpisodes returns a list of all episodes for a given series

func (*Client) GetEpisode 

func (c *Client) GetEpisode(ctx context.Context, episodeID int32) (*EpisodeResource, error)

GetEpisode returns an episode by its ID

func (*Client) GetEpisodeFiles 

func (c *Client) GetEpisodeFiles(ctx context.Context, seriesID int32) ([]*EpisodeFileResource, error)

GetEpisodeFiles returns all episode files for a given series

func (*Client) GetEpisodes 

func (c *Client) GetEpisodes(ctx context.Context, seriesID, seasonNumber int32) ([]*EpisodeResource, error)

GetEpisodes returns a list of episodes for a given series and season

func (*Client) GetHistory 

func (c *Client) GetHistory(ctx context.Context, opts ...httpclient.RequestOpts) (*HistoryResourcePagingResource, error)

GetHistory returns the history of an object

func (*Client) GetLanguageProfiles deprecated 

func (c *Client) GetLanguageProfiles(ctx context.Context) ([]*LanguageProfileResource, error)

GetLanguageProfiles returns all language profiles

Deprecated: Will be obsolete in Sonarr v4

func (*Client) GetMissings 

func (c *Client) GetMissings(ctx context.Context) (*EpisodeResourcePagingResource, error)

GetMissings returns all the missing episodes

func (*Client) GetQualityProfile 

func (c *Client) GetQualityProfile(ctx context.Context, id int) (*QualityProfileResource, error)

GetQualityProfile returns a quality profile by its ID

func (*Client) GetQualityProfiles 

func (c *Client) GetQualityProfiles(ctx context.Context) ([]*QualityProfileResource, error)

GetQualityProfiles returns a list of all quality profiles

func (*Client) GetQueue 

func (c *Client) GetQueue(ctx context.Context, opts ...httpclient.RequestOpts) (*QueueResourcePagingResource, error)

GetQueue returns the current download queue

func (*Client) GetQueueDetails 

func (c *Client) GetQueueDetails(ctx context.Context, seriesID int32) ([]*QueueResource, error)

GetQueueDetails returns the queue for a certain series

func (*Client) GetRootFolders 

func (c *Client) GetRootFolders(ctx context.Context) ([]*RootFolderResource, error)

GetRootFolders returns all root folders

func (*Client) GetSerie 

func (c *Client) GetSerie(ctx context.Context, tvdbID int32) (*SeriesResource, error)

GetSerie returns a serie by its TVDB ID

func (*Client) GetSeries 

func (c *Client) GetSeries(ctx context.Context) ([]*SeriesResource, error)

GetSeries returns a list of all series

func (*Client) GetSeriesLookup 

func (c *Client) GetSeriesLookup(ctx context.Context, query string) ([]*SeriesResource, error)

GetSeriesLookup returns a list of series matching the given query

func (*Client) Ping 

func (c *Client) Ping(ctx context.Context) (*Ping, error)

Ping pings the sonarr server

func (*Client) PostCommand 

func (c *Client) PostCommand(ctx context.Context, params *CommandRequest) (*CommandResource, error)

PostCommand sends a command to sonarr

func (*Client) PostSerie 

func (c *Client) PostSerie(ctx context.Context, serie *SeriesResource) (*SeriesResource, error)

PostSerie adds a new serie

func (*Client) PutSerie 

func (c *Client) PutSerie(ctx context.Context, serie *SeriesResource, opts ...httpclient.RequestOpts) (*SeriesResource, error)

PutSerie updates a serie by its ID

func (*Client) SetEpisodesMonitored 

func (c *Client) SetEpisodesMonitored(ctx context.Context, params *EpisodesMonitoredResource) error

SetEpisodesMonitored sets the monitored status of a list of episodes

type Command 

type Command struct {
	SendUpdatesToClient bool           `json:"sendUpdatesToClient"`
	LastExecutionTime   time.Time      `json:"lastExecutionTime"`
	LastStartTime       time.Time      `json:"lastStartTime"`
	Trigger             CommandTrigger `json:"trigger"`
	SuppressMessages    bool           `json:"suppressMessages"`
	ClientUserAgent     string         `json:"clientUserAgent"`
}

type CommandPriority 

type CommandPriority string
const (
	CommandPriorityNormal CommandPriority = "normal"
	CommandPriorityHigh   CommandPriority = "high"
	CommandPriorityLow    CommandPriority = "low"
)

type CommandRequest 

type CommandRequest struct {
	Name         string  `json:"name"`
	SeasonNumber int32   `json:"seasonNumber,omitempty"`
	SeriesID     int32   `json:"seriesId,omitempty"`
	EpisodeIDs   []int32 `json:"episodeIds,omitempty"`
}

CommandRequest is the request body for a command This struct isn't acording to the API docs, but it's what the API actually expects

type CommandResource 

type CommandResource struct {
	ID                  int32           `json:"id"`
	Name                string          `json:"name"`
	CommandName         string          `json:"commandName"`
	Message             string          `json:"message"`
	Body                *Command        `json:"body"`
	Priority            CommandPriority `json:"priority"`
	Status              CommandStatus   `json:"status"`
	Result              CommandResult   `json:"result"`
	Queued              time.Time       `json:"queued"`
	Started             time.Time       `json:"started"`
	Ended               time.Time       `json:"ended"`
	Duration            time.Duration   `json:"duration"`
	Exception           string          `json:"exception"`
	Trigger             CommandTrigger  `json:"trigger"`
	ClientUserAgent     string          `json:"clientUserAgent"`
	StateChangeTime     time.Time       `json:"stateChangeTime"`
	SendUpdatesToClient bool            `json:"sendUpdatesToClient"`
	UpdateScheduledTask bool            `json:"updateScheduledTask"`
	LastExecutionTime   time.Time       `json:"lastExecutionTime"`
}

type CommandResult 

type CommandResult string
const (
	CommandResultUnknown     CommandResult = "unknown"
	CommandResultSuccessful  CommandResult = "successful"
	CommandResultUnsucessful CommandResult = "unsucessful"
)

type CommandStatus 

type CommandStatus string
const (
	CommandStatusQueued    CommandStatus = "queued"
	CommandStatusStarted   CommandStatus = "started"
	CommandStatusCompleted CommandStatus = "completed"
	CommandStatusFailed    CommandStatus = "failed"
	CommandStatusAborted   CommandStatus = "aborted"
	CommandStatusCancelled CommandStatus = "cancelled"
	CommandStatusOrphaned  CommandStatus = "orphaned"
)

type CommandTrigger 

type CommandTrigger string
const (
	CommandTriggerUnspecified CommandTrigger = "unspecified"
	CommandTriggerManual      CommandTrigger = "manual"
	CommandTriggerScheduled   CommandTrigger = "scheduled"
)

type CustomFormatResource 

type CustomFormatResource struct {
	ID                              int32                             `json:"id"`
	Name                            string                            `json:"name"`
	IncludeCustomFormatWhenRenaming bool                              `json:"includeCustomFormatWhenRenaming"`
	Specifications                  []CustomFormatSpecificationSchema `json:"specifications"`
}

type CustomFormatSpecificationSchema 

type CustomFormatSpecificationSchema struct {
	ID                 int32   `json:"id"`
	Name               string  `json:"name"`
	Implementation     string  `json:"implementation"`
	ImplementationName string  `json:"implementationName"`
	InfoLink           string  `json:"infoLink"`
	Negate             bool    `json:"negate"`
	Required           bool    `json:"required"`
	Fields             []Field `json:"fields"`
	Presets            []any   `json:"presets"`
}

type DownloadProtocol 

type DownloadProtocol string
const (
	UnknownDownloadProtocol DownloadProtocol = "unknown"
	Usenet                  DownloadProtocol = "usenet"
	Torrent                 DownloadProtocol = "torrent"
)

type EpisodeFileResource 

type EpisodeFileResource struct {
	ID                  int32                  `json:"id"`
	SeriesID            int32                  `json:"seriesId"`
	SeasonNumber        int32                  `json:"seasonNumber"`
	RelativePath        string                 `json:"relativePath"`
	Path                string                 `json:"path"`
	Size                int64                  `json:"size"`
	DateAdded           time.Time              `json:"dateAdded"`
	SceneName           string                 `json:"sceneName"`
	ReleaseGroup        string                 `json:"releaseGroup"`
	Languages           []Language             `json:"languages"`
	Quality             *QualityModel          `json:"quality"`
	CustomFormats       []CustomFormatResource `json:"customFormats"`
	MediaInfo           *MediaInfoResource     `json:"mediaInfo"`
	QualityCutoffNotMet bool                   `json:"qualityCutoffNotMet"`
}

type EpisodeHistoryEventType 

type EpisodeHistoryEventType string
const (
	EpisodeHistoryEventTypeUnknown                EpisodeHistoryEventType = "unknown"
	EpisodeHistoryEventTypeGrabbed                EpisodeHistoryEventType = "grabbed"
	EpisodeHistoryEventTypeSeriesFolderImported   EpisodeHistoryEventType = "seriesFolderImported"
	EpisodeHistoryEventTypeDownloadFolderImported EpisodeHistoryEventType = "downloadFolderImported"
	EpisodeHistoryEventTypeDownloadFailed         EpisodeHistoryEventType = "downloadFailed"
	EpisodeHistoryEventTypeEpisodeFileDeleted     EpisodeHistoryEventType = "episodeFileDeleted"
	EpisodeHistoryEventTypeEpisodeFileRenamed     EpisodeHistoryEventType = "episodeFileRenamed"
	EpisodeHistoryEventTypeDownloadIgnored        EpisodeHistoryEventType = "downloadIgnored"
)

type EpisodeResource 

type EpisodeResource struct {
	ID                         int32                `json:"id"`
	SeriesID                   int32                `json:"seriesId"`
	TVDBID                     int32                `json:"tvdbId"`
	EpisodeFileID              int32                `json:"episodeFileId"`
	SeasonNumber               int32                `json:"seasonNumber"`
	EpisodeNumber              int32                `json:"episodeNumber"`
	Title                      string               `json:"title"`
	AirDate                    CivilTime            `json:"airDate"`
	AirDateUTC                 time.Time            `json:"airDateUtc"`
	Overview                   string               `json:"overview"`
	EpisodeFile                *EpisodeFileResource `json:"episodeFile"`
	HasFile                    bool                 `json:"hasFile"`
	Monitored                  bool                 `json:"monitored"`
	AbsoluteEpisodeNumber      int32                `json:"absoluteEpisodeNumber"`
	SceneAbsoluteEpisodeNumber int32                `json:"sceneAbsoluteEpisodeNumber"`
	SceneEpisodeNumber         int32                `json:"sceneEpisodeNumber"`
	SceneSeasonNumber          int32                `json:"sceneSeasonNumber"`
	UnverifiedSceneNumbering   bool                 `json:"unverifiedSceneNumbering"`
	EndTime                    time.Time            `json:"endTime"`
	GrabDate                   time.Time            `json:"grabDate"`
	SeriesTitle                string               `json:"seriesTitle"`
	Series                     *SeriesResource      `json:"series"`
	Images                     []MediaCover         `json:"images"`
	Grabbed                    bool                 `json:"grabbed"`
}

type EpisodeResourcePagingResource 

type EpisodeResourcePagingResource struct {
	Page          int32                    `json:"page"`
	PageSize      int32                    `json:"pageSize"`
	SortKey       string                   `json:"sortKey"`
	SortDirection httpclient.SortDirection `json:"sortDirection"`
	Filters       []PagingResourceFilter   `json:"filters"`
	TotalRecords  int32                    `json:"totalRecords"`
	Records       []*EpisodeResource       `json:"records"`
}

type EpisodesMonitoredResource 

type EpisodesMonitoredResource struct {
	EpisodeIDs []int32 `json:"episodeIds"`
	Monitored  bool    `json:"monitored"`
}

type Field 

type Field struct {
	Order                       int32          `json:"order"`
	Name                        string         `json:"name"`
	Label                       string         `json:"label"`
	Unit                        string         `json:"unit"`
	HelpText                    string         `json:"helpText"`
	HelpLink                    string         `json:"helpLink"`
	Value                       any            `json:"value"`
	Type                        string         `json:"type"`
	Advanced                    bool           `json:"advanced"`
	SelectOptions               []SelectOption `json:"selectOptions"`
	SelectOptionsProviderAction string         `json:"selectOptionsProviderAction"`
	Section                     string         `json:"section"`
	Hidden                      string         `json:"hidden"`
	Privacy                     PrivacyLevel   `json:"privacy"`
}

type HistoryResource 

type HistoryResource struct {
	ID                  int32                   `json:"id"`
	EpisodeID           int32                   `json:"episodeId"`
	SeriesID            int32                   `json:"seriesId"`
	SourceTitle         string                  `json:"sourceTitle"`
	Languages           []Language              `json:"languages"`
	Quality             *QualityModel           `json:"quality"`
	CustomFormat        []CustomFormatResource  `json:"customFormats"`
	CustomFormatScore   int32                   `json:"customFormatScore"`
	QualityCutoffNotMet bool                    `json:"qualityCutoffNotMet"`
	Date                time.Time               `json:"date"`
	DownloadID          string                  `json:"downloadId"`
	EventType           EpisodeHistoryEventType `json:"eventType"`
	Data                any                     `json:"data"`
	Episode             *EpisodeResource        `json:"episode"`
	Series              *SeriesResource         `json:"series"`
}

type HistoryResourcePagingResource 

type HistoryResourcePagingResource struct {
	Page          int32                    `json:"page"`
	PageSize      int32                    `json:"pageSize"`
	SortKey       string                   `json:"sortKey"`
	SortDirection httpclient.SortDirection `json:"sortDirection"`
	Filters       []PagingResourceFilter   `json:"filters"`
	TotalRecords  int32                    `json:"totalRecords"`
	Records       []*HistoryResource       `json:"records"`
}

type Language 

type Language struct {
	ID   int32  `json:"id"`
	Name string `json:"name"`
}

type LanguageProfileItemResource 

type LanguageProfileItemResource struct {
	ID       int32    `json:"id"`
	Language Language `json:"language"`
	Allowed  bool     `json:"allowed"`
}

type LanguageProfileResource 

type LanguageProfileResource struct {
	ID          int32                         `json:"id"`
	Name        string                        `json:"name"`
	Upgradeable bool                          `json:"upgradeable"`
	Cutoff      Language                      `json:"cutoff"`
	Languages   []LanguageProfileItemResource `json:"languages"`
}

type MediaCover 

type MediaCover struct {
	CoverType MediaCoverType `json:"coverType"`
	URL       string         `json:"url"`
	RemoteURL string         `json:"remoteUrl"`
}

type MediaCoverType 

type MediaCoverType string
const (
	UnknownMediaCoverType MediaCoverType = "unknown"
	Poster                MediaCoverType = "poster"
	Fanart                MediaCoverType = "fanart"
	Screenshot            MediaCoverType = "screenshot"
	Headshot              MediaCoverType = "headshot"
)

type MediaInfoResource 

type MediaInfoResource struct {
	ID                    int32   `json:"id"`
	AudioBitrate          int64   `json:"audioBitrate"`
	AudioChannels         float64 `json:"audioChannels"`
	AudioCodec            string  `json:"audioCodec"`
	AudioLanguages        string  `json:"audioLanguages"`
	AudioStreamCount      int32   `json:"audioStreamCount"`
	VideoBitDepth         int32   `json:"videoBitDepth"`
	VideoBitrate          int64   `json:"videoBitrate"`
	VideoCodec            string  `json:"videoCodec"`
	VideoFps              float64 `json:"videoFps"`
	VideoDynamicRange     string  `json:"videoDynamicRange"`
	VideoDynamicRangeType string  `json:"videoDynamicRangeType"`
	Resolution            string  `json:"resolution"`
	RunTime               string  `json:"runTime"`
	ScanType              string  `json:"scanType"`
	Subtitles             string  `json:"subtitles"`
}

type MonitorType 

type MonitorType string
const (
	UnknownMonitorType MonitorType = "unknown"
	All                MonitorType = "all"
	Future             MonitorType = "future"
	Missing            MonitorType = "missing"
	Existing           MonitorType = "existing"
	FirstSeason        MonitorType = "firstSeason"
	LastSeason         MonitorType = "lastSeason"
	Pilot              MonitorType = "pilot"
	None               MonitorType = "none"
)

type PagingResourceFilter 

type PagingResourceFilter struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

type Ping 

type Ping struct {
	Status string `json:"status"`
}

Ping is the response from the ping endpoint

type PrivacyLevel 

type PrivacyLevel string
const (
	Normal   PrivacyLevel = "normal"
	Password PrivacyLevel = "password"
	APIKey   PrivacyLevel = "apiKey"
	UserName PrivacyLevel = "userName"
)

type ProfileFormatItemResource 

type ProfileFormatItemResource struct {
	ID     int32  `json:"id"`
	Format int32  `json:"format"`
	Name   string `json:"name"`
	Score  int32  `json:"score"`
}

type Quality 

type Quality struct {
	ID         int32         `json:"id"`
	Name       string        `json:"name"`
	Source     QualitySource `json:"source"`
	Resolution int32         `json:"resolution"`
}

type QualityModel 

type QualityModel struct {
	Quality  *Quality  `json:"quality"`
	Revision *Revision `json:"revision"`
}

type QualityProfileQualityItemResource 

type QualityProfileQualityItemResource struct {
	ID      int32   `json:"id"`
	Name    string  `json:"name"`
	Quality Quality `json:"quality"`
	Items   []any   `json:"items"`
	Allowed bool    `json:"allowed"`
}

type QualityProfileResource 

type QualityProfileResource struct {
	ID                int32  `json:"id"`
	Name              string `json:"name"`
	UpgradeAllowed    bool   `json:"upgradeAllowed"`
	Cutoff            int32
	Items             []QualityProfileQualityItemResource `json:"items"`
	MinFormatScore    int32                               `json:"minFormatScore"`
	CutoffFormatScore int32                               `json:"cutoffFormatScore"`
	FormatItems       []ProfileFormatItemResource         `json:"formatItems"`
}

type QualitySource 

type QualitySource string
const (
	UnknownQualitySource QualitySource = "unknown"
	Television           QualitySource = "television"
	TelevisionRaw        QualitySource = "televisionRaw"
	Web                  QualitySource = "web"
	WebRip               QualitySource = "webRip"
	Dvd                  QualitySource = "dvd"
	Bluray               QualitySource = "bluray"
	BlurayRaw            QualitySource = "blurayRaw"
)

type QueueResource 

type QueueResource struct {
	ID                      int32                          `json:"id"`
	SeriesID                int32                          `json:"seriesId"`
	EpisodeID               int32                          `json:"episodeId"`
	Series                  *SeriesResource                `json:"series"`
	Episode                 *EpisodeResource               `json:"episode"`
	Languages               []Language                     `json:"languages"`
	Quality                 *QualityModel                  `json:"quality"`
	CustomFormats           []CustomFormatResource         `json:"customFormats"`
	Size                    float64                        `json:"size"`
	Title                   string                         `json:"title"`
	Sizeleft                float64                        `json:"sizeleft"`
	Timeleft                TimeLeft                       `json:"timeleft"`
	EstimatedCompletionTime time.Time                      `json:"estimatedCompletionTime"`
	Status                  string                         `json:"status"`
	TrackedDownloadStatus   TrackedDownloadStatus          `json:"trackedDownloadStatus"`
	TrackedDownloadState    TrackedDownloadState           `json:"trackedDownloadState"`
	StatusMessages          []TrackedDownloadStatusMessage `json:"statusMessages"`
	ErrorMessage            string                         `json:"errorMessage"`
	DownloadID              string                         `json:"downloadId"`
	Protocol                DownloadProtocol               `json:"protocol"`
	DownloadClient          string                         `json:"downloadClient"`
	Indexer                 string                         `json:"indexer"`
	OutputPath              string                         `json:"outputPath"`
}

type QueueResourcePagingResource 

type QueueResourcePagingResource struct {
	Page          int32                    `json:"page"`
	PageSize      int32                    `json:"pageSize"`
	SortKey       string                   `json:"sortKey"`
	SortDirection httpclient.SortDirection `json:"sortDirection"`
	Filters       []PagingResourceFilter   `json:"filters"`
	TotalRecords  int32                    `json:"totalRecords"`
	Records       []*QueueResource         `json:"records"`
}

type Ratings 

type Ratings struct {
	Votes int32   `json:"votes"`
	Value float64 `json:"value"`
}

type Revision 

type Revision struct {
	Version  int32 `json:"version"`
	Real     int32 `json:"real"`
	IsRepack bool  `json:"isRepack"`
}

type RootFolderResource 

type RootFolderResource struct {
	ID              int32            `json:"id"`
	Path            string           `json:"path"`
	Accessible      bool             `json:"accessible"`
	FreeSpace       int64            `json:"freeSpace"`
	UnmappedFolders []UnmappedFolder `json:"unmappedFolders"`
}

type SeasonResource 

type SeasonResource struct {
	SeasonNumber int32                     `json:"seasonNumber"`
	Monitored    bool                      `json:"monitored"`
	Statistics   *SeasonStatisticsResource `json:"statistics"`
	Images       []MediaCover              `json:"images"`
}

type SeasonStatisticsResource 

type SeasonStatisticsResource struct {
	NextAiring        time.Time `json:"nextAiring"`
	PreviousAiring    time.Time `json:"previousAiring"`
	EpisodeFileCount  int32     `json:"episodeFileCount"`
	EpisodeCount      int32     `json:"episodeCount"`
	TotalEpisodeCount int32     `json:"totalEpisodeCount"`
	SizeOnDisk        int64     `json:"sizeOnDisk"`
	ReleaseGroups     []string  `json:"releaseGroups"`
	PercentOfEpisodes float64   `json:"percentOfEpisodes"`
}

type SelectOption 

type SelectOption struct {
	Value int32  `json:"value"`
	Name  string `json:"name"`
	Order int32  `json:"order"`
	Hint  string `json:"hint"`
}

type SeriesResource 

type SeriesResource struct {
	ID                int32                      `json:"id"`
	Title             string                     `json:"title"`
	AlternateTitles   []AlternativeTitleResource `json:"alternateTitles"`
	SortTitle         string                     `json:"sortTitle"`
	Status            SeriesStatusType           `json:"status"`
	Ended             bool                       `json:"ended"`
	ProfileName       string                     `json:"profileName"`
	Overview          string                     `json:"overview"`
	NextAiring        time.Time                  `json:"nextAiring"`
	PreviousAiring    time.Time                  `json:"previousAiring"`
	Network           string                     `json:"network"`
	AirTime           string                     `json:"airTime"`
	Images            []MediaCover               `json:"images"`
	OriginalLanguage  *Language                  `json:"originalLanguage"`
	RemotePoster      string                     `json:"remotePoster"`
	Seasons           []*SeasonResource          `json:"seasons"`
	Year              int32                      `json:"year"`
	Path              string                     `json:"path"`
	QualityProfileID  int32                      `json:"qualityProfileId"`
	SeasonFolder      bool                       `json:"seasonFolder"`
	Monitored         bool                       `json:"monitored"`
	UseSceneNumbering bool                       `json:"useSceneNumbering"`
	Runtime           int32                      `json:"runtime"`
	TVDBID            int32                      `json:"tvdbId"`
	TVRageID          int32                      `json:"tvRageId"`
	TVMAZEID          int32                      `json:"tvMazeId"`
	FirstAired        time.Time                  `json:"firstAired"`
	SeriesType        SeriesType                 `json:"seriesType"`
	CleanTitle        string                     `json:"cleanTitle"`
	ImdbID            string                     `json:"imdbId"`
	TitleSlug         string                     `json:"titleSlug"`
	RootFolderPath    string                     `json:"rootFolderPath"`
	Folder            string                     `json:"folder"`
	Certification     string                     `json:"certification"`
	Genres            []string                   `json:"genres"`
	Tags              []int32                    `json:"tags"`
	Added             time.Time                  `json:"added"`
	AddOptions        *AddSeriesOptions          `json:"addOptions"`
	Statistics        *SeriesStatisticsResource  `json:"statistics"`
	EpisodesChanged   bool                       `json:"episodesChanged"`
	LanguageProfileID int32                      `json:"languageProfileId,omitempty"` // deprecated
}

SeriesResource is the response from the series endpoint

type SeriesStatisticsResource 

type SeriesStatisticsResource struct {
	SeasonCount       int32    `json:"seasonCount"`
	EpisodeFileCount  int32    `json:"episodeFileCount"`
	EpisodeCount      int32    `json:"episodeCount"`
	TotalEpisodeCount int32    `json:"totalEpisodeCount"`
	SizeOnDisk        int64    `json:"sizeOnDisk"`
	ReleaseGroups     []string `json:"releaseGroups"`
	PercentOfEpisodes float64  `json:"percentOfEpisodes"`
}

type SeriesStatusType 

type SeriesStatusType string
const (
	Continuing SeriesStatusType = "continuing"
	Ended      SeriesStatusType = "ended"
	Upcoming   SeriesStatusType = "upcoming"
	Deleted    SeriesStatusType = "deleted"
)

type SeriesType 

type SeriesType string
const (
	Standard SeriesType = "standard"
	Daily    SeriesType = "daily"
	Anime    SeriesType = "anime"
)

type TimeLeft 

type TimeLeft time.Time

TimeLeft is a custom type to handle the timeleft field

func (TimeLeft) MarshalJSON 

func (tl TimeLeft) MarshalJSON() ([]byte, error)

func (*TimeLeft) UnmarshalJSON 

func (tl *TimeLeft) UnmarshalJSON(b []byte) (err error)

type TimeSpan 

type TimeSpan struct {
	Ticks             int64   `json:"ticks"`
	Days              int32   `json:"days"`
	Hours             int32   `json:"hours"`
	Milliseconds      int32   `json:"milliseconds"`
	Minutes           int32   `json:"minutes"`
	Seconds           int32   `json:"seconds"`
	TotalDays         float64 `json:"totalDays"`
	TotalHours        float64 `json:"totalHours"`
	TotalMilliseconds float64 `json:"totalMilliseconds"`
	TotalMinutes      float64 `json:"totalMinutes"`
	TotalSeconds      float64 `json:"totalSeconds"`
}

type TrackedDownloadState 

type TrackedDownloadState string
const (
	Downloading   TrackedDownloadState = "downloading"
	ImportPending TrackedDownloadState = "importPending"
	Importing     TrackedDownloadState = "importing"
	Imported      TrackedDownloadState = "imported"
	FailedPending TrackedDownloadState = "failedPending"
	Failed        TrackedDownloadState = "failed"
	Ignored       TrackedDownloadState = "ignored"
)

type TrackedDownloadStatus 

type TrackedDownloadStatus string
const (
	OK      TrackedDownloadStatus = "ok"
	Warning TrackedDownloadStatus = "warning"
	Error   TrackedDownloadStatus = "error"
)

type TrackedDownloadStatusMessage 

type TrackedDownloadStatusMessage struct {
	Title    string   `json:"title"`
	Messages []string `json:"messages"`
}

type UnmappedFolder 

type UnmappedFolder struct {
	Name         string `json:"name"`
	Path         string `json:"path"`
	RelativePath string `json:"relativePath"`
}

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.