Search#
Models#
- class nrk_psapi.models.search.SearchResultLink[source]#
Bases:
BaseDataClassORJSONMixinRepresents a link in the API search response.
- class nrk_psapi.models.search.Links[source]#
Bases:
BaseDataClassORJSONMixinRepresents the _links object in the API response.
- class nrk_psapi.models.search.SeriesListItemLinks[source]#
Bases:
BaseDataClassORJSONMixinSeriesListItemLinks(series: ‘Link | None’ = None, podcast: ‘Link | None’ = None, custom_season: ‘Link | None’ = None, single_program: ‘Link | None’ = None)
- class nrk_psapi.models.search.SeriesListItem[source]#
Bases:
BaseDataClassORJSONMixinSeriesListItem(_links: ‘SeriesListItemLinks’, id: ‘str’, type: ‘Literal[SearchResultType.SERIES, SearchResultType.PODCAST, SearchResultType.SINGLE_PROGRAM, SearchResultType.CUSTOM_SEASON]’, title: ‘str’, initial_character: ‘str’, images: ‘list[Image]’, square_images: ‘list[Image] | None’ = None, series_id: ‘str | None’ = None, season_id: ‘str | None’ = None)
-
_links:
SeriesListItemLinks#
-
_links:
- class nrk_psapi.models.search.LetterListItem[source]#
Bases:
BaseDataClassORJSONMixinLetterListItem(letter: ‘str’, count: ‘int’, link: ‘str’)
- class nrk_psapi.models.search.CategoriesLinks[source]#
Bases:
BaseDataClassORJSONMixinCategoriesLinks(next_page: ‘Link | None’ = None, prev_page: ‘Link | None’ = None, next_letter: ‘Link | None’ = None, prev_letter: ‘Link | None’ = None)
- class nrk_psapi.models.search.CategoriesResponse[source]#
Bases:
BaseDataClassORJSONMixinCategoriesResponse(_links: ‘CategoriesLinks’, letters: ‘list[LetterListItem]’, title: ‘str’, series: ‘list[SeriesListItem]’, total_count: ‘int’)
-
_links:
CategoriesLinks#
-
letters:
list[LetterListItem]#
-
series:
list[SeriesListItem]#
-
_links:
- class nrk_psapi.models.search.Letter[source]#
Bases:
BaseDataClassORJSONMixinRepresents a letter object in the letters array.
- class nrk_psapi.models.search.Highlight[source]#
Bases:
BaseDataClassORJSONMixinRepresents a highlight object in the highlights array.
- class nrk_psapi.models.search.SearchedSeries[source]#
Bases:
BaseDataClassORJSONMixinRepresents a series object in the series array.
-
type:
SearchResultType#
-
type:
- class nrk_psapi.models.search.PodcastSearchResponse[source]#
Bases:
BaseDataClassORJSONMixinRepresents the main response object from the podcast search API.
-
series:
list[SearchedSeries]#
-
series:
- class nrk_psapi.models.search.SearchResponseCounts[source]#
Bases:
BaseDataClassORJSONMixinRepresents the counts object in the main response object from the podcast search API.
- class nrk_psapi.models.search.SearchResponseResult[source]#
Bases:
BaseDataClassORJSONMixinRepresents the result object in the results array in the main response object from the podcast search API.
-
type:
SearchResultType#
-
type:
- class nrk_psapi.models.search.SearchResponseResultCategory[source]#
Bases:
SearchResponseResultRepresents a category object in the results array in the main response object from the podcast search API.
-
type:
SearchResultType= 'category'#
-
type:
- class nrk_psapi.models.search.SearchResponseResultChannel[source]#
Bases:
SearchResponseResultRepresents a channel object in the results array in the main response object from the podcast search API.
-
type:
SearchResultType= 'channel'#
-
type:
- class nrk_psapi.models.search.SearchResponseResultSeries[source]#
Bases:
SearchResponseResultRepresents a series object in the results array in the main response object from the podcast search API.
-
type:
SearchResultType= 'series'#
-
type:
- class nrk_psapi.models.search.SearchResponseResultCustomSeason[source]#
Bases:
SearchResponseResultRepresents a custom season object in the results array in the main response object from the podcast search API.
-
type:
SearchResultType= 'customSeason'#
-
type:
- class nrk_psapi.models.search.SearchResponseResultPodcast[source]#
Bases:
SearchResponseResultRepresents a podcast object in the results array in the main response object from the podcast search API.
-
type:
SearchResultType= 'podcast'#
-
type:
- class nrk_psapi.models.search.SearchResponseResultEpisode[source]#
Bases:
SearchResponseResultRepresents an episode object in the results array in the main response object from the podcast search API.
-
type:
SearchResultType= 'podcastEpisode'#
-
type:
- class nrk_psapi.models.search.SearchResponseResultCustomSeasonEpisode[source]#
Bases:
SearchResponseResultRepresents a custom season episode object in the results array in the main response object from the podcast search API.
-
type:
SearchResultType= 'customSeasonEpisode'#
-
type:
- class nrk_psapi.models.search.SearchResponseResultSeriesEpisode[source]#
Bases:
SearchResponseResultEpisodeSearchResponseResultSeriesEpisode(id: ‘str’, type: ‘SearchResultType’, images: ‘list[Image]’, highlights: ‘list[Highlight]’, title: ‘str’, episode_id: ‘str’, series_id: ‘str’, series_title: ‘str’, date: ‘datetime’, square_images: ‘list[Image]’, season_id: ‘str | None’ = None)
-
type:
SearchResultType= 'seriesEpisode'#
-
type:
- class nrk_psapi.models.search.SearchResponseResultsResult[source]#
Bases:
BaseDataClassORJSONMixinRepresents the result object in the results array in the main response object from the podcast search API.
-
results:
list[SearchResponseResult]#
-
links:
SearchResultLink|None= None#
-
results:
- class nrk_psapi.models.search.SearchResponseResults[source]#
Bases:
BaseDataClassORJSONMixinRepresents the results object in the main response object from the podcast search API.
-
channels:
SearchResponseResultsResult#
-
categories:
SearchResponseResultsResult#
-
series:
SearchResponseResultsResult#
-
episodes:
SearchResponseResultsResult#
-
contents:
SearchResponseResultsResult#
-
contributors:
SearchResponseResultsResult#
-
channels:
- class nrk_psapi.models.search.SearchResponse[source]#
Bases:
BaseDataClassORJSONMixinRepresents the main response object from the podcast search API.
-
take_count:
SearchResponseCounts#
-
total_count:
SearchResponseCounts#
-
results:
SearchResponseResults#
-
take_count:
Enums#
- enum nrk_psapi.models.search.SearchResultType(value)[source]#
Bases:
StrEnumThe different types of search results that can be returned.
- Member Type:
Valid values are as follows:
- CATEGORY = <SearchResultType.CATEGORY: 'category'>#
- CHANNEL = <SearchResultType.CHANNEL: 'channel'>#
- PODCAST = <SearchResultType.PODCAST: 'podcast'>#
- PODCAST_EPISODE = <SearchResultType.PODCAST_EPISODE: 'podcastEpisode'>#
- SERIES = <SearchResultType.SERIES: 'series'>#
- SERIES_EPISODE = <SearchResultType.SERIES_EPISODE: 'seriesEpisode'>#
- CUSTOM_SEASON = <SearchResultType.CUSTOM_SEASON: 'customSeason'>#
- CUSTOM_SEASON_EPISODE = <SearchResultType.CUSTOM_SEASON_EPISODE: 'customSeasonEpisode'>#
- SINGLE_PROGRAM = <SearchResultType.SINGLE_PROGRAM: 'singleProgram'>#