# 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 DestinyLinkedProfilesResponse:
"""I know what you seek.
You seek linked accounts. Found them, you have. This contract
returns a minimal amount of data about Destiny Accounts that are
linked through your Bungie.Net account. We will not return accounts
in this response whose
"""
bnet_membership: t.Optional[
"UserInfoCard"
] = None # If the requested membership had a linked Bungie.Net membership ID, this is the basic information about that BNet account. I know, Tetron; I know this is mixing UserServices concerns with DestinyServices concerns. But it's so damn convenient! https://www.youtube.com/watch?v=X5R-bB-gKVI
profiles: t.Optional[
t.Sequence["DestinyProfileUserInfoCard"]
] = None # Any Destiny account for whom we could successfully pull characters will be returned here, as the Platform-level summary of user data. (no character data, no Destiny account data other than the Membership ID and Type so you can make further queries)
profiles_with_errors: t.Optional[
t.Sequence["DestinyErrorProfile"]
] = None # This is brief summary info for profiles that we believe have valid Destiny info, but who failed to return data for some other reason and thus we know that subsequent calls for their info will also fail.
[docs] def to_json(self) -> t.Mapping[str, t.Any]:
return {
"profiles": to_json(self.profiles),
"bnetMembership": to_json(self.bnet_membership),
"profilesWithErrors": to_json(self.profiles_with_errors),
}
[docs]@dt.dataclass(frozen=True)
class DestinyProfileUserInfoCard:
applicable_membership_types: t.Optional[
t.Sequence["BungieMembershipType"]
] = None # The list of Membership Types indicating the platforms on which this Membership can be used. Not in Cross Save = its original membership type. Cross Save Primary = Any membership types it is overridding, and its original membership type Cross Save Overridden = Empty list
bungie_global_display_name: t.Optional[
str
] = None # The bungie global display name, if set.
bungie_global_display_name_code: t.Optional[
int
] = None # The bungie global display name code, if set.
cross_save_override: t.Optional[
"BungieMembershipType"
] = None # If there is a cross save override in effect, this value will tell you the type that is overridding this one.
date_last_played: t.Optional[str] = None
display_name: t.Optional[
str
] = None # Display Name the player has chosen for themselves. The display name is optional when the data type is used as input to a platform API.
icon_path: t.Optional[str] = None # URL the Icon if available.
is_cross_save_primary: t.Optional[
bool
] = None # If true, this account is hooked up as the "Primary" cross save account for one or more platforms.
is_overridden: t.Optional[
bool
] = None # If this profile is being overridden/obscured by Cross Save, this will be set to true. We will still return the profile for display purposes where users need to know the info: it is up to any given area of the app/site to determine if this profile should still be shown.
is_public: t.Optional[bool] = None # If True, this is a public user membership.
membership_id: t.Optional[
int
] = None # Membership ID as they user is known in the Accounts service
membership_type: t.Optional[
"BungieMembershipType"
] = None # Type of the membership. Not necessarily the native type.
platform_silver: t.Optional[
"DestinyPlatformSilverComponent"
] = None # This is the silver available on this Profile across any platforms on which they have purchased silver. This is only available if you are requesting yourself.
supplemental_display_name: t.Optional[
str
] = None # A platform specific additional display name - ex: psn Real Name, bnet Unique Name, etc.
unpaired_game_versions: t.Optional[
int
] = None # If this profile is not in a cross save pairing, this will return the game versions that we believe this profile has access to. For the time being, we will not return this information for any membership that is in a cross save pairing. The gist is that, once the pairing occurs, we do not currently have a consistent way to get that information for the profile's original Platform, and thus gameVersions would be too inconsistent (based on the last platform they happened to play on) for the info to be useful. If we ever can get this data, this field will be deprecated and replaced with data on the DestinyLinkedProfileResponse itself, with game versions per linked Platform. But since we can't get that, we have this as a stop-gap measure for getting the data in the only situation that we currently need it.
[docs] def to_json(self) -> t.Mapping[str, t.Any]:
return {
"dateLastPlayed": to_json(self.date_last_played),
"isOverridden": to_json(self.is_overridden),
"isCrossSavePrimary": to_json(self.is_cross_save_primary),
"platformSilver": to_json(self.platform_silver),
"unpairedGameVersions": to_json(self.unpaired_game_versions),
"supplementalDisplayName": to_json(self.supplemental_display_name),
"iconPath": to_json(self.icon_path),
"crossSaveOverride": to_json(self.cross_save_override),
"applicableMembershipTypes": to_json(self.applicable_membership_types),
"isPublic": to_json(self.is_public),
"membershipType": to_json(self.membership_type),
"membershipId": to_json(self.membership_id),
"displayName": to_json(self.display_name),
"bungieGlobalDisplayName": to_json(self.bungie_global_display_name),
"bungieGlobalDisplayNameCode": to_json(
self.bungie_global_display_name_code
),
}
[docs]@dt.dataclass(frozen=True)
class DestinyErrorProfile:
"""If a Destiny Profile can't be returned, but we're pretty certain it's a
valid Destiny account, this will contain as much info as we can get about
the profile for your use.
Assume that the most you'll get is the Error Code, the Membership
Type and the Membership ID.
"""
error_code: t.Optional[
"PlatformErrorCodes"
] = None # The error that we encountered. You should be able to look up localized text to show to the user for these failures.
info_card: t.Optional[
"UserInfoCard"
] = None # Basic info about the account that failed. Don't expect anything other than membership ID, Membership Type, and displayName to be populated.
[docs] def to_json(self) -> t.Mapping[str, t.Any]:
return {
"errorCode": to_json(self.error_code),
"infoCard": to_json(self.info_card),
}
[docs]@dt.dataclass(frozen=True)
class DestinyProfileResponse:
"""The response for GetDestinyProfile, with components for character and
item-level data."""
character_activities: t.Optional[
"DictionaryComponentResponseOfint64AndDestinyCharacterActivitiesComponent"
] = None # Character activity data - the activities available to this character and its status, keyed by the Character's Id. COMPONENT TYPE: CharacterActivities
character_collectibles: t.Optional[
"DictionaryComponentResponseOfint64AndDestinyCollectiblesComponent"
] = None # COMPONENT TYPE: Collectibles
character_currency_lookups: t.Optional[
"DictionaryComponentResponseOfint64AndDestinyCurrenciesComponent"
] = None # A "lookup" convenience component that can be used to quickly check if the character has access to items that can be used for purchasing. COMPONENT TYPE: CurrencyLookups
character_equipment: t.Optional[
"DictionaryComponentResponseOfint64AndDestinyInventoryComponent"
] = None # The character's equipped items, keyed by the Character's Id. COMPONENT TYPE: CharacterEquipment
character_inventories: t.Optional[
"DictionaryComponentResponseOfint64AndDestinyInventoryComponent"
] = None # The character-level non-equipped inventory items, keyed by the Character's Id. COMPONENT TYPE: CharacterInventories
character_kiosks: t.Optional[
"DictionaryComponentResponseOfint64AndDestinyKiosksComponent"
] = None # Items available from Kiosks that are available to a specific character as opposed to the account as a whole. It must be combined with data from the profileKiosks property to get a full picture of the character's available items to check out of a kiosk. This component returns information about what Kiosk items are available to you on a *Character* level. Usually, kiosk items will be earned for the entire Profile (all characters) at once. To find those, look in the profileKiosks property. COMPONENT TYPE: Kiosks
character_plug_sets: t.Optional[
"DictionaryComponentResponseOfint64AndDestinyPlugSetsComponent"
] = None # When sockets refer to reusable Plug Sets (see DestinyPlugSetDefinition for more info), this is the set of plugs and their states, per character, that are character-scoped. This comes back with ItemSockets, as it is needed for a complete picture of the sockets on requested items. COMPONENT TYPE: ItemSockets
character_presentation_nodes: t.Optional[
"DictionaryComponentResponseOfint64AndDestinyPresentationNodesComponent"
] = None # COMPONENT TYPE: PresentationNodes
character_progressions: t.Optional[
"DictionaryComponentResponseOfint64AndDestinyCharacterProgressionComponent"
] = None # Character-level progression data, keyed by the Character's Id. COMPONENT TYPE: CharacterProgressions
character_records: t.Optional[
"DictionaryComponentResponseOfint64AndDestinyCharacterRecordsComponent"
] = None # COMPONENT TYPE: Records
character_render_data: t.Optional[
"DictionaryComponentResponseOfint64AndDestinyCharacterRenderComponent"
] = None # Character rendering data - a minimal set of info needed to render a character in 3D - keyed by the Character's Id. COMPONENT TYPE: CharacterRenderData
character_string_variables: t.Optional[
"DictionaryComponentResponseOfint64AndDestinyStringVariablesComponent"
] = None # COMPONENT TYPE: StringVariables
character_uninstanced_item_components: t.Optional[
t.Mapping[str, "DestinyBaseItemComponentSetOfuint32"]
] = None # Do you ever get the feeling that a system was designed *too* flexibly? That it can be used in so many different ways that you end up being unable to provide an easy to use abstraction for the mess that's happening under the surface? Let's talk about character-specific data that might be related to items without instances. These two statements are totally unrelated, I promise. At some point during D2, it was decided that items - such as Bounties - could be given to characters and *not* have instance data, but that *could* display and even use relevant state information on your account and character. Up to now, any item that had meaningful dependencies on character or account state had to be instanced, and thus "itemComponents" was all that you needed: it was keyed by item's instance IDs and provided the stateful information you needed inside. Unfortunately, we don't live in such a magical world anymore. This is information held on a per-character basis about non-instanced items that the characters have in their inventory - or that reference character-specific state information even if it's in Account-level inventory - and the values related to that item's state in relation to the given character. To give a concrete example, look at a Moments of Triumph bounty. They exist in a character's inventory, and show/care about a character's progression toward completing the bounty. But the bounty itself is a non-instanced item, like a mod or a currency. This returns that data for the characters who have the bounty in their inventory. I'm not crying, you're crying Okay we're both crying but it's going to be okay I promise Actually I shouldn't promise that, I don't know if it's going to be okay
characters: t.Optional[
"DictionaryComponentResponseOfint64AndDestinyCharacterComponent"
] = None # Basic information about each character, keyed by the CharacterId. COMPONENT TYPE: Characters
item_components: t.Optional[
"DestinyItemComponentSetOfint64"
] = None # Information about instanced items across all returned characters, keyed by the item's instance ID. COMPONENT TYPE: [See inside the DestinyItemComponentSet contract for component types.]
metrics: t.Optional[
"SingleComponentResponseOfDestinyMetricsComponent"
] = None # COMPONENT TYPE: Metrics
platform_silver: t.Optional[
"SingleComponentResponseOfDestinyPlatformSilverComponent"
] = None # Silver quantities for any platform on which this Profile plays destiny. COMPONENT TYPE: PlatformSilver
profile: t.Optional[
"SingleComponentResponseOfDestinyProfileComponent"
] = None # The basic information about the Destiny Profile (formerly "Account"). COMPONENT TYPE: Profiles
profile_collectibles: t.Optional[
"SingleComponentResponseOfDestinyProfileCollectiblesComponent"
] = None # COMPONENT TYPE: Collectibles
profile_currencies: t.Optional[
"SingleComponentResponseOfDestinyInventoryComponent"
] = None # The profile-level currencies owned by the Destiny Profile. COMPONENT TYPE: ProfileCurrencies
profile_inventory: t.Optional[
"SingleComponentResponseOfDestinyInventoryComponent"
] = None # The profile-level inventory of the Destiny Profile. COMPONENT TYPE: ProfileInventories
profile_kiosks: t.Optional[
"SingleComponentResponseOfDestinyKiosksComponent"
] = None # Items available from Kiosks that are available Profile-wide (i.e. across all characters) This component returns information about what Kiosk items are available to you on a *Profile* level. It is theoretically possible for Kiosks to have items gated by specific Character as well. If you ever have those, you will find them on the characterKiosks property. COMPONENT TYPE: Kiosks
profile_plug_sets: t.Optional[
"SingleComponentResponseOfDestinyPlugSetsComponent"
] = None # When sockets refer to reusable Plug Sets (see DestinyPlugSetDefinition for more info), this is the set of plugs and their states that are profile-scoped. This comes back with ItemSockets, as it is needed for a complete picture of the sockets on requested items. COMPONENT TYPE: ItemSockets
profile_presentation_nodes: t.Optional[
"SingleComponentResponseOfDestinyPresentationNodesComponent"
] = None # COMPONENT TYPE: PresentationNodes
profile_progression: t.Optional[
"SingleComponentResponseOfDestinyProfileProgressionComponent"
] = None # When we have progression information - such as Checklists - that may apply profile-wide, it will be returned here rather than in the per-character progression data. COMPONENT TYPE: ProfileProgression
profile_records: t.Optional[
"SingleComponentResponseOfDestinyProfileRecordsComponent"
] = None # COMPONENT TYPE: Records
profile_string_variables: t.Optional[
"SingleComponentResponseOfDestinyStringVariablesComponent"
] = None # COMPONENT TYPE: StringVariables
profile_transitory_data: t.Optional[
"SingleComponentResponseOfDestinyProfileTransitoryComponent"
] = None # COMPONENT TYPE: Transitory
vendor_receipts: t.Optional[
"SingleComponentResponseOfDestinyVendorReceiptsComponent"
] = None # Recent, refundable purchases you have made from vendors. When will you use it? Couldn't say... COMPONENT TYPE: VendorReceipts
[docs] def to_json(self) -> t.Mapping[str, t.Any]:
return {
"vendorReceipts": to_json(self.vendor_receipts),
"profileInventory": to_json(self.profile_inventory),
"profileCurrencies": to_json(self.profile_currencies),
"profile": to_json(self.profile),
"platformSilver": to_json(self.platform_silver),
"profileKiosks": to_json(self.profile_kiosks),
"profilePlugSets": to_json(self.profile_plug_sets),
"profileProgression": to_json(self.profile_progression),
"profilePresentationNodes": to_json(self.profile_presentation_nodes),
"profileRecords": to_json(self.profile_records),
"profileCollectibles": to_json(self.profile_collectibles),
"profileTransitoryData": to_json(self.profile_transitory_data),
"metrics": to_json(self.metrics),
"profileStringVariables": to_json(self.profile_string_variables),
"characters": to_json(self.characters),
"characterInventories": to_json(self.character_inventories),
"characterProgressions": to_json(self.character_progressions),
"characterRenderData": to_json(self.character_render_data),
"characterActivities": to_json(self.character_activities),
"characterEquipment": to_json(self.character_equipment),
"characterKiosks": to_json(self.character_kiosks),
"characterPlugSets": to_json(self.character_plug_sets),
"characterUninstancedItemComponents": to_json(
self.character_uninstanced_item_components
),
"characterPresentationNodes": to_json(self.character_presentation_nodes),
"characterRecords": to_json(self.character_records),
"characterCollectibles": to_json(self.character_collectibles),
"characterStringVariables": to_json(self.character_string_variables),
"itemComponents": to_json(self.item_components),
"characterCurrencyLookups": to_json(self.character_currency_lookups),
}
[docs]@dt.dataclass(frozen=True)
class DestinyCharacterResponse:
"""The response contract for GetDestinyCharacter, with components that can
be returned for character and item-level data."""
activities: t.Optional[
"SingleComponentResponseOfDestinyCharacterActivitiesComponent"
] = None # Activity data - info about current activities available to the player. COMPONENT TYPE: CharacterActivities
character: t.Optional[
"SingleComponentResponseOfDestinyCharacterComponent"
] = None # Base information about the character in question. COMPONENT TYPE: Characters
collectibles: t.Optional[
"SingleComponentResponseOfDestinyCollectiblesComponent"
] = None # COMPONENT TYPE: Collectibles
currency_lookups: t.Optional[
"SingleComponentResponseOfDestinyCurrenciesComponent"
] = None # A "lookup" convenience component that can be used to quickly check if the character has access to items that can be used for purchasing. COMPONENT TYPE: CurrencyLookups
equipment: t.Optional[
"SingleComponentResponseOfDestinyInventoryComponent"
] = None # Equipped items on the character. COMPONENT TYPE: CharacterEquipment
inventory: t.Optional[
"SingleComponentResponseOfDestinyInventoryComponent"
] = None # The character-level non-equipped inventory items. COMPONENT TYPE: CharacterInventories
item_components: t.Optional[
"DestinyItemComponentSetOfint64"
] = None # The set of components belonging to the player's instanced items. COMPONENT TYPE: [See inside the DestinyItemComponentSet contract for component types.]
kiosks: t.Optional[
"SingleComponentResponseOfDestinyKiosksComponent"
] = None # Items available from Kiosks that are available to this specific character. COMPONENT TYPE: Kiosks
plug_sets: t.Optional[
"SingleComponentResponseOfDestinyPlugSetsComponent"
] = None # When sockets refer to reusable Plug Sets (see DestinyPlugSetDefinition for more info), this is the set of plugs and their states that are scoped to this character. This comes back with ItemSockets, as it is needed for a complete picture of the sockets on requested items. COMPONENT TYPE: ItemSockets
presentation_nodes: t.Optional[
"SingleComponentResponseOfDestinyPresentationNodesComponent"
] = None # COMPONENT TYPE: PresentationNodes
progressions: t.Optional[
"SingleComponentResponseOfDestinyCharacterProgressionComponent"
] = None # Character progression data, including Milestones. COMPONENT TYPE: CharacterProgressions
records: t.Optional[
"SingleComponentResponseOfDestinyCharacterRecordsComponent"
] = None # COMPONENT TYPE: Records
render_data: t.Optional[
"SingleComponentResponseOfDestinyCharacterRenderComponent"
] = None # Character rendering data - a minimal set of information about equipment and dyes used for rendering. COMPONENT TYPE: CharacterRenderData
uninstanced_item_components: t.Optional[
"DestinyBaseItemComponentSetOfuint32"
] = None # The set of components belonging to the player's UNinstanced items. Because apparently now those too can have information relevant to the character's state. COMPONENT TYPE: [See inside the DestinyItemComponentSet contract for component types.]
[docs] def to_json(self) -> t.Mapping[str, t.Any]:
return {
"inventory": to_json(self.inventory),
"character": to_json(self.character),
"progressions": to_json(self.progressions),
"renderData": to_json(self.render_data),
"activities": to_json(self.activities),
"equipment": to_json(self.equipment),
"kiosks": to_json(self.kiosks),
"plugSets": to_json(self.plug_sets),
"presentationNodes": to_json(self.presentation_nodes),
"records": to_json(self.records),
"collectibles": to_json(self.collectibles),
"itemComponents": to_json(self.item_components),
"uninstancedItemComponents": to_json(self.uninstanced_item_components),
"currencyLookups": to_json(self.currency_lookups),
}
[docs]@dt.dataclass(frozen=True)
class DestinyItemResponse:
"""The response object for retrieving an individual instanced item.
None of these components are relevant for an item that doesn't have
an "itemInstanceId": for those, get your information from the
DestinyInventoryDefinition.
"""
character_id: t.Optional[
int
] = None # If the item is on a character, this will return the ID of the character that is holding the item.
instance: t.Optional[
"SingleComponentResponseOfDestinyItemInstanceComponent"
] = None # Basic instance data for the item. COMPONENT TYPE: ItemInstances
item: t.Optional[
"SingleComponentResponseOfDestinyItemComponent"
] = None # Common data for the item relevant to its non-instanced properties. COMPONENT TYPE: ItemCommonData
objectives: t.Optional[
"SingleComponentResponseOfDestinyItemObjectivesComponent"
] = None # Information specifically about the item's objectives. COMPONENT TYPE: ItemObjectives
perks: t.Optional[
"SingleComponentResponseOfDestinyItemPerksComponent"
] = None # Information specifically about the perks currently active on the item. COMPONENT TYPE: ItemPerks
plug_objectives: t.Optional[
"SingleComponentResponseOfDestinyItemPlugObjectivesComponent"
] = None # Information about objectives on Plugs for a given item. See the component's documentation for more info. COMPONENT TYPE: ItemPlugObjectives
render_data: t.Optional[
"SingleComponentResponseOfDestinyItemRenderComponent"
] = None # Information about how to render the item in 3D. COMPONENT TYPE: ItemRenderData
reusable_plugs: t.Optional[
"SingleComponentResponseOfDestinyItemReusablePlugsComponent"
] = None # Information about the Reusable Plugs for sockets on an item. These are plugs that you can insert into the given socket regardless of if you actually own an instance of that plug: they are logic-driven plugs rather than inventory-driven. These may need to be combined with Plug Set component data to get a full picture of available plugs on a given socket. COMPONENT TYPE: ItemReusablePlugs
sockets: t.Optional[
"SingleComponentResponseOfDestinyItemSocketsComponent"
] = None # Information about the sockets of the item: which are currently active, what potential sockets you could have and the stats/abilities/perks you can gain from them. COMPONENT TYPE: ItemSockets
stats: t.Optional[
"SingleComponentResponseOfDestinyItemStatsComponent"
] = None # Information about the computed stats of the item: power, defense, etc... COMPONENT TYPE: ItemStats
talent_grid: t.Optional[
"SingleComponentResponseOfDestinyItemTalentGridComponent"
] = None # Information about the talent grid attached to the item. Talent nodes can provide a variety of benefits and abilities, and in Destiny 2 are used almost exclusively for the character's "Builds". COMPONENT TYPE: ItemTalentGrids
[docs] def to_json(self) -> t.Mapping[str, t.Any]:
return {
"characterId": to_json(self.character_id),
"item": to_json(self.item),
"instance": to_json(self.instance),
"objectives": to_json(self.objectives),
"perks": to_json(self.perks),
"renderData": to_json(self.render_data),
"stats": to_json(self.stats),
"talentGrid": to_json(self.talent_grid),
"sockets": to_json(self.sockets),
"reusablePlugs": to_json(self.reusable_plugs),
"plugObjectives": to_json(self.plug_objectives),
}
[docs]@dt.dataclass(frozen=True)
class DestinyVendorsResponse:
"""A response containing all of the components for all requested
vendors."""
categories: t.Optional[
"DictionaryComponentResponseOfuint32AndDestinyVendorCategoriesComponent"
] = None # Categories that the vendor has available, and references to the sales therein. These are keyed by the Vendor Hash, so you will get one Categories Component per vendor returned. COMPONENT TYPE: VendorCategories
currency_lookups: t.Optional[
"SingleComponentResponseOfDestinyCurrenciesComponent"
] = None # A "lookup" convenience component that can be used to quickly check if the character has access to items that can be used for purchasing. COMPONENT TYPE: CurrencyLookups
item_components: t.Optional[
t.Mapping[str, "DestinyItemComponentSetOfint32"]
] = None # The set of item detail components, one set of item components per Vendor. These are keyed by the Vendor Hash, so you will get one Item Component Set per vendor returned. The components contained inside are themselves keyed by the vendorSaleIndex, and will have whatever item-level components you requested (Sockets, Stats, Instance data etc...) per item being sold by the vendor.
sales: t.Optional[
"DictionaryComponentResponseOfuint32AndPersonalDestinyVendorSaleItemSetComponent"
] = None # Sales, keyed by the vendorItemIndex of the item being sold. These are keyed by the Vendor Hash, so you will get one Sale Item Set Component per vendor returned. Note that within the Sale Item Set component, the sales are themselves keyed by the vendorSaleIndex, so you can relate it to the corrent sale item definition within the Vendor's definition. COMPONENT TYPE: VendorSales
string_variables: t.Optional[
"SingleComponentResponseOfDestinyStringVariablesComponent"
] = None # A map of string variable values by hash for this character context. COMPONENT TYPE: StringVariables
vendor_groups: t.Optional[
"SingleComponentResponseOfDestinyVendorGroupComponent"
] = None # For Vendors being returned, this will give you the information you need to group them and order them in the same way that the Bungie Companion app performs grouping. It will automatically be returned if you request the Vendors component. COMPONENT TYPE: Vendors
vendors: t.Optional[
"DictionaryComponentResponseOfuint32AndDestinyVendorComponent"
] = None # The base properties of the vendor. These are keyed by the Vendor Hash, so you will get one Vendor Component per vendor returned. COMPONENT TYPE: Vendors
[docs] def to_json(self) -> t.Mapping[str, t.Any]:
return {
"vendorGroups": to_json(self.vendor_groups),
"vendors": to_json(self.vendors),
"categories": to_json(self.categories),
"sales": to_json(self.sales),
"itemComponents": to_json(self.item_components),
"currencyLookups": to_json(self.currency_lookups),
"stringVariables": to_json(self.string_variables),
}
[docs]@dt.dataclass(frozen=True)
class PersonalDestinyVendorSaleItemSetComponent:
sale_items: t.Optional[t.Mapping[str, "DestinyVendorSaleItemComponent"]] = None
[docs] def to_json(self) -> t.Mapping[str, t.Any]:
return {
"saleItems": to_json(self.sale_items),
}
[docs]@dt.dataclass(frozen=True)
class DestinyVendorResponse:
"""A response containing all of the components for a vendor."""
categories: t.Optional[
"SingleComponentResponseOfDestinyVendorCategoriesComponent"
] = None # Categories that the vendor has available, and references to the sales therein. COMPONENT TYPE: VendorCategories
currency_lookups: t.Optional[
"SingleComponentResponseOfDestinyCurrenciesComponent"
] = None # A "lookup" convenience component that can be used to quickly check if the character has access to items that can be used for purchasing. COMPONENT TYPE: CurrencyLookups
item_components: t.Optional[
"DestinyItemComponentSetOfint32"
] = None # Item components, keyed by the vendorItemIndex of the active sale items. COMPONENT TYPE: [See inside the DestinyItemComponentSet contract for component types.]
sales: t.Optional[
"DictionaryComponentResponseOfint32AndDestinyVendorSaleItemComponent"
] = None # Sales, keyed by the vendorItemIndex of the item being sold. COMPONENT TYPE: VendorSales
string_variables: t.Optional[
"SingleComponentResponseOfDestinyStringVariablesComponent"
] = None # A map of string variable values by hash for this character context. COMPONENT TYPE: StringVariables
vendor: t.Optional[
"SingleComponentResponseOfDestinyVendorComponent"
] = None # The base properties of the vendor. COMPONENT TYPE: Vendors
[docs] def to_json(self) -> t.Mapping[str, t.Any]:
return {
"vendor": to_json(self.vendor),
"categories": to_json(self.categories),
"sales": to_json(self.sales),
"itemComponents": to_json(self.item_components),
"currencyLookups": to_json(self.currency_lookups),
"stringVariables": to_json(self.string_variables),
}
[docs]@dt.dataclass(frozen=True)
class DestinyPublicVendorsResponse:
"""A response containing all valid components for the public Vendors
endpoint. It is a decisively smaller subset of data compared to what we can
get when we know the specific user making the request.
If you want any of the other data - item details, whether or not you can buy it, etc... you'll have to call in the context of a character. I know, sad but true.
"""
categories: t.Optional[
"DictionaryComponentResponseOfuint32AndDestinyVendorCategoriesComponent"
] = None # Categories that the vendor has available, and references to the sales therein. These are keyed by the Vendor Hash, so you will get one Categories Component per vendor returned. COMPONENT TYPE: VendorCategories
sales: t.Optional[
"DictionaryComponentResponseOfuint32AndPublicDestinyVendorSaleItemSetComponent"
] = None # Sales, keyed by the vendorItemIndex of the item being sold. These are keyed by the Vendor Hash, so you will get one Sale Item Set Component per vendor returned. Note that within the Sale Item Set component, the sales are themselves keyed by the vendorSaleIndex, so you can relate it to the corrent sale item definition within the Vendor's definition. COMPONENT TYPE: VendorSales
string_variables: t.Optional[
"SingleComponentResponseOfDestinyStringVariablesComponent"
] = None # A set of string variable values by hash for a public vendors context. COMPONENT TYPE: StringVariables
vendor_groups: t.Optional[
"SingleComponentResponseOfDestinyVendorGroupComponent"
] = None # For Vendors being returned, this will give you the information you need to group them and order them in the same way that the Bungie Companion app performs grouping. It will automatically be returned if you request the Vendors component. COMPONENT TYPE: Vendors
vendors: t.Optional[
"DictionaryComponentResponseOfuint32AndDestinyPublicVendorComponent"
] = None # The base properties of the vendor. These are keyed by the Vendor Hash, so you will get one Vendor Component per vendor returned. COMPONENT TYPE: Vendors
[docs] def to_json(self) -> t.Mapping[str, t.Any]:
return {
"vendorGroups": to_json(self.vendor_groups),
"vendors": to_json(self.vendors),
"categories": to_json(self.categories),
"sales": to_json(self.sales),
"stringVariables": to_json(self.string_variables),
}
[docs]@dt.dataclass(frozen=True)
class PublicDestinyVendorSaleItemSetComponent:
sale_items: t.Optional[
t.Mapping[str, "DestinyPublicVendorSaleItemComponent"]
] = None
[docs] def to_json(self) -> t.Mapping[str, t.Any]:
return {
"saleItems": to_json(self.sale_items),
}
[docs]@dt.dataclass(frozen=True)
class DestinyCollectibleNodeDetailResponse:
"""Returns the detailed information about a Collectible Presentation Node
and any Collectibles that are direct descendants."""
collectible_item_components: t.Optional[
"DestinyItemComponentSetOfuint32"
] = None # Item components, keyed by the item hash of the items pointed at collectibles found under the requested Presentation Node. NOTE: I had a lot of hemming and hawing about whether these should be keyed by collectible hash or item hash... but ultimately having it be keyed by item hash meant that UI that already uses DestinyItemComponentSet data wouldn't have to have a special override to do the collectible -> item lookup once you delve into an item's details, and it also meant that you didn't have to remember that the Hash being used as the key for plugSets was different from the Hash being used for the other Dictionaries. As a result, using the Item Hash felt like the least crappy solution. We may all come to regret this decision. We will see. COMPONENT TYPE: [See inside the DestinyItemComponentSet contract for component types.]
collectibles: t.Optional[
"SingleComponentResponseOfDestinyCollectiblesComponent"
] = None # COMPONENT TYPE: Collectibles
[docs] def to_json(self) -> t.Mapping[str, t.Any]:
return {
"collectibles": to_json(self.collectibles),
"collectibleItemComponents": to_json(self.collectible_item_components),
}
[docs]@dt.dataclass(frozen=True)
class InventoryChangedResponse:
"""A response containing all of the components for all requested
vendors."""
added_inventory_items: t.Optional[
t.Sequence["DestinyItemComponent"]
] = None # Items that appeared in the inventory possibly as a result of an action.
removed_inventory_items: t.Optional[
t.Sequence["DestinyItemComponent"]
] = None # Items that disappeared from the inventory possibly as a result of an action.
[docs] def to_json(self) -> t.Mapping[str, t.Any]:
return {
"addedInventoryItems": to_json(self.added_inventory_items),
"removedInventoryItems": to_json(self.removed_inventory_items),
}
[docs]@dt.dataclass(frozen=True)
class DestinyItemChangeResponse:
added_inventory_items: t.Optional[
t.Sequence["DestinyItemComponent"]
] = None # Items that appeared in the inventory possibly as a result of an action.
item: t.Optional["DestinyItemResponse"] = None
removed_inventory_items: t.Optional[
t.Sequence["DestinyItemComponent"]
] = None # Items that disappeared from the inventory possibly as a result of an action.
[docs] def to_json(self) -> t.Mapping[str, t.Any]:
return {
"item": to_json(self.item),
"addedInventoryItems": to_json(self.added_inventory_items),
"removedInventoryItems": to_json(self.removed_inventory_items),
}
from bungieapi.generated.components.schemas import BungieMembershipType # noqa: E402
from bungieapi.generated.components.schemas import (
DestinyBaseItemComponentSetOfuint32,
) # noqa: E402
from bungieapi.generated.components.schemas import (
DestinyItemComponentSetOfint32,
) # noqa: E402
from bungieapi.generated.components.schemas import (
DestinyItemComponentSetOfint64,
) # noqa: E402
from bungieapi.generated.components.schemas import (
DestinyItemComponentSetOfuint32,
) # noqa: E402
from bungieapi.generated.components.schemas import (
DictionaryComponentResponseOfint32AndDestinyVendorSaleItemComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
DictionaryComponentResponseOfint64AndDestinyCharacterActivitiesComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
DictionaryComponentResponseOfint64AndDestinyCharacterComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
DictionaryComponentResponseOfint64AndDestinyCharacterProgressionComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
DictionaryComponentResponseOfint64AndDestinyCharacterRecordsComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
DictionaryComponentResponseOfint64AndDestinyCharacterRenderComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
DictionaryComponentResponseOfint64AndDestinyCollectiblesComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
DictionaryComponentResponseOfint64AndDestinyCurrenciesComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
DictionaryComponentResponseOfint64AndDestinyInventoryComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
DictionaryComponentResponseOfint64AndDestinyKiosksComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
DictionaryComponentResponseOfint64AndDestinyPlugSetsComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
DictionaryComponentResponseOfint64AndDestinyPresentationNodesComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
DictionaryComponentResponseOfint64AndDestinyStringVariablesComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
DictionaryComponentResponseOfuint32AndDestinyPublicVendorComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
DictionaryComponentResponseOfuint32AndDestinyVendorCategoriesComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
DictionaryComponentResponseOfuint32AndDestinyVendorComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
DictionaryComponentResponseOfuint32AndPersonalDestinyVendorSaleItemSetComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
DictionaryComponentResponseOfuint32AndPublicDestinyVendorSaleItemSetComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyCharacterActivitiesComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyCharacterComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyCharacterProgressionComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyCharacterRecordsComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyCharacterRenderComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyCollectiblesComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyCurrenciesComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyInventoryComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyItemComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyItemInstanceComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyItemObjectivesComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyItemPerksComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyItemPlugObjectivesComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyItemRenderComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyItemReusablePlugsComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyItemSocketsComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyItemStatsComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyItemTalentGridComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyKiosksComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyMetricsComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyPlatformSilverComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyPlugSetsComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyPresentationNodesComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyProfileCollectiblesComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyProfileComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyProfileProgressionComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyProfileRecordsComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyProfileTransitoryComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyStringVariablesComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyVendorCategoriesComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyVendorComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyVendorGroupComponent,
) # noqa: E402
from bungieapi.generated.components.schemas import (
SingleComponentResponseOfDestinyVendorReceiptsComponent,
) # noqa: E402
from bungieapi.generated.components.schemas.destiny.components.inventory import (
DestinyPlatformSilverComponent,
) # noqa: E402
from bungieapi.generated.components.schemas.destiny.components.vendors import (
DestinyPublicVendorSaleItemComponent,
) # noqa: E402
from bungieapi.generated.components.schemas.destiny.entities.items import (
DestinyItemComponent,
) # noqa: E402
from bungieapi.generated.components.schemas.destiny.entities.vendors import (
DestinyVendorSaleItemComponent,
) # noqa: E402
from bungieapi.generated.components.schemas.exceptions import (
PlatformErrorCodes,
) # noqa: E402
# imported at the end to do not case circular imports for type annotations
from bungieapi.generated.components.schemas.user import UserInfoCard # noqa: E402