flexget.components.series.api module#
- class flexget.components.series.api.ObjectsContainer[source]#
Bases:
object- episode_list_schema = {'items': {'properties': {'first_seen': {'format': 'date-time', 'type': ['string', 'null']}, 'id': {'type': 'integer'}, 'identified_by': {'type': 'string'}, 'identifier': {'type': 'string'}, 'latest_release': {'properties': {'downloaded': {'type': 'boolean'}, 'episode_id': {'type': 'integer'}, 'first_seen': {'format': 'date-time', 'type': 'string'}, 'id': {'type': 'integer'}, 'proper_count': {'type': 'integer'}, 'quality': {'type': 'string'}, 'title': {'type': 'string'}}, 'required': ['id', 'title', 'downloaded', 'quality', 'proper_count', 'first_seen', 'episode_id'], 'type': 'object'}, 'number': {'type': 'integer'}, 'number_of_releases': {'type': 'integer'}, 'premiere': {'type': ['string', 'boolean']}, 'season': {'type': 'integer'}, 'series_id': {'type': 'integer'}}, 'required': ['first_seen', 'id', 'identified_by', 'identifier', 'premiere', 'number', 'season', 'series_id', 'number_of_releases'], 'type': ['object', 'null']}, 'type': 'array'}#
- episode_object = {'properties': {'first_seen': {'format': 'date-time', 'type': ['string', 'null']}, 'id': {'type': 'integer'}, 'identified_by': {'type': 'string'}, 'identifier': {'type': 'string'}, 'latest_release': {'properties': {'downloaded': {'type': 'boolean'}, 'episode_id': {'type': 'integer'}, 'first_seen': {'format': 'date-time', 'type': 'string'}, 'id': {'type': 'integer'}, 'proper_count': {'type': 'integer'}, 'quality': {'type': 'string'}, 'title': {'type': 'string'}}, 'required': ['id', 'title', 'downloaded', 'quality', 'proper_count', 'first_seen', 'episode_id'], 'type': 'object'}, 'number': {'type': 'integer'}, 'number_of_releases': {'type': 'integer'}, 'premiere': {'type': ['string', 'boolean']}, 'season': {'type': 'integer'}, 'series_id': {'type': 'integer'}}, 'required': ['first_seen', 'id', 'identified_by', 'identifier', 'premiere', 'number', 'season', 'series_id', 'number_of_releases'], 'type': ['object', 'null']}#
- episode_release_list_schema = {'items': {'properties': {'downloaded': {'type': 'boolean'}, 'episode_id': {'type': 'integer'}, 'first_seen': {'format': 'date-time', 'type': 'string'}, 'id': {'type': 'integer'}, 'proper_count': {'type': 'integer'}, 'quality': {'type': 'string'}, 'title': {'type': 'string'}}, 'required': ['id', 'title', 'downloaded', 'quality', 'proper_count', 'first_seen', 'episode_id'], 'type': 'object'}, 'type': 'array'}#
- episode_release_object = {'properties': {'downloaded': {'type': 'boolean'}, 'episode_id': {'type': 'integer'}, 'first_seen': {'format': 'date-time', 'type': 'string'}, 'id': {'type': 'integer'}, 'proper_count': {'type': 'integer'}, 'quality': {'type': 'string'}, 'title': {'type': 'string'}}, 'required': ['id', 'title', 'downloaded', 'quality', 'proper_count', 'first_seen', 'episode_id'], 'type': 'object'}#
- season_object = {'properties': {'first_seen': {'format': 'date-time', 'type': ['string', 'null']}, 'id': {'type': 'integer'}, 'identified_by': {'type': 'string'}, 'identifier': {'type': 'string'}, 'latest_release': {'properties': {'downloaded': {'type': 'boolean'}, 'episode_id': {'type': 'integer'}, 'first_seen': {'format': 'date-time', 'type': 'string'}, 'id': {'type': 'integer'}, 'proper_count': {'type': 'integer'}, 'quality': {'type': 'string'}, 'title': {'type': 'string'}}, 'required': ['id', 'title', 'downloaded', 'quality', 'proper_count', 'first_seen', 'episode_id'], 'type': 'object'}, 'number_of_releases': {'type': 'integer'}, 'premiere': {'type': ['string', 'boolean']}, 'season': {'type': 'integer'}, 'series_id': {'type': 'integer'}}, 'required': ['first_seen', 'id', 'identified_by', 'identifier', 'season', 'series_id', 'number_of_releases'], 'type': ['object', 'null']}#
- season_release_list_schema = {'items': {'properties': {'downloaded': {'type': 'boolean'}, 'first_seen': {'format': 'date-time', 'type': 'string'}, 'id': {'type': 'integer'}, 'proper_count': {'type': 'integer'}, 'quality': {'type': 'string'}, 'season_id': {'type': 'integer'}, 'title': {'type': 'string'}}, 'required': ['id', 'title', 'downloaded', 'quality', 'proper_count', 'first_seen', 'season_id'], 'type': 'object'}, 'type': 'array'}#
- season_release_object = {'properties': {'downloaded': {'type': 'boolean'}, 'first_seen': {'format': 'date-time', 'type': 'string'}, 'id': {'type': 'integer'}, 'proper_count': {'type': 'integer'}, 'quality': {'type': 'string'}, 'season_id': {'type': 'integer'}, 'title': {'type': 'string'}}, 'required': ['id', 'title', 'downloaded', 'quality', 'proper_count', 'first_seen', 'season_id'], 'type': 'object'}#
- seasons_list_schema = {'items': {'properties': {'first_seen': {'format': 'date-time', 'type': ['string', 'null']}, 'id': {'type': 'integer'}, 'identified_by': {'type': 'string'}, 'identifier': {'type': 'string'}, 'latest_release': {'properties': {'downloaded': {'type': 'boolean'}, 'episode_id': {'type': 'integer'}, 'first_seen': {'format': 'date-time', 'type': 'string'}, 'id': {'type': 'integer'}, 'proper_count': {'type': 'integer'}, 'quality': {'type': 'string'}, 'title': {'type': 'string'}}, 'required': ['id', 'title', 'downloaded', 'quality', 'proper_count', 'first_seen', 'episode_id'], 'type': 'object'}, 'number_of_releases': {'type': 'integer'}, 'premiere': {'type': ['string', 'boolean']}, 'season': {'type': 'integer'}, 'series_id': {'type': 'integer'}}, 'required': ['first_seen', 'id', 'identified_by', 'identifier', 'season', 'series_id', 'number_of_releases'], 'type': ['object', 'null']}, 'type': 'array'}#
- series_edit_object = {'additionalProperties:': False, 'anyOf': [{'required': ['begin_episode']}, {'required': ['alternate_names']}], 'properties': {'alternate_names': {'items': {'type': 'string'}, 'type': 'array'}, 'begin_episode': {'format': 'episode_or_season_id', 'type': ['string', 'integer']}}, 'type': 'object'}#
- series_input_object = {'additionalProperties:': False, 'properties': {'alternate_names': {'items': {'type': 'string'}, 'type': 'array'}, 'begin_episode': {'format': 'episode_or_season_id', 'type': ['string', 'integer']}, 'name': {'type': 'string'}}, 'required': ['name'], 'type': 'object'}#
- series_list_schema = {'items': {'properties': {'alternate_names': {'items': {'type': 'string'}, 'type': 'array'}, 'begin_episode': {'properties': {'first_seen': {'format': 'date-time', 'type': ['string', 'null']}, 'id': {'type': 'integer'}, 'identified_by': {'type': 'string'}, 'identifier': {'type': 'string'}, 'latest_release': {'properties': {'downloaded': {'type': 'boolean'}, 'episode_id': {'type': 'integer'}, 'first_seen': {'format': 'date-time', 'type': 'string'}, 'id': {'type': 'integer'}, 'proper_count': {'type': 'integer'}, 'quality': {'type': 'string'}, 'title': {'type': 'string'}}, 'required': ['id', 'title', 'downloaded', 'quality', 'proper_count', 'first_seen', 'episode_id'], 'type': 'object'}, 'number': {'type': 'integer'}, 'number_of_releases': {'type': 'integer'}, 'premiere': {'type': ['string', 'boolean']}, 'season': {'type': 'integer'}, 'series_id': {'type': 'integer'}}, 'required': ['first_seen', 'id', 'identified_by', 'identifier', 'premiere', 'number', 'season', 'series_id', 'number_of_releases'], 'type': ['object', 'null']}, 'id': {'type': 'integer'}, 'in_tasks': {'items': {'type': 'string'}, 'type': 'array'}, 'latest_episode': {'properties': {'first_seen': {'format': 'date-time', 'type': ['string', 'null']}, 'id': {'type': 'integer'}, 'identified_by': {'type': 'string'}, 'identifier': {'type': 'string'}, 'latest_release': {'properties': {'downloaded': {'type': 'boolean'}, 'episode_id': {'type': 'integer'}, 'first_seen': {'format': 'date-time', 'type': 'string'}, 'id': {'type': 'integer'}, 'proper_count': {'type': 'integer'}, 'quality': {'type': 'string'}, 'title': {'type': 'string'}}, 'required': ['id', 'title', 'downloaded', 'quality', 'proper_count', 'first_seen', 'episode_id'], 'type': 'object'}, 'number': {'type': 'integer'}, 'number_of_releases': {'type': 'integer'}, 'premiere': {'type': ['string', 'boolean']}, 'season': {'type': 'integer'}, 'series_id': {'type': 'integer'}}, 'required': ['first_seen', 'id', 'identified_by', 'identifier', 'premiere', 'number', 'season', 'series_id', 'number_of_releases'], 'type': ['object', 'null']}, 'lookup': {'properties': {'tvdb': {'additionalProperties': False, 'properties': {'actors': {'items': {'type': 'string'}, 'type': 'array'}, 'airs_dayofweek': {'type': 'string'}, 'airs_time': {'type': 'string'}, 'aliases': {'items': {'type': 'string'}, 'type': 'array'}, 'banner': {'type': 'string'}, 'content_rating': {'type': 'string'}, 'expired': {'type': 'boolean'}, 'first_aired': {'type': 'string'}, 'genres': {'items': {'type': 'string'}, 'type': 'array'}, 'imdb_id': {'type': 'string'}, 'language': {'type': 'string'}, 'last_updated': {'format': 'date-time', 'type': 'string'}, 'network': {'type': 'string'}, 'overview': {'type': 'string'}, 'posters': {'items': {'type': 'string'}, 'type': 'array'}, 'rating': {'type': 'number'}, 'runtime': {'type': 'integer'}, 'series_name': {'type': 'string'}, 'status': {'type': 'string'}, 'tvdb_id': {'type': 'integer'}, 'zap2it_id': {'type': 'string'}}, 'required': ['tvdb_id', 'last_updated', 'expired', 'series_name', 'rating', 'status', 'runtime', 'airs_time', 'airs_dayofweek', 'content_rating', 'network', 'overview', 'imdb_id', 'zap2it_id', 'banner', 'first_aired', 'aliases', 'posters', 'genres', 'language'], 'type': 'object'}, 'tvmaze': {'additionalProperties': False, 'properties': {'genres': {'items': {'type': 'string'}, 'type': 'array'}, 'language': {'type': 'string'}, 'last_update': {'format': 'date-time', 'type': 'string'}, 'medium_image': {'type': 'string'}, 'name': {'type': 'string'}, 'network': {'type': ['string', 'null']}, 'original_image': {'type': 'string'}, 'premiered': {'format': 'date-time', 'type': 'string'}, 'rating': {'type': 'number'}, 'runtime': {'type': 'integer'}, 'schedule': {'properties': {'days': {'items': {'type': 'string'}, 'type': 'array'}, 'time': {'type': 'string'}}, 'type': 'object'}, 'show_type': {'type': 'string'}, 'status': {'type': 'string'}, 'summary': {'type': 'string'}, 'tvdb_id': {'type': 'integer'}, 'tvmaze_id': {'type': 'integer'}, 'tvrage_id': {'type': 'integer'}, 'updated': {'format': 'date-time', 'type': 'string'}, 'url': {'format': 'url', 'type': 'string'}, 'webchannel': {'type': ['string', 'null']}, 'weight': {'type': 'integer'}, 'year': {'type': 'integer'}}, 'required': ['tvmaze_id', 'status', 'rating', 'genres', 'weight', 'updated', 'name', 'language', 'schedule', 'url', 'original_image', 'medium_image', 'tvdb_id', 'tvrage_id', 'premiered', 'year', 'summary', 'webchannel', 'runtime', 'show_type', 'network', 'last_update'], 'type': 'object'}}, 'type': 'object'}, 'name': {'type': 'string'}}, 'required': ['id', 'name', 'alternate_names', 'in_tasks'], 'type': 'object'}, 'type': 'array'}#
- single_series_object = {'properties': {'alternate_names': {'items': {'type': 'string'}, 'type': 'array'}, 'begin_episode': {'properties': {'first_seen': {'format': 'date-time', 'type': ['string', 'null']}, 'id': {'type': 'integer'}, 'identified_by': {'type': 'string'}, 'identifier': {'type': 'string'}, 'latest_release': {'properties': {'downloaded': {'type': 'boolean'}, 'episode_id': {'type': 'integer'}, 'first_seen': {'format': 'date-time', 'type': 'string'}, 'id': {'type': 'integer'}, 'proper_count': {'type': 'integer'}, 'quality': {'type': 'string'}, 'title': {'type': 'string'}}, 'required': ['id', 'title', 'downloaded', 'quality', 'proper_count', 'first_seen', 'episode_id'], 'type': 'object'}, 'number': {'type': 'integer'}, 'number_of_releases': {'type': 'integer'}, 'premiere': {'type': ['string', 'boolean']}, 'season': {'type': 'integer'}, 'series_id': {'type': 'integer'}}, 'required': ['first_seen', 'id', 'identified_by', 'identifier', 'premiere', 'number', 'season', 'series_id', 'number_of_releases'], 'type': ['object', 'null']}, 'id': {'type': 'integer'}, 'in_tasks': {'items': {'type': 'string'}, 'type': 'array'}, 'latest_episode': {'properties': {'first_seen': {'format': 'date-time', 'type': ['string', 'null']}, 'id': {'type': 'integer'}, 'identified_by': {'type': 'string'}, 'identifier': {'type': 'string'}, 'latest_release': {'properties': {'downloaded': {'type': 'boolean'}, 'episode_id': {'type': 'integer'}, 'first_seen': {'format': 'date-time', 'type': 'string'}, 'id': {'type': 'integer'}, 'proper_count': {'type': 'integer'}, 'quality': {'type': 'string'}, 'title': {'type': 'string'}}, 'required': ['id', 'title', 'downloaded', 'quality', 'proper_count', 'first_seen', 'episode_id'], 'type': 'object'}, 'number': {'type': 'integer'}, 'number_of_releases': {'type': 'integer'}, 'premiere': {'type': ['string', 'boolean']}, 'season': {'type': 'integer'}, 'series_id': {'type': 'integer'}}, 'required': ['first_seen', 'id', 'identified_by', 'identifier', 'premiere', 'number', 'season', 'series_id', 'number_of_releases'], 'type': ['object', 'null']}, 'lookup': {'properties': {'tvdb': {'additionalProperties': False, 'properties': {'actors': {'items': {'type': 'string'}, 'type': 'array'}, 'airs_dayofweek': {'type': 'string'}, 'airs_time': {'type': 'string'}, 'aliases': {'items': {'type': 'string'}, 'type': 'array'}, 'banner': {'type': 'string'}, 'content_rating': {'type': 'string'}, 'expired': {'type': 'boolean'}, 'first_aired': {'type': 'string'}, 'genres': {'items': {'type': 'string'}, 'type': 'array'}, 'imdb_id': {'type': 'string'}, 'language': {'type': 'string'}, 'last_updated': {'format': 'date-time', 'type': 'string'}, 'network': {'type': 'string'}, 'overview': {'type': 'string'}, 'posters': {'items': {'type': 'string'}, 'type': 'array'}, 'rating': {'type': 'number'}, 'runtime': {'type': 'integer'}, 'series_name': {'type': 'string'}, 'status': {'type': 'string'}, 'tvdb_id': {'type': 'integer'}, 'zap2it_id': {'type': 'string'}}, 'required': ['tvdb_id', 'last_updated', 'expired', 'series_name', 'rating', 'status', 'runtime', 'airs_time', 'airs_dayofweek', 'content_rating', 'network', 'overview', 'imdb_id', 'zap2it_id', 'banner', 'first_aired', 'aliases', 'posters', 'genres', 'language'], 'type': 'object'}, 'tvmaze': {'additionalProperties': False, 'properties': {'genres': {'items': {'type': 'string'}, 'type': 'array'}, 'language': {'type': 'string'}, 'last_update': {'format': 'date-time', 'type': 'string'}, 'medium_image': {'type': 'string'}, 'name': {'type': 'string'}, 'network': {'type': ['string', 'null']}, 'original_image': {'type': 'string'}, 'premiered': {'format': 'date-time', 'type': 'string'}, 'rating': {'type': 'number'}, 'runtime': {'type': 'integer'}, 'schedule': {'properties': {'days': {'items': {'type': 'string'}, 'type': 'array'}, 'time': {'type': 'string'}}, 'type': 'object'}, 'show_type': {'type': 'string'}, 'status': {'type': 'string'}, 'summary': {'type': 'string'}, 'tvdb_id': {'type': 'integer'}, 'tvmaze_id': {'type': 'integer'}, 'tvrage_id': {'type': 'integer'}, 'updated': {'format': 'date-time', 'type': 'string'}, 'url': {'format': 'url', 'type': 'string'}, 'webchannel': {'type': ['string', 'null']}, 'weight': {'type': 'integer'}, 'year': {'type': 'integer'}}, 'required': ['tvmaze_id', 'status', 'rating', 'genres', 'weight', 'updated', 'name', 'language', 'schedule', 'url', 'original_image', 'medium_image', 'tvdb_id', 'tvrage_id', 'premiered', 'year', 'summary', 'webchannel', 'runtime', 'show_type', 'network', 'last_update'], 'type': 'object'}}, 'type': 'object'}, 'name': {'type': 'string'}}, 'required': ['id', 'name', 'alternate_names', 'in_tasks'], 'type': 'object'}#
- class flexget.components.series.api.SeriesAPI(api, *args, **kwargs)[source]#
Bases:
APIResource- Parameters:
api (RestxAPI)
- mediatypes()#
- endpoint = 'series_series_api'#
- methods: ClassVar[Collection[str] | None] = {'GET', 'POST'}#
The methods this view is registered for. Uses the same default (
["GET", "HEAD", "OPTIONS"]) asrouteandadd_url_ruleby default.
- class flexget.components.series.api.SeriesEpisodeAPI(api, *args, **kwargs)[source]#
Bases:
APIResource- Parameters:
api (RestxAPI)
- mediatypes()#
- endpoint = 'series_series_episode_api'#
- methods: ClassVar[Collection[str] | None] = {'DELETE', 'GET'}#
The methods this view is registered for. Uses the same default (
["GET", "HEAD", "OPTIONS"]) asrouteandadd_url_ruleby default.
- class flexget.components.series.api.SeriesEpisodeReleaseAPI(api, *args, **kwargs)[source]#
Bases:
APIResource- Parameters:
api (RestxAPI)
- delete(show_id, ep_id, rel_id, session)[source]#
Delete episode release by show ID, episode ID and release ID.
- get(show_id, ep_id, rel_id, session)[source]#
Get episode release by show ID, episode ID and release ID.
- mediatypes()#
- endpoint = 'series_series_episode_release_api'#
- methods: ClassVar[Collection[str] | None] = {'DELETE', 'GET', 'PUT'}#
The methods this view is registered for. Uses the same default (
["GET", "HEAD", "OPTIONS"]) asrouteandadd_url_ruleby default.
- class flexget.components.series.api.SeriesEpisodeReleasesAPI(api, *args, **kwargs)[source]#
Bases:
APIResource- Parameters:
api (RestxAPI)
- mediatypes()#
- endpoint = 'series_series_episode_releases_api'#
- methods: ClassVar[Collection[str] | None] = {'DELETE', 'GET', 'PUT'}#
The methods this view is registered for. Uses the same default (
["GET", "HEAD", "OPTIONS"]) asrouteandadd_url_ruleby default.
- class flexget.components.series.api.SeriesEpisodesAPI(api, *args, **kwargs)[source]#
Bases:
APIResource- Parameters:
api (RestxAPI)
- mediatypes()#
- endpoint = 'series_series_episodes_api'#
- methods: ClassVar[Collection[str] | None] = {'DELETE', 'GET'}#
The methods this view is registered for. Uses the same default (
["GET", "HEAD", "OPTIONS"]) asrouteandadd_url_ruleby default.
- class flexget.components.series.api.SeriesGetShowsAPI(api, *args, **kwargs)[source]#
Bases:
APIResource- Parameters:
api (RestxAPI)
- mediatypes()#
- endpoint = 'series_series_get_shows_api'#
- methods: ClassVar[Collection[str] | None] = {'GET'}#
The methods this view is registered for. Uses the same default (
["GET", "HEAD", "OPTIONS"]) asrouteandadd_url_ruleby default.
- class flexget.components.series.api.SeriesSeasonAPI(api, *args, **kwargs)[source]#
Bases:
APIResource- Parameters:
api (RestxAPI)
- mediatypes()#
- endpoint = 'series_series_season_api'#
- methods: ClassVar[Collection[str] | None] = {'DELETE', 'GET'}#
The methods this view is registered for. Uses the same default (
["GET", "HEAD", "OPTIONS"]) asrouteandadd_url_ruleby default.
- class flexget.components.series.api.SeriesSeasonReleaseAPI(api, *args, **kwargs)[source]#
Bases:
APIResource- Parameters:
api (RestxAPI)
- delete(show_id, season_id, rel_id, session)[source]#
Delete episode release by show ID, season ID and release ID.
- get(show_id, season_id, rel_id, session)[source]#
Get season release by show ID, season ID and release ID.
- mediatypes()#
- endpoint = 'series_series_season_release_api'#
- methods: ClassVar[Collection[str] | None] = {'DELETE', 'GET', 'PUT'}#
The methods this view is registered for. Uses the same default (
["GET", "HEAD", "OPTIONS"]) asrouteandadd_url_ruleby default.
- class flexget.components.series.api.SeriesSeasonsAPI(api, *args, **kwargs)[source]#
Bases:
APIResource- Parameters:
api (RestxAPI)
- mediatypes()#
- endpoint = 'series_series_seasons_api'#
- methods: ClassVar[Collection[str] | None] = {'DELETE', 'GET'}#
The methods this view is registered for. Uses the same default (
["GET", "HEAD", "OPTIONS"]) asrouteandadd_url_ruleby default.
- class flexget.components.series.api.SeriesSeasonsReleasesAPI(api, *args, **kwargs)[source]#
Bases:
APIResource- Parameters:
api (RestxAPI)
- mediatypes()#
- endpoint = 'series_series_seasons_releases_api'#
- methods: ClassVar[Collection[str] | None] = {'DELETE', 'GET', 'PUT'}#
The methods this view is registered for. Uses the same default (
["GET", "HEAD", "OPTIONS"]) asrouteandadd_url_ruleby default.
- class flexget.components.series.api.SeriesShowAPI(api, *args, **kwargs)[source]#
Bases:
APIResource- Parameters:
api (RestxAPI)
- mediatypes()#
- endpoint = 'series_series_show_api'#
- methods: ClassVar[Collection[str] | None] = {'DELETE', 'GET', 'PUT'}#
The methods this view is registered for. Uses the same default (
["GET", "HEAD", "OPTIONS"]) asrouteandadd_url_ruleby default.