# generated by update to not change manually
import dataclasses as dt
import typing as t
from bungieapi.json import to_json
[docs]@dt.dataclass(frozen=True)
class DestinySeasonDefinition:
"""Defines a canonical "Season" of Destiny: a range of a few months where
the game highlights certain challenges, provides new loot, has new Clan-
related rewards and celebrates various seasonal events."""
artifact_item_hash: t.Optional[int] = None
background_image_path: t.Optional[str] = None
display_properties: t.Optional["DestinyDisplayPropertiesDefinition"] = None
end_date: t.Optional[str] = None
hash: t.Optional[
int
] = None # The unique identifier for this entity. Guaranteed to be unique for the type of entity, but not globally. When entities refer to each other in Destiny content, it is this hash that they are referring to.
index: t.Optional[
int
] = None # The index of the entity as it was found in the investment tables.
preview: t.Optional[
"DestinySeasonPreviewDefinition"
] = None # Optional - Defines the promotional text, images, and links to preview this season.
redacted: t.Optional[
bool
] = None # If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
seal_presentation_node_hash: t.Optional[int] = None
season_number: t.Optional[int] = None
season_pass_hash: t.Optional[int] = None
season_pass_progression_hash: t.Optional[int] = None
seasonal_challenges_presentation_node_hash: t.Optional[int] = None
start_date: t.Optional[str] = None
[docs] def to_json(self) -> t.Mapping[str, t.Any]:
return {
"displayProperties": to_json(self.display_properties),
"backgroundImagePath": to_json(self.background_image_path),
"seasonNumber": to_json(self.season_number),
"startDate": to_json(self.start_date),
"endDate": to_json(self.end_date),
"seasonPassHash": to_json(self.season_pass_hash),
"seasonPassProgressionHash": to_json(self.season_pass_progression_hash),
"artifactItemHash": to_json(self.artifact_item_hash),
"sealPresentationNodeHash": to_json(self.seal_presentation_node_hash),
"seasonalChallengesPresentationNodeHash": to_json(
self.seasonal_challenges_presentation_node_hash
),
"preview": to_json(self.preview),
"hash": to_json(self.hash),
"index": to_json(self.index),
"redacted": to_json(self.redacted),
}
[docs]@dt.dataclass(frozen=True)
class DestinySeasonPreviewDefinition:
"""Defines the promotional text, images, and links to preview this
season."""
description: t.Optional[str] = None # A localized description of the season.
images: t.Optional[
t.Sequence["DestinySeasonPreviewImageDefinition"]
] = None # A list of images to preview the seasonal content. Should have at least three to show.
link_path: t.Optional[
str
] = None # A relative path to learn more about the season. Web browsers should be automatically redirected to the user's Bungie.net locale. For example: "/SeasonOfTheChosen" will redirect to "/7/en/Seasons/SeasonOfTheChosen" for English users.
video_link: t.Optional[
str
] = None # An optional link to a localized video, probably YouTube.
[docs] def to_json(self) -> t.Mapping[str, t.Any]:
return {
"description": to_json(self.description),
"linkPath": to_json(self.link_path),
"videoLink": to_json(self.video_link),
"images": to_json(self.images),
}
[docs]@dt.dataclass(frozen=True)
class DestinySeasonPreviewImageDefinition:
"""Defines the thumbnail icon, high-res image, and video link for
promotional images."""
high_res_image: t.Optional[
str
] = None # An optional path to a high-resolution image, probably 1920x1080.
thumbnail_image: t.Optional[
str
] = None # A thumbnail icon path to preview seasonal content, probably 480x270.
[docs] def to_json(self) -> t.Mapping[str, t.Any]:
return {
"thumbnailImage": to_json(self.thumbnail_image),
"highResImage": to_json(self.high_res_image),
}
[docs]@dt.dataclass(frozen=True)
class DestinySeasonPassDefinition:
display_properties: t.Optional["DestinyDisplayPropertiesDefinition"] = None
hash: t.Optional[
int
] = None # The unique identifier for this entity. Guaranteed to be unique for the type of entity, but not globally. When entities refer to each other in Destiny content, it is this hash that they are referring to.
index: t.Optional[
int
] = None # The index of the entity as it was found in the investment tables.
prestige_progression_hash: t.Optional[
int
] = None # I know what you're thinking, but I promise we're not going to duplicate and drown you. Instead, we're giving you sweet, sweet power bonuses. Prestige progression is further progression that you can make on the Season pass after you gain max ranks, that will ultimately increase your power/light level over the theoretical limit.
redacted: t.Optional[
bool
] = None # If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
reward_progression_hash: t.Optional[
int
] = None # This is the progression definition related to the progression for the initial levels 1-100 that provide item rewards for the Season pass. Further experience after you reach the limit is provided in the "Prestige" progression referred to by prestigeProgressionHash.
[docs] def to_json(self) -> t.Mapping[str, t.Any]:
return {
"displayProperties": to_json(self.display_properties),
"rewardProgressionHash": to_json(self.reward_progression_hash),
"prestigeProgressionHash": to_json(self.prestige_progression_hash),
"hash": to_json(self.hash),
"index": to_json(self.index),
"redacted": to_json(self.redacted),
}
# imported at the end to do not case circular imports for type annotations
from bungieapi.generated.components.schemas.destiny.definitions.common import (
DestinyDisplayPropertiesDefinition,
) # noqa: E402