Pages

Models

class nrk_psapi.models.pages.Placeholder

Bases: BaseDataClassORJSONMixin

Placeholder(type: ‘str | None’ = None, title: ‘str | None’ = None)

type: str | None = None

title: str | None = None

class nrk_psapi.models.pages.PageEcommerce

Bases: BaseDataClassORJSONMixin

PageEcommerce(brand: ‘str’, tracking_exempt: ‘bool’)

brand: str

tracking_exempt: bool

class nrk_psapi.models.pages.PlugEcommerce

Bases: BaseDataClassORJSONMixin

PlugEcommerce(id: ‘str’, name: ‘str’, position: ‘int’)

id: str

name: str

position: int

class nrk_psapi.models.pages.PlugAnalytics

Bases: BaseDataClassORJSONMixin

PlugAnalytics(content_id: ‘str’, content_source: ‘str’, title: ‘str | None’ = None)

content_id: str

content_source: str

title: str | None = None

class nrk_psapi.models.pages.ProductCustomDimensions

Bases: BaseDataClassORJSONMixin

ProductCustomDimensions(dimension37: ‘str’, dimension38: ‘str | None’ = None, dimension39: ‘str | None’ = None)

dimension37: str

dimension38: str | None = None

dimension39: str | None = None

class nrk_psapi.models.pages.TemplatedLink

Bases: BaseDataClassORJSONMixin

TemplatedLink(href: ‘str’, templated: ‘Literal[True] | None’ = None)

href: str

templated: Optional[Literal[True]] = None

class nrk_psapi.models.pages.ButtonItem

Bases: BaseDataClassORJSONMixin

ButtonItem(title: ‘str’, page_id: ‘str’, url: ‘str’, page_type: ‘PageTypeEnum’)

title: str

page_id: str

url: str

page_type: PageTypeEnum

class nrk_psapi.models.pages.SectionEcommerce

Bases: BaseDataClassORJSONMixin

SectionEcommerce(list: ‘str’, variant: ‘str’, category: ‘str’, product_custom_dimensions: ‘ProductCustomDimensions’)

list: str

variant: str

category: str

product_custom_dimensions: ProductCustomDimensions

class nrk_psapi.models.pages.StandaloneProgramLinks

Bases: BaseDataClassORJSONMixin

StandaloneProgramLinks(program: ‘Link’, playback_metadata: ‘Link’, playback_manifest: ‘Link’, share: ‘Link’)

program: Link

playback_metadata: Link

playback_manifest: Link

share: Link

class nrk_psapi.models.pages.PageListItemLinks

Bases: BaseDataClassORJSONMixin

PageListItemLinks(self: ‘Link’)

self: Link

class nrk_psapi.models.pages.PageLinks

Bases: BaseDataClassORJSONMixin

PageLinks(self: ‘Link’)

self: Link

class nrk_psapi.models.pages.SeriesLinks

Bases: BaseDataClassORJSONMixin

SeriesLinks(series: ‘Link’, share: ‘Link’, favourite: ‘TemplatedLink | None’ = None)

series: Link

share: Link

favourite: TemplatedLink | None = None

class nrk_psapi.models.pages.ChannelLinks

Bases: BaseDataClassORJSONMixin

ChannelLinks(playback_metadata: ‘Link’, playback_manifest: ‘Link’, share: ‘Link’)

playback_metadata: Link

playback_manifest: Link

share: Link

class nrk_psapi.models.pages.ChannelPlugLinks

Bases: BaseDataClassORJSONMixin

ChannelPlugLinks(channel: ‘str’)

channel: str

class nrk_psapi.models.pages.SeriesPlugLinks

Bases: BaseDataClassORJSONMixin

SeriesPlugLinks(series: ‘str’)

series: str

class nrk_psapi.models.pages.PodcastPlugLinks

Bases: BaseDataClassORJSONMixin

PodcastPlugLinks(podcast: ‘str’)

podcast: str

class nrk_psapi.models.pages.PodcastEpisodePlugLinks

Bases: BaseDataClassORJSONMixin

PodcastEpisodePlugLinks(podcast_episode: ‘str’, podcast: ‘str’, audio_download: ‘str’)

podcast_episode: str

podcast: str

audio_download: str

class nrk_psapi.models.pages.EpisodePlugLinks

Bases: BaseDataClassORJSONMixin

EpisodePlugLinks(episode: ‘str’, mediaelement: ‘str’, series: ‘str’, season: ‘str’)

episode: str

mediaelement: str

series: str

season: str

class nrk_psapi.models.pages.StandaloneProgramPlugLinks

Bases: BaseDataClassORJSONMixin

StandaloneProgramPlugLinks(program: ‘str’, mediaelement: ‘str’)

program: str

mediaelement: str

class nrk_psapi.models.pages.PodcastSeasonLinks

Bases: BaseDataClassORJSONMixin

PodcastSeasonLinks(podcast_season: ‘Link’, podcast: ‘Link’, share: ‘Link’, favourite: ‘TemplatedLink | None’ = None)

podcast_season: Link

podcast: Link

share: Link

favourite: TemplatedLink | None = None

class nrk_psapi.models.pages.LinkPlugLinks

Bases: BaseDataClassORJSONMixin

LinkPlugLinks(external_url: ‘Link’)

external_url: Link

class nrk_psapi.models.pages.PagePlugLinks

Bases: BaseDataClassORJSONMixin

PagePlugLinks(page_url: ‘Link’)

page_url: Link

class nrk_psapi.models.pages.Links

Bases: BaseDataClassORJSONMixin

Links(self: ‘Link’)

self: Link

class nrk_psapi.models.pages.Plug

Bases: BaseDataClassORJSONMixin

Plug()

class nrk_psapi.models.pages.Section

Bases: BaseDataClassORJSONMixin

Section()

class nrk_psapi.models.pages.PlaceholderSection

Bases: Section

PlaceholderSection(placeholder: ‘Placeholder’, id: ‘str | None’ = None, e_commerce: ‘SectionEcommerce | None’ = None)

type = 'placeholder'

placeholder: Placeholder

id: str | None = None

e_commerce: SectionEcommerce | None = None

class nrk_psapi.models.pages.PluggedEpisode

Bases: BaseDataClassORJSONMixin

PluggedEpisode(titles: ‘Titles’, image: ‘WebImage’, duration: ‘timedelta’, series: ‘PluggedSeries | None’ = None)

title: str

titles: Titles

image: WebImage

duration: timedelta

series: PluggedSeries | None = None

class nrk_psapi.models.pages.PluggedSeries

Bases: BaseDataClassORJSONMixin

PluggedSeries(titles: ‘Titles’, image: ‘WebImage | None’ = None, number_of_episodes: ‘int | None’ = None)

title: str

titles: Titles

image: WebImage | None = None

number_of_episodes: int | None = None

class nrk_psapi.models.pages.PluggedChannel

Bases: BaseDataClassORJSONMixin

PluggedChannel(titles: ‘Titles’, image: ‘WebImage | None’ = None)

title: str

titles: Titles

image: WebImage | None = None

class nrk_psapi.models.pages.PluggedStandaloneProgram

Bases: BaseDataClassORJSONMixin

PluggedStandaloneProgram(titles: ‘Titles’, image: ‘WebImage’, duration: ‘timedelta’)

title: str

titles: Titles

image: WebImage

duration: timedelta

class nrk_psapi.models.pages.PluggedPodcast

Bases: BaseDataClassORJSONMixin

PluggedPodcast(titles: ‘Titles’, image_url: ‘str | None’ = None, number_of_episodes: ‘int | None’ = None)

podcast_title: str

titles: Titles

image_url: str | None = None

number_of_episodes: int | None = None

class nrk_psapi.models.pages.PluggedPodcastEpisode

Bases: BaseDataClassORJSONMixin

PluggedPodcastEpisode(titles: ‘Titles’, duration: ‘timedelta’, image_url: ‘str’, podcast: ‘PluggedPodcast’)

title: str

titles: Titles

duration: timedelta

image_url: str

podcast: PluggedPodcast

podcast_title: str

class nrk_psapi.models.pages.PluggedPodcastSeason

Bases: BaseDataClassORJSONMixin

PluggedPodcastSeason(_links: ‘PodcastSeasonLinks | None’ = None, podcast_id: ‘str | None’ = None, season_id: ‘str | None’ = None, season_number: ‘int | None’ = None, number_of_episodes: ‘int | None’ = None, image_url: ‘str | None’ = None, podcast_title: ‘str | None’ = None, podcast_season_title: ‘str | None’ = None)

_links: PodcastSeasonLinks | None = None

podcast_id: str | None = None

season_id: str | None = None

season_number: int | None = None

number_of_episodes: int | None = None

image_url: str | None = None

podcast_title: str | None = None

podcast_season_title: str | None = None

class nrk_psapi.models.pages.LinkPlugInner

Bases: BaseDataClassORJSONMixin

LinkPlugInner(_links: ‘LinkPlugLinks’)

_links: LinkPlugLinks

class nrk_psapi.models.pages.PagePlugInner

Bases: BaseDataClassORJSONMixin

PagePlugInner(_links: ‘PagePlugLinks’, page_id: ‘str’)

_links: PagePlugLinks

page_id: str

class nrk_psapi.models.pages.PageListItem

Bases: BaseDataClassORJSONMixin

PageListItem(_links: ‘PageListItemLinks’, title: ‘str’, id: ‘str | None’ = None, image: ‘WebImage | None’ = None, image_square: ‘WebImage | None’ = None)

_links: PageListItemLinks

title: str

id: str | None = None

image: WebImage | None = None

image_square: WebImage | None = None

class nrk_psapi.models.pages.Pages

Bases: BaseDataClassORJSONMixin

Pages(_links: ‘Links’, pages: ‘list[PageListItem]’)

_links: Links

pages: list[PageListItem]

class nrk_psapi.models.pages.ChannelPlug

Bases: Plug

ChannelPlug(_links: ‘ChannelPlugLinks’, channel: ‘PluggedChannel’)

id: str

type = 'channel'

_links: ChannelPlugLinks

channel: PluggedChannel

class nrk_psapi.models.pages.SeriesPlug

Bases: Plug

SeriesPlug(_links: ‘SeriesPlugLinks’, series: ‘PluggedSeries’)

id: str

title: str

type = 'series'

_links: SeriesPlugLinks

series: PluggedSeries

class nrk_psapi.models.pages.EpisodePlug

Bases: Plug

EpisodePlug(_links: ‘EpisodePlugLinks’, episode: ‘PluggedEpisode’)

id: str

series_id: str

title: str

type = 'episode'

_links: EpisodePlugLinks

episode: PluggedEpisode

class nrk_psapi.models.pages.StandaloneProgramPlug

Bases: Plug

StandaloneProgramPlug(_links: ‘StandaloneProgramPlugLinks’, program: ‘PluggedStandaloneProgram’)

id: str

type = 'standaloneProgram'

_links: StandaloneProgramPlugLinks

program: PluggedStandaloneProgram

class nrk_psapi.models.pages.PodcastPlug

Bases: Plug

PodcastPlug(podcast: ‘PluggedPodcast’, _links: ‘PodcastPlugLinks’)

id: str

title: str

tagline: str

type = 'podcast'

podcast: PluggedPodcast

_links: PodcastPlugLinks

class nrk_psapi.models.pages.PodcastEpisodePlug

Bases: Plug

PodcastEpisodePlug(podcast_episode: ‘PluggedPodcastEpisode’, _links: ‘PodcastEpisodePlugLinks’)

id: str

podcast_id: str

type = 'podcastEpisode'

podcast_episode: PluggedPodcastEpisode

_links: PodcastEpisodePlugLinks

class nrk_psapi.models.pages.PodcastSeasonPlug

Bases: Plug

PodcastSeasonPlug(id: ‘str’, podcast_season: ‘PluggedPodcastSeason’, image: ‘WebImage | None’ = None)

type = 'podcastSeason'

id: str

podcast_season: PluggedPodcastSeason

image: WebImage | None = None

class nrk_psapi.models.pages.LinkPlug

Bases: Plug

LinkPlug(link: ‘LinkPlugInner’, id: ‘str | None’ = None, image: ‘WebImage | None’ = None)

type = 'link'

link: LinkPlugInner

id: str | None = None

image: WebImage | None = None

class nrk_psapi.models.pages.PagePlug

Bases: Plug

PagePlug(page: ‘PagePlugInner’, id: ‘str | None’ = None, image: ‘WebImage | None’ = None)

type = 'page'

page: PagePlugInner

id: str | None = None

image: WebImage | None = None

class nrk_psapi.models.pages.Included

Bases: BaseDataClassORJSONMixin

Included(title: ‘str’, plugs: ‘list[Plug]’)

section_id: str

title: str

plugs: list[Plug]

class nrk_psapi.models.pages.IncludedSection

Bases: Section

IncludedSection(included: ‘Included’)

type = 'included'

included: Included

class nrk_psapi.models.pages.Page

Bases: BaseDataClassORJSONMixin

Page(title: ‘str’, sections: ‘list[Section]’, _links: ‘PageLinks’)

id: str

title: str

sections: list[Section]

_links: PageLinks

class nrk_psapi.models.pages.CuratedPodcast

Bases: BaseDataClassORJSONMixin

CuratedPodcast(id: ‘str’, title: ‘str’, subtitle: ‘str’, image: ‘str’, number_of_episodes: ‘int’)

id: str

title: str

subtitle: str

image: str

number_of_episodes: int

class nrk_psapi.models.pages.CuratedSection

Bases: BaseDataClassORJSONMixin

CuratedSection(id: ‘str’, title: ‘str’, podcasts: ‘list[CuratedPodcast]’)

id: str

title: str

podcasts: list[CuratedPodcast]

class nrk_psapi.models.pages.Curated

Bases: BaseDataClassORJSONMixin

Curated(sections: ‘list[CuratedSection]’)

sections: list[CuratedSection]

get_section_by_id(section_id)

Return the CuratedSection with the given id.

Return type:

CuratedSection | None

Parameters:

section_id (str)

Enums

enum nrk_psapi.models.pages.DisplayType(value)

Bases: StrEnum

Member Type:

str

Valid values are as follows:

DEFAULT = <DisplayType.DEFAULT: 'default'>

GRID = <DisplayType.GRID: 'grid'>

enum nrk_psapi.models.pages.DisplayContract(value)

Bases: StrEnum

Member Type:

str

Valid values are as follows:

HERO = <DisplayContract.HERO: 'hero'>

EDITORIAL = <DisplayContract.EDITORIAL: 'editorial'>

INLINEHERO = <DisplayContract.INLINEHERO: 'inlineHero'>

LANDSCAPE = <DisplayContract.LANDSCAPE: 'landscape'>

LANDSCAPELOGO = <DisplayContract.LANDSCAPELOGO: 'landscapeLogo'>

SIMPLE = <DisplayContract.SIMPLE: 'simple'>

SQUARED = <DisplayContract.SQUARED: 'squared'>

SQUAREDLOGO = <DisplayContract.SQUAREDLOGO: 'squaredLogo'>

NYHETSATOM = <DisplayContract.NYHETSATOM: 'nyhetsAtom'>

RADIOMULTIHERO = <DisplayContract.RADIOMULTIHERO: 'radioMultiHero'>

SIDEKICKLOGO = <DisplayContract.SIDEKICKLOGO: 'sidekickLogo'>

enum nrk_psapi.models.pages.PlugSize(value)

Bases: StrEnum

Member Type:

str

Valid values are as follows:

SMALL = <PlugSize.SMALL: 'small'>

MEDIUM = <PlugSize.MEDIUM: 'medium'>

LARGE = <PlugSize.LARGE: 'large'>

enum nrk_psapi.models.pages.PlugType(value)

Bases: StrEnum

Member Type:

str

Valid values are as follows:

CHANNEL = <PlugType.CHANNEL: 'channel'>

SERIES = <PlugType.SERIES: 'series'>

EPISODE = <PlugType.EPISODE: 'episode'>

STANDALONE_PROGRAM = <PlugType.STANDALONE_PROGRAM: 'standaloneProgram'>

PODCAST = <PlugType.PODCAST: 'podcast'>

PODCAST_EPISODE = <PlugType.PODCAST_EPISODE: 'podcastEpisode'>

PODCAST_SEASON = <PlugType.PODCAST_SEASON: 'podcastSeason'>

LINK = <PlugType.LINK: 'link'>

PAGE = <PlugType.PAGE: 'page'>

enum nrk_psapi.models.pages.SectionType(value)

Bases: StrEnum

Member Type:

str

Valid values are as follows:

INCLUDED = <SectionType.INCLUDED: 'included'>

PLACEHOLDER = <SectionType.PLACEHOLDER: 'placeholder'>

enum nrk_psapi.models.pages.PageTypeEnum(value)

Bases: StrEnum

Member Type:

str

Valid values are as follows:

CATEGORY = <PageTypeEnum.CATEGORY: 'category'>

SUBCATEGORY = <PageTypeEnum.SUBCATEGORY: 'subcategory'>